xref: /qemu/include/block/block_int-common.h (revision 533c6e4e)
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     /*
141ebc2752bSEmanuele Giuseppe Esposito      * Drivers not implementing bdrv_parse_filename nor bdrv_open should have
142ebc2752bSEmanuele Giuseppe Esposito      * this field set to true, except ones that are defined only by their
143ebc2752bSEmanuele Giuseppe Esposito      * child's bs.
144ebc2752bSEmanuele Giuseppe Esposito      * An example of the last type will be the quorum block driver.
145ebc2752bSEmanuele Giuseppe Esposito      */
146ebc2752bSEmanuele Giuseppe Esposito     bool bdrv_needs_filename;
147ebc2752bSEmanuele Giuseppe Esposito 
148ebc2752bSEmanuele Giuseppe Esposito     /*
149ebc2752bSEmanuele Giuseppe Esposito      * Set if a driver can support backing files. This also implies the
150ebc2752bSEmanuele Giuseppe Esposito      * following semantics:
151ebc2752bSEmanuele Giuseppe Esposito      *
152ebc2752bSEmanuele Giuseppe Esposito      *  - Return status 0 of .bdrv_co_block_status means that corresponding
153ebc2752bSEmanuele Giuseppe Esposito      *    blocks are not allocated in this layer of backing-chain
154ebc2752bSEmanuele Giuseppe Esposito      *  - For such (unallocated) blocks, read will:
155ebc2752bSEmanuele Giuseppe Esposito      *    - fill buffer with zeros if there is no backing file
156ebc2752bSEmanuele Giuseppe Esposito      *    - read from the backing file otherwise, where the block layer
157ebc2752bSEmanuele Giuseppe Esposito      *      takes care of reading zeros beyond EOF if backing file is short
158ebc2752bSEmanuele Giuseppe Esposito      */
159ebc2752bSEmanuele Giuseppe Esposito     bool supports_backing;
160ebc2752bSEmanuele Giuseppe Esposito 
16169c0bf11SEmanuele Giuseppe Esposito     /*
16269c0bf11SEmanuele Giuseppe Esposito      * Drivers setting this field must be able to work with just a plain
16369c0bf11SEmanuele Giuseppe Esposito      * filename with '<protocol_name>:' as a prefix, and no other options.
16469c0bf11SEmanuele Giuseppe Esposito      * Options may be extracted from the filename by implementing
16569c0bf11SEmanuele Giuseppe Esposito      * bdrv_parse_filename.
16669c0bf11SEmanuele Giuseppe Esposito      */
16769c0bf11SEmanuele Giuseppe Esposito     const char *protocol_name;
16869c0bf11SEmanuele Giuseppe Esposito 
16969c0bf11SEmanuele Giuseppe Esposito     /* List of options for creating images, terminated by name == NULL */
17069c0bf11SEmanuele Giuseppe Esposito     QemuOptsList *create_opts;
17169c0bf11SEmanuele Giuseppe Esposito 
17269c0bf11SEmanuele Giuseppe Esposito     /* List of options for image amend */
17369c0bf11SEmanuele Giuseppe Esposito     QemuOptsList *amend_opts;
17469c0bf11SEmanuele Giuseppe Esposito 
17569c0bf11SEmanuele Giuseppe Esposito     /*
17669c0bf11SEmanuele Giuseppe Esposito      * If this driver supports reopening images this contains a
17769c0bf11SEmanuele Giuseppe Esposito      * NULL-terminated list of the runtime options that can be
17869c0bf11SEmanuele Giuseppe Esposito      * modified. If an option in this list is unspecified during
17969c0bf11SEmanuele Giuseppe Esposito      * reopen then it _must_ be reset to its default value or return
18069c0bf11SEmanuele Giuseppe Esposito      * an error.
18169c0bf11SEmanuele Giuseppe Esposito      */
18269c0bf11SEmanuele Giuseppe Esposito     const char *const *mutable_opts;
18369c0bf11SEmanuele Giuseppe Esposito 
18469c0bf11SEmanuele Giuseppe Esposito     /*
18569c0bf11SEmanuele Giuseppe Esposito      * Pointer to a NULL-terminated array of names of strong options
18669c0bf11SEmanuele Giuseppe Esposito      * that can be specified for bdrv_open(). A strong option is one
18769c0bf11SEmanuele Giuseppe Esposito      * that changes the data of a BDS.
18869c0bf11SEmanuele Giuseppe Esposito      * If this pointer is NULL, the array is considered empty.
18969c0bf11SEmanuele Giuseppe Esposito      * "filename" and "driver" are always considered strong.
19069c0bf11SEmanuele Giuseppe Esposito      */
19169c0bf11SEmanuele Giuseppe Esposito     const char *const *strong_runtime_opts;
19269c0bf11SEmanuele Giuseppe Esposito 
19369c0bf11SEmanuele Giuseppe Esposito 
19469c0bf11SEmanuele Giuseppe Esposito     /*
19569c0bf11SEmanuele Giuseppe Esposito      * Global state (GS) API. These functions run under the BQL.
19669c0bf11SEmanuele Giuseppe Esposito      *
19769c0bf11SEmanuele Giuseppe Esposito      * See include/block/block-global-state.h for more information about
19869c0bf11SEmanuele Giuseppe Esposito      * the GS API.
19969c0bf11SEmanuele Giuseppe Esposito      */
20069c0bf11SEmanuele Giuseppe Esposito 
20169c0bf11SEmanuele Giuseppe Esposito     /*
20269c0bf11SEmanuele Giuseppe Esposito      * This function is invoked under BQL before .bdrv_co_amend()
20369c0bf11SEmanuele Giuseppe Esposito      * (which in contrast does not necessarily run under the BQL)
20469c0bf11SEmanuele Giuseppe Esposito      * to allow driver-specific initialization code that requires
20569c0bf11SEmanuele Giuseppe Esposito      * the BQL, like setting up specific permission flags.
20669c0bf11SEmanuele Giuseppe Esposito      */
207840428a2SEmanuele Giuseppe Esposito     int GRAPH_RDLOCK_PTR (*bdrv_amend_pre_run)(
208840428a2SEmanuele Giuseppe Esposito         BlockDriverState *bs, Error **errp);
20969c0bf11SEmanuele Giuseppe Esposito     /*
21069c0bf11SEmanuele Giuseppe Esposito      * This function is invoked under BQL after .bdrv_co_amend()
21169c0bf11SEmanuele Giuseppe Esposito      * to allow cleaning up what was done in .bdrv_amend_pre_run().
21269c0bf11SEmanuele Giuseppe Esposito      */
213840428a2SEmanuele Giuseppe Esposito     void GRAPH_RDLOCK_PTR (*bdrv_amend_clean)(BlockDriverState *bs);
21469c0bf11SEmanuele Giuseppe Esposito 
21569c0bf11SEmanuele Giuseppe Esposito     /*
21669c0bf11SEmanuele Giuseppe Esposito      * Return true if @to_replace can be replaced by a BDS with the
21769c0bf11SEmanuele Giuseppe Esposito      * same data as @bs without it affecting @bs's behavior (that is,
21869c0bf11SEmanuele Giuseppe Esposito      * without it being visible to @bs's parents).
21969c0bf11SEmanuele Giuseppe Esposito      */
220533c6e4eSKevin Wolf     bool GRAPH_RDLOCK_PTR (*bdrv_recurse_can_replace)(
221533c6e4eSKevin Wolf         BlockDriverState *bs, BlockDriverState *to_replace);
22269c0bf11SEmanuele Giuseppe Esposito 
22369c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_probe_device)(const char *filename);
22469c0bf11SEmanuele Giuseppe Esposito 
22569c0bf11SEmanuele Giuseppe Esposito     /*
22669c0bf11SEmanuele Giuseppe Esposito      * Any driver implementing this callback is expected to be able to handle
22769c0bf11SEmanuele Giuseppe Esposito      * NULL file names in its .bdrv_open() implementation.
22869c0bf11SEmanuele Giuseppe Esposito      */
22969c0bf11SEmanuele Giuseppe Esposito     void (*bdrv_parse_filename)(const char *filename, QDict *options,
23069c0bf11SEmanuele Giuseppe Esposito                                 Error **errp);
23169c0bf11SEmanuele Giuseppe Esposito 
23269c0bf11SEmanuele Giuseppe Esposito     /* For handling image reopen for split or non-split files. */
233ebc2752bSEmanuele Giuseppe Esposito     int (*bdrv_reopen_prepare)(BDRVReopenState *reopen_state,
234ebc2752bSEmanuele Giuseppe Esposito                                BlockReopenQueue *queue, Error **errp);
235ebc2752bSEmanuele Giuseppe Esposito     void (*bdrv_reopen_commit)(BDRVReopenState *reopen_state);
236ebc2752bSEmanuele Giuseppe Esposito     void (*bdrv_reopen_commit_post)(BDRVReopenState *reopen_state);
237ebc2752bSEmanuele Giuseppe Esposito     void (*bdrv_reopen_abort)(BDRVReopenState *reopen_state);
238ebc2752bSEmanuele Giuseppe Esposito     void (*bdrv_join_options)(QDict *options, QDict *old_options);
239ebc2752bSEmanuele Giuseppe Esposito 
2401a30b0f5SKevin Wolf     int GRAPH_UNLOCKED_PTR (*bdrv_open)(
2411a30b0f5SKevin Wolf         BlockDriverState *bs, QDict *options, int flags, Error **errp);
242ebc2752bSEmanuele Giuseppe Esposito 
243ebc2752bSEmanuele Giuseppe Esposito     /* Protocol drivers should implement this instead of bdrv_open */
2441a30b0f5SKevin Wolf     int GRAPH_UNLOCKED_PTR (*bdrv_file_open)(
2451a30b0f5SKevin Wolf         BlockDriverState *bs, QDict *options, int flags, Error **errp);
246ebc2752bSEmanuele Giuseppe Esposito     void (*bdrv_close)(BlockDriverState *bs);
247ebc2752bSEmanuele Giuseppe Esposito 
2484ec8df01SKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_create)(
2494ec8df01SKevin Wolf         BlockdevCreateOptions *opts, Error **errp);
2504ec8df01SKevin Wolf 
2514ec8df01SKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_create_opts)(
2524ec8df01SKevin Wolf         BlockDriver *drv, const char *filename, QemuOpts *opts, Error **errp);
253ebc2752bSEmanuele Giuseppe Esposito 
254ebc2752bSEmanuele Giuseppe Esposito     int (*bdrv_amend_options)(BlockDriverState *bs,
255ebc2752bSEmanuele Giuseppe Esposito                               QemuOpts *opts,
256ebc2752bSEmanuele Giuseppe Esposito                               BlockDriverAmendStatusCB *status_cb,
257ebc2752bSEmanuele Giuseppe Esposito                               void *cb_opaque,
258ebc2752bSEmanuele Giuseppe Esposito                               bool force,
259ebc2752bSEmanuele Giuseppe Esposito                               Error **errp);
260ebc2752bSEmanuele Giuseppe Esposito 
261ebc2752bSEmanuele Giuseppe Esposito     int (*bdrv_make_empty)(BlockDriverState *bs);
262ebc2752bSEmanuele Giuseppe Esposito 
263ebc2752bSEmanuele Giuseppe Esposito     /*
264ebc2752bSEmanuele Giuseppe Esposito      * Refreshes the bs->exact_filename field. If that is impossible,
265ebc2752bSEmanuele Giuseppe Esposito      * bs->exact_filename has to be left empty.
266ebc2752bSEmanuele Giuseppe Esposito      */
267ebc2752bSEmanuele Giuseppe Esposito     void (*bdrv_refresh_filename)(BlockDriverState *bs);
268ebc2752bSEmanuele Giuseppe Esposito 
269ebc2752bSEmanuele Giuseppe Esposito     /*
270ebc2752bSEmanuele Giuseppe Esposito      * Gathers the open options for all children into @target.
271ebc2752bSEmanuele Giuseppe Esposito      * A simple format driver (without backing file support) might
272ebc2752bSEmanuele Giuseppe Esposito      * implement this function like this:
273ebc2752bSEmanuele Giuseppe Esposito      *
274ebc2752bSEmanuele Giuseppe Esposito      *     QINCREF(bs->file->bs->full_open_options);
275ebc2752bSEmanuele Giuseppe Esposito      *     qdict_put(target, "file", bs->file->bs->full_open_options);
276ebc2752bSEmanuele Giuseppe Esposito      *
277ebc2752bSEmanuele Giuseppe Esposito      * If not specified, the generic implementation will simply put
278ebc2752bSEmanuele Giuseppe Esposito      * all children's options under their respective name.
279ebc2752bSEmanuele Giuseppe Esposito      *
280ebc2752bSEmanuele Giuseppe Esposito      * @backing_overridden is true when bs->backing seems not to be
281ebc2752bSEmanuele Giuseppe Esposito      * the child that would result from opening bs->backing_file.
282ebc2752bSEmanuele Giuseppe Esposito      * Therefore, if it is true, the backing child's options should be
283ebc2752bSEmanuele Giuseppe Esposito      * gathered; otherwise, there is no need since the backing child
284ebc2752bSEmanuele Giuseppe Esposito      * is the one implied by the image header.
285ebc2752bSEmanuele Giuseppe Esposito      *
286ebc2752bSEmanuele Giuseppe Esposito      * Note that ideally this function would not be needed.  Every
287ebc2752bSEmanuele Giuseppe Esposito      * block driver which implements it is probably doing something
288ebc2752bSEmanuele Giuseppe Esposito      * shady regarding its runtime option structure.
289ebc2752bSEmanuele Giuseppe Esposito      */
290ebc2752bSEmanuele Giuseppe Esposito     void (*bdrv_gather_child_options)(BlockDriverState *bs, QDict *target,
291ebc2752bSEmanuele Giuseppe Esposito                                       bool backing_overridden);
292ebc2752bSEmanuele Giuseppe Esposito 
293ebc2752bSEmanuele Giuseppe Esposito     /*
294ebc2752bSEmanuele Giuseppe Esposito      * Returns an allocated string which is the directory name of this BDS: It
295ebc2752bSEmanuele Giuseppe Esposito      * will be used to make relative filenames absolute by prepending this
296ebc2752bSEmanuele Giuseppe Esposito      * function's return value to them.
297ebc2752bSEmanuele Giuseppe Esposito      */
298ebc2752bSEmanuele Giuseppe Esposito     char *(*bdrv_dirname)(BlockDriverState *bs, Error **errp);
299ebc2752bSEmanuele Giuseppe Esposito 
30069c0bf11SEmanuele Giuseppe Esposito     /*
30169c0bf11SEmanuele Giuseppe Esposito      * This informs the driver that we are no longer interested in the result
30269c0bf11SEmanuele Giuseppe Esposito      * of in-flight requests, so don't waste the time if possible.
30369c0bf11SEmanuele Giuseppe Esposito      *
30469c0bf11SEmanuele Giuseppe Esposito      * One example usage is to avoid waiting for an nbd target node reconnect
30569c0bf11SEmanuele Giuseppe Esposito      * timeout during job-cancel with force=true.
30669c0bf11SEmanuele Giuseppe Esposito      */
30769c0bf11SEmanuele Giuseppe Esposito     void (*bdrv_cancel_in_flight)(BlockDriverState *bs);
30869c0bf11SEmanuele Giuseppe Esposito 
30969c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_inactivate)(BlockDriverState *bs);
31069c0bf11SEmanuele Giuseppe Esposito 
31169c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_snapshot_create)(BlockDriverState *bs,
31269c0bf11SEmanuele Giuseppe Esposito                                 QEMUSnapshotInfo *sn_info);
31369c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_snapshot_goto)(BlockDriverState *bs,
31469c0bf11SEmanuele Giuseppe Esposito                               const char *snapshot_id);
31569c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_snapshot_delete)(BlockDriverState *bs,
31669c0bf11SEmanuele Giuseppe Esposito                                 const char *snapshot_id,
31769c0bf11SEmanuele Giuseppe Esposito                                 const char *name,
31869c0bf11SEmanuele Giuseppe Esposito                                 Error **errp);
31969c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_snapshot_list)(BlockDriverState *bs,
32069c0bf11SEmanuele Giuseppe Esposito                               QEMUSnapshotInfo **psn_info);
32169c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
32269c0bf11SEmanuele Giuseppe Esposito                                   const char *snapshot_id,
32369c0bf11SEmanuele Giuseppe Esposito                                   const char *name,
32469c0bf11SEmanuele Giuseppe Esposito                                   Error **errp);
32569c0bf11SEmanuele Giuseppe Esposito 
32669c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_change_backing_file)(BlockDriverState *bs,
32769c0bf11SEmanuele Giuseppe Esposito         const char *backing_file, const char *backing_fmt);
32869c0bf11SEmanuele Giuseppe Esposito 
32969c0bf11SEmanuele Giuseppe Esposito     /* TODO Better pass a option string/QDict/QemuOpts to add any rule? */
33069c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_debug_breakpoint)(BlockDriverState *bs, const char *event,
33169c0bf11SEmanuele Giuseppe Esposito         const char *tag);
33269c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_debug_remove_breakpoint)(BlockDriverState *bs,
33369c0bf11SEmanuele Giuseppe Esposito         const char *tag);
33469c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_debug_resume)(BlockDriverState *bs, const char *tag);
33569c0bf11SEmanuele Giuseppe Esposito     bool (*bdrv_debug_is_suspended)(BlockDriverState *bs, const char *tag);
33669c0bf11SEmanuele Giuseppe Esposito 
33769c0bf11SEmanuele Giuseppe Esposito     void (*bdrv_refresh_limits)(BlockDriverState *bs, Error **errp);
33869c0bf11SEmanuele Giuseppe Esposito 
33969c0bf11SEmanuele Giuseppe Esposito     /*
34069c0bf11SEmanuele Giuseppe Esposito      * Returns 1 if newly created images are guaranteed to contain only
34169c0bf11SEmanuele Giuseppe Esposito      * zeros, 0 otherwise.
34269c0bf11SEmanuele Giuseppe Esposito      */
34369c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_has_zero_init)(BlockDriverState *bs);
34469c0bf11SEmanuele Giuseppe Esposito 
34569c0bf11SEmanuele Giuseppe Esposito     /*
34669c0bf11SEmanuele Giuseppe Esposito      * Remove fd handlers, timers, and other event loop callbacks so the event
34769c0bf11SEmanuele Giuseppe Esposito      * loop is no longer in use.  Called with no in-flight requests and in
34869c0bf11SEmanuele Giuseppe Esposito      * depth-first traversal order with parents before child nodes.
34969c0bf11SEmanuele Giuseppe Esposito      */
35069c0bf11SEmanuele Giuseppe Esposito     void (*bdrv_detach_aio_context)(BlockDriverState *bs);
35169c0bf11SEmanuele Giuseppe Esposito 
35269c0bf11SEmanuele Giuseppe Esposito     /*
35369c0bf11SEmanuele Giuseppe Esposito      * Add fd handlers, timers, and other event loop callbacks so I/O requests
35469c0bf11SEmanuele Giuseppe Esposito      * can be processed again.  Called with no in-flight requests and in
35569c0bf11SEmanuele Giuseppe Esposito      * depth-first traversal order with child nodes before parent nodes.
35669c0bf11SEmanuele Giuseppe Esposito      */
35769c0bf11SEmanuele Giuseppe Esposito     void (*bdrv_attach_aio_context)(BlockDriverState *bs,
35869c0bf11SEmanuele Giuseppe Esposito                                     AioContext *new_context);
35969c0bf11SEmanuele Giuseppe Esposito 
36069c0bf11SEmanuele Giuseppe Esposito     /**
36169c0bf11SEmanuele Giuseppe Esposito      * Try to get @bs's logical and physical block size.
36269c0bf11SEmanuele Giuseppe Esposito      * On success, store them in @bsz and return zero.
36369c0bf11SEmanuele Giuseppe Esposito      * On failure, return negative errno.
36469c0bf11SEmanuele Giuseppe Esposito      */
36569c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_probe_blocksizes)(BlockDriverState *bs, BlockSizes *bsz);
36669c0bf11SEmanuele Giuseppe Esposito     /**
36769c0bf11SEmanuele Giuseppe Esposito      * Try to get @bs's geometry (cyls, heads, sectors)
36869c0bf11SEmanuele Giuseppe Esposito      * On success, store them in @geo and return 0.
36969c0bf11SEmanuele Giuseppe Esposito      * On failure return -errno.
37069c0bf11SEmanuele Giuseppe Esposito      * Only drivers that want to override guest geometry implement this
37169c0bf11SEmanuele Giuseppe Esposito      * callback; see hd_geometry_guess().
37269c0bf11SEmanuele Giuseppe Esposito      */
37369c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_probe_geometry)(BlockDriverState *bs, HDGeometry *geo);
37469c0bf11SEmanuele Giuseppe Esposito 
37569c0bf11SEmanuele Giuseppe Esposito     void (*bdrv_add_child)(BlockDriverState *parent, BlockDriverState *child,
37669c0bf11SEmanuele Giuseppe Esposito                            Error **errp);
37769c0bf11SEmanuele Giuseppe Esposito     void (*bdrv_del_child)(BlockDriverState *parent, BdrvChild *child,
37869c0bf11SEmanuele Giuseppe Esposito                            Error **errp);
37969c0bf11SEmanuele Giuseppe Esposito 
38069c0bf11SEmanuele Giuseppe Esposito     /**
38169c0bf11SEmanuele Giuseppe Esposito      * Informs the block driver that a permission change is intended. The
38269c0bf11SEmanuele Giuseppe Esposito      * driver checks whether the change is permissible and may take other
38369c0bf11SEmanuele Giuseppe Esposito      * preparations for the change (e.g. get file system locks). This operation
38469c0bf11SEmanuele Giuseppe Esposito      * is always followed either by a call to either .bdrv_set_perm or
38569c0bf11SEmanuele Giuseppe Esposito      * .bdrv_abort_perm_update.
38669c0bf11SEmanuele Giuseppe Esposito      *
38769c0bf11SEmanuele Giuseppe Esposito      * Checks whether the requested set of cumulative permissions in @perm
38869c0bf11SEmanuele Giuseppe Esposito      * can be granted for accessing @bs and whether no other users are using
38969c0bf11SEmanuele Giuseppe Esposito      * permissions other than those given in @shared (both arguments take
39069c0bf11SEmanuele Giuseppe Esposito      * BLK_PERM_* bitmasks).
39169c0bf11SEmanuele Giuseppe Esposito      *
39269c0bf11SEmanuele Giuseppe Esposito      * If both conditions are met, 0 is returned. Otherwise, -errno is returned
39369c0bf11SEmanuele Giuseppe Esposito      * and errp is set to an error describing the conflict.
39469c0bf11SEmanuele Giuseppe Esposito      */
39569c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_check_perm)(BlockDriverState *bs, uint64_t perm,
39669c0bf11SEmanuele Giuseppe Esposito                            uint64_t shared, Error **errp);
39769c0bf11SEmanuele Giuseppe Esposito 
39869c0bf11SEmanuele Giuseppe Esposito     /**
39969c0bf11SEmanuele Giuseppe Esposito      * Called to inform the driver that the set of cumulative set of used
40069c0bf11SEmanuele Giuseppe Esposito      * permissions for @bs has changed to @perm, and the set of sharable
40169c0bf11SEmanuele Giuseppe Esposito      * permission to @shared. The driver can use this to propagate changes to
40269c0bf11SEmanuele Giuseppe Esposito      * its children (i.e. request permissions only if a parent actually needs
40369c0bf11SEmanuele Giuseppe Esposito      * them).
40469c0bf11SEmanuele Giuseppe Esposito      *
40569c0bf11SEmanuele Giuseppe Esposito      * This function is only invoked after bdrv_check_perm(), so block drivers
40669c0bf11SEmanuele Giuseppe Esposito      * may rely on preparations made in their .bdrv_check_perm implementation.
40769c0bf11SEmanuele Giuseppe Esposito      */
40869c0bf11SEmanuele Giuseppe Esposito     void (*bdrv_set_perm)(BlockDriverState *bs, uint64_t perm, uint64_t shared);
40969c0bf11SEmanuele Giuseppe Esposito 
41069c0bf11SEmanuele Giuseppe Esposito     /*
41169c0bf11SEmanuele Giuseppe Esposito      * Called to inform the driver that after a previous bdrv_check_perm()
41269c0bf11SEmanuele Giuseppe Esposito      * call, the permission update is not performed and any preparations made
41369c0bf11SEmanuele Giuseppe Esposito      * for it (e.g. taken file locks) need to be undone.
41469c0bf11SEmanuele Giuseppe Esposito      *
41569c0bf11SEmanuele Giuseppe Esposito      * This function can be called even for nodes that never saw a
41669c0bf11SEmanuele Giuseppe Esposito      * bdrv_check_perm() call. It is a no-op then.
41769c0bf11SEmanuele Giuseppe Esposito      */
41869c0bf11SEmanuele Giuseppe Esposito     void (*bdrv_abort_perm_update)(BlockDriverState *bs);
41969c0bf11SEmanuele Giuseppe Esposito 
42069c0bf11SEmanuele Giuseppe Esposito     /**
42169c0bf11SEmanuele Giuseppe Esposito      * Returns in @nperm and @nshared the permissions that the driver for @bs
42269c0bf11SEmanuele Giuseppe Esposito      * needs on its child @c, based on the cumulative permissions requested by
42369c0bf11SEmanuele Giuseppe Esposito      * the parents in @parent_perm and @parent_shared.
42469c0bf11SEmanuele Giuseppe Esposito      *
42569c0bf11SEmanuele Giuseppe Esposito      * If @c is NULL, return the permissions for attaching a new child for the
42669c0bf11SEmanuele Giuseppe Esposito      * given @child_class and @role.
42769c0bf11SEmanuele Giuseppe Esposito      *
42869c0bf11SEmanuele Giuseppe Esposito      * If @reopen_queue is non-NULL, don't return the currently needed
42969c0bf11SEmanuele Giuseppe Esposito      * permissions, but those that will be needed after applying the
43069c0bf11SEmanuele Giuseppe Esposito      * @reopen_queue.
43169c0bf11SEmanuele Giuseppe Esposito      */
43269c0bf11SEmanuele Giuseppe Esposito      void (*bdrv_child_perm)(BlockDriverState *bs, BdrvChild *c,
43369c0bf11SEmanuele Giuseppe Esposito                              BdrvChildRole role,
43469c0bf11SEmanuele Giuseppe Esposito                              BlockReopenQueue *reopen_queue,
43569c0bf11SEmanuele Giuseppe Esposito                              uint64_t parent_perm, uint64_t parent_shared,
43669c0bf11SEmanuele Giuseppe Esposito                              uint64_t *nperm, uint64_t *nshared);
43769c0bf11SEmanuele Giuseppe Esposito 
43869c0bf11SEmanuele Giuseppe Esposito     /**
43969c0bf11SEmanuele Giuseppe Esposito      * Register/unregister a buffer for I/O. For example, when the driver is
44069c0bf11SEmanuele Giuseppe Esposito      * interested to know the memory areas that will later be used in iovs, so
44169c0bf11SEmanuele Giuseppe Esposito      * that it can do IOMMU mapping with VFIO etc., in order to get better
44269c0bf11SEmanuele Giuseppe Esposito      * performance. In the case of VFIO drivers, this callback is used to do
44369c0bf11SEmanuele Giuseppe Esposito      * DMA mapping for hot buffers.
444f4ec04baSStefan Hajnoczi      *
445f4ec04baSStefan Hajnoczi      * Returns: true on success, false on failure
44669c0bf11SEmanuele Giuseppe Esposito      */
447d9249c25SKevin Wolf     bool GRAPH_RDLOCK_PTR (*bdrv_register_buf)(
448d9249c25SKevin Wolf         BlockDriverState *bs, void *host, size_t size, Error **errp);
449d9249c25SKevin Wolf     void GRAPH_RDLOCK_PTR (*bdrv_unregister_buf)(
450d9249c25SKevin Wolf         BlockDriverState *bs, void *host, size_t size);
45169c0bf11SEmanuele Giuseppe Esposito 
45269c0bf11SEmanuele Giuseppe Esposito     /*
45369c0bf11SEmanuele Giuseppe Esposito      * This field is modified only under the BQL, and is part of
45469c0bf11SEmanuele Giuseppe Esposito      * the global state.
45569c0bf11SEmanuele Giuseppe Esposito      */
45669c0bf11SEmanuele Giuseppe Esposito     QLIST_ENTRY(BlockDriver) list;
45769c0bf11SEmanuele Giuseppe Esposito 
45869c0bf11SEmanuele Giuseppe Esposito     /*
45969c0bf11SEmanuele Giuseppe Esposito      * I/O API functions. These functions are thread-safe.
46069c0bf11SEmanuele Giuseppe Esposito      *
46169c0bf11SEmanuele Giuseppe Esposito      * See include/block/block-io.h for more information about
46269c0bf11SEmanuele Giuseppe Esposito      * the I/O API.
46369c0bf11SEmanuele Giuseppe Esposito      */
46469c0bf11SEmanuele Giuseppe Esposito 
46569c0bf11SEmanuele Giuseppe Esposito     int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
46669c0bf11SEmanuele Giuseppe Esposito 
467840428a2SEmanuele Giuseppe Esposito     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_amend)(
468840428a2SEmanuele Giuseppe Esposito         BlockDriverState *bs, BlockdevAmendOptions *opts, bool force,
46969c0bf11SEmanuele Giuseppe Esposito         Error **errp);
47069c0bf11SEmanuele Giuseppe Esposito 
471ebc2752bSEmanuele Giuseppe Esposito     /* aio */
4727b1fb72eSKevin Wolf     BlockAIOCB * GRAPH_RDLOCK_PTR (*bdrv_aio_preadv)(BlockDriverState *bs,
473ebc2752bSEmanuele Giuseppe Esposito         int64_t offset, int64_t bytes, QEMUIOVector *qiov,
474ebc2752bSEmanuele Giuseppe Esposito         BdrvRequestFlags flags, BlockCompletionFunc *cb, void *opaque);
4757b1fb72eSKevin Wolf 
4767b1fb72eSKevin Wolf     BlockAIOCB * GRAPH_RDLOCK_PTR (*bdrv_aio_pwritev)(BlockDriverState *bs,
477ebc2752bSEmanuele Giuseppe Esposito         int64_t offset, int64_t bytes, QEMUIOVector *qiov,
478ebc2752bSEmanuele Giuseppe Esposito         BdrvRequestFlags flags, BlockCompletionFunc *cb, void *opaque);
4797b1fb72eSKevin Wolf 
48088095349SEmanuele Giuseppe Esposito     BlockAIOCB * GRAPH_RDLOCK_PTR (*bdrv_aio_flush)(
48188095349SEmanuele Giuseppe Esposito         BlockDriverState *bs, BlockCompletionFunc *cb, void *opaque);
4829a5a1c62SEmanuele Giuseppe Esposito 
4839a5a1c62SEmanuele Giuseppe Esposito     BlockAIOCB * GRAPH_RDLOCK_PTR (*bdrv_aio_pdiscard)(
4849a5a1c62SEmanuele Giuseppe Esposito         BlockDriverState *bs, int64_t offset, int bytes,
485ebc2752bSEmanuele Giuseppe Esposito         BlockCompletionFunc *cb, void *opaque);
486ebc2752bSEmanuele Giuseppe Esposito 
4877b1fb72eSKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_readv)(BlockDriverState *bs,
488ebc2752bSEmanuele Giuseppe Esposito         int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
489ebc2752bSEmanuele Giuseppe Esposito 
490ebc2752bSEmanuele Giuseppe Esposito     /**
491ebc2752bSEmanuele Giuseppe Esposito      * @offset: position in bytes to read at
492ebc2752bSEmanuele Giuseppe Esposito      * @bytes: number of bytes to read
493ebc2752bSEmanuele Giuseppe Esposito      * @qiov: the buffers to fill with read data
494ebc2752bSEmanuele Giuseppe Esposito      * @flags: currently unused, always 0
495ebc2752bSEmanuele Giuseppe Esposito      *
496ebc2752bSEmanuele Giuseppe Esposito      * @offset and @bytes will be a multiple of 'request_alignment',
497ebc2752bSEmanuele Giuseppe Esposito      * but the length of individual @qiov elements does not have to
498ebc2752bSEmanuele Giuseppe Esposito      * be a multiple.
499ebc2752bSEmanuele Giuseppe Esposito      *
500ebc2752bSEmanuele Giuseppe Esposito      * @bytes will always equal the total size of @qiov, and will be
501ebc2752bSEmanuele Giuseppe Esposito      * no larger than 'max_transfer'.
502ebc2752bSEmanuele Giuseppe Esposito      *
503ebc2752bSEmanuele Giuseppe Esposito      * The buffer in @qiov may point directly to guest memory.
504ebc2752bSEmanuele Giuseppe Esposito      */
5057b1fb72eSKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_preadv)(BlockDriverState *bs,
506ebc2752bSEmanuele Giuseppe Esposito         int64_t offset, int64_t bytes, QEMUIOVector *qiov,
507ebc2752bSEmanuele Giuseppe Esposito         BdrvRequestFlags flags);
508ebc2752bSEmanuele Giuseppe Esposito 
5097b1fb72eSKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_preadv_part)(
5107b1fb72eSKevin Wolf         BlockDriverState *bs, int64_t offset, int64_t bytes,
511ebc2752bSEmanuele Giuseppe Esposito         QEMUIOVector *qiov, size_t qiov_offset,
512ebc2752bSEmanuele Giuseppe Esposito         BdrvRequestFlags flags);
513ebc2752bSEmanuele Giuseppe Esposito 
5147b1fb72eSKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_writev)(BlockDriverState *bs,
515ebc2752bSEmanuele Giuseppe Esposito         int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
516ebc2752bSEmanuele Giuseppe Esposito         int flags);
517ebc2752bSEmanuele Giuseppe Esposito     /**
518ebc2752bSEmanuele Giuseppe Esposito      * @offset: position in bytes to write at
519ebc2752bSEmanuele Giuseppe Esposito      * @bytes: number of bytes to write
520ebc2752bSEmanuele Giuseppe Esposito      * @qiov: the buffers containing data to write
521ebc2752bSEmanuele Giuseppe Esposito      * @flags: zero or more bits allowed by 'supported_write_flags'
522ebc2752bSEmanuele Giuseppe Esposito      *
523ebc2752bSEmanuele Giuseppe Esposito      * @offset and @bytes will be a multiple of 'request_alignment',
524ebc2752bSEmanuele Giuseppe Esposito      * but the length of individual @qiov elements does not have to
525ebc2752bSEmanuele Giuseppe Esposito      * be a multiple.
526ebc2752bSEmanuele Giuseppe Esposito      *
527ebc2752bSEmanuele Giuseppe Esposito      * @bytes will always equal the total size of @qiov, and will be
528ebc2752bSEmanuele Giuseppe Esposito      * no larger than 'max_transfer'.
529ebc2752bSEmanuele Giuseppe Esposito      *
530ebc2752bSEmanuele Giuseppe Esposito      * The buffer in @qiov may point directly to guest memory.
531ebc2752bSEmanuele Giuseppe Esposito      */
5327b1fb72eSKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pwritev)(
5337b1fb72eSKevin Wolf         BlockDriverState *bs, int64_t offset, int64_t bytes, QEMUIOVector *qiov,
534ebc2752bSEmanuele Giuseppe Esposito         BdrvRequestFlags flags);
5357b1fb72eSKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pwritev_part)(
5367b1fb72eSKevin Wolf         BlockDriverState *bs, int64_t offset, int64_t bytes, QEMUIOVector *qiov,
5377b1fb72eSKevin Wolf         size_t qiov_offset, BdrvRequestFlags flags);
538ebc2752bSEmanuele Giuseppe Esposito 
539ebc2752bSEmanuele Giuseppe Esposito     /*
540ebc2752bSEmanuele Giuseppe Esposito      * Efficiently zero a region of the disk image.  Typically an image format
541ebc2752bSEmanuele Giuseppe Esposito      * would use a compact metadata representation to implement this.  This
542ebc2752bSEmanuele Giuseppe Esposito      * function pointer may be NULL or return -ENOSUP and .bdrv_co_writev()
543ebc2752bSEmanuele Giuseppe Esposito      * will be called instead.
544ebc2752bSEmanuele Giuseppe Esposito      */
545abaf8b75SKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pwrite_zeroes)(
546abaf8b75SKevin Wolf         BlockDriverState *bs, int64_t offset, int64_t bytes,
547abaf8b75SKevin Wolf         BdrvRequestFlags flags);
5489a5a1c62SEmanuele Giuseppe Esposito 
5499a5a1c62SEmanuele Giuseppe Esposito     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pdiscard)(
5509a5a1c62SEmanuele Giuseppe Esposito         BlockDriverState *bs, int64_t offset, int64_t bytes);
551ebc2752bSEmanuele Giuseppe Esposito 
552ebc2752bSEmanuele Giuseppe Esposito     /*
553ebc2752bSEmanuele Giuseppe Esposito      * Map [offset, offset + nbytes) range onto a child of @bs to copy from,
554ebc2752bSEmanuele Giuseppe Esposito      * and invoke bdrv_co_copy_range_from(child, ...), or invoke
555ebc2752bSEmanuele Giuseppe Esposito      * bdrv_co_copy_range_to() if @bs is the leaf child to copy data from.
556ebc2752bSEmanuele Giuseppe Esposito      *
557ebc2752bSEmanuele Giuseppe Esposito      * See the comment of bdrv_co_copy_range for the parameter and return value
558ebc2752bSEmanuele Giuseppe Esposito      * semantics.
559ebc2752bSEmanuele Giuseppe Esposito      */
560742bf09bSEmanuele Giuseppe Esposito     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_copy_range_from)(
561742bf09bSEmanuele Giuseppe Esposito         BlockDriverState *bs, BdrvChild *src, int64_t offset,
562742bf09bSEmanuele Giuseppe Esposito         BdrvChild *dst, int64_t dst_offset, int64_t bytes,
563742bf09bSEmanuele Giuseppe Esposito         BdrvRequestFlags read_flags, BdrvRequestFlags write_flags);
564ebc2752bSEmanuele Giuseppe Esposito 
565ebc2752bSEmanuele Giuseppe Esposito     /*
566ebc2752bSEmanuele Giuseppe Esposito      * Map [offset, offset + nbytes) range onto a child of bs to copy data to,
567ebc2752bSEmanuele Giuseppe Esposito      * and invoke bdrv_co_copy_range_to(child, src, ...), or perform the copy
568ebc2752bSEmanuele Giuseppe Esposito      * operation if @bs is the leaf and @src has the same BlockDriver.  Return
569ebc2752bSEmanuele Giuseppe Esposito      * -ENOTSUP if @bs is the leaf but @src has a different BlockDriver.
570ebc2752bSEmanuele Giuseppe Esposito      *
571ebc2752bSEmanuele Giuseppe Esposito      * See the comment of bdrv_co_copy_range for the parameter and return value
572ebc2752bSEmanuele Giuseppe Esposito      * semantics.
573ebc2752bSEmanuele Giuseppe Esposito      */
574742bf09bSEmanuele Giuseppe Esposito     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_copy_range_to)(
575742bf09bSEmanuele Giuseppe Esposito         BlockDriverState *bs, BdrvChild *src, int64_t src_offset,
576742bf09bSEmanuele Giuseppe Esposito         BdrvChild *dst, int64_t dst_offset, int64_t bytes,
577742bf09bSEmanuele Giuseppe Esposito         BdrvRequestFlags read_flags, BdrvRequestFlags write_flags);
578ebc2752bSEmanuele Giuseppe Esposito 
579ebc2752bSEmanuele Giuseppe Esposito     /*
580ebc2752bSEmanuele Giuseppe Esposito      * Building block for bdrv_block_status[_above] and
581ebc2752bSEmanuele Giuseppe Esposito      * bdrv_is_allocated[_above].  The driver should answer only
582ebc2752bSEmanuele Giuseppe Esposito      * according to the current layer, and should only need to set
583ebc2752bSEmanuele Giuseppe Esposito      * BDRV_BLOCK_DATA, BDRV_BLOCK_ZERO, BDRV_BLOCK_OFFSET_VALID,
584ebc2752bSEmanuele Giuseppe Esposito      * and/or BDRV_BLOCK_RAW; if the current layer defers to a backing
585ebc2752bSEmanuele Giuseppe Esposito      * layer, the result should be 0 (and not BDRV_BLOCK_ZERO).  See
586ebc2752bSEmanuele Giuseppe Esposito      * block.h for the overall meaning of the bits.  As a hint, the
587ebc2752bSEmanuele Giuseppe Esposito      * flag want_zero is true if the caller cares more about precise
588ebc2752bSEmanuele Giuseppe Esposito      * mappings (favor accurate _OFFSET_VALID/_ZERO) or false for
589ebc2752bSEmanuele Giuseppe Esposito      * overall allocation (favor larger *pnum, perhaps by reporting
590ebc2752bSEmanuele Giuseppe Esposito      * _DATA instead of _ZERO).  The block layer guarantees input
591ebc2752bSEmanuele Giuseppe Esposito      * clamped to bdrv_getlength() and aligned to request_alignment,
592ebc2752bSEmanuele Giuseppe Esposito      * as well as non-NULL pnum, map, and file; in turn, the driver
593ebc2752bSEmanuele Giuseppe Esposito      * must return an error or set pnum to an aligned non-zero value.
594ebc2752bSEmanuele Giuseppe Esposito      *
595ebc2752bSEmanuele Giuseppe Esposito      * Note that @bytes is just a hint on how big of a region the
596ebc2752bSEmanuele Giuseppe Esposito      * caller wants to inspect.  It is not a limit on *pnum.
597ebc2752bSEmanuele Giuseppe Esposito      * Implementations are free to return larger values of *pnum if
598ebc2752bSEmanuele Giuseppe Esposito      * doing so does not incur a performance penalty.
599ebc2752bSEmanuele Giuseppe Esposito      *
600ebc2752bSEmanuele Giuseppe Esposito      * block/io.c's bdrv_co_block_status() will utilize an unclamped
601ebc2752bSEmanuele Giuseppe Esposito      * *pnum value for the block-status cache on protocol nodes, prior
602ebc2752bSEmanuele Giuseppe Esposito      * to clamping *pnum for return to its caller.
603ebc2752bSEmanuele Giuseppe Esposito      */
6047ff9579eSKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_block_status)(
6057ff9579eSKevin Wolf         BlockDriverState *bs,
606ebc2752bSEmanuele Giuseppe Esposito         bool want_zero, int64_t offset, int64_t bytes, int64_t *pnum,
607ebc2752bSEmanuele Giuseppe Esposito         int64_t *map, BlockDriverState **file);
608ebc2752bSEmanuele Giuseppe Esposito 
609ebc2752bSEmanuele Giuseppe Esposito     /*
610ce14f3b4SVladimir Sementsov-Ogievskiy      * Snapshot-access API.
611ce14f3b4SVladimir Sementsov-Ogievskiy      *
612ce14f3b4SVladimir Sementsov-Ogievskiy      * Block-driver may provide snapshot-access API: special functions to access
613ce14f3b4SVladimir Sementsov-Ogievskiy      * some internal "snapshot". The functions are similar with normal
614ce14f3b4SVladimir Sementsov-Ogievskiy      * read/block_status/discard handler, but don't have any specific handling
615ce14f3b4SVladimir Sementsov-Ogievskiy      * in generic block-layer: no serializing, no alignment, no tracked
616ce14f3b4SVladimir Sementsov-Ogievskiy      * requests. So, block-driver that realizes these APIs is fully responsible
617ce14f3b4SVladimir Sementsov-Ogievskiy      * for synchronization between snapshot-access API and normal IO requests.
6181c14eaabSVladimir Sementsov-Ogievskiy      *
6191c14eaabSVladimir Sementsov-Ogievskiy      * TODO: To be able to support qcow2's internal snapshots, this API will
6201c14eaabSVladimir Sementsov-Ogievskiy      * need to be extended to:
6211c14eaabSVladimir Sementsov-Ogievskiy      * - be able to select a specific snapshot
6221c14eaabSVladimir Sementsov-Ogievskiy      * - receive the snapshot's actual length (which may differ from bs's
6231c14eaabSVladimir Sementsov-Ogievskiy      *   length)
624ce14f3b4SVladimir Sementsov-Ogievskiy      */
6257b9e8b22SKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_preadv_snapshot)(
6267b9e8b22SKevin Wolf         BlockDriverState *bs, int64_t offset, int64_t bytes,
6277b9e8b22SKevin Wolf         QEMUIOVector *qiov, size_t qiov_offset);
6287b9e8b22SKevin Wolf 
6297b9e8b22SKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_snapshot_block_status)(
6307b9e8b22SKevin Wolf         BlockDriverState *bs, bool want_zero, int64_t offset, int64_t bytes,
6317b9e8b22SKevin Wolf         int64_t *pnum, int64_t *map, BlockDriverState **file);
6329a5a1c62SEmanuele Giuseppe Esposito 
6339a5a1c62SEmanuele Giuseppe Esposito     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pdiscard_snapshot)(
6349a5a1c62SEmanuele Giuseppe Esposito         BlockDriverState *bs, int64_t offset, int64_t bytes);
635ce14f3b4SVladimir Sementsov-Ogievskiy 
636ce14f3b4SVladimir Sementsov-Ogievskiy     /*
637ebc2752bSEmanuele Giuseppe Esposito      * Invalidate any cached meta-data.
638ebc2752bSEmanuele Giuseppe Esposito      */
6391b3ff9feSKevin Wolf     void coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_invalidate_cache)(
6401b3ff9feSKevin Wolf         BlockDriverState *bs, Error **errp);
641ebc2752bSEmanuele Giuseppe Esposito 
642ebc2752bSEmanuele Giuseppe Esposito     /*
643ebc2752bSEmanuele Giuseppe Esposito      * Flushes all data for all layers by calling bdrv_co_flush for underlying
644ebc2752bSEmanuele Giuseppe Esposito      * layers, if needed. This function is needed for deterministic
645ebc2752bSEmanuele Giuseppe Esposito      * synchronization of the flush finishing callback.
646ebc2752bSEmanuele Giuseppe Esposito      */
64788095349SEmanuele Giuseppe Esposito     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_flush)(BlockDriverState *bs);
648ebc2752bSEmanuele Giuseppe Esposito 
649ebc2752bSEmanuele Giuseppe Esposito     /* Delete a created file. */
65048aef794SKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_delete_file)(
65148aef794SKevin Wolf         BlockDriverState *bs, Error **errp);
652ebc2752bSEmanuele Giuseppe Esposito 
653ebc2752bSEmanuele Giuseppe Esposito     /*
654ebc2752bSEmanuele Giuseppe Esposito      * Flushes all data that was already written to the OS all the way down to
655ebc2752bSEmanuele Giuseppe Esposito      * the disk (for example file-posix.c calls fsync()).
656ebc2752bSEmanuele Giuseppe Esposito      */
65788095349SEmanuele Giuseppe Esposito     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_flush_to_disk)(
65888095349SEmanuele Giuseppe Esposito         BlockDriverState *bs);
659ebc2752bSEmanuele Giuseppe Esposito 
660ebc2752bSEmanuele Giuseppe Esposito     /*
661ebc2752bSEmanuele Giuseppe Esposito      * Flushes all internal caches to the OS. The data may still sit in a
662ebc2752bSEmanuele Giuseppe Esposito      * writeback cache of the host OS, but it will survive a crash of the qemu
663ebc2752bSEmanuele Giuseppe Esposito      * process.
664ebc2752bSEmanuele Giuseppe Esposito      */
66588095349SEmanuele Giuseppe Esposito     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_flush_to_os)(
66688095349SEmanuele Giuseppe Esposito         BlockDriverState *bs);
667ebc2752bSEmanuele Giuseppe Esposito 
668ebc2752bSEmanuele Giuseppe Esposito     /*
669ebc2752bSEmanuele Giuseppe Esposito      * Truncate @bs to @offset bytes using the given @prealloc mode
670ebc2752bSEmanuele Giuseppe Esposito      * when growing.  Modes other than PREALLOC_MODE_OFF should be
671ebc2752bSEmanuele Giuseppe Esposito      * rejected when shrinking @bs.
672ebc2752bSEmanuele Giuseppe Esposito      *
673ebc2752bSEmanuele Giuseppe Esposito      * If @exact is true, @bs must be resized to exactly @offset.
674ebc2752bSEmanuele Giuseppe Esposito      * Otherwise, it is sufficient for @bs (if it is a host block
675ebc2752bSEmanuele Giuseppe Esposito      * device and thus there is no way to resize it) to be at least
676ebc2752bSEmanuele Giuseppe Esposito      * @offset bytes in length.
677ebc2752bSEmanuele Giuseppe Esposito      *
678ebc2752bSEmanuele Giuseppe Esposito      * If @exact is true and this function fails but would succeed
679ebc2752bSEmanuele Giuseppe Esposito      * with @exact = false, it should return -ENOTSUP.
680ebc2752bSEmanuele Giuseppe Esposito      */
681c2b8e315SKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_truncate)(
682c2b8e315SKevin Wolf         BlockDriverState *bs, int64_t offset, bool exact,
683c2b8e315SKevin Wolf         PreallocMode prealloc, BdrvRequestFlags flags, Error **errp);
684c2b8e315SKevin Wolf 
6858ab8140aSKevin Wolf     int64_t coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_getlength)(
6868ab8140aSKevin Wolf         BlockDriverState *bs);
6878ab8140aSKevin Wolf 
688de335638SEmanuele Giuseppe Esposito     int64_t coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_get_allocated_file_size)(
68982618d7bSEmanuele Giuseppe Esposito         BlockDriverState *bs);
69082618d7bSEmanuele Giuseppe Esposito 
691ebc2752bSEmanuele Giuseppe Esposito     BlockMeasureInfo *(*bdrv_measure)(QemuOpts *opts, BlockDriverState *in_bs,
692ebc2752bSEmanuele Giuseppe Esposito                                       Error **errp);
693ebc2752bSEmanuele Giuseppe Esposito 
6947b1fb72eSKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pwritev_compressed)(
6957b1fb72eSKevin Wolf         BlockDriverState *bs, int64_t offset, int64_t bytes,
6967b1fb72eSKevin Wolf         QEMUIOVector *qiov);
6977b1fb72eSKevin Wolf 
6987b1fb72eSKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_pwritev_compressed_part)(
6997b1fb72eSKevin Wolf         BlockDriverState *bs, int64_t offset, int64_t bytes,
7007b1fb72eSKevin Wolf         QEMUIOVector *qiov, size_t qiov_offset);
701ebc2752bSEmanuele Giuseppe Esposito 
702a00e70c0SEmanuele Giuseppe Esposito     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_get_info)(
703a00e70c0SEmanuele Giuseppe Esposito         BlockDriverState *bs, BlockDriverInfo *bdi);
704ebc2752bSEmanuele Giuseppe Esposito 
705ebc2752bSEmanuele Giuseppe Esposito     ImageInfoSpecific *(*bdrv_get_specific_info)(BlockDriverState *bs,
706ebc2752bSEmanuele Giuseppe Esposito                                                  Error **errp);
707ebc2752bSEmanuele Giuseppe Esposito     BlockStatsSpecific *(*bdrv_get_specific_stats)(BlockDriverState *bs);
708ebc2752bSEmanuele Giuseppe Esposito 
709ca5e2ad9SEmanuele Giuseppe Esposito     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_save_vmstate)(
7101b3ff9feSKevin Wolf         BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
7111b3ff9feSKevin Wolf 
712ca5e2ad9SEmanuele Giuseppe Esposito     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_load_vmstate)(
7131b3ff9feSKevin Wolf         BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
714ebc2752bSEmanuele Giuseppe Esposito 
715ebc2752bSEmanuele Giuseppe Esposito     /* removable device specific */
716c73ff92cSEmanuele Giuseppe Esposito     bool coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_is_inserted)(
717c73ff92cSEmanuele Giuseppe Esposito         BlockDriverState *bs);
71879a292e5SKevin Wolf     void coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_eject)(
71979a292e5SKevin Wolf         BlockDriverState *bs, bool eject_flag);
72079a292e5SKevin Wolf     void coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_lock_medium)(
72179a292e5SKevin Wolf         BlockDriverState *bs, bool locked);
722ebc2752bSEmanuele Giuseppe Esposito 
723ebc2752bSEmanuele Giuseppe Esposito     /* to control generic scsi devices */
72426c518abSKevin Wolf     BlockAIOCB *coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_aio_ioctl)(
72526c518abSKevin Wolf         BlockDriverState *bs, unsigned long int req, void *buf,
726ebc2752bSEmanuele Giuseppe Esposito         BlockCompletionFunc *cb, void *opaque);
72726c518abSKevin Wolf 
72826c518abSKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_ioctl)(
72926c518abSKevin Wolf         BlockDriverState *bs, unsigned long int req, void *buf);
730ebc2752bSEmanuele Giuseppe Esposito 
731ebc2752bSEmanuele Giuseppe Esposito     /*
732ebc2752bSEmanuele Giuseppe Esposito      * Returns 0 for completed check, -errno for internal errors.
733ebc2752bSEmanuele Giuseppe Esposito      * The check results are stored in result.
734ebc2752bSEmanuele Giuseppe Esposito      */
7351b3ff9feSKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_check)(
7361b3ff9feSKevin Wolf         BlockDriverState *bs, BdrvCheckResult *result, BdrvCheckMode fix);
737ebc2752bSEmanuele Giuseppe Esposito 
738cb2bfaa4SEmanuele Giuseppe Esposito     void coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_debug_event)(
739cb2bfaa4SEmanuele Giuseppe Esposito         BlockDriverState *bs, BlkdebugEvent event);
740ebc2752bSEmanuele Giuseppe Esposito 
741ebc2752bSEmanuele Giuseppe Esposito     /* io queue for linux-aio */
742c3827069SKevin Wolf     void coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_io_plug)(BlockDriverState *bs);
743c3827069SKevin Wolf     void coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_io_unplug)(
744c3827069SKevin Wolf         BlockDriverState *bs);
745ebc2752bSEmanuele Giuseppe Esposito 
746ebc2752bSEmanuele Giuseppe Esposito     /**
7475e8ac217SKevin Wolf      * bdrv_drain_begin is called if implemented in the beginning of a
748ebc2752bSEmanuele Giuseppe Esposito      * drain operation to drain and stop any internal sources of requests in
749ebc2752bSEmanuele Giuseppe Esposito      * the driver.
7505e8ac217SKevin Wolf      * bdrv_drain_end is called if implemented at the end of the drain.
751ebc2752bSEmanuele Giuseppe Esposito      *
752ebc2752bSEmanuele Giuseppe Esposito      * They should be used by the driver to e.g. manage scheduled I/O
753ebc2752bSEmanuele Giuseppe Esposito      * requests, or toggle an internal state. After the end of the drain new
754ebc2752bSEmanuele Giuseppe Esposito      * requests will continue normally.
7555e8ac217SKevin Wolf      *
7565e8ac217SKevin Wolf      * Implementations of both functions must not call aio_poll().
757ebc2752bSEmanuele Giuseppe Esposito      */
7585e8ac217SKevin Wolf     void (*bdrv_drain_begin)(BlockDriverState *bs);
7595e8ac217SKevin Wolf     void (*bdrv_drain_end)(BlockDriverState *bs);
760ebc2752bSEmanuele Giuseppe Esposito 
761ebc2752bSEmanuele Giuseppe Esposito     bool (*bdrv_supports_persistent_dirty_bitmap)(BlockDriverState *bs);
762167f748dSKevin Wolf 
763167f748dSKevin Wolf     bool coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_can_store_new_dirty_bitmap)(
764c2d76808SAlberto Faria         BlockDriverState *bs, const char *name, uint32_t granularity,
765ebc2752bSEmanuele Giuseppe Esposito         Error **errp);
766167f748dSKevin Wolf 
767167f748dSKevin Wolf     int coroutine_fn GRAPH_RDLOCK_PTR (*bdrv_co_remove_persistent_dirty_bitmap)(
768c2d76808SAlberto Faria         BlockDriverState *bs, const char *name, Error **errp);
769ebc2752bSEmanuele Giuseppe Esposito };
770ebc2752bSEmanuele Giuseppe Esposito 
7717b1fb72eSKevin Wolf static inline bool TSA_NO_TSA block_driver_can_compress(BlockDriver *drv)
772ebc2752bSEmanuele Giuseppe Esposito {
773ebc2752bSEmanuele Giuseppe Esposito     return drv->bdrv_co_pwritev_compressed ||
774ebc2752bSEmanuele Giuseppe Esposito            drv->bdrv_co_pwritev_compressed_part;
775ebc2752bSEmanuele Giuseppe Esposito }
776ebc2752bSEmanuele Giuseppe Esposito 
777ebc2752bSEmanuele Giuseppe Esposito typedef struct BlockLimits {
778ebc2752bSEmanuele Giuseppe Esposito     /*
779ebc2752bSEmanuele Giuseppe Esposito      * Alignment requirement, in bytes, for offset/length of I/O
780ebc2752bSEmanuele Giuseppe Esposito      * requests. Must be a power of 2 less than INT_MAX; defaults to
781ebc2752bSEmanuele Giuseppe Esposito      * 1 for drivers with modern byte interfaces, and to 512
782ebc2752bSEmanuele Giuseppe Esposito      * otherwise.
783ebc2752bSEmanuele Giuseppe Esposito      */
784ebc2752bSEmanuele Giuseppe Esposito     uint32_t request_alignment;
785ebc2752bSEmanuele Giuseppe Esposito 
786ebc2752bSEmanuele Giuseppe Esposito     /*
787ebc2752bSEmanuele Giuseppe Esposito      * Maximum number of bytes that can be discarded at once. Must be multiple
788ebc2752bSEmanuele Giuseppe Esposito      * of pdiscard_alignment, but need not be power of 2. May be 0 if no
789ebc2752bSEmanuele Giuseppe Esposito      * inherent 64-bit limit.
790ebc2752bSEmanuele Giuseppe Esposito      */
791ebc2752bSEmanuele Giuseppe Esposito     int64_t max_pdiscard;
792ebc2752bSEmanuele Giuseppe Esposito 
793ebc2752bSEmanuele Giuseppe Esposito     /*
794ebc2752bSEmanuele Giuseppe Esposito      * Optimal alignment for discard requests in bytes. A power of 2
795ebc2752bSEmanuele Giuseppe Esposito      * is best but not mandatory.  Must be a multiple of
796ebc2752bSEmanuele Giuseppe Esposito      * bl.request_alignment, and must be less than max_pdiscard if
797ebc2752bSEmanuele Giuseppe Esposito      * that is set. May be 0 if bl.request_alignment is good enough
798ebc2752bSEmanuele Giuseppe Esposito      */
799ebc2752bSEmanuele Giuseppe Esposito     uint32_t pdiscard_alignment;
800ebc2752bSEmanuele Giuseppe Esposito 
801ebc2752bSEmanuele Giuseppe Esposito     /*
802ebc2752bSEmanuele Giuseppe Esposito      * Maximum number of bytes that can zeroized at once. Must be multiple of
803ebc2752bSEmanuele Giuseppe Esposito      * pwrite_zeroes_alignment. 0 means no limit.
804ebc2752bSEmanuele Giuseppe Esposito      */
805ebc2752bSEmanuele Giuseppe Esposito     int64_t max_pwrite_zeroes;
806ebc2752bSEmanuele Giuseppe Esposito 
807ebc2752bSEmanuele Giuseppe Esposito     /*
808ebc2752bSEmanuele Giuseppe Esposito      * Optimal alignment for write zeroes requests in bytes. A power
809ebc2752bSEmanuele Giuseppe Esposito      * of 2 is best but not mandatory.  Must be a multiple of
810ebc2752bSEmanuele Giuseppe Esposito      * bl.request_alignment, and must be less than max_pwrite_zeroes
811ebc2752bSEmanuele Giuseppe Esposito      * if that is set. May be 0 if bl.request_alignment is good
812ebc2752bSEmanuele Giuseppe Esposito      * enough
813ebc2752bSEmanuele Giuseppe Esposito      */
814ebc2752bSEmanuele Giuseppe Esposito     uint32_t pwrite_zeroes_alignment;
815ebc2752bSEmanuele Giuseppe Esposito 
816ebc2752bSEmanuele Giuseppe Esposito     /*
817ebc2752bSEmanuele Giuseppe Esposito      * Optimal transfer length in bytes.  A power of 2 is best but not
818ebc2752bSEmanuele Giuseppe Esposito      * mandatory.  Must be a multiple of bl.request_alignment, or 0 if
819ebc2752bSEmanuele Giuseppe Esposito      * no preferred size
820ebc2752bSEmanuele Giuseppe Esposito      */
821ebc2752bSEmanuele Giuseppe Esposito     uint32_t opt_transfer;
822ebc2752bSEmanuele Giuseppe Esposito 
823ebc2752bSEmanuele Giuseppe Esposito     /*
824ebc2752bSEmanuele Giuseppe Esposito      * Maximal transfer length in bytes.  Need not be power of 2, but
825ebc2752bSEmanuele Giuseppe Esposito      * must be multiple of opt_transfer and bl.request_alignment, or 0
826ebc2752bSEmanuele Giuseppe Esposito      * for no 32-bit limit.  For now, anything larger than INT_MAX is
827ebc2752bSEmanuele Giuseppe Esposito      * clamped down.
828ebc2752bSEmanuele Giuseppe Esposito      */
829ebc2752bSEmanuele Giuseppe Esposito     uint32_t max_transfer;
830ebc2752bSEmanuele Giuseppe Esposito 
831ebc2752bSEmanuele Giuseppe Esposito     /*
832ebc2752bSEmanuele Giuseppe Esposito      * Maximal hardware transfer length in bytes.  Applies whenever
833ebc2752bSEmanuele Giuseppe Esposito      * transfers to the device bypass the kernel I/O scheduler, for
834ebc2752bSEmanuele Giuseppe Esposito      * example with SG_IO.  If larger than max_transfer or if zero,
835ebc2752bSEmanuele Giuseppe Esposito      * blk_get_max_hw_transfer will fall back to max_transfer.
836ebc2752bSEmanuele Giuseppe Esposito      */
837ebc2752bSEmanuele Giuseppe Esposito     uint64_t max_hw_transfer;
838ebc2752bSEmanuele Giuseppe Esposito 
839ebc2752bSEmanuele Giuseppe Esposito     /*
840ebc2752bSEmanuele Giuseppe Esposito      * Maximal number of scatter/gather elements allowed by the hardware.
841ebc2752bSEmanuele Giuseppe Esposito      * Applies whenever transfers to the device bypass the kernel I/O
842ebc2752bSEmanuele Giuseppe Esposito      * scheduler, for example with SG_IO.  If larger than max_iov
843ebc2752bSEmanuele Giuseppe Esposito      * or if zero, blk_get_max_hw_iov will fall back to max_iov.
844ebc2752bSEmanuele Giuseppe Esposito      */
845ebc2752bSEmanuele Giuseppe Esposito     int max_hw_iov;
846ebc2752bSEmanuele Giuseppe Esposito 
847ebc2752bSEmanuele Giuseppe Esposito 
848ebc2752bSEmanuele Giuseppe Esposito     /* memory alignment, in bytes so that no bounce buffer is needed */
849ebc2752bSEmanuele Giuseppe Esposito     size_t min_mem_alignment;
850ebc2752bSEmanuele Giuseppe Esposito 
851ebc2752bSEmanuele Giuseppe Esposito     /* memory alignment, in bytes, for bounce buffer */
852ebc2752bSEmanuele Giuseppe Esposito     size_t opt_mem_alignment;
853ebc2752bSEmanuele Giuseppe Esposito 
854ebc2752bSEmanuele Giuseppe Esposito     /* maximum number of iovec elements */
855ebc2752bSEmanuele Giuseppe Esposito     int max_iov;
856160a29e2SPaolo Bonzini 
857160a29e2SPaolo Bonzini     /*
858160a29e2SPaolo Bonzini      * true if the length of the underlying file can change, and QEMU
859160a29e2SPaolo Bonzini      * is expected to adjust automatically.  Mostly for CD-ROM drives,
860160a29e2SPaolo Bonzini      * whose length is zero when the tray is empty (they don't need
861160a29e2SPaolo Bonzini      * an explicit monitor command to load the disk inside the guest).
862160a29e2SPaolo Bonzini      */
863160a29e2SPaolo Bonzini     bool has_variable_length;
864ebc2752bSEmanuele Giuseppe Esposito } BlockLimits;
865ebc2752bSEmanuele Giuseppe Esposito 
866ebc2752bSEmanuele Giuseppe Esposito typedef struct BdrvOpBlocker BdrvOpBlocker;
867ebc2752bSEmanuele Giuseppe Esposito 
868ebc2752bSEmanuele Giuseppe Esposito typedef struct BdrvAioNotifier {
869ebc2752bSEmanuele Giuseppe Esposito     void (*attached_aio_context)(AioContext *new_context, void *opaque);
870ebc2752bSEmanuele Giuseppe Esposito     void (*detach_aio_context)(void *opaque);
871ebc2752bSEmanuele Giuseppe Esposito 
872ebc2752bSEmanuele Giuseppe Esposito     void *opaque;
873ebc2752bSEmanuele Giuseppe Esposito     bool deleted;
874ebc2752bSEmanuele Giuseppe Esposito 
875ebc2752bSEmanuele Giuseppe Esposito     QLIST_ENTRY(BdrvAioNotifier) list;
876ebc2752bSEmanuele Giuseppe Esposito } BdrvAioNotifier;
877ebc2752bSEmanuele Giuseppe Esposito 
878ebc2752bSEmanuele Giuseppe Esposito struct BdrvChildClass {
879ebc2752bSEmanuele Giuseppe Esposito     /*
880ebc2752bSEmanuele Giuseppe Esposito      * If true, bdrv_replace_node() doesn't change the node this BdrvChild
881ebc2752bSEmanuele Giuseppe Esposito      * points to.
882ebc2752bSEmanuele Giuseppe Esposito      */
883ebc2752bSEmanuele Giuseppe Esposito     bool stay_at_node;
884ebc2752bSEmanuele Giuseppe Esposito 
885ebc2752bSEmanuele Giuseppe Esposito     /*
886ebc2752bSEmanuele Giuseppe Esposito      * If true, the parent is a BlockDriverState and bdrv_next_all_states()
887ebc2752bSEmanuele Giuseppe Esposito      * will return it. This information is used for drain_all, where every node
888ebc2752bSEmanuele Giuseppe Esposito      * will be drained separately, so the drain only needs to be propagated to
889ebc2752bSEmanuele Giuseppe Esposito      * non-BDS parents.
890ebc2752bSEmanuele Giuseppe Esposito      */
891ebc2752bSEmanuele Giuseppe Esposito     bool parent_is_bds;
892ebc2752bSEmanuele Giuseppe Esposito 
893abc5a79cSEmanuele Giuseppe Esposito     /*
894abc5a79cSEmanuele Giuseppe Esposito      * Global state (GS) API. These functions run under the BQL.
895abc5a79cSEmanuele Giuseppe Esposito      *
896abc5a79cSEmanuele Giuseppe Esposito      * See include/block/block-global-state.h for more information about
897abc5a79cSEmanuele Giuseppe Esposito      * the GS API.
898abc5a79cSEmanuele Giuseppe Esposito      */
899ebc2752bSEmanuele Giuseppe Esposito     void (*inherit_options)(BdrvChildRole role, bool parent_is_format,
900ebc2752bSEmanuele Giuseppe Esposito                             int *child_flags, QDict *child_options,
901ebc2752bSEmanuele Giuseppe Esposito                             int parent_flags, QDict *parent_options);
902ebc2752bSEmanuele Giuseppe Esposito     void (*change_media)(BdrvChild *child, bool load);
903ebc2752bSEmanuele Giuseppe Esposito 
904ebc2752bSEmanuele Giuseppe Esposito     /*
905ebc2752bSEmanuele Giuseppe Esposito      * Returns a malloced string that describes the parent of the child for a
906ebc2752bSEmanuele Giuseppe Esposito      * human reader. This could be a node-name, BlockBackend name, qdev ID or
907ebc2752bSEmanuele Giuseppe Esposito      * QOM path of the device owning the BlockBackend, job type and ID etc. The
908ebc2752bSEmanuele Giuseppe Esposito      * caller is responsible for freeing the memory.
909ebc2752bSEmanuele Giuseppe Esposito      */
910ebc2752bSEmanuele Giuseppe Esposito     char *(*get_parent_desc)(BdrvChild *child);
911ebc2752bSEmanuele Giuseppe Esposito 
912ebc2752bSEmanuele Giuseppe Esposito     /*
913ebc2752bSEmanuele Giuseppe Esposito      * Notifies the parent that the child has been activated/inactivated (e.g.
914ebc2752bSEmanuele Giuseppe Esposito      * when migration is completing) and it can start/stop requesting
915ebc2752bSEmanuele Giuseppe Esposito      * permissions and doing I/O on it.
916ebc2752bSEmanuele Giuseppe Esposito      */
917ebc2752bSEmanuele Giuseppe Esposito     void (*activate)(BdrvChild *child, Error **errp);
918ebc2752bSEmanuele Giuseppe Esposito     int (*inactivate)(BdrvChild *child);
919ebc2752bSEmanuele Giuseppe Esposito 
920303de47bSKevin Wolf     void GRAPH_WRLOCK_PTR (*attach)(BdrvChild *child);
921303de47bSKevin Wolf     void GRAPH_WRLOCK_PTR (*detach)(BdrvChild *child);
922ebc2752bSEmanuele Giuseppe Esposito 
923ebc2752bSEmanuele Giuseppe Esposito     /*
924ebc2752bSEmanuele Giuseppe Esposito      * Notifies the parent that the filename of its child has changed (e.g.
925ebc2752bSEmanuele Giuseppe Esposito      * because the direct child was removed from the backing chain), so that it
926ebc2752bSEmanuele Giuseppe Esposito      * can update its reference.
927ebc2752bSEmanuele Giuseppe Esposito      */
928ebc2752bSEmanuele Giuseppe Esposito     int (*update_filename)(BdrvChild *child, BlockDriverState *new_base,
929ebc2752bSEmanuele Giuseppe Esposito                            const char *filename, Error **errp);
930ebc2752bSEmanuele Giuseppe Esposito 
9317e8c182fSEmanuele Giuseppe Esposito     bool (*change_aio_ctx)(BdrvChild *child, AioContext *ctx,
932e08cc001SEmanuele Giuseppe Esposito                            GHashTable *visited, Transaction *tran,
933e08cc001SEmanuele Giuseppe Esposito                            Error **errp);
934ebc2752bSEmanuele Giuseppe Esposito 
935abc5a79cSEmanuele Giuseppe Esposito     /*
936abc5a79cSEmanuele Giuseppe Esposito      * I/O API functions. These functions are thread-safe.
937abc5a79cSEmanuele Giuseppe Esposito      *
938abc5a79cSEmanuele Giuseppe Esposito      * See include/block/block-io.h for more information about
939abc5a79cSEmanuele Giuseppe Esposito      * the I/O API.
940abc5a79cSEmanuele Giuseppe Esposito      */
941abc5a79cSEmanuele Giuseppe Esposito 
942abc5a79cSEmanuele Giuseppe Esposito     void (*resize)(BdrvChild *child);
943abc5a79cSEmanuele Giuseppe Esposito 
944abc5a79cSEmanuele Giuseppe Esposito     /*
945abc5a79cSEmanuele Giuseppe Esposito      * Returns a name that is supposedly more useful for human users than the
946abc5a79cSEmanuele Giuseppe Esposito      * node name for identifying the node in question (in particular, a BB
947abc5a79cSEmanuele Giuseppe Esposito      * name), or NULL if the parent can't provide a better name.
948abc5a79cSEmanuele Giuseppe Esposito      */
949abc5a79cSEmanuele Giuseppe Esposito     const char *(*get_name)(BdrvChild *child);
950abc5a79cSEmanuele Giuseppe Esposito 
951d5f8d79cSHanna Reitz     AioContext *(*get_parent_aio_context)(BdrvChild *child);
952d5f8d79cSHanna Reitz 
953abc5a79cSEmanuele Giuseppe Esposito     /*
954abc5a79cSEmanuele Giuseppe Esposito      * If this pair of functions is implemented, the parent doesn't issue new
955abc5a79cSEmanuele Giuseppe Esposito      * requests after returning from .drained_begin() until .drained_end() is
956abc5a79cSEmanuele Giuseppe Esposito      * called.
957abc5a79cSEmanuele Giuseppe Esposito      *
958abc5a79cSEmanuele Giuseppe Esposito      * These functions must not change the graph (and therefore also must not
959abc5a79cSEmanuele Giuseppe Esposito      * call aio_poll(), which could change the graph indirectly).
960abc5a79cSEmanuele Giuseppe Esposito      *
961abc5a79cSEmanuele Giuseppe Esposito      * Note that this can be nested. If drained_begin() was called twice, new
962abc5a79cSEmanuele Giuseppe Esposito      * I/O is allowed only after drained_end() was called twice, too.
963abc5a79cSEmanuele Giuseppe Esposito      */
964abc5a79cSEmanuele Giuseppe Esposito     void (*drained_begin)(BdrvChild *child);
9652f65df6eSKevin Wolf     void (*drained_end)(BdrvChild *child);
966abc5a79cSEmanuele Giuseppe Esposito 
967abc5a79cSEmanuele Giuseppe Esposito     /*
968abc5a79cSEmanuele Giuseppe Esposito      * Returns whether the parent has pending requests for the child. This
969abc5a79cSEmanuele Giuseppe Esposito      * callback is polled after .drained_begin() has been called until all
970abc5a79cSEmanuele Giuseppe Esposito      * activity on the child has stopped.
971abc5a79cSEmanuele Giuseppe Esposito      */
972abc5a79cSEmanuele Giuseppe Esposito     bool (*drained_poll)(BdrvChild *child);
973ebc2752bSEmanuele Giuseppe Esposito };
974ebc2752bSEmanuele Giuseppe Esposito 
975ebc2752bSEmanuele Giuseppe Esposito extern const BdrvChildClass child_of_bds;
976ebc2752bSEmanuele Giuseppe Esposito 
977ebc2752bSEmanuele Giuseppe Esposito struct BdrvChild {
978ebc2752bSEmanuele Giuseppe Esposito     BlockDriverState *bs;
979ebc2752bSEmanuele Giuseppe Esposito     char *name;
980ebc2752bSEmanuele Giuseppe Esposito     const BdrvChildClass *klass;
981ebc2752bSEmanuele Giuseppe Esposito     BdrvChildRole role;
982ebc2752bSEmanuele Giuseppe Esposito     void *opaque;
983ebc2752bSEmanuele Giuseppe Esposito 
984ebc2752bSEmanuele Giuseppe Esposito     /**
985ebc2752bSEmanuele Giuseppe Esposito      * Granted permissions for operating on this BdrvChild (BLK_PERM_* bitmask)
986ebc2752bSEmanuele Giuseppe Esposito      */
987ebc2752bSEmanuele Giuseppe Esposito     uint64_t perm;
988ebc2752bSEmanuele Giuseppe Esposito 
989ebc2752bSEmanuele Giuseppe Esposito     /**
990ebc2752bSEmanuele Giuseppe Esposito      * Permissions that can still be granted to other users of @bs while this
991ebc2752bSEmanuele Giuseppe Esposito      * BdrvChild is still attached to it. (BLK_PERM_* bitmask)
992ebc2752bSEmanuele Giuseppe Esposito      */
993ebc2752bSEmanuele Giuseppe Esposito     uint64_t shared_perm;
994ebc2752bSEmanuele Giuseppe Esposito 
995ebc2752bSEmanuele Giuseppe Esposito     /*
996ebc2752bSEmanuele Giuseppe Esposito      * This link is frozen: the child can neither be replaced nor
997ebc2752bSEmanuele Giuseppe Esposito      * detached from the parent.
998ebc2752bSEmanuele Giuseppe Esposito      */
999ebc2752bSEmanuele Giuseppe Esposito     bool frozen;
1000ebc2752bSEmanuele Giuseppe Esposito 
1001ebc2752bSEmanuele Giuseppe Esposito     /*
100257e05be3SKevin Wolf      * True if the parent of this child has been drained by this BdrvChild
1003ebc2752bSEmanuele Giuseppe Esposito      * (through klass->drained_*).
100457e05be3SKevin Wolf      *
100557e05be3SKevin Wolf      * It is generally true if bs->quiesce_counter > 0. It may differ while the
1006ebc2752bSEmanuele Giuseppe Esposito      * child is entering or leaving a drained section.
1007ebc2752bSEmanuele Giuseppe Esposito      */
100857e05be3SKevin Wolf     bool quiesced_parent;
1009ebc2752bSEmanuele Giuseppe Esposito 
1010ebc2752bSEmanuele Giuseppe Esposito     QLIST_ENTRY(BdrvChild) next;
1011ebc2752bSEmanuele Giuseppe Esposito     QLIST_ENTRY(BdrvChild) next_parent;
1012ebc2752bSEmanuele Giuseppe Esposito };
1013ebc2752bSEmanuele Giuseppe Esposito 
1014ebc2752bSEmanuele Giuseppe Esposito /*
1015ebc2752bSEmanuele Giuseppe Esposito  * Allows bdrv_co_block_status() to cache one data region for a
1016ebc2752bSEmanuele Giuseppe Esposito  * protocol node.
1017ebc2752bSEmanuele Giuseppe Esposito  *
1018ebc2752bSEmanuele Giuseppe Esposito  * @valid: Whether the cache is valid (should be accessed with atomic
1019ebc2752bSEmanuele Giuseppe Esposito  *         functions so this can be reset by RCU readers)
1020ebc2752bSEmanuele Giuseppe Esposito  * @data_start: Offset where we know (or strongly assume) is data
1021ebc2752bSEmanuele Giuseppe Esposito  * @data_end: Offset where the data region ends (which is not necessarily
1022ebc2752bSEmanuele Giuseppe Esposito  *            the start of a zeroed region)
1023ebc2752bSEmanuele Giuseppe Esposito  */
1024ebc2752bSEmanuele Giuseppe Esposito typedef struct BdrvBlockStatusCache {
1025ebc2752bSEmanuele Giuseppe Esposito     struct rcu_head rcu;
1026ebc2752bSEmanuele Giuseppe Esposito 
1027ebc2752bSEmanuele Giuseppe Esposito     bool valid;
1028ebc2752bSEmanuele Giuseppe Esposito     int64_t data_start;
1029ebc2752bSEmanuele Giuseppe Esposito     int64_t data_end;
1030ebc2752bSEmanuele Giuseppe Esposito } BdrvBlockStatusCache;
1031ebc2752bSEmanuele Giuseppe Esposito 
1032ebc2752bSEmanuele Giuseppe Esposito struct BlockDriverState {
1033ebc2752bSEmanuele Giuseppe Esposito     /*
1034ebc2752bSEmanuele Giuseppe Esposito      * Protected by big QEMU lock or read-only after opening.  No special
1035ebc2752bSEmanuele Giuseppe Esposito      * locking needed during I/O...
1036ebc2752bSEmanuele Giuseppe Esposito      */
1037ebc2752bSEmanuele Giuseppe Esposito     int open_flags; /* flags used to open the file, re-used for re-open */
1038ebc2752bSEmanuele Giuseppe Esposito     bool encrypted; /* if true, the media is encrypted */
1039ebc2752bSEmanuele Giuseppe Esposito     bool sg;        /* if true, the device is a /dev/sg* */
1040ebc2752bSEmanuele Giuseppe Esposito     bool probed;    /* if true, format was probed rather than specified */
1041ebc2752bSEmanuele Giuseppe Esposito     bool force_share; /* if true, always allow all shared permissions */
1042ebc2752bSEmanuele Giuseppe Esposito     bool implicit;  /* if true, this filter node was automatically inserted */
1043ebc2752bSEmanuele Giuseppe Esposito 
1044ebc2752bSEmanuele Giuseppe Esposito     BlockDriver *drv; /* NULL means no media */
1045ebc2752bSEmanuele Giuseppe Esposito     void *opaque;
1046ebc2752bSEmanuele Giuseppe Esposito 
1047ebc2752bSEmanuele Giuseppe Esposito     AioContext *aio_context; /* event loop used for fd handlers, timers, etc */
1048ebc2752bSEmanuele Giuseppe Esposito     /*
1049ebc2752bSEmanuele Giuseppe Esposito      * long-running tasks intended to always use the same AioContext as this
1050ebc2752bSEmanuele Giuseppe Esposito      * BDS may register themselves in this list to be notified of changes
1051ebc2752bSEmanuele Giuseppe Esposito      * regarding this BDS's context
1052ebc2752bSEmanuele Giuseppe Esposito      */
1053ebc2752bSEmanuele Giuseppe Esposito     QLIST_HEAD(, BdrvAioNotifier) aio_notifiers;
1054ebc2752bSEmanuele Giuseppe Esposito     bool walking_aio_notifiers; /* to make removal during iteration safe */
1055ebc2752bSEmanuele Giuseppe Esposito 
1056ebc2752bSEmanuele Giuseppe Esposito     char filename[PATH_MAX];
1057ebc2752bSEmanuele Giuseppe Esposito     /*
1058ebc2752bSEmanuele Giuseppe Esposito      * If not empty, this image is a diff in relation to backing_file.
1059ebc2752bSEmanuele Giuseppe Esposito      * Note that this is the name given in the image header and
1060ebc2752bSEmanuele Giuseppe Esposito      * therefore may or may not be equal to .backing->bs->filename.
1061ebc2752bSEmanuele Giuseppe Esposito      * If this field contains a relative path, it is to be resolved
1062ebc2752bSEmanuele Giuseppe Esposito      * relatively to the overlay's location.
1063ebc2752bSEmanuele Giuseppe Esposito      */
1064ebc2752bSEmanuele Giuseppe Esposito     char backing_file[PATH_MAX];
1065ebc2752bSEmanuele Giuseppe Esposito     /*
1066ebc2752bSEmanuele Giuseppe Esposito      * The backing filename indicated by the image header.  Contrary
1067ebc2752bSEmanuele Giuseppe Esposito      * to backing_file, if we ever open this file, auto_backing_file
1068ebc2752bSEmanuele Giuseppe Esposito      * is replaced by the resulting BDS's filename (i.e. after a
1069ebc2752bSEmanuele Giuseppe Esposito      * bdrv_refresh_filename() run).
1070ebc2752bSEmanuele Giuseppe Esposito      */
1071ebc2752bSEmanuele Giuseppe Esposito     char auto_backing_file[PATH_MAX];
1072ebc2752bSEmanuele Giuseppe Esposito     char backing_format[16]; /* if non-zero and backing_file exists */
1073ebc2752bSEmanuele Giuseppe Esposito 
1074ebc2752bSEmanuele Giuseppe Esposito     QDict *full_open_options;
1075ebc2752bSEmanuele Giuseppe Esposito     char exact_filename[PATH_MAX];
1076ebc2752bSEmanuele Giuseppe Esposito 
1077ebc2752bSEmanuele Giuseppe Esposito     /* I/O Limits */
1078ebc2752bSEmanuele Giuseppe Esposito     BlockLimits bl;
1079ebc2752bSEmanuele Giuseppe Esposito 
1080ebc2752bSEmanuele Giuseppe Esposito     /*
1081ebc2752bSEmanuele Giuseppe Esposito      * Flags honored during pread
1082ebc2752bSEmanuele Giuseppe Esposito      */
108398b3ddc7SStefan Hajnoczi     BdrvRequestFlags supported_read_flags;
1084ebc2752bSEmanuele Giuseppe Esposito     /*
1085ebc2752bSEmanuele Giuseppe Esposito      * Flags honored during pwrite (so far: BDRV_REQ_FUA,
1086ebc2752bSEmanuele Giuseppe Esposito      * BDRV_REQ_WRITE_UNCHANGED).
1087ebc2752bSEmanuele Giuseppe Esposito      * If a driver does not support BDRV_REQ_WRITE_UNCHANGED, those
1088ebc2752bSEmanuele Giuseppe Esposito      * writes will be issued as normal writes without the flag set.
1089ebc2752bSEmanuele Giuseppe Esposito      * This is important to note for drivers that do not explicitly
1090ebc2752bSEmanuele Giuseppe Esposito      * request a WRITE permission for their children and instead take
1091ebc2752bSEmanuele Giuseppe Esposito      * the same permissions as their parent did (this is commonly what
1092ebc2752bSEmanuele Giuseppe Esposito      * block filters do).  Such drivers have to be aware that the
1093ebc2752bSEmanuele Giuseppe Esposito      * parent may have taken a WRITE_UNCHANGED permission only and is
1094ebc2752bSEmanuele Giuseppe Esposito      * issuing such requests.  Drivers either must make sure that
1095ebc2752bSEmanuele Giuseppe Esposito      * these requests do not result in plain WRITE accesses (usually
1096ebc2752bSEmanuele Giuseppe Esposito      * by supporting BDRV_REQ_WRITE_UNCHANGED, and then forwarding
1097ebc2752bSEmanuele Giuseppe Esposito      * every incoming write request as-is, including potentially that
1098ebc2752bSEmanuele Giuseppe Esposito      * flag), or they have to explicitly take the WRITE permission for
1099ebc2752bSEmanuele Giuseppe Esposito      * their children.
1100ebc2752bSEmanuele Giuseppe Esposito      */
110198b3ddc7SStefan Hajnoczi     BdrvRequestFlags supported_write_flags;
1102ebc2752bSEmanuele Giuseppe Esposito     /*
1103ebc2752bSEmanuele Giuseppe Esposito      * Flags honored during pwrite_zeroes (so far: BDRV_REQ_FUA,
1104ebc2752bSEmanuele Giuseppe Esposito      * BDRV_REQ_MAY_UNMAP, BDRV_REQ_WRITE_UNCHANGED)
1105ebc2752bSEmanuele Giuseppe Esposito      */
110698b3ddc7SStefan Hajnoczi     BdrvRequestFlags supported_zero_flags;
1107ebc2752bSEmanuele Giuseppe Esposito     /*
1108ebc2752bSEmanuele Giuseppe Esposito      * Flags honoured during truncate (so far: BDRV_REQ_ZERO_WRITE).
1109ebc2752bSEmanuele Giuseppe Esposito      *
1110ebc2752bSEmanuele Giuseppe Esposito      * If BDRV_REQ_ZERO_WRITE is given, the truncate operation must make sure
1111ebc2752bSEmanuele Giuseppe Esposito      * that any added space reads as all zeros. If this can't be guaranteed,
1112ebc2752bSEmanuele Giuseppe Esposito      * the operation must fail.
1113ebc2752bSEmanuele Giuseppe Esposito      */
111498b3ddc7SStefan Hajnoczi     BdrvRequestFlags supported_truncate_flags;
1115ebc2752bSEmanuele Giuseppe Esposito 
1116ebc2752bSEmanuele Giuseppe Esposito     /* the following member gives a name to every node on the bs graph. */
1117ebc2752bSEmanuele Giuseppe Esposito     char node_name[32];
1118ebc2752bSEmanuele Giuseppe Esposito     /* element of the list of named nodes building the graph */
1119ebc2752bSEmanuele Giuseppe Esposito     QTAILQ_ENTRY(BlockDriverState) node_list;
1120ebc2752bSEmanuele Giuseppe Esposito     /* element of the list of all BlockDriverStates (all_bdrv_states) */
1121ebc2752bSEmanuele Giuseppe Esposito     QTAILQ_ENTRY(BlockDriverState) bs_list;
1122ebc2752bSEmanuele Giuseppe Esposito     /* element of the list of monitor-owned BDS */
1123ebc2752bSEmanuele Giuseppe Esposito     QTAILQ_ENTRY(BlockDriverState) monitor_list;
1124ebc2752bSEmanuele Giuseppe Esposito     int refcnt;
1125ebc2752bSEmanuele Giuseppe Esposito 
1126ebc2752bSEmanuele Giuseppe Esposito     /* operation blockers. Protected by BQL. */
1127ebc2752bSEmanuele Giuseppe Esposito     QLIST_HEAD(, BdrvOpBlocker) op_blockers[BLOCK_OP_TYPE_MAX];
1128ebc2752bSEmanuele Giuseppe Esposito 
1129ebc2752bSEmanuele Giuseppe Esposito     /*
1130ebc2752bSEmanuele Giuseppe Esposito      * The node that this node inherited default options from (and a reopen on
1131ebc2752bSEmanuele Giuseppe Esposito      * which can affect this node by changing these defaults). This is always a
1132ebc2752bSEmanuele Giuseppe Esposito      * parent node of this node.
1133ebc2752bSEmanuele Giuseppe Esposito      */
1134ebc2752bSEmanuele Giuseppe Esposito     BlockDriverState *inherits_from;
11355bb04747SVladimir Sementsov-Ogievskiy 
11365bb04747SVladimir Sementsov-Ogievskiy     /*
11375bb04747SVladimir Sementsov-Ogievskiy      * @backing and @file are some of @children or NULL. All these three fields
11385bb04747SVladimir Sementsov-Ogievskiy      * (@file, @backing and @children) are modified only in
11395bb04747SVladimir Sementsov-Ogievskiy      * bdrv_child_cb_attach() and bdrv_child_cb_detach().
11405bb04747SVladimir Sementsov-Ogievskiy      *
11415bb04747SVladimir Sementsov-Ogievskiy      * See also comment in include/block/block.h, to learn how backing and file
11425bb04747SVladimir Sementsov-Ogievskiy      * are connected with BdrvChildRole.
11435bb04747SVladimir Sementsov-Ogievskiy      */
1144ebc2752bSEmanuele Giuseppe Esposito     QLIST_HEAD(, BdrvChild) children;
11455bb04747SVladimir Sementsov-Ogievskiy     BdrvChild *backing;
11465bb04747SVladimir Sementsov-Ogievskiy     BdrvChild *file;
11475bb04747SVladimir Sementsov-Ogievskiy 
1148ebc2752bSEmanuele Giuseppe Esposito     QLIST_HEAD(, BdrvChild) parents;
1149ebc2752bSEmanuele Giuseppe Esposito 
1150ebc2752bSEmanuele Giuseppe Esposito     QDict *options;
1151ebc2752bSEmanuele Giuseppe Esposito     QDict *explicit_options;
1152ebc2752bSEmanuele Giuseppe Esposito     BlockdevDetectZeroesOptions detect_zeroes;
1153ebc2752bSEmanuele Giuseppe Esposito 
1154ebc2752bSEmanuele Giuseppe Esposito     /* The error object in use for blocking operations on backing_hd */
1155ebc2752bSEmanuele Giuseppe Esposito     Error *backing_blocker;
1156ebc2752bSEmanuele Giuseppe Esposito 
1157ebc2752bSEmanuele Giuseppe Esposito     /* Protected by AioContext lock */
1158ebc2752bSEmanuele Giuseppe Esposito 
1159ebc2752bSEmanuele Giuseppe Esposito     /*
1160ebc2752bSEmanuele Giuseppe Esposito      * If we are reading a disk image, give its size in sectors.
1161ebc2752bSEmanuele Giuseppe Esposito      * Generally read-only; it is written to by load_snapshot and
1162ebc2752bSEmanuele Giuseppe Esposito      * save_snaphost, but the block layer is quiescent during those.
1163ebc2752bSEmanuele Giuseppe Esposito      */
1164ebc2752bSEmanuele Giuseppe Esposito     int64_t total_sectors;
1165ebc2752bSEmanuele Giuseppe Esposito 
1166ebc2752bSEmanuele Giuseppe Esposito     /* threshold limit for writes, in bytes. "High water mark". */
1167ebc2752bSEmanuele Giuseppe Esposito     uint64_t write_threshold_offset;
1168ebc2752bSEmanuele Giuseppe Esposito 
1169ebc2752bSEmanuele Giuseppe Esposito     /*
1170ebc2752bSEmanuele Giuseppe Esposito      * Writing to the list requires the BQL _and_ the dirty_bitmap_mutex.
1171ebc2752bSEmanuele Giuseppe Esposito      * Reading from the list can be done with either the BQL or the
1172ebc2752bSEmanuele Giuseppe Esposito      * dirty_bitmap_mutex.  Modifying a bitmap only requires
1173ebc2752bSEmanuele Giuseppe Esposito      * dirty_bitmap_mutex.
1174ebc2752bSEmanuele Giuseppe Esposito      */
1175ebc2752bSEmanuele Giuseppe Esposito     QemuMutex dirty_bitmap_mutex;
1176ebc2752bSEmanuele Giuseppe Esposito     QLIST_HEAD(, BdrvDirtyBitmap) dirty_bitmaps;
1177ebc2752bSEmanuele Giuseppe Esposito 
1178ebc2752bSEmanuele Giuseppe Esposito     /* Offset after the highest byte written to */
1179ebc2752bSEmanuele Giuseppe Esposito     Stat64 wr_highest_offset;
1180ebc2752bSEmanuele Giuseppe Esposito 
1181ebc2752bSEmanuele Giuseppe Esposito     /*
1182ebc2752bSEmanuele Giuseppe Esposito      * If true, copy read backing sectors into image.  Can be >1 if more
1183ebc2752bSEmanuele Giuseppe Esposito      * than one client has requested copy-on-read.  Accessed with atomic
1184ebc2752bSEmanuele Giuseppe Esposito      * ops.
1185ebc2752bSEmanuele Giuseppe Esposito      */
1186ebc2752bSEmanuele Giuseppe Esposito     int copy_on_read;
1187ebc2752bSEmanuele Giuseppe Esposito 
1188ebc2752bSEmanuele Giuseppe Esposito     /*
1189ebc2752bSEmanuele Giuseppe Esposito      * number of in-flight requests; overall and serialising.
1190ebc2752bSEmanuele Giuseppe Esposito      * Accessed with atomic ops.
1191ebc2752bSEmanuele Giuseppe Esposito      */
1192ebc2752bSEmanuele Giuseppe Esposito     unsigned int in_flight;
1193ebc2752bSEmanuele Giuseppe Esposito     unsigned int serialising_in_flight;
1194ebc2752bSEmanuele Giuseppe Esposito 
1195ebc2752bSEmanuele Giuseppe Esposito     /*
1196ebc2752bSEmanuele Giuseppe Esposito      * counter for nested bdrv_io_plug.
1197ebc2752bSEmanuele Giuseppe Esposito      * Accessed with atomic ops.
1198ebc2752bSEmanuele Giuseppe Esposito      */
1199ebc2752bSEmanuele Giuseppe Esposito     unsigned io_plugged;
1200ebc2752bSEmanuele Giuseppe Esposito 
1201ebc2752bSEmanuele Giuseppe Esposito     /* do we need to tell the quest if we have a volatile write cache? */
1202ebc2752bSEmanuele Giuseppe Esposito     int enable_write_cache;
1203ebc2752bSEmanuele Giuseppe Esposito 
1204ebc2752bSEmanuele Giuseppe Esposito     /* Accessed with atomic ops.  */
1205ebc2752bSEmanuele Giuseppe Esposito     int quiesce_counter;
1206ebc2752bSEmanuele Giuseppe Esposito 
1207ebc2752bSEmanuele Giuseppe Esposito     unsigned int write_gen;               /* Current data generation */
1208ebc2752bSEmanuele Giuseppe Esposito 
1209ebc2752bSEmanuele Giuseppe Esposito     /* Protected by reqs_lock.  */
1210ebc2752bSEmanuele Giuseppe Esposito     CoMutex reqs_lock;
1211ebc2752bSEmanuele Giuseppe Esposito     QLIST_HEAD(, BdrvTrackedRequest) tracked_requests;
1212ebc2752bSEmanuele Giuseppe Esposito     CoQueue flush_queue;                  /* Serializing flush queue */
1213ebc2752bSEmanuele Giuseppe Esposito     bool active_flush_req;                /* Flush request in flight? */
1214ebc2752bSEmanuele Giuseppe Esposito 
1215ebc2752bSEmanuele Giuseppe Esposito     /* Only read/written by whoever has set active_flush_req to true.  */
1216ebc2752bSEmanuele Giuseppe Esposito     unsigned int flushed_gen;             /* Flushed write generation */
1217ebc2752bSEmanuele Giuseppe Esposito 
1218ebc2752bSEmanuele Giuseppe Esposito     /* BdrvChild links to this node may never be frozen */
1219ebc2752bSEmanuele Giuseppe Esposito     bool never_freeze;
1220ebc2752bSEmanuele Giuseppe Esposito 
1221ebc2752bSEmanuele Giuseppe Esposito     /* Lock for block-status cache RCU writers */
1222ebc2752bSEmanuele Giuseppe Esposito     CoMutex bsc_modify_lock;
1223ebc2752bSEmanuele Giuseppe Esposito     /* Always non-NULL, but must only be dereferenced under an RCU read guard */
1224ebc2752bSEmanuele Giuseppe Esposito     BdrvBlockStatusCache *block_status_cache;
1225ebc2752bSEmanuele Giuseppe Esposito };
1226ebc2752bSEmanuele Giuseppe Esposito 
1227ebc2752bSEmanuele Giuseppe Esposito struct BlockBackendRootState {
1228ebc2752bSEmanuele Giuseppe Esposito     int open_flags;
1229ebc2752bSEmanuele Giuseppe Esposito     BlockdevDetectZeroesOptions detect_zeroes;
1230ebc2752bSEmanuele Giuseppe Esposito };
1231ebc2752bSEmanuele Giuseppe Esposito 
1232ebc2752bSEmanuele Giuseppe Esposito typedef enum BlockMirrorBackingMode {
1233ebc2752bSEmanuele Giuseppe Esposito     /*
1234ebc2752bSEmanuele Giuseppe Esposito      * Reuse the existing backing chain from the source for the target.
1235ebc2752bSEmanuele Giuseppe Esposito      * - sync=full: Set backing BDS to NULL.
1236ebc2752bSEmanuele Giuseppe Esposito      * - sync=top:  Use source's backing BDS.
1237ebc2752bSEmanuele Giuseppe Esposito      * - sync=none: Use source as the backing BDS.
1238ebc2752bSEmanuele Giuseppe Esposito      */
1239ebc2752bSEmanuele Giuseppe Esposito     MIRROR_SOURCE_BACKING_CHAIN,
1240ebc2752bSEmanuele Giuseppe Esposito 
1241ebc2752bSEmanuele Giuseppe Esposito     /* Open the target's backing chain completely anew */
1242ebc2752bSEmanuele Giuseppe Esposito     MIRROR_OPEN_BACKING_CHAIN,
1243ebc2752bSEmanuele Giuseppe Esposito 
1244ebc2752bSEmanuele Giuseppe Esposito     /* Do not change the target's backing BDS after job completion */
1245ebc2752bSEmanuele Giuseppe Esposito     MIRROR_LEAVE_BACKING_CHAIN,
1246ebc2752bSEmanuele Giuseppe Esposito } BlockMirrorBackingMode;
1247ebc2752bSEmanuele Giuseppe Esposito 
1248ebc2752bSEmanuele Giuseppe Esposito 
1249ebc2752bSEmanuele Giuseppe Esposito /*
1250ebc2752bSEmanuele Giuseppe Esposito  * Essential block drivers which must always be statically linked into qemu, and
1251ebc2752bSEmanuele Giuseppe Esposito  * which therefore can be accessed without using bdrv_find_format()
1252ebc2752bSEmanuele Giuseppe Esposito  */
1253ebc2752bSEmanuele Giuseppe Esposito extern BlockDriver bdrv_file;
1254ebc2752bSEmanuele Giuseppe Esposito extern BlockDriver bdrv_raw;
1255ebc2752bSEmanuele Giuseppe Esposito extern BlockDriver bdrv_qcow2;
1256ebc2752bSEmanuele Giuseppe Esposito 
1257ebc2752bSEmanuele Giuseppe Esposito extern unsigned int bdrv_drain_all_count;
1258ebc2752bSEmanuele Giuseppe Esposito extern QemuOptsList bdrv_create_opts_simple;
1259ebc2752bSEmanuele Giuseppe Esposito 
1260ebc2752bSEmanuele Giuseppe Esposito /*
1261ebc2752bSEmanuele Giuseppe Esposito  * Common functions that are neither I/O nor Global State.
1262ebc2752bSEmanuele Giuseppe Esposito  *
126304ae220dSWilfred Mallawa  * See include/block/block-common.h for more information about
1264ebc2752bSEmanuele Giuseppe Esposito  * the Common API.
1265ebc2752bSEmanuele Giuseppe Esposito  */
1266ebc2752bSEmanuele Giuseppe Esposito 
1267ebc2752bSEmanuele Giuseppe Esposito static inline BlockDriverState *child_bs(BdrvChild *child)
1268ebc2752bSEmanuele Giuseppe Esposito {
1269ebc2752bSEmanuele Giuseppe Esposito     return child ? child->bs : NULL;
1270ebc2752bSEmanuele Giuseppe Esposito }
1271ebc2752bSEmanuele Giuseppe Esposito 
1272ebc2752bSEmanuele Giuseppe Esposito int bdrv_check_request(int64_t offset, int64_t bytes, Error **errp);
127369fbfff9SBin Meng char *create_tmp_file(Error **errp);
1274ebc2752bSEmanuele Giuseppe Esposito void bdrv_parse_filename_strip_prefix(const char *filename, const char *prefix,
1275ebc2752bSEmanuele Giuseppe Esposito                                       QDict *options);
1276ebc2752bSEmanuele Giuseppe Esposito 
1277ebc2752bSEmanuele Giuseppe Esposito 
1278ebc2752bSEmanuele Giuseppe Esposito int bdrv_check_qiov_request(int64_t offset, int64_t bytes,
1279ebc2752bSEmanuele Giuseppe Esposito                             QEMUIOVector *qiov, size_t qiov_offset,
1280ebc2752bSEmanuele Giuseppe Esposito                             Error **errp);
1281ebc2752bSEmanuele Giuseppe Esposito 
1282ebc2752bSEmanuele Giuseppe Esposito #ifdef _WIN32
1283ebc2752bSEmanuele Giuseppe Esposito int is_windows_drive(const char *filename);
1284ebc2752bSEmanuele Giuseppe Esposito #endif
1285ebc2752bSEmanuele Giuseppe Esposito 
1286ebc2752bSEmanuele Giuseppe Esposito #endif /* BLOCK_INT_COMMON_H */
1287