]> git.proxmox.com Git - qemu.git/blame - block.h
qcow2: Report error for version > 2
[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
PB
68BlockDriverState *bdrv_new(const char *device_name);
69void bdrv_delete(BlockDriverState *bs);
70int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
d6e9098e
KW
71int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
72 BlockDriver *drv);
faf07963 73void bdrv_close(BlockDriverState *bs);
18846dee
MA
74int bdrv_attach(BlockDriverState *bs, DeviceState *qdev);
75void bdrv_detach(BlockDriverState *bs, DeviceState *qdev);
76DeviceState *bdrv_get_attached(BlockDriverState *bs);
faf07963
PB
77int bdrv_read(BlockDriverState *bs, int64_t sector_num,
78 uint8_t *buf, int nb_sectors);
79int bdrv_write(BlockDriverState *bs, int64_t sector_num,
80 const uint8_t *buf, int nb_sectors);
81int bdrv_pread(BlockDriverState *bs, int64_t offset,
82 void *buf, int count);
83int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
84 const void *buf, int count);
f08145fe
KW
85int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
86 const void *buf, int count);
87int bdrv_write_sync(BlockDriverState *bs, int64_t sector_num,
88 const uint8_t *buf, int nb_sectors);
faf07963
PB
89int bdrv_truncate(BlockDriverState *bs, int64_t offset);
90int64_t bdrv_getlength(BlockDriverState *bs);
96b8f136 91void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
f3d54fc4 92void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
faf07963 93int bdrv_commit(BlockDriverState *bs);
6ab4b5ab 94void bdrv_commit_all(void);
756e6736
KW
95int bdrv_change_backing_file(BlockDriverState *bs,
96 const char *backing_file, const char *backing_fmt);
5efa9d5a
AL
97void bdrv_register(BlockDriver *bdrv);
98
e076f338
KW
99
100typedef struct BdrvCheckResult {
101 int corruptions;
102 int leaks;
103 int check_errors;
104} BdrvCheckResult;
105
106int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res);
107
faf07963
PB
108/* async block I/O */
109typedef struct BlockDriverAIOCB BlockDriverAIOCB;
110typedef void BlockDriverCompletionFunc(void *opaque, int ret);
7cd1e32a 111typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
112 int sector_num);
3b69e4b9
AL
113BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
114 QEMUIOVector *iov, int nb_sectors,
115 BlockDriverCompletionFunc *cb, void *opaque);
116BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
117 QEMUIOVector *iov, int nb_sectors,
118 BlockDriverCompletionFunc *cb, void *opaque);
b2e12bc6
CH
119BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
120 BlockDriverCompletionFunc *cb, void *opaque);
faf07963
PB
121void bdrv_aio_cancel(BlockDriverAIOCB *acb);
122
40b4f539
KW
123typedef struct BlockRequest {
124 /* Fields to be filled by multiwrite caller */
125 int64_t sector;
126 int nb_sectors;
127 QEMUIOVector *qiov;
128 BlockDriverCompletionFunc *cb;
129 void *opaque;
130
131 /* Filled by multiwrite implementation */
132 int error;
133} BlockRequest;
134
135int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
136 int num_reqs);
137
7d780669 138/* sg packet commands */
221f715d
AL
139int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
140BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
141 unsigned long int req, void *buf,
142 BlockDriverCompletionFunc *cb, void *opaque);
7d780669 143
faf07963 144/* Ensure contents are flushed to disk. */
205ef796 145int bdrv_flush(BlockDriverState *bs);
c6ca28d6 146void bdrv_flush_all(void);
2bc93fed 147void bdrv_close_all(void);
c6ca28d6 148
bb8bf76f 149int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
f2feebbd 150int bdrv_has_zero_init(BlockDriverState *bs);
f58c7b35
TS
151int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
152 int *pnum);
faf07963
PB
153
154#define BDRV_TYPE_HD 0
155#define BDRV_TYPE_CDROM 1
156#define BDRV_TYPE_FLOPPY 2
157#define BIOS_ATA_TRANSLATION_AUTO 0
158#define BIOS_ATA_TRANSLATION_NONE 1
159#define BIOS_ATA_TRANSLATION_LBA 2
160#define BIOS_ATA_TRANSLATION_LARGE 3
161#define BIOS_ATA_TRANSLATION_RECHS 4
162
163void bdrv_set_geometry_hint(BlockDriverState *bs,
164 int cyls, int heads, int secs);
165void bdrv_set_type_hint(BlockDriverState *bs, int type);
166void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
167void bdrv_get_geometry_hint(BlockDriverState *bs,
168 int *pcyls, int *pheads, int *psecs);
169int bdrv_get_type_hint(BlockDriverState *bs);
170int bdrv_get_translation_hint(BlockDriverState *bs);
abd7f68d
MA
171void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
172 BlockErrorAction on_write_error);
173BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
7d0d6950 174void bdrv_set_removable(BlockDriverState *bs, int removable);
faf07963
PB
175int bdrv_is_removable(BlockDriverState *bs);
176int bdrv_is_read_only(BlockDriverState *bs);
985a03b0 177int bdrv_is_sg(BlockDriverState *bs);
e900a7b7 178int bdrv_enable_write_cache(BlockDriverState *bs);
faf07963
PB
179int bdrv_is_inserted(BlockDriverState *bs);
180int bdrv_media_changed(BlockDriverState *bs);
181int bdrv_is_locked(BlockDriverState *bs);
182void bdrv_set_locked(BlockDriverState *bs, int locked);
aea2a33c 183int bdrv_eject(BlockDriverState *bs, int eject_flag);
faf07963 184void bdrv_set_change_cb(BlockDriverState *bs,
db97ee6a
CH
185 void (*change_cb)(void *opaque, int reason),
186 void *opaque);
faf07963
PB
187void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
188BlockDriverState *bdrv_find(const char *name);
2f399b0a 189BlockDriverState *bdrv_next(BlockDriverState *bs);
51de9760
AL
190void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
191 void *opaque);
faf07963 192int bdrv_is_encrypted(BlockDriverState *bs);
c0f4ce77 193int bdrv_key_required(BlockDriverState *bs);
faf07963 194int bdrv_set_key(BlockDriverState *bs, const char *key);
c0f4ce77 195int bdrv_query_missing_keys(void);
faf07963
PB
196void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
197 void *opaque);
198const char *bdrv_get_device_name(BlockDriverState *bs);
199int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
200 const uint8_t *buf, int nb_sectors);
201int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
202
045df330 203const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
faf07963
PB
204void bdrv_get_backing_filename(BlockDriverState *bs,
205 char *filename, int filename_size);
feeee5ac 206int bdrv_can_snapshot(BlockDriverState *bs);
199630b6 207int bdrv_is_snapshot(BlockDriverState *bs);
f9092b10 208BlockDriverState *bdrv_snapshots(void);
faf07963
PB
209int bdrv_snapshot_create(BlockDriverState *bs,
210 QEMUSnapshotInfo *sn_info);
211int bdrv_snapshot_goto(BlockDriverState *bs,
212 const char *snapshot_id);
213int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
214int bdrv_snapshot_list(BlockDriverState *bs,
215 QEMUSnapshotInfo **psn_info);
51ef6727 216int bdrv_snapshot_load_tmp(BlockDriverState *bs,
217 const char *snapshot_name);
faf07963
PB
218char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
219
220char *get_human_readable_size(char *buf, int buf_size, int64_t size);
221int path_is_absolute(const char *path);
222void path_combine(char *dest, int dest_size,
223 const char *base_path,
224 const char *filename);
225
45566e9c
CH
226int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
227 int64_t pos, int size);
178e08a5 228
45566e9c
CH
229int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
230 int64_t pos, int size);
178e08a5 231
f88e1a42
JS
232int bdrv_img_create(const char *filename, const char *fmt,
233 const char *base_filename, const char *base_fmt,
234 char *options, uint64_t img_size, int flags);
235
23bd90d2 236#define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
6ea44308 237
7cd1e32a 238void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
239int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
a55eb92c
JK
240void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
241 int nr_sectors);
aaa0eb75 242int64_t bdrv_get_dirty_count(BlockDriverState *bs);
8b9b0cc2 243
44d631a0
MT
244void bdrv_set_in_use(BlockDriverState *bs, int in_use);
245int bdrv_in_use(BlockDriverState *bs);
8b9b0cc2
KW
246
247typedef enum {
8252278a
KW
248 BLKDBG_L1_UPDATE,
249
250 BLKDBG_L1_GROW_ALLOC_TABLE,
251 BLKDBG_L1_GROW_WRITE_TABLE,
252 BLKDBG_L1_GROW_ACTIVATE_TABLE,
253
254 BLKDBG_L2_LOAD,
255 BLKDBG_L2_UPDATE,
256 BLKDBG_L2_UPDATE_COMPRESSED,
257 BLKDBG_L2_ALLOC_COW_READ,
258 BLKDBG_L2_ALLOC_WRITE,
259
260 BLKDBG_READ,
261 BLKDBG_READ_AIO,
262 BLKDBG_READ_BACKING,
263 BLKDBG_READ_BACKING_AIO,
264 BLKDBG_READ_COMPRESSED,
265
266 BLKDBG_WRITE_AIO,
267 BLKDBG_WRITE_COMPRESSED,
268
269 BLKDBG_VMSTATE_LOAD,
270 BLKDBG_VMSTATE_SAVE,
271
272 BLKDBG_COW_READ,
273 BLKDBG_COW_WRITE,
274
275 BLKDBG_REFTABLE_LOAD,
276 BLKDBG_REFTABLE_GROW,
277
278 BLKDBG_REFBLOCK_LOAD,
279 BLKDBG_REFBLOCK_UPDATE,
280 BLKDBG_REFBLOCK_UPDATE_PART,
281 BLKDBG_REFBLOCK_ALLOC,
282 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
283 BLKDBG_REFBLOCK_ALLOC_WRITE,
284 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
285 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
286 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
287
288 BLKDBG_CLUSTER_ALLOC,
289 BLKDBG_CLUSTER_ALLOC_BYTES,
290 BLKDBG_CLUSTER_FREE,
291
8b9b0cc2
KW
292 BLKDBG_EVENT_MAX,
293} BlkDebugEvent;
294
295#define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
296void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
297
faf07963 298#endif