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