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