]> git.proxmox.com Git - qemu.git/blame - block.h
char: rename qemu_chr_guest_close() -> qemu_chr_fe_close()
[qemu.git] / block.h
CommitLineData
faf07963
PB
1#ifndef BLOCK_H
2#define BLOCK_H
3
a76bab49 4#include "qemu-aio.h"
3b69e4b9 5#include "qemu-common.h"
0e7e1989 6#include "qemu-option.h"
da1fa91d 7#include "qemu-coroutine.h"
d15e5465 8#include "qobject.h"
a76bab49 9
faf07963 10/* block.c */
faf07963
PB
11typedef struct BlockDriver BlockDriver;
12
faf07963
PB
13typedef struct BlockDriverInfo {
14 /* in bytes, 0 if irrelevant */
15 int cluster_size;
16 /* offset at which the VM state can be saved (0 if not possible) */
17 int64_t vm_state_offset;
18} BlockDriverInfo;
19
20typedef 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 */
27 uint32_t date_nsec;
28 uint64_t vm_clock_nsec; /* VM clock relative to boot */
29} QEMUSnapshotInfo;
30
faf07963 31#define BDRV_O_RDWR 0x0002
faf07963 32#define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
9f7965c7
AL
33#define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
34#define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
5c6c3a6c 35#define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
b783e409 36#define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
016f5cf6 37#define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
9f7965c7 38
ceb25e5c 39#define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
faf07963 40
6ea44308 41#define BDRV_SECTOR_BITS 9
c63782cb 42#define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
3abbc4d9 43#define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
6ea44308 44
abd7f68d
MA
45typedef enum {
46 BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
47 BLOCK_ERR_STOP_ANY
48} BlockErrorAction;
49
2582bfed
LC
50typedef enum {
51 BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
52} BlockMonEventAction;
53
54void bdrv_mon_event(const BlockDriverState *bdrv,
55 BlockMonEventAction action, int is_read);
d15e5465
LC
56void bdrv_info_print(Monitor *mon, const QObject *data);
57void bdrv_info(Monitor *mon, QObject **ret_data);
218a536a
LC
58void bdrv_stats_print(Monitor *mon, const QObject *data);
59void bdrv_info_stats(Monitor *mon, QObject **ret_data);
faf07963
PB
60
61void bdrv_init(void);
eb852011 62void bdrv_init_with_whitelist(void);
b50cbabc 63BlockDriver *bdrv_find_protocol(const char *filename);
faf07963 64BlockDriver *bdrv_find_format(const char *format_name);
eb852011 65BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
0e7e1989
KW
66int bdrv_create(BlockDriver *drv, const char* filename,
67 QEMUOptionParameter *options);
84a12e66 68int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
faf07963 69BlockDriverState *bdrv_new(const char *device_name);
d22b2f41 70void bdrv_make_anon(BlockDriverState *bs);
faf07963
PB
71void bdrv_delete(BlockDriverState *bs);
72int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
d6e9098e
KW
73int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
74 BlockDriver *drv);
faf07963 75void bdrv_close(BlockDriverState *bs);
18846dee
MA
76int bdrv_attach(BlockDriverState *bs, DeviceState *qdev);
77void bdrv_detach(BlockDriverState *bs, DeviceState *qdev);
78DeviceState *bdrv_get_attached(BlockDriverState *bs);
faf07963
PB
79int bdrv_read(BlockDriverState *bs, int64_t sector_num,
80 uint8_t *buf, int nb_sectors);
81int bdrv_write(BlockDriverState *bs, int64_t sector_num,
82 const uint8_t *buf, int nb_sectors);
83int bdrv_pread(BlockDriverState *bs, int64_t offset,
84 void *buf, int count);
85int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
86 const void *buf, int count);
f08145fe
KW
87int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
88 const void *buf, int count);
da1fa91d
KW
89int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
90 int nb_sectors, QEMUIOVector *qiov);
91int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
92 int nb_sectors, QEMUIOVector *qiov);
faf07963
PB
93int bdrv_truncate(BlockDriverState *bs, int64_t offset);
94int64_t bdrv_getlength(BlockDriverState *bs);
4a1d5e1f 95int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
96b8f136 96void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
f3d54fc4 97void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
faf07963 98int bdrv_commit(BlockDriverState *bs);
6ab4b5ab 99void bdrv_commit_all(void);
756e6736
KW
100int bdrv_change_backing_file(BlockDriverState *bs,
101 const char *backing_file, const char *backing_fmt);
5efa9d5a
AL
102void bdrv_register(BlockDriver *bdrv);
103
e076f338
KW
104
105typedef struct BdrvCheckResult {
106 int corruptions;
107 int leaks;
108 int check_errors;
109} BdrvCheckResult;
110
111int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res);
112
faf07963
PB
113/* async block I/O */
114typedef struct BlockDriverAIOCB BlockDriverAIOCB;
115typedef void BlockDriverCompletionFunc(void *opaque, int ret);
7cd1e32a 116typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
39aa9a12 117 int sector_num);
3b69e4b9
AL
118BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
119 QEMUIOVector *iov, int nb_sectors,
120 BlockDriverCompletionFunc *cb, void *opaque);
121BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
122 QEMUIOVector *iov, int nb_sectors,
123 BlockDriverCompletionFunc *cb, void *opaque);
b2e12bc6 124BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
39aa9a12 125 BlockDriverCompletionFunc *cb, void *opaque);
faf07963
PB
126void bdrv_aio_cancel(BlockDriverAIOCB *acb);
127
40b4f539
KW
128typedef struct BlockRequest {
129 /* Fields to be filled by multiwrite caller */
130 int64_t sector;
131 int nb_sectors;
132 QEMUIOVector *qiov;
133 BlockDriverCompletionFunc *cb;
134 void *opaque;
135
136 /* Filled by multiwrite implementation */
137 int error;
138} BlockRequest;
139
140int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
141 int num_reqs);
142
7d780669 143/* sg packet commands */
221f715d
AL
144int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
145BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
146 unsigned long int req, void *buf,
147 BlockDriverCompletionFunc *cb, void *opaque);
7d780669 148
faf07963 149/* Ensure contents are flushed to disk. */
205ef796 150int bdrv_flush(BlockDriverState *bs);
c6ca28d6 151void bdrv_flush_all(void);
2bc93fed 152void bdrv_close_all(void);
c6ca28d6 153
bb8bf76f 154int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
f2feebbd 155int bdrv_has_zero_init(BlockDriverState *bs);
f58c7b35 156int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
39aa9a12 157 int *pnum);
faf07963 158
faf07963
PB
159#define BIOS_ATA_TRANSLATION_AUTO 0
160#define BIOS_ATA_TRANSLATION_NONE 1
161#define BIOS_ATA_TRANSLATION_LBA 2
162#define BIOS_ATA_TRANSLATION_LARGE 3
163#define BIOS_ATA_TRANSLATION_RECHS 4
164
165void bdrv_set_geometry_hint(BlockDriverState *bs,
166 int cyls, int heads, int secs);
faf07963
PB
167void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
168void bdrv_get_geometry_hint(BlockDriverState *bs,
169 int *pcyls, int *pheads, int *psecs);
5bbdbb46
BS
170typedef enum FDriveType {
171 FDRIVE_DRV_144 = 0x00, /* 1.44 MB 3"5 drive */
172 FDRIVE_DRV_288 = 0x01, /* 2.88 MB 3"5 drive */
173 FDRIVE_DRV_120 = 0x02, /* 1.2 MB 5"25 drive */
174 FDRIVE_DRV_NONE = 0x03, /* No drive connected */
175} FDriveType;
176
177void bdrv_get_floppy_geometry_hint(BlockDriverState *bs, int *nb_heads,
178 int *max_track, int *last_sect,
179 FDriveType drive_in, FDriveType *drive);
faf07963 180int bdrv_get_translation_hint(BlockDriverState *bs);
abd7f68d
MA
181void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
182 BlockErrorAction on_write_error);
183BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
7d0d6950 184void bdrv_set_removable(BlockDriverState *bs, int removable);
faf07963
PB
185int bdrv_is_removable(BlockDriverState *bs);
186int bdrv_is_read_only(BlockDriverState *bs);
985a03b0 187int bdrv_is_sg(BlockDriverState *bs);
e900a7b7 188int bdrv_enable_write_cache(BlockDriverState *bs);
faf07963
PB
189int bdrv_is_inserted(BlockDriverState *bs);
190int bdrv_media_changed(BlockDriverState *bs);
191int bdrv_is_locked(BlockDriverState *bs);
192void bdrv_set_locked(BlockDriverState *bs, int locked);
aea2a33c 193int bdrv_eject(BlockDriverState *bs, int eject_flag);
faf07963 194void bdrv_set_change_cb(BlockDriverState *bs,
db97ee6a
CH
195 void (*change_cb)(void *opaque, int reason),
196 void *opaque);
faf07963
PB
197void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
198BlockDriverState *bdrv_find(const char *name);
2f399b0a 199BlockDriverState *bdrv_next(BlockDriverState *bs);
51de9760
AL
200void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
201 void *opaque);
faf07963 202int bdrv_is_encrypted(BlockDriverState *bs);
c0f4ce77 203int bdrv_key_required(BlockDriverState *bs);
faf07963 204int bdrv_set_key(BlockDriverState *bs, const char *key);
c0f4ce77 205int bdrv_query_missing_keys(void);
faf07963
PB
206void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
207 void *opaque);
208const char *bdrv_get_device_name(BlockDriverState *bs);
209int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
210 const uint8_t *buf, int nb_sectors);
211int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
212
045df330 213const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
faf07963
PB
214void bdrv_get_backing_filename(BlockDriverState *bs,
215 char *filename, int filename_size);
feeee5ac 216int bdrv_can_snapshot(BlockDriverState *bs);
199630b6 217int bdrv_is_snapshot(BlockDriverState *bs);
f9092b10 218BlockDriverState *bdrv_snapshots(void);
faf07963
PB
219int bdrv_snapshot_create(BlockDriverState *bs,
220 QEMUSnapshotInfo *sn_info);
221int bdrv_snapshot_goto(BlockDriverState *bs,
222 const char *snapshot_id);
223int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
224int bdrv_snapshot_list(BlockDriverState *bs,
225 QEMUSnapshotInfo **psn_info);
51ef6727 226int bdrv_snapshot_load_tmp(BlockDriverState *bs,
227 const char *snapshot_name);
faf07963
PB
228char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
229
230char *get_human_readable_size(char *buf, int buf_size, int64_t size);
231int path_is_absolute(const char *path);
232void path_combine(char *dest, int dest_size,
233 const char *base_path,
234 const char *filename);
235
45566e9c
CH
236int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
237 int64_t pos, int size);
178e08a5 238
45566e9c
CH
239int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
240 int64_t pos, int size);
178e08a5 241
f88e1a42
JS
242int bdrv_img_create(const char *filename, const char *fmt,
243 const char *base_filename, const char *base_fmt,
244 char *options, uint64_t img_size, int flags);
245
23bd90d2 246#define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
6ea44308 247
7cd1e32a 248void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
249int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
a55eb92c
JK
250void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
251 int nr_sectors);
aaa0eb75 252int64_t bdrv_get_dirty_count(BlockDriverState *bs);
8b9b0cc2 253
db593f25
MT
254void bdrv_set_in_use(BlockDriverState *bs, int in_use);
255int bdrv_in_use(BlockDriverState *bs);
8b9b0cc2
KW
256
257typedef enum {
8252278a
KW
258 BLKDBG_L1_UPDATE,
259
260 BLKDBG_L1_GROW_ALLOC_TABLE,
261 BLKDBG_L1_GROW_WRITE_TABLE,
262 BLKDBG_L1_GROW_ACTIVATE_TABLE,
263
264 BLKDBG_L2_LOAD,
265 BLKDBG_L2_UPDATE,
266 BLKDBG_L2_UPDATE_COMPRESSED,
267 BLKDBG_L2_ALLOC_COW_READ,
268 BLKDBG_L2_ALLOC_WRITE,
269
270 BLKDBG_READ,
271 BLKDBG_READ_AIO,
272 BLKDBG_READ_BACKING,
273 BLKDBG_READ_BACKING_AIO,
274 BLKDBG_READ_COMPRESSED,
275
276 BLKDBG_WRITE_AIO,
277 BLKDBG_WRITE_COMPRESSED,
278
279 BLKDBG_VMSTATE_LOAD,
280 BLKDBG_VMSTATE_SAVE,
281
282 BLKDBG_COW_READ,
283 BLKDBG_COW_WRITE,
284
285 BLKDBG_REFTABLE_LOAD,
286 BLKDBG_REFTABLE_GROW,
287
288 BLKDBG_REFBLOCK_LOAD,
289 BLKDBG_REFBLOCK_UPDATE,
290 BLKDBG_REFBLOCK_UPDATE_PART,
291 BLKDBG_REFBLOCK_ALLOC,
292 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
293 BLKDBG_REFBLOCK_ALLOC_WRITE,
294 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
295 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
296 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
297
298 BLKDBG_CLUSTER_ALLOC,
299 BLKDBG_CLUSTER_ALLOC_BYTES,
300 BLKDBG_CLUSTER_FREE,
301
8b9b0cc2
KW
302 BLKDBG_EVENT_MAX,
303} BlkDebugEvent;
304
305#define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
306void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
307
faf07963 308#endif