Merge remote-tracking branch 'stefanha/trivial-patches' into staging
[qemu-kvm.git] / block.h
blobd135652902a48fc77686cb9970ee7e7e0549c468
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 bool is_dirty;
19 } BlockDriverInfo;
21 typedef struct BlockFragInfo {
22 uint64_t allocated_clusters;
23 uint64_t total_clusters;
24 uint64_t fragmented_clusters;
25 } BlockFragInfo;
27 typedef struct QEMUSnapshotInfo {
28 char id_str[128]; /* unique snapshot id */
29 /* the following fields are informative. They are not needed for
30 the consistency of the snapshot */
31 char name[256]; /* user chosen name */
32 uint64_t vm_state_size; /* VM state info size */
33 uint32_t date_sec; /* UTC date of the snapshot */
34 uint32_t date_nsec;
35 uint64_t vm_clock_nsec; /* VM clock relative to boot */
36 } QEMUSnapshotInfo;
38 /* Callbacks for block device models */
39 typedef struct BlockDevOps {
41 * Runs when virtual media changed (monitor commands eject, change)
42 * Argument load is true on load and false on eject.
43 * Beware: doesn't run when a host device's physical media
44 * changes. Sure would be useful if it did.
45 * Device models with removable media must implement this callback.
47 void (*change_media_cb)(void *opaque, bool load);
49 * Runs when an eject request is issued from the monitor, the tray
50 * is closed, and the medium is locked.
51 * Device models that do not implement is_medium_locked will not need
52 * this callback. Device models that can lock the medium or tray might
53 * want to implement the callback and unlock the tray when "force" is
54 * true, even if they do not support eject requests.
56 void (*eject_request_cb)(void *opaque, bool force);
58 * Is the virtual tray open?
59 * Device models implement this only when the device has a tray.
61 bool (*is_tray_open)(void *opaque);
63 * Is the virtual medium locked into the device?
64 * Device models implement this only when device has such a lock.
66 bool (*is_medium_locked)(void *opaque);
68 * Runs when the size changed (e.g. monitor command block_resize)
70 void (*resize_cb)(void *opaque);
71 } BlockDevOps;
73 #define BDRV_O_RDWR 0x0002
74 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
75 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
76 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
77 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
78 #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
79 #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
80 #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
81 #define BDRV_O_INCOMING 0x0800 /* consistency hint for incoming migration */
83 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
85 #define BDRV_SECTOR_BITS 9
86 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
87 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
89 typedef enum {
90 BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
91 BLOCK_ERR_STOP_ANY
92 } BlockErrorAction;
94 typedef enum {
95 BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
96 } BlockQMPEventAction;
98 void bdrv_iostatus_enable(BlockDriverState *bs);
99 void bdrv_iostatus_reset(BlockDriverState *bs);
100 void bdrv_iostatus_disable(BlockDriverState *bs);
101 bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
102 void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
103 void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
104 BlockQMPEventAction action, int is_read);
105 void bdrv_info_print(Monitor *mon, const QObject *data);
106 void bdrv_info(Monitor *mon, QObject **ret_data);
107 void bdrv_stats_print(Monitor *mon, const QObject *data);
108 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
110 /* disk I/O throttling */
111 void bdrv_io_limits_enable(BlockDriverState *bs);
112 void bdrv_io_limits_disable(BlockDriverState *bs);
113 bool bdrv_io_limits_enabled(BlockDriverState *bs);
115 void bdrv_init(void);
116 void bdrv_init_with_whitelist(void);
117 BlockDriver *bdrv_find_protocol(const char *filename);
118 BlockDriver *bdrv_find_format(const char *format_name);
119 BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
120 int bdrv_create(BlockDriver *drv, const char* filename,
121 QEMUOptionParameter *options);
122 int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
123 BlockDriverState *bdrv_new(const char *device_name);
124 void bdrv_make_anon(BlockDriverState *bs);
125 void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
126 void bdrv_delete(BlockDriverState *bs);
127 int bdrv_parse_cache_flags(const char *mode, int *flags);
128 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
129 int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
130 BlockDriver *drv);
131 void bdrv_close(BlockDriverState *bs);
132 int bdrv_attach_dev(BlockDriverState *bs, void *dev);
133 void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev);
134 void bdrv_detach_dev(BlockDriverState *bs, void *dev);
135 void *bdrv_get_attached_dev(BlockDriverState *bs);
136 void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
137 void *opaque);
138 void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
139 bool bdrv_dev_has_removable_media(BlockDriverState *bs);
140 bool bdrv_dev_is_tray_open(BlockDriverState *bs);
141 bool bdrv_dev_is_medium_locked(BlockDriverState *bs);
142 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
143 uint8_t *buf, int nb_sectors);
144 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
145 const uint8_t *buf, int nb_sectors);
146 int bdrv_pread(BlockDriverState *bs, int64_t offset,
147 void *buf, int count);
148 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
149 const void *buf, int count);
150 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
151 const void *buf, int count);
152 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
153 int nb_sectors, QEMUIOVector *qiov);
154 int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
155 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
156 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
157 int nb_sectors, QEMUIOVector *qiov);
159 * Efficiently zero a region of the disk image. Note that this is a regular
160 * I/O request like read or write and should have a reasonable size. This
161 * function is not suitable for zeroing the entire image in a single request
162 * because it may allocate memory for the entire region.
164 int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
165 int nb_sectors);
166 int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
167 int nb_sectors, int *pnum);
168 int coroutine_fn bdrv_co_is_allocated_above(BlockDriverState *top,
169 BlockDriverState *base,
170 int64_t sector_num,
171 int nb_sectors, int *pnum);
172 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
173 const char *backing_file);
174 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
175 int64_t bdrv_getlength(BlockDriverState *bs);
176 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
177 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
178 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
179 int bdrv_commit(BlockDriverState *bs);
180 int bdrv_commit_all(void);
181 int bdrv_change_backing_file(BlockDriverState *bs,
182 const char *backing_file, const char *backing_fmt);
183 void bdrv_register(BlockDriver *bdrv);
186 typedef struct BdrvCheckResult {
187 int corruptions;
188 int leaks;
189 int check_errors;
190 int corruptions_fixed;
191 int leaks_fixed;
192 BlockFragInfo bfi;
193 } BdrvCheckResult;
195 typedef enum {
196 BDRV_FIX_LEAKS = 1,
197 BDRV_FIX_ERRORS = 2,
198 } BdrvCheckMode;
200 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
202 /* async block I/O */
203 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
204 int sector_num);
205 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
206 QEMUIOVector *iov, int nb_sectors,
207 BlockDriverCompletionFunc *cb, void *opaque);
208 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
209 QEMUIOVector *iov, int nb_sectors,
210 BlockDriverCompletionFunc *cb, void *opaque);
211 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
212 BlockDriverCompletionFunc *cb, void *opaque);
213 BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
214 int64_t sector_num, int nb_sectors,
215 BlockDriverCompletionFunc *cb, void *opaque);
216 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
218 typedef struct BlockRequest {
219 /* Fields to be filled by multiwrite caller */
220 int64_t sector;
221 int nb_sectors;
222 QEMUIOVector *qiov;
223 BlockDriverCompletionFunc *cb;
224 void *opaque;
226 /* Filled by multiwrite implementation */
227 int error;
228 } BlockRequest;
230 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
231 int num_reqs);
233 /* sg packet commands */
234 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
235 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
236 unsigned long int req, void *buf,
237 BlockDriverCompletionFunc *cb, void *opaque);
239 /* Invalidate any cached metadata used by image formats */
240 void bdrv_invalidate_cache(BlockDriverState *bs);
241 void bdrv_invalidate_cache_all(void);
243 void bdrv_clear_incoming_migration_all(void);
245 /* Ensure contents are flushed to disk. */
246 int bdrv_flush(BlockDriverState *bs);
247 int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
248 void bdrv_flush_all(void);
249 void bdrv_close_all(void);
250 void bdrv_drain_all(void);
252 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
253 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
254 int bdrv_has_zero_init(BlockDriverState *bs);
255 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
256 int *pnum);
258 #define BIOS_ATA_TRANSLATION_AUTO 0
259 #define BIOS_ATA_TRANSLATION_NONE 1
260 #define BIOS_ATA_TRANSLATION_LBA 2
261 #define BIOS_ATA_TRANSLATION_LARGE 3
262 #define BIOS_ATA_TRANSLATION_RECHS 4
264 void bdrv_set_geometry_hint(BlockDriverState *bs,
265 int cyls, int heads, int secs);
266 void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
267 void bdrv_get_geometry_hint(BlockDriverState *bs,
268 int *pcyls, int *pheads, int *psecs);
269 typedef enum FDriveType {
270 FDRIVE_DRV_144 = 0x00, /* 1.44 MB 3"5 drive */
271 FDRIVE_DRV_288 = 0x01, /* 2.88 MB 3"5 drive */
272 FDRIVE_DRV_120 = 0x02, /* 1.2 MB 5"25 drive */
273 FDRIVE_DRV_NONE = 0x03, /* No drive connected */
274 } FDriveType;
276 typedef enum FDriveRate {
277 FDRIVE_RATE_500K = 0x00, /* 500 Kbps */
278 FDRIVE_RATE_300K = 0x01, /* 300 Kbps */
279 FDRIVE_RATE_250K = 0x02, /* 250 Kbps */
280 FDRIVE_RATE_1M = 0x03, /* 1 Mbps */
281 } FDriveRate;
283 void bdrv_get_floppy_geometry_hint(BlockDriverState *bs, int *nb_heads,
284 int *max_track, int *last_sect,
285 FDriveType drive_in, FDriveType *drive,
286 FDriveRate *rate);
287 int bdrv_get_translation_hint(BlockDriverState *bs);
288 void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
289 BlockErrorAction on_write_error);
290 BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
291 int bdrv_is_read_only(BlockDriverState *bs);
292 int bdrv_is_sg(BlockDriverState *bs);
293 int bdrv_enable_write_cache(BlockDriverState *bs);
294 void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
295 int bdrv_is_inserted(BlockDriverState *bs);
296 int bdrv_media_changed(BlockDriverState *bs);
297 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
298 void bdrv_eject(BlockDriverState *bs, bool eject_flag);
299 const char *bdrv_get_format_name(BlockDriverState *bs);
300 BlockDriverState *bdrv_find(const char *name);
301 BlockDriverState *bdrv_next(BlockDriverState *bs);
302 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
303 void *opaque);
304 int bdrv_is_encrypted(BlockDriverState *bs);
305 int bdrv_key_required(BlockDriverState *bs);
306 int bdrv_set_key(BlockDriverState *bs, const char *key);
307 int bdrv_query_missing_keys(void);
308 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
309 void *opaque);
310 const char *bdrv_get_device_name(BlockDriverState *bs);
311 int bdrv_get_flags(BlockDriverState *bs);
312 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
313 const uint8_t *buf, int nb_sectors);
314 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
316 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
317 void bdrv_get_backing_filename(BlockDriverState *bs,
318 char *filename, int filename_size);
319 void bdrv_get_full_backing_filename(BlockDriverState *bs,
320 char *dest, size_t sz);
321 int bdrv_can_snapshot(BlockDriverState *bs);
322 int bdrv_is_snapshot(BlockDriverState *bs);
323 BlockDriverState *bdrv_snapshots(void);
324 int bdrv_snapshot_create(BlockDriverState *bs,
325 QEMUSnapshotInfo *sn_info);
326 int bdrv_snapshot_goto(BlockDriverState *bs,
327 const char *snapshot_id);
328 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
329 int bdrv_snapshot_list(BlockDriverState *bs,
330 QEMUSnapshotInfo **psn_info);
331 int bdrv_snapshot_load_tmp(BlockDriverState *bs,
332 const char *snapshot_name);
333 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
335 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
336 int path_is_absolute(const char *path);
337 void path_combine(char *dest, int dest_size,
338 const char *base_path,
339 const char *filename);
341 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
342 int64_t pos, int size);
344 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
345 int64_t pos, int size);
347 int bdrv_img_create(const char *filename, const char *fmt,
348 const char *base_filename, const char *base_fmt,
349 char *options, uint64_t img_size, int flags);
351 void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
352 void *qemu_blockalign(BlockDriverState *bs, size_t size);
354 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
356 void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
357 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
358 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
359 int nr_sectors);
360 int64_t bdrv_get_dirty_count(BlockDriverState *bs);
362 void bdrv_enable_copy_on_read(BlockDriverState *bs);
363 void bdrv_disable_copy_on_read(BlockDriverState *bs);
365 void bdrv_set_in_use(BlockDriverState *bs, int in_use);
366 int bdrv_in_use(BlockDriverState *bs);
368 enum BlockAcctType {
369 BDRV_ACCT_READ,
370 BDRV_ACCT_WRITE,
371 BDRV_ACCT_FLUSH,
372 BDRV_MAX_IOTYPE,
375 typedef struct BlockAcctCookie {
376 int64_t bytes;
377 int64_t start_time_ns;
378 enum BlockAcctType type;
379 } BlockAcctCookie;
381 void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
382 int64_t bytes, enum BlockAcctType type);
383 void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);
385 typedef enum {
386 BLKDBG_L1_UPDATE,
388 BLKDBG_L1_GROW_ALLOC_TABLE,
389 BLKDBG_L1_GROW_WRITE_TABLE,
390 BLKDBG_L1_GROW_ACTIVATE_TABLE,
392 BLKDBG_L2_LOAD,
393 BLKDBG_L2_UPDATE,
394 BLKDBG_L2_UPDATE_COMPRESSED,
395 BLKDBG_L2_ALLOC_COW_READ,
396 BLKDBG_L2_ALLOC_WRITE,
398 BLKDBG_READ,
399 BLKDBG_READ_AIO,
400 BLKDBG_READ_BACKING,
401 BLKDBG_READ_BACKING_AIO,
402 BLKDBG_READ_COMPRESSED,
404 BLKDBG_WRITE_AIO,
405 BLKDBG_WRITE_COMPRESSED,
407 BLKDBG_VMSTATE_LOAD,
408 BLKDBG_VMSTATE_SAVE,
410 BLKDBG_COW_READ,
411 BLKDBG_COW_WRITE,
413 BLKDBG_REFTABLE_LOAD,
414 BLKDBG_REFTABLE_GROW,
416 BLKDBG_REFBLOCK_LOAD,
417 BLKDBG_REFBLOCK_UPDATE,
418 BLKDBG_REFBLOCK_UPDATE_PART,
419 BLKDBG_REFBLOCK_ALLOC,
420 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
421 BLKDBG_REFBLOCK_ALLOC_WRITE,
422 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
423 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
424 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
426 BLKDBG_CLUSTER_ALLOC,
427 BLKDBG_CLUSTER_ALLOC_BYTES,
428 BLKDBG_CLUSTER_FREE,
430 BLKDBG_EVENT_MAX,
431 } BlkDebugEvent;
433 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
434 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
437 /* Convenience for block device models */
439 typedef struct BlockConf {
440 BlockDriverState *bs;
441 uint16_t physical_block_size;
442 uint16_t logical_block_size;
443 uint16_t min_io_size;
444 uint32_t opt_io_size;
445 int32_t bootindex;
446 uint32_t discard_granularity;
447 } BlockConf;
449 static inline unsigned int get_physical_block_exp(BlockConf *conf)
451 unsigned int exp = 0, size;
453 for (size = conf->physical_block_size;
454 size > conf->logical_block_size;
455 size >>= 1) {
456 exp++;
459 return exp;
462 #define DEFINE_BLOCK_PROPERTIES(_state, _conf) \
463 DEFINE_PROP_DRIVE("drive", _state, _conf.bs), \
464 DEFINE_PROP_BLOCKSIZE("logical_block_size", _state, \
465 _conf.logical_block_size, 512), \
466 DEFINE_PROP_BLOCKSIZE("physical_block_size", _state, \
467 _conf.physical_block_size, 512), \
468 DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0), \
469 DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0), \
470 DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1), \
471 DEFINE_PROP_UINT32("discard_granularity", _state, \
472 _conf.discard_granularity, 0)
474 #endif