hyper-v: introduce Hyper-V support infrastructure.
[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 "qemu-coroutine.h"
8 #include "qobject.h"
9
10 /* block.c */
11 typedef struct BlockDriver BlockDriver;
12
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 chosen name */
25 uint64_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
31 /* Callbacks for block device models */
32 typedef struct BlockDevOps {
33 /*
34 * Runs when virtual media changed (monitor commands eject, change)
35 * Argument load is true on load and false on eject.
36 * Beware: doesn't run when a host device's physical media
37 * changes. Sure would be useful if it did.
38 * Device models with removable media must implement this callback.
39 */
40 void (*change_media_cb)(void *opaque, bool load);
41 /*
42 * Runs when an eject request is issued from the monitor, the tray
43 * is closed, and the medium is locked.
44 * Device models that do not implement is_medium_locked will not need
45 * this callback. Device models that can lock the medium or tray might
46 * want to implement the callback and unlock the tray when "force" is
47 * true, even if they do not support eject requests.
48 */
49 void (*eject_request_cb)(void *opaque, bool force);
50 /*
51 * Is the virtual tray open?
52 * Device models implement this only when the device has a tray.
53 */
54 bool (*is_tray_open)(void *opaque);
55 /*
56 * Is the virtual medium locked into the device?
57 * Device models implement this only when device has such a lock.
58 */
59 bool (*is_medium_locked)(void *opaque);
60 /*
61 * Runs when the size changed (e.g. monitor command block_resize)
62 */
63 void (*resize_cb)(void *opaque);
64 } BlockDevOps;
65
66 #define BDRV_O_RDWR 0x0002
67 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
68 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
69 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
70 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
71 #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
72 #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
73 #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
74
75 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
76
77 #define BDRV_SECTOR_BITS 9
78 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
79 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
80
81 typedef enum {
82 BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
83 BLOCK_ERR_STOP_ANY
84 } BlockErrorAction;
85
86 typedef enum {
87 BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
88 } BlockMonEventAction;
89
90 void bdrv_iostatus_enable(BlockDriverState *bs);
91 void bdrv_iostatus_reset(BlockDriverState *bs);
92 void bdrv_iostatus_disable(BlockDriverState *bs);
93 bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
94 void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
95 void bdrv_mon_event(const BlockDriverState *bdrv,
96 BlockMonEventAction action, int is_read);
97 void bdrv_info_print(Monitor *mon, const QObject *data);
98 void bdrv_info(Monitor *mon, QObject **ret_data);
99 void bdrv_stats_print(Monitor *mon, const QObject *data);
100 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
101
102 /* disk I/O throttling */
103 void bdrv_io_limits_enable(BlockDriverState *bs);
104 void bdrv_io_limits_disable(BlockDriverState *bs);
105 bool bdrv_io_limits_enabled(BlockDriverState *bs);
106
107 void bdrv_init(void);
108 void bdrv_init_with_whitelist(void);
109 BlockDriver *bdrv_find_protocol(const char *filename);
110 BlockDriver *bdrv_find_format(const char *format_name);
111 BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
112 int bdrv_create(BlockDriver *drv, const char* filename,
113 QEMUOptionParameter *options);
114 int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
115 BlockDriverState *bdrv_new(const char *device_name);
116 void bdrv_make_anon(BlockDriverState *bs);
117 void bdrv_delete(BlockDriverState *bs);
118 int bdrv_parse_cache_flags(const char *mode, int *flags);
119 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
120 int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
121 BlockDriver *drv);
122 void bdrv_close(BlockDriverState *bs);
123 int bdrv_attach_dev(BlockDriverState *bs, void *dev);
124 void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev);
125 void bdrv_detach_dev(BlockDriverState *bs, void *dev);
126 void *bdrv_get_attached_dev(BlockDriverState *bs);
127 void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
128 void *opaque);
129 void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
130 bool bdrv_dev_has_removable_media(BlockDriverState *bs);
131 bool bdrv_dev_is_tray_open(BlockDriverState *bs);
132 bool bdrv_dev_is_medium_locked(BlockDriverState *bs);
133 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
134 uint8_t *buf, int nb_sectors);
135 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
136 const uint8_t *buf, int nb_sectors);
137 int bdrv_pread(BlockDriverState *bs, int64_t offset,
138 void *buf, int count);
139 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
140 const void *buf, int count);
141 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
142 const void *buf, int count);
143 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
144 int nb_sectors, QEMUIOVector *qiov);
145 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
146 int nb_sectors, QEMUIOVector *qiov);
147 int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
148 int nb_sectors, int *pnum);
149 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
150 int64_t bdrv_getlength(BlockDriverState *bs);
151 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
152 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
153 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
154 int bdrv_commit(BlockDriverState *bs);
155 void bdrv_commit_all(void);
156 int bdrv_change_backing_file(BlockDriverState *bs,
157 const char *backing_file, const char *backing_fmt);
158 void bdrv_register(BlockDriver *bdrv);
159
160
161 typedef struct BdrvCheckResult {
162 int corruptions;
163 int leaks;
164 int check_errors;
165 } BdrvCheckResult;
166
167 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res);
168
169 /* async block I/O */
170 typedef struct BlockDriverAIOCB BlockDriverAIOCB;
171 typedef void BlockDriverCompletionFunc(void *opaque, int ret);
172 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
173 int sector_num);
174 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
175 QEMUIOVector *iov, int nb_sectors,
176 BlockDriverCompletionFunc *cb, void *opaque);
177 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
178 QEMUIOVector *iov, int nb_sectors,
179 BlockDriverCompletionFunc *cb, void *opaque);
180 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
181 BlockDriverCompletionFunc *cb, void *opaque);
182 BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
183 int64_t sector_num, int nb_sectors,
184 BlockDriverCompletionFunc *cb, void *opaque);
185 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
186
187 typedef struct BlockRequest {
188 /* Fields to be filled by multiwrite caller */
189 int64_t sector;
190 int nb_sectors;
191 QEMUIOVector *qiov;
192 BlockDriverCompletionFunc *cb;
193 void *opaque;
194
195 /* Filled by multiwrite implementation */
196 int error;
197 } BlockRequest;
198
199 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
200 int num_reqs);
201
202 /* sg packet commands */
203 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
204 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
205 unsigned long int req, void *buf,
206 BlockDriverCompletionFunc *cb, void *opaque);
207
208 /* Invalidate any cached metadata used by image formats */
209 void bdrv_invalidate_cache(BlockDriverState *bs);
210 void bdrv_invalidate_cache_all(void);
211
212 /* Ensure contents are flushed to disk. */
213 int bdrv_flush(BlockDriverState *bs);
214 int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
215 void bdrv_flush_all(void);
216 void bdrv_close_all(void);
217 void bdrv_drain_all(void);
218
219 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
220 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
221 int bdrv_has_zero_init(BlockDriverState *bs);
222 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
223 int *pnum);
224
225 #define BIOS_ATA_TRANSLATION_AUTO 0
226 #define BIOS_ATA_TRANSLATION_NONE 1
227 #define BIOS_ATA_TRANSLATION_LBA 2
228 #define BIOS_ATA_TRANSLATION_LARGE 3
229 #define BIOS_ATA_TRANSLATION_RECHS 4
230
231 void bdrv_set_geometry_hint(BlockDriverState *bs,
232 int cyls, int heads, int secs);
233 void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
234 void bdrv_get_geometry_hint(BlockDriverState *bs,
235 int *pcyls, int *pheads, int *psecs);
236 typedef enum FDriveType {
237 FDRIVE_DRV_144 = 0x00, /* 1.44 MB 3"5 drive */
238 FDRIVE_DRV_288 = 0x01, /* 2.88 MB 3"5 drive */
239 FDRIVE_DRV_120 = 0x02, /* 1.2 MB 5"25 drive */
240 FDRIVE_DRV_NONE = 0x03, /* No drive connected */
241 } FDriveType;
242
243 void bdrv_get_floppy_geometry_hint(BlockDriverState *bs, int *nb_heads,
244 int *max_track, int *last_sect,
245 FDriveType drive_in, FDriveType *drive);
246 int bdrv_get_translation_hint(BlockDriverState *bs);
247 void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
248 BlockErrorAction on_write_error);
249 BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
250 int bdrv_is_read_only(BlockDriverState *bs);
251 int bdrv_is_sg(BlockDriverState *bs);
252 int bdrv_enable_write_cache(BlockDriverState *bs);
253 int bdrv_is_inserted(BlockDriverState *bs);
254 int bdrv_media_changed(BlockDriverState *bs);
255 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
256 void bdrv_eject(BlockDriverState *bs, int eject_flag);
257 void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
258 BlockDriverState *bdrv_find(const char *name);
259 BlockDriverState *bdrv_next(BlockDriverState *bs);
260 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
261 void *opaque);
262 int bdrv_is_encrypted(BlockDriverState *bs);
263 int bdrv_key_required(BlockDriverState *bs);
264 int bdrv_set_key(BlockDriverState *bs, const char *key);
265 int bdrv_query_missing_keys(void);
266 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
267 void *opaque);
268 const char *bdrv_get_device_name(BlockDriverState *bs);
269 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
270 const uint8_t *buf, int nb_sectors);
271 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
272
273 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
274 void bdrv_get_backing_filename(BlockDriverState *bs,
275 char *filename, int filename_size);
276 int bdrv_can_snapshot(BlockDriverState *bs);
277 int bdrv_is_snapshot(BlockDriverState *bs);
278 BlockDriverState *bdrv_snapshots(void);
279 int bdrv_snapshot_create(BlockDriverState *bs,
280 QEMUSnapshotInfo *sn_info);
281 int bdrv_snapshot_goto(BlockDriverState *bs,
282 const char *snapshot_id);
283 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
284 int bdrv_snapshot_list(BlockDriverState *bs,
285 QEMUSnapshotInfo **psn_info);
286 int bdrv_snapshot_load_tmp(BlockDriverState *bs,
287 const char *snapshot_name);
288 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
289
290 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
291 int path_is_absolute(const char *path);
292 void path_combine(char *dest, int dest_size,
293 const char *base_path,
294 const char *filename);
295
296 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
297 int64_t pos, int size);
298
299 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
300 int64_t pos, int size);
301
302 int bdrv_img_create(const char *filename, const char *fmt,
303 const char *base_filename, const char *base_fmt,
304 char *options, uint64_t img_size, int flags);
305
306 void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
307 void *qemu_blockalign(BlockDriverState *bs, size_t size);
308
309 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
310
311 void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
312 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
313 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
314 int nr_sectors);
315 int64_t bdrv_get_dirty_count(BlockDriverState *bs);
316
317 void bdrv_enable_copy_on_read(BlockDriverState *bs);
318 void bdrv_disable_copy_on_read(BlockDriverState *bs);
319
320 void bdrv_set_in_use(BlockDriverState *bs, int in_use);
321 int bdrv_in_use(BlockDriverState *bs);
322
323 enum BlockAcctType {
324 BDRV_ACCT_READ,
325 BDRV_ACCT_WRITE,
326 BDRV_ACCT_FLUSH,
327 BDRV_MAX_IOTYPE,
328 };
329
330 typedef struct BlockAcctCookie {
331 int64_t bytes;
332 int64_t start_time_ns;
333 enum BlockAcctType type;
334 } BlockAcctCookie;
335
336 void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
337 int64_t bytes, enum BlockAcctType type);
338 void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);
339
340 typedef enum {
341 BLKDBG_L1_UPDATE,
342
343 BLKDBG_L1_GROW_ALLOC_TABLE,
344 BLKDBG_L1_GROW_WRITE_TABLE,
345 BLKDBG_L1_GROW_ACTIVATE_TABLE,
346
347 BLKDBG_L2_LOAD,
348 BLKDBG_L2_UPDATE,
349 BLKDBG_L2_UPDATE_COMPRESSED,
350 BLKDBG_L2_ALLOC_COW_READ,
351 BLKDBG_L2_ALLOC_WRITE,
352
353 BLKDBG_READ,
354 BLKDBG_READ_AIO,
355 BLKDBG_READ_BACKING,
356 BLKDBG_READ_BACKING_AIO,
357 BLKDBG_READ_COMPRESSED,
358
359 BLKDBG_WRITE_AIO,
360 BLKDBG_WRITE_COMPRESSED,
361
362 BLKDBG_VMSTATE_LOAD,
363 BLKDBG_VMSTATE_SAVE,
364
365 BLKDBG_COW_READ,
366 BLKDBG_COW_WRITE,
367
368 BLKDBG_REFTABLE_LOAD,
369 BLKDBG_REFTABLE_GROW,
370
371 BLKDBG_REFBLOCK_LOAD,
372 BLKDBG_REFBLOCK_UPDATE,
373 BLKDBG_REFBLOCK_UPDATE_PART,
374 BLKDBG_REFBLOCK_ALLOC,
375 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
376 BLKDBG_REFBLOCK_ALLOC_WRITE,
377 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
378 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
379 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
380
381 BLKDBG_CLUSTER_ALLOC,
382 BLKDBG_CLUSTER_ALLOC_BYTES,
383 BLKDBG_CLUSTER_FREE,
384
385 BLKDBG_EVENT_MAX,
386 } BlkDebugEvent;
387
388 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
389 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
390
391
392 /* Convenience for block device models */
393
394 typedef struct BlockConf {
395 BlockDriverState *bs;
396 uint16_t physical_block_size;
397 uint16_t logical_block_size;
398 uint16_t min_io_size;
399 uint32_t opt_io_size;
400 int32_t bootindex;
401 uint32_t discard_granularity;
402 } BlockConf;
403
404 static inline unsigned int get_physical_block_exp(BlockConf *conf)
405 {
406 unsigned int exp = 0, size;
407
408 for (size = conf->physical_block_size;
409 size > conf->logical_block_size;
410 size >>= 1) {
411 exp++;
412 }
413
414 return exp;
415 }
416
417 #define DEFINE_BLOCK_PROPERTIES(_state, _conf) \
418 DEFINE_PROP_DRIVE("drive", _state, _conf.bs), \
419 DEFINE_PROP_UINT16("logical_block_size", _state, \
420 _conf.logical_block_size, 512), \
421 DEFINE_PROP_UINT16("physical_block_size", _state, \
422 _conf.physical_block_size, 512), \
423 DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0), \
424 DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0), \
425 DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1), \
426 DEFINE_PROP_UINT32("discard_granularity", _state, \
427 _conf.discard_granularity, 0)
428
429 #endif
430