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