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 #define BDRV_O_RDWR 0x0002
32 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
33 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
34 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
35 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
36 #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
37 #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
39 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
41 #define BDRV_SECTOR_BITS 9
42 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
43 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
46 BLOCK_ERR_REPORT
, BLOCK_ERR_IGNORE
, BLOCK_ERR_STOP_ENOSPC
,
51 BDRV_ACTION_REPORT
, BDRV_ACTION_IGNORE
, BDRV_ACTION_STOP
52 } BlockMonEventAction
;
54 void bdrv_mon_event(const BlockDriverState
*bdrv
,
55 BlockMonEventAction action
, int is_read
);
56 void bdrv_info_print(Monitor
*mon
, const QObject
*data
);
57 void bdrv_info(Monitor
*mon
, QObject
**ret_data
);
58 void bdrv_stats_print(Monitor
*mon
, const QObject
*data
);
59 void bdrv_info_stats(Monitor
*mon
, QObject
**ret_data
);
62 void bdrv_init_with_whitelist(void);
63 BlockDriver
*bdrv_find_protocol(const char *filename
);
64 BlockDriver
*bdrv_find_format(const char *format_name
);
65 BlockDriver
*bdrv_find_whitelisted_format(const char *format_name
);
66 int bdrv_create(BlockDriver
*drv
, const char* filename
,
67 QEMUOptionParameter
*options
);
68 int bdrv_create_file(const char* filename
, QEMUOptionParameter
*options
);
69 BlockDriverState
*bdrv_new(const char *device_name
);
70 void bdrv_make_anon(BlockDriverState
*bs
);
71 void bdrv_delete(BlockDriverState
*bs
);
72 int bdrv_parse_cache_flags(const char *mode
, int *flags
);
73 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
, int flags
);
74 int bdrv_open(BlockDriverState
*bs
, const char *filename
, int flags
,
76 void bdrv_close(BlockDriverState
*bs
);
77 int bdrv_attach_dev(BlockDriverState
*bs
, void *dev
);
78 void bdrv_attach_dev_nofail(BlockDriverState
*bs
, void *dev
);
79 void bdrv_detach_dev(BlockDriverState
*bs
, void *dev
);
80 void *bdrv_get_attached_dev(BlockDriverState
*bs
);
81 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
82 uint8_t *buf
, int nb_sectors
);
83 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
84 const uint8_t *buf
, int nb_sectors
);
85 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
86 void *buf
, int count
);
87 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
88 const void *buf
, int count
);
89 int bdrv_pwrite_sync(BlockDriverState
*bs
, int64_t offset
,
90 const void *buf
, int count
);
91 int coroutine_fn
bdrv_co_readv(BlockDriverState
*bs
, int64_t sector_num
,
92 int nb_sectors
, QEMUIOVector
*qiov
);
93 int coroutine_fn
bdrv_co_writev(BlockDriverState
*bs
, int64_t sector_num
,
94 int nb_sectors
, QEMUIOVector
*qiov
);
95 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
);
96 int64_t bdrv_getlength(BlockDriverState
*bs
);
97 int64_t bdrv_get_allocated_file_size(BlockDriverState
*bs
);
98 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
);
99 void bdrv_guess_geometry(BlockDriverState
*bs
, int *pcyls
, int *pheads
, int *psecs
);
100 int bdrv_commit(BlockDriverState
*bs
);
101 void bdrv_commit_all(void);
102 int bdrv_change_backing_file(BlockDriverState
*bs
,
103 const char *backing_file
, const char *backing_fmt
);
104 void bdrv_register(BlockDriver
*bdrv
);
107 typedef struct BdrvCheckResult
{
113 int bdrv_check(BlockDriverState
*bs
, BdrvCheckResult
*res
);
115 /* async block I/O */
116 typedef struct BlockDriverAIOCB BlockDriverAIOCB
;
117 typedef void BlockDriverCompletionFunc(void *opaque
, int ret
);
118 typedef void BlockDriverDirtyHandler(BlockDriverState
*bs
, int64_t sector
,
120 BlockDriverAIOCB
*bdrv_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
121 QEMUIOVector
*iov
, int nb_sectors
,
122 BlockDriverCompletionFunc
*cb
, void *opaque
);
123 BlockDriverAIOCB
*bdrv_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
124 QEMUIOVector
*iov
, int nb_sectors
,
125 BlockDriverCompletionFunc
*cb
, void *opaque
);
126 BlockDriverAIOCB
*bdrv_aio_flush(BlockDriverState
*bs
,
127 BlockDriverCompletionFunc
*cb
, void *opaque
);
128 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
);
130 typedef struct BlockRequest
{
131 /* Fields to be filled by multiwrite caller */
135 BlockDriverCompletionFunc
*cb
;
138 /* Filled by multiwrite implementation */
142 int bdrv_aio_multiwrite(BlockDriverState
*bs
, BlockRequest
*reqs
,
145 /* sg packet commands */
146 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
);
147 BlockDriverAIOCB
*bdrv_aio_ioctl(BlockDriverState
*bs
,
148 unsigned long int req
, void *buf
,
149 BlockDriverCompletionFunc
*cb
, void *opaque
);
151 /* Ensure contents are flushed to disk. */
152 int bdrv_flush(BlockDriverState
*bs
);
153 void bdrv_flush_all(void);
154 void bdrv_close_all(void);
156 int bdrv_discard(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
);
157 int bdrv_has_zero_init(BlockDriverState
*bs
);
158 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
161 #define BIOS_ATA_TRANSLATION_AUTO 0
162 #define BIOS_ATA_TRANSLATION_NONE 1
163 #define BIOS_ATA_TRANSLATION_LBA 2
164 #define BIOS_ATA_TRANSLATION_LARGE 3
165 #define BIOS_ATA_TRANSLATION_RECHS 4
167 void bdrv_set_geometry_hint(BlockDriverState
*bs
,
168 int cyls
, int heads
, int secs
);
169 void bdrv_set_translation_hint(BlockDriverState
*bs
, int translation
);
170 void bdrv_get_geometry_hint(BlockDriverState
*bs
,
171 int *pcyls
, int *pheads
, int *psecs
);
172 typedef enum FDriveType
{
173 FDRIVE_DRV_144
= 0x00, /* 1.44 MB 3"5 drive */
174 FDRIVE_DRV_288
= 0x01, /* 2.88 MB 3"5 drive */
175 FDRIVE_DRV_120
= 0x02, /* 1.2 MB 5"25 drive */
176 FDRIVE_DRV_NONE
= 0x03, /* No drive connected */
179 void bdrv_get_floppy_geometry_hint(BlockDriverState
*bs
, int *nb_heads
,
180 int *max_track
, int *last_sect
,
181 FDriveType drive_in
, FDriveType
*drive
);
182 int bdrv_get_translation_hint(BlockDriverState
*bs
);
183 void bdrv_set_on_error(BlockDriverState
*bs
, BlockErrorAction on_read_error
,
184 BlockErrorAction on_write_error
);
185 BlockErrorAction
bdrv_get_on_error(BlockDriverState
*bs
, int is_read
);
186 void bdrv_set_removable(BlockDriverState
*bs
, int removable
);
187 int bdrv_is_removable(BlockDriverState
*bs
);
188 int bdrv_is_read_only(BlockDriverState
*bs
);
189 int bdrv_is_sg(BlockDriverState
*bs
);
190 int bdrv_enable_write_cache(BlockDriverState
*bs
);
191 int bdrv_is_inserted(BlockDriverState
*bs
);
192 int bdrv_media_changed(BlockDriverState
*bs
);
193 int bdrv_is_locked(BlockDriverState
*bs
);
194 void bdrv_set_locked(BlockDriverState
*bs
, int locked
);
195 int bdrv_eject(BlockDriverState
*bs
, int eject_flag
);
196 void bdrv_set_change_cb(BlockDriverState
*bs
,
197 void (*change_cb
)(void *opaque
, int reason
),
199 void bdrv_get_format(BlockDriverState
*bs
, char *buf
, int buf_size
);
200 BlockDriverState
*bdrv_find(const char *name
);
201 BlockDriverState
*bdrv_next(BlockDriverState
*bs
);
202 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
),
204 int bdrv_is_encrypted(BlockDriverState
*bs
);
205 int bdrv_key_required(BlockDriverState
*bs
);
206 int bdrv_set_key(BlockDriverState
*bs
, const char *key
);
207 int bdrv_query_missing_keys(void);
208 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
210 const char *bdrv_get_device_name(BlockDriverState
*bs
);
211 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
212 const uint8_t *buf
, int nb_sectors
);
213 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
);
215 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
);
216 void bdrv_get_backing_filename(BlockDriverState
*bs
,
217 char *filename
, int filename_size
);
218 int bdrv_can_snapshot(BlockDriverState
*bs
);
219 int bdrv_is_snapshot(BlockDriverState
*bs
);
220 BlockDriverState
*bdrv_snapshots(void);
221 int bdrv_snapshot_create(BlockDriverState
*bs
,
222 QEMUSnapshotInfo
*sn_info
);
223 int bdrv_snapshot_goto(BlockDriverState
*bs
,
224 const char *snapshot_id
);
225 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
);
226 int bdrv_snapshot_list(BlockDriverState
*bs
,
227 QEMUSnapshotInfo
**psn_info
);
228 int bdrv_snapshot_load_tmp(BlockDriverState
*bs
,
229 const char *snapshot_name
);
230 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
);
232 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
);
233 int path_is_absolute(const char *path
);
234 void path_combine(char *dest
, int dest_size
,
235 const char *base_path
,
236 const char *filename
);
238 int bdrv_save_vmstate(BlockDriverState
*bs
, const uint8_t *buf
,
239 int64_t pos
, int size
);
241 int bdrv_load_vmstate(BlockDriverState
*bs
, uint8_t *buf
,
242 int64_t pos
, int size
);
244 int bdrv_img_create(const char *filename
, const char *fmt
,
245 const char *base_filename
, const char *base_fmt
,
246 char *options
, uint64_t img_size
, int flags
);
248 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
250 void bdrv_set_dirty_tracking(BlockDriverState
*bs
, int enable
);
251 int bdrv_get_dirty(BlockDriverState
*bs
, int64_t sector
);
252 void bdrv_reset_dirty(BlockDriverState
*bs
, int64_t cur_sector
,
254 int64_t bdrv_get_dirty_count(BlockDriverState
*bs
);
256 void bdrv_set_in_use(BlockDriverState
*bs
, int in_use
);
257 int bdrv_in_use(BlockDriverState
*bs
);
266 typedef struct BlockAcctCookie
{
268 int64_t start_time_ns
;
269 enum BlockAcctType type
;
272 void bdrv_acct_start(BlockDriverState
*bs
, BlockAcctCookie
*cookie
,
273 int64_t bytes
, enum BlockAcctType type
);
274 void bdrv_acct_done(BlockDriverState
*bs
, BlockAcctCookie
*cookie
);
279 BLKDBG_L1_GROW_ALLOC_TABLE
,
280 BLKDBG_L1_GROW_WRITE_TABLE
,
281 BLKDBG_L1_GROW_ACTIVATE_TABLE
,
285 BLKDBG_L2_UPDATE_COMPRESSED
,
286 BLKDBG_L2_ALLOC_COW_READ
,
287 BLKDBG_L2_ALLOC_WRITE
,
292 BLKDBG_READ_BACKING_AIO
,
293 BLKDBG_READ_COMPRESSED
,
296 BLKDBG_WRITE_COMPRESSED
,
304 BLKDBG_REFTABLE_LOAD
,
305 BLKDBG_REFTABLE_GROW
,
307 BLKDBG_REFBLOCK_LOAD
,
308 BLKDBG_REFBLOCK_UPDATE
,
309 BLKDBG_REFBLOCK_UPDATE_PART
,
310 BLKDBG_REFBLOCK_ALLOC
,
311 BLKDBG_REFBLOCK_ALLOC_HOOKUP
,
312 BLKDBG_REFBLOCK_ALLOC_WRITE
,
313 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS
,
314 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE
,
315 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE
,
317 BLKDBG_CLUSTER_ALLOC
,
318 BLKDBG_CLUSTER_ALLOC_BYTES
,
324 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
325 void bdrv_debug_event(BlockDriverState
*bs
, BlkDebugEvent event
);