]>
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 | ||
5e5a94b6 | 27 | #include "block/accounting.h" |
737e150e | 28 | #include "block/block.h" |
1de7afc9 PB |
29 | #include "qemu/option.h" |
30 | #include "qemu/queue.h" | |
737e150e | 31 | #include "block/coroutine.h" |
1de7afc9 | 32 | #include "qemu/timer.h" |
b2023818 | 33 | #include "qapi-types.h" |
7b1b5d19 | 34 | #include "qapi/qmp/qerror.h" |
83c9089e | 35 | #include "monitor/monitor.h" |
8f0720ec | 36 | #include "qemu/hbitmap.h" |
f364ec65 | 37 | #include "block/snapshot.h" |
6a1751b7 | 38 | #include "qemu/main-loop.h" |
cc0681c4 | 39 | #include "qemu/throttle.h" |
faf07963 | 40 | |
bfe8043e SH |
41 | #define BLOCK_FLAG_ENCRYPT 1 |
42 | #define BLOCK_FLAG_COMPAT6 4 | |
43 | #define BLOCK_FLAG_LAZY_REFCOUNTS 8 | |
ec36ba14 | 44 | |
bfe8043e SH |
45 | #define BLOCK_OPT_SIZE "size" |
46 | #define BLOCK_OPT_ENCRYPT "encryption" | |
47 | #define BLOCK_OPT_COMPAT6 "compat6" | |
48 | #define BLOCK_OPT_BACKING_FILE "backing_file" | |
49 | #define BLOCK_OPT_BACKING_FMT "backing_fmt" | |
50 | #define BLOCK_OPT_CLUSTER_SIZE "cluster_size" | |
51 | #define BLOCK_OPT_TABLE_SIZE "table_size" | |
52 | #define BLOCK_OPT_PREALLOC "preallocation" | |
53 | #define BLOCK_OPT_SUBFMT "subformat" | |
54 | #define BLOCK_OPT_COMPAT_LEVEL "compat" | |
55 | #define BLOCK_OPT_LAZY_REFCOUNTS "lazy_refcounts" | |
7f2039f6 | 56 | #define BLOCK_OPT_ADAPTER_TYPE "adapter_type" |
b3af018f | 57 | #define BLOCK_OPT_REDUNDANCY "redundancy" |
4ab15590 | 58 | #define BLOCK_OPT_NOCOW "nocow" |
876eb1b0 | 59 | #define BLOCK_OPT_OBJECT_SIZE "object_size" |
06d05fa7 | 60 | #define BLOCK_OPT_REFCOUNT_BITS "refcount_bits" |
0e7e1989 | 61 | |
7cddd372 KW |
62 | #define BLOCK_PROBE_BUF_SIZE 512 |
63 | ||
d616b224 SH |
64 | typedef struct BdrvTrackedRequest { |
65 | BlockDriverState *bs; | |
793ed47a KW |
66 | int64_t offset; |
67 | unsigned int bytes; | |
d616b224 | 68 | bool is_write; |
7327145f | 69 | |
2dbafdc0 | 70 | bool serialising; |
7327145f KW |
71 | int64_t overlap_offset; |
72 | unsigned int overlap_bytes; | |
73 | ||
d616b224 SH |
74 | QLIST_ENTRY(BdrvTrackedRequest) list; |
75 | Coroutine *co; /* owner, used for deadlock detection */ | |
76 | CoQueue wait_queue; /* coroutines blocked on this request */ | |
6460440f KW |
77 | |
78 | struct BdrvTrackedRequest *waiting_for; | |
d616b224 SH |
79 | } BdrvTrackedRequest; |
80 | ||
ea2384d3 FB |
81 | struct BlockDriver { |
82 | const char *format_name; | |
83 | int instance_size; | |
f6186f49 | 84 | |
b5042a36 BC |
85 | /* set to true if the BlockDriver is a block filter */ |
86 | bool is_filter; | |
87 | /* for snapshots block filter like Quorum can implement the | |
88 | * following recursive callback. | |
212a5a8f BC |
89 | * It's purpose is to recurse on the filter children while calling |
90 | * bdrv_recurse_is_first_non_filter on them. | |
91 | * For a sample implementation look in the future Quorum block filter. | |
f6186f49 | 92 | */ |
212a5a8f BC |
93 | bool (*bdrv_recurse_is_first_non_filter)(BlockDriverState *bs, |
94 | BlockDriverState *candidate); | |
f6186f49 | 95 | |
ea2384d3 | 96 | int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename); |
508c7cb3 | 97 | int (*bdrv_probe_device)(const char *filename); |
c2ad1b0c KW |
98 | |
99 | /* Any driver implementing this callback is expected to be able to handle | |
100 | * NULL file names in its .bdrv_open() implementation */ | |
6963a30d | 101 | void (*bdrv_parse_filename)(const char *filename, QDict *options, Error **errp); |
030be321 BC |
102 | /* Drivers not implementing bdrv_parse_filename nor bdrv_open should have |
103 | * this field set to true, except ones that are defined only by their | |
104 | * child's bs. | |
105 | * An example of the last type will be the quorum block driver. | |
106 | */ | |
107 | bool bdrv_needs_filename; | |
e971aa12 | 108 | |
8ee79e70 KW |
109 | /* Set if a driver can support backing files */ |
110 | bool supports_backing; | |
111 | ||
e971aa12 JC |
112 | /* For handling image reopen for split or non-split files */ |
113 | int (*bdrv_reopen_prepare)(BDRVReopenState *reopen_state, | |
114 | BlockReopenQueue *queue, Error **errp); | |
115 | void (*bdrv_reopen_commit)(BDRVReopenState *reopen_state); | |
116 | void (*bdrv_reopen_abort)(BDRVReopenState *reopen_state); | |
117 | ||
015a1036 HR |
118 | int (*bdrv_open)(BlockDriverState *bs, QDict *options, int flags, |
119 | Error **errp); | |
120 | int (*bdrv_file_open)(BlockDriverState *bs, QDict *options, int flags, | |
121 | Error **errp); | |
5fafdf24 | 122 | int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num, |
ea2384d3 | 123 | uint8_t *buf, int nb_sectors); |
5fafdf24 | 124 | int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num, |
ea2384d3 | 125 | const uint8_t *buf, int nb_sectors); |
e2731add | 126 | void (*bdrv_close)(BlockDriverState *bs); |
e023b2e2 | 127 | void (*bdrv_rebind)(BlockDriverState *bs); |
c282e1fd | 128 | int (*bdrv_create)(const char *filename, QemuOpts *opts, Error **errp); |
ea2384d3 | 129 | int (*bdrv_set_key)(BlockDriverState *bs, const char *key); |
95389c86 | 130 | int (*bdrv_make_empty)(BlockDriverState *bs); |
91af7014 HR |
131 | |
132 | void (*bdrv_refresh_filename)(BlockDriverState *bs); | |
133 | ||
83f64091 | 134 | /* aio */ |
7c84b1b8 | 135 | BlockAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs, |
f141eafe | 136 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, |
097310b5 | 137 | BlockCompletionFunc *cb, void *opaque); |
7c84b1b8 | 138 | BlockAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs, |
f141eafe | 139 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, |
097310b5 | 140 | BlockCompletionFunc *cb, void *opaque); |
7c84b1b8 | 141 | BlockAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs, |
097310b5 | 142 | BlockCompletionFunc *cb, void *opaque); |
7c84b1b8 | 143 | BlockAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs, |
4265d620 | 144 | int64_t sector_num, int nb_sectors, |
097310b5 | 145 | BlockCompletionFunc *cb, void *opaque); |
83f64091 | 146 | |
da1fa91d KW |
147 | int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs, |
148 | int64_t sector_num, int nb_sectors, QEMUIOVector *qiov); | |
149 | int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs, | |
150 | int64_t sector_num, int nb_sectors, QEMUIOVector *qiov); | |
f08f2dda SH |
151 | /* |
152 | * Efficiently zero a region of the disk image. Typically an image format | |
153 | * would use a compact metadata representation to implement this. This | |
154 | * function pointer may be NULL and .bdrv_co_writev() will be called | |
155 | * instead. | |
156 | */ | |
157 | int coroutine_fn (*bdrv_co_write_zeroes)(BlockDriverState *bs, | |
aa7bfbff | 158 | int64_t sector_num, int nb_sectors, BdrvRequestFlags flags); |
4265d620 PB |
159 | int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs, |
160 | int64_t sector_num, int nb_sectors); | |
b6b8a333 | 161 | int64_t coroutine_fn (*bdrv_co_get_block_status)(BlockDriverState *bs, |
376ae3f1 | 162 | int64_t sector_num, int nb_sectors, int *pnum); |
da1fa91d | 163 | |
0f15423c AL |
164 | /* |
165 | * Invalidate any cached meta-data. | |
166 | */ | |
5a8a30db | 167 | void (*bdrv_invalidate_cache)(BlockDriverState *bs, Error **errp); |
0f15423c | 168 | |
c68b89ac KW |
169 | /* |
170 | * Flushes all data that was already written to the OS all the way down to | |
171 | * the disk (for example raw-posix calls fsync()). | |
172 | */ | |
173 | int coroutine_fn (*bdrv_co_flush_to_disk)(BlockDriverState *bs); | |
174 | ||
eb489bb1 KW |
175 | /* |
176 | * Flushes all internal caches to the OS. The data may still sit in a | |
177 | * writeback cache of the host OS, but it will survive a crash of the qemu | |
178 | * process. | |
179 | */ | |
180 | int coroutine_fn (*bdrv_co_flush_to_os)(BlockDriverState *bs); | |
181 | ||
83f64091 | 182 | const char *protocol_name; |
83f64091 | 183 | int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset); |
b94a2610 | 184 | |
83f64091 | 185 | int64_t (*bdrv_getlength)(BlockDriverState *bs); |
b94a2610 | 186 | bool has_variable_length; |
4a1d5e1f | 187 | int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs); |
b94a2610 | 188 | |
5fafdf24 | 189 | int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num, |
faea38e7 FB |
190 | const uint8_t *buf, int nb_sectors); |
191 | ||
5fafdf24 | 192 | int (*bdrv_snapshot_create)(BlockDriverState *bs, |
faea38e7 | 193 | QEMUSnapshotInfo *sn_info); |
5fafdf24 | 194 | int (*bdrv_snapshot_goto)(BlockDriverState *bs, |
faea38e7 | 195 | const char *snapshot_id); |
a89d89d3 WX |
196 | int (*bdrv_snapshot_delete)(BlockDriverState *bs, |
197 | const char *snapshot_id, | |
198 | const char *name, | |
199 | Error **errp); | |
5fafdf24 | 200 | int (*bdrv_snapshot_list)(BlockDriverState *bs, |
faea38e7 | 201 | QEMUSnapshotInfo **psn_info); |
51ef6727 | 202 | int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs, |
7b4c4781 WX |
203 | const char *snapshot_id, |
204 | const char *name, | |
205 | Error **errp); | |
faea38e7 | 206 | int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi); |
eae041fe | 207 | ImageInfoSpecific *(*bdrv_get_specific_info)(BlockDriverState *bs); |
83f64091 | 208 | |
cf8074b3 KW |
209 | int (*bdrv_save_vmstate)(BlockDriverState *bs, QEMUIOVector *qiov, |
210 | int64_t pos); | |
45566e9c CH |
211 | int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf, |
212 | int64_t pos, int size); | |
178e08a5 | 213 | |
756e6736 KW |
214 | int (*bdrv_change_backing_file)(BlockDriverState *bs, |
215 | const char *backing_file, const char *backing_fmt); | |
216 | ||
19cb3738 FB |
217 | /* removable device specific */ |
218 | int (*bdrv_is_inserted)(BlockDriverState *bs); | |
219 | int (*bdrv_media_changed)(BlockDriverState *bs); | |
f36f3949 | 220 | void (*bdrv_eject)(BlockDriverState *bs, bool eject_flag); |
025e849a | 221 | void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked); |
3b46e624 | 222 | |
985a03b0 TS |
223 | /* to control generic scsi devices */ |
224 | int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf); | |
7c84b1b8 | 225 | BlockAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs, |
221f715d | 226 | unsigned long int req, void *buf, |
097310b5 | 227 | BlockCompletionFunc *cb, void *opaque); |
985a03b0 | 228 | |
0e7e1989 | 229 | /* List of options for creating images, terminated by name == NULL */ |
83d0521a | 230 | QemuOptsList *create_opts; |
5eb45639 | 231 | |
9ac228e0 KW |
232 | /* |
233 | * Returns 0 for completed check, -errno for internal errors. | |
234 | * The check results are stored in result. | |
235 | */ | |
4534ff54 KW |
236 | int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result, |
237 | BdrvCheckMode fix); | |
e97fc193 | 238 | |
77485434 HR |
239 | int (*bdrv_amend_options)(BlockDriverState *bs, QemuOpts *opts, |
240 | BlockDriverAmendStatusCB *status_cb); | |
6f176b48 | 241 | |
8b9b0cc2 KW |
242 | void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event); |
243 | ||
41c695c7 KW |
244 | /* TODO Better pass a option string/QDict/QemuOpts to add any rule? */ |
245 | int (*bdrv_debug_breakpoint)(BlockDriverState *bs, const char *event, | |
246 | const char *tag); | |
4cc70e93 FZ |
247 | int (*bdrv_debug_remove_breakpoint)(BlockDriverState *bs, |
248 | const char *tag); | |
41c695c7 KW |
249 | int (*bdrv_debug_resume)(BlockDriverState *bs, const char *tag); |
250 | bool (*bdrv_debug_is_suspended)(BlockDriverState *bs, const char *tag); | |
251 | ||
3baca891 | 252 | void (*bdrv_refresh_limits)(BlockDriverState *bs, Error **errp); |
d34682cd | 253 | |
336c1c12 KW |
254 | /* |
255 | * Returns 1 if newly created images are guaranteed to contain only | |
256 | * zeros, 0 otherwise. | |
257 | */ | |
258 | int (*bdrv_has_zero_init)(BlockDriverState *bs); | |
12c09b8c | 259 | |
dcd04228 SH |
260 | /* Remove fd handlers, timers, and other event loop callbacks so the event |
261 | * loop is no longer in use. Called with no in-flight requests and in | |
262 | * depth-first traversal order with parents before child nodes. | |
263 | */ | |
264 | void (*bdrv_detach_aio_context)(BlockDriverState *bs); | |
265 | ||
266 | /* Add fd handlers, timers, and other event loop callbacks so I/O requests | |
267 | * can be processed again. Called with no in-flight requests and in | |
268 | * depth-first traversal order with child nodes before parent nodes. | |
269 | */ | |
270 | void (*bdrv_attach_aio_context)(BlockDriverState *bs, | |
271 | AioContext *new_context); | |
272 | ||
448ad91d ML |
273 | /* io queue for linux-aio */ |
274 | void (*bdrv_io_plug)(BlockDriverState *bs); | |
275 | void (*bdrv_io_unplug)(BlockDriverState *bs); | |
276 | void (*bdrv_flush_io_queue)(BlockDriverState *bs); | |
277 | ||
892b7de8 ET |
278 | /** |
279 | * Try to get @bs's logical and physical block size. | |
280 | * On success, store them in @bsz and return zero. | |
281 | * On failure, return negative errno. | |
282 | */ | |
283 | int (*bdrv_probe_blocksizes)(BlockDriverState *bs, BlockSizes *bsz); | |
284 | /** | |
285 | * Try to get @bs's geometry (cyls, heads, sectors) | |
286 | * On success, store them in @geo and return 0. | |
287 | * On failure return -errno. | |
288 | * Only drivers that want to override guest geometry implement this | |
289 | * callback; see hd_geometry_guess(). | |
290 | */ | |
291 | int (*bdrv_probe_geometry)(BlockDriverState *bs, HDGeometry *geo); | |
292 | ||
8a22f02a | 293 | QLIST_ENTRY(BlockDriver) list; |
ea2384d3 FB |
294 | }; |
295 | ||
fe81c2cc PL |
296 | typedef struct BlockLimits { |
297 | /* maximum number of sectors that can be discarded at once */ | |
298 | int max_discard; | |
299 | ||
300 | /* optimal alignment for discard requests in sectors */ | |
301 | int64_t discard_alignment; | |
302 | ||
303 | /* maximum number of sectors that can zeroized at once */ | |
304 | int max_write_zeroes; | |
305 | ||
306 | /* optimal alignment for write zeroes requests in sectors */ | |
307 | int64_t write_zeroes_alignment; | |
7337acaf PL |
308 | |
309 | /* optimal transfer length in sectors */ | |
310 | int opt_transfer_length; | |
339064d5 | 311 | |
2647fab5 PL |
312 | /* maximal transfer length in sectors */ |
313 | int max_transfer_length; | |
314 | ||
339064d5 | 315 | /* memory alignment so that no bounce buffer is needed */ |
4196d2f0 DL |
316 | size_t min_mem_alignment; |
317 | ||
318 | /* memory alignment for bounce buffer */ | |
339064d5 | 319 | size_t opt_mem_alignment; |
fe81c2cc PL |
320 | } BlockLimits; |
321 | ||
fbe40ff7 FZ |
322 | typedef struct BdrvOpBlocker BdrvOpBlocker; |
323 | ||
33384421 HR |
324 | typedef struct BdrvAioNotifier { |
325 | void (*attached_aio_context)(AioContext *new_context, void *opaque); | |
326 | void (*detach_aio_context)(void *opaque); | |
327 | ||
328 | void *opaque; | |
329 | ||
330 | QLIST_ENTRY(BdrvAioNotifier) list; | |
331 | } BdrvAioNotifier; | |
332 | ||
8802d1fd JC |
333 | /* |
334 | * Note: the function bdrv_append() copies and swaps contents of | |
335 | * BlockDriverStates, so if you add new fields to this struct, please | |
336 | * inspect bdrv_append() to determine if the new fields need to be | |
337 | * copied as well. | |
338 | */ | |
ea2384d3 | 339 | struct BlockDriverState { |
d15a771d FB |
340 | int64_t total_sectors; /* if we are reading a disk image, give its |
341 | size in sectors */ | |
ea2384d3 | 342 | int read_only; /* if true, the media is read only */ |
4dca4b63 | 343 | int open_flags; /* flags used to open the file, re-used for re-open */ |
ea2384d3 | 344 | int encrypted; /* if true, the media is encrypted */ |
c0f4ce77 | 345 | int valid_key; /* if true, a valid encryption key has been set */ |
985a03b0 | 346 | int sg; /* if true, the device is a /dev/sg* */ |
53fec9d3 SH |
347 | int copy_on_read; /* if true, copy read backing sectors into image |
348 | note this is a reference count */ | |
38f3ef57 | 349 | bool probed; |
ea2384d3 | 350 | |
19cb3738 | 351 | BlockDriver *drv; /* NULL means no media */ |
ea2384d3 FB |
352 | void *opaque; |
353 | ||
7e7d56d9 MA |
354 | BlockBackend *blk; /* owning backend, if any */ |
355 | ||
dcd04228 | 356 | AioContext *aio_context; /* event loop used for fd handlers, timers, etc */ |
33384421 HR |
357 | /* long-running tasks intended to always use the same AioContext as this |
358 | * BDS may register themselves in this list to be notified of changes | |
359 | * regarding this BDS's context */ | |
360 | QLIST_HEAD(, BdrvAioNotifier) aio_notifiers; | |
dcd04228 | 361 | |
9a29e18f JC |
362 | char filename[PATH_MAX]; |
363 | char backing_file[PATH_MAX]; /* if non zero, the image is a diff of | |
364 | this file image */ | |
5eb45639 | 365 | char backing_format[16]; /* if non-zero and backing_file exists */ |
19cb3738 | 366 | |
91af7014 | 367 | QDict *full_open_options; |
9a29e18f | 368 | char exact_filename[PATH_MAX]; |
91af7014 | 369 | |
ea2384d3 | 370 | BlockDriverState *backing_hd; |
66f82cee KW |
371 | BlockDriverState *file; |
372 | ||
d7d512f6 PB |
373 | NotifierList close_notifiers; |
374 | ||
d616b224 SH |
375 | /* Callback before write request is processed */ |
376 | NotifierWithReturnList before_write_notifiers; | |
377 | ||
2dbafdc0 KW |
378 | /* number of in-flight serialising requests */ |
379 | unsigned int serialising_in_flight; | |
470c0504 | 380 | |
cc0681c4 | 381 | /* I/O throttling */ |
cc0681c4 | 382 | CoQueue throttled_reqs[2]; |
0563e191 | 383 | bool io_limits_enabled; |
76f4afb4 AG |
384 | /* The following fields are protected by the ThrottleGroup lock. |
385 | * See the ThrottleGroup documentation for details. */ | |
386 | ThrottleState *throttle_state; | |
387 | ThrottleTimers throttle_timers; | |
388 | unsigned pending_reqs[2]; | |
2ff1f2e3 | 389 | QLIST_ENTRY(BlockDriverState) round_robin; |
0563e191 | 390 | |
a36e69dd | 391 | /* I/O stats (display with "info blockstats"). */ |
0ddd0ad9 | 392 | BlockAcctStats stats; |
a36e69dd | 393 | |
fe81c2cc PL |
394 | /* I/O Limits */ |
395 | BlockLimits bl; | |
396 | ||
0d51b4de AH |
397 | /* Whether produces zeros when read beyond eof */ |
398 | bool zero_beyond_eof; | |
399 | ||
c25f53b0 PB |
400 | /* Alignment requirement for offset/length of I/O requests */ |
401 | unsigned int request_alignment; | |
402 | ||
1b7fd729 PB |
403 | /* the block size for which the guest device expects atomicity */ |
404 | int guest_block_size; | |
e268ca52 | 405 | |
e900a7b7 CH |
406 | /* do we need to tell the quest if we have a volatile write cache? */ |
407 | int enable_write_cache; | |
408 | ||
ea2384d3 FB |
409 | /* NOTE: the following infos are only hints for real hardware |
410 | drivers. They are not used by the block driver */ | |
ff06f5f3 | 411 | BlockdevOnError on_read_error, on_write_error; |
d6bf279e | 412 | bool iostatus_enabled; |
b2023818 | 413 | BlockDeviceIoStatus iostatus; |
dc364f4c BC |
414 | |
415 | /* the following member gives a name to every node on the bs graph. */ | |
416 | char node_name[32]; | |
417 | /* element of the list of named nodes building the graph */ | |
418 | QTAILQ_ENTRY(BlockDriverState) node_list; | |
dc364f4c BC |
419 | /* element of the list of "drives" the guest sees */ |
420 | QTAILQ_ENTRY(BlockDriverState) device_list; | |
e4654d2d | 421 | QLIST_HEAD(, BdrvDirtyBitmap) dirty_bitmaps; |
9fcb0251 | 422 | int refcnt; |
dbffbdcf SH |
423 | |
424 | QLIST_HEAD(, BdrvTrackedRequest) tracked_requests; | |
eeec61f2 | 425 | |
fbe40ff7 FZ |
426 | /* operation blockers */ |
427 | QLIST_HEAD(, BdrvOpBlocker) op_blockers[BLOCK_OP_TYPE_MAX]; | |
428 | ||
eeec61f2 SH |
429 | /* long-running background operation */ |
430 | BlockJob *job; | |
e971aa12 | 431 | |
de9c0cec | 432 | QDict *options; |
465bee1d | 433 | BlockdevDetectZeroesOptions detect_zeroes; |
826b6ca0 FZ |
434 | |
435 | /* The error object in use for blocking operations on backing_hd */ | |
436 | Error *backing_blocker; | |
e2462113 FR |
437 | |
438 | /* threshold limit for writes, in bytes. "High water mark". */ | |
439 | uint64_t write_threshold_offset; | |
440 | NotifierWithReturn write_threshold_notifier; | |
ea2384d3 FB |
441 | }; |
442 | ||
5f535a94 HR |
443 | |
444 | /* Essential block drivers which must always be statically linked into qemu, and | |
445 | * which therefore can be accessed without using bdrv_find_format() */ | |
446 | extern BlockDriver bdrv_file; | |
447 | extern BlockDriver bdrv_raw; | |
448 | extern BlockDriver bdrv_qcow2; | |
449 | ||
0eb7217e SH |
450 | /** |
451 | * bdrv_setup_io_funcs: | |
452 | * | |
453 | * Prepare a #BlockDriver for I/O request processing by populating | |
454 | * unimplemented coroutine and AIO interfaces with generic wrapper functions | |
455 | * that fall back to implemented interfaces. | |
456 | */ | |
457 | void bdrv_setup_io_funcs(BlockDriver *bdrv); | |
5f535a94 | 458 | |
eba25057 | 459 | int get_tmp_filename(char *filename, int size); |
38f3ef57 KW |
460 | BlockDriver *bdrv_probe_all(const uint8_t *buf, int buf_size, |
461 | const char *filename); | |
95389c86 | 462 | |
0563e191 | 463 | void bdrv_set_io_limits(BlockDriverState *bs, |
cc0681c4 BC |
464 | ThrottleConfig *cfg); |
465 | ||
0563e191 | 466 | |
d616b224 SH |
467 | /** |
468 | * bdrv_add_before_write_notifier: | |
469 | * | |
470 | * Register a callback that is invoked before write requests are processed but | |
471 | * after any throttling or waiting for overlapping requests. | |
472 | */ | |
473 | void bdrv_add_before_write_notifier(BlockDriverState *bs, | |
474 | NotifierWithReturn *notifier); | |
475 | ||
dcd04228 SH |
476 | /** |
477 | * bdrv_detach_aio_context: | |
478 | * | |
479 | * May be called from .bdrv_detach_aio_context() to detach children from the | |
480 | * current #AioContext. This is only needed by block drivers that manage their | |
481 | * own children. Both ->file and ->backing_hd are automatically handled and | |
482 | * block drivers should not call this function on them explicitly. | |
483 | */ | |
484 | void bdrv_detach_aio_context(BlockDriverState *bs); | |
485 | ||
486 | /** | |
487 | * bdrv_attach_aio_context: | |
488 | * | |
489 | * May be called from .bdrv_attach_aio_context() to attach children to the new | |
490 | * #AioContext. This is only needed by block drivers that manage their own | |
491 | * children. Both ->file and ->backing_hd are automatically handled and block | |
492 | * drivers should not call this function on them explicitly. | |
493 | */ | |
494 | void bdrv_attach_aio_context(BlockDriverState *bs, | |
495 | AioContext *new_context); | |
496 | ||
33384421 HR |
497 | /** |
498 | * bdrv_add_aio_context_notifier: | |
499 | * | |
500 | * If a long-running job intends to be always run in the same AioContext as a | |
501 | * certain BDS, it may use this function to be notified of changes regarding the | |
502 | * association of the BDS to an AioContext. | |
503 | * | |
504 | * attached_aio_context() is called after the target BDS has been attached to a | |
505 | * new AioContext; detach_aio_context() is called before the target BDS is being | |
506 | * detached from its old AioContext. | |
507 | */ | |
508 | void bdrv_add_aio_context_notifier(BlockDriverState *bs, | |
509 | void (*attached_aio_context)(AioContext *new_context, void *opaque), | |
510 | void (*detach_aio_context)(void *opaque), void *opaque); | |
511 | ||
512 | /** | |
513 | * bdrv_remove_aio_context_notifier: | |
514 | * | |
515 | * Unsubscribe of change notifications regarding the BDS's AioContext. The | |
516 | * parameters given here have to be the same as those given to | |
517 | * bdrv_add_aio_context_notifier(). | |
518 | */ | |
519 | void bdrv_remove_aio_context_notifier(BlockDriverState *bs, | |
520 | void (*aio_context_attached)(AioContext *, | |
521 | void *), | |
522 | void (*aio_context_detached)(void *), | |
523 | void *opaque); | |
524 | ||
508c7cb3 CH |
525 | #ifdef _WIN32 |
526 | int is_windows_drive(const char *filename); | |
527 | #endif | |
528 | ||
dc534f8f PB |
529 | /** |
530 | * stream_start: | |
531 | * @bs: Block device to operate on. | |
532 | * @base: Block device that will become the new base, or %NULL to | |
533 | * flatten the whole backing file chain onto @bs. | |
534 | * @base_id: The file name that will be written to @bs as the new | |
535 | * backing file if the job completes. Ignored if @base is %NULL. | |
c83c66c3 | 536 | * @speed: The maximum speed, in bytes per second, or 0 for unlimited. |
1d809098 | 537 | * @on_error: The action to take upon error. |
dc534f8f PB |
538 | * @cb: Completion function for the job. |
539 | * @opaque: Opaque pointer value passed to @cb. | |
fd7f8c65 | 540 | * @errp: Error object. |
dc534f8f PB |
541 | * |
542 | * Start a streaming operation on @bs. Clusters that are unallocated | |
543 | * in @bs, but allocated in any image between @base and @bs (both | |
544 | * exclusive) will be written to @bs. At the end of a successful | |
545 | * streaming job, the backing file of @bs will be changed to | |
546 | * @base_id in the written image and to @base in the live BlockDriverState. | |
547 | */ | |
fd7f8c65 | 548 | void stream_start(BlockDriverState *bs, BlockDriverState *base, |
1d809098 | 549 | const char *base_id, int64_t speed, BlockdevOnError on_error, |
097310b5 | 550 | BlockCompletionFunc *cb, |
fd7f8c65 | 551 | void *opaque, Error **errp); |
4f1043b4 | 552 | |
747ff602 JC |
553 | /** |
554 | * commit_start: | |
03544a6e FZ |
555 | * @bs: Active block device. |
556 | * @top: Top block device to be committed. | |
557 | * @base: Block device that will be written into, and become the new top. | |
747ff602 JC |
558 | * @speed: The maximum speed, in bytes per second, or 0 for unlimited. |
559 | * @on_error: The action to take upon error. | |
560 | * @cb: Completion function for the job. | |
561 | * @opaque: Opaque pointer value passed to @cb. | |
54e26900 | 562 | * @backing_file_str: String to use as the backing file in @top's overlay |
747ff602 JC |
563 | * @errp: Error object. |
564 | * | |
565 | */ | |
566 | void commit_start(BlockDriverState *bs, BlockDriverState *base, | |
567 | BlockDriverState *top, int64_t speed, | |
097310b5 | 568 | BlockdevOnError on_error, BlockCompletionFunc *cb, |
54e26900 | 569 | void *opaque, const char *backing_file_str, Error **errp); |
03544a6e FZ |
570 | /** |
571 | * commit_active_start: | |
572 | * @bs: Active block device to be committed. | |
573 | * @base: Block device that will be written into, and become the new top. | |
574 | * @speed: The maximum speed, in bytes per second, or 0 for unlimited. | |
575 | * @on_error: The action to take upon error. | |
576 | * @cb: Completion function for the job. | |
577 | * @opaque: Opaque pointer value passed to @cb. | |
578 | * @errp: Error object. | |
579 | * | |
580 | */ | |
581 | void commit_active_start(BlockDriverState *bs, BlockDriverState *base, | |
582 | int64_t speed, | |
583 | BlockdevOnError on_error, | |
097310b5 | 584 | BlockCompletionFunc *cb, |
03544a6e | 585 | void *opaque, Error **errp); |
893f7eba PB |
586 | /* |
587 | * mirror_start: | |
588 | * @bs: Block device to operate on. | |
589 | * @target: Block device to write to. | |
09158f00 BC |
590 | * @replaces: Block graph node name to replace once the mirror is done. Can |
591 | * only be used when full mirroring is selected. | |
893f7eba | 592 | * @speed: The maximum speed, in bytes per second, or 0 for unlimited. |
eee13dfe | 593 | * @granularity: The chosen granularity for the dirty bitmap. |
08e4ed6c | 594 | * @buf_size: The amount of data that can be in flight at one time. |
893f7eba | 595 | * @mode: Whether to collapse all images in the chain to the target. |
b952b558 PB |
596 | * @on_source_error: The action to take upon error reading from the source. |
597 | * @on_target_error: The action to take upon error writing to the target. | |
893f7eba PB |
598 | * @cb: Completion function for the job. |
599 | * @opaque: Opaque pointer value passed to @cb. | |
600 | * @errp: Error object. | |
601 | * | |
602 | * Start a mirroring operation on @bs. Clusters that are allocated | |
603 | * in @bs will be written to @bs until the job is cancelled or | |
604 | * manually completed. At the end of a successful mirroring job, | |
605 | * @bs will be switched to read from @target. | |
606 | */ | |
607 | void mirror_start(BlockDriverState *bs, BlockDriverState *target, | |
09158f00 | 608 | const char *replaces, |
5fba6c0e | 609 | int64_t speed, uint32_t granularity, int64_t buf_size, |
08e4ed6c | 610 | MirrorSyncMode mode, BlockdevOnError on_source_error, |
b952b558 | 611 | BlockdevOnError on_target_error, |
097310b5 | 612 | BlockCompletionFunc *cb, |
893f7eba PB |
613 | void *opaque, Error **errp); |
614 | ||
98d2c6f2 DM |
615 | /* |
616 | * backup_start: | |
617 | * @bs: Block device to operate on. | |
618 | * @target: Block device to write to. | |
619 | * @speed: The maximum speed, in bytes per second, or 0 for unlimited. | |
fc5d3f84 | 620 | * @sync_mode: What parts of the disk image should be copied to the destination. |
d58d8453 | 621 | * @sync_bitmap: The dirty bitmap if sync_mode is MIRROR_SYNC_MODE_DIRTY_BITMAP. |
98d2c6f2 DM |
622 | * @on_source_error: The action to take upon error reading from the source. |
623 | * @on_target_error: The action to take upon error writing to the target. | |
624 | * @cb: Completion function for the job. | |
625 | * @opaque: Opaque pointer value passed to @cb. | |
626 | * | |
627 | * Start a backup operation on @bs. Clusters in @bs are written to @target | |
628 | * until the job is cancelled or manually completed. | |
629 | */ | |
630 | void backup_start(BlockDriverState *bs, BlockDriverState *target, | |
fc5d3f84 | 631 | int64_t speed, MirrorSyncMode sync_mode, |
d58d8453 | 632 | BdrvDirtyBitmap *sync_bitmap, |
fc5d3f84 | 633 | BlockdevOnError on_source_error, |
98d2c6f2 | 634 | BlockdevOnError on_target_error, |
097310b5 | 635 | BlockCompletionFunc *cb, void *opaque, |
98d2c6f2 DM |
636 | Error **errp); |
637 | ||
a7f53e26 MA |
638 | void blk_dev_change_media_cb(BlockBackend *blk, bool load); |
639 | bool blk_dev_has_removable_media(BlockBackend *blk); | |
640 | void blk_dev_eject_request(BlockBackend *blk, bool force); | |
641 | bool blk_dev_is_tray_open(BlockBackend *blk); | |
642 | bool blk_dev_is_medium_locked(BlockBackend *blk); | |
643 | void blk_dev_resize_cb(BlockBackend *blk); | |
644 | ||
e0c47b6c SH |
645 | void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors); |
646 | void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, | |
647 | int nr_sectors); | |
648 | ||
ea2384d3 | 649 | #endif /* BLOCK_INT_H */ |