blob: 5f6438010f84c925cbf18f277cd91870f42c78b5 [file] [log] [blame]
pbrookfaf07962007-11-11 02:51:17 +00001#ifndef BLOCK_H
2#define BLOCK_H
3
aliguoria76bab42008-09-22 19:17:18 +00004#include "qemu-aio.h"
aliguori3b69e4b2009-01-22 16:59:24 +00005#include "qemu-common.h"
Kevin Wolf0e7e1982009-05-18 16:42:10 +02006#include "qemu-option.h"
Luiz Capitulinod15e5462009-12-10 17:16:06 -02007#include "qobject.h"
aliguoria76bab42008-09-22 19:17:18 +00008
pbrookfaf07962007-11-11 02:51:17 +00009/* block.c */
pbrookfaf07962007-11-11 02:51:17 +000010typedef struct BlockDriver BlockDriver;
11
pbrookfaf07962007-11-11 02:51:17 +000012typedef 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
pbrookfaf07962007-11-11 02:51:17 +000030#define BDRV_O_RDWR 0x0002
pbrookfaf07962007-11-11 02:51:17 +000031#define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
aliguori9f7965c2008-10-14 14:42:54 +000032#define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
33#define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
Christoph Hellwig5c6c3a62009-08-20 16:58:35 +020034#define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
Kevin Wolfb783e402010-01-12 12:55:16 +010035#define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
Alexander Graf016f5cf2010-05-26 17:51:49 +020036#define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
aliguori9f7965c2008-10-14 14:42:54 +000037
Kevin Wolfceb25e52010-08-31 15:08:03 +020038#define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
pbrookfaf07962007-11-11 02:51:17 +000039
Jan Kiszka6ea44302009-11-30 18:21:19 +010040#define BDRV_SECTOR_BITS 9
Jes Sorensenc63782c2010-05-27 15:46:55 +020041#define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
Stefan Hajnoczi3abbc4d2010-05-01 07:23:32 +010042#define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
Jan Kiszka6ea44302009-11-30 18:21:19 +010043
Luiz Capitulino2582bfe2010-02-03 12:41:01 -020044typedef enum {
Markus Armbrusterabd7f682010-06-02 18:55:17 +020045 BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
46 BLOCK_ERR_STOP_ANY
47} BlockErrorAction;
48
49typedef enum {
Luiz Capitulino2582bfe2010-02-03 12:41:01 -020050 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);
Luiz Capitulinod15e5462009-12-10 17:16:06 -020055void bdrv_info_print(Monitor *mon, const QObject *data);
56void bdrv_info(Monitor *mon, QObject **ret_data);
Luiz Capitulino218a5362009-12-10 17:16:07 -020057void bdrv_stats_print(Monitor *mon, const QObject *data);
58void bdrv_info_stats(Monitor *mon, QObject **ret_data);
pbrookfaf07962007-11-11 02:51:17 +000059
60void bdrv_init(void);
Markus Armbrustereb852012009-10-27 18:41:44 +010061void bdrv_init_with_whitelist(void);
MORITA Kazutakab50cbab2010-05-26 11:35:36 +090062BlockDriver *bdrv_find_protocol(const char *filename);
pbrookfaf07962007-11-11 02:51:17 +000063BlockDriver *bdrv_find_format(const char *format_name);
Markus Armbrustereb852012009-10-27 18:41:44 +010064BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
Kevin Wolf0e7e1982009-05-18 16:42:10 +020065int bdrv_create(BlockDriver *drv, const char* filename,
66 QEMUOptionParameter *options);
Christoph Hellwig84a12e62010-04-07 22:30:24 +020067int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
pbrookfaf07962007-11-11 02:51:17 +000068BlockDriverState *bdrv_new(const char *device_name);
69void bdrv_delete(BlockDriverState *bs);
70int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
Kevin Wolfd6e90982010-03-31 14:40:27 +020071int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
72 BlockDriver *drv);
pbrookfaf07962007-11-11 02:51:17 +000073void bdrv_close(BlockDriverState *bs);
Markus Armbruster18846de2010-06-29 16:58:30 +020074int bdrv_attach(BlockDriverState *bs, DeviceState *qdev);
75void bdrv_detach(BlockDriverState *bs, DeviceState *qdev);
76DeviceState *bdrv_get_attached(BlockDriverState *bs);
pbrookfaf07962007-11-11 02:51:17 +000077int 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);
Kevin Wolff08145f2010-06-16 16:38:15 +020085int 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);
pbrookfaf07962007-11-11 02:51:17 +000089int bdrv_truncate(BlockDriverState *bs, int64_t offset);
90int64_t bdrv_getlength(BlockDriverState *bs);
ths96b8f132007-12-17 01:35:20 +000091void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
aliguorif3d54fc2008-11-25 21:50:24 +000092void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
pbrookfaf07962007-11-11 02:51:17 +000093int bdrv_commit(BlockDriverState *bs);
Markus Armbruster6ab4b5a2010-06-02 18:55:18 +020094void bdrv_commit_all(void);
Kevin Wolf756e6732010-01-12 12:55:17 +010095int bdrv_change_backing_file(BlockDriverState *bs,
96 const char *backing_file, const char *backing_fmt);
Anthony Liguori5efa9d52009-05-09 17:03:42 -050097void bdrv_register(BlockDriver *bdrv);
98
Kevin Wolfe076f332010-06-29 11:43:13 +020099
100typedef struct BdrvCheckResult {
101 int corruptions;
102 int leaks;
103 int check_errors;
104} BdrvCheckResult;
105
106int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res);
107
pbrookfaf07962007-11-11 02:51:17 +0000108/* async block I/O */
109typedef struct BlockDriverAIOCB BlockDriverAIOCB;
110typedef void BlockDriverCompletionFunc(void *opaque, int ret);
lirans@il.ibm.com7cd1e322009-11-02 15:40:41 +0200111typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
112 int sector_num);
aliguori3b69e4b2009-01-22 16:59:24 +0000113BlockDriverAIOCB *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);
Christoph Hellwigb2e12bc2009-09-04 19:01:49 +0200119BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
120 BlockDriverCompletionFunc *cb, void *opaque);
pbrookfaf07962007-11-11 02:51:17 +0000121void bdrv_aio_cancel(BlockDriverAIOCB *acb);
122
Kevin Wolf40b4f532009-09-09 17:53:37 +0200123typedef 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
aliguori7d780662009-03-12 19:57:08 +0000138/* sg packet commands */
aliguori221f7152009-03-28 17:28:41 +0000139int 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);
aliguori7d780662009-03-12 19:57:08 +0000143
pbrookfaf07962007-11-11 02:51:17 +0000144/* Ensure contents are flushed to disk. */
145void bdrv_flush(BlockDriverState *bs);
aliguoric6ca28d2008-10-06 13:55:43 +0000146void bdrv_flush_all(void);
MORITA Kazutaka2bc93fe2010-05-28 11:44:57 +0900147void bdrv_close_all(void);
aliguoric6ca28d2008-10-06 13:55:43 +0000148
Kevin Wolff2feebb2010-04-14 17:30:35 +0200149int bdrv_has_zero_init(BlockDriverState *bs);
thsf58c7b32008-06-05 21:53:49 +0000150int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
151 int *pnum);
pbrookfaf07962007-11-11 02:51:17 +0000152
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
162void bdrv_set_geometry_hint(BlockDriverState *bs,
163 int cyls, int heads, int secs);
164void bdrv_set_type_hint(BlockDriverState *bs, int type);
165void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
166void bdrv_get_geometry_hint(BlockDriverState *bs,
167 int *pcyls, int *pheads, int *psecs);
168int bdrv_get_type_hint(BlockDriverState *bs);
169int bdrv_get_translation_hint(BlockDriverState *bs);
Markus Armbrusterabd7f682010-06-02 18:55:17 +0200170void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
171 BlockErrorAction on_write_error);
172BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
Markus Armbruster7d0d6952010-06-25 13:42:14 +0200173void bdrv_set_removable(BlockDriverState *bs, int removable);
pbrookfaf07962007-11-11 02:51:17 +0000174int bdrv_is_removable(BlockDriverState *bs);
175int bdrv_is_read_only(BlockDriverState *bs);
ths985a03b2007-12-24 16:10:43 +0000176int bdrv_is_sg(BlockDriverState *bs);
Christoph Hellwige900a7b2009-09-04 19:01:15 +0200177int bdrv_enable_write_cache(BlockDriverState *bs);
pbrookfaf07962007-11-11 02:51:17 +0000178int bdrv_is_inserted(BlockDriverState *bs);
179int bdrv_media_changed(BlockDriverState *bs);
180int bdrv_is_locked(BlockDriverState *bs);
181void bdrv_set_locked(BlockDriverState *bs, int locked);
Mark McLoughlinaea2a332009-05-27 10:06:11 +0100182int bdrv_eject(BlockDriverState *bs, int eject_flag);
pbrookfaf07962007-11-11 02:51:17 +0000183void bdrv_set_change_cb(BlockDriverState *bs,
184 void (*change_cb)(void *opaque), void *opaque);
185void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
186BlockDriverState *bdrv_find(const char *name);
Markus Armbruster2f399b02010-06-02 18:55:20 +0200187BlockDriverState *bdrv_next(BlockDriverState *bs);
aliguori51de9762009-03-05 23:00:43 +0000188void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
189 void *opaque);
pbrookfaf07962007-11-11 02:51:17 +0000190int bdrv_is_encrypted(BlockDriverState *bs);
aliguoric0f4ce72009-03-05 23:01:01 +0000191int bdrv_key_required(BlockDriverState *bs);
pbrookfaf07962007-11-11 02:51:17 +0000192int bdrv_set_key(BlockDriverState *bs, const char *key);
aliguoric0f4ce72009-03-05 23:01:01 +0000193int bdrv_query_missing_keys(void);
pbrookfaf07962007-11-11 02:51:17 +0000194void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
195 void *opaque);
196const char *bdrv_get_device_name(BlockDriverState *bs);
197int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
198 const uint8_t *buf, int nb_sectors);
199int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
200
aliguori045df332009-03-05 23:00:48 +0000201const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
pbrookfaf07962007-11-11 02:51:17 +0000202void bdrv_get_backing_filename(BlockDriverState *bs,
203 char *filename, int filename_size);
Miguel Di Ciurcio Filhofeeee5a2010-06-08 10:40:55 -0300204int bdrv_can_snapshot(BlockDriverState *bs);
Blue Swirl199630b2010-07-25 20:49:34 +0000205int bdrv_is_snapshot(BlockDriverState *bs);
Markus Armbrusterf9092b12010-06-25 10:33:39 +0200206BlockDriverState *bdrv_snapshots(void);
pbrookfaf07962007-11-11 02:51:17 +0000207int bdrv_snapshot_create(BlockDriverState *bs,
208 QEMUSnapshotInfo *sn_info);
209int bdrv_snapshot_goto(BlockDriverState *bs,
210 const char *snapshot_id);
211int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
212int bdrv_snapshot_list(BlockDriverState *bs,
213 QEMUSnapshotInfo **psn_info);
214char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
pbrookfaf07962007-11-11 02:51:17 +0000215
216char *get_human_readable_size(char *buf, int buf_size, int64_t size);
217int path_is_absolute(const char *path);
218void path_combine(char *dest, int dest_size,
219 const char *base_path,
220 const char *filename);
221
Christoph Hellwig45566e92009-07-10 23:11:57 +0200222int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
223 int64_t pos, int size);
aliguori178e08a2009-04-05 19:10:55 +0000224
Christoph Hellwig45566e92009-07-10 23:11:57 +0200225int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
226 int64_t pos, int size);
aliguori178e08a2009-04-05 19:10:55 +0000227
Jan Kiszka23bd90d2009-11-30 18:21:22 +0100228#define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
Jan Kiszka6ea44302009-11-30 18:21:19 +0100229
lirans@il.ibm.com7cd1e322009-11-02 15:40:41 +0200230void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
231int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
Jan Kiszkaa55eb922009-11-30 18:21:19 +0100232void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
233 int nr_sectors);
Liran Schouraaa0eb72010-01-26 10:31:48 +0200234int64_t bdrv_get_dirty_count(BlockDriverState *bs);
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100235
236
237typedef enum {
Kevin Wolf82522782010-03-15 17:38:05 +0100238 BLKDBG_L1_UPDATE,
239
240 BLKDBG_L1_GROW_ALLOC_TABLE,
241 BLKDBG_L1_GROW_WRITE_TABLE,
242 BLKDBG_L1_GROW_ACTIVATE_TABLE,
243
244 BLKDBG_L2_LOAD,
245 BLKDBG_L2_UPDATE,
246 BLKDBG_L2_UPDATE_COMPRESSED,
247 BLKDBG_L2_ALLOC_COW_READ,
248 BLKDBG_L2_ALLOC_WRITE,
249
250 BLKDBG_READ,
251 BLKDBG_READ_AIO,
252 BLKDBG_READ_BACKING,
253 BLKDBG_READ_BACKING_AIO,
254 BLKDBG_READ_COMPRESSED,
255
256 BLKDBG_WRITE_AIO,
257 BLKDBG_WRITE_COMPRESSED,
258
259 BLKDBG_VMSTATE_LOAD,
260 BLKDBG_VMSTATE_SAVE,
261
262 BLKDBG_COW_READ,
263 BLKDBG_COW_WRITE,
264
265 BLKDBG_REFTABLE_LOAD,
266 BLKDBG_REFTABLE_GROW,
267
268 BLKDBG_REFBLOCK_LOAD,
269 BLKDBG_REFBLOCK_UPDATE,
270 BLKDBG_REFBLOCK_UPDATE_PART,
271 BLKDBG_REFBLOCK_ALLOC,
272 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
273 BLKDBG_REFBLOCK_ALLOC_WRITE,
274 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
275 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
276 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
277
278 BLKDBG_CLUSTER_ALLOC,
279 BLKDBG_CLUSTER_ALLOC_BYTES,
280 BLKDBG_CLUSTER_FREE,
281
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100282 BLKDBG_EVENT_MAX,
283} BlkDebugEvent;
284
285#define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
286void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
287
pbrookfaf07962007-11-11 02:51:17 +0000288#endif