5 #include "qemu-common.h"
6 #include "qemu-option.h"
7 #include "qemu-coroutine.h"
11 typedef struct BlockDriver BlockDriver
;
13 typedef struct BlockDriverInfo
{
14 /* in bytes, 0 if irrelevant */
16 /* offset at which the VM state can be saved (0 if not possible) */
17 int64_t vm_state_offset
;
21 typedef struct BlockFragInfo
{
22 uint64_t allocated_clusters
;
23 uint64_t total_clusters
;
24 uint64_t fragmented_clusters
;
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 */
35 uint64_t vm_clock_nsec
; /* VM clock relative to boot */
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
);
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)
90 BLOCK_ERR_REPORT
, BLOCK_ERR_IGNORE
, BLOCK_ERR_STOP_ENOSPC
,
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_swap(BlockDriverState
*bs_new
, BlockDriverState
*bs_old
);
126 void bdrv_append(BlockDriverState
*bs_new
, BlockDriverState
*bs_top
);
127 void bdrv_delete(BlockDriverState
*bs
);
128 int bdrv_parse_cache_flags(const char *mode
, int *flags
);
129 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
, int flags
);
130 int bdrv_open(BlockDriverState
*bs
, const char *filename
, int flags
,
132 void bdrv_close(BlockDriverState
*bs
);
133 int bdrv_attach_dev(BlockDriverState
*bs
, void *dev
);
134 void bdrv_attach_dev_nofail(BlockDriverState
*bs
, void *dev
);
135 void bdrv_detach_dev(BlockDriverState
*bs
, void *dev
);
136 void *bdrv_get_attached_dev(BlockDriverState
*bs
);
137 void bdrv_set_dev_ops(BlockDriverState
*bs
, const BlockDevOps
*ops
,
139 void bdrv_dev_eject_request(BlockDriverState
*bs
, bool force
);
140 bool bdrv_dev_has_removable_media(BlockDriverState
*bs
);
141 bool bdrv_dev_is_tray_open(BlockDriverState
*bs
);
142 bool bdrv_dev_is_medium_locked(BlockDriverState
*bs
);
143 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
144 uint8_t *buf
, int nb_sectors
);
145 int bdrv_read_unthrottled(BlockDriverState
*bs
, int64_t sector_num
,
146 uint8_t *buf
, int nb_sectors
);
147 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
148 const uint8_t *buf
, int nb_sectors
);
149 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
150 void *buf
, int count
);
151 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
152 const void *buf
, int count
);
153 int bdrv_pwrite_sync(BlockDriverState
*bs
, int64_t offset
,
154 const void *buf
, int count
);
155 int coroutine_fn
bdrv_co_readv(BlockDriverState
*bs
, int64_t sector_num
,
156 int nb_sectors
, QEMUIOVector
*qiov
);
157 int coroutine_fn
bdrv_co_copy_on_readv(BlockDriverState
*bs
,
158 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
);
159 int coroutine_fn
bdrv_co_writev(BlockDriverState
*bs
, int64_t sector_num
,
160 int nb_sectors
, QEMUIOVector
*qiov
);
162 * Efficiently zero a region of the disk image. Note that this is a regular
163 * I/O request like read or write and should have a reasonable size. This
164 * function is not suitable for zeroing the entire image in a single request
165 * because it may allocate memory for the entire region.
167 int coroutine_fn
bdrv_co_write_zeroes(BlockDriverState
*bs
, int64_t sector_num
,
169 int coroutine_fn
bdrv_co_is_allocated(BlockDriverState
*bs
, int64_t sector_num
,
170 int nb_sectors
, int *pnum
);
171 int coroutine_fn
bdrv_co_is_allocated_above(BlockDriverState
*top
,
172 BlockDriverState
*base
,
174 int nb_sectors
, int *pnum
);
175 BlockDriverState
*bdrv_find_backing_image(BlockDriverState
*bs
,
176 const char *backing_file
);
177 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
);
178 int64_t bdrv_getlength(BlockDriverState
*bs
);
179 int64_t bdrv_get_allocated_file_size(BlockDriverState
*bs
);
180 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
);
181 void bdrv_guess_geometry(BlockDriverState
*bs
, int *pcyls
, int *pheads
, int *psecs
);
182 int bdrv_commit(BlockDriverState
*bs
);
183 int bdrv_commit_all(void);
184 int bdrv_change_backing_file(BlockDriverState
*bs
,
185 const char *backing_file
, const char *backing_fmt
);
186 void bdrv_register(BlockDriver
*bdrv
);
189 typedef struct BdrvCheckResult
{
193 int corruptions_fixed
;
203 int bdrv_check(BlockDriverState
*bs
, BdrvCheckResult
*res
, BdrvCheckMode fix
);
205 /* async block I/O */
206 typedef void BlockDriverDirtyHandler(BlockDriverState
*bs
, int64_t sector
,
208 BlockDriverAIOCB
*bdrv_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
209 QEMUIOVector
*iov
, int nb_sectors
,
210 BlockDriverCompletionFunc
*cb
, void *opaque
);
211 BlockDriverAIOCB
*bdrv_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
212 QEMUIOVector
*iov
, int nb_sectors
,
213 BlockDriverCompletionFunc
*cb
, void *opaque
);
214 BlockDriverAIOCB
*bdrv_aio_flush(BlockDriverState
*bs
,
215 BlockDriverCompletionFunc
*cb
, void *opaque
);
216 BlockDriverAIOCB
*bdrv_aio_discard(BlockDriverState
*bs
,
217 int64_t sector_num
, int nb_sectors
,
218 BlockDriverCompletionFunc
*cb
, void *opaque
);
219 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
);
221 typedef struct BlockRequest
{
222 /* Fields to be filled by multiwrite caller */
226 BlockDriverCompletionFunc
*cb
;
229 /* Filled by multiwrite implementation */
233 int bdrv_aio_multiwrite(BlockDriverState
*bs
, BlockRequest
*reqs
,
236 /* sg packet commands */
237 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
);
238 BlockDriverAIOCB
*bdrv_aio_ioctl(BlockDriverState
*bs
,
239 unsigned long int req
, void *buf
,
240 BlockDriverCompletionFunc
*cb
, void *opaque
);
242 /* Invalidate any cached metadata used by image formats */
243 void bdrv_invalidate_cache(BlockDriverState
*bs
);
244 void bdrv_invalidate_cache_all(void);
246 void bdrv_clear_incoming_migration_all(void);
248 /* Ensure contents are flushed to disk. */
249 int bdrv_flush(BlockDriverState
*bs
);
250 int coroutine_fn
bdrv_co_flush(BlockDriverState
*bs
);
251 void bdrv_flush_all(void);
252 void bdrv_close_all(void);
253 void bdrv_drain_all(void);
255 int bdrv_discard(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
);
256 int bdrv_co_discard(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
);
257 int bdrv_has_zero_init(BlockDriverState
*bs
);
258 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
261 #define BIOS_ATA_TRANSLATION_AUTO 0
262 #define BIOS_ATA_TRANSLATION_NONE 1
263 #define BIOS_ATA_TRANSLATION_LBA 2
264 #define BIOS_ATA_TRANSLATION_LARGE 3
265 #define BIOS_ATA_TRANSLATION_RECHS 4
267 void bdrv_set_geometry_hint(BlockDriverState
*bs
,
268 int cyls
, int heads
, int secs
);
269 void bdrv_set_translation_hint(BlockDriverState
*bs
, int translation
);
270 void bdrv_get_geometry_hint(BlockDriverState
*bs
,
271 int *pcyls
, int *pheads
, int *psecs
);
272 typedef enum FDriveType
{
273 FDRIVE_DRV_144
= 0x00, /* 1.44 MB 3"5 drive */
274 FDRIVE_DRV_288
= 0x01, /* 2.88 MB 3"5 drive */
275 FDRIVE_DRV_120
= 0x02, /* 1.2 MB 5"25 drive */
276 FDRIVE_DRV_NONE
= 0x03, /* No drive connected */
279 typedef enum FDriveRate
{
280 FDRIVE_RATE_500K
= 0x00, /* 500 Kbps */
281 FDRIVE_RATE_300K
= 0x01, /* 300 Kbps */
282 FDRIVE_RATE_250K
= 0x02, /* 250 Kbps */
283 FDRIVE_RATE_1M
= 0x03, /* 1 Mbps */
286 void bdrv_get_floppy_geometry_hint(BlockDriverState
*bs
, int *nb_heads
,
287 int *max_track
, int *last_sect
,
288 FDriveType drive_in
, FDriveType
*drive
,
290 int bdrv_get_translation_hint(BlockDriverState
*bs
);
291 void bdrv_set_on_error(BlockDriverState
*bs
, BlockErrorAction on_read_error
,
292 BlockErrorAction on_write_error
);
293 BlockErrorAction
bdrv_get_on_error(BlockDriverState
*bs
, int is_read
);
294 int bdrv_is_read_only(BlockDriverState
*bs
);
295 int bdrv_is_sg(BlockDriverState
*bs
);
296 int bdrv_enable_write_cache(BlockDriverState
*bs
);
297 void bdrv_set_enable_write_cache(BlockDriverState
*bs
, bool wce
);
298 int bdrv_is_inserted(BlockDriverState
*bs
);
299 int bdrv_media_changed(BlockDriverState
*bs
);
300 void bdrv_lock_medium(BlockDriverState
*bs
, bool locked
);
301 void bdrv_eject(BlockDriverState
*bs
, bool eject_flag
);
302 const char *bdrv_get_format_name(BlockDriverState
*bs
);
303 BlockDriverState
*bdrv_find(const char *name
);
304 BlockDriverState
*bdrv_next(BlockDriverState
*bs
);
305 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
),
307 int bdrv_is_encrypted(BlockDriverState
*bs
);
308 int bdrv_key_required(BlockDriverState
*bs
);
309 int bdrv_set_key(BlockDriverState
*bs
, const char *key
);
310 int bdrv_query_missing_keys(void);
311 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
313 const char *bdrv_get_device_name(BlockDriverState
*bs
);
314 int bdrv_get_flags(BlockDriverState
*bs
);
315 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
316 const uint8_t *buf
, int nb_sectors
);
317 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
);
319 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
);
320 void bdrv_get_backing_filename(BlockDriverState
*bs
,
321 char *filename
, int filename_size
);
322 void bdrv_get_full_backing_filename(BlockDriverState
*bs
,
323 char *dest
, size_t sz
);
324 int bdrv_can_snapshot(BlockDriverState
*bs
);
325 int bdrv_is_snapshot(BlockDriverState
*bs
);
326 BlockDriverState
*bdrv_snapshots(void);
327 int bdrv_snapshot_create(BlockDriverState
*bs
,
328 QEMUSnapshotInfo
*sn_info
);
329 int bdrv_snapshot_goto(BlockDriverState
*bs
,
330 const char *snapshot_id
);
331 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
);
332 int bdrv_snapshot_list(BlockDriverState
*bs
,
333 QEMUSnapshotInfo
**psn_info
);
334 int bdrv_snapshot_load_tmp(BlockDriverState
*bs
,
335 const char *snapshot_name
);
336 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
);
338 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
);
339 int path_is_absolute(const char *path
);
340 void path_combine(char *dest
, int dest_size
,
341 const char *base_path
,
342 const char *filename
);
344 int bdrv_save_vmstate(BlockDriverState
*bs
, const uint8_t *buf
,
345 int64_t pos
, int size
);
347 int bdrv_load_vmstate(BlockDriverState
*bs
, uint8_t *buf
,
348 int64_t pos
, int size
);
350 int bdrv_img_create(const char *filename
, const char *fmt
,
351 const char *base_filename
, const char *base_fmt
,
352 char *options
, uint64_t img_size
, int flags
);
354 void bdrv_set_buffer_alignment(BlockDriverState
*bs
, int align
);
355 void *qemu_blockalign(BlockDriverState
*bs
, size_t size
);
357 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
359 void bdrv_set_dirty_tracking(BlockDriverState
*bs
, int enable
);
360 int bdrv_get_dirty(BlockDriverState
*bs
, int64_t sector
);
361 void bdrv_reset_dirty(BlockDriverState
*bs
, int64_t cur_sector
,
363 int64_t bdrv_get_dirty_count(BlockDriverState
*bs
);
365 void bdrv_enable_copy_on_read(BlockDriverState
*bs
);
366 void bdrv_disable_copy_on_read(BlockDriverState
*bs
);
368 void bdrv_set_in_use(BlockDriverState
*bs
, int in_use
);
369 int bdrv_in_use(BlockDriverState
*bs
);
378 typedef struct BlockAcctCookie
{
380 int64_t start_time_ns
;
381 enum BlockAcctType type
;
384 void bdrv_acct_start(BlockDriverState
*bs
, BlockAcctCookie
*cookie
,
385 int64_t bytes
, enum BlockAcctType type
);
386 void bdrv_acct_done(BlockDriverState
*bs
, BlockAcctCookie
*cookie
);
391 BLKDBG_L1_GROW_ALLOC_TABLE
,
392 BLKDBG_L1_GROW_WRITE_TABLE
,
393 BLKDBG_L1_GROW_ACTIVATE_TABLE
,
397 BLKDBG_L2_UPDATE_COMPRESSED
,
398 BLKDBG_L2_ALLOC_COW_READ
,
399 BLKDBG_L2_ALLOC_WRITE
,
402 BLKDBG_READ_BACKING_AIO
,
403 BLKDBG_READ_COMPRESSED
,
406 BLKDBG_WRITE_COMPRESSED
,
414 BLKDBG_REFTABLE_LOAD
,
415 BLKDBG_REFTABLE_GROW
,
417 BLKDBG_REFBLOCK_LOAD
,
418 BLKDBG_REFBLOCK_UPDATE
,
419 BLKDBG_REFBLOCK_UPDATE_PART
,
420 BLKDBG_REFBLOCK_ALLOC
,
421 BLKDBG_REFBLOCK_ALLOC_HOOKUP
,
422 BLKDBG_REFBLOCK_ALLOC_WRITE
,
423 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS
,
424 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE
,
425 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE
,
427 BLKDBG_CLUSTER_ALLOC
,
428 BLKDBG_CLUSTER_ALLOC_BYTES
,
434 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
435 void bdrv_debug_event(BlockDriverState
*bs
, BlkDebugEvent event
);
438 /* Convenience for block device models */
440 typedef struct BlockConf
{
441 BlockDriverState
*bs
;
442 uint16_t physical_block_size
;
443 uint16_t logical_block_size
;
444 uint16_t min_io_size
;
445 uint32_t opt_io_size
;
447 uint32_t discard_granularity
;
450 static inline unsigned int get_physical_block_exp(BlockConf
*conf
)
452 unsigned int exp
= 0, size
;
454 for (size
= conf
->physical_block_size
;
455 size
> conf
->logical_block_size
;
463 #define DEFINE_BLOCK_PROPERTIES(_state, _conf) \
464 DEFINE_PROP_DRIVE("drive", _state, _conf.bs), \
465 DEFINE_PROP_BLOCKSIZE("logical_block_size", _state, \
466 _conf.logical_block_size, 512), \
467 DEFINE_PROP_BLOCKSIZE("physical_block_size", _state, \
468 _conf.physical_block_size, 512), \
469 DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0), \
470 DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0), \
471 DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1), \
472 DEFINE_PROP_UINT32("discard_granularity", _state, \
473 _conf.discard_granularity, 0)