]> git.proxmox.com Git - qemu.git/blame - block.h
vnc: rich cursor support.
[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"
d15e5465 7#include "qobject.h"
a76bab49 8
faf07963 9/* block.c */
faf07963
PB
10typedef struct BlockDriver BlockDriver;
11
faf07963
PB
12typedef struct BlockDriverInfo {
13 /* in bytes, 0 if irrelevant */
14 int cluster_size;
15 /* offset at which the VM state can be saved (0 if not possible) */
16 int64_t vm_state_offset;
17} BlockDriverInfo;
18
19typedef struct QEMUSnapshotInfo {
20 char id_str[128]; /* unique snapshot id */
21 /* the following fields are informative. They are not needed for
22 the consistency of the snapshot */
23 char name[256]; /* user choosen name */
24 uint32_t vm_state_size; /* VM state info size */
25 uint32_t date_sec; /* UTC date of the snapshot */
26 uint32_t date_nsec;
27 uint64_t vm_clock_nsec; /* VM clock relative to boot */
28} QEMUSnapshotInfo;
29
faf07963 30#define BDRV_O_RDWR 0x0002
faf07963 31#define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
9f7965c7
AL
32#define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
33#define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
5c6c3a6c 34#define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
b783e409 35#define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
9f7965c7 36
0aa217e4 37#define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB)
faf07963 38
6ea44308
JK
39#define BDRV_SECTOR_BITS 9
40#define BDRV_SECTOR_SIZE (1 << BDRV_SECTOR_BITS)
3abbc4d9 41#define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
6ea44308 42
2582bfed
LC
43typedef enum {
44 BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
45} BlockMonEventAction;
46
47void bdrv_mon_event(const BlockDriverState *bdrv,
48 BlockMonEventAction action, int is_read);
d15e5465
LC
49void bdrv_info_print(Monitor *mon, const QObject *data);
50void bdrv_info(Monitor *mon, QObject **ret_data);
218a536a
LC
51void bdrv_stats_print(Monitor *mon, const QObject *data);
52void bdrv_info_stats(Monitor *mon, QObject **ret_data);
faf07963
PB
53
54void bdrv_init(void);
eb852011 55void bdrv_init_with_whitelist(void);
faf07963 56BlockDriver *bdrv_find_format(const char *format_name);
eb852011 57BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
0e7e1989
KW
58int bdrv_create(BlockDriver *drv, const char* filename,
59 QEMUOptionParameter *options);
84a12e66 60int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
faf07963
PB
61BlockDriverState *bdrv_new(const char *device_name);
62void bdrv_delete(BlockDriverState *bs);
63int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
d6e9098e
KW
64int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
65 BlockDriver *drv);
faf07963 66void bdrv_close(BlockDriverState *bs);
e97fc193 67int bdrv_check(BlockDriverState *bs);
faf07963
PB
68int bdrv_read(BlockDriverState *bs, int64_t sector_num,
69 uint8_t *buf, int nb_sectors);
70int bdrv_write(BlockDriverState *bs, int64_t sector_num,
71 const uint8_t *buf, int nb_sectors);
72int bdrv_pread(BlockDriverState *bs, int64_t offset,
73 void *buf, int count);
74int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
75 const void *buf, int count);
76int bdrv_truncate(BlockDriverState *bs, int64_t offset);
77int64_t bdrv_getlength(BlockDriverState *bs);
96b8f136 78void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
f3d54fc4 79void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
faf07963 80int bdrv_commit(BlockDriverState *bs);
756e6736
KW
81int bdrv_change_backing_file(BlockDriverState *bs,
82 const char *backing_file, const char *backing_fmt);
5efa9d5a
AL
83void bdrv_register(BlockDriver *bdrv);
84
faf07963
PB
85/* async block I/O */
86typedef struct BlockDriverAIOCB BlockDriverAIOCB;
87typedef void BlockDriverCompletionFunc(void *opaque, int ret);
7cd1e32a 88typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
89 int sector_num);
3b69e4b9
AL
90BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
91 QEMUIOVector *iov, int nb_sectors,
92 BlockDriverCompletionFunc *cb, void *opaque);
93BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
94 QEMUIOVector *iov, int nb_sectors,
95 BlockDriverCompletionFunc *cb, void *opaque);
b2e12bc6
CH
96BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
97 BlockDriverCompletionFunc *cb, void *opaque);
faf07963
PB
98void bdrv_aio_cancel(BlockDriverAIOCB *acb);
99
40b4f539
KW
100typedef struct BlockRequest {
101 /* Fields to be filled by multiwrite caller */
102 int64_t sector;
103 int nb_sectors;
104 QEMUIOVector *qiov;
105 BlockDriverCompletionFunc *cb;
106 void *opaque;
107
108 /* Filled by multiwrite implementation */
109 int error;
110} BlockRequest;
111
112int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
113 int num_reqs);
114
7d780669 115/* sg packet commands */
221f715d
AL
116int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
117BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
118 unsigned long int req, void *buf,
119 BlockDriverCompletionFunc *cb, void *opaque);
7d780669 120
faf07963
PB
121/* Ensure contents are flushed to disk. */
122void bdrv_flush(BlockDriverState *bs);
c6ca28d6
AL
123void bdrv_flush_all(void);
124
f2feebbd 125int bdrv_has_zero_init(BlockDriverState *bs);
f58c7b35
TS
126int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
127 int *pnum);
faf07963
PB
128
129#define BDRV_TYPE_HD 0
130#define BDRV_TYPE_CDROM 1
131#define BDRV_TYPE_FLOPPY 2
132#define BIOS_ATA_TRANSLATION_AUTO 0
133#define BIOS_ATA_TRANSLATION_NONE 1
134#define BIOS_ATA_TRANSLATION_LBA 2
135#define BIOS_ATA_TRANSLATION_LARGE 3
136#define BIOS_ATA_TRANSLATION_RECHS 4
137
138void bdrv_set_geometry_hint(BlockDriverState *bs,
139 int cyls, int heads, int secs);
140void bdrv_set_type_hint(BlockDriverState *bs, int type);
141void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
142void bdrv_get_geometry_hint(BlockDriverState *bs,
143 int *pcyls, int *pheads, int *psecs);
144int bdrv_get_type_hint(BlockDriverState *bs);
145int bdrv_get_translation_hint(BlockDriverState *bs);
146int bdrv_is_removable(BlockDriverState *bs);
147int bdrv_is_read_only(BlockDriverState *bs);
985a03b0 148int bdrv_is_sg(BlockDriverState *bs);
e900a7b7 149int bdrv_enable_write_cache(BlockDriverState *bs);
faf07963
PB
150int bdrv_is_inserted(BlockDriverState *bs);
151int bdrv_media_changed(BlockDriverState *bs);
152int bdrv_is_locked(BlockDriverState *bs);
153void bdrv_set_locked(BlockDriverState *bs, int locked);
aea2a33c 154int bdrv_eject(BlockDriverState *bs, int eject_flag);
faf07963
PB
155void bdrv_set_change_cb(BlockDriverState *bs,
156 void (*change_cb)(void *opaque), void *opaque);
157void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
158BlockDriverState *bdrv_find(const char *name);
51de9760
AL
159void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
160 void *opaque);
faf07963 161int bdrv_is_encrypted(BlockDriverState *bs);
c0f4ce77 162int bdrv_key_required(BlockDriverState *bs);
faf07963 163int bdrv_set_key(BlockDriverState *bs, const char *key);
c0f4ce77 164int bdrv_query_missing_keys(void);
faf07963
PB
165void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
166 void *opaque);
167const char *bdrv_get_device_name(BlockDriverState *bs);
168int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
169 const uint8_t *buf, int nb_sectors);
170int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
171
045df330 172const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
faf07963
PB
173void bdrv_get_backing_filename(BlockDriverState *bs,
174 char *filename, int filename_size);
175int bdrv_snapshot_create(BlockDriverState *bs,
176 QEMUSnapshotInfo *sn_info);
177int bdrv_snapshot_goto(BlockDriverState *bs,
178 const char *snapshot_id);
179int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
180int bdrv_snapshot_list(BlockDriverState *bs,
181 QEMUSnapshotInfo **psn_info);
182char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
183
184char *get_human_readable_size(char *buf, int buf_size, int64_t size);
185int path_is_absolute(const char *path);
186void path_combine(char *dest, int dest_size,
187 const char *base_path,
188 const char *filename);
189
45566e9c
CH
190int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
191 int64_t pos, int size);
178e08a5 192
45566e9c
CH
193int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
194 int64_t pos, int size);
178e08a5 195
23bd90d2 196#define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
6ea44308 197
7cd1e32a 198void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
199int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
a55eb92c
JK
200void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
201 int nr_sectors);
aaa0eb75 202int64_t bdrv_get_dirty_count(BlockDriverState *bs);
8b9b0cc2
KW
203
204
205typedef enum {
8252278a
KW
206 BLKDBG_L1_UPDATE,
207
208 BLKDBG_L1_GROW_ALLOC_TABLE,
209 BLKDBG_L1_GROW_WRITE_TABLE,
210 BLKDBG_L1_GROW_ACTIVATE_TABLE,
211
212 BLKDBG_L2_LOAD,
213 BLKDBG_L2_UPDATE,
214 BLKDBG_L2_UPDATE_COMPRESSED,
215 BLKDBG_L2_ALLOC_COW_READ,
216 BLKDBG_L2_ALLOC_WRITE,
217
218 BLKDBG_READ,
219 BLKDBG_READ_AIO,
220 BLKDBG_READ_BACKING,
221 BLKDBG_READ_BACKING_AIO,
222 BLKDBG_READ_COMPRESSED,
223
224 BLKDBG_WRITE_AIO,
225 BLKDBG_WRITE_COMPRESSED,
226
227 BLKDBG_VMSTATE_LOAD,
228 BLKDBG_VMSTATE_SAVE,
229
230 BLKDBG_COW_READ,
231 BLKDBG_COW_WRITE,
232
233 BLKDBG_REFTABLE_LOAD,
234 BLKDBG_REFTABLE_GROW,
235
236 BLKDBG_REFBLOCK_LOAD,
237 BLKDBG_REFBLOCK_UPDATE,
238 BLKDBG_REFBLOCK_UPDATE_PART,
239 BLKDBG_REFBLOCK_ALLOC,
240 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
241 BLKDBG_REFBLOCK_ALLOC_WRITE,
242 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
243 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
244 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
245
246 BLKDBG_CLUSTER_ALLOC,
247 BLKDBG_CLUSTER_ALLOC_BYTES,
248 BLKDBG_CLUSTER_FREE,
249
8b9b0cc2
KW
250 BLKDBG_EVENT_MAX,
251} BlkDebugEvent;
252
253#define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
254void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
255
faf07963 256#endif