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