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 */
82 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
84 #define BDRV_SECTOR_BITS 9
85 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
86 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
89 BLOCK_ERR_REPORT
, BLOCK_ERR_IGNORE
, BLOCK_ERR_STOP_ENOSPC
,
94 BDRV_ACTION_REPORT
, BDRV_ACTION_IGNORE
, BDRV_ACTION_STOP
95 } BlockQMPEventAction
;
97 void bdrv_iostatus_enable(BlockDriverState
*bs
);
98 void bdrv_iostatus_reset(BlockDriverState
*bs
);
99 void bdrv_iostatus_disable(BlockDriverState
*bs
);
100 bool bdrv_iostatus_is_enabled(const BlockDriverState
*bs
);
101 void bdrv_iostatus_set_err(BlockDriverState
*bs
, int error
);
102 void bdrv_emit_qmp_error_event(const BlockDriverState
*bdrv
,
103 BlockQMPEventAction action
, int is_read
);
104 void bdrv_info_print(Monitor
*mon
, const QObject
*data
);
105 void bdrv_info(Monitor
*mon
, QObject
**ret_data
);
106 void bdrv_stats_print(Monitor
*mon
, const QObject
*data
);
107 void bdrv_info_stats(Monitor
*mon
, QObject
**ret_data
);
109 /* disk I/O throttling */
110 void bdrv_io_limits_enable(BlockDriverState
*bs
);
111 void bdrv_io_limits_disable(BlockDriverState
*bs
);
112 bool bdrv_io_limits_enabled(BlockDriverState
*bs
);
114 void bdrv_init(void);
115 void bdrv_init_with_whitelist(void);
116 BlockDriver
*bdrv_find_protocol(const char *filename
);
117 BlockDriver
*bdrv_find_format(const char *format_name
);
118 BlockDriver
*bdrv_find_whitelisted_format(const char *format_name
);
119 int bdrv_create(BlockDriver
*drv
, const char* filename
,
120 QEMUOptionParameter
*options
);
121 int bdrv_create_file(const char* filename
, QEMUOptionParameter
*options
);
122 BlockDriverState
*bdrv_new(const char *device_name
);
123 void bdrv_make_anon(BlockDriverState
*bs
);
124 void bdrv_append(BlockDriverState
*bs_new
, BlockDriverState
*bs_top
);
125 void bdrv_delete(BlockDriverState
*bs
);
126 int bdrv_parse_cache_flags(const char *mode
, int *flags
);
127 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
, int flags
);
128 int bdrv_open(BlockDriverState
*bs
, const char *filename
, int flags
,
130 void bdrv_close(BlockDriverState
*bs
);
131 int bdrv_attach_dev(BlockDriverState
*bs
, void *dev
);
132 void bdrv_attach_dev_nofail(BlockDriverState
*bs
, void *dev
);
133 void bdrv_detach_dev(BlockDriverState
*bs
, void *dev
);
134 void *bdrv_get_attached_dev(BlockDriverState
*bs
);
135 void bdrv_set_dev_ops(BlockDriverState
*bs
, const BlockDevOps
*ops
,
137 void bdrv_dev_eject_request(BlockDriverState
*bs
, bool force
);
138 bool bdrv_dev_has_removable_media(BlockDriverState
*bs
);
139 bool bdrv_dev_is_tray_open(BlockDriverState
*bs
);
140 bool bdrv_dev_is_medium_locked(BlockDriverState
*bs
);
141 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
142 uint8_t *buf
, int nb_sectors
);
143 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
144 const uint8_t *buf
, int nb_sectors
);
145 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
146 void *buf
, int count
);
147 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
148 const void *buf
, int count
);
149 int bdrv_pwrite_sync(BlockDriverState
*bs
, int64_t offset
,
150 const void *buf
, int count
);
151 int coroutine_fn
bdrv_co_readv(BlockDriverState
*bs
, int64_t sector_num
,
152 int nb_sectors
, QEMUIOVector
*qiov
);
153 int coroutine_fn
bdrv_co_copy_on_readv(BlockDriverState
*bs
,
154 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
);
155 int coroutine_fn
bdrv_co_writev(BlockDriverState
*bs
, int64_t sector_num
,
156 int nb_sectors
, QEMUIOVector
*qiov
);
158 * Efficiently zero a region of the disk image. Note that this is a regular
159 * I/O request like read or write and should have a reasonable size. This
160 * function is not suitable for zeroing the entire image in a single request
161 * because it may allocate memory for the entire region.
163 int coroutine_fn
bdrv_co_write_zeroes(BlockDriverState
*bs
, int64_t sector_num
,
165 int coroutine_fn
bdrv_co_is_allocated(BlockDriverState
*bs
, int64_t sector_num
,
166 int nb_sectors
, int *pnum
);
167 BlockDriverState
*bdrv_find_backing_image(BlockDriverState
*bs
,
168 const char *backing_file
);
169 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
);
170 int64_t bdrv_getlength(BlockDriverState
*bs
);
171 int64_t bdrv_get_allocated_file_size(BlockDriverState
*bs
);
172 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
);
173 void bdrv_guess_geometry(BlockDriverState
*bs
, int *pcyls
, int *pheads
, int *psecs
);
174 int bdrv_commit(BlockDriverState
*bs
);
175 int bdrv_commit_all(void);
176 int bdrv_change_backing_file(BlockDriverState
*bs
,
177 const char *backing_file
, const char *backing_fmt
);
178 void bdrv_register(BlockDriver
*bdrv
);
181 typedef struct BdrvCheckResult
{
188 int bdrv_check(BlockDriverState
*bs
, BdrvCheckResult
*res
);
190 /* async block I/O */
191 typedef void BlockDriverDirtyHandler(BlockDriverState
*bs
, int64_t sector
,
193 BlockDriverAIOCB
*bdrv_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
194 QEMUIOVector
*iov
, int nb_sectors
,
195 BlockDriverCompletionFunc
*cb
, void *opaque
);
196 BlockDriverAIOCB
*bdrv_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
197 QEMUIOVector
*iov
, int nb_sectors
,
198 BlockDriverCompletionFunc
*cb
, void *opaque
);
199 BlockDriverAIOCB
*bdrv_aio_flush(BlockDriverState
*bs
,
200 BlockDriverCompletionFunc
*cb
, void *opaque
);
201 BlockDriverAIOCB
*bdrv_aio_discard(BlockDriverState
*bs
,
202 int64_t sector_num
, int nb_sectors
,
203 BlockDriverCompletionFunc
*cb
, void *opaque
);
204 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
);
206 typedef struct BlockRequest
{
207 /* Fields to be filled by multiwrite caller */
211 BlockDriverCompletionFunc
*cb
;
214 /* Filled by multiwrite implementation */
218 int bdrv_aio_multiwrite(BlockDriverState
*bs
, BlockRequest
*reqs
,
221 /* sg packet commands */
222 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
);
223 BlockDriverAIOCB
*bdrv_aio_ioctl(BlockDriverState
*bs
,
224 unsigned long int req
, void *buf
,
225 BlockDriverCompletionFunc
*cb
, void *opaque
);
227 /* Invalidate any cached metadata used by image formats */
228 void bdrv_invalidate_cache(BlockDriverState
*bs
);
229 void bdrv_invalidate_cache_all(void);
231 /* Ensure contents are flushed to disk. */
232 int bdrv_flush(BlockDriverState
*bs
);
233 int coroutine_fn
bdrv_co_flush(BlockDriverState
*bs
);
234 void bdrv_flush_all(void);
235 void bdrv_close_all(void);
236 void bdrv_drain_all(void);
238 int bdrv_discard(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
);
239 int bdrv_co_discard(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
);
240 int bdrv_has_zero_init(BlockDriverState
*bs
);
241 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
244 #define BIOS_ATA_TRANSLATION_AUTO 0
245 #define BIOS_ATA_TRANSLATION_NONE 1
246 #define BIOS_ATA_TRANSLATION_LBA 2
247 #define BIOS_ATA_TRANSLATION_LARGE 3
248 #define BIOS_ATA_TRANSLATION_RECHS 4
250 void bdrv_set_geometry_hint(BlockDriverState
*bs
,
251 int cyls
, int heads
, int secs
);
252 void bdrv_set_translation_hint(BlockDriverState
*bs
, int translation
);
253 void bdrv_get_geometry_hint(BlockDriverState
*bs
,
254 int *pcyls
, int *pheads
, int *psecs
);
255 typedef enum FDriveType
{
256 FDRIVE_DRV_144
= 0x00, /* 1.44 MB 3"5 drive */
257 FDRIVE_DRV_288
= 0x01, /* 2.88 MB 3"5 drive */
258 FDRIVE_DRV_120
= 0x02, /* 1.2 MB 5"25 drive */
259 FDRIVE_DRV_NONE
= 0x03, /* No drive connected */
262 typedef enum FDriveRate
{
263 FDRIVE_RATE_500K
= 0x00, /* 500 Kbps */
264 FDRIVE_RATE_300K
= 0x01, /* 300 Kbps */
265 FDRIVE_RATE_250K
= 0x02, /* 250 Kbps */
266 FDRIVE_RATE_1M
= 0x03, /* 1 Mbps */
269 void bdrv_get_floppy_geometry_hint(BlockDriverState
*bs
, int *nb_heads
,
270 int *max_track
, int *last_sect
,
271 FDriveType drive_in
, FDriveType
*drive
,
273 int bdrv_get_translation_hint(BlockDriverState
*bs
);
274 void bdrv_set_on_error(BlockDriverState
*bs
, BlockErrorAction on_read_error
,
275 BlockErrorAction on_write_error
);
276 BlockErrorAction
bdrv_get_on_error(BlockDriverState
*bs
, int is_read
);
277 int bdrv_is_read_only(BlockDriverState
*bs
);
278 int bdrv_is_sg(BlockDriverState
*bs
);
279 int bdrv_enable_write_cache(BlockDriverState
*bs
);
280 int bdrv_is_inserted(BlockDriverState
*bs
);
281 int bdrv_media_changed(BlockDriverState
*bs
);
282 void bdrv_lock_medium(BlockDriverState
*bs
, bool locked
);
283 void bdrv_eject(BlockDriverState
*bs
, bool eject_flag
);
284 void bdrv_get_format(BlockDriverState
*bs
, char *buf
, int buf_size
);
285 BlockDriverState
*bdrv_find(const char *name
);
286 BlockDriverState
*bdrv_next(BlockDriverState
*bs
);
287 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
),
289 int bdrv_is_encrypted(BlockDriverState
*bs
);
290 int bdrv_key_required(BlockDriverState
*bs
);
291 int bdrv_set_key(BlockDriverState
*bs
, const char *key
);
292 int bdrv_query_missing_keys(void);
293 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
295 const char *bdrv_get_device_name(BlockDriverState
*bs
);
296 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
297 const uint8_t *buf
, int nb_sectors
);
298 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
);
300 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
);
301 void bdrv_get_backing_filename(BlockDriverState
*bs
,
302 char *filename
, int filename_size
);
303 int bdrv_can_snapshot(BlockDriverState
*bs
);
304 int bdrv_is_snapshot(BlockDriverState
*bs
);
305 BlockDriverState
*bdrv_snapshots(void);
306 int bdrv_snapshot_create(BlockDriverState
*bs
,
307 QEMUSnapshotInfo
*sn_info
);
308 int bdrv_snapshot_goto(BlockDriverState
*bs
,
309 const char *snapshot_id
);
310 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
);
311 int bdrv_snapshot_list(BlockDriverState
*bs
,
312 QEMUSnapshotInfo
**psn_info
);
313 int bdrv_snapshot_load_tmp(BlockDriverState
*bs
,
314 const char *snapshot_name
);
315 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
);
317 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
);
318 int path_is_absolute(const char *path
);
319 void path_combine(char *dest
, int dest_size
,
320 const char *base_path
,
321 const char *filename
);
323 int bdrv_save_vmstate(BlockDriverState
*bs
, const uint8_t *buf
,
324 int64_t pos
, int size
);
326 int bdrv_load_vmstate(BlockDriverState
*bs
, uint8_t *buf
,
327 int64_t pos
, int size
);
329 int bdrv_img_create(const char *filename
, const char *fmt
,
330 const char *base_filename
, const char *base_fmt
,
331 char *options
, uint64_t img_size
, int flags
);
333 void bdrv_set_buffer_alignment(BlockDriverState
*bs
, int align
);
334 void *qemu_blockalign(BlockDriverState
*bs
, size_t size
);
336 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
338 void bdrv_set_dirty_tracking(BlockDriverState
*bs
, int enable
);
339 int bdrv_get_dirty(BlockDriverState
*bs
, int64_t sector
);
340 void bdrv_reset_dirty(BlockDriverState
*bs
, int64_t cur_sector
,
342 int64_t bdrv_get_dirty_count(BlockDriverState
*bs
);
344 void bdrv_enable_copy_on_read(BlockDriverState
*bs
);
345 void bdrv_disable_copy_on_read(BlockDriverState
*bs
);
347 void bdrv_set_in_use(BlockDriverState
*bs
, int in_use
);
348 int bdrv_in_use(BlockDriverState
*bs
);
357 typedef struct BlockAcctCookie
{
359 int64_t start_time_ns
;
360 enum BlockAcctType type
;
363 void bdrv_acct_start(BlockDriverState
*bs
, BlockAcctCookie
*cookie
,
364 int64_t bytes
, enum BlockAcctType type
);
365 void bdrv_acct_done(BlockDriverState
*bs
, BlockAcctCookie
*cookie
);
370 BLKDBG_L1_GROW_ALLOC_TABLE
,
371 BLKDBG_L1_GROW_WRITE_TABLE
,
372 BLKDBG_L1_GROW_ACTIVATE_TABLE
,
376 BLKDBG_L2_UPDATE_COMPRESSED
,
377 BLKDBG_L2_ALLOC_COW_READ
,
378 BLKDBG_L2_ALLOC_WRITE
,
383 BLKDBG_READ_BACKING_AIO
,
384 BLKDBG_READ_COMPRESSED
,
387 BLKDBG_WRITE_COMPRESSED
,
395 BLKDBG_REFTABLE_LOAD
,
396 BLKDBG_REFTABLE_GROW
,
398 BLKDBG_REFBLOCK_LOAD
,
399 BLKDBG_REFBLOCK_UPDATE
,
400 BLKDBG_REFBLOCK_UPDATE_PART
,
401 BLKDBG_REFBLOCK_ALLOC
,
402 BLKDBG_REFBLOCK_ALLOC_HOOKUP
,
403 BLKDBG_REFBLOCK_ALLOC_WRITE
,
404 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS
,
405 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE
,
406 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE
,
408 BLKDBG_CLUSTER_ALLOC
,
409 BLKDBG_CLUSTER_ALLOC_BYTES
,
415 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
416 void bdrv_debug_event(BlockDriverState
*bs
, BlkDebugEvent event
);
419 /* Convenience for block device models */
421 typedef struct BlockConf
{
422 BlockDriverState
*bs
;
423 uint16_t physical_block_size
;
424 uint16_t logical_block_size
;
425 uint16_t min_io_size
;
426 uint32_t opt_io_size
;
428 uint32_t discard_granularity
;
431 static inline unsigned int get_physical_block_exp(BlockConf
*conf
)
433 unsigned int exp
= 0, size
;
435 for (size
= conf
->physical_block_size
;
436 size
> conf
->logical_block_size
;
444 #define DEFINE_BLOCK_PROPERTIES(_state, _conf) \
445 DEFINE_PROP_DRIVE("drive", _state, _conf.bs), \
446 DEFINE_PROP_BLOCKSIZE("logical_block_size", _state, \
447 _conf.logical_block_size, 512), \
448 DEFINE_PROP_BLOCKSIZE("physical_block_size", _state, \
449 _conf.physical_block_size, 512), \
450 DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0), \
451 DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0), \
452 DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1), \
453 DEFINE_PROP_UINT32("discard_granularity", _state, \
454 _conf.discard_granularity, 0)