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
;
20 typedef struct QEMUSnapshotInfo
{
21 char id_str
[128]; /* unique snapshot id */
22 /* the following fields are informative. They are not needed for
23 the consistency of the snapshot */
24 char name
[256]; /* user choosen name */
25 uint32_t vm_state_size
; /* VM state info size */
26 uint32_t date_sec
; /* UTC date of the snapshot */
28 uint64_t vm_clock_nsec
; /* VM clock relative to boot */
31 /* Callbacks for block device models */
32 typedef struct BlockDevOps
{
34 * Runs when virtual media changed (monitor commands eject, change)
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
);
41 * Is the virtual medium locked into the device?
42 * Device models implement this only when device has such a lock.
44 bool (*is_medium_locked
)(void *opaque
);
46 * Runs when the size changed (e.g. monitor command block_resize)
48 void (*resize_cb
)(void *opaque
);
51 #define BDRV_O_RDWR 0x0002
52 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
53 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
54 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
55 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
56 #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
57 #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
59 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
61 #define BDRV_SECTOR_BITS 9
62 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
63 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
66 BLOCK_ERR_REPORT
, BLOCK_ERR_IGNORE
, BLOCK_ERR_STOP_ENOSPC
,
71 BDRV_ACTION_REPORT
, BDRV_ACTION_IGNORE
, BDRV_ACTION_STOP
72 } BlockMonEventAction
;
74 void bdrv_mon_event(const BlockDriverState
*bdrv
,
75 BlockMonEventAction action
, int is_read
);
76 void bdrv_info_print(Monitor
*mon
, const QObject
*data
);
77 void bdrv_info(Monitor
*mon
, QObject
**ret_data
);
78 void bdrv_stats_print(Monitor
*mon
, const QObject
*data
);
79 void bdrv_info_stats(Monitor
*mon
, QObject
**ret_data
);
82 void bdrv_init_with_whitelist(void);
83 BlockDriver
*bdrv_find_protocol(const char *filename
);
84 BlockDriver
*bdrv_find_format(const char *format_name
);
85 BlockDriver
*bdrv_find_whitelisted_format(const char *format_name
);
86 int bdrv_create(BlockDriver
*drv
, const char* filename
,
87 QEMUOptionParameter
*options
);
88 int bdrv_create_file(const char* filename
, QEMUOptionParameter
*options
);
89 BlockDriverState
*bdrv_new(const char *device_name
);
90 void bdrv_make_anon(BlockDriverState
*bs
);
91 void bdrv_delete(BlockDriverState
*bs
);
92 int bdrv_parse_cache_flags(const char *mode
, int *flags
);
93 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
, int flags
);
94 int bdrv_open(BlockDriverState
*bs
, const char *filename
, int flags
,
96 void bdrv_close(BlockDriverState
*bs
);
97 int bdrv_attach_dev(BlockDriverState
*bs
, void *dev
);
98 void bdrv_attach_dev_nofail(BlockDriverState
*bs
, void *dev
);
99 void bdrv_detach_dev(BlockDriverState
*bs
, void *dev
);
100 void *bdrv_get_attached_dev(BlockDriverState
*bs
);
101 void bdrv_set_dev_ops(BlockDriverState
*bs
, const BlockDevOps
*ops
,
103 bool bdrv_dev_has_removable_media(BlockDriverState
*bs
);
104 bool bdrv_dev_is_medium_locked(BlockDriverState
*bs
);
105 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
106 uint8_t *buf
, int nb_sectors
);
107 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
108 const uint8_t *buf
, int nb_sectors
);
109 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
110 void *buf
, int count
);
111 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
112 const void *buf
, int count
);
113 int bdrv_pwrite_sync(BlockDriverState
*bs
, int64_t offset
,
114 const void *buf
, int count
);
115 int coroutine_fn
bdrv_co_readv(BlockDriverState
*bs
, int64_t sector_num
,
116 int nb_sectors
, QEMUIOVector
*qiov
);
117 int coroutine_fn
bdrv_co_writev(BlockDriverState
*bs
, int64_t sector_num
,
118 int nb_sectors
, QEMUIOVector
*qiov
);
119 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
);
120 int64_t bdrv_getlength(BlockDriverState
*bs
);
121 int64_t bdrv_get_allocated_file_size(BlockDriverState
*bs
);
122 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
);
123 void bdrv_guess_geometry(BlockDriverState
*bs
, int *pcyls
, int *pheads
, int *psecs
);
124 int bdrv_commit(BlockDriverState
*bs
);
125 void bdrv_commit_all(void);
126 int bdrv_change_backing_file(BlockDriverState
*bs
,
127 const char *backing_file
, const char *backing_fmt
);
128 void bdrv_register(BlockDriver
*bdrv
);
131 typedef struct BdrvCheckResult
{
137 int bdrv_check(BlockDriverState
*bs
, BdrvCheckResult
*res
);
139 /* async block I/O */
140 typedef struct BlockDriverAIOCB BlockDriverAIOCB
;
141 typedef void BlockDriverCompletionFunc(void *opaque
, int ret
);
142 typedef void BlockDriverDirtyHandler(BlockDriverState
*bs
, int64_t sector
,
144 BlockDriverAIOCB
*bdrv_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
145 QEMUIOVector
*iov
, int nb_sectors
,
146 BlockDriverCompletionFunc
*cb
, void *opaque
);
147 BlockDriverAIOCB
*bdrv_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
148 QEMUIOVector
*iov
, int nb_sectors
,
149 BlockDriverCompletionFunc
*cb
, void *opaque
);
150 BlockDriverAIOCB
*bdrv_aio_flush(BlockDriverState
*bs
,
151 BlockDriverCompletionFunc
*cb
, void *opaque
);
152 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
);
154 typedef struct BlockRequest
{
155 /* Fields to be filled by multiwrite caller */
159 BlockDriverCompletionFunc
*cb
;
162 /* Filled by multiwrite implementation */
166 int bdrv_aio_multiwrite(BlockDriverState
*bs
, BlockRequest
*reqs
,
169 /* sg packet commands */
170 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
);
171 BlockDriverAIOCB
*bdrv_aio_ioctl(BlockDriverState
*bs
,
172 unsigned long int req
, void *buf
,
173 BlockDriverCompletionFunc
*cb
, void *opaque
);
175 /* Ensure contents are flushed to disk. */
176 int bdrv_flush(BlockDriverState
*bs
);
177 void bdrv_flush_all(void);
178 void bdrv_close_all(void);
180 int bdrv_discard(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
);
181 int bdrv_has_zero_init(BlockDriverState
*bs
);
182 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
185 #define BIOS_ATA_TRANSLATION_AUTO 0
186 #define BIOS_ATA_TRANSLATION_NONE 1
187 #define BIOS_ATA_TRANSLATION_LBA 2
188 #define BIOS_ATA_TRANSLATION_LARGE 3
189 #define BIOS_ATA_TRANSLATION_RECHS 4
191 void bdrv_set_geometry_hint(BlockDriverState
*bs
,
192 int cyls
, int heads
, int secs
);
193 void bdrv_set_translation_hint(BlockDriverState
*bs
, int translation
);
194 void bdrv_get_geometry_hint(BlockDriverState
*bs
,
195 int *pcyls
, int *pheads
, int *psecs
);
196 typedef enum FDriveType
{
197 FDRIVE_DRV_144
= 0x00, /* 1.44 MB 3"5 drive */
198 FDRIVE_DRV_288
= 0x01, /* 2.88 MB 3"5 drive */
199 FDRIVE_DRV_120
= 0x02, /* 1.2 MB 5"25 drive */
200 FDRIVE_DRV_NONE
= 0x03, /* No drive connected */
203 void bdrv_get_floppy_geometry_hint(BlockDriverState
*bs
, int *nb_heads
,
204 int *max_track
, int *last_sect
,
205 FDriveType drive_in
, FDriveType
*drive
);
206 int bdrv_get_translation_hint(BlockDriverState
*bs
);
207 void bdrv_set_on_error(BlockDriverState
*bs
, BlockErrorAction on_read_error
,
208 BlockErrorAction on_write_error
);
209 BlockErrorAction
bdrv_get_on_error(BlockDriverState
*bs
, int is_read
);
210 int bdrv_is_read_only(BlockDriverState
*bs
);
211 int bdrv_is_sg(BlockDriverState
*bs
);
212 int bdrv_enable_write_cache(BlockDriverState
*bs
);
213 int bdrv_is_inserted(BlockDriverState
*bs
);
214 int bdrv_media_changed(BlockDriverState
*bs
);
215 void bdrv_lock_medium(BlockDriverState
*bs
, bool locked
);
216 void bdrv_eject(BlockDriverState
*bs
, int eject_flag
);
217 void bdrv_get_format(BlockDriverState
*bs
, char *buf
, int buf_size
);
218 BlockDriverState
*bdrv_find(const char *name
);
219 BlockDriverState
*bdrv_next(BlockDriverState
*bs
);
220 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
),
222 int bdrv_is_encrypted(BlockDriverState
*bs
);
223 int bdrv_key_required(BlockDriverState
*bs
);
224 int bdrv_set_key(BlockDriverState
*bs
, const char *key
);
225 int bdrv_query_missing_keys(void);
226 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
228 const char *bdrv_get_device_name(BlockDriverState
*bs
);
229 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
230 const uint8_t *buf
, int nb_sectors
);
231 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
);
233 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
);
234 void bdrv_get_backing_filename(BlockDriverState
*bs
,
235 char *filename
, int filename_size
);
236 int bdrv_can_snapshot(BlockDriverState
*bs
);
237 int bdrv_is_snapshot(BlockDriverState
*bs
);
238 BlockDriverState
*bdrv_snapshots(void);
239 int bdrv_snapshot_create(BlockDriverState
*bs
,
240 QEMUSnapshotInfo
*sn_info
);
241 int bdrv_snapshot_goto(BlockDriverState
*bs
,
242 const char *snapshot_id
);
243 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
);
244 int bdrv_snapshot_list(BlockDriverState
*bs
,
245 QEMUSnapshotInfo
**psn_info
);
246 int bdrv_snapshot_load_tmp(BlockDriverState
*bs
,
247 const char *snapshot_name
);
248 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
);
250 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
);
251 int path_is_absolute(const char *path
);
252 void path_combine(char *dest
, int dest_size
,
253 const char *base_path
,
254 const char *filename
);
256 int bdrv_save_vmstate(BlockDriverState
*bs
, const uint8_t *buf
,
257 int64_t pos
, int size
);
259 int bdrv_load_vmstate(BlockDriverState
*bs
, uint8_t *buf
,
260 int64_t pos
, int size
);
262 int bdrv_img_create(const char *filename
, const char *fmt
,
263 const char *base_filename
, const char *base_fmt
,
264 char *options
, uint64_t img_size
, int flags
);
266 void *qemu_blockalign(BlockDriverState
*bs
, size_t size
);
268 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
270 void bdrv_set_dirty_tracking(BlockDriverState
*bs
, int enable
);
271 int bdrv_get_dirty(BlockDriverState
*bs
, int64_t sector
);
272 void bdrv_reset_dirty(BlockDriverState
*bs
, int64_t cur_sector
,
274 int64_t bdrv_get_dirty_count(BlockDriverState
*bs
);
276 void bdrv_set_in_use(BlockDriverState
*bs
, int in_use
);
277 int bdrv_in_use(BlockDriverState
*bs
);
286 typedef struct BlockAcctCookie
{
288 int64_t start_time_ns
;
289 enum BlockAcctType type
;
292 void bdrv_acct_start(BlockDriverState
*bs
, BlockAcctCookie
*cookie
,
293 int64_t bytes
, enum BlockAcctType type
);
294 void bdrv_acct_done(BlockDriverState
*bs
, BlockAcctCookie
*cookie
);
299 BLKDBG_L1_GROW_ALLOC_TABLE
,
300 BLKDBG_L1_GROW_WRITE_TABLE
,
301 BLKDBG_L1_GROW_ACTIVATE_TABLE
,
305 BLKDBG_L2_UPDATE_COMPRESSED
,
306 BLKDBG_L2_ALLOC_COW_READ
,
307 BLKDBG_L2_ALLOC_WRITE
,
312 BLKDBG_READ_BACKING_AIO
,
313 BLKDBG_READ_COMPRESSED
,
316 BLKDBG_WRITE_COMPRESSED
,
324 BLKDBG_REFTABLE_LOAD
,
325 BLKDBG_REFTABLE_GROW
,
327 BLKDBG_REFBLOCK_LOAD
,
328 BLKDBG_REFBLOCK_UPDATE
,
329 BLKDBG_REFBLOCK_UPDATE_PART
,
330 BLKDBG_REFBLOCK_ALLOC
,
331 BLKDBG_REFBLOCK_ALLOC_HOOKUP
,
332 BLKDBG_REFBLOCK_ALLOC_WRITE
,
333 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS
,
334 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE
,
335 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE
,
337 BLKDBG_CLUSTER_ALLOC
,
338 BLKDBG_CLUSTER_ALLOC_BYTES
,
344 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
345 void bdrv_debug_event(BlockDriverState
*bs
, BlkDebugEvent event
);