5 #include "qemu-common.h"
6 #include "qemu-option.h"
7 #include "qemu-coroutine.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
;
29 typedef struct QEMUSnapshotInfo
{
30 char id_str
[128]; /* unique snapshot id */
31 /* the following fields are informative. They are not needed for
32 the consistency of the snapshot */
33 char name
[256]; /* user chosen name */
34 uint64_t vm_state_size
; /* VM state info size */
35 uint32_t date_sec
; /* UTC date of the snapshot */
37 uint64_t vm_clock_nsec
; /* VM clock relative to boot */
40 /* Callbacks for block device models */
41 typedef struct BlockDevOps
{
43 * Runs when virtual media changed (monitor commands eject, change)
44 * Argument load is true on load and false on eject.
45 * Beware: doesn't run when a host device's physical media
46 * changes. Sure would be useful if it did.
47 * Device models with removable media must implement this callback.
49 void (*change_media_cb
)(void *opaque
, bool load
);
51 * Runs when an eject request is issued from the monitor, the tray
52 * is closed, and the medium is locked.
53 * Device models that do not implement is_medium_locked will not need
54 * this callback. Device models that can lock the medium or tray might
55 * want to implement the callback and unlock the tray when "force" is
56 * true, even if they do not support eject requests.
58 void (*eject_request_cb
)(void *opaque
, bool force
);
60 * Is the virtual tray open?
61 * Device models implement this only when the device has a tray.
63 bool (*is_tray_open
)(void *opaque
);
65 * Is the virtual medium locked into the device?
66 * Device models implement this only when device has such a lock.
68 bool (*is_medium_locked
)(void *opaque
);
70 * Runs when the size changed (e.g. monitor command block_resize)
72 void (*resize_cb
)(void *opaque
);
75 #define BDRV_O_RDWR 0x0002
76 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
77 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
78 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
79 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
80 #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
81 #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
82 #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
83 #define BDRV_O_INCOMING 0x0800 /* consistency hint for incoming migration */
84 #define BDRV_O_CHECK 0x1000 /* open solely for consistency check */
85 #define BDRV_O_ALLOW_RDWR 0x2000 /* allow reopen to change from r/o to r/w */
87 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
89 #define BDRV_SECTOR_BITS 9
90 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
91 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
94 BLOCK_ERR_REPORT
, BLOCK_ERR_IGNORE
, BLOCK_ERR_STOP_ENOSPC
,
99 BDRV_ACTION_REPORT
, BDRV_ACTION_IGNORE
, BDRV_ACTION_STOP
100 } BlockQMPEventAction
;
102 typedef QSIMPLEQ_HEAD(BlockReopenQueue
, BlockReopenQueueEntry
) BlockReopenQueue
;
104 typedef struct BDRVReopenState
{
105 BlockDriverState
*bs
;
111 void bdrv_iostatus_enable(BlockDriverState
*bs
);
112 void bdrv_iostatus_reset(BlockDriverState
*bs
);
113 void bdrv_iostatus_disable(BlockDriverState
*bs
);
114 bool bdrv_iostatus_is_enabled(const BlockDriverState
*bs
);
115 void bdrv_iostatus_set_err(BlockDriverState
*bs
, int error
);
116 void bdrv_emit_qmp_error_event(const BlockDriverState
*bdrv
,
117 BlockQMPEventAction action
, int is_read
);
118 void bdrv_info_print(Monitor
*mon
, const QObject
*data
);
119 void bdrv_info(Monitor
*mon
, QObject
**ret_data
);
120 void bdrv_stats_print(Monitor
*mon
, const QObject
*data
);
121 void bdrv_info_stats(Monitor
*mon
, QObject
**ret_data
);
123 /* disk I/O throttling */
124 void bdrv_io_limits_enable(BlockDriverState
*bs
);
125 void bdrv_io_limits_disable(BlockDriverState
*bs
);
126 bool bdrv_io_limits_enabled(BlockDriverState
*bs
);
128 void bdrv_init(void);
129 void bdrv_init_with_whitelist(void);
130 BlockDriver
*bdrv_find_protocol(const char *filename
);
131 BlockDriver
*bdrv_find_format(const char *format_name
);
132 BlockDriver
*bdrv_find_whitelisted_format(const char *format_name
);
133 int bdrv_create(BlockDriver
*drv
, const char* filename
,
134 QEMUOptionParameter
*options
);
135 int bdrv_create_file(const char* filename
, QEMUOptionParameter
*options
);
136 BlockDriverState
*bdrv_new(const char *device_name
);
137 void bdrv_make_anon(BlockDriverState
*bs
);
138 void bdrv_swap(BlockDriverState
*bs_new
, BlockDriverState
*bs_old
);
139 void bdrv_append(BlockDriverState
*bs_new
, BlockDriverState
*bs_top
);
140 void bdrv_delete(BlockDriverState
*bs
);
141 int bdrv_parse_cache_flags(const char *mode
, int *flags
);
142 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
, int flags
);
143 int bdrv_open(BlockDriverState
*bs
, const char *filename
, int flags
,
145 BlockReopenQueue
*bdrv_reopen_queue(BlockReopenQueue
*bs_queue
,
146 BlockDriverState
*bs
, int flags
);
147 int bdrv_reopen_multiple(BlockReopenQueue
*bs_queue
, Error
**errp
);
148 int bdrv_reopen(BlockDriverState
*bs
, int bdrv_flags
, Error
**errp
);
149 int bdrv_reopen_prepare(BDRVReopenState
*reopen_state
,
150 BlockReopenQueue
*queue
, Error
**errp
);
151 void bdrv_reopen_commit(BDRVReopenState
*reopen_state
);
152 void bdrv_reopen_abort(BDRVReopenState
*reopen_state
);
153 void bdrv_close(BlockDriverState
*bs
);
154 int bdrv_attach_dev(BlockDriverState
*bs
, void *dev
);
155 void bdrv_attach_dev_nofail(BlockDriverState
*bs
, void *dev
);
156 void bdrv_detach_dev(BlockDriverState
*bs
, void *dev
);
157 void *bdrv_get_attached_dev(BlockDriverState
*bs
);
158 void bdrv_set_dev_ops(BlockDriverState
*bs
, const BlockDevOps
*ops
,
160 void bdrv_dev_eject_request(BlockDriverState
*bs
, bool force
);
161 bool bdrv_dev_has_removable_media(BlockDriverState
*bs
);
162 bool bdrv_dev_is_tray_open(BlockDriverState
*bs
);
163 bool bdrv_dev_is_medium_locked(BlockDriverState
*bs
);
164 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
165 uint8_t *buf
, int nb_sectors
);
166 int bdrv_read_unthrottled(BlockDriverState
*bs
, int64_t sector_num
,
167 uint8_t *buf
, int nb_sectors
);
168 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
169 const uint8_t *buf
, int nb_sectors
);
170 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
171 void *buf
, int count
);
172 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
173 const void *buf
, int count
);
174 int bdrv_pwrite_sync(BlockDriverState
*bs
, int64_t offset
,
175 const void *buf
, int count
);
176 int coroutine_fn
bdrv_co_readv(BlockDriverState
*bs
, int64_t sector_num
,
177 int nb_sectors
, QEMUIOVector
*qiov
);
178 int coroutine_fn
bdrv_co_copy_on_readv(BlockDriverState
*bs
,
179 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
);
180 int coroutine_fn
bdrv_co_writev(BlockDriverState
*bs
, int64_t sector_num
,
181 int nb_sectors
, QEMUIOVector
*qiov
);
183 * Efficiently zero a region of the disk image. Note that this is a regular
184 * I/O request like read or write and should have a reasonable size. This
185 * function is not suitable for zeroing the entire image in a single request
186 * because it may allocate memory for the entire region.
188 int coroutine_fn
bdrv_co_write_zeroes(BlockDriverState
*bs
, int64_t sector_num
,
190 int coroutine_fn
bdrv_co_is_allocated(BlockDriverState
*bs
, int64_t sector_num
,
191 int nb_sectors
, int *pnum
);
192 int coroutine_fn
bdrv_co_is_allocated_above(BlockDriverState
*top
,
193 BlockDriverState
*base
,
195 int nb_sectors
, int *pnum
);
196 BlockDriverState
*bdrv_find_backing_image(BlockDriverState
*bs
,
197 const char *backing_file
);
198 int bdrv_get_backing_file_depth(BlockDriverState
*bs
);
199 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
);
200 int64_t bdrv_getlength(BlockDriverState
*bs
);
201 int64_t bdrv_get_allocated_file_size(BlockDriverState
*bs
);
202 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
);
203 int bdrv_commit(BlockDriverState
*bs
);
204 int bdrv_commit_all(void);
205 int bdrv_change_backing_file(BlockDriverState
*bs
,
206 const char *backing_file
, const char *backing_fmt
);
207 void bdrv_register(BlockDriver
*bdrv
);
208 int bdrv_drop_intermediate(BlockDriverState
*active
, BlockDriverState
*top
,
209 BlockDriverState
*base
);
210 BlockDriverState
*bdrv_find_overlay(BlockDriverState
*active
,
211 BlockDriverState
*bs
);
212 BlockDriverState
*bdrv_find_base(BlockDriverState
*bs
);
215 typedef struct BdrvCheckResult
{
219 int corruptions_fixed
;
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
,
287 void bdrv_set_on_error(BlockDriverState
*bs
, BlockErrorAction on_read_error
,
288 BlockErrorAction on_write_error
);
289 BlockErrorAction
bdrv_get_on_error(BlockDriverState
*bs
, int is_read
);
290 int bdrv_is_read_only(BlockDriverState
*bs
);
291 int bdrv_is_sg(BlockDriverState
*bs
);
292 int bdrv_enable_write_cache(BlockDriverState
*bs
);
293 void bdrv_set_enable_write_cache(BlockDriverState
*bs
, bool wce
);
294 int bdrv_is_inserted(BlockDriverState
*bs
);
295 int bdrv_media_changed(BlockDriverState
*bs
);
296 void bdrv_lock_medium(BlockDriverState
*bs
, bool locked
);
297 void bdrv_eject(BlockDriverState
*bs
, bool eject_flag
);
298 const char *bdrv_get_format_name(BlockDriverState
*bs
);
299 BlockDriverState
*bdrv_find(const char *name
);
300 BlockDriverState
*bdrv_next(BlockDriverState
*bs
);
301 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
),
303 int bdrv_is_encrypted(BlockDriverState
*bs
);
304 int bdrv_key_required(BlockDriverState
*bs
);
305 int bdrv_set_key(BlockDriverState
*bs
, const char *key
);
306 int bdrv_query_missing_keys(void);
307 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
309 const char *bdrv_get_device_name(BlockDriverState
*bs
);
310 int bdrv_get_flags(BlockDriverState
*bs
);
311 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
312 const uint8_t *buf
, int nb_sectors
);
313 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
);
315 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
);
316 void bdrv_get_backing_filename(BlockDriverState
*bs
,
317 char *filename
, int filename_size
);
318 void bdrv_get_full_backing_filename(BlockDriverState
*bs
,
319 char *dest
, size_t sz
);
320 int bdrv_can_snapshot(BlockDriverState
*bs
);
321 int bdrv_is_snapshot(BlockDriverState
*bs
);
322 BlockDriverState
*bdrv_snapshots(void);
323 int bdrv_snapshot_create(BlockDriverState
*bs
,
324 QEMUSnapshotInfo
*sn_info
);
325 int bdrv_snapshot_goto(BlockDriverState
*bs
,
326 const char *snapshot_id
);
327 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
);
328 int bdrv_snapshot_list(BlockDriverState
*bs
,
329 QEMUSnapshotInfo
**psn_info
);
330 int bdrv_snapshot_load_tmp(BlockDriverState
*bs
,
331 const char *snapshot_name
);
332 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
);
334 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
);
335 int path_is_absolute(const char *path
);
336 void path_combine(char *dest
, int dest_size
,
337 const char *base_path
,
338 const char *filename
);
340 int bdrv_save_vmstate(BlockDriverState
*bs
, const uint8_t *buf
,
341 int64_t pos
, int size
);
343 int bdrv_load_vmstate(BlockDriverState
*bs
, uint8_t *buf
,
344 int64_t pos
, int size
);
346 int bdrv_img_create(const char *filename
, const char *fmt
,
347 const char *base_filename
, const char *base_fmt
,
348 char *options
, uint64_t img_size
, int flags
);
350 void bdrv_set_buffer_alignment(BlockDriverState
*bs
, int align
);
351 void *qemu_blockalign(BlockDriverState
*bs
, size_t size
);
353 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
355 void bdrv_set_dirty_tracking(BlockDriverState
*bs
, int enable
);
356 int bdrv_get_dirty(BlockDriverState
*bs
, int64_t sector
);
357 void bdrv_reset_dirty(BlockDriverState
*bs
, int64_t cur_sector
,
359 int64_t bdrv_get_dirty_count(BlockDriverState
*bs
);
361 void bdrv_enable_copy_on_read(BlockDriverState
*bs
);
362 void bdrv_disable_copy_on_read(BlockDriverState
*bs
);
364 void bdrv_set_in_use(BlockDriverState
*bs
, int in_use
);
365 int bdrv_in_use(BlockDriverState
*bs
);
374 typedef struct BlockAcctCookie
{
376 int64_t start_time_ns
;
377 enum BlockAcctType type
;
380 void bdrv_acct_start(BlockDriverState
*bs
, BlockAcctCookie
*cookie
,
381 int64_t bytes
, enum BlockAcctType type
);
382 void bdrv_acct_done(BlockDriverState
*bs
, BlockAcctCookie
*cookie
);
387 BLKDBG_L1_GROW_ALLOC_TABLE
,
388 BLKDBG_L1_GROW_WRITE_TABLE
,
389 BLKDBG_L1_GROW_ACTIVATE_TABLE
,
393 BLKDBG_L2_UPDATE_COMPRESSED
,
394 BLKDBG_L2_ALLOC_COW_READ
,
395 BLKDBG_L2_ALLOC_WRITE
,
398 BLKDBG_READ_BACKING_AIO
,
399 BLKDBG_READ_COMPRESSED
,
402 BLKDBG_WRITE_COMPRESSED
,
410 BLKDBG_REFTABLE_LOAD
,
411 BLKDBG_REFTABLE_GROW
,
413 BLKDBG_REFBLOCK_LOAD
,
414 BLKDBG_REFBLOCK_UPDATE
,
415 BLKDBG_REFBLOCK_UPDATE_PART
,
416 BLKDBG_REFBLOCK_ALLOC
,
417 BLKDBG_REFBLOCK_ALLOC_HOOKUP
,
418 BLKDBG_REFBLOCK_ALLOC_WRITE
,
419 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS
,
420 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE
,
421 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE
,
423 BLKDBG_CLUSTER_ALLOC
,
424 BLKDBG_CLUSTER_ALLOC_BYTES
,
430 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
431 void bdrv_debug_event(BlockDriverState
*bs
, BlkDebugEvent event
);