]>
Commit | Line | Data |
---|---|---|
ea2384d3 FB |
1 | /* |
2 | * QEMU System Emulator block driver | |
5fafdf24 | 3 | * |
ea2384d3 | 4 | * Copyright (c) 2003 Fabrice Bellard |
5fafdf24 | 5 | * |
ea2384d3 FB |
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
7 | * of this software and associated documentation files (the "Software"), to deal | |
8 | * in the Software without restriction, including without limitation the rights | |
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
10 | * copies of the Software, and to permit persons to whom the Software is | |
11 | * furnished to do so, subject to the following conditions: | |
12 | * | |
13 | * The above copyright notice and this permission notice shall be included in | |
14 | * all copies or substantial portions of the Software. | |
15 | * | |
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
19 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
22 | * THE SOFTWARE. | |
23 | */ | |
24 | #ifndef BLOCK_INT_H | |
25 | #define BLOCK_INT_H | |
26 | ||
faf07963 | 27 | #include "block.h" |
0e7e1989 | 28 | #include "qemu-option.h" |
1b7bdbc1 | 29 | #include "qemu-queue.h" |
faf07963 | 30 | |
ec36ba14 TS |
31 | #define BLOCK_FLAG_ENCRYPT 1 |
32 | #define BLOCK_FLAG_COMPRESS 2 | |
33 | #define BLOCK_FLAG_COMPAT6 4 | |
34 | ||
0e7e1989 KW |
35 | #define BLOCK_OPT_SIZE "size" |
36 | #define BLOCK_OPT_ENCRYPT "encryption" | |
37 | #define BLOCK_OPT_COMPAT6 "compat6" | |
38 | #define BLOCK_OPT_BACKING_FILE "backing_file" | |
39 | #define BLOCK_OPT_BACKING_FMT "backing_fmt" | |
73c632ed | 40 | #define BLOCK_OPT_CLUSTER_SIZE "cluster_size" |
a35e1c17 | 41 | #define BLOCK_OPT_PREALLOC "preallocation" |
0e7e1989 | 42 | |
6bbff9a0 AL |
43 | typedef struct AIOPool { |
44 | void (*cancel)(BlockDriverAIOCB *acb); | |
45 | int aiocb_size; | |
46 | BlockDriverAIOCB *free_aiocb; | |
47 | } AIOPool; | |
48 | ||
ea2384d3 FB |
49 | struct BlockDriver { |
50 | const char *format_name; | |
51 | int instance_size; | |
52 | int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename); | |
508c7cb3 | 53 | int (*bdrv_probe_device)(const char *filename); |
66f82cee KW |
54 | int (*bdrv_open)(BlockDriverState *bs, int flags); |
55 | int (*bdrv_file_open)(BlockDriverState *bs, const char *filename, int flags); | |
5fafdf24 | 56 | int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num, |
ea2384d3 | 57 | uint8_t *buf, int nb_sectors); |
5fafdf24 | 58 | int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num, |
ea2384d3 | 59 | const uint8_t *buf, int nb_sectors); |
e2731add | 60 | void (*bdrv_close)(BlockDriverState *bs); |
0e7e1989 | 61 | int (*bdrv_create)(const char *filename, QEMUOptionParameter *options); |
205ef796 | 62 | int (*bdrv_flush)(BlockDriverState *bs); |
ea2384d3 FB |
63 | int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num, |
64 | int nb_sectors, int *pnum); | |
65 | int (*bdrv_set_key)(BlockDriverState *bs, const char *key); | |
95389c86 | 66 | int (*bdrv_make_empty)(BlockDriverState *bs); |
83f64091 | 67 | /* aio */ |
f141eafe AL |
68 | BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs, |
69 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, | |
ce1a14dc | 70 | BlockDriverCompletionFunc *cb, void *opaque); |
f141eafe AL |
71 | BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs, |
72 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, | |
ce1a14dc | 73 | BlockDriverCompletionFunc *cb, void *opaque); |
b2e12bc6 CH |
74 | BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs, |
75 | BlockDriverCompletionFunc *cb, void *opaque); | |
83f64091 | 76 | |
40b4f539 KW |
77 | int (*bdrv_aio_multiwrite)(BlockDriverState *bs, BlockRequest *reqs, |
78 | int num_reqs); | |
79 | int (*bdrv_merge_requests)(BlockDriverState *bs, BlockRequest* a, | |
80 | BlockRequest *b); | |
81 | ||
82 | ||
83f64091 | 83 | const char *protocol_name; |
83f64091 FB |
84 | int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset); |
85 | int64_t (*bdrv_getlength)(BlockDriverState *bs); | |
5fafdf24 | 86 | int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num, |
faea38e7 FB |
87 | const uint8_t *buf, int nb_sectors); |
88 | ||
5fafdf24 | 89 | int (*bdrv_snapshot_create)(BlockDriverState *bs, |
faea38e7 | 90 | QEMUSnapshotInfo *sn_info); |
5fafdf24 | 91 | int (*bdrv_snapshot_goto)(BlockDriverState *bs, |
faea38e7 FB |
92 | const char *snapshot_id); |
93 | int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id); | |
5fafdf24 | 94 | int (*bdrv_snapshot_list)(BlockDriverState *bs, |
faea38e7 | 95 | QEMUSnapshotInfo **psn_info); |
51ef6727 | 96 | int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs, |
97 | const char *snapshot_name); | |
faea38e7 | 98 | int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi); |
83f64091 | 99 | |
45566e9c CH |
100 | int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf, |
101 | int64_t pos, int size); | |
102 | int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf, | |
103 | int64_t pos, int size); | |
178e08a5 | 104 | |
756e6736 KW |
105 | int (*bdrv_change_backing_file)(BlockDriverState *bs, |
106 | const char *backing_file, const char *backing_fmt); | |
107 | ||
19cb3738 FB |
108 | /* removable device specific */ |
109 | int (*bdrv_is_inserted)(BlockDriverState *bs); | |
110 | int (*bdrv_media_changed)(BlockDriverState *bs); | |
111 | int (*bdrv_eject)(BlockDriverState *bs, int eject_flag); | |
112 | int (*bdrv_set_locked)(BlockDriverState *bs, int locked); | |
3b46e624 | 113 | |
985a03b0 TS |
114 | /* to control generic scsi devices */ |
115 | int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf); | |
221f715d AL |
116 | BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs, |
117 | unsigned long int req, void *buf, | |
118 | BlockDriverCompletionFunc *cb, void *opaque); | |
985a03b0 | 119 | |
0e7e1989 KW |
120 | /* List of options for creating images, terminated by name == NULL */ |
121 | QEMUOptionParameter *create_options; | |
122 | ||
5eb45639 | 123 | |
9ac228e0 KW |
124 | /* |
125 | * Returns 0 for completed check, -errno for internal errors. | |
126 | * The check results are stored in result. | |
127 | */ | |
128 | int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result); | |
e97fc193 | 129 | |
8b9b0cc2 KW |
130 | void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event); |
131 | ||
336c1c12 KW |
132 | /* |
133 | * Returns 1 if newly created images are guaranteed to contain only | |
134 | * zeros, 0 otherwise. | |
135 | */ | |
136 | int (*bdrv_has_zero_init)(BlockDriverState *bs); | |
12c09b8c | 137 | |
8a22f02a | 138 | QLIST_ENTRY(BlockDriver) list; |
ea2384d3 FB |
139 | }; |
140 | ||
141 | struct BlockDriverState { | |
d15a771d FB |
142 | int64_t total_sectors; /* if we are reading a disk image, give its |
143 | size in sectors */ | |
ea2384d3 | 144 | int read_only; /* if true, the media is read only */ |
4dca4b63 NS |
145 | int keep_read_only; /* if true, the media was requested to stay read only */ |
146 | int open_flags; /* flags used to open the file, re-used for re-open */ | |
ea2384d3 FB |
147 | int removable; /* if true, the media can be removed */ |
148 | int locked; /* if true, the media cannot temporarily be ejected */ | |
4be9762a | 149 | int tray_open; /* if true, the virtual tray is open */ |
ea2384d3 | 150 | int encrypted; /* if true, the media is encrypted */ |
c0f4ce77 | 151 | int valid_key; /* if true, a valid encryption key has been set */ |
985a03b0 | 152 | int sg; /* if true, the device is a /dev/sg* */ |
ea2384d3 FB |
153 | /* event callback when inserting/removing */ |
154 | void (*change_cb)(void *opaque); | |
155 | void *change_opaque; | |
156 | ||
19cb3738 | 157 | BlockDriver *drv; /* NULL means no media */ |
ea2384d3 FB |
158 | void *opaque; |
159 | ||
18846dee MA |
160 | DeviceState *peer; |
161 | ||
ea2384d3 FB |
162 | char filename[1024]; |
163 | char backing_file[1024]; /* if non zero, the image is a diff of | |
164 | this file image */ | |
5eb45639 | 165 | char backing_format[16]; /* if non-zero and backing_file exists */ |
ea2384d3 | 166 | int is_temporary; |
19cb3738 FB |
167 | int media_changed; |
168 | ||
ea2384d3 | 169 | BlockDriverState *backing_hd; |
66f82cee KW |
170 | BlockDriverState *file; |
171 | ||
ce1a14dc | 172 | /* async read/write emulation */ |
83f64091 | 173 | |
ce1a14dc | 174 | void *sync_aiocb; |
3b46e624 | 175 | |
a36e69dd TS |
176 | /* I/O stats (display with "info blockstats"). */ |
177 | uint64_t rd_bytes; | |
178 | uint64_t wr_bytes; | |
179 | uint64_t rd_ops; | |
180 | uint64_t wr_ops; | |
294cc35f | 181 | uint64_t wr_highest_sector; |
a36e69dd | 182 | |
71d0770c AL |
183 | /* Whether the disk can expand beyond total_sectors */ |
184 | int growable; | |
185 | ||
e268ca52 AL |
186 | /* the memory alignment required for the buffers handled by this driver */ |
187 | int buffer_alignment; | |
188 | ||
e900a7b7 CH |
189 | /* do we need to tell the quest if we have a volatile write cache? */ |
190 | int enable_write_cache; | |
191 | ||
ea2384d3 FB |
192 | /* NOTE: the following infos are only hints for real hardware |
193 | drivers. They are not used by the block driver */ | |
46d4767d | 194 | int cyls, heads, secs, translation; |
ea2384d3 | 195 | int type; |
abd7f68d | 196 | BlockErrorAction on_read_error, on_write_error; |
ea2384d3 | 197 | char device_name[32]; |
c6d22830 | 198 | unsigned long *dirty_bitmap; |
aaa0eb75 | 199 | int64_t dirty_count; |
1b7bdbc1 | 200 | QTAILQ_ENTRY(BlockDriverState) list; |
b0a7b120 | 201 | void *private; |
ea2384d3 FB |
202 | }; |
203 | ||
83f64091 | 204 | struct BlockDriverAIOCB { |
6bbff9a0 | 205 | AIOPool *pool; |
83f64091 FB |
206 | BlockDriverState *bs; |
207 | BlockDriverCompletionFunc *cb; | |
ce1a14dc PB |
208 | void *opaque; |
209 | BlockDriverAIOCB *next; | |
83f64091 FB |
210 | }; |
211 | ||
95389c86 FB |
212 | void get_tmp_filename(char *filename, int size); |
213 | ||
c16b5a2c CH |
214 | void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs, |
215 | BlockDriverCompletionFunc *cb, void *opaque); | |
ce1a14dc PB |
216 | void qemu_aio_release(void *p); |
217 | ||
e268ca52 AL |
218 | void *qemu_blockalign(BlockDriverState *bs, size_t size); |
219 | ||
508c7cb3 CH |
220 | #ifdef _WIN32 |
221 | int is_windows_drive(const char *filename); | |
222 | #endif | |
223 | ||
428c149b | 224 | typedef struct BlockConf { |
f8b6cc00 | 225 | BlockDriverState *bs; |
428c149b | 226 | uint16_t physical_block_size; |
8cfacf07 | 227 | uint16_t logical_block_size; |
428c149b CH |
228 | uint16_t min_io_size; |
229 | uint32_t opt_io_size; | |
230 | } BlockConf; | |
231 | ||
232 | static inline unsigned int get_physical_block_exp(BlockConf *conf) | |
233 | { | |
234 | unsigned int exp = 0, size; | |
235 | ||
1e297c32 CH |
236 | for (size = conf->physical_block_size; |
237 | size > conf->logical_block_size; | |
238 | size >>= 1) { | |
428c149b CH |
239 | exp++; |
240 | } | |
241 | ||
242 | return exp; | |
243 | } | |
244 | ||
245 | #define DEFINE_BLOCK_PROPERTIES(_state, _conf) \ | |
f8b6cc00 | 246 | DEFINE_PROP_DRIVE("drive", _state, _conf.bs), \ |
8cfacf07 CH |
247 | DEFINE_PROP_UINT16("logical_block_size", _state, \ |
248 | _conf.logical_block_size, 512), \ | |
428c149b CH |
249 | DEFINE_PROP_UINT16("physical_block_size", _state, \ |
250 | _conf.physical_block_size, 512), \ | |
55459498 CH |
251 | DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0), \ |
252 | DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0) | |
428c149b | 253 | |
ea2384d3 | 254 | #endif /* BLOCK_INT_H */ |