[WIN32] Enable -k option on Windows too
[qemu.git] / block.h
blob2d4f066906ef3b95f272dae8ad70aae2ef476a96
1 #ifndef BLOCK_H
2 #define BLOCK_H
4 #include "qemu-aio.h"
5 #include "qemu-common.h"
6 #include "qemu-option.h"
8 /* block.c */
9 typedef struct BlockDriver BlockDriver;
11 typedef struct BlockDriverInfo {
12 /* in bytes, 0 if irrelevant */
13 int cluster_size;
14 /* offset at which the VM state can be saved (0 if not possible) */
15 int64_t vm_state_offset;
16 } BlockDriverInfo;
18 typedef struct QEMUSnapshotInfo {
19 char id_str[128]; /* unique snapshot id */
20 /* the following fields are informative. They are not needed for
21 the consistency of the snapshot */
22 char name[256]; /* user choosen name */
23 uint32_t vm_state_size; /* VM state info size */
24 uint32_t date_sec; /* UTC date of the snapshot */
25 uint32_t date_nsec;
26 uint64_t vm_clock_nsec; /* VM clock relative to boot */
27 } QEMUSnapshotInfo;
29 #define BDRV_O_RDONLY 0x0000
30 #define BDRV_O_RDWR 0x0002
31 #define BDRV_O_ACCESS 0x0003
32 #define BDRV_O_CREAT 0x0004 /* create an empty file */
33 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
34 #define BDRV_O_FILE 0x0010 /* open as a raw file (do not try to
35 use a disk image format on top of
36 it (default for
37 bdrv_file_open()) */
38 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
39 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
40 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
42 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB)
44 void bdrv_info(Monitor *mon);
45 void bdrv_info_stats(Monitor *mon);
47 void bdrv_init(void);
48 void bdrv_init_with_whitelist(void);
49 BlockDriver *bdrv_find_format(const char *format_name);
50 BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
51 int bdrv_create(BlockDriver *drv, const char* filename,
52 QEMUOptionParameter *options);
53 int bdrv_create2(BlockDriver *drv,
54 const char *filename, int64_t size_in_sectors,
55 const char *backing_file, const char *backing_format,
56 int flags);
57 BlockDriverState *bdrv_new(const char *device_name);
58 void bdrv_delete(BlockDriverState *bs);
59 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
60 int bdrv_open(BlockDriverState *bs, const char *filename, int flags);
61 int bdrv_open2(BlockDriverState *bs, const char *filename, int flags,
62 BlockDriver *drv);
63 void bdrv_close(BlockDriverState *bs);
64 int bdrv_check(BlockDriverState *bs);
65 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
66 uint8_t *buf, int nb_sectors);
67 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
68 const uint8_t *buf, int nb_sectors);
69 int bdrv_pread(BlockDriverState *bs, int64_t offset,
70 void *buf, int count);
71 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
72 const void *buf, int count);
73 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
74 int64_t bdrv_getlength(BlockDriverState *bs);
75 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
76 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
77 int bdrv_commit(BlockDriverState *bs);
78 void bdrv_register(BlockDriver *bdrv);
80 /* async block I/O */
81 typedef struct BlockDriverAIOCB BlockDriverAIOCB;
82 typedef void BlockDriverCompletionFunc(void *opaque, int ret);
83 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
84 int sector_num);
85 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
86 QEMUIOVector *iov, int nb_sectors,
87 BlockDriverCompletionFunc *cb, void *opaque);
88 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
89 QEMUIOVector *iov, int nb_sectors,
90 BlockDriverCompletionFunc *cb, void *opaque);
91 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
92 BlockDriverCompletionFunc *cb, void *opaque);
93 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
95 typedef struct BlockRequest {
96 /* Fields to be filled by multiwrite caller */
97 int64_t sector;
98 int nb_sectors;
99 QEMUIOVector *qiov;
100 BlockDriverCompletionFunc *cb;
101 void *opaque;
103 /* Filled by multiwrite implementation */
104 int error;
105 } BlockRequest;
107 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
108 int num_reqs);
110 /* sg packet commands */
111 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
112 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
113 unsigned long int req, void *buf,
114 BlockDriverCompletionFunc *cb, void *opaque);
116 /* Ensure contents are flushed to disk. */
117 void bdrv_flush(BlockDriverState *bs);
118 void bdrv_flush_all(void);
120 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
121 int *pnum);
123 #define BDRV_TYPE_HD 0
124 #define BDRV_TYPE_CDROM 1
125 #define BDRV_TYPE_FLOPPY 2
126 #define BIOS_ATA_TRANSLATION_AUTO 0
127 #define BIOS_ATA_TRANSLATION_NONE 1
128 #define BIOS_ATA_TRANSLATION_LBA 2
129 #define BIOS_ATA_TRANSLATION_LARGE 3
130 #define BIOS_ATA_TRANSLATION_RECHS 4
132 void bdrv_set_geometry_hint(BlockDriverState *bs,
133 int cyls, int heads, int secs);
134 void bdrv_set_type_hint(BlockDriverState *bs, int type);
135 void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
136 void bdrv_get_geometry_hint(BlockDriverState *bs,
137 int *pcyls, int *pheads, int *psecs);
138 int bdrv_get_type_hint(BlockDriverState *bs);
139 int bdrv_get_translation_hint(BlockDriverState *bs);
140 int bdrv_is_removable(BlockDriverState *bs);
141 int bdrv_is_read_only(BlockDriverState *bs);
142 int bdrv_set_read_only(BlockDriverState *bs, int read_only);
143 int bdrv_is_sg(BlockDriverState *bs);
144 int bdrv_enable_write_cache(BlockDriverState *bs);
145 int bdrv_is_inserted(BlockDriverState *bs);
146 int bdrv_media_changed(BlockDriverState *bs);
147 int bdrv_is_locked(BlockDriverState *bs);
148 void bdrv_set_locked(BlockDriverState *bs, int locked);
149 int bdrv_eject(BlockDriverState *bs, int eject_flag);
150 void bdrv_set_change_cb(BlockDriverState *bs,
151 void (*change_cb)(void *opaque), void *opaque);
152 void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
153 BlockDriverState *bdrv_find(const char *name);
154 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
155 void *opaque);
156 int bdrv_is_encrypted(BlockDriverState *bs);
157 int bdrv_key_required(BlockDriverState *bs);
158 int bdrv_set_key(BlockDriverState *bs, const char *key);
159 int bdrv_query_missing_keys(void);
160 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
161 void *opaque);
162 const char *bdrv_get_device_name(BlockDriverState *bs);
163 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
164 const uint8_t *buf, int nb_sectors);
165 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
167 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
168 void bdrv_get_backing_filename(BlockDriverState *bs,
169 char *filename, int filename_size);
170 int bdrv_snapshot_create(BlockDriverState *bs,
171 QEMUSnapshotInfo *sn_info);
172 int bdrv_snapshot_goto(BlockDriverState *bs,
173 const char *snapshot_id);
174 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
175 int bdrv_snapshot_list(BlockDriverState *bs,
176 QEMUSnapshotInfo **psn_info);
177 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
179 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
180 int path_is_absolute(const char *path);
181 void path_combine(char *dest, int dest_size,
182 const char *base_path,
183 const char *filename);
185 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
186 int64_t pos, int size);
188 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
189 int64_t pos, int size);
191 void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
192 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
193 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
194 int nr_sectors);
195 int bdrv_get_sectors_per_chunk(void);
196 #endif