2 * QEMU System Emulator block driver
4 * Copyright (c) 2003 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
24 #ifndef BLOCK_INT_COMMON_H
25 #define BLOCK_INT_COMMON_H
27 #include "block/accounting.h"
28 #include "block/block.h"
29 #include "block/aio-wait.h"
30 #include "qemu/queue.h"
31 #include "qemu/coroutine.h"
32 #include "qemu/stats64.h"
33 #include "qemu/timer.h"
34 #include "qemu/hbitmap.h"
35 #include "block/snapshot.h"
36 #include "qemu/throttle.h"
39 #define BLOCK_FLAG_LAZY_REFCOUNTS 8
41 #define BLOCK_OPT_SIZE "size"
42 #define BLOCK_OPT_ENCRYPT "encryption"
43 #define BLOCK_OPT_ENCRYPT_FORMAT "encrypt.format"
44 #define BLOCK_OPT_COMPAT6 "compat6"
45 #define BLOCK_OPT_HWVERSION "hwversion"
46 #define BLOCK_OPT_BACKING_FILE "backing_file"
47 #define BLOCK_OPT_BACKING_FMT "backing_fmt"
48 #define BLOCK_OPT_CLUSTER_SIZE "cluster_size"
49 #define BLOCK_OPT_TABLE_SIZE "table_size"
50 #define BLOCK_OPT_PREALLOC "preallocation"
51 #define BLOCK_OPT_SUBFMT "subformat"
52 #define BLOCK_OPT_COMPAT_LEVEL "compat"
53 #define BLOCK_OPT_LAZY_REFCOUNTS "lazy_refcounts"
54 #define BLOCK_OPT_ADAPTER_TYPE "adapter_type"
55 #define BLOCK_OPT_REDUNDANCY "redundancy"
56 #define BLOCK_OPT_NOCOW "nocow"
57 #define BLOCK_OPT_EXTENT_SIZE_HINT "extent_size_hint"
58 #define BLOCK_OPT_OBJECT_SIZE "object_size"
59 #define BLOCK_OPT_REFCOUNT_BITS "refcount_bits"
60 #define BLOCK_OPT_DATA_FILE "data_file"
61 #define BLOCK_OPT_DATA_FILE_RAW "data_file_raw"
62 #define BLOCK_OPT_COMPRESSION_TYPE "compression_type"
63 #define BLOCK_OPT_EXTL2 "extended_l2"
65 #define BLOCK_PROBE_BUF_SIZE 512
67 enum BdrvTrackedRequestType
{
71 BDRV_TRACKED_TRUNCATE
,
75 * That is not quite good that BdrvTrackedRequest structure is public,
76 * as block/io.c is very careful about incoming offset/bytes being
77 * correct. Be sure to assert bdrv_check_request() succeeded after any
78 * modification of BdrvTrackedRequest object out of block/io.c
80 typedef struct BdrvTrackedRequest
{
84 enum BdrvTrackedRequestType type
;
87 int64_t overlap_offset
;
88 int64_t overlap_bytes
;
90 QLIST_ENTRY(BdrvTrackedRequest
) list
;
91 Coroutine
*co
; /* owner, used for deadlock detection */
92 CoQueue wait_queue
; /* coroutines blocked on this request */
94 struct BdrvTrackedRequest
*waiting_for
;
100 * These fields are initialized when this object is created,
101 * and are never changed afterwards.
104 const char *format_name
;
108 * Set to true if the BlockDriver is a block filter. Block filters pass
109 * certain callbacks that refer to data (see block.c) to their bs->file
110 * or bs->backing (whichever one exists) if the driver doesn't implement
111 * them. Drivers that do not wish to forward must implement them and return
113 * Note that filters are not allowed to modify data.
115 * Filters generally cannot have more than a single filtered child,
116 * because the data they present must at all times be the same as
117 * that on their filtered child. That would be impossible to
118 * achieve for multiple filtered children.
119 * (And this filtered child must then be bs->file or bs->backing.)
123 * Set to true if the BlockDriver is a format driver. Format nodes
124 * generally do not expect their children to be other format nodes
125 * (except for backing files), and so format probing is disabled
131 * Drivers not implementing bdrv_parse_filename nor bdrv_open should have
132 * this field set to true, except ones that are defined only by their
134 * An example of the last type will be the quorum block driver.
136 bool bdrv_needs_filename
;
139 * Set if a driver can support backing files. This also implies the
140 * following semantics:
142 * - Return status 0 of .bdrv_co_block_status means that corresponding
143 * blocks are not allocated in this layer of backing-chain
144 * - For such (unallocated) blocks, read will:
145 * - fill buffer with zeros if there is no backing file
146 * - read from the backing file otherwise, where the block layer
147 * takes care of reading zeros beyond EOF if backing file is short
149 bool supports_backing
;
151 bool has_variable_length
;
154 * Drivers setting this field must be able to work with just a plain
155 * filename with '<protocol_name>:' as a prefix, and no other options.
156 * Options may be extracted from the filename by implementing
157 * bdrv_parse_filename.
159 const char *protocol_name
;
161 /* List of options for creating images, terminated by name == NULL */
162 QemuOptsList
*create_opts
;
164 /* List of options for image amend */
165 QemuOptsList
*amend_opts
;
168 * If this driver supports reopening images this contains a
169 * NULL-terminated list of the runtime options that can be
170 * modified. If an option in this list is unspecified during
171 * reopen then it _must_ be reset to its default value or return
174 const char *const *mutable_opts
;
177 * Pointer to a NULL-terminated array of names of strong options
178 * that can be specified for bdrv_open(). A strong option is one
179 * that changes the data of a BDS.
180 * If this pointer is NULL, the array is considered empty.
181 * "filename" and "driver" are always considered strong.
183 const char *const *strong_runtime_opts
;
187 * Global state (GS) API. These functions run under the BQL.
189 * See include/block/block-global-state.h for more information about
194 * This function is invoked under BQL before .bdrv_co_amend()
195 * (which in contrast does not necessarily run under the BQL)
196 * to allow driver-specific initialization code that requires
197 * the BQL, like setting up specific permission flags.
199 int (*bdrv_amend_pre_run
)(BlockDriverState
*bs
, Error
**errp
);
201 * This function is invoked under BQL after .bdrv_co_amend()
202 * to allow cleaning up what was done in .bdrv_amend_pre_run().
204 void (*bdrv_amend_clean
)(BlockDriverState
*bs
);
207 * Return true if @to_replace can be replaced by a BDS with the
208 * same data as @bs without it affecting @bs's behavior (that is,
209 * without it being visible to @bs's parents).
211 bool (*bdrv_recurse_can_replace
)(BlockDriverState
*bs
,
212 BlockDriverState
*to_replace
);
214 int (*bdrv_probe_device
)(const char *filename
);
217 * Any driver implementing this callback is expected to be able to handle
218 * NULL file names in its .bdrv_open() implementation.
220 void (*bdrv_parse_filename
)(const char *filename
, QDict
*options
,
223 /* For handling image reopen for split or non-split files. */
224 int (*bdrv_reopen_prepare
)(BDRVReopenState
*reopen_state
,
225 BlockReopenQueue
*queue
, Error
**errp
);
226 void (*bdrv_reopen_commit
)(BDRVReopenState
*reopen_state
);
227 void (*bdrv_reopen_commit_post
)(BDRVReopenState
*reopen_state
);
228 void (*bdrv_reopen_abort
)(BDRVReopenState
*reopen_state
);
229 void (*bdrv_join_options
)(QDict
*options
, QDict
*old_options
);
231 int (*bdrv_open
)(BlockDriverState
*bs
, QDict
*options
, int flags
,
234 /* Protocol drivers should implement this instead of bdrv_open */
235 int (*bdrv_file_open
)(BlockDriverState
*bs
, QDict
*options
, int flags
,
237 void (*bdrv_close
)(BlockDriverState
*bs
);
239 int coroutine_fn (*bdrv_co_create
)(BlockdevCreateOptions
*opts
,
241 int coroutine_fn (*bdrv_co_create_opts
)(BlockDriver
*drv
,
242 const char *filename
,
246 int (*bdrv_amend_options
)(BlockDriverState
*bs
,
248 BlockDriverAmendStatusCB
*status_cb
,
253 int (*bdrv_make_empty
)(BlockDriverState
*bs
);
256 * Refreshes the bs->exact_filename field. If that is impossible,
257 * bs->exact_filename has to be left empty.
259 void (*bdrv_refresh_filename
)(BlockDriverState
*bs
);
262 * Gathers the open options for all children into @target.
263 * A simple format driver (without backing file support) might
264 * implement this function like this:
266 * QINCREF(bs->file->bs->full_open_options);
267 * qdict_put(target, "file", bs->file->bs->full_open_options);
269 * If not specified, the generic implementation will simply put
270 * all children's options under their respective name.
272 * @backing_overridden is true when bs->backing seems not to be
273 * the child that would result from opening bs->backing_file.
274 * Therefore, if it is true, the backing child's options should be
275 * gathered; otherwise, there is no need since the backing child
276 * is the one implied by the image header.
278 * Note that ideally this function would not be needed. Every
279 * block driver which implements it is probably doing something
280 * shady regarding its runtime option structure.
282 void (*bdrv_gather_child_options
)(BlockDriverState
*bs
, QDict
*target
,
283 bool backing_overridden
);
286 * Returns an allocated string which is the directory name of this BDS: It
287 * will be used to make relative filenames absolute by prepending this
288 * function's return value to them.
290 char *(*bdrv_dirname
)(BlockDriverState
*bs
, Error
**errp
);
293 * This informs the driver that we are no longer interested in the result
294 * of in-flight requests, so don't waste the time if possible.
296 * One example usage is to avoid waiting for an nbd target node reconnect
297 * timeout during job-cancel with force=true.
299 void (*bdrv_cancel_in_flight
)(BlockDriverState
*bs
);
301 int (*bdrv_inactivate
)(BlockDriverState
*bs
);
303 int (*bdrv_snapshot_create
)(BlockDriverState
*bs
,
304 QEMUSnapshotInfo
*sn_info
);
305 int (*bdrv_snapshot_goto
)(BlockDriverState
*bs
,
306 const char *snapshot_id
);
307 int (*bdrv_snapshot_delete
)(BlockDriverState
*bs
,
308 const char *snapshot_id
,
311 int (*bdrv_snapshot_list
)(BlockDriverState
*bs
,
312 QEMUSnapshotInfo
**psn_info
);
313 int (*bdrv_snapshot_load_tmp
)(BlockDriverState
*bs
,
314 const char *snapshot_id
,
318 int (*bdrv_change_backing_file
)(BlockDriverState
*bs
,
319 const char *backing_file
, const char *backing_fmt
);
321 /* TODO Better pass a option string/QDict/QemuOpts to add any rule? */
322 int (*bdrv_debug_breakpoint
)(BlockDriverState
*bs
, const char *event
,
324 int (*bdrv_debug_remove_breakpoint
)(BlockDriverState
*bs
,
326 int (*bdrv_debug_resume
)(BlockDriverState
*bs
, const char *tag
);
327 bool (*bdrv_debug_is_suspended
)(BlockDriverState
*bs
, const char *tag
);
329 void (*bdrv_refresh_limits
)(BlockDriverState
*bs
, Error
**errp
);
332 * Returns 1 if newly created images are guaranteed to contain only
333 * zeros, 0 otherwise.
335 int (*bdrv_has_zero_init
)(BlockDriverState
*bs
);
338 * Remove fd handlers, timers, and other event loop callbacks so the event
339 * loop is no longer in use. Called with no in-flight requests and in
340 * depth-first traversal order with parents before child nodes.
342 void (*bdrv_detach_aio_context
)(BlockDriverState
*bs
);
345 * Add fd handlers, timers, and other event loop callbacks so I/O requests
346 * can be processed again. Called with no in-flight requests and in
347 * depth-first traversal order with child nodes before parent nodes.
349 void (*bdrv_attach_aio_context
)(BlockDriverState
*bs
,
350 AioContext
*new_context
);
353 * Try to get @bs's logical and physical block size.
354 * On success, store them in @bsz and return zero.
355 * On failure, return negative errno.
357 int (*bdrv_probe_blocksizes
)(BlockDriverState
*bs
, BlockSizes
*bsz
);
359 * Try to get @bs's geometry (cyls, heads, sectors)
360 * On success, store them in @geo and return 0.
361 * On failure return -errno.
362 * Only drivers that want to override guest geometry implement this
363 * callback; see hd_geometry_guess().
365 int (*bdrv_probe_geometry
)(BlockDriverState
*bs
, HDGeometry
*geo
);
367 void (*bdrv_add_child
)(BlockDriverState
*parent
, BlockDriverState
*child
,
369 void (*bdrv_del_child
)(BlockDriverState
*parent
, BdrvChild
*child
,
373 * Informs the block driver that a permission change is intended. The
374 * driver checks whether the change is permissible and may take other
375 * preparations for the change (e.g. get file system locks). This operation
376 * is always followed either by a call to either .bdrv_set_perm or
377 * .bdrv_abort_perm_update.
379 * Checks whether the requested set of cumulative permissions in @perm
380 * can be granted for accessing @bs and whether no other users are using
381 * permissions other than those given in @shared (both arguments take
382 * BLK_PERM_* bitmasks).
384 * If both conditions are met, 0 is returned. Otherwise, -errno is returned
385 * and errp is set to an error describing the conflict.
387 int (*bdrv_check_perm
)(BlockDriverState
*bs
, uint64_t perm
,
388 uint64_t shared
, Error
**errp
);
391 * Called to inform the driver that the set of cumulative set of used
392 * permissions for @bs has changed to @perm, and the set of sharable
393 * permission to @shared. The driver can use this to propagate changes to
394 * its children (i.e. request permissions only if a parent actually needs
397 * This function is only invoked after bdrv_check_perm(), so block drivers
398 * may rely on preparations made in their .bdrv_check_perm implementation.
400 void (*bdrv_set_perm
)(BlockDriverState
*bs
, uint64_t perm
, uint64_t shared
);
403 * Called to inform the driver that after a previous bdrv_check_perm()
404 * call, the permission update is not performed and any preparations made
405 * for it (e.g. taken file locks) need to be undone.
407 * This function can be called even for nodes that never saw a
408 * bdrv_check_perm() call. It is a no-op then.
410 void (*bdrv_abort_perm_update
)(BlockDriverState
*bs
);
413 * Returns in @nperm and @nshared the permissions that the driver for @bs
414 * needs on its child @c, based on the cumulative permissions requested by
415 * the parents in @parent_perm and @parent_shared.
417 * If @c is NULL, return the permissions for attaching a new child for the
418 * given @child_class and @role.
420 * If @reopen_queue is non-NULL, don't return the currently needed
421 * permissions, but those that will be needed after applying the
424 void (*bdrv_child_perm
)(BlockDriverState
*bs
, BdrvChild
*c
,
426 BlockReopenQueue
*reopen_queue
,
427 uint64_t parent_perm
, uint64_t parent_shared
,
428 uint64_t *nperm
, uint64_t *nshared
);
431 * Register/unregister a buffer for I/O. For example, when the driver is
432 * interested to know the memory areas that will later be used in iovs, so
433 * that it can do IOMMU mapping with VFIO etc., in order to get better
434 * performance. In the case of VFIO drivers, this callback is used to do
435 * DMA mapping for hot buffers.
437 void (*bdrv_register_buf
)(BlockDriverState
*bs
, void *host
, size_t size
);
438 void (*bdrv_unregister_buf
)(BlockDriverState
*bs
, void *host
);
441 * This field is modified only under the BQL, and is part of
444 QLIST_ENTRY(BlockDriver
) list
;
447 * I/O API functions. These functions are thread-safe.
449 * See include/block/block-io.h for more information about
453 int (*bdrv_probe
)(const uint8_t *buf
, int buf_size
, const char *filename
);
455 int coroutine_fn (*bdrv_co_amend
)(BlockDriverState
*bs
,
456 BlockdevAmendOptions
*opts
,
461 BlockAIOCB
*(*bdrv_aio_preadv
)(BlockDriverState
*bs
,
462 int64_t offset
, int64_t bytes
, QEMUIOVector
*qiov
,
463 BdrvRequestFlags flags
, BlockCompletionFunc
*cb
, void *opaque
);
464 BlockAIOCB
*(*bdrv_aio_pwritev
)(BlockDriverState
*bs
,
465 int64_t offset
, int64_t bytes
, QEMUIOVector
*qiov
,
466 BdrvRequestFlags flags
, BlockCompletionFunc
*cb
, void *opaque
);
467 BlockAIOCB
*(*bdrv_aio_flush
)(BlockDriverState
*bs
,
468 BlockCompletionFunc
*cb
, void *opaque
);
469 BlockAIOCB
*(*bdrv_aio_pdiscard
)(BlockDriverState
*bs
,
470 int64_t offset
, int bytes
,
471 BlockCompletionFunc
*cb
, void *opaque
);
473 int coroutine_fn (*bdrv_co_readv
)(BlockDriverState
*bs
,
474 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
);
477 * @offset: position in bytes to read at
478 * @bytes: number of bytes to read
479 * @qiov: the buffers to fill with read data
480 * @flags: currently unused, always 0
482 * @offset and @bytes will be a multiple of 'request_alignment',
483 * but the length of individual @qiov elements does not have to
486 * @bytes will always equal the total size of @qiov, and will be
487 * no larger than 'max_transfer'.
489 * The buffer in @qiov may point directly to guest memory.
491 int coroutine_fn (*bdrv_co_preadv
)(BlockDriverState
*bs
,
492 int64_t offset
, int64_t bytes
, QEMUIOVector
*qiov
,
493 BdrvRequestFlags flags
);
495 int coroutine_fn (*bdrv_co_preadv_part
)(BlockDriverState
*bs
,
496 int64_t offset
, int64_t bytes
,
497 QEMUIOVector
*qiov
, size_t qiov_offset
,
498 BdrvRequestFlags flags
);
500 int coroutine_fn (*bdrv_co_writev
)(BlockDriverState
*bs
,
501 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
,
504 * @offset: position in bytes to write at
505 * @bytes: number of bytes to write
506 * @qiov: the buffers containing data to write
507 * @flags: zero or more bits allowed by 'supported_write_flags'
509 * @offset and @bytes will be a multiple of 'request_alignment',
510 * but the length of individual @qiov elements does not have to
513 * @bytes will always equal the total size of @qiov, and will be
514 * no larger than 'max_transfer'.
516 * The buffer in @qiov may point directly to guest memory.
518 int coroutine_fn (*bdrv_co_pwritev
)(BlockDriverState
*bs
,
519 int64_t offset
, int64_t bytes
, QEMUIOVector
*qiov
,
520 BdrvRequestFlags flags
);
521 int coroutine_fn (*bdrv_co_pwritev_part
)(BlockDriverState
*bs
,
522 int64_t offset
, int64_t bytes
, QEMUIOVector
*qiov
, size_t qiov_offset
,
523 BdrvRequestFlags flags
);
526 * Efficiently zero a region of the disk image. Typically an image format
527 * would use a compact metadata representation to implement this. This
528 * function pointer may be NULL or return -ENOSUP and .bdrv_co_writev()
529 * will be called instead.
531 int coroutine_fn (*bdrv_co_pwrite_zeroes
)(BlockDriverState
*bs
,
532 int64_t offset
, int64_t bytes
, BdrvRequestFlags flags
);
533 int coroutine_fn (*bdrv_co_pdiscard
)(BlockDriverState
*bs
,
534 int64_t offset
, int64_t bytes
);
537 * Map [offset, offset + nbytes) range onto a child of @bs to copy from,
538 * and invoke bdrv_co_copy_range_from(child, ...), or invoke
539 * bdrv_co_copy_range_to() if @bs is the leaf child to copy data from.
541 * See the comment of bdrv_co_copy_range for the parameter and return value
544 int coroutine_fn (*bdrv_co_copy_range_from
)(BlockDriverState
*bs
,
550 BdrvRequestFlags read_flags
,
551 BdrvRequestFlags write_flags
);
554 * Map [offset, offset + nbytes) range onto a child of bs to copy data to,
555 * and invoke bdrv_co_copy_range_to(child, src, ...), or perform the copy
556 * operation if @bs is the leaf and @src has the same BlockDriver. Return
557 * -ENOTSUP if @bs is the leaf but @src has a different BlockDriver.
559 * See the comment of bdrv_co_copy_range for the parameter and return value
562 int coroutine_fn (*bdrv_co_copy_range_to
)(BlockDriverState
*bs
,
568 BdrvRequestFlags read_flags
,
569 BdrvRequestFlags write_flags
);
572 * Building block for bdrv_block_status[_above] and
573 * bdrv_is_allocated[_above]. The driver should answer only
574 * according to the current layer, and should only need to set
575 * BDRV_BLOCK_DATA, BDRV_BLOCK_ZERO, BDRV_BLOCK_OFFSET_VALID,
576 * and/or BDRV_BLOCK_RAW; if the current layer defers to a backing
577 * layer, the result should be 0 (and not BDRV_BLOCK_ZERO). See
578 * block.h for the overall meaning of the bits. As a hint, the
579 * flag want_zero is true if the caller cares more about precise
580 * mappings (favor accurate _OFFSET_VALID/_ZERO) or false for
581 * overall allocation (favor larger *pnum, perhaps by reporting
582 * _DATA instead of _ZERO). The block layer guarantees input
583 * clamped to bdrv_getlength() and aligned to request_alignment,
584 * as well as non-NULL pnum, map, and file; in turn, the driver
585 * must return an error or set pnum to an aligned non-zero value.
587 * Note that @bytes is just a hint on how big of a region the
588 * caller wants to inspect. It is not a limit on *pnum.
589 * Implementations are free to return larger values of *pnum if
590 * doing so does not incur a performance penalty.
592 * block/io.c's bdrv_co_block_status() will utilize an unclamped
593 * *pnum value for the block-status cache on protocol nodes, prior
594 * to clamping *pnum for return to its caller.
596 int coroutine_fn (*bdrv_co_block_status
)(BlockDriverState
*bs
,
597 bool want_zero
, int64_t offset
, int64_t bytes
, int64_t *pnum
,
598 int64_t *map
, BlockDriverState
**file
);
601 * Invalidate any cached meta-data.
603 void coroutine_fn (*bdrv_co_invalidate_cache
)(BlockDriverState
*bs
,
607 * Flushes all data for all layers by calling bdrv_co_flush for underlying
608 * layers, if needed. This function is needed for deterministic
609 * synchronization of the flush finishing callback.
611 int coroutine_fn (*bdrv_co_flush
)(BlockDriverState
*bs
);
613 /* Delete a created file. */
614 int coroutine_fn (*bdrv_co_delete_file
)(BlockDriverState
*bs
,
618 * Flushes all data that was already written to the OS all the way down to
619 * the disk (for example file-posix.c calls fsync()).
621 int coroutine_fn (*bdrv_co_flush_to_disk
)(BlockDriverState
*bs
);
624 * Flushes all internal caches to the OS. The data may still sit in a
625 * writeback cache of the host OS, but it will survive a crash of the qemu
628 int coroutine_fn (*bdrv_co_flush_to_os
)(BlockDriverState
*bs
);
631 * Truncate @bs to @offset bytes using the given @prealloc mode
632 * when growing. Modes other than PREALLOC_MODE_OFF should be
633 * rejected when shrinking @bs.
635 * If @exact is true, @bs must be resized to exactly @offset.
636 * Otherwise, it is sufficient for @bs (if it is a host block
637 * device and thus there is no way to resize it) to be at least
638 * @offset bytes in length.
640 * If @exact is true and this function fails but would succeed
641 * with @exact = false, it should return -ENOTSUP.
643 int coroutine_fn (*bdrv_co_truncate
)(BlockDriverState
*bs
, int64_t offset
,
644 bool exact
, PreallocMode prealloc
,
645 BdrvRequestFlags flags
, Error
**errp
);
646 int64_t (*bdrv_getlength
)(BlockDriverState
*bs
);
647 int64_t (*bdrv_get_allocated_file_size
)(BlockDriverState
*bs
);
648 BlockMeasureInfo
*(*bdrv_measure
)(QemuOpts
*opts
, BlockDriverState
*in_bs
,
651 int coroutine_fn (*bdrv_co_pwritev_compressed
)(BlockDriverState
*bs
,
652 int64_t offset
, int64_t bytes
, QEMUIOVector
*qiov
);
653 int coroutine_fn (*bdrv_co_pwritev_compressed_part
)(BlockDriverState
*bs
,
654 int64_t offset
, int64_t bytes
, QEMUIOVector
*qiov
,
657 int (*bdrv_get_info
)(BlockDriverState
*bs
, BlockDriverInfo
*bdi
);
659 ImageInfoSpecific
*(*bdrv_get_specific_info
)(BlockDriverState
*bs
,
661 BlockStatsSpecific
*(*bdrv_get_specific_stats
)(BlockDriverState
*bs
);
663 int coroutine_fn (*bdrv_save_vmstate
)(BlockDriverState
*bs
,
666 int coroutine_fn (*bdrv_load_vmstate
)(BlockDriverState
*bs
,
670 /* removable device specific */
671 bool (*bdrv_is_inserted
)(BlockDriverState
*bs
);
672 void (*bdrv_eject
)(BlockDriverState
*bs
, bool eject_flag
);
673 void (*bdrv_lock_medium
)(BlockDriverState
*bs
, bool locked
);
675 /* to control generic scsi devices */
676 BlockAIOCB
*(*bdrv_aio_ioctl
)(BlockDriverState
*bs
,
677 unsigned long int req
, void *buf
,
678 BlockCompletionFunc
*cb
, void *opaque
);
679 int coroutine_fn (*bdrv_co_ioctl
)(BlockDriverState
*bs
,
680 unsigned long int req
, void *buf
);
683 * Returns 0 for completed check, -errno for internal errors.
684 * The check results are stored in result.
686 int coroutine_fn (*bdrv_co_check
)(BlockDriverState
*bs
,
687 BdrvCheckResult
*result
,
690 void (*bdrv_debug_event
)(BlockDriverState
*bs
, BlkdebugEvent event
);
692 /* io queue for linux-aio */
693 void (*bdrv_io_plug
)(BlockDriverState
*bs
);
694 void (*bdrv_io_unplug
)(BlockDriverState
*bs
);
697 * bdrv_co_drain_begin is called if implemented in the beginning of a
698 * drain operation to drain and stop any internal sources of requests in
700 * bdrv_co_drain_end is called if implemented at the end of the drain.
702 * They should be used by the driver to e.g. manage scheduled I/O
703 * requests, or toggle an internal state. After the end of the drain new
704 * requests will continue normally.
706 void coroutine_fn (*bdrv_co_drain_begin
)(BlockDriverState
*bs
);
707 void coroutine_fn (*bdrv_co_drain_end
)(BlockDriverState
*bs
);
709 bool (*bdrv_supports_persistent_dirty_bitmap
)(BlockDriverState
*bs
);
710 bool (*bdrv_co_can_store_new_dirty_bitmap
)(BlockDriverState
*bs
,
712 uint32_t granularity
,
714 int (*bdrv_co_remove_persistent_dirty_bitmap
)(BlockDriverState
*bs
,
719 static inline bool block_driver_can_compress(BlockDriver
*drv
)
721 return drv
->bdrv_co_pwritev_compressed
||
722 drv
->bdrv_co_pwritev_compressed_part
;
725 typedef struct BlockLimits
{
727 * Alignment requirement, in bytes, for offset/length of I/O
728 * requests. Must be a power of 2 less than INT_MAX; defaults to
729 * 1 for drivers with modern byte interfaces, and to 512
732 uint32_t request_alignment
;
735 * Maximum number of bytes that can be discarded at once. Must be multiple
736 * of pdiscard_alignment, but need not be power of 2. May be 0 if no
737 * inherent 64-bit limit.
739 int64_t max_pdiscard
;
742 * Optimal alignment for discard requests in bytes. A power of 2
743 * is best but not mandatory. Must be a multiple of
744 * bl.request_alignment, and must be less than max_pdiscard if
745 * that is set. May be 0 if bl.request_alignment is good enough
747 uint32_t pdiscard_alignment
;
750 * Maximum number of bytes that can zeroized at once. Must be multiple of
751 * pwrite_zeroes_alignment. 0 means no limit.
753 int64_t max_pwrite_zeroes
;
756 * Optimal alignment for write zeroes requests in bytes. A power
757 * of 2 is best but not mandatory. Must be a multiple of
758 * bl.request_alignment, and must be less than max_pwrite_zeroes
759 * if that is set. May be 0 if bl.request_alignment is good
762 uint32_t pwrite_zeroes_alignment
;
765 * Optimal transfer length in bytes. A power of 2 is best but not
766 * mandatory. Must be a multiple of bl.request_alignment, or 0 if
769 uint32_t opt_transfer
;
772 * Maximal transfer length in bytes. Need not be power of 2, but
773 * must be multiple of opt_transfer and bl.request_alignment, or 0
774 * for no 32-bit limit. For now, anything larger than INT_MAX is
777 uint32_t max_transfer
;
780 * Maximal hardware transfer length in bytes. Applies whenever
781 * transfers to the device bypass the kernel I/O scheduler, for
782 * example with SG_IO. If larger than max_transfer or if zero,
783 * blk_get_max_hw_transfer will fall back to max_transfer.
785 uint64_t max_hw_transfer
;
788 * Maximal number of scatter/gather elements allowed by the hardware.
789 * Applies whenever transfers to the device bypass the kernel I/O
790 * scheduler, for example with SG_IO. If larger than max_iov
791 * or if zero, blk_get_max_hw_iov will fall back to max_iov.
796 /* memory alignment, in bytes so that no bounce buffer is needed */
797 size_t min_mem_alignment
;
799 /* memory alignment, in bytes, for bounce buffer */
800 size_t opt_mem_alignment
;
802 /* maximum number of iovec elements */
806 typedef struct BdrvOpBlocker BdrvOpBlocker
;
808 typedef struct BdrvAioNotifier
{
809 void (*attached_aio_context
)(AioContext
*new_context
, void *opaque
);
810 void (*detach_aio_context
)(void *opaque
);
815 QLIST_ENTRY(BdrvAioNotifier
) list
;
818 struct BdrvChildClass
{
820 * If true, bdrv_replace_node() doesn't change the node this BdrvChild
826 * If true, the parent is a BlockDriverState and bdrv_next_all_states()
827 * will return it. This information is used for drain_all, where every node
828 * will be drained separately, so the drain only needs to be propagated to
834 * Global state (GS) API. These functions run under the BQL.
836 * See include/block/block-global-state.h for more information about
839 void (*inherit_options
)(BdrvChildRole role
, bool parent_is_format
,
840 int *child_flags
, QDict
*child_options
,
841 int parent_flags
, QDict
*parent_options
);
842 void (*change_media
)(BdrvChild
*child
, bool load
);
845 * Returns a malloced string that describes the parent of the child for a
846 * human reader. This could be a node-name, BlockBackend name, qdev ID or
847 * QOM path of the device owning the BlockBackend, job type and ID etc. The
848 * caller is responsible for freeing the memory.
850 char *(*get_parent_desc
)(BdrvChild
*child
);
853 * Notifies the parent that the child has been activated/inactivated (e.g.
854 * when migration is completing) and it can start/stop requesting
855 * permissions and doing I/O on it.
857 void (*activate
)(BdrvChild
*child
, Error
**errp
);
858 int (*inactivate
)(BdrvChild
*child
);
860 void (*attach
)(BdrvChild
*child
);
861 void (*detach
)(BdrvChild
*child
);
864 * Notifies the parent that the filename of its child has changed (e.g.
865 * because the direct child was removed from the backing chain), so that it
866 * can update its reference.
868 int (*update_filename
)(BdrvChild
*child
, BlockDriverState
*new_base
,
869 const char *filename
, Error
**errp
);
871 bool (*can_set_aio_ctx
)(BdrvChild
*child
, AioContext
*ctx
,
872 GSList
**ignore
, Error
**errp
);
873 void (*set_aio_ctx
)(BdrvChild
*child
, AioContext
*ctx
, GSList
**ignore
);
875 AioContext
*(*get_parent_aio_context
)(BdrvChild
*child
);
878 * I/O API functions. These functions are thread-safe.
880 * See include/block/block-io.h for more information about
884 void (*resize
)(BdrvChild
*child
);
887 * Returns a name that is supposedly more useful for human users than the
888 * node name for identifying the node in question (in particular, a BB
889 * name), or NULL if the parent can't provide a better name.
891 const char *(*get_name
)(BdrvChild
*child
);
894 * If this pair of functions is implemented, the parent doesn't issue new
895 * requests after returning from .drained_begin() until .drained_end() is
898 * These functions must not change the graph (and therefore also must not
899 * call aio_poll(), which could change the graph indirectly).
901 * If drained_end() schedules background operations, it must atomically
902 * increment *drained_end_counter for each such operation and atomically
903 * decrement it once the operation has settled.
905 * Note that this can be nested. If drained_begin() was called twice, new
906 * I/O is allowed only after drained_end() was called twice, too.
908 void (*drained_begin
)(BdrvChild
*child
);
909 void (*drained_end
)(BdrvChild
*child
, int *drained_end_counter
);
912 * Returns whether the parent has pending requests for the child. This
913 * callback is polled after .drained_begin() has been called until all
914 * activity on the child has stopped.
916 bool (*drained_poll
)(BdrvChild
*child
);
919 extern const BdrvChildClass child_of_bds
;
922 BlockDriverState
*bs
;
924 const BdrvChildClass
*klass
;
929 * Granted permissions for operating on this BdrvChild (BLK_PERM_* bitmask)
934 * Permissions that can still be granted to other users of @bs while this
935 * BdrvChild is still attached to it. (BLK_PERM_* bitmask)
937 uint64_t shared_perm
;
940 * This link is frozen: the child can neither be replaced nor
941 * detached from the parent.
946 * How many times the parent of this child has been drained
947 * (through klass->drained_*).
948 * Usually, this is equal to bs->quiesce_counter (potentially
949 * reduced by bdrv_drain_all_count). It may differ while the
950 * child is entering or leaving a drained section.
952 int parent_quiesce_counter
;
954 QLIST_ENTRY(BdrvChild
) next
;
955 QLIST_ENTRY(BdrvChild
) next_parent
;
959 * Allows bdrv_co_block_status() to cache one data region for a
962 * @valid: Whether the cache is valid (should be accessed with atomic
963 * functions so this can be reset by RCU readers)
964 * @data_start: Offset where we know (or strongly assume) is data
965 * @data_end: Offset where the data region ends (which is not necessarily
966 * the start of a zeroed region)
968 typedef struct BdrvBlockStatusCache
{
974 } BdrvBlockStatusCache
;
976 struct BlockDriverState
{
978 * Protected by big QEMU lock or read-only after opening. No special
979 * locking needed during I/O...
981 int open_flags
; /* flags used to open the file, re-used for re-open */
982 bool encrypted
; /* if true, the media is encrypted */
983 bool sg
; /* if true, the device is a /dev/sg* */
984 bool probed
; /* if true, format was probed rather than specified */
985 bool force_share
; /* if true, always allow all shared permissions */
986 bool implicit
; /* if true, this filter node was automatically inserted */
988 BlockDriver
*drv
; /* NULL means no media */
991 AioContext
*aio_context
; /* event loop used for fd handlers, timers, etc */
993 * long-running tasks intended to always use the same AioContext as this
994 * BDS may register themselves in this list to be notified of changes
995 * regarding this BDS's context
997 QLIST_HEAD(, BdrvAioNotifier
) aio_notifiers
;
998 bool walking_aio_notifiers
; /* to make removal during iteration safe */
1000 char filename
[PATH_MAX
];
1002 * If not empty, this image is a diff in relation to backing_file.
1003 * Note that this is the name given in the image header and
1004 * therefore may or may not be equal to .backing->bs->filename.
1005 * If this field contains a relative path, it is to be resolved
1006 * relatively to the overlay's location.
1008 char backing_file
[PATH_MAX
];
1010 * The backing filename indicated by the image header. Contrary
1011 * to backing_file, if we ever open this file, auto_backing_file
1012 * is replaced by the resulting BDS's filename (i.e. after a
1013 * bdrv_refresh_filename() run).
1015 char auto_backing_file
[PATH_MAX
];
1016 char backing_format
[16]; /* if non-zero and backing_file exists */
1018 QDict
*full_open_options
;
1019 char exact_filename
[PATH_MAX
];
1028 * Flags honored during pread
1030 unsigned int supported_read_flags
;
1032 * Flags honored during pwrite (so far: BDRV_REQ_FUA,
1033 * BDRV_REQ_WRITE_UNCHANGED).
1034 * If a driver does not support BDRV_REQ_WRITE_UNCHANGED, those
1035 * writes will be issued as normal writes without the flag set.
1036 * This is important to note for drivers that do not explicitly
1037 * request a WRITE permission for their children and instead take
1038 * the same permissions as their parent did (this is commonly what
1039 * block filters do). Such drivers have to be aware that the
1040 * parent may have taken a WRITE_UNCHANGED permission only and is
1041 * issuing such requests. Drivers either must make sure that
1042 * these requests do not result in plain WRITE accesses (usually
1043 * by supporting BDRV_REQ_WRITE_UNCHANGED, and then forwarding
1044 * every incoming write request as-is, including potentially that
1045 * flag), or they have to explicitly take the WRITE permission for
1048 unsigned int supported_write_flags
;
1050 * Flags honored during pwrite_zeroes (so far: BDRV_REQ_FUA,
1051 * BDRV_REQ_MAY_UNMAP, BDRV_REQ_WRITE_UNCHANGED)
1053 unsigned int supported_zero_flags
;
1055 * Flags honoured during truncate (so far: BDRV_REQ_ZERO_WRITE).
1057 * If BDRV_REQ_ZERO_WRITE is given, the truncate operation must make sure
1058 * that any added space reads as all zeros. If this can't be guaranteed,
1059 * the operation must fail.
1061 unsigned int supported_truncate_flags
;
1063 /* the following member gives a name to every node on the bs graph. */
1065 /* element of the list of named nodes building the graph */
1066 QTAILQ_ENTRY(BlockDriverState
) node_list
;
1067 /* element of the list of all BlockDriverStates (all_bdrv_states) */
1068 QTAILQ_ENTRY(BlockDriverState
) bs_list
;
1069 /* element of the list of monitor-owned BDS */
1070 QTAILQ_ENTRY(BlockDriverState
) monitor_list
;
1073 /* operation blockers. Protected by BQL. */
1074 QLIST_HEAD(, BdrvOpBlocker
) op_blockers
[BLOCK_OP_TYPE_MAX
];
1077 * The node that this node inherited default options from (and a reopen on
1078 * which can affect this node by changing these defaults). This is always a
1079 * parent node of this node.
1081 BlockDriverState
*inherits_from
;
1082 QLIST_HEAD(, BdrvChild
) children
;
1083 QLIST_HEAD(, BdrvChild
) parents
;
1086 QDict
*explicit_options
;
1087 BlockdevDetectZeroesOptions detect_zeroes
;
1089 /* The error object in use for blocking operations on backing_hd */
1090 Error
*backing_blocker
;
1092 /* Protected by AioContext lock */
1095 * If we are reading a disk image, give its size in sectors.
1096 * Generally read-only; it is written to by load_snapshot and
1097 * save_snaphost, but the block layer is quiescent during those.
1099 int64_t total_sectors
;
1101 /* threshold limit for writes, in bytes. "High water mark". */
1102 uint64_t write_threshold_offset
;
1105 * Writing to the list requires the BQL _and_ the dirty_bitmap_mutex.
1106 * Reading from the list can be done with either the BQL or the
1107 * dirty_bitmap_mutex. Modifying a bitmap only requires
1108 * dirty_bitmap_mutex.
1110 QemuMutex dirty_bitmap_mutex
;
1111 QLIST_HEAD(, BdrvDirtyBitmap
) dirty_bitmaps
;
1113 /* Offset after the highest byte written to */
1114 Stat64 wr_highest_offset
;
1117 * If true, copy read backing sectors into image. Can be >1 if more
1118 * than one client has requested copy-on-read. Accessed with atomic
1124 * number of in-flight requests; overall and serialising.
1125 * Accessed with atomic ops.
1127 unsigned int in_flight
;
1128 unsigned int serialising_in_flight
;
1131 * counter for nested bdrv_io_plug.
1132 * Accessed with atomic ops.
1134 unsigned io_plugged
;
1136 /* do we need to tell the quest if we have a volatile write cache? */
1137 int enable_write_cache
;
1139 /* Accessed with atomic ops. */
1140 int quiesce_counter
;
1141 int recursive_quiesce_counter
;
1143 unsigned int write_gen
; /* Current data generation */
1145 /* Protected by reqs_lock. */
1147 QLIST_HEAD(, BdrvTrackedRequest
) tracked_requests
;
1148 CoQueue flush_queue
; /* Serializing flush queue */
1149 bool active_flush_req
; /* Flush request in flight? */
1151 /* Only read/written by whoever has set active_flush_req to true. */
1152 unsigned int flushed_gen
; /* Flushed write generation */
1154 /* BdrvChild links to this node may never be frozen */
1157 /* Lock for block-status cache RCU writers */
1158 CoMutex bsc_modify_lock
;
1159 /* Always non-NULL, but must only be dereferenced under an RCU read guard */
1160 BdrvBlockStatusCache
*block_status_cache
;
1163 struct BlockBackendRootState
{
1165 BlockdevDetectZeroesOptions detect_zeroes
;
1168 typedef enum BlockMirrorBackingMode
{
1170 * Reuse the existing backing chain from the source for the target.
1171 * - sync=full: Set backing BDS to NULL.
1172 * - sync=top: Use source's backing BDS.
1173 * - sync=none: Use source as the backing BDS.
1175 MIRROR_SOURCE_BACKING_CHAIN
,
1177 /* Open the target's backing chain completely anew */
1178 MIRROR_OPEN_BACKING_CHAIN
,
1180 /* Do not change the target's backing BDS after job completion */
1181 MIRROR_LEAVE_BACKING_CHAIN
,
1182 } BlockMirrorBackingMode
;
1186 * Essential block drivers which must always be statically linked into qemu, and
1187 * which therefore can be accessed without using bdrv_find_format()
1189 extern BlockDriver bdrv_file
;
1190 extern BlockDriver bdrv_raw
;
1191 extern BlockDriver bdrv_qcow2
;
1193 extern unsigned int bdrv_drain_all_count
;
1194 extern QemuOptsList bdrv_create_opts_simple
;
1197 * Common functions that are neither I/O nor Global State.
1199 * See include/block/block-commmon.h for more information about
1203 static inline BlockDriverState
*child_bs(BdrvChild
*child
)
1205 return child
? child
->bs
: NULL
;
1208 int bdrv_check_request(int64_t offset
, int64_t bytes
, Error
**errp
);
1209 int get_tmp_filename(char *filename
, int size
);
1210 void bdrv_parse_filename_strip_prefix(const char *filename
, const char *prefix
,
1214 int bdrv_check_qiov_request(int64_t offset
, int64_t bytes
,
1215 QEMUIOVector
*qiov
, size_t qiov_offset
,
1219 int is_windows_drive(const char *filename
);
1222 #endif /* BLOCK_INT_COMMON_H */