Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 288 lines (244 sloc) 10.9 kB
faf0796 Split block API from vl.h.
pbrook authored
1 #ifndef BLOCK_H
2 #define BLOCK_H
3
a76bab4 Refactor AIO to allow multiple AIO implementations
aliguori authored
4 #include "qemu-aio.h"
3b69e4b Vectored block device API (Avi Kivity)
aliguori authored
5 #include "qemu-common.h"
0e7e198 Convert all block drivers to new bdrv_create
Kevin Wolf authored
6 #include "qemu-option.h"
d15e546 block: Convert bdrv_info() to QObject
Luiz Capitulino authored
7 #include "qobject.h"
a76bab4 Refactor AIO to allow multiple AIO implementations
aliguori authored
8
faf0796 Split block API from vl.h.
pbrook authored
9 /* block.c */
10 typedef struct BlockDriver BlockDriver;
11
12 typedef 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
19 typedef 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
30 #define BDRV_O_RDWR 0x0002
31 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
9f7965c Expand cache= option and use write-through caching by default
aliguori authored
32 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
33 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
5c6c3a6 raw-posix: add Linux native AIO support
Christoph Hellwig authored
34 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
b783e40 block: Introduce BDRV_O_NO_BACKING
Kevin Wolf authored
35 #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
016f5cf @agraf Add cache=unsafe parameter to -drive
agraf authored
36 #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
9f7965c Expand cache= option and use write-through caching by default
aliguori authored
37
0aa217e qcow2: Make cache=writethrough default
Kevin Wolf authored
38 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB)
faf0796 Split block API from vl.h.
pbrook authored
39
6ea4430 @jan-kiszka block migration: Rework constants API
jan-kiszka authored
40 #define BDRV_SECTOR_BITS 9
c63782c block.h: Make BDRV_SECTOR_SIZE 64 bit safe
Jes Sorensen authored
41 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
3abbc4d block: Remove semicolon in BDRV_SECTOR_MASK macro
Stefan Hajnoczi authored
42 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
6ea4430 @jan-kiszka block migration: Rework constants API
jan-kiszka authored
43
2582bfe block: BLOCK_IO_ERROR QMP event
Luiz Capitulino authored
44 typedef enum {
abd7f68 block: Move error actions from DriveInfo to BlockDriverState
Markus Armbruster authored
45 BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
46 BLOCK_ERR_STOP_ANY
47 } BlockErrorAction;
48
49 typedef enum {
2582bfe block: BLOCK_IO_ERROR QMP event
Luiz Capitulino authored
50 BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
51 } BlockMonEventAction;
52
53 void bdrv_mon_event(const BlockDriverState *bdrv,
54 BlockMonEventAction action, int is_read);
d15e546 block: Convert bdrv_info() to QObject
Luiz Capitulino authored
55 void bdrv_info_print(Monitor *mon, const QObject *data);
56 void bdrv_info(Monitor *mon, QObject **ret_data);
218a536 block: Convert bdrv_info_stats() to QObject
Luiz Capitulino authored
57 void bdrv_stats_print(Monitor *mon, const QObject *data);
58 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
faf0796 Split block API from vl.h.
pbrook authored
59
60 void bdrv_init(void);
eb85201 Configurable block format whitelist
Markus Armbruster authored
61 void bdrv_init_with_whitelist(void);
b50cbab @kazum add support for protocol driver create_options
kazum authored
62 BlockDriver *bdrv_find_protocol(const char *filename);
faf0796 Split block API from vl.h.
pbrook authored
63 BlockDriver *bdrv_find_format(const char *format_name);
eb85201 Configurable block format whitelist
Markus Armbruster authored
64 BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
0e7e198 Convert all block drivers to new bdrv_create
Kevin Wolf authored
65 int bdrv_create(BlockDriver *drv, const char* filename,
66 QEMUOptionParameter *options);
84a12e6 block: separate raw images from the file protocol
Christoph Hellwig authored
67 int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
faf0796 Split block API from vl.h.
pbrook authored
68 BlockDriverState *bdrv_new(const char *device_name);
69 void bdrv_delete(BlockDriverState *bs);
70 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
d6e9098 Replace calls of old bdrv_open
Kevin Wolf authored
71 int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
72 BlockDriver *drv);
faf0796 Split block API from vl.h.
pbrook authored
73 void bdrv_close(BlockDriverState *bs);
18846de block: Catch attempt to attach multiple devices to a blockdev
Markus Armbruster authored
74 int bdrv_attach(BlockDriverState *bs, DeviceState *qdev);
75 void bdrv_detach(BlockDriverState *bs, DeviceState *qdev);
76 DeviceState *bdrv_get_attached(BlockDriverState *bs);
faf0796 Split block API from vl.h.
pbrook authored
77 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
78 uint8_t *buf, int nb_sectors);
79 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
80 const uint8_t *buf, int nb_sectors);
81 int bdrv_pread(BlockDriverState *bs, int64_t offset,
82 void *buf, int count);
83 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
84 const void *buf, int count);
f08145f block: Add bdrv_(p)write_sync
Kevin Wolf authored
85 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
86 const void *buf, int count);
87 int bdrv_write_sync(BlockDriverState *bs, int64_t sector_num,
88 const uint8_t *buf, int nb_sectors);
faf0796 Split block API from vl.h.
pbrook authored
89 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
90 int64_t bdrv_getlength(BlockDriverState *bs);
96b8f13 Fix bdrv_get_geometry to return uint64_t, by Andre Przywara.
ths authored
91 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
f3d54fc Abstract out geometry detection code from IDE for reuse
aliguori authored
92 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
faf0796 Split block API from vl.h.
pbrook authored
93 int bdrv_commit(BlockDriverState *bs);
6ab4b5a block: Decouple block device "commit all" from DriveInfo
Markus Armbruster authored
94 void bdrv_commit_all(void);
756e673 block: Add bdrv_change_backing_file
Kevin Wolf authored
95 int bdrv_change_backing_file(BlockDriverState *bs,
96 const char *backing_file, const char *backing_fmt);
5efa9d5 Convert block infrastructure to use new module init functionality
Anthony Liguori authored
97 void bdrv_register(BlockDriver *bdrv);
98
e076f33 qemu-img check: Distinguish different kinds of errors
Kevin Wolf authored
99
100 typedef struct BdrvCheckResult {
101 int corruptions;
102 int leaks;
103 int check_errors;
104 } BdrvCheckResult;
105
106 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res);
107
faf0796 Split block API from vl.h.
pbrook authored
108 /* async block I/O */
109 typedef struct BlockDriverAIOCB BlockDriverAIOCB;
110 typedef void BlockDriverCompletionFunc(void *opaque, int ret);
7cd1e32 @liranschour Expose a mechanism to trace block writes
liranschour authored
111 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
112 int sector_num);
3b69e4b Vectored block device API (Avi Kivity)
aliguori authored
113 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
114 QEMUIOVector *iov, int nb_sectors,
115 BlockDriverCompletionFunc *cb, void *opaque);
116 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
117 QEMUIOVector *iov, int nb_sectors,
118 BlockDriverCompletionFunc *cb, void *opaque);
b2e12bc block: add aio_flush operation
Christoph Hellwig authored
119 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
120 BlockDriverCompletionFunc *cb, void *opaque);
faf0796 Split block API from vl.h.
pbrook authored
121 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
122
40b4f53 Add bdrv_aio_multiwrite
Kevin Wolf authored
123 typedef 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
135 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
136 int num_reqs);
137
7d78066 Add specialized block driver scsi generic API (Avi Kivity)
aliguori authored
138 /* sg packet commands */
221f715 new scsi-generic abstraction, use SG_IO (Christoph Hellwig)
aliguori authored
139 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
140 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
141 unsigned long int req, void *buf,
142 BlockDriverCompletionFunc *cb, void *opaque);
7d78066 Add specialized block driver scsi generic API (Avi Kivity)
aliguori authored
143
faf0796 Split block API from vl.h.
pbrook authored
144 /* Ensure contents are flushed to disk. */
145 void bdrv_flush(BlockDriverState *bs);
c6ca28d Add bdrv_flush_all()
aliguori authored
146 void bdrv_flush_all(void);
2bc93fe @kazum close all the block drivers before the qemu process exits
kazum authored
147 void bdrv_close_all(void);
c6ca28d Add bdrv_flush_all()
aliguori authored
148
f2feebb block: bdrv_has_zero_init
Kevin Wolf authored
149 int bdrv_has_zero_init(BlockDriverState *bs);
f58c7b3 New qemu-img convert -B option, by Marc Bevand.
ths authored
150 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
151 int *pnum);
faf0796 Split block API from vl.h.
pbrook authored
152
153 #define BDRV_TYPE_HD 0
154 #define BDRV_TYPE_CDROM 1
155 #define BDRV_TYPE_FLOPPY 2
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
162 void bdrv_set_geometry_hint(BlockDriverState *bs,
163 int cyls, int heads, int secs);
164 void bdrv_set_type_hint(BlockDriverState *bs, int type);
165 void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
166 void bdrv_get_geometry_hint(BlockDriverState *bs,
167 int *pcyls, int *pheads, int *psecs);
168 int bdrv_get_type_hint(BlockDriverState *bs);
169 int bdrv_get_translation_hint(BlockDriverState *bs);
abd7f68 block: Move error actions from DriveInfo to BlockDriverState
Markus Armbruster authored
170 void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
171 BlockErrorAction on_write_error);
172 BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
7d0d695 block: Fix virtual media change for if=none
Markus Armbruster authored
173 void bdrv_set_removable(BlockDriverState *bs, int removable);
faf0796 Split block API from vl.h.
pbrook authored
174 int bdrv_is_removable(BlockDriverState *bs);
175 int bdrv_is_read_only(BlockDriverState *bs);
985a03b Real SCSI device passthrough (v4), by Laurent Vivier.
ths authored
176 int bdrv_is_sg(BlockDriverState *bs);
e900a7b block: add enable_write_cache flag
Christoph Hellwig authored
177 int bdrv_enable_write_cache(BlockDriverState *bs);
faf0796 Split block API from vl.h.
pbrook authored
178 int bdrv_is_inserted(BlockDriverState *bs);
179 int bdrv_media_changed(BlockDriverState *bs);
180 int bdrv_is_locked(BlockDriverState *bs);
181 void bdrv_set_locked(BlockDriverState *bs, int locked);
aea2a33 @markmc Prevent CD-ROM media eject while device is locked
markmc authored
182 int bdrv_eject(BlockDriverState *bs, int eject_flag);
faf0796 Split block API from vl.h.
pbrook authored
183 void bdrv_set_change_cb(BlockDriverState *bs,
184 void (*change_cb)(void *opaque), void *opaque);
185 void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
186 BlockDriverState *bdrv_find(const char *name);
2f399b0 block: New bdrv_next()
Markus Armbruster authored
187 BlockDriverState *bdrv_next(BlockDriverState *bs);
51de976 block: Improve bdrv_iterate (Jan Kiszka)
aliguori authored
188 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
189 void *opaque);
faf0796 Split block API from vl.h.
pbrook authored
190 int bdrv_is_encrypted(BlockDriverState *bs);
c0f4ce7 monitor: Rework early disk password inquiry (Jan Kiszka)
aliguori authored
191 int bdrv_key_required(BlockDriverState *bs);
faf0796 Split block API from vl.h.
pbrook authored
192 int bdrv_set_key(BlockDriverState *bs, const char *key);
c0f4ce7 monitor: Rework early disk password inquiry (Jan Kiszka)
aliguori authored
193 int bdrv_query_missing_keys(void);
faf0796 Split block API from vl.h.
pbrook authored
194 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
195 void *opaque);
196 const char *bdrv_get_device_name(BlockDriverState *bs);
197 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
198 const uint8_t *buf, int nb_sectors);
199 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
200
045df33 block: Introduce bdrv_get_encrypted_filename (Jan Kiszka)
aliguori authored
201 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
faf0796 Split block API from vl.h.
pbrook authored
202 void bdrv_get_backing_filename(BlockDriverState *bs,
203 char *filename, int filename_size);
feeee5a @mciurcio savevm: Really verify if a drive supports snapshots
mciurcio authored
204 int bdrv_can_snapshot(BlockDriverState *bs);
f9092b1 savevm: Survive hot-unplug of snapshot device
Markus Armbruster authored
205 BlockDriverState *bdrv_snapshots(void);
faf0796 Split block API from vl.h.
pbrook authored
206 int bdrv_snapshot_create(BlockDriverState *bs,
207 QEMUSnapshotInfo *sn_info);
208 int bdrv_snapshot_goto(BlockDriverState *bs,
209 const char *snapshot_id);
210 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
211 int bdrv_snapshot_list(BlockDriverState *bs,
212 QEMUSnapshotInfo **psn_info);
213 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
214
215 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
216 int path_is_absolute(const char *path);
217 void path_combine(char *dest, int dest_size,
218 const char *base_path,
219 const char *filename);
220
45566e9 replace bdrv_{get, put}_buffer with bdrv_{load, save}_vmstate
Christoph Hellwig authored
221 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
222 int64_t pos, int size);
178e08a Fix savevm after BDRV_FILE size enforcement
aliguori authored
223
45566e9 replace bdrv_{get, put}_buffer with bdrv_{load, save}_vmstate
Christoph Hellwig authored
224 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
225 int64_t pos, int size);
178e08a Fix savevm after BDRV_FILE size enforcement
aliguori authored
226
23bd90d @jan-kiszka block migration: Increase dirty chunk size to 1M
jan-kiszka authored
227 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
6ea4430 @jan-kiszka block migration: Rework constants API
jan-kiszka authored
228
7cd1e32 @liranschour Expose a mechanism to trace block writes
liranschour authored
229 void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
230 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
a55eb92 @jan-kiszka block migration: Fix coding style and whitespaces
jan-kiszka authored
231 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
232 int nr_sectors);
aaa0eb7 @liranschour Count dirty blocks and expose an API to get dirty count
liranschour authored
233 int64_t bdrv_get_dirty_count(BlockDriverState *bs);
8b9b0cc blkdebug: Add events and rules
Kevin Wolf authored
234
235
236 typedef enum {
8252278 qcow2: Trigger blkdebug events
Kevin Wolf authored
237 BLKDBG_L1_UPDATE,
238
239 BLKDBG_L1_GROW_ALLOC_TABLE,
240 BLKDBG_L1_GROW_WRITE_TABLE,
241 BLKDBG_L1_GROW_ACTIVATE_TABLE,
242
243 BLKDBG_L2_LOAD,
244 BLKDBG_L2_UPDATE,
245 BLKDBG_L2_UPDATE_COMPRESSED,
246 BLKDBG_L2_ALLOC_COW_READ,
247 BLKDBG_L2_ALLOC_WRITE,
248
249 BLKDBG_READ,
250 BLKDBG_READ_AIO,
251 BLKDBG_READ_BACKING,
252 BLKDBG_READ_BACKING_AIO,
253 BLKDBG_READ_COMPRESSED,
254
255 BLKDBG_WRITE_AIO,
256 BLKDBG_WRITE_COMPRESSED,
257
258 BLKDBG_VMSTATE_LOAD,
259 BLKDBG_VMSTATE_SAVE,
260
261 BLKDBG_COW_READ,
262 BLKDBG_COW_WRITE,
263
264 BLKDBG_REFTABLE_LOAD,
265 BLKDBG_REFTABLE_GROW,
266
267 BLKDBG_REFBLOCK_LOAD,
268 BLKDBG_REFBLOCK_UPDATE,
269 BLKDBG_REFBLOCK_UPDATE_PART,
270 BLKDBG_REFBLOCK_ALLOC,
271 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
272 BLKDBG_REFBLOCK_ALLOC_WRITE,
273 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
274 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
275 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
276
277 BLKDBG_CLUSTER_ALLOC,
278 BLKDBG_CLUSTER_ALLOC_BYTES,
279 BLKDBG_CLUSTER_FREE,
280
8b9b0cc blkdebug: Add events and rules
Kevin Wolf authored
281 BLKDBG_EVENT_MAX,
282 } BlkDebugEvent;
283
284 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
285 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
286
faf0796 Split block API from vl.h.
pbrook authored
287 #endif
Something went wrong with that request. Please try again.