5 #include "qemu-common.h"
6 #include "qemu/option.h"
7 #include "block/coroutine.h"
8 #include "qapi/qmp/qobject.h"
9 #include "qapi-types.h"
12 typedef struct BlockDriver BlockDriver
;
13 typedef struct BlockJob BlockJob
;
15 typedef struct BlockDriverInfo
{
16 /* in bytes, 0 if irrelevant */
18 /* offset at which the VM state can be saved (0 if not possible) */
19 int64_t vm_state_offset
;
23 typedef struct BlockFragInfo
{
24 uint64_t allocated_clusters
;
25 uint64_t total_clusters
;
26 uint64_t fragmented_clusters
;
27 uint64_t compressed_clusters
;
30 typedef struct QEMUSnapshotInfo
{
31 char id_str
[128]; /* unique snapshot id */
32 /* the following fields are informative. They are not needed for
33 the consistency of the snapshot */
34 char name
[256]; /* user chosen name */
35 uint64_t vm_state_size
; /* VM state info size */
36 uint32_t date_sec
; /* UTC date of the snapshot */
38 uint64_t vm_clock_nsec
; /* VM clock relative to boot */
41 /* Callbacks for block device models */
42 typedef struct BlockDevOps
{
44 * Runs when virtual media changed (monitor commands eject, change)
45 * Argument load is true on load and false on eject.
46 * Beware: doesn't run when a host device's physical media
47 * changes. Sure would be useful if it did.
48 * Device models with removable media must implement this callback.
50 void (*change_media_cb
)(void *opaque
, bool load
);
52 * Runs when an eject request is issued from the monitor, the tray
53 * is closed, and the medium is locked.
54 * Device models that do not implement is_medium_locked will not need
55 * this callback. Device models that can lock the medium or tray might
56 * want to implement the callback and unlock the tray when "force" is
57 * true, even if they do not support eject requests.
59 void (*eject_request_cb
)(void *opaque
, bool force
);
61 * Is the virtual tray open?
62 * Device models implement this only when the device has a tray.
64 bool (*is_tray_open
)(void *opaque
);
66 * Is the virtual medium locked into the device?
67 * Device models implement this only when device has such a lock.
69 bool (*is_medium_locked
)(void *opaque
);
71 * Runs when the size changed (e.g. monitor command block_resize)
73 void (*resize_cb
)(void *opaque
);
76 #define BDRV_O_RDWR 0x0002
77 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
78 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
79 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
80 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
81 #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
82 #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
83 #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
84 #define BDRV_O_INCOMING 0x0800 /* consistency hint for incoming migration */
85 #define BDRV_O_CHECK 0x1000 /* open solely for consistency check */
86 #define BDRV_O_ALLOW_RDWR 0x2000 /* allow reopen to change from r/o to r/w */
87 #define BDRV_O_UNMAP 0x4000 /* execute guest UNMAP/TRIM operations */
89 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
91 #define BDRV_SECTOR_BITS 9
92 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
93 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
96 BDRV_ACTION_REPORT
, BDRV_ACTION_IGNORE
, BDRV_ACTION_STOP
99 typedef QSIMPLEQ_HEAD(BlockReopenQueue
, BlockReopenQueueEntry
) BlockReopenQueue
;
101 typedef struct BDRVReopenState
{
102 BlockDriverState
*bs
;
108 void bdrv_iostatus_enable(BlockDriverState
*bs
);
109 void bdrv_iostatus_reset(BlockDriverState
*bs
);
110 void bdrv_iostatus_disable(BlockDriverState
*bs
);
111 bool bdrv_iostatus_is_enabled(const BlockDriverState
*bs
);
112 void bdrv_iostatus_set_err(BlockDriverState
*bs
, int error
);
113 void bdrv_info_print(Monitor
*mon
, const QObject
*data
);
114 void bdrv_info(Monitor
*mon
, QObject
**ret_data
);
115 void bdrv_stats_print(Monitor
*mon
, const QObject
*data
);
116 void bdrv_info_stats(Monitor
*mon
, QObject
**ret_data
);
118 /* disk I/O throttling */
119 void bdrv_io_limits_enable(BlockDriverState
*bs
);
120 void bdrv_io_limits_disable(BlockDriverState
*bs
);
121 bool bdrv_io_limits_enabled(BlockDriverState
*bs
);
123 void bdrv_init(void);
124 void bdrv_init_with_whitelist(void);
125 BlockDriver
*bdrv_find_protocol(const char *filename
);
126 BlockDriver
*bdrv_find_format(const char *format_name
);
127 BlockDriver
*bdrv_find_whitelisted_format(const char *format_name
);
128 int bdrv_create(BlockDriver
*drv
, const char* filename
,
129 QEMUOptionParameter
*options
);
130 int bdrv_create_file(const char* filename
, QEMUOptionParameter
*options
);
131 BlockDriverState
*bdrv_new(const char *device_name
);
132 void bdrv_make_anon(BlockDriverState
*bs
);
133 void bdrv_swap(BlockDriverState
*bs_new
, BlockDriverState
*bs_old
);
134 void bdrv_append(BlockDriverState
*bs_new
, BlockDriverState
*bs_top
);
135 void bdrv_delete(BlockDriverState
*bs
);
136 int bdrv_parse_cache_flags(const char *mode
, int *flags
);
137 int bdrv_parse_discard_flags(const char *mode
, int *flags
);
138 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
,
139 QDict
*options
, int flags
);
140 int bdrv_open_backing_file(BlockDriverState
*bs
);
141 int bdrv_open(BlockDriverState
*bs
, const char *filename
, QDict
*options
,
142 int flags
, BlockDriver
*drv
);
143 BlockReopenQueue
*bdrv_reopen_queue(BlockReopenQueue
*bs_queue
,
144 BlockDriverState
*bs
, int flags
);
145 int bdrv_reopen_multiple(BlockReopenQueue
*bs_queue
, Error
**errp
);
146 int bdrv_reopen(BlockDriverState
*bs
, int bdrv_flags
, Error
**errp
);
147 int bdrv_reopen_prepare(BDRVReopenState
*reopen_state
,
148 BlockReopenQueue
*queue
, Error
**errp
);
149 void bdrv_reopen_commit(BDRVReopenState
*reopen_state
);
150 void bdrv_reopen_abort(BDRVReopenState
*reopen_state
);
151 void bdrv_close(BlockDriverState
*bs
);
152 void bdrv_add_close_notifier(BlockDriverState
*bs
, Notifier
*notify
);
153 int bdrv_attach_dev(BlockDriverState
*bs
, void *dev
);
154 void bdrv_attach_dev_nofail(BlockDriverState
*bs
, void *dev
);
155 void bdrv_detach_dev(BlockDriverState
*bs
, void *dev
);
156 void *bdrv_get_attached_dev(BlockDriverState
*bs
);
157 void bdrv_set_dev_ops(BlockDriverState
*bs
, const BlockDevOps
*ops
,
159 void bdrv_dev_eject_request(BlockDriverState
*bs
, bool force
);
160 bool bdrv_dev_has_removable_media(BlockDriverState
*bs
);
161 bool bdrv_dev_is_tray_open(BlockDriverState
*bs
);
162 bool bdrv_dev_is_medium_locked(BlockDriverState
*bs
);
163 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
164 uint8_t *buf
, int nb_sectors
);
165 int bdrv_read_unthrottled(BlockDriverState
*bs
, int64_t sector_num
,
166 uint8_t *buf
, int nb_sectors
);
167 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
168 const uint8_t *buf
, int nb_sectors
);
169 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
170 void *buf
, int count
);
171 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
172 const void *buf
, int count
);
173 int bdrv_pwrite_sync(BlockDriverState
*bs
, int64_t offset
,
174 const void *buf
, int count
);
175 int coroutine_fn
bdrv_co_readv(BlockDriverState
*bs
, int64_t sector_num
,
176 int nb_sectors
, QEMUIOVector
*qiov
);
177 int coroutine_fn
bdrv_co_copy_on_readv(BlockDriverState
*bs
,
178 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
);
179 int coroutine_fn
bdrv_co_writev(BlockDriverState
*bs
, int64_t sector_num
,
180 int nb_sectors
, QEMUIOVector
*qiov
);
182 * Efficiently zero a region of the disk image. Note that this is a regular
183 * I/O request like read or write and should have a reasonable size. This
184 * function is not suitable for zeroing the entire image in a single request
185 * because it may allocate memory for the entire region.
187 int coroutine_fn
bdrv_co_write_zeroes(BlockDriverState
*bs
, int64_t sector_num
,
189 int coroutine_fn
bdrv_co_is_allocated(BlockDriverState
*bs
, int64_t sector_num
,
190 int nb_sectors
, int *pnum
);
191 int coroutine_fn
bdrv_co_is_allocated_above(BlockDriverState
*top
,
192 BlockDriverState
*base
,
194 int nb_sectors
, int *pnum
);
195 BlockDriverState
*bdrv_find_backing_image(BlockDriverState
*bs
,
196 const char *backing_file
);
197 int bdrv_get_backing_file_depth(BlockDriverState
*bs
);
198 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
);
199 int64_t bdrv_getlength(BlockDriverState
*bs
);
200 int64_t bdrv_get_allocated_file_size(BlockDriverState
*bs
);
201 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
);
202 int bdrv_commit(BlockDriverState
*bs
);
203 int bdrv_commit_all(void);
204 int bdrv_change_backing_file(BlockDriverState
*bs
,
205 const char *backing_file
, const char *backing_fmt
);
206 void bdrv_register(BlockDriver
*bdrv
);
207 int bdrv_drop_intermediate(BlockDriverState
*active
, BlockDriverState
*top
,
208 BlockDriverState
*base
);
209 BlockDriverState
*bdrv_find_overlay(BlockDriverState
*active
,
210 BlockDriverState
*bs
);
211 BlockDriverState
*bdrv_find_base(BlockDriverState
*bs
);
214 typedef struct BdrvCheckResult
{
218 int corruptions_fixed
;
220 int64_t image_end_offset
;
229 int bdrv_check(BlockDriverState
*bs
, BdrvCheckResult
*res
, BdrvCheckMode fix
);
231 /* async block I/O */
232 typedef void BlockDriverDirtyHandler(BlockDriverState
*bs
, int64_t sector
,
234 BlockDriverAIOCB
*bdrv_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
235 QEMUIOVector
*iov
, int nb_sectors
,
236 BlockDriverCompletionFunc
*cb
, void *opaque
);
237 BlockDriverAIOCB
*bdrv_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
238 QEMUIOVector
*iov
, int nb_sectors
,
239 BlockDriverCompletionFunc
*cb
, void *opaque
);
240 BlockDriverAIOCB
*bdrv_aio_flush(BlockDriverState
*bs
,
241 BlockDriverCompletionFunc
*cb
, void *opaque
);
242 BlockDriverAIOCB
*bdrv_aio_discard(BlockDriverState
*bs
,
243 int64_t sector_num
, int nb_sectors
,
244 BlockDriverCompletionFunc
*cb
, void *opaque
);
245 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
);
247 typedef struct BlockRequest
{
248 /* Fields to be filled by multiwrite caller */
252 BlockDriverCompletionFunc
*cb
;
255 /* Filled by multiwrite implementation */
259 int bdrv_aio_multiwrite(BlockDriverState
*bs
, BlockRequest
*reqs
,
262 /* sg packet commands */
263 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
);
264 BlockDriverAIOCB
*bdrv_aio_ioctl(BlockDriverState
*bs
,
265 unsigned long int req
, void *buf
,
266 BlockDriverCompletionFunc
*cb
, void *opaque
);
268 /* Invalidate any cached metadata used by image formats */
269 void bdrv_invalidate_cache(BlockDriverState
*bs
);
270 void bdrv_invalidate_cache_all(void);
272 void bdrv_clear_incoming_migration_all(void);
274 /* Ensure contents are flushed to disk. */
275 int bdrv_flush(BlockDriverState
*bs
);
276 int coroutine_fn
bdrv_co_flush(BlockDriverState
*bs
);
277 void bdrv_flush_all(void);
278 void bdrv_close_all(void);
279 void bdrv_drain_all(void);
281 int bdrv_discard(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
);
282 int bdrv_co_discard(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
);
283 int bdrv_has_zero_init(BlockDriverState
*bs
);
284 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
286 int bdrv_is_allocated_above(BlockDriverState
*top
, BlockDriverState
*base
,
287 int64_t sector_num
, int nb_sectors
, int *pnum
);
289 void bdrv_set_on_error(BlockDriverState
*bs
, BlockdevOnError on_read_error
,
290 BlockdevOnError on_write_error
);
291 BlockdevOnError
bdrv_get_on_error(BlockDriverState
*bs
, bool is_read
);
292 BlockErrorAction
bdrv_get_error_action(BlockDriverState
*bs
, bool is_read
, int error
);
293 void bdrv_error_action(BlockDriverState
*bs
, BlockErrorAction action
,
294 bool is_read
, int error
);
295 int bdrv_is_read_only(BlockDriverState
*bs
);
296 int bdrv_is_sg(BlockDriverState
*bs
);
297 int bdrv_enable_write_cache(BlockDriverState
*bs
);
298 void bdrv_set_enable_write_cache(BlockDriverState
*bs
, bool wce
);
299 int bdrv_is_inserted(BlockDriverState
*bs
);
300 int bdrv_media_changed(BlockDriverState
*bs
);
301 void bdrv_lock_medium(BlockDriverState
*bs
, bool locked
);
302 void bdrv_eject(BlockDriverState
*bs
, bool eject_flag
);
303 const char *bdrv_get_format_name(BlockDriverState
*bs
);
304 BlockDriverState
*bdrv_find(const char *name
);
305 BlockDriverState
*bdrv_next(BlockDriverState
*bs
);
306 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
),
308 int bdrv_is_encrypted(BlockDriverState
*bs
);
309 int bdrv_key_required(BlockDriverState
*bs
);
310 int bdrv_set_key(BlockDriverState
*bs
, const char *key
);
311 int bdrv_query_missing_keys(void);
312 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
314 const char *bdrv_get_device_name(BlockDriverState
*bs
);
315 int bdrv_get_flags(BlockDriverState
*bs
);
316 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
317 const uint8_t *buf
, int nb_sectors
);
318 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
);
319 void bdrv_round_to_clusters(BlockDriverState
*bs
,
320 int64_t sector_num
, int nb_sectors
,
321 int64_t *cluster_sector_num
,
322 int *cluster_nb_sectors
);
324 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
);
325 void bdrv_get_backing_filename(BlockDriverState
*bs
,
326 char *filename
, int filename_size
);
327 void bdrv_get_full_backing_filename(BlockDriverState
*bs
,
328 char *dest
, size_t sz
);
329 BlockInfo
*bdrv_query_info(BlockDriverState
*s
);
330 BlockStats
*bdrv_query_stats(const BlockDriverState
*bs
);
331 int bdrv_can_snapshot(BlockDriverState
*bs
);
332 int bdrv_is_snapshot(BlockDriverState
*bs
);
333 BlockDriverState
*bdrv_snapshots(void);
334 int bdrv_snapshot_create(BlockDriverState
*bs
,
335 QEMUSnapshotInfo
*sn_info
);
336 int bdrv_snapshot_goto(BlockDriverState
*bs
,
337 const char *snapshot_id
);
338 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
);
339 int bdrv_snapshot_list(BlockDriverState
*bs
,
340 QEMUSnapshotInfo
**psn_info
);
341 int bdrv_snapshot_load_tmp(BlockDriverState
*bs
,
342 const char *snapshot_name
);
343 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
);
345 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
);
346 int path_is_absolute(const char *path
);
347 void path_combine(char *dest
, int dest_size
,
348 const char *base_path
,
349 const char *filename
);
351 int bdrv_writev_vmstate(BlockDriverState
*bs
, QEMUIOVector
*qiov
, int64_t pos
);
352 int bdrv_save_vmstate(BlockDriverState
*bs
, const uint8_t *buf
,
353 int64_t pos
, int size
);
355 int bdrv_load_vmstate(BlockDriverState
*bs
, uint8_t *buf
,
356 int64_t pos
, int size
);
358 void bdrv_img_create(const char *filename
, const char *fmt
,
359 const char *base_filename
, const char *base_fmt
,
360 char *options
, uint64_t img_size
, int flags
,
361 Error
**errp
, bool quiet
);
363 void bdrv_set_buffer_alignment(BlockDriverState
*bs
, int align
);
364 void *qemu_blockalign(BlockDriverState
*bs
, size_t size
);
365 bool bdrv_qiov_is_aligned(BlockDriverState
*bs
, QEMUIOVector
*qiov
);
368 void bdrv_set_dirty_tracking(BlockDriverState
*bs
, int granularity
);
369 int bdrv_get_dirty(BlockDriverState
*bs
, int64_t sector
);
370 void bdrv_set_dirty(BlockDriverState
*bs
, int64_t cur_sector
, int nr_sectors
);
371 void bdrv_reset_dirty(BlockDriverState
*bs
, int64_t cur_sector
, int nr_sectors
);
372 void bdrv_dirty_iter_init(BlockDriverState
*bs
, struct HBitmapIter
*hbi
);
373 int64_t bdrv_get_dirty_count(BlockDriverState
*bs
);
375 void bdrv_enable_copy_on_read(BlockDriverState
*bs
);
376 void bdrv_disable_copy_on_read(BlockDriverState
*bs
);
378 void bdrv_set_in_use(BlockDriverState
*bs
, int in_use
);
379 int bdrv_in_use(BlockDriverState
*bs
);
381 #ifdef CONFIG_LINUX_AIO
382 int raw_get_aio_fd(BlockDriverState
*bs
);
384 static inline int raw_get_aio_fd(BlockDriverState
*bs
)
397 typedef struct BlockAcctCookie
{
399 int64_t start_time_ns
;
400 enum BlockAcctType type
;
403 void bdrv_acct_start(BlockDriverState
*bs
, BlockAcctCookie
*cookie
,
404 int64_t bytes
, enum BlockAcctType type
);
405 void bdrv_acct_done(BlockDriverState
*bs
, BlockAcctCookie
*cookie
);
410 BLKDBG_L1_GROW_ALLOC_TABLE
,
411 BLKDBG_L1_GROW_WRITE_TABLE
,
412 BLKDBG_L1_GROW_ACTIVATE_TABLE
,
416 BLKDBG_L2_UPDATE_COMPRESSED
,
417 BLKDBG_L2_ALLOC_COW_READ
,
418 BLKDBG_L2_ALLOC_WRITE
,
421 BLKDBG_READ_BACKING_AIO
,
422 BLKDBG_READ_COMPRESSED
,
425 BLKDBG_WRITE_COMPRESSED
,
433 BLKDBG_REFTABLE_LOAD
,
434 BLKDBG_REFTABLE_GROW
,
436 BLKDBG_REFBLOCK_LOAD
,
437 BLKDBG_REFBLOCK_UPDATE
,
438 BLKDBG_REFBLOCK_UPDATE_PART
,
439 BLKDBG_REFBLOCK_ALLOC
,
440 BLKDBG_REFBLOCK_ALLOC_HOOKUP
,
441 BLKDBG_REFBLOCK_ALLOC_WRITE
,
442 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS
,
443 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE
,
444 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE
,
446 BLKDBG_CLUSTER_ALLOC
,
447 BLKDBG_CLUSTER_ALLOC_BYTES
,
453 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
454 void bdrv_debug_event(BlockDriverState
*bs
, BlkDebugEvent event
);
456 int bdrv_debug_breakpoint(BlockDriverState
*bs
, const char *event
,
458 int bdrv_debug_resume(BlockDriverState
*bs
, const char *tag
);
459 bool bdrv_debug_is_suspended(BlockDriverState
*bs
, const char *tag
);