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 /* Callbacks for block device models */
31 typedef struct BlockDevOps
{
33 * Runs when virtual media changed (monitor commands eject, change)
34 * Argument load is true on load and false on eject.
35 * Beware: doesn't run when a host device's physical media
36 * changes. Sure would be useful if it did.
37 * Device models with removable media must implement this callback.
39 void (*change_media_cb
)(void *opaque
, bool load
);
41 * Runs when an eject request is issued from the monitor, the tray
42 * is closed, and the medium is locked.
43 * Device models that do not implement is_medium_locked will not need
44 * this callback. Device models that can lock the medium or tray might
45 * want to implement the callback and unlock the tray when "force" is
46 * true, even if they do not support eject requests.
48 void (*eject_request_cb
)(void *opaque
, bool force
);
50 * Is the virtual tray open?
51 * Device models implement this only when the device has a tray.
53 bool (*is_tray_open
)(void *opaque
);
55 * Is the virtual medium locked into the device?
56 * Device models implement this only when device has such a lock.
58 bool (*is_medium_locked
)(void *opaque
);
60 * Runs when the size changed (e.g. monitor command block_resize)
62 void (*resize_cb
)(void *opaque
);
66 BDRV_REQ_COPY_ON_READ
= 0x1,
67 BDRV_REQ_ZERO_WRITE
= 0x2,
68 /* The BDRV_REQ_MAY_UNMAP flag is used to indicate that the block driver
69 * is allowed to optimize a write zeroes request by unmapping (discarding)
70 * blocks if it is guaranteed that the result will read back as
71 * zeroes. The flag is only passed to the driver if the block device is
72 * opened with BDRV_O_UNMAP.
74 BDRV_REQ_MAY_UNMAP
= 0x4,
77 #define BDRV_O_RDWR 0x0002
78 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
79 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
80 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
81 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
82 #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
83 #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
84 #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
85 #define BDRV_O_INCOMING 0x0800 /* consistency hint for incoming migration */
86 #define BDRV_O_CHECK 0x1000 /* open solely for consistency check */
87 #define BDRV_O_ALLOW_RDWR 0x2000 /* allow reopen to change from r/o to r/w */
88 #define BDRV_O_UNMAP 0x4000 /* execute guest UNMAP/TRIM operations */
90 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
92 #define BDRV_SECTOR_BITS 9
93 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
94 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
96 /* BDRV_BLOCK_DATA: data is read from bs->file or another file
97 * BDRV_BLOCK_ZERO: sectors read as zero
98 * BDRV_BLOCK_OFFSET_VALID: sector stored in bs->file as raw data
99 * BDRV_BLOCK_RAW: used internally to indicate that the request
100 * was answered by the raw driver and that one
101 * should look in bs->file directly.
103 * If BDRV_BLOCK_OFFSET_VALID is set, bits 9-62 represent the offset in
104 * bs->file where sector data can be read from as raw data.
106 * DATA == 0 && ZERO == 0 means that data is read from backing_hd if present.
108 * DATA ZERO OFFSET_VALID
109 * t t t sectors read as zero, bs->file is zero at offset
110 * t f t sectors read as valid from bs->file at offset
111 * f t t sectors preallocated, read as zero, bs->file not
112 * necessarily zero at offset
113 * f f t sectors preallocated but read from backing_hd,
114 * bs->file contains garbage at offset
115 * t t f sectors preallocated, read as zero, unknown offset
116 * t f f sectors read from unknown file or offset
117 * f t f not allocated or unknown offset, read as zero
118 * f f f not allocated or unknown offset, read from backing_hd
120 #define BDRV_BLOCK_DATA 1
121 #define BDRV_BLOCK_ZERO 2
122 #define BDRV_BLOCK_OFFSET_VALID 4
123 #define BDRV_BLOCK_RAW 8
124 #define BDRV_BLOCK_OFFSET_MASK BDRV_SECTOR_MASK
127 BDRV_ACTION_REPORT
, BDRV_ACTION_IGNORE
, BDRV_ACTION_STOP
130 typedef QSIMPLEQ_HEAD(BlockReopenQueue
, BlockReopenQueueEntry
) BlockReopenQueue
;
132 typedef struct BDRVReopenState
{
133 BlockDriverState
*bs
;
139 void bdrv_iostatus_enable(BlockDriverState
*bs
);
140 void bdrv_iostatus_reset(BlockDriverState
*bs
);
141 void bdrv_iostatus_disable(BlockDriverState
*bs
);
142 bool bdrv_iostatus_is_enabled(const BlockDriverState
*bs
);
143 void bdrv_iostatus_set_err(BlockDriverState
*bs
, int error
);
144 void bdrv_info_print(Monitor
*mon
, const QObject
*data
);
145 void bdrv_info(Monitor
*mon
, QObject
**ret_data
);
146 void bdrv_stats_print(Monitor
*mon
, const QObject
*data
);
147 void bdrv_info_stats(Monitor
*mon
, QObject
**ret_data
);
149 /* disk I/O throttling */
150 void bdrv_io_limits_enable(BlockDriverState
*bs
);
151 void bdrv_io_limits_disable(BlockDriverState
*bs
);
153 void bdrv_init(void);
154 void bdrv_init_with_whitelist(void);
155 BlockDriver
*bdrv_find_protocol(const char *filename
,
156 bool allow_protocol_prefix
);
157 BlockDriver
*bdrv_find_format(const char *format_name
);
158 BlockDriver
*bdrv_find_whitelisted_format(const char *format_name
,
160 int bdrv_create(BlockDriver
*drv
, const char* filename
,
161 QEMUOptionParameter
*options
, Error
**errp
);
162 int bdrv_create_file(const char* filename
, QEMUOptionParameter
*options
,
164 BlockDriverState
*bdrv_new(const char *device_name
);
165 void bdrv_make_anon(BlockDriverState
*bs
);
166 void bdrv_swap(BlockDriverState
*bs_new
, BlockDriverState
*bs_old
);
167 void bdrv_append(BlockDriverState
*bs_new
, BlockDriverState
*bs_top
);
168 int bdrv_parse_cache_flags(const char *mode
, int *flags
);
169 int bdrv_parse_discard_flags(const char *mode
, int *flags
);
170 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
,
171 QDict
*options
, int flags
, Error
**errp
);
172 int bdrv_open_backing_file(BlockDriverState
*bs
, QDict
*options
, Error
**errp
);
173 int bdrv_open(BlockDriverState
*bs
, const char *filename
, QDict
*options
,
174 int flags
, BlockDriver
*drv
, Error
**errp
);
175 BlockReopenQueue
*bdrv_reopen_queue(BlockReopenQueue
*bs_queue
,
176 BlockDriverState
*bs
, int flags
);
177 int bdrv_reopen_multiple(BlockReopenQueue
*bs_queue
, Error
**errp
);
178 int bdrv_reopen(BlockDriverState
*bs
, int bdrv_flags
, Error
**errp
);
179 int bdrv_reopen_prepare(BDRVReopenState
*reopen_state
,
180 BlockReopenQueue
*queue
, Error
**errp
);
181 void bdrv_reopen_commit(BDRVReopenState
*reopen_state
);
182 void bdrv_reopen_abort(BDRVReopenState
*reopen_state
);
183 void bdrv_close(BlockDriverState
*bs
);
184 void bdrv_add_close_notifier(BlockDriverState
*bs
, Notifier
*notify
);
185 int bdrv_attach_dev(BlockDriverState
*bs
, void *dev
);
186 void bdrv_attach_dev_nofail(BlockDriverState
*bs
, void *dev
);
187 void bdrv_detach_dev(BlockDriverState
*bs
, void *dev
);
188 void *bdrv_get_attached_dev(BlockDriverState
*bs
);
189 void bdrv_set_dev_ops(BlockDriverState
*bs
, const BlockDevOps
*ops
,
191 void bdrv_dev_eject_request(BlockDriverState
*bs
, bool force
);
192 bool bdrv_dev_has_removable_media(BlockDriverState
*bs
);
193 bool bdrv_dev_is_tray_open(BlockDriverState
*bs
);
194 bool bdrv_dev_is_medium_locked(BlockDriverState
*bs
);
195 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
196 uint8_t *buf
, int nb_sectors
);
197 int bdrv_read_unthrottled(BlockDriverState
*bs
, int64_t sector_num
,
198 uint8_t *buf
, int nb_sectors
);
199 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
200 const uint8_t *buf
, int nb_sectors
);
201 int bdrv_write_zeroes(BlockDriverState
*bs
, int64_t sector_num
,
202 int nb_sectors
, BdrvRequestFlags flags
);
203 int bdrv_writev(BlockDriverState
*bs
, int64_t sector_num
, QEMUIOVector
*qiov
);
204 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
205 void *buf
, int count
);
206 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
207 const void *buf
, int count
);
208 int bdrv_pwritev(BlockDriverState
*bs
, int64_t offset
, QEMUIOVector
*qiov
);
209 int bdrv_pwrite_sync(BlockDriverState
*bs
, int64_t offset
,
210 const void *buf
, int count
);
211 int coroutine_fn
bdrv_co_readv(BlockDriverState
*bs
, int64_t sector_num
,
212 int nb_sectors
, QEMUIOVector
*qiov
);
213 int coroutine_fn
bdrv_co_copy_on_readv(BlockDriverState
*bs
,
214 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
);
215 int coroutine_fn
bdrv_co_writev(BlockDriverState
*bs
, int64_t sector_num
,
216 int nb_sectors
, QEMUIOVector
*qiov
);
218 * Efficiently zero a region of the disk image. Note that this is a regular
219 * I/O request like read or write and should have a reasonable size. This
220 * function is not suitable for zeroing the entire image in a single request
221 * because it may allocate memory for the entire region.
223 int coroutine_fn
bdrv_co_write_zeroes(BlockDriverState
*bs
, int64_t sector_num
,
224 int nb_sectors
, BdrvRequestFlags flags
);
225 BlockDriverState
*bdrv_find_backing_image(BlockDriverState
*bs
,
226 const char *backing_file
);
227 int bdrv_get_backing_file_depth(BlockDriverState
*bs
);
228 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
);
229 int64_t bdrv_getlength(BlockDriverState
*bs
);
230 int64_t bdrv_get_allocated_file_size(BlockDriverState
*bs
);
231 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
);
232 int bdrv_commit(BlockDriverState
*bs
);
233 int bdrv_commit_all(void);
234 int bdrv_change_backing_file(BlockDriverState
*bs
,
235 const char *backing_file
, const char *backing_fmt
);
236 void bdrv_register(BlockDriver
*bdrv
);
237 int bdrv_drop_intermediate(BlockDriverState
*active
, BlockDriverState
*top
,
238 BlockDriverState
*base
);
239 BlockDriverState
*bdrv_find_overlay(BlockDriverState
*active
,
240 BlockDriverState
*bs
);
241 BlockDriverState
*bdrv_find_base(BlockDriverState
*bs
);
244 typedef struct BdrvCheckResult
{
248 int corruptions_fixed
;
250 int64_t image_end_offset
;
259 int bdrv_check(BlockDriverState
*bs
, BdrvCheckResult
*res
, BdrvCheckMode fix
);
261 int bdrv_amend_options(BlockDriverState
*bs_new
, QEMUOptionParameter
*options
);
263 /* external snapshots */
266 EXT_SNAPSHOT_ALLOWED
,
267 EXT_SNAPSHOT_FORBIDDEN
,
270 /* return EXT_SNAPSHOT_ALLOWED if external snapshot is allowed
271 * return EXT_SNAPSHOT_FORBIDDEN if external snapshot is forbidden
273 ExtSnapshotPerm
bdrv_check_ext_snapshot(BlockDriverState
*bs
);
274 /* helper used to forbid external snapshots like in blkverify */
275 ExtSnapshotPerm
bdrv_check_ext_snapshot_forbidden(BlockDriverState
*bs
);
277 /* async block I/O */
278 typedef void BlockDriverDirtyHandler(BlockDriverState
*bs
, int64_t sector
,
280 BlockDriverAIOCB
*bdrv_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
281 QEMUIOVector
*iov
, int nb_sectors
,
282 BlockDriverCompletionFunc
*cb
, void *opaque
);
283 BlockDriverAIOCB
*bdrv_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
284 QEMUIOVector
*iov
, int nb_sectors
,
285 BlockDriverCompletionFunc
*cb
, void *opaque
);
286 BlockDriverAIOCB
*bdrv_aio_flush(BlockDriverState
*bs
,
287 BlockDriverCompletionFunc
*cb
, void *opaque
);
288 BlockDriverAIOCB
*bdrv_aio_discard(BlockDriverState
*bs
,
289 int64_t sector_num
, int nb_sectors
,
290 BlockDriverCompletionFunc
*cb
, void *opaque
);
291 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
);
293 typedef struct BlockRequest
{
294 /* Fields to be filled by multiwrite caller */
298 BlockDriverCompletionFunc
*cb
;
301 /* Filled by multiwrite implementation */
305 int bdrv_aio_multiwrite(BlockDriverState
*bs
, BlockRequest
*reqs
,
308 /* sg packet commands */
309 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
);
310 BlockDriverAIOCB
*bdrv_aio_ioctl(BlockDriverState
*bs
,
311 unsigned long int req
, void *buf
,
312 BlockDriverCompletionFunc
*cb
, void *opaque
);
314 /* Invalidate any cached metadata used by image formats */
315 void bdrv_invalidate_cache(BlockDriverState
*bs
);
316 void bdrv_invalidate_cache_all(void);
318 void bdrv_clear_incoming_migration_all(void);
320 /* Ensure contents are flushed to disk. */
321 int bdrv_flush(BlockDriverState
*bs
);
322 int coroutine_fn
bdrv_co_flush(BlockDriverState
*bs
);
323 int bdrv_flush_all(void);
324 void bdrv_close_all(void);
325 void bdrv_drain_all(void);
327 int bdrv_discard(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
);
328 int bdrv_co_discard(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
);
329 int bdrv_has_zero_init_1(BlockDriverState
*bs
);
330 int bdrv_has_zero_init(BlockDriverState
*bs
);
331 int64_t bdrv_get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
332 int nb_sectors
, int *pnum
);
333 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
335 int bdrv_is_allocated_above(BlockDriverState
*top
, BlockDriverState
*base
,
336 int64_t sector_num
, int nb_sectors
, int *pnum
);
338 void bdrv_set_on_error(BlockDriverState
*bs
, BlockdevOnError on_read_error
,
339 BlockdevOnError on_write_error
);
340 BlockdevOnError
bdrv_get_on_error(BlockDriverState
*bs
, bool is_read
);
341 BlockErrorAction
bdrv_get_error_action(BlockDriverState
*bs
, bool is_read
, int error
);
342 void bdrv_error_action(BlockDriverState
*bs
, BlockErrorAction action
,
343 bool is_read
, int error
);
344 int bdrv_is_read_only(BlockDriverState
*bs
);
345 int bdrv_is_sg(BlockDriverState
*bs
);
346 int bdrv_enable_write_cache(BlockDriverState
*bs
);
347 void bdrv_set_enable_write_cache(BlockDriverState
*bs
, bool wce
);
348 int bdrv_is_inserted(BlockDriverState
*bs
);
349 int bdrv_media_changed(BlockDriverState
*bs
);
350 void bdrv_lock_medium(BlockDriverState
*bs
, bool locked
);
351 void bdrv_eject(BlockDriverState
*bs
, bool eject_flag
);
352 const char *bdrv_get_format_name(BlockDriverState
*bs
);
353 BlockDriverState
*bdrv_find(const char *name
);
354 BlockDriverState
*bdrv_next(BlockDriverState
*bs
);
355 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
),
357 int bdrv_is_encrypted(BlockDriverState
*bs
);
358 int bdrv_key_required(BlockDriverState
*bs
);
359 int bdrv_set_key(BlockDriverState
*bs
, const char *key
);
360 int bdrv_query_missing_keys(void);
361 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
363 const char *bdrv_get_device_name(BlockDriverState
*bs
);
364 int bdrv_get_flags(BlockDriverState
*bs
);
365 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
366 const uint8_t *buf
, int nb_sectors
);
367 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
);
368 ImageInfoSpecific
*bdrv_get_specific_info(BlockDriverState
*bs
);
369 void bdrv_round_to_clusters(BlockDriverState
*bs
,
370 int64_t sector_num
, int nb_sectors
,
371 int64_t *cluster_sector_num
,
372 int *cluster_nb_sectors
);
374 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
);
375 void bdrv_get_backing_filename(BlockDriverState
*bs
,
376 char *filename
, int filename_size
);
377 void bdrv_get_full_backing_filename(BlockDriverState
*bs
,
378 char *dest
, size_t sz
);
379 int bdrv_is_snapshot(BlockDriverState
*bs
);
381 int path_is_absolute(const char *path
);
382 void path_combine(char *dest
, int dest_size
,
383 const char *base_path
,
384 const char *filename
);
386 int bdrv_writev_vmstate(BlockDriverState
*bs
, QEMUIOVector
*qiov
, int64_t pos
);
387 int bdrv_save_vmstate(BlockDriverState
*bs
, const uint8_t *buf
,
388 int64_t pos
, int size
);
390 int bdrv_load_vmstate(BlockDriverState
*bs
, uint8_t *buf
,
391 int64_t pos
, int size
);
393 void bdrv_img_create(const char *filename
, const char *fmt
,
394 const char *base_filename
, const char *base_fmt
,
395 char *options
, uint64_t img_size
, int flags
,
396 Error
**errp
, bool quiet
);
398 void bdrv_set_buffer_alignment(BlockDriverState
*bs
, int align
);
399 void *qemu_blockalign(BlockDriverState
*bs
, size_t size
);
400 bool bdrv_qiov_is_aligned(BlockDriverState
*bs
, QEMUIOVector
*qiov
);
403 void bdrv_set_dirty_tracking(BlockDriverState
*bs
, int granularity
);
404 int bdrv_get_dirty(BlockDriverState
*bs
, int64_t sector
);
405 void bdrv_set_dirty(BlockDriverState
*bs
, int64_t cur_sector
, int nr_sectors
);
406 void bdrv_reset_dirty(BlockDriverState
*bs
, int64_t cur_sector
, int nr_sectors
);
407 void bdrv_dirty_iter_init(BlockDriverState
*bs
, struct HBitmapIter
*hbi
);
408 int64_t bdrv_get_dirty_count(BlockDriverState
*bs
);
410 void bdrv_enable_copy_on_read(BlockDriverState
*bs
);
411 void bdrv_disable_copy_on_read(BlockDriverState
*bs
);
413 void bdrv_ref(BlockDriverState
*bs
);
414 void bdrv_unref(BlockDriverState
*bs
);
415 void bdrv_set_in_use(BlockDriverState
*bs
, int in_use
);
416 int bdrv_in_use(BlockDriverState
*bs
);
418 #ifdef CONFIG_LINUX_AIO
419 int raw_get_aio_fd(BlockDriverState
*bs
);
421 static inline int raw_get_aio_fd(BlockDriverState
*bs
)
434 typedef struct BlockAcctCookie
{
436 int64_t start_time_ns
;
437 enum BlockAcctType type
;
440 void bdrv_acct_start(BlockDriverState
*bs
, BlockAcctCookie
*cookie
,
441 int64_t bytes
, enum BlockAcctType type
);
442 void bdrv_acct_done(BlockDriverState
*bs
, BlockAcctCookie
*cookie
);
447 BLKDBG_L1_GROW_ALLOC_TABLE
,
448 BLKDBG_L1_GROW_WRITE_TABLE
,
449 BLKDBG_L1_GROW_ACTIVATE_TABLE
,
453 BLKDBG_L2_UPDATE_COMPRESSED
,
454 BLKDBG_L2_ALLOC_COW_READ
,
455 BLKDBG_L2_ALLOC_WRITE
,
458 BLKDBG_READ_BACKING_AIO
,
459 BLKDBG_READ_COMPRESSED
,
462 BLKDBG_WRITE_COMPRESSED
,
470 BLKDBG_REFTABLE_LOAD
,
471 BLKDBG_REFTABLE_GROW
,
472 BLKDBG_REFTABLE_UPDATE
,
474 BLKDBG_REFBLOCK_LOAD
,
475 BLKDBG_REFBLOCK_UPDATE
,
476 BLKDBG_REFBLOCK_UPDATE_PART
,
477 BLKDBG_REFBLOCK_ALLOC
,
478 BLKDBG_REFBLOCK_ALLOC_HOOKUP
,
479 BLKDBG_REFBLOCK_ALLOC_WRITE
,
480 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS
,
481 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE
,
482 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE
,
484 BLKDBG_CLUSTER_ALLOC
,
485 BLKDBG_CLUSTER_ALLOC_BYTES
,
489 BLKDBG_FLUSH_TO_DISK
,
494 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
495 void bdrv_debug_event(BlockDriverState
*bs
, BlkDebugEvent event
);
497 int bdrv_debug_breakpoint(BlockDriverState
*bs
, const char *event
,
499 int bdrv_debug_resume(BlockDriverState
*bs
, const char *tag
);
500 bool bdrv_debug_is_suspended(BlockDriverState
*bs
, const char *tag
);