1ebc2752bSEmanuele Giuseppe Esposito /*
2ebc2752bSEmanuele Giuseppe Esposito * QEMU System Emulator block driver
3ebc2752bSEmanuele Giuseppe Esposito *
4ebc2752bSEmanuele Giuseppe Esposito * Copyright (c) 2003 Fabrice Bellard
5ebc2752bSEmanuele Giuseppe Esposito *
6ebc2752bSEmanuele Giuseppe Esposito * Permission is hereby granted, free of charge, to any person obtaining a copy
7ebc2752bSEmanuele Giuseppe Esposito * of this software and associated documentation files (the "Software"), to deal
8ebc2752bSEmanuele Giuseppe Esposito * in the Software without restriction, including without limitation the rights
9ebc2752bSEmanuele Giuseppe Esposito * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10ebc2752bSEmanuele Giuseppe Esposito * copies of the Software, and to permit persons to whom the Software is
11ebc2752bSEmanuele Giuseppe Esposito * furnished to do so, subject to the following conditions:
12ebc2752bSEmanuele Giuseppe Esposito *
13ebc2752bSEmanuele Giuseppe Esposito * The above copyright notice and this permission notice shall be included in
14ebc2752bSEmanuele Giuseppe Esposito * all copies or substantial portions of the Software.
15ebc2752bSEmanuele Giuseppe Esposito *
16ebc2752bSEmanuele Giuseppe Esposito * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17ebc2752bSEmanuele Giuseppe Esposito * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18ebc2752bSEmanuele Giuseppe Esposito * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19ebc2752bSEmanuele Giuseppe Esposito * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20ebc2752bSEmanuele Giuseppe Esposito * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21ebc2752bSEmanuele Giuseppe Esposito * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22ebc2752bSEmanuele Giuseppe Esposito * THE SOFTWARE.
23ebc2752bSEmanuele Giuseppe Esposito */
24ebc2752bSEmanuele Giuseppe Esposito #ifndef BLOCK_INT_COMMON_H
25ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_INT_COMMON_H
26ebc2752bSEmanuele Giuseppe Esposito
27e2c1c34fSMarkus Armbruster #include "block/aio.h"
28e2c1c34fSMarkus Armbruster #include "block/block-common.h"
29e2c1c34fSMarkus Armbruster #include "block/block-global-state.h"
30ebc2752bSEmanuele Giuseppe Esposito #include "block/snapshot.h"
31e2c1c34fSMarkus Armbruster #include "qemu/iov.h"
32ebc2752bSEmanuele Giuseppe Esposito #include "qemu/rcu.h"
33e2c1c34fSMarkus Armbruster #include "qemu/stats64.h"
34ebc2752bSEmanuele Giuseppe Esposito
35ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_FLAG_LAZY_REFCOUNTS 8
36ebc2752bSEmanuele Giuseppe Esposito
37ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_SIZE "size"
38ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_ENCRYPT "encryption"
39ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_ENCRYPT_FORMAT "encrypt.format"
40ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_COMPAT6 "compat6"
41ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_HWVERSION "hwversion"
42ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_BACKING_FILE "backing_file"
43ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_BACKING_FMT "backing_fmt"
44ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_CLUSTER_SIZE "cluster_size"
45ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_TABLE_SIZE "table_size"
46ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_PREALLOC "preallocation"
47ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_SUBFMT "subformat"
48ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_COMPAT_LEVEL "compat"
49ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_LAZY_REFCOUNTS "lazy_refcounts"
50ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_ADAPTER_TYPE "adapter_type"
51ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_REDUNDANCY "redundancy"
52ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_NOCOW "nocow"
53ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_EXTENT_SIZE_HINT "extent_size_hint"
54ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_OBJECT_SIZE "object_size"
55ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_REFCOUNT_BITS "refcount_bits"
56ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_DATA_FILE "data_file"
57ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_DATA_FILE_RAW "data_file_raw"
58ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_COMPRESSION_TYPE "compression_type"
59ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_EXTL2 "extended_l2"
60ebc2752bSEmanuele Giuseppe Esposito
61ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_PROBE_BUF_SIZE 512
62ebc2752bSEmanuele Giuseppe Esposito
63ebc2752bSEmanuele Giuseppe Esposito enum BdrvTrackedRequestType {
64ebc2752bSEmanuele Giuseppe Esposito BDRV_TRACKED_READ,
65ebc2752bSEmanuele Giuseppe Esposito BDRV_TRACKED_WRITE,
66ebc2752bSEmanuele Giuseppe Esposito BDRV_TRACKED_DISCARD,
67ebc2752bSEmanuele Giuseppe Esposito BDRV_TRACKED_TRUNCATE,
68ebc2752bSEmanuele Giuseppe Esposito };
69ebc2752bSEmanuele Giuseppe Esposito
70ebc2752bSEmanuele Giuseppe Esposito /*
71ebc2752bSEmanuele Giuseppe Esposito * That is not quite good that BdrvTrackedRequest structure is public,
72ebc2752bSEmanuele Giuseppe Esposito * as block/io.c is very careful about incoming offset/bytes being
73ebc2752bSEmanuele Giuseppe Esposito * correct. Be sure to assert bdrv_check_request() succeeded after any
74ebc2752bSEmanuele Giuseppe Esposito * modification of BdrvTrackedRequest object out of block/io.c
75ebc2752bSEmanuele Giuseppe Esposito */
76ebc2752bSEmanuele Giuseppe Esposito typedef struct BdrvTrackedRequest {
77ebc2752bSEmanuele Giuseppe Esposito BlockDriverState *bs;
78ebc2752bSEmanuele Giuseppe Esposito int64_t offset;
79ebc2752bSEmanuele Giuseppe Esposito int64_t bytes;
80ebc2752bSEmanuele Giuseppe Esposito enum BdrvTrackedRequestType type;
81ebc2752bSEmanuele Giuseppe Esposito
82ebc2752bSEmanuele Giuseppe Esposito bool serialising;
83ebc2752bSEmanuele Giuseppe Esposito int64_t overlap_offset;
84ebc2752bSEmanuele Giuseppe Esposito int64_t overlap_bytes;
85ebc2752bSEmanuele Giuseppe Esposito
86ebc2752bSEmanuele Giuseppe Esposito QLIST_ENTRY(BdrvTrackedRequest) list;
87ebc2752bSEmanuele Giuseppe Esposito Coroutine *co; /* owner, used for deadlock detection */
88ebc2752bSEmanuele Giuseppe Esposito CoQueue wait_queue; /* coroutines blocked on this request */
89ebc2752bSEmanuele Giuseppe Esposito
90ebc2752bSEmanuele Giuseppe Esposito struct BdrvTrackedRequest *waiting_for;
91ebc2752bSEmanuele Giuseppe Esposito } BdrvTrackedRequest;
92ebc2752bSEmanuele Giuseppe Esposito
93ebc2752bSEmanuele Giuseppe Esposito
94ebc2752bSEmanuele Giuseppe Esposito struct BlockDriver {
9569c0bf11SEmanuele Giuseppe Esposito /*
9669c0bf11SEmanuele Giuseppe Esposito * These fields are initialized when this object is created,
9769c0bf11SEmanuele Giuseppe Esposito * and are never changed afterwards.
9869c0bf11SEmanuele Giuseppe Esposito */
9969c0bf11SEmanuele Giuseppe Esposito
100ebc2752bSEmanuele Giuseppe Esposito const char *format_name;
101ebc2752bSEmanuele Giuseppe Esposito int instance_size;
102ebc2752bSEmanuele Giuseppe Esposito
103ebc2752bSEmanuele Giuseppe Esposito /*
104ebc2752bSEmanuele Giuseppe Esposito * Set to true if the BlockDriver is a block filter. Block filters pass
105ebc2752bSEmanuele Giuseppe Esposito * certain callbacks that refer to data (see block.c) to their bs->file
106ebc2752bSEmanuele Giuseppe Esposito * or bs->backing (whichever one exists) if the driver doesn't implement
107ebc2752bSEmanuele Giuseppe Esposito * them. Drivers that do not wish to forward must implement them and return
108ebc2752bSEmanuele Giuseppe Esposito * -ENOTSUP.
109ebc2752bSEmanuele Giuseppe Esposito * Note that filters are not allowed to modify data.
110ebc2752bSEmanuele Giuseppe Esposito *
111ebc2752bSEmanuele Giuseppe Esposito * Filters generally cannot have more than a single filtered child,
112ebc2752bSEmanuele Giuseppe Esposito * because the data they present must at all times be the same as
113ebc2752bSEmanuele Giuseppe Esposito * that on their filtered child. That would be impossible to
114ebc2752bSEmanuele Giuseppe Esposito * achieve for multiple filtered children.
115ebc2752bSEmanuele Giuseppe Esposito * (And this filtered child must then be bs->file or bs->backing.)
116ebc2752bSEmanuele Giuseppe Esposito */
117ebc2752bSEmanuele Giuseppe Esposito bool is_filter;
118ebc2752bSEmanuele Giuseppe Esposito /*
119046fd84fSVladimir Sementsov-Ogievskiy * Only make sense for filter drivers, for others must be false.
120046fd84fSVladimir Sementsov-Ogievskiy * If true, filtered child is bs->backing. Otherwise it's bs->file.
1211921b4f7SVladimir Sementsov-Ogievskiy * Two internal filters use bs->backing as filtered child and has this
1221921b4f7SVladimir Sementsov-Ogievskiy * field set to true: mirror_top and commit_top. There also two such test
1231921b4f7SVladimir Sementsov-Ogievskiy * filters in tests/unit/test-bdrv-graph-mod.c.
124046fd84fSVladimir Sementsov-Ogievskiy *
125046fd84fSVladimir Sementsov-Ogievskiy * Never create any more such filters!
126046fd84fSVladimir Sementsov-Ogievskiy *
127046fd84fSVladimir Sementsov-Ogievskiy * TODO: imagine how to deprecate this behavior and make all filters work
128046fd84fSVladimir Sementsov-Ogievskiy * similarly using bs->file as filtered child.
129046fd84fSVladimir Sementsov-Ogievskiy */
130046fd84fSVladimir Sementsov-Ogievskiy bool filtered_child_is_backing;
131046fd84fSVladimir Sementsov-Ogievskiy
132046fd84fSVladimir Sementsov-Ogievskiy /*
133ebc2752bSEmanuele Giuseppe Esposito * Set to true if the BlockDriver is a format driver. Format nodes
134ebc2752bSEmanuele Giuseppe Esposito * generally do not expect their children to be other format nodes
135ebc2752bSEmanuele Giuseppe Esposito * (except for backing files), and so format probing is disabled
136ebc2752bSEmanuele Giuseppe Esposito * on those children.
137ebc2752bSEmanuele Giuseppe Esposito */
138ebc2752bSEmanuele Giuseppe Esposito bool is_format;
139ebc2752bSEmanuele Giuseppe Esposito
140ebc2752bSEmanuele Giuseppe Esposito /*
141774c726cSSam Li * Set to true if the BlockDriver supports zoned children.
142774c726cSSam Li */
143774c726cSSam Li bool supports_zoned_children;
144774c726cSSam Li
145774c726cSSam Li /*
146ebc2752bSEmanuele Giuseppe Esposito * Drivers not implementing bdrv_parse_filename nor bdrv_open should have
147ebc2752bSEmanuele Giuseppe Esposito * this field set to true, except ones that are defined only by their
148ebc2752bSEmanuele Giuseppe Esposito * child's bs.
149ebc2752bSEmanuele Giuseppe Esposito * An example of the last type will be the quorum block driver.
150ebc2752bSEmanuele Giuseppe Esposito */
151ebc2752bSEmanuele Giuseppe Esposito bool bdrv_needs_filename;
152ebc2752bSEmanuele Giuseppe Esposito
153ebc2752bSEmanuele Giuseppe Esposito /*
154ebc2752bSEmanuele Giuseppe Esposito * Set if a driver can support backing files. This also implies the
155ebc2752bSEmanuele Giuseppe Esposito * following semantics:
156ebc2752bSEmanuele Giuseppe Esposito *
157ebc2752bSEmanuele Giuseppe Esposito * - Return status 0 of .bdrv_co_block_status means that corresponding
158ebc2752bSEmanuele Giuseppe Esposito * blocks are not allocated in this layer of backing-chain
159ebc2752bSEmanuele Giuseppe Esposito * - For such (unallocated) blocks, read will:
160ebc2752bSEmanuele Giuseppe Esposito * - fill buffer with zeros if there is no backing file
161ebc2752bSEmanuele Giuseppe Esposito * - read from the backing file otherwise, where the block layer
162ebc2752bSEmanuele Giuseppe Esposito * takes care of reading zeros beyond EOF if backing file is short
163ebc2752bSEmanuele Giuseppe Esposito */
164ebc2752bSEmanuele Giuseppe Esposito bool supports_backing;
165ebc2752bSEmanuele Giuseppe Esposito
16669c0bf11SEmanuele Giuseppe Esposito /*
16769c0bf11SEmanuele Giuseppe Esposito * Drivers setting this field must be able to work with just a plain
16869c0bf11SEmanuele Giuseppe Esposito * filename with '<protocol_name>:' as a prefix, and no other options.
16969c0bf11SEmanuele Giuseppe Esposito * Options may be extracted from the filename by implementing
17069c0bf11SEmanuele Giuseppe Esposito * bdrv_parse_filename.
17169c0bf11SEmanuele Giuseppe Esposito */
17269c0bf11SEmanuele Giuseppe Esposito const char *protocol_name;
17369c0bf11SEmanuele Giuseppe Esposito
17469c0bf11SEmanuele Giuseppe Esposito /* List of options for creating images, terminated by name == NULL */
17569c0bf11SEmanuele Giuseppe Esposito QemuOptsList *create_opts;
17669c0bf11SEmanuele Giuseppe Esposito
17769c0bf11SEmanuele Giuseppe Esposito /* List of options for image amend */
17869c0bf11SEmanuele Giuseppe Esposito QemuOptsList *amend_opts;
17969c0bf11SEmanuele Giuseppe Esposito
18069c0bf11SEmanuele Giuseppe Esposito /*
18169c0bf11SEmanuele Giuseppe Esposito * If this driver supports reopening images this contains a
18269c0bf11SEmanuele Giuseppe Esposito * NULL-terminated list of the runtime options that can be
18369c0bf11SEmanuele Giuseppe Esposito * modified. If an option in this list is unspecified during
18469c0bf11SEmanuele Giuseppe Esposito * reopen then it _must_ be reset to its default value or return
18569c0bf11SEmanuele Giuseppe Esposito * an error.
18669c0bf11SEmanuele Giuseppe Esposito */
18769c0bf11SEmanuele Giuseppe Esposito const char *const *mutable_opts;
18869c0bf11SEmanuele Giuseppe Esposito
18969c0bf11SEmanuele Giuseppe Esposito /*
19069c0bf11SEmanuele Giuseppe Esposito * Pointer to a NULL-terminated array of names of strong options
19169c0bf11SEmanuele Giuseppe Esposito * that can be specified for bdrv_open(). A strong option is one
19269c0bf11SEmanuele Giuseppe Esposito * that changes the data of a BDS.
19369c0bf11SEmanuele Giuseppe Esposito * If this pointer is NULL, the array is considered empty.
19469c0bf11SEmanuele Giuseppe Esposito * "filename" and "driver" are always considered strong.
19569c0bf11SEmanuele Giuseppe Esposito */
19669c0bf11SEmanuele Giuseppe Esposito const char *const *strong_runtime_opts;
19769c0bf11SEmanuele Giuseppe Esposito
19869c0bf11SEmanuele Giuseppe Esposito
19969c0bf11SEmanuele Giuseppe Esposito /*
20069c0bf11SEmanuele Giuseppe Esposito * Global state (GS) API. These functions run under the BQL.
20169c0bf11SEmanuele Giuseppe Esposito *
20269c0bf11SEmanuele Giuseppe Esposito * See include/block/block-global-state.h for more information about
20369c0bf11SEmanuele Giuseppe Esposito * the GS API.
20469c0bf11SEmanuele Giuseppe Esposito */
20569c0bf11SEmanuele Giuseppe Esposito
20669c0bf11SEmanuele Giuseppe Esposito /*
20769c0bf11SEmanuele Giuseppe Esposito * This function is invoked under BQL before .bdrv_co_amend()
20869c0bf11SEmanuele Giuseppe Esposito * (which in contrast does not necessarily run under the BQL)
20969c0bf11SEmanuele Giuseppe Esposito * to allow driver-specific initialization code that requires
21069c0bf11SEmanuele Giuseppe Esposito * the BQL, like setting up specific permission flags.
21169c0bf11SEmanuele Giuseppe Esposito */
212840428a2SEmanuele Giuseppe Esposito int GRAPH_RDLOCK_PTR (*bdrv_amend_pre_run)(
213840428a2SEmanuele Giuseppe Esposito BlockDriverState *bs, Error **errp);
21469c0bf11SEmanuele Giuseppe Esposito /*
21569c0bf11SEmanuele Giuseppe Esposito * This function is invoked under BQL after .bdrv_co_amend()
21669c0bf11SEmanuele Giuseppe Esposito * to allow cleaning up what was done in .bdrv_amend_pre_run().
21769c0bf11SEmanuele Giuseppe Esposito */
218840428a2SEmanuele Giuseppe Esposito void GRAPH_RDLOCK_PTR (*bdrv_amend_clean)(BlockDriverState *bs);
21969c0bf11SEmanuele Giuseppe Esposito
22069c0bf11SEmanuele Giuseppe Esposito /*
22169c0bf11SEmanuele Giuseppe Esposito * Return true if @to_replace can be replaced by a BDS with the
22269c0bf11SEmanuele Giuseppe Esposito * same data as @bs without it affecting @bs's behavior (that is,
22369c0bf11SEmanuele Giuseppe Esposito * without it being visible to @bs's parents).
22469c0bf11SEmanuele Giuseppe Esposito */
225533c6e4eSKevin Wolf bool GRAPH_RDLOCK_PTR (*bdrv_recurse_can_replace)(
226533c6e4eSKevin Wolf BlockDriverState *bs, BlockDriverState *to_replace);
22769c0bf11SEmanuele Giuseppe Esposito
22869c0bf11SEmanuele Giuseppe Esposito int (*bdrv_probe_device)(const char *filename);
22969c0bf11SEmanuele Giuseppe Esposito
23069c0bf11SEmanuele Giuseppe Esposito /*
23169c0bf11SEmanuele Giuseppe Esposito * Any driver implementing this callback is expected to be able to handle
23269c0bf11SEmanuele Giuseppe Esposito * NULL file names in its .bdrv_open() implementation.
23369c0bf11SEmanuele Giuseppe Esposito */
23469c0bf11SEmanuele Giuseppe Esposito void (*bdrv_parse_filename)(const char *filename, QDict *options,
23569c0bf11SEmanuele Giuseppe Esposito Error **errp);
23669c0bf11SEmanuele Giuseppe Esposito
23769c0bf11SEmanuele Giuseppe Esposito /* For handling image reopen for split or non-split files. */
238ce433d29SKevin Wolf int GRAPH_UNLOCKED_PTR (*bdrv_reopen_prepare)(
239ce433d29SKevin Wolf BDRVReopenState *reopen_state, BlockReopenQueue *queue, Error **errp);
240ce433d29SKevin Wolf void GRAPH_UNLOCKED_PTR (*bdrv_reopen_commit)(
241ce433d29SKevin Wolf BDRVReopenState *reopen_state);
242ce433d29SKevin Wolf void GRAPH_UNLOCKED_PTR (*bdrv_reopen_commit_post)(
243ce433d29SKevin Wolf BDRVReopenState *reopen_state);
244ce433d29SKevin Wolf void GRAPH_UNLOCKED_PTR (*bdrv_reopen_abort)(
245ce433d29SKevin Wolf BDRVReopenState *reopen_state);
246ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_join_options)(QDict *options, QDict *old_options);
247ebc2752bSEmanuele Giuseppe Esposito
2481a30b0f5SKevin Wolf int GRAPH_UNLOCKED_PTR (*bdrv_open)(
2491a30b0f5SKevin Wolf BlockDriverState *bs, QDict *options, int flags, Error **errp);
250ebc2752bSEmanuele Giuseppe Esposito
251ebc2752bSEmanuele Giuseppe Esposito /* Protocol drivers should implement this instead of bdrv_open */
2521a30b0f5SKevin Wolf int GRAPH_UNLOCKED_PTR (*bdrv_file_open)(
2531a30b0f5SKevin Wolf BlockDriverState *bs, QDict *options, int flags, Error **errp);
254ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_close)(BlockDriverState *bs);
255ebc2752bSEmanuele Giuseppe Esposito
2564db7ba3bSKevin Wolf int coroutine_fn GRAPH_UNLOCKED_PTR (*bdrv_co_create)(
2574ec8df01SKevin Wolf BlockdevCreateOptions *opts, Error **errp);
2584ec8df01SKevin Wolf
2594db7ba3bSKevin Wolf int coroutine_fn GRAPH_UNLOCKED_PTR (*bdrv_co_create_opts)(
2604ec8df01SKevin Wolf BlockDriver *drv, const char *filename, QemuOpts *opts, Error **errp);
261ebc2752bSEmanuele Giuseppe Esposito
262bd131d67SKevin Wolf int GRAPH_RDLOCK_PTR (*bdrv_amend_options)(
263bd131d67SKevin Wolf BlockDriverState *bs, QemuOpts *opts,
264bd131d67SKevin Wolf BlockDriverAmendStatusCB *status_cb, void *cb_opaque,
265bd131d67SKevin Wolf bool force, Error **errp);
266ebc2752bSEmanuele Giuseppe Esposito
2670bb79c97SKevin Wolf int GRAPH_RDLOCK_PTR (*bdrv_make_empty)(BlockDriverState *bs);
268ebc2752bSEmanuele Giuseppe Esposito
269ebc2752bSEmanuele Giuseppe Esposito /*
270ebc2752bSEmanuele Giuseppe Esposito * Refreshes the bs->exact_filename field. If that is impossible,
271ebc2752bSEmanuele Giuseppe Esposito * bs->exact_filename has to be left empty.
272ebc2752bSEmanuele Giuseppe Esposito */
273b7cfc7d5SKevin Wolf void GRAPH_RDLOCK_PTR (*bdrv_refresh_filename)(BlockDriverState *bs);
274ebc2752bSEmanuele Giuseppe Esposito
275ebc2752bSEmanuele Giuseppe Esposito /*
276ebc2752bSEmanuele Giuseppe Esposito * Gathers the open options for all children into @target.
277ebc2752bSEmanuele Giuseppe Esposito * A simple format driver (without backing file support) might
278ebc2752bSEmanuele Giuseppe Esposito * implement this function like this:
279ebc2752bSEmanuele Giuseppe Esposito *
280ebc2752bSEmanuele Giuseppe Esposito * QINCREF(bs->file->bs->full_open_options);
281ebc2752bSEmanuele Giuseppe Esposito * qdict_put(target, "file", bs->file->bs->full_open_options);
282ebc2752bSEmanuele Giuseppe Esposito *
283ebc2752bSEmanuele Giuseppe Esposito * If not specified, the generic implementation will simply put
284ebc2752bSEmanuele Giuseppe Esposito * all children's options under their respective name.
285ebc2752bSEmanuele Giuseppe Esposito *
286ebc2752bSEmanuele Giuseppe Esposito * @backing_overridden is true when bs->backing seems not to be
287ebc2752bSEmanuele Giuseppe Esposito * the child that would result from opening bs->backing_file.
288ebc2752bSEmanuele Giuseppe Esposito * Therefore, if it is true, the backing child's options should be
289ebc2752bSEmanuele Giuseppe Esposito * gathered; otherwise, there is no need since the backing child
290ebc2752bSEmanuele Giuseppe Esposito * is the one implied by the image header.
291ebc2752bSEmanuele Giuseppe Esposito *
292ebc2752bSEmanuele Giuseppe Esposito * Note that ideally this function would not be needed. Every
293ebc2752bSEmanuele Giuseppe Esposito * block driver which implements it is probably doing something
294ebc2752bSEmanuele Giuseppe Esposito * shady regarding its runtime option structure.
295ebc2752bSEmanuele Giuseppe Esposito */
296b7cfc7d5SKevin Wolf void GRAPH_RDLOCK_PTR (*bdrv_gather_child_options)(
297b7cfc7d5SKevin Wolf BlockDriverState *bs, QDict *target, bool backing_overridden);
298ebc2752bSEmanuele Giuseppe Esposito
299ebc2752bSEmanuele Giuseppe Esposito /*
300ebc2752bSEmanuele Giuseppe Esposito * Returns an allocated string which is the directory name of this BDS: It
301ebc2752bSEmanuele Giuseppe Esposito * will be used to make relative filenames absolute by prepending this
302ebc2752bSEmanuele Giuseppe Esposito * function's return value to them.
303ebc2752bSEmanuele Giuseppe Esposito */
304b7cfc7d5SKevin Wolf char * GRAPH_RDLOCK_PTR (*bdrv_dirname)(BlockDriverState *bs, Error **errp);
305ebc2752bSEmanuele Giuseppe Esposito
30669c0bf11SEmanuele Giuseppe Esposito /*
30769c0bf11SEmanuele Giuseppe Esposito * This informs the driver that we are no longer interested in the result
30869c0bf11SEmanuele Giuseppe Esposito * of in-flight requests, so don't waste the time if possible.
30969c0bf11SEmanuele Giuseppe Esposito *
31069c0bf11SEmanuele Giuseppe Esposito * One example usage is to avoid waiting for an nbd target node reconnect
31169c0bf11SEmanuele Giuseppe Esposito * timeout during job-cancel with force=true.
31269c0bf11SEmanuele Giuseppe Esposito */
31379a55866SKevin Wolf void GRAPH_RDLOCK_PTR (*bdrv_cancel_in_flight)(BlockDriverState *bs);
31469c0bf11SEmanuele Giuseppe Esposito
3153804e3cfSKevin Wolf int GRAPH_RDLOCK_PTR (*bdrv_inactivate)(BlockDriverState *bs);
31669c0bf11SEmanuele Giuseppe Esposito
317a32e7818SKevin Wolf int GRAPH_RDLOCK_PTR (*bdrv_snapshot_create)(
318a32e7818SKevin Wolf BlockDriverState *bs, QEMUSnapshotInfo *sn_info);
319a32e7818SKevin Wolf
320a32e7818SKevin Wolf int GRAPH_UNLOCKED_PTR (*bdrv_snapshot_goto)(
321a32e7818SKevin Wolf BlockDriverState *bs, const char *snapshot_id);
322a32e7818SKevin Wolf
323a32e7818SKevin Wolf int GRAPH_RDLOCK_PTR (*bdrv_snapshot_delete)(
324a32e7818SKevin Wolf BlockDriverState *bs, const char *snapshot_id, const char *name,
32569c0bf11SEmanuele Giuseppe Esposito Error **errp);
326a32e7818SKevin Wolf
32779a55866SKevin Wolf int GRAPH_RDLOCK_PTR (*bdrv_snapshot_list)(
32879a55866SKevin Wolf BlockDriverState *bs, QEMUSnapshotInfo **psn_info);
32979a55866SKevin Wolf
33079a55866SKevin Wolf int GRAPH_RDLOCK_PTR (*bdrv_snapshot_load_tmp)(
33179a55866SKevin Wolf BlockDriverState *bs, const char *snapshot_id, const char *name,
33269c0bf11SEmanuele Giuseppe Esposito Error **errp);
33369c0bf11SEmanuele Giuseppe Esposito
334e2dd2737SKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_change_backing_file)(
335e2dd2737SKevin Wolf BlockDriverState *bs, const char *backing_file,
336e2dd2737SKevin Wolf const char *backing_fmt);
33769c0bf11SEmanuele Giuseppe Esposito
33869c0bf11SEmanuele Giuseppe Esposito /* TODO Better pass a option string/QDict/QemuOpts to add any rule? */
33969c0bf11SEmanuele Giuseppe Esposito int (*bdrv_debug_breakpoint)(BlockDriverState *bs, const char *event,
34069c0bf11SEmanuele Giuseppe Esposito const char *tag);
34169c0bf11SEmanuele Giuseppe Esposito int (*bdrv_debug_remove_breakpoint)(BlockDriverState *bs,
34269c0bf11SEmanuele Giuseppe Esposito const char *tag);
34369c0bf11SEmanuele Giuseppe Esposito int (*bdrv_debug_resume)(BlockDriverState *bs, const char *tag);
34469c0bf11SEmanuele Giuseppe Esposito bool (*bdrv_debug_is_suspended)(BlockDriverState *bs, const char *tag);
34569c0bf11SEmanuele Giuseppe Esposito
346e19b157fSKevin Wolf void GRAPH_RDLOCK_PTR (*bdrv_refresh_limits)(
347e19b157fSKevin Wolf BlockDriverState *bs, Error **errp);
34869c0bf11SEmanuele Giuseppe Esposito
34969c0bf11SEmanuele Giuseppe Esposito /*
35069c0bf11SEmanuele Giuseppe Esposito * Returns 1 if newly created images are guaranteed to contain only
35169c0bf11SEmanuele Giuseppe Esposito * zeros, 0 otherwise.
35269c0bf11SEmanuele Giuseppe Esposito */
35306717986SKevin Wolf int GRAPH_RDLOCK_PTR (*bdrv_has_zero_init)(BlockDriverState *bs);
35469c0bf11SEmanuele Giuseppe Esposito
35569c0bf11SEmanuele Giuseppe Esposito /*
35669c0bf11SEmanuele Giuseppe Esposito * Remove fd handlers, timers, and other event loop callbacks so the event
35769c0bf11SEmanuele Giuseppe Esposito * loop is no longer in use. Called with no in-flight requests and in
35869c0bf11SEmanuele Giuseppe Esposito * depth-first traversal order with parents before child nodes.
35969c0bf11SEmanuele Giuseppe Esposito */
36069c0bf11SEmanuele Giuseppe Esposito void (*bdrv_detach_aio_context)(BlockDriverState *bs);
36169c0bf11SEmanuele Giuseppe Esposito
36269c0bf11SEmanuele Giuseppe Esposito /*
36369c0bf11SEmanuele Giuseppe Esposito * Add fd handlers, timers, and other event loop callbacks so I/O requests
36469c0bf11SEmanuele Giuseppe Esposito * can be processed again. Called with no in-flight requests and in
36569c0bf11SEmanuele Giuseppe Esposito * depth-first traversal order with child nodes before parent nodes.
36669c0bf11SEmanuele Giuseppe Esposito */
36769c0bf11SEmanuele Giuseppe Esposito void (*bdrv_attach_aio_context)(BlockDriverState *bs,
36869c0bf11SEmanuele Giuseppe Esposito AioContext *new_context);
36969c0bf11SEmanuele Giuseppe Esposito
37069c0bf11SEmanuele Giuseppe Esposito /**
371ab613350SStefan Hajnoczi * bdrv_drain_begin is called if implemented in the beginning of a
372ab613350SStefan Hajnoczi * drain operation to drain and stop any internal sources of requests in
373ab613350SStefan Hajnoczi * the driver.
374ab613350SStefan Hajnoczi * bdrv_drain_end is called if implemented at the end of the drain.
375ab613350SStefan Hajnoczi *
376ab613350SStefan Hajnoczi * They should be used by the driver to e.g. manage scheduled I/O
377ab613350SStefan Hajnoczi * requests, or toggle an internal state. After the end of the drain new
378ab613350SStefan Hajnoczi * requests will continue normally.
379ab613350SStefan Hajnoczi *
380ab613350SStefan Hajnoczi * Implementations of both functions must not call aio_poll().
381ab613350SStefan Hajnoczi */
382ab613350SStefan Hajnoczi void (*bdrv_drain_begin)(BlockDriverState *bs);
383ab613350SStefan Hajnoczi void (*bdrv_drain_end)(BlockDriverState *bs);
384ab613350SStefan Hajnoczi
385ab613350SStefan Hajnoczi /**
38669c0bf11SEmanuele Giuseppe Esposito * Try to get @bs's logical and physical block size.
38769c0bf11SEmanuele Giuseppe Esposito * On success, store them in @bsz and return zero.
38869c0bf11SEmanuele Giuseppe Esposito * On failure, return negative errno.
38969c0bf11SEmanuele Giuseppe Esposito */
390221caadcSKevin Wolf int GRAPH_RDLOCK_PTR (*bdrv_probe_blocksizes)(
391221caadcSKevin Wolf BlockDriverState *bs, BlockSizes *bsz);
39269c0bf11SEmanuele Giuseppe Esposito /**
39369c0bf11SEmanuele Giuseppe Esposito * Try to get @bs's geometry (cyls, heads, sectors)
39469c0bf11SEmanuele Giuseppe Esposito * On success, store them in @geo and return 0.
39569c0bf11SEmanuele Giuseppe Esposito * On failure return -errno.
39669c0bf11SEmanuele Giuseppe Esposito * Only drivers that want to override guest geometry implement this
39769c0bf11SEmanuele Giuseppe Esposito * callback; see hd_geometry_guess().
39869c0bf11SEmanuele Giuseppe Esposito */
39979a55866SKevin Wolf int GRAPH_RDLOCK_PTR (*bdrv_probe_geometry)(
40079a55866SKevin Wolf BlockDriverState *bs, HDGeometry *geo);
40169c0bf11SEmanuele Giuseppe Esposito
4029def6082SKevin Wolf void GRAPH_WRLOCK_PTR (*bdrv_add_child)(
4039def6082SKevin Wolf BlockDriverState *parent, BlockDriverState *child, Error **errp);
4049def6082SKevin Wolf
4059def6082SKevin Wolf void GRAPH_WRLOCK_PTR (*bdrv_del_child)(
4069def6082SKevin Wolf BlockDriverState *parent, BdrvChild *child, Error **errp);
40769c0bf11SEmanuele Giuseppe Esposito
40869c0bf11SEmanuele Giuseppe Esposito /**
40969c0bf11SEmanuele Giuseppe Esposito * Informs the block driver that a permission change is intended. The
41069c0bf11SEmanuele Giuseppe Esposito * driver checks whether the change is permissible and may take other
41169c0bf11SEmanuele Giuseppe Esposito * preparations for the change (e.g. get file system locks). This operation
41269c0bf11SEmanuele Giuseppe Esposito * is always followed either by a call to either .bdrv_set_perm or
41369c0bf11SEmanuele Giuseppe Esposito * .bdrv_abort_perm_update.
41469c0bf11SEmanuele Giuseppe Esposito *
41569c0bf11SEmanuele Giuseppe Esposito * Checks whether the requested set of cumulative permissions in @perm
41669c0bf11SEmanuele Giuseppe Esposito * can be granted for accessing @bs and whether no other users are using
41769c0bf11SEmanuele Giuseppe Esposito * permissions other than those given in @shared (both arguments take
41869c0bf11SEmanuele Giuseppe Esposito * BLK_PERM_* bitmasks).
41969c0bf11SEmanuele Giuseppe Esposito *
42069c0bf11SEmanuele Giuseppe Esposito * If both conditions are met, 0 is returned. Otherwise, -errno is returned
42169c0bf11SEmanuele Giuseppe Esposito * and errp is set to an error describing the conflict.
42269c0bf11SEmanuele Giuseppe Esposito */
423bce73bc2SKevin Wolf int GRAPH_RDLOCK_PTR (*bdrv_check_perm)(BlockDriverState *bs, uint64_t perm,
42469c0bf11SEmanuele Giuseppe Esposito uint64_t shared, Error **errp);
42569c0bf11SEmanuele Giuseppe Esposito
42669c0bf11SEmanuele Giuseppe Esposito /**
42769c0bf11SEmanuele Giuseppe Esposito * Called to inform the driver that the set of cumulative set of used
428a1a62cedSMichael Tokarev * permissions for @bs has changed to @perm, and the set of shareable
42969c0bf11SEmanuele Giuseppe Esposito * permission to @shared. The driver can use this to propagate changes to
43069c0bf11SEmanuele Giuseppe Esposito * its children (i.e. request permissions only if a parent actually needs
43169c0bf11SEmanuele Giuseppe Esposito * them).
43269c0bf11SEmanuele Giuseppe Esposito *
43369c0bf11SEmanuele Giuseppe Esposito * This function is only invoked after bdrv_check_perm(), so block drivers
43469c0bf11SEmanuele Giuseppe Esposito * may rely on preparations made in their .bdrv_check_perm implementation.
43569c0bf11SEmanuele Giuseppe Esposito */
436bce73bc2SKevin Wolf void GRAPH_RDLOCK_PTR (*bdrv_set_perm)(
437bce73bc2SKevin Wolf BlockDriverState *bs, uint64_t perm, uint64_t shared);
43869c0bf11SEmanuele Giuseppe Esposito
43969c0bf11SEmanuele Giuseppe Esposito /*
44069c0bf11SEmanuele Giuseppe Esposito * Called to inform the driver that after a previous bdrv_check_perm()
44169c0bf11SEmanuele Giuseppe Esposito * call, the permission update is not performed and any preparations made
44269c0bf11SEmanuele Giuseppe Esposito * for it (e.g. taken file locks) need to be undone.
44369c0bf11SEmanuele Giuseppe Esposito *
44469c0bf11SEmanuele Giuseppe Esposito * This function can be called even for nodes that never saw a
44569c0bf11SEmanuele Giuseppe Esposito * bdrv_check_perm() call. It is a no-op then.
44669c0bf11SEmanuele Giuseppe Esposito */
447bce73bc2SKevin Wolf void GRAPH_RDLOCK_PTR (*bdrv_abort_perm_update)(BlockDriverState *bs);
44869c0bf11SEmanuele Giuseppe Esposito
44969c0bf11SEmanuele Giuseppe Esposito /**
45069c0bf11SEmanuele Giuseppe Esposito * Returns in @nperm and @nshared the permissions that the driver for @bs
45169c0bf11SEmanuele Giuseppe Esposito * needs on its child @c, based on the cumulative permissions requested by
45269c0bf11SEmanuele Giuseppe Esposito * the parents in @parent_perm and @parent_shared.
45369c0bf11SEmanuele Giuseppe Esposito *
45469c0bf11SEmanuele Giuseppe Esposito * If @c is NULL, return the permissions for attaching a new child for the
45569c0bf11SEmanuele Giuseppe Esposito * given @child_class and @role.
45669c0bf11SEmanuele Giuseppe Esposito *
45769c0bf11SEmanuele Giuseppe Esposito * If @reopen_queue is non-NULL, don't return the currently needed
45869c0bf11SEmanuele Giuseppe Esposito * permissions, but those that will be needed after applying the
45969c0bf11SEmanuele Giuseppe Esposito * @reopen_queue.
46069c0bf11SEmanuele Giuseppe Esposito */
461c629b6d2SKevin Wolf void GRAPH_RDLOCK_PTR (*bdrv_child_perm)(
462c629b6d2SKevin Wolf BlockDriverState *bs, BdrvChild *c, BdrvChildRole role,
46369c0bf11SEmanuele Giuseppe Esposito BlockReopenQueue *reopen_queue,
46469c0bf11SEmanuele Giuseppe Esposito uint64_t parent_perm, uint64_t parent_shared,
46569c0bf11SEmanuele Giuseppe Esposito uint64_t *nperm, uint64_t *nshared);
46669c0bf11SEmanuele Giuseppe Esposito
46769c0bf11SEmanuele Giuseppe Esposito /**
46869c0bf11SEmanuele Giuseppe Esposito * Register/unregister a buffer for I/O. For example, when the driver is
46969c0bf11SEmanuele Giuseppe Esposito * interested to know the memory areas that will later be used in iovs, so
47069c0bf11SEmanuele Giuseppe Esposito * that it can do IOMMU mapping with VFIO etc., in order to get better
47169c0bf11SEmanuele Giuseppe Esposito * performance. In the case of VFIO drivers, this callback is used to do
47269c0bf11SEmanuele Giuseppe Esposito * DMA mapping for hot buffers.
473f4ec04baSStefan Hajnoczi *
474f4ec04baSStefan Hajnoczi * Returns: true on success, false on failure
47569c0bf11SEmanuele Giuseppe Esposito */
476d9249c25SKevin Wolf bool GRAPH_RDLOCK_PTR (*bdrv_register_buf)(
477d9249c25SKevin Wolf BlockDriverState *bs, void *host, size_t size, Error **errp);
478d9249c25SKevin Wolf void GRAPH_RDLOCK_PTR (*bdrv_unregister_buf)(
479d9249c25SKevin Wolf BlockDriverState *bs, void *host, size_t size);
48069c0bf11SEmanuele Giuseppe Esposito
48169c0bf11SEmanuele Giuseppe Esposito /*
48269c0bf11SEmanuele Giuseppe Esposito * This field is modified only under the BQL, and is part of
48369c0bf11SEmanuele Giuseppe Esposito * the global state.
48469c0bf11SEmanuele Giuseppe Esposito */
48569c0bf11SEmanuele Giuseppe Esposito QLIST_ENTRY(BlockDriver) list;
48669c0bf11SEmanuele Giuseppe Esposito
48769c0bf11SEmanuele Giuseppe Esposito /*
48869c0bf11SEmanuele Giuseppe Esposito * I/O API functions. These functions are thread-safe.
48969c0bf11SEmanuele Giuseppe Esposito *
49069c0bf11SEmanuele Giuseppe Esposito * See include/block/block-io.h for more information about
49169c0bf11SEmanuele Giuseppe Esposito * the I/O API.
49269c0bf11SEmanuele Giuseppe Esposito */
49369c0bf11SEmanuele Giuseppe Esposito
49469c0bf11SEmanuele Giuseppe Esposito int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
49569c0bf11SEmanuele Giuseppe Esposito
496840428a2SEmanuele Giuseppe Esposito int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_amend)(
497840428a2SEmanuele Giuseppe Esposito BlockDriverState *bs, BlockdevAmendOptions *opts, bool force,
49869c0bf11SEmanuele Giuseppe Esposito Error **errp);
49969c0bf11SEmanuele Giuseppe Esposito
500ebc2752bSEmanuele Giuseppe Esposito /* aio */
5017b1fb72eSKevin Wolf BlockAIOCB * GRAPH_RDLOCK_PTR (*bdrv_aio_preadv)(BlockDriverState *bs,
502ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes, QEMUIOVector *qiov,
503ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags flags, BlockCompletionFunc *cb, void *opaque);
5047b1fb72eSKevin Wolf
5057b1fb72eSKevin Wolf BlockAIOCB * GRAPH_RDLOCK_PTR (*bdrv_aio_pwritev)(BlockDriverState *bs,
506ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes, QEMUIOVector *qiov,
507ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags flags, BlockCompletionFunc *cb, void *opaque);
5087b1fb72eSKevin Wolf
50988095349SEmanuele Giuseppe Esposito BlockAIOCB * GRAPH_RDLOCK_PTR (*bdrv_aio_flush)(
51088095349SEmanuele Giuseppe Esposito BlockDriverState *bs, BlockCompletionFunc *cb, void *opaque);
5119a5a1c62SEmanuele Giuseppe Esposito
5129a5a1c62SEmanuele Giuseppe Esposito BlockAIOCB * GRAPH_RDLOCK_PTR (*bdrv_aio_pdiscard)(
5139a5a1c62SEmanuele Giuseppe Esposito BlockDriverState *bs, int64_t offset, int bytes,
514ebc2752bSEmanuele Giuseppe Esposito BlockCompletionFunc *cb, void *opaque);
515ebc2752bSEmanuele Giuseppe Esposito
5167b1fb72eSKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_readv)(BlockDriverState *bs,
517ebc2752bSEmanuele Giuseppe Esposito int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
518ebc2752bSEmanuele Giuseppe Esposito
519ebc2752bSEmanuele Giuseppe Esposito /**
520ebc2752bSEmanuele Giuseppe Esposito * @offset: position in bytes to read at
521ebc2752bSEmanuele Giuseppe Esposito * @bytes: number of bytes to read
522ebc2752bSEmanuele Giuseppe Esposito * @qiov: the buffers to fill with read data
523ebc2752bSEmanuele Giuseppe Esposito * @flags: currently unused, always 0
524ebc2752bSEmanuele Giuseppe Esposito *
525ebc2752bSEmanuele Giuseppe Esposito * @offset and @bytes will be a multiple of 'request_alignment',
526ebc2752bSEmanuele Giuseppe Esposito * but the length of individual @qiov elements does not have to
527ebc2752bSEmanuele Giuseppe Esposito * be a multiple.
528ebc2752bSEmanuele Giuseppe Esposito *
529ebc2752bSEmanuele Giuseppe Esposito * @bytes will always equal the total size of @qiov, and will be
530ebc2752bSEmanuele Giuseppe Esposito * no larger than 'max_transfer'.
531ebc2752bSEmanuele Giuseppe Esposito *
532ebc2752bSEmanuele Giuseppe Esposito * The buffer in @qiov may point directly to guest memory.
533ebc2752bSEmanuele Giuseppe Esposito */
5347b1fb72eSKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_preadv)(BlockDriverState *bs,
535ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes, QEMUIOVector *qiov,
536ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags flags);
537ebc2752bSEmanuele Giuseppe Esposito
5387b1fb72eSKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_preadv_part)(
5397b1fb72eSKevin Wolf BlockDriverState *bs, int64_t offset, int64_t bytes,
540ebc2752bSEmanuele Giuseppe Esposito QEMUIOVector *qiov, size_t qiov_offset,
541ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags flags);
542ebc2752bSEmanuele Giuseppe Esposito
5437b1fb72eSKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_writev)(BlockDriverState *bs,
544ebc2752bSEmanuele Giuseppe Esposito int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
545ebc2752bSEmanuele Giuseppe Esposito int flags);
546ebc2752bSEmanuele Giuseppe Esposito /**
547ebc2752bSEmanuele Giuseppe Esposito * @offset: position in bytes to write at
548ebc2752bSEmanuele Giuseppe Esposito * @bytes: number of bytes to write
549ebc2752bSEmanuele Giuseppe Esposito * @qiov: the buffers containing data to write
550ebc2752bSEmanuele Giuseppe Esposito * @flags: zero or more bits allowed by 'supported_write_flags'
551ebc2752bSEmanuele Giuseppe Esposito *
552ebc2752bSEmanuele Giuseppe Esposito * @offset and @bytes will be a multiple of 'request_alignment',
553ebc2752bSEmanuele Giuseppe Esposito * but the length of individual @qiov elements does not have to
554ebc2752bSEmanuele Giuseppe Esposito * be a multiple.
555ebc2752bSEmanuele Giuseppe Esposito *
556ebc2752bSEmanuele Giuseppe Esposito * @bytes will always equal the total size of @qiov, and will be
557ebc2752bSEmanuele Giuseppe Esposito * no larger than 'max_transfer'.
558ebc2752bSEmanuele Giuseppe Esposito *
559ebc2752bSEmanuele Giuseppe Esposito * The buffer in @qiov may point directly to guest memory.
560ebc2752bSEmanuele Giuseppe Esposito */
5617b1fb72eSKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pwritev)(
5627b1fb72eSKevin Wolf BlockDriverState *bs, int64_t offset, int64_t bytes, QEMUIOVector *qiov,
563ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags flags);
5647b1fb72eSKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pwritev_part)(
5657b1fb72eSKevin Wolf BlockDriverState *bs, int64_t offset, int64_t bytes, QEMUIOVector *qiov,
5667b1fb72eSKevin Wolf size_t qiov_offset, BdrvRequestFlags flags);
567ebc2752bSEmanuele Giuseppe Esposito
568ebc2752bSEmanuele Giuseppe Esposito /*
569ebc2752bSEmanuele Giuseppe Esposito * Efficiently zero a region of the disk image. Typically an image format
570ebc2752bSEmanuele Giuseppe Esposito * would use a compact metadata representation to implement this. This
571ebc2752bSEmanuele Giuseppe Esposito * function pointer may be NULL or return -ENOSUP and .bdrv_co_writev()
572ebc2752bSEmanuele Giuseppe Esposito * will be called instead.
573ebc2752bSEmanuele Giuseppe Esposito */
574abaf8b75SKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pwrite_zeroes)(
575abaf8b75SKevin Wolf BlockDriverState *bs, int64_t offset, int64_t bytes,
576abaf8b75SKevin Wolf BdrvRequestFlags flags);
5779a5a1c62SEmanuele Giuseppe Esposito
5789a5a1c62SEmanuele Giuseppe Esposito int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pdiscard)(
5799a5a1c62SEmanuele Giuseppe Esposito BlockDriverState *bs, int64_t offset, int64_t bytes);
580ebc2752bSEmanuele Giuseppe Esposito
581ebc2752bSEmanuele Giuseppe Esposito /*
582ebc2752bSEmanuele Giuseppe Esposito * Map [offset, offset + nbytes) range onto a child of @bs to copy from,
583ebc2752bSEmanuele Giuseppe Esposito * and invoke bdrv_co_copy_range_from(child, ...), or invoke
584ebc2752bSEmanuele Giuseppe Esposito * bdrv_co_copy_range_to() if @bs is the leaf child to copy data from.
585ebc2752bSEmanuele Giuseppe Esposito *
586ebc2752bSEmanuele Giuseppe Esposito * See the comment of bdrv_co_copy_range for the parameter and return value
587ebc2752bSEmanuele Giuseppe Esposito * semantics.
588ebc2752bSEmanuele Giuseppe Esposito */
589742bf09bSEmanuele Giuseppe Esposito int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_copy_range_from)(
590742bf09bSEmanuele Giuseppe Esposito BlockDriverState *bs, BdrvChild *src, int64_t offset,
591742bf09bSEmanuele Giuseppe Esposito BdrvChild *dst, int64_t dst_offset, int64_t bytes,
592742bf09bSEmanuele Giuseppe Esposito BdrvRequestFlags read_flags, BdrvRequestFlags write_flags);
593ebc2752bSEmanuele Giuseppe Esposito
594ebc2752bSEmanuele Giuseppe Esposito /*
595ebc2752bSEmanuele Giuseppe Esposito * Map [offset, offset + nbytes) range onto a child of bs to copy data to,
596ebc2752bSEmanuele Giuseppe Esposito * and invoke bdrv_co_copy_range_to(child, src, ...), or perform the copy
597ebc2752bSEmanuele Giuseppe Esposito * operation if @bs is the leaf and @src has the same BlockDriver. Return
598ebc2752bSEmanuele Giuseppe Esposito * -ENOTSUP if @bs is the leaf but @src has a different BlockDriver.
599ebc2752bSEmanuele Giuseppe Esposito *
600ebc2752bSEmanuele Giuseppe Esposito * See the comment of bdrv_co_copy_range for the parameter and return value
601ebc2752bSEmanuele Giuseppe Esposito * semantics.
602ebc2752bSEmanuele Giuseppe Esposito */
603742bf09bSEmanuele Giuseppe Esposito int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_copy_range_to)(
604742bf09bSEmanuele Giuseppe Esposito BlockDriverState *bs, BdrvChild *src, int64_t src_offset,
605742bf09bSEmanuele Giuseppe Esposito BdrvChild *dst, int64_t dst_offset, int64_t bytes,
606742bf09bSEmanuele Giuseppe Esposito BdrvRequestFlags read_flags, BdrvRequestFlags write_flags);
607ebc2752bSEmanuele Giuseppe Esposito
608ebc2752bSEmanuele Giuseppe Esposito /*
609ebc2752bSEmanuele Giuseppe Esposito * Building block for bdrv_block_status[_above] and
610ebc2752bSEmanuele Giuseppe Esposito * bdrv_is_allocated[_above]. The driver should answer only
611ebc2752bSEmanuele Giuseppe Esposito * according to the current layer, and should only need to set
612ebc2752bSEmanuele Giuseppe Esposito * BDRV_BLOCK_DATA, BDRV_BLOCK_ZERO, BDRV_BLOCK_OFFSET_VALID,
613ebc2752bSEmanuele Giuseppe Esposito * and/or BDRV_BLOCK_RAW; if the current layer defers to a backing
614ebc2752bSEmanuele Giuseppe Esposito * layer, the result should be 0 (and not BDRV_BLOCK_ZERO). See
615ebc2752bSEmanuele Giuseppe Esposito * block.h for the overall meaning of the bits. As a hint, the
616ebc2752bSEmanuele Giuseppe Esposito * flag want_zero is true if the caller cares more about precise
617ebc2752bSEmanuele Giuseppe Esposito * mappings (favor accurate _OFFSET_VALID/_ZERO) or false for
618ebc2752bSEmanuele Giuseppe Esposito * overall allocation (favor larger *pnum, perhaps by reporting
619ebc2752bSEmanuele Giuseppe Esposito * _DATA instead of _ZERO). The block layer guarantees input
620ebc2752bSEmanuele Giuseppe Esposito * clamped to bdrv_getlength() and aligned to request_alignment,
621ebc2752bSEmanuele Giuseppe Esposito * as well as non-NULL pnum, map, and file; in turn, the driver
622ebc2752bSEmanuele Giuseppe Esposito * must return an error or set pnum to an aligned non-zero value.
623ebc2752bSEmanuele Giuseppe Esposito *
624ebc2752bSEmanuele Giuseppe Esposito * Note that @bytes is just a hint on how big of a region the
625ebc2752bSEmanuele Giuseppe Esposito * caller wants to inspect. It is not a limit on *pnum.
626ebc2752bSEmanuele Giuseppe Esposito * Implementations are free to return larger values of *pnum if
627ebc2752bSEmanuele Giuseppe Esposito * doing so does not incur a performance penalty.
628ebc2752bSEmanuele Giuseppe Esposito *
629ebc2752bSEmanuele Giuseppe Esposito * block/io.c's bdrv_co_block_status() will utilize an unclamped
630ebc2752bSEmanuele Giuseppe Esposito * *pnum value for the block-status cache on protocol nodes, prior
631ebc2752bSEmanuele Giuseppe Esposito * to clamping *pnum for return to its caller.
632ebc2752bSEmanuele Giuseppe Esposito */
6337ff9579eSKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_block_status)(
6347ff9579eSKevin Wolf BlockDriverState *bs,
635ebc2752bSEmanuele Giuseppe Esposito bool want_zero, int64_t offset, int64_t bytes, int64_t *pnum,
636ebc2752bSEmanuele Giuseppe Esposito int64_t *map, BlockDriverState **file);
637ebc2752bSEmanuele Giuseppe Esposito
638ebc2752bSEmanuele Giuseppe Esposito /*
639ce14f3b4SVladimir Sementsov-Ogievskiy * Snapshot-access API.
640ce14f3b4SVladimir Sementsov-Ogievskiy *
641ce14f3b4SVladimir Sementsov-Ogievskiy * Block-driver may provide snapshot-access API: special functions to access
642ce14f3b4SVladimir Sementsov-Ogievskiy * some internal "snapshot". The functions are similar with normal
643ce14f3b4SVladimir Sementsov-Ogievskiy * read/block_status/discard handler, but don't have any specific handling
644ce14f3b4SVladimir Sementsov-Ogievskiy * in generic block-layer: no serializing, no alignment, no tracked
645ce14f3b4SVladimir Sementsov-Ogievskiy * requests. So, block-driver that realizes these APIs is fully responsible
646ce14f3b4SVladimir Sementsov-Ogievskiy * for synchronization between snapshot-access API and normal IO requests.
6471c14eaabSVladimir Sementsov-Ogievskiy *
6481c14eaabSVladimir Sementsov-Ogievskiy * TODO: To be able to support qcow2's internal snapshots, this API will
6491c14eaabSVladimir Sementsov-Ogievskiy * need to be extended to:
6501c14eaabSVladimir Sementsov-Ogievskiy * - be able to select a specific snapshot
6511c14eaabSVladimir Sementsov-Ogievskiy * - receive the snapshot's actual length (which may differ from bs's
6521c14eaabSVladimir Sementsov-Ogievskiy * length)
653ce14f3b4SVladimir Sementsov-Ogievskiy */
6547b9e8b22SKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_preadv_snapshot)(
6557b9e8b22SKevin Wolf BlockDriverState *bs, int64_t offset, int64_t bytes,
6567b9e8b22SKevin Wolf QEMUIOVector *qiov, size_t qiov_offset);
6577b9e8b22SKevin Wolf
6587b9e8b22SKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_snapshot_block_status)(
6597b9e8b22SKevin Wolf BlockDriverState *bs, bool want_zero, int64_t offset, int64_t bytes,
6607b9e8b22SKevin Wolf int64_t *pnum, int64_t *map, BlockDriverState **file);
6619a5a1c62SEmanuele Giuseppe Esposito
6629a5a1c62SEmanuele Giuseppe Esposito int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pdiscard_snapshot)(
6639a5a1c62SEmanuele Giuseppe Esposito BlockDriverState *bs, int64_t offset, int64_t bytes);
664ce14f3b4SVladimir Sementsov-Ogievskiy
665ce14f3b4SVladimir Sementsov-Ogievskiy /*
666ebc2752bSEmanuele Giuseppe Esposito * Invalidate any cached meta-data.
667ebc2752bSEmanuele Giuseppe Esposito */
6681b3ff9feSKevin Wolf void coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_invalidate_cache)(
6691b3ff9feSKevin Wolf BlockDriverState *bs, Error **errp);
670ebc2752bSEmanuele Giuseppe Esposito
671ebc2752bSEmanuele Giuseppe Esposito /*
672ebc2752bSEmanuele Giuseppe Esposito * Flushes all data for all layers by calling bdrv_co_flush for underlying
673ebc2752bSEmanuele Giuseppe Esposito * layers, if needed. This function is needed for deterministic
674ebc2752bSEmanuele Giuseppe Esposito * synchronization of the flush finishing callback.
675ebc2752bSEmanuele Giuseppe Esposito */
67688095349SEmanuele Giuseppe Esposito int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_flush)(BlockDriverState *bs);
677ebc2752bSEmanuele Giuseppe Esposito
678ebc2752bSEmanuele Giuseppe Esposito /* Delete a created file. */
67948aef794SKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_delete_file)(
68048aef794SKevin Wolf BlockDriverState *bs, Error **errp);
681ebc2752bSEmanuele Giuseppe Esposito
682ebc2752bSEmanuele Giuseppe Esposito /*
683ebc2752bSEmanuele Giuseppe Esposito * Flushes all data that was already written to the OS all the way down to
684ebc2752bSEmanuele Giuseppe Esposito * the disk (for example file-posix.c calls fsync()).
685ebc2752bSEmanuele Giuseppe Esposito */
68688095349SEmanuele Giuseppe Esposito int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_flush_to_disk)(
68788095349SEmanuele Giuseppe Esposito BlockDriverState *bs);
688ebc2752bSEmanuele Giuseppe Esposito
689ebc2752bSEmanuele Giuseppe Esposito /*
690ebc2752bSEmanuele Giuseppe Esposito * Flushes all internal caches to the OS. The data may still sit in a
691ebc2752bSEmanuele Giuseppe Esposito * writeback cache of the host OS, but it will survive a crash of the qemu
692ebc2752bSEmanuele Giuseppe Esposito * process.
693ebc2752bSEmanuele Giuseppe Esposito */
69488095349SEmanuele Giuseppe Esposito int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_flush_to_os)(
69588095349SEmanuele Giuseppe Esposito BlockDriverState *bs);
696ebc2752bSEmanuele Giuseppe Esposito
697ebc2752bSEmanuele Giuseppe Esposito /*
698ebc2752bSEmanuele Giuseppe Esposito * Truncate @bs to @offset bytes using the given @prealloc mode
699ebc2752bSEmanuele Giuseppe Esposito * when growing. Modes other than PREALLOC_MODE_OFF should be
700ebc2752bSEmanuele Giuseppe Esposito * rejected when shrinking @bs.
701ebc2752bSEmanuele Giuseppe Esposito *
702ebc2752bSEmanuele Giuseppe Esposito * If @exact is true, @bs must be resized to exactly @offset.
703ebc2752bSEmanuele Giuseppe Esposito * Otherwise, it is sufficient for @bs (if it is a host block
704ebc2752bSEmanuele Giuseppe Esposito * device and thus there is no way to resize it) to be at least
705ebc2752bSEmanuele Giuseppe Esposito * @offset bytes in length.
706ebc2752bSEmanuele Giuseppe Esposito *
707ebc2752bSEmanuele Giuseppe Esposito * If @exact is true and this function fails but would succeed
708ebc2752bSEmanuele Giuseppe Esposito * with @exact = false, it should return -ENOTSUP.
709ebc2752bSEmanuele Giuseppe Esposito */
710c2b8e315SKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_truncate)(
711c2b8e315SKevin Wolf BlockDriverState *bs, int64_t offset, bool exact,
712c2b8e315SKevin Wolf PreallocMode prealloc, BdrvRequestFlags flags, Error **errp);
713c2b8e315SKevin Wolf
7148ab8140aSKevin Wolf int64_t coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_getlength)(
7158ab8140aSKevin Wolf BlockDriverState *bs);
7168ab8140aSKevin Wolf
717de335638SEmanuele Giuseppe Esposito int64_t coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_get_allocated_file_size)(
71882618d7bSEmanuele Giuseppe Esposito BlockDriverState *bs);
71982618d7bSEmanuele Giuseppe Esposito
720ebc2752bSEmanuele Giuseppe Esposito BlockMeasureInfo *(*bdrv_measure)(QemuOpts *opts, BlockDriverState *in_bs,
721ebc2752bSEmanuele Giuseppe Esposito Error **errp);
722ebc2752bSEmanuele Giuseppe Esposito
7237b1fb72eSKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pwritev_compressed)(
7247b1fb72eSKevin Wolf BlockDriverState *bs, int64_t offset, int64_t bytes,
7257b1fb72eSKevin Wolf QEMUIOVector *qiov);
7267b1fb72eSKevin Wolf
7277b1fb72eSKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pwritev_compressed_part)(
7287b1fb72eSKevin Wolf BlockDriverState *bs, int64_t offset, int64_t bytes,
7297b1fb72eSKevin Wolf QEMUIOVector *qiov, size_t qiov_offset);
730ebc2752bSEmanuele Giuseppe Esposito
731a00e70c0SEmanuele Giuseppe Esposito int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_get_info)(
732a00e70c0SEmanuele Giuseppe Esposito BlockDriverState *bs, BlockDriverInfo *bdi);
733ebc2752bSEmanuele Giuseppe Esposito
7343574499aSKevin Wolf ImageInfoSpecific * GRAPH_RDLOCK_PTR (*bdrv_get_specific_info)(
7353574499aSKevin Wolf BlockDriverState *bs, Error **errp);
736ebc2752bSEmanuele Giuseppe Esposito BlockStatsSpecific *(*bdrv_get_specific_stats)(BlockDriverState *bs);
737ebc2752bSEmanuele Giuseppe Esposito
738ca5e2ad9SEmanuele Giuseppe Esposito int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_save_vmstate)(
7391b3ff9feSKevin Wolf BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
7401b3ff9feSKevin Wolf
741ca5e2ad9SEmanuele Giuseppe Esposito int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_load_vmstate)(
7421b3ff9feSKevin Wolf BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
743ebc2752bSEmanuele Giuseppe Esposito
7446d43eaa3SSam Li int coroutine_fn (*bdrv_co_zone_report)(BlockDriverState *bs,
7456d43eaa3SSam Li int64_t offset, unsigned int *nr_zones,
7466d43eaa3SSam Li BlockZoneDescriptor *zones);
7476d43eaa3SSam Li int coroutine_fn (*bdrv_co_zone_mgmt)(BlockDriverState *bs, BlockZoneOp op,
7486d43eaa3SSam Li int64_t offset, int64_t len);
7494751d09aSSam Li int coroutine_fn (*bdrv_co_zone_append)(BlockDriverState *bs,
7504751d09aSSam Li int64_t *offset, QEMUIOVector *qiov,
7514751d09aSSam Li BdrvRequestFlags flags);
7526d43eaa3SSam Li
753ebc2752bSEmanuele Giuseppe Esposito /* removable device specific */
754c73ff92cSEmanuele Giuseppe Esposito bool coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_is_inserted)(
755c73ff92cSEmanuele Giuseppe Esposito BlockDriverState *bs);
75679a292e5SKevin Wolf void coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_eject)(
75779a292e5SKevin Wolf BlockDriverState *bs, bool eject_flag);
75879a292e5SKevin Wolf void coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_lock_medium)(
75979a292e5SKevin Wolf BlockDriverState *bs, bool locked);
760ebc2752bSEmanuele Giuseppe Esposito
761ebc2752bSEmanuele Giuseppe Esposito /* to control generic scsi devices */
76226c518abSKevin Wolf BlockAIOCB *coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_aio_ioctl)(
76326c518abSKevin Wolf BlockDriverState *bs, unsigned long int req, void *buf,
764ebc2752bSEmanuele Giuseppe Esposito BlockCompletionFunc *cb, void *opaque);
76526c518abSKevin Wolf
76626c518abSKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_ioctl)(
76726c518abSKevin Wolf BlockDriverState *bs, unsigned long int req, void *buf);
768ebc2752bSEmanuele Giuseppe Esposito
769ebc2752bSEmanuele Giuseppe Esposito /*
770ebc2752bSEmanuele Giuseppe Esposito * Returns 0 for completed check, -errno for internal errors.
771ebc2752bSEmanuele Giuseppe Esposito * The check results are stored in result.
772ebc2752bSEmanuele Giuseppe Esposito */
7731b3ff9feSKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_check)(
7741b3ff9feSKevin Wolf BlockDriverState *bs, BdrvCheckResult *result, BdrvCheckMode fix);
775ebc2752bSEmanuele Giuseppe Esposito
776cb2bfaa4SEmanuele Giuseppe Esposito void coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_debug_event)(
777cb2bfaa4SEmanuele Giuseppe Esposito BlockDriverState *bs, BlkdebugEvent event);
778ebc2752bSEmanuele Giuseppe Esposito
779ebc2752bSEmanuele Giuseppe Esposito bool (*bdrv_supports_persistent_dirty_bitmap)(BlockDriverState *bs);
780167f748dSKevin Wolf
781167f748dSKevin Wolf bool coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_can_store_new_dirty_bitmap)(
782c2d76808SAlberto Faria BlockDriverState *bs, const char *name, uint32_t granularity,
783ebc2752bSEmanuele Giuseppe Esposito Error **errp);
784167f748dSKevin Wolf
785167f748dSKevin Wolf int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_remove_persistent_dirty_bitmap)(
786c2d76808SAlberto Faria BlockDriverState *bs, const char *name, Error **errp);
787ebc2752bSEmanuele Giuseppe Esposito };
788ebc2752bSEmanuele Giuseppe Esposito
block_driver_can_compress(BlockDriver * drv)7897b1fb72eSKevin Wolf static inline bool TSA_NO_TSA block_driver_can_compress(BlockDriver *drv)
790ebc2752bSEmanuele Giuseppe Esposito {
791ebc2752bSEmanuele Giuseppe Esposito return drv->bdrv_co_pwritev_compressed ||
792ebc2752bSEmanuele Giuseppe Esposito drv->bdrv_co_pwritev_compressed_part;
793ebc2752bSEmanuele Giuseppe Esposito }
794ebc2752bSEmanuele Giuseppe Esposito
795ebc2752bSEmanuele Giuseppe Esposito typedef struct BlockLimits {
796ebc2752bSEmanuele Giuseppe Esposito /*
797ebc2752bSEmanuele Giuseppe Esposito * Alignment requirement, in bytes, for offset/length of I/O
798ebc2752bSEmanuele Giuseppe Esposito * requests. Must be a power of 2 less than INT_MAX; defaults to
799ebc2752bSEmanuele Giuseppe Esposito * 1 for drivers with modern byte interfaces, and to 512
800ebc2752bSEmanuele Giuseppe Esposito * otherwise.
801ebc2752bSEmanuele Giuseppe Esposito */
802ebc2752bSEmanuele Giuseppe Esposito uint32_t request_alignment;
803ebc2752bSEmanuele Giuseppe Esposito
804ebc2752bSEmanuele Giuseppe Esposito /*
805ebc2752bSEmanuele Giuseppe Esposito * Maximum number of bytes that can be discarded at once. Must be multiple
806ebc2752bSEmanuele Giuseppe Esposito * of pdiscard_alignment, but need not be power of 2. May be 0 if no
807ebc2752bSEmanuele Giuseppe Esposito * inherent 64-bit limit.
808ebc2752bSEmanuele Giuseppe Esposito */
809ebc2752bSEmanuele Giuseppe Esposito int64_t max_pdiscard;
810ebc2752bSEmanuele Giuseppe Esposito
811ebc2752bSEmanuele Giuseppe Esposito /*
812ebc2752bSEmanuele Giuseppe Esposito * Optimal alignment for discard requests in bytes. A power of 2
813ebc2752bSEmanuele Giuseppe Esposito * is best but not mandatory. Must be a multiple of
814ebc2752bSEmanuele Giuseppe Esposito * bl.request_alignment, and must be less than max_pdiscard if
815ebc2752bSEmanuele Giuseppe Esposito * that is set. May be 0 if bl.request_alignment is good enough
816ebc2752bSEmanuele Giuseppe Esposito */
817ebc2752bSEmanuele Giuseppe Esposito uint32_t pdiscard_alignment;
818ebc2752bSEmanuele Giuseppe Esposito
819ebc2752bSEmanuele Giuseppe Esposito /*
820ebc2752bSEmanuele Giuseppe Esposito * Maximum number of bytes that can zeroized at once. Must be multiple of
821ebc2752bSEmanuele Giuseppe Esposito * pwrite_zeroes_alignment. 0 means no limit.
822ebc2752bSEmanuele Giuseppe Esposito */
823ebc2752bSEmanuele Giuseppe Esposito int64_t max_pwrite_zeroes;
824ebc2752bSEmanuele Giuseppe Esposito
825ebc2752bSEmanuele Giuseppe Esposito /*
826ebc2752bSEmanuele Giuseppe Esposito * Optimal alignment for write zeroes requests in bytes. A power
827ebc2752bSEmanuele Giuseppe Esposito * of 2 is best but not mandatory. Must be a multiple of
828ebc2752bSEmanuele Giuseppe Esposito * bl.request_alignment, and must be less than max_pwrite_zeroes
829ebc2752bSEmanuele Giuseppe Esposito * if that is set. May be 0 if bl.request_alignment is good
830ebc2752bSEmanuele Giuseppe Esposito * enough
831ebc2752bSEmanuele Giuseppe Esposito */
832ebc2752bSEmanuele Giuseppe Esposito uint32_t pwrite_zeroes_alignment;
833ebc2752bSEmanuele Giuseppe Esposito
834ebc2752bSEmanuele Giuseppe Esposito /*
835ebc2752bSEmanuele Giuseppe Esposito * Optimal transfer length in bytes. A power of 2 is best but not
836ebc2752bSEmanuele Giuseppe Esposito * mandatory. Must be a multiple of bl.request_alignment, or 0 if
837ebc2752bSEmanuele Giuseppe Esposito * no preferred size
838ebc2752bSEmanuele Giuseppe Esposito */
839ebc2752bSEmanuele Giuseppe Esposito uint32_t opt_transfer;
840ebc2752bSEmanuele Giuseppe Esposito
841ebc2752bSEmanuele Giuseppe Esposito /*
842ebc2752bSEmanuele Giuseppe Esposito * Maximal transfer length in bytes. Need not be power of 2, but
843ebc2752bSEmanuele Giuseppe Esposito * must be multiple of opt_transfer and bl.request_alignment, or 0
844ebc2752bSEmanuele Giuseppe Esposito * for no 32-bit limit. For now, anything larger than INT_MAX is
845ebc2752bSEmanuele Giuseppe Esposito * clamped down.
846ebc2752bSEmanuele Giuseppe Esposito */
847ebc2752bSEmanuele Giuseppe Esposito uint32_t max_transfer;
848ebc2752bSEmanuele Giuseppe Esposito
849ebc2752bSEmanuele Giuseppe Esposito /*
850ebc2752bSEmanuele Giuseppe Esposito * Maximal hardware transfer length in bytes. Applies whenever
851ebc2752bSEmanuele Giuseppe Esposito * transfers to the device bypass the kernel I/O scheduler, for
852ebc2752bSEmanuele Giuseppe Esposito * example with SG_IO. If larger than max_transfer or if zero,
853ebc2752bSEmanuele Giuseppe Esposito * blk_get_max_hw_transfer will fall back to max_transfer.
854ebc2752bSEmanuele Giuseppe Esposito */
855ebc2752bSEmanuele Giuseppe Esposito uint64_t max_hw_transfer;
856ebc2752bSEmanuele Giuseppe Esposito
857ebc2752bSEmanuele Giuseppe Esposito /*
858ebc2752bSEmanuele Giuseppe Esposito * Maximal number of scatter/gather elements allowed by the hardware.
859ebc2752bSEmanuele Giuseppe Esposito * Applies whenever transfers to the device bypass the kernel I/O
860ebc2752bSEmanuele Giuseppe Esposito * scheduler, for example with SG_IO. If larger than max_iov
861ebc2752bSEmanuele Giuseppe Esposito * or if zero, blk_get_max_hw_iov will fall back to max_iov.
862ebc2752bSEmanuele Giuseppe Esposito */
863ebc2752bSEmanuele Giuseppe Esposito int max_hw_iov;
864ebc2752bSEmanuele Giuseppe Esposito
865ebc2752bSEmanuele Giuseppe Esposito
866ebc2752bSEmanuele Giuseppe Esposito /* memory alignment, in bytes so that no bounce buffer is needed */
867ebc2752bSEmanuele Giuseppe Esposito size_t min_mem_alignment;
868ebc2752bSEmanuele Giuseppe Esposito
869ebc2752bSEmanuele Giuseppe Esposito /* memory alignment, in bytes, for bounce buffer */
870ebc2752bSEmanuele Giuseppe Esposito size_t opt_mem_alignment;
871ebc2752bSEmanuele Giuseppe Esposito
872ebc2752bSEmanuele Giuseppe Esposito /* maximum number of iovec elements */
873ebc2752bSEmanuele Giuseppe Esposito int max_iov;
874160a29e2SPaolo Bonzini
875160a29e2SPaolo Bonzini /*
876160a29e2SPaolo Bonzini * true if the length of the underlying file can change, and QEMU
877160a29e2SPaolo Bonzini * is expected to adjust automatically. Mostly for CD-ROM drives,
878160a29e2SPaolo Bonzini * whose length is zero when the tray is empty (they don't need
879160a29e2SPaolo Bonzini * an explicit monitor command to load the disk inside the guest).
880160a29e2SPaolo Bonzini */
881160a29e2SPaolo Bonzini bool has_variable_length;
882a735b56eSSam Li
883a735b56eSSam Li /* device zone model */
884a735b56eSSam Li BlockZoneModel zoned;
8856d43eaa3SSam Li
8866d43eaa3SSam Li /* zone size expressed in bytes */
8876d43eaa3SSam Li uint32_t zone_size;
8886d43eaa3SSam Li
8896d43eaa3SSam Li /* total number of zones */
8906d43eaa3SSam Li uint32_t nr_zones;
8916d43eaa3SSam Li
8926d43eaa3SSam Li /* maximum sectors of a zone append write operation */
8936d43eaa3SSam Li uint32_t max_append_sectors;
8946d43eaa3SSam Li
8956d43eaa3SSam Li /* maximum number of open zones */
8966d43eaa3SSam Li uint32_t max_open_zones;
8976d43eaa3SSam Li
8986d43eaa3SSam Li /* maximum number of active zones */
8996d43eaa3SSam Li uint32_t max_active_zones;
900a3c41f06SSam Li
901a3c41f06SSam Li uint32_t write_granularity;
902ebc2752bSEmanuele Giuseppe Esposito } BlockLimits;
903ebc2752bSEmanuele Giuseppe Esposito
904ebc2752bSEmanuele Giuseppe Esposito typedef struct BdrvOpBlocker BdrvOpBlocker;
905ebc2752bSEmanuele Giuseppe Esposito
906ebc2752bSEmanuele Giuseppe Esposito typedef struct BdrvAioNotifier {
907ebc2752bSEmanuele Giuseppe Esposito void (*attached_aio_context)(AioContext *new_context, void *opaque);
908ebc2752bSEmanuele Giuseppe Esposito void (*detach_aio_context)(void *opaque);
909ebc2752bSEmanuele Giuseppe Esposito
910ebc2752bSEmanuele Giuseppe Esposito void *opaque;
911ebc2752bSEmanuele Giuseppe Esposito bool deleted;
912ebc2752bSEmanuele Giuseppe Esposito
913ebc2752bSEmanuele Giuseppe Esposito QLIST_ENTRY(BdrvAioNotifier) list;
914ebc2752bSEmanuele Giuseppe Esposito } BdrvAioNotifier;
915ebc2752bSEmanuele Giuseppe Esposito
916ebc2752bSEmanuele Giuseppe Esposito struct BdrvChildClass {
917ebc2752bSEmanuele Giuseppe Esposito /*
918ebc2752bSEmanuele Giuseppe Esposito * If true, bdrv_replace_node() doesn't change the node this BdrvChild
919ebc2752bSEmanuele Giuseppe Esposito * points to.
920ebc2752bSEmanuele Giuseppe Esposito */
921ebc2752bSEmanuele Giuseppe Esposito bool stay_at_node;
922ebc2752bSEmanuele Giuseppe Esposito
923ebc2752bSEmanuele Giuseppe Esposito /*
924ebc2752bSEmanuele Giuseppe Esposito * If true, the parent is a BlockDriverState and bdrv_next_all_states()
925ebc2752bSEmanuele Giuseppe Esposito * will return it. This information is used for drain_all, where every node
926ebc2752bSEmanuele Giuseppe Esposito * will be drained separately, so the drain only needs to be propagated to
927ebc2752bSEmanuele Giuseppe Esposito * non-BDS parents.
928ebc2752bSEmanuele Giuseppe Esposito */
929ebc2752bSEmanuele Giuseppe Esposito bool parent_is_bds;
930ebc2752bSEmanuele Giuseppe Esposito
931abc5a79cSEmanuele Giuseppe Esposito /*
932abc5a79cSEmanuele Giuseppe Esposito * Global state (GS) API. These functions run under the BQL.
933abc5a79cSEmanuele Giuseppe Esposito *
934abc5a79cSEmanuele Giuseppe Esposito * See include/block/block-global-state.h for more information about
935abc5a79cSEmanuele Giuseppe Esposito * the GS API.
936abc5a79cSEmanuele Giuseppe Esposito */
937ebc2752bSEmanuele Giuseppe Esposito void (*inherit_options)(BdrvChildRole role, bool parent_is_format,
938ebc2752bSEmanuele Giuseppe Esposito int *child_flags, QDict *child_options,
939ebc2752bSEmanuele Giuseppe Esposito int parent_flags, QDict *parent_options);
940ebc2752bSEmanuele Giuseppe Esposito void (*change_media)(BdrvChild *child, bool load);
941ebc2752bSEmanuele Giuseppe Esposito
942ebc2752bSEmanuele Giuseppe Esposito /*
943ebc2752bSEmanuele Giuseppe Esposito * Returns a malloced string that describes the parent of the child for a
944ebc2752bSEmanuele Giuseppe Esposito * human reader. This could be a node-name, BlockBackend name, qdev ID or
945ebc2752bSEmanuele Giuseppe Esposito * QOM path of the device owning the BlockBackend, job type and ID etc. The
946ebc2752bSEmanuele Giuseppe Esposito * caller is responsible for freeing the memory.
947ebc2752bSEmanuele Giuseppe Esposito */
948ebc2752bSEmanuele Giuseppe Esposito char *(*get_parent_desc)(BdrvChild *child);
949ebc2752bSEmanuele Giuseppe Esposito
950ebc2752bSEmanuele Giuseppe Esposito /*
951ebc2752bSEmanuele Giuseppe Esposito * Notifies the parent that the child has been activated/inactivated (e.g.
952ebc2752bSEmanuele Giuseppe Esposito * when migration is completing) and it can start/stop requesting
953ebc2752bSEmanuele Giuseppe Esposito * permissions and doing I/O on it.
954ebc2752bSEmanuele Giuseppe Esposito */
9553804e3cfSKevin Wolf void GRAPH_RDLOCK_PTR (*activate)(BdrvChild *child, Error **errp);
9563804e3cfSKevin Wolf int GRAPH_RDLOCK_PTR (*inactivate)(BdrvChild *child);
957ebc2752bSEmanuele Giuseppe Esposito
958303de47bSKevin Wolf void GRAPH_WRLOCK_PTR (*attach)(BdrvChild *child);
959303de47bSKevin Wolf void GRAPH_WRLOCK_PTR (*detach)(BdrvChild *child);
960ebc2752bSEmanuele Giuseppe Esposito
961ebc2752bSEmanuele Giuseppe Esposito /*
962ab613350SStefan Hajnoczi * If this pair of functions is implemented, the parent doesn't issue new
963ab613350SStefan Hajnoczi * requests after returning from .drained_begin() until .drained_end() is
964ab613350SStefan Hajnoczi * called.
965ab613350SStefan Hajnoczi *
966ab613350SStefan Hajnoczi * These functions must not change the graph (and therefore also must not
967ab613350SStefan Hajnoczi * call aio_poll(), which could change the graph indirectly).
968ab613350SStefan Hajnoczi *
969ab613350SStefan Hajnoczi * Note that this can be nested. If drained_begin() was called twice, new
970ab613350SStefan Hajnoczi * I/O is allowed only after drained_end() was called twice, too.
971ab613350SStefan Hajnoczi */
972d05ab380SEmanuele Giuseppe Esposito void GRAPH_RDLOCK_PTR (*drained_begin)(BdrvChild *child);
973d05ab380SEmanuele Giuseppe Esposito void GRAPH_RDLOCK_PTR (*drained_end)(BdrvChild *child);
974ab613350SStefan Hajnoczi
975ab613350SStefan Hajnoczi /*
976ab613350SStefan Hajnoczi * Returns whether the parent has pending requests for the child. This
977ab613350SStefan Hajnoczi * callback is polled after .drained_begin() has been called until all
978ab613350SStefan Hajnoczi * activity on the child has stopped.
979ab613350SStefan Hajnoczi */
980d05ab380SEmanuele Giuseppe Esposito bool GRAPH_RDLOCK_PTR (*drained_poll)(BdrvChild *child);
981ab613350SStefan Hajnoczi
982ab613350SStefan Hajnoczi /*
983ebc2752bSEmanuele Giuseppe Esposito * Notifies the parent that the filename of its child has changed (e.g.
984ebc2752bSEmanuele Giuseppe Esposito * because the direct child was removed from the backing chain), so that it
985ebc2752bSEmanuele Giuseppe Esposito * can update its reference.
986ebc2752bSEmanuele Giuseppe Esposito */
987ebc2752bSEmanuele Giuseppe Esposito int (*update_filename)(BdrvChild *child, BlockDriverState *new_base,
9884b028cbeSPeter Krempa const char *filename,
9894b028cbeSPeter Krempa bool backing_mask_protocol,
9904b028cbeSPeter Krempa Error **errp);
991ebc2752bSEmanuele Giuseppe Esposito
9927e8c182fSEmanuele Giuseppe Esposito bool (*change_aio_ctx)(BdrvChild *child, AioContext *ctx,
993e08cc001SEmanuele Giuseppe Esposito GHashTable *visited, Transaction *tran,
994e08cc001SEmanuele Giuseppe Esposito Error **errp);
995ebc2752bSEmanuele Giuseppe Esposito
996abc5a79cSEmanuele Giuseppe Esposito /*
997abc5a79cSEmanuele Giuseppe Esposito * I/O API functions. These functions are thread-safe.
998abc5a79cSEmanuele Giuseppe Esposito *
999abc5a79cSEmanuele Giuseppe Esposito * See include/block/block-io.h for more information about
1000abc5a79cSEmanuele Giuseppe Esposito * the I/O API.
1001abc5a79cSEmanuele Giuseppe Esposito */
1002abc5a79cSEmanuele Giuseppe Esposito
1003abc5a79cSEmanuele Giuseppe Esposito void (*resize)(BdrvChild *child);
1004abc5a79cSEmanuele Giuseppe Esposito
1005abc5a79cSEmanuele Giuseppe Esposito /*
1006abc5a79cSEmanuele Giuseppe Esposito * Returns a name that is supposedly more useful for human users than the
1007abc5a79cSEmanuele Giuseppe Esposito * node name for identifying the node in question (in particular, a BB
1008abc5a79cSEmanuele Giuseppe Esposito * name), or NULL if the parent can't provide a better name.
1009abc5a79cSEmanuele Giuseppe Esposito */
1010abc5a79cSEmanuele Giuseppe Esposito const char *(*get_name)(BdrvChild *child);
1011abc5a79cSEmanuele Giuseppe Esposito
1012d5f8d79cSHanna Reitz AioContext *(*get_parent_aio_context)(BdrvChild *child);
1013ebc2752bSEmanuele Giuseppe Esposito };
1014ebc2752bSEmanuele Giuseppe Esposito
1015ebc2752bSEmanuele Giuseppe Esposito extern const BdrvChildClass child_of_bds;
1016ebc2752bSEmanuele Giuseppe Esposito
1017ebc2752bSEmanuele Giuseppe Esposito struct BdrvChild {
1018ebc2752bSEmanuele Giuseppe Esposito BlockDriverState *bs;
1019ebc2752bSEmanuele Giuseppe Esposito char *name;
1020ebc2752bSEmanuele Giuseppe Esposito const BdrvChildClass *klass;
1021ebc2752bSEmanuele Giuseppe Esposito BdrvChildRole role;
1022ebc2752bSEmanuele Giuseppe Esposito void *opaque;
1023ebc2752bSEmanuele Giuseppe Esposito
1024ebc2752bSEmanuele Giuseppe Esposito /**
1025ebc2752bSEmanuele Giuseppe Esposito * Granted permissions for operating on this BdrvChild (BLK_PERM_* bitmask)
1026ebc2752bSEmanuele Giuseppe Esposito */
1027ebc2752bSEmanuele Giuseppe Esposito uint64_t perm;
1028ebc2752bSEmanuele Giuseppe Esposito
1029ebc2752bSEmanuele Giuseppe Esposito /**
1030ebc2752bSEmanuele Giuseppe Esposito * Permissions that can still be granted to other users of @bs while this
1031ebc2752bSEmanuele Giuseppe Esposito * BdrvChild is still attached to it. (BLK_PERM_* bitmask)
1032ebc2752bSEmanuele Giuseppe Esposito */
1033ebc2752bSEmanuele Giuseppe Esposito uint64_t shared_perm;
1034ebc2752bSEmanuele Giuseppe Esposito
1035ebc2752bSEmanuele Giuseppe Esposito /*
1036ebc2752bSEmanuele Giuseppe Esposito * This link is frozen: the child can neither be replaced nor
1037ebc2752bSEmanuele Giuseppe Esposito * detached from the parent.
1038ebc2752bSEmanuele Giuseppe Esposito */
1039ebc2752bSEmanuele Giuseppe Esposito bool frozen;
1040ebc2752bSEmanuele Giuseppe Esposito
1041ebc2752bSEmanuele Giuseppe Esposito /*
104257e05be3SKevin Wolf * True if the parent of this child has been drained by this BdrvChild
1043ebc2752bSEmanuele Giuseppe Esposito * (through klass->drained_*).
104457e05be3SKevin Wolf *
104557e05be3SKevin Wolf * It is generally true if bs->quiesce_counter > 0. It may differ while the
1046ebc2752bSEmanuele Giuseppe Esposito * child is entering or leaving a drained section.
1047ebc2752bSEmanuele Giuseppe Esposito */
104857e05be3SKevin Wolf bool quiesced_parent;
1049ebc2752bSEmanuele Giuseppe Esposito
1050680e0cc4SKevin Wolf QLIST_ENTRY(BdrvChild GRAPH_RDLOCK_PTR) next;
1051b59b4660SKevin Wolf QLIST_ENTRY(BdrvChild GRAPH_RDLOCK_PTR) next_parent;
1052ebc2752bSEmanuele Giuseppe Esposito };
1053ebc2752bSEmanuele Giuseppe Esposito
1054ebc2752bSEmanuele Giuseppe Esposito /*
1055ebc2752bSEmanuele Giuseppe Esposito * Allows bdrv_co_block_status() to cache one data region for a
1056ebc2752bSEmanuele Giuseppe Esposito * protocol node.
1057ebc2752bSEmanuele Giuseppe Esposito *
1058ebc2752bSEmanuele Giuseppe Esposito * @valid: Whether the cache is valid (should be accessed with atomic
1059ebc2752bSEmanuele Giuseppe Esposito * functions so this can be reset by RCU readers)
1060ebc2752bSEmanuele Giuseppe Esposito * @data_start: Offset where we know (or strongly assume) is data
1061ebc2752bSEmanuele Giuseppe Esposito * @data_end: Offset where the data region ends (which is not necessarily
1062ebc2752bSEmanuele Giuseppe Esposito * the start of a zeroed region)
1063ebc2752bSEmanuele Giuseppe Esposito */
1064ebc2752bSEmanuele Giuseppe Esposito typedef struct BdrvBlockStatusCache {
1065ebc2752bSEmanuele Giuseppe Esposito struct rcu_head rcu;
1066ebc2752bSEmanuele Giuseppe Esposito
1067ebc2752bSEmanuele Giuseppe Esposito bool valid;
1068ebc2752bSEmanuele Giuseppe Esposito int64_t data_start;
1069ebc2752bSEmanuele Giuseppe Esposito int64_t data_end;
1070ebc2752bSEmanuele Giuseppe Esposito } BdrvBlockStatusCache;
1071ebc2752bSEmanuele Giuseppe Esposito
1072ebc2752bSEmanuele Giuseppe Esposito struct BlockDriverState {
1073ebc2752bSEmanuele Giuseppe Esposito /*
1074ebc2752bSEmanuele Giuseppe Esposito * Protected by big QEMU lock or read-only after opening. No special
1075ebc2752bSEmanuele Giuseppe Esposito * locking needed during I/O...
1076ebc2752bSEmanuele Giuseppe Esposito */
1077ebc2752bSEmanuele Giuseppe Esposito int open_flags; /* flags used to open the file, re-used for re-open */
1078ebc2752bSEmanuele Giuseppe Esposito bool encrypted; /* if true, the media is encrypted */
1079ebc2752bSEmanuele Giuseppe Esposito bool sg; /* if true, the device is a /dev/sg* */
1080ebc2752bSEmanuele Giuseppe Esposito bool probed; /* if true, format was probed rather than specified */
1081ebc2752bSEmanuele Giuseppe Esposito bool force_share; /* if true, always allow all shared permissions */
1082ebc2752bSEmanuele Giuseppe Esposito bool implicit; /* if true, this filter node was automatically inserted */
1083ebc2752bSEmanuele Giuseppe Esposito
1084ebc2752bSEmanuele Giuseppe Esposito BlockDriver *drv; /* NULL means no media */
1085ebc2752bSEmanuele Giuseppe Esposito void *opaque;
1086ebc2752bSEmanuele Giuseppe Esposito
1087ebc2752bSEmanuele Giuseppe Esposito AioContext *aio_context; /* event loop used for fd handlers, timers, etc */
1088ebc2752bSEmanuele Giuseppe Esposito /*
1089ebc2752bSEmanuele Giuseppe Esposito * long-running tasks intended to always use the same AioContext as this
1090ebc2752bSEmanuele Giuseppe Esposito * BDS may register themselves in this list to be notified of changes
1091ebc2752bSEmanuele Giuseppe Esposito * regarding this BDS's context
1092ebc2752bSEmanuele Giuseppe Esposito */
1093ebc2752bSEmanuele Giuseppe Esposito QLIST_HEAD(, BdrvAioNotifier) aio_notifiers;
1094ebc2752bSEmanuele Giuseppe Esposito bool walking_aio_notifiers; /* to make removal during iteration safe */
1095ebc2752bSEmanuele Giuseppe Esposito
1096ebc2752bSEmanuele Giuseppe Esposito char filename[PATH_MAX];
1097ebc2752bSEmanuele Giuseppe Esposito /*
1098ebc2752bSEmanuele Giuseppe Esposito * If not empty, this image is a diff in relation to backing_file.
1099ebc2752bSEmanuele Giuseppe Esposito * Note that this is the name given in the image header and
1100ebc2752bSEmanuele Giuseppe Esposito * therefore may or may not be equal to .backing->bs->filename.
1101ebc2752bSEmanuele Giuseppe Esposito * If this field contains a relative path, it is to be resolved
1102ebc2752bSEmanuele Giuseppe Esposito * relatively to the overlay's location.
1103ebc2752bSEmanuele Giuseppe Esposito */
1104ebc2752bSEmanuele Giuseppe Esposito char backing_file[PATH_MAX];
1105ebc2752bSEmanuele Giuseppe Esposito /*
1106ebc2752bSEmanuele Giuseppe Esposito * The backing filename indicated by the image header. Contrary
1107ebc2752bSEmanuele Giuseppe Esposito * to backing_file, if we ever open this file, auto_backing_file
1108ebc2752bSEmanuele Giuseppe Esposito * is replaced by the resulting BDS's filename (i.e. after a
1109ebc2752bSEmanuele Giuseppe Esposito * bdrv_refresh_filename() run).
1110ebc2752bSEmanuele Giuseppe Esposito */
1111ebc2752bSEmanuele Giuseppe Esposito char auto_backing_file[PATH_MAX];
1112ebc2752bSEmanuele Giuseppe Esposito char backing_format[16]; /* if non-zero and backing_file exists */
1113ebc2752bSEmanuele Giuseppe Esposito
1114ebc2752bSEmanuele Giuseppe Esposito QDict *full_open_options;
1115ebc2752bSEmanuele Giuseppe Esposito char exact_filename[PATH_MAX];
1116ebc2752bSEmanuele Giuseppe Esposito
1117ebc2752bSEmanuele Giuseppe Esposito /* I/O Limits */
1118ebc2752bSEmanuele Giuseppe Esposito BlockLimits bl;
1119ebc2752bSEmanuele Giuseppe Esposito
1120ebc2752bSEmanuele Giuseppe Esposito /*
1121ebc2752bSEmanuele Giuseppe Esposito * Flags honored during pread
1122ebc2752bSEmanuele Giuseppe Esposito */
112398b3ddc7SStefan Hajnoczi BdrvRequestFlags supported_read_flags;
1124ebc2752bSEmanuele Giuseppe Esposito /*
1125ebc2752bSEmanuele Giuseppe Esposito * Flags honored during pwrite (so far: BDRV_REQ_FUA,
1126ebc2752bSEmanuele Giuseppe Esposito * BDRV_REQ_WRITE_UNCHANGED).
1127ebc2752bSEmanuele Giuseppe Esposito * If a driver does not support BDRV_REQ_WRITE_UNCHANGED, those
1128ebc2752bSEmanuele Giuseppe Esposito * writes will be issued as normal writes without the flag set.
1129ebc2752bSEmanuele Giuseppe Esposito * This is important to note for drivers that do not explicitly
1130ebc2752bSEmanuele Giuseppe Esposito * request a WRITE permission for their children and instead take
1131ebc2752bSEmanuele Giuseppe Esposito * the same permissions as their parent did (this is commonly what
1132ebc2752bSEmanuele Giuseppe Esposito * block filters do). Such drivers have to be aware that the
1133ebc2752bSEmanuele Giuseppe Esposito * parent may have taken a WRITE_UNCHANGED permission only and is
1134ebc2752bSEmanuele Giuseppe Esposito * issuing such requests. Drivers either must make sure that
1135ebc2752bSEmanuele Giuseppe Esposito * these requests do not result in plain WRITE accesses (usually
1136ebc2752bSEmanuele Giuseppe Esposito * by supporting BDRV_REQ_WRITE_UNCHANGED, and then forwarding
1137ebc2752bSEmanuele Giuseppe Esposito * every incoming write request as-is, including potentially that
1138ebc2752bSEmanuele Giuseppe Esposito * flag), or they have to explicitly take the WRITE permission for
1139ebc2752bSEmanuele Giuseppe Esposito * their children.
1140ebc2752bSEmanuele Giuseppe Esposito */
114198b3ddc7SStefan Hajnoczi BdrvRequestFlags supported_write_flags;
1142ebc2752bSEmanuele Giuseppe Esposito /*
1143ebc2752bSEmanuele Giuseppe Esposito * Flags honored during pwrite_zeroes (so far: BDRV_REQ_FUA,
1144ebc2752bSEmanuele Giuseppe Esposito * BDRV_REQ_MAY_UNMAP, BDRV_REQ_WRITE_UNCHANGED)
1145ebc2752bSEmanuele Giuseppe Esposito */
114698b3ddc7SStefan Hajnoczi BdrvRequestFlags supported_zero_flags;
1147ebc2752bSEmanuele Giuseppe Esposito /*
1148ebc2752bSEmanuele Giuseppe Esposito * Flags honoured during truncate (so far: BDRV_REQ_ZERO_WRITE).
1149ebc2752bSEmanuele Giuseppe Esposito *
1150ebc2752bSEmanuele Giuseppe Esposito * If BDRV_REQ_ZERO_WRITE is given, the truncate operation must make sure
1151ebc2752bSEmanuele Giuseppe Esposito * that any added space reads as all zeros. If this can't be guaranteed,
1152ebc2752bSEmanuele Giuseppe Esposito * the operation must fail.
1153ebc2752bSEmanuele Giuseppe Esposito */
115498b3ddc7SStefan Hajnoczi BdrvRequestFlags supported_truncate_flags;
1155ebc2752bSEmanuele Giuseppe Esposito
1156ebc2752bSEmanuele Giuseppe Esposito /* the following member gives a name to every node on the bs graph. */
1157ebc2752bSEmanuele Giuseppe Esposito char node_name[32];
1158ebc2752bSEmanuele Giuseppe Esposito /* element of the list of named nodes building the graph */
1159ebc2752bSEmanuele Giuseppe Esposito QTAILQ_ENTRY(BlockDriverState) node_list;
1160ebc2752bSEmanuele Giuseppe Esposito /* element of the list of all BlockDriverStates (all_bdrv_states) */
1161ebc2752bSEmanuele Giuseppe Esposito QTAILQ_ENTRY(BlockDriverState) bs_list;
1162ebc2752bSEmanuele Giuseppe Esposito /* element of the list of monitor-owned BDS */
1163ebc2752bSEmanuele Giuseppe Esposito QTAILQ_ENTRY(BlockDriverState) monitor_list;
1164ebc2752bSEmanuele Giuseppe Esposito int refcnt;
1165ebc2752bSEmanuele Giuseppe Esposito
1166ebc2752bSEmanuele Giuseppe Esposito /* operation blockers. Protected by BQL. */
1167ebc2752bSEmanuele Giuseppe Esposito QLIST_HEAD(, BdrvOpBlocker) op_blockers[BLOCK_OP_TYPE_MAX];
1168ebc2752bSEmanuele Giuseppe Esposito
1169ebc2752bSEmanuele Giuseppe Esposito /*
1170ebc2752bSEmanuele Giuseppe Esposito * The node that this node inherited default options from (and a reopen on
1171ebc2752bSEmanuele Giuseppe Esposito * which can affect this node by changing these defaults). This is always a
1172ebc2752bSEmanuele Giuseppe Esposito * parent node of this node.
1173ebc2752bSEmanuele Giuseppe Esposito */
1174ebc2752bSEmanuele Giuseppe Esposito BlockDriverState *inherits_from;
11755bb04747SVladimir Sementsov-Ogievskiy
11765bb04747SVladimir Sementsov-Ogievskiy /*
11775bb04747SVladimir Sementsov-Ogievskiy * @backing and @file are some of @children or NULL. All these three fields
11785bb04747SVladimir Sementsov-Ogievskiy * (@file, @backing and @children) are modified only in
11795bb04747SVladimir Sementsov-Ogievskiy * bdrv_child_cb_attach() and bdrv_child_cb_detach().
11805bb04747SVladimir Sementsov-Ogievskiy *
11815bb04747SVladimir Sementsov-Ogievskiy * See also comment in include/block/block.h, to learn how backing and file
11825bb04747SVladimir Sementsov-Ogievskiy * are connected with BdrvChildRole.
11835bb04747SVladimir Sementsov-Ogievskiy */
1184680e0cc4SKevin Wolf QLIST_HEAD(, BdrvChild GRAPH_RDLOCK_PTR) children;
1185004915a9SKevin Wolf BdrvChild * GRAPH_RDLOCK_PTR backing;
11861f051dcbSKevin Wolf BdrvChild * GRAPH_RDLOCK_PTR file;
11875bb04747SVladimir Sementsov-Ogievskiy
1188b59b4660SKevin Wolf QLIST_HEAD(, BdrvChild GRAPH_RDLOCK_PTR) parents;
1189ebc2752bSEmanuele Giuseppe Esposito
1190ebc2752bSEmanuele Giuseppe Esposito QDict *options;
1191ebc2752bSEmanuele Giuseppe Esposito QDict *explicit_options;
1192ebc2752bSEmanuele Giuseppe Esposito BlockdevDetectZeroesOptions detect_zeroes;
1193ebc2752bSEmanuele Giuseppe Esposito
1194ebc2752bSEmanuele Giuseppe Esposito /* The error object in use for blocking operations on backing_hd */
1195ebc2752bSEmanuele Giuseppe Esposito Error *backing_blocker;
1196ebc2752bSEmanuele Giuseppe Esposito
1197ebc2752bSEmanuele Giuseppe Esposito /*
1198ebc2752bSEmanuele Giuseppe Esposito * If we are reading a disk image, give its size in sectors.
1199ebc2752bSEmanuele Giuseppe Esposito * Generally read-only; it is written to by load_snapshot and
1200ebc2752bSEmanuele Giuseppe Esposito * save_snaphost, but the block layer is quiescent during those.
1201ebc2752bSEmanuele Giuseppe Esposito */
1202ebc2752bSEmanuele Giuseppe Esposito int64_t total_sectors;
1203ebc2752bSEmanuele Giuseppe Esposito
1204ebc2752bSEmanuele Giuseppe Esposito /* threshold limit for writes, in bytes. "High water mark". */
1205ebc2752bSEmanuele Giuseppe Esposito uint64_t write_threshold_offset;
1206ebc2752bSEmanuele Giuseppe Esposito
1207ebc2752bSEmanuele Giuseppe Esposito /*
1208ebc2752bSEmanuele Giuseppe Esposito * Writing to the list requires the BQL _and_ the dirty_bitmap_mutex.
1209ebc2752bSEmanuele Giuseppe Esposito * Reading from the list can be done with either the BQL or the
1210ebc2752bSEmanuele Giuseppe Esposito * dirty_bitmap_mutex. Modifying a bitmap only requires
1211ebc2752bSEmanuele Giuseppe Esposito * dirty_bitmap_mutex.
1212ebc2752bSEmanuele Giuseppe Esposito */
1213ebc2752bSEmanuele Giuseppe Esposito QemuMutex dirty_bitmap_mutex;
1214ebc2752bSEmanuele Giuseppe Esposito QLIST_HEAD(, BdrvDirtyBitmap) dirty_bitmaps;
1215ebc2752bSEmanuele Giuseppe Esposito
1216ebc2752bSEmanuele Giuseppe Esposito /* Offset after the highest byte written to */
1217ebc2752bSEmanuele Giuseppe Esposito Stat64 wr_highest_offset;
1218ebc2752bSEmanuele Giuseppe Esposito
1219ebc2752bSEmanuele Giuseppe Esposito /*
1220ebc2752bSEmanuele Giuseppe Esposito * If true, copy read backing sectors into image. Can be >1 if more
1221ebc2752bSEmanuele Giuseppe Esposito * than one client has requested copy-on-read. Accessed with atomic
1222ebc2752bSEmanuele Giuseppe Esposito * ops.
1223ebc2752bSEmanuele Giuseppe Esposito */
1224ebc2752bSEmanuele Giuseppe Esposito int copy_on_read;
1225ebc2752bSEmanuele Giuseppe Esposito
1226ebc2752bSEmanuele Giuseppe Esposito /*
1227ebc2752bSEmanuele Giuseppe Esposito * number of in-flight requests; overall and serialising.
1228ebc2752bSEmanuele Giuseppe Esposito * Accessed with atomic ops.
1229ebc2752bSEmanuele Giuseppe Esposito */
1230ebc2752bSEmanuele Giuseppe Esposito unsigned int in_flight;
1231ebc2752bSEmanuele Giuseppe Esposito unsigned int serialising_in_flight;
1232ebc2752bSEmanuele Giuseppe Esposito
1233ebc2752bSEmanuele Giuseppe Esposito /* do we need to tell the quest if we have a volatile write cache? */
1234ebc2752bSEmanuele Giuseppe Esposito int enable_write_cache;
1235ebc2752bSEmanuele Giuseppe Esposito
1236ebc2752bSEmanuele Giuseppe Esposito /* Accessed with atomic ops. */
1237ebc2752bSEmanuele Giuseppe Esposito int quiesce_counter;
1238ebc2752bSEmanuele Giuseppe Esposito
1239ebc2752bSEmanuele Giuseppe Esposito unsigned int write_gen; /* Current data generation */
1240ebc2752bSEmanuele Giuseppe Esposito
1241ebc2752bSEmanuele Giuseppe Esposito /* Protected by reqs_lock. */
1242fa9185fcSStefan Hajnoczi QemuMutex reqs_lock;
1243ebc2752bSEmanuele Giuseppe Esposito QLIST_HEAD(, BdrvTrackedRequest) tracked_requests;
1244ebc2752bSEmanuele Giuseppe Esposito CoQueue flush_queue; /* Serializing flush queue */
1245ebc2752bSEmanuele Giuseppe Esposito bool active_flush_req; /* Flush request in flight? */
1246ebc2752bSEmanuele Giuseppe Esposito
1247ebc2752bSEmanuele Giuseppe Esposito /* Only read/written by whoever has set active_flush_req to true. */
1248ebc2752bSEmanuele Giuseppe Esposito unsigned int flushed_gen; /* Flushed write generation */
1249ebc2752bSEmanuele Giuseppe Esposito
1250ebc2752bSEmanuele Giuseppe Esposito /* BdrvChild links to this node may never be frozen */
1251ebc2752bSEmanuele Giuseppe Esposito bool never_freeze;
1252ebc2752bSEmanuele Giuseppe Esposito
1253ebc2752bSEmanuele Giuseppe Esposito /* Lock for block-status cache RCU writers */
1254ebc2752bSEmanuele Giuseppe Esposito CoMutex bsc_modify_lock;
1255ebc2752bSEmanuele Giuseppe Esposito /* Always non-NULL, but must only be dereferenced under an RCU read guard */
1256ebc2752bSEmanuele Giuseppe Esposito BdrvBlockStatusCache *block_status_cache;
1257a3c41f06SSam Li
1258a3c41f06SSam Li /* array of write pointers' location of each zone in the zoned device. */
1259a3c41f06SSam Li BlockZoneWps *wps;
1260ebc2752bSEmanuele Giuseppe Esposito };
1261ebc2752bSEmanuele Giuseppe Esposito
1262ebc2752bSEmanuele Giuseppe Esposito struct BlockBackendRootState {
1263ebc2752bSEmanuele Giuseppe Esposito int open_flags;
1264ebc2752bSEmanuele Giuseppe Esposito BlockdevDetectZeroesOptions detect_zeroes;
1265ebc2752bSEmanuele Giuseppe Esposito };
1266ebc2752bSEmanuele Giuseppe Esposito
1267ebc2752bSEmanuele Giuseppe Esposito typedef enum BlockMirrorBackingMode {
1268ebc2752bSEmanuele Giuseppe Esposito /*
1269ebc2752bSEmanuele Giuseppe Esposito * Reuse the existing backing chain from the source for the target.
1270ebc2752bSEmanuele Giuseppe Esposito * - sync=full: Set backing BDS to NULL.
1271ebc2752bSEmanuele Giuseppe Esposito * - sync=top: Use source's backing BDS.
1272ebc2752bSEmanuele Giuseppe Esposito * - sync=none: Use source as the backing BDS.
1273ebc2752bSEmanuele Giuseppe Esposito */
1274ebc2752bSEmanuele Giuseppe Esposito MIRROR_SOURCE_BACKING_CHAIN,
1275ebc2752bSEmanuele Giuseppe Esposito
1276ebc2752bSEmanuele Giuseppe Esposito /* Open the target's backing chain completely anew */
1277ebc2752bSEmanuele Giuseppe Esposito MIRROR_OPEN_BACKING_CHAIN,
1278ebc2752bSEmanuele Giuseppe Esposito
1279ebc2752bSEmanuele Giuseppe Esposito /* Do not change the target's backing BDS after job completion */
1280ebc2752bSEmanuele Giuseppe Esposito MIRROR_LEAVE_BACKING_CHAIN,
1281ebc2752bSEmanuele Giuseppe Esposito } BlockMirrorBackingMode;
1282ebc2752bSEmanuele Giuseppe Esposito
1283ebc2752bSEmanuele Giuseppe Esposito
1284ebc2752bSEmanuele Giuseppe Esposito /*
1285ebc2752bSEmanuele Giuseppe Esposito * Essential block drivers which must always be statically linked into qemu, and
1286ebc2752bSEmanuele Giuseppe Esposito * which therefore can be accessed without using bdrv_find_format()
1287ebc2752bSEmanuele Giuseppe Esposito */
1288ebc2752bSEmanuele Giuseppe Esposito extern BlockDriver bdrv_file;
1289ebc2752bSEmanuele Giuseppe Esposito extern BlockDriver bdrv_raw;
1290ebc2752bSEmanuele Giuseppe Esposito extern BlockDriver bdrv_qcow2;
1291ebc2752bSEmanuele Giuseppe Esposito
1292ebc2752bSEmanuele Giuseppe Esposito extern unsigned int bdrv_drain_all_count;
1293ebc2752bSEmanuele Giuseppe Esposito extern QemuOptsList bdrv_create_opts_simple;
1294ebc2752bSEmanuele Giuseppe Esposito
1295ebc2752bSEmanuele Giuseppe Esposito /*
1296ebc2752bSEmanuele Giuseppe Esposito * Common functions that are neither I/O nor Global State.
1297ebc2752bSEmanuele Giuseppe Esposito *
129804ae220dSWilfred Mallawa * See include/block/block-common.h for more information about
1299ebc2752bSEmanuele Giuseppe Esposito * the Common API.
1300ebc2752bSEmanuele Giuseppe Esposito */
1301ebc2752bSEmanuele Giuseppe Esposito
child_bs(BdrvChild * child)1302ebc2752bSEmanuele Giuseppe Esposito static inline BlockDriverState *child_bs(BdrvChild *child)
1303ebc2752bSEmanuele Giuseppe Esposito {
1304ebc2752bSEmanuele Giuseppe Esposito return child ? child->bs : NULL;
1305ebc2752bSEmanuele Giuseppe Esposito }
1306ebc2752bSEmanuele Giuseppe Esposito
1307ebc2752bSEmanuele Giuseppe Esposito int bdrv_check_request(int64_t offset, int64_t bytes, Error **errp);
130869fbfff9SBin Meng char *create_tmp_file(Error **errp);
1309ebc2752bSEmanuele Giuseppe Esposito void bdrv_parse_filename_strip_prefix(const char *filename, const char *prefix,
1310ebc2752bSEmanuele Giuseppe Esposito QDict *options);
1311ebc2752bSEmanuele Giuseppe Esposito
1312ebc2752bSEmanuele Giuseppe Esposito
1313ebc2752bSEmanuele Giuseppe Esposito int bdrv_check_qiov_request(int64_t offset, int64_t bytes,
1314ebc2752bSEmanuele Giuseppe Esposito QEMUIOVector *qiov, size_t qiov_offset,
1315ebc2752bSEmanuele Giuseppe Esposito Error **errp);
1316ebc2752bSEmanuele Giuseppe Esposito
1317ebc2752bSEmanuele Giuseppe Esposito #ifdef _WIN32
1318ebc2752bSEmanuele Giuseppe Esposito int is_windows_drive(const char *filename);
1319ebc2752bSEmanuele Giuseppe Esposito #endif
1320ebc2752bSEmanuele Giuseppe Esposito
1321ebc2752bSEmanuele Giuseppe Esposito #endif /* BLOCK_INT_COMMON_H */
1322