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 27ebc2752bSEmanuele Giuseppe Esposito #include "block/accounting.h" 28ebc2752bSEmanuele Giuseppe Esposito #include "block/block.h" 29ebc2752bSEmanuele Giuseppe Esposito #include "block/aio-wait.h" 30ebc2752bSEmanuele Giuseppe Esposito #include "qemu/queue.h" 31ebc2752bSEmanuele Giuseppe Esposito #include "qemu/coroutine.h" 32ebc2752bSEmanuele Giuseppe Esposito #include "qemu/stats64.h" 33ebc2752bSEmanuele Giuseppe Esposito #include "qemu/timer.h" 34ebc2752bSEmanuele Giuseppe Esposito #include "qemu/hbitmap.h" 35ebc2752bSEmanuele Giuseppe Esposito #include "block/snapshot.h" 36ebc2752bSEmanuele Giuseppe Esposito #include "qemu/throttle.h" 37ebc2752bSEmanuele Giuseppe Esposito #include "qemu/rcu.h" 38ebc2752bSEmanuele Giuseppe Esposito 39ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_FLAG_LAZY_REFCOUNTS 8 40ebc2752bSEmanuele Giuseppe Esposito 41ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_SIZE "size" 42ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_ENCRYPT "encryption" 43ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_ENCRYPT_FORMAT "encrypt.format" 44ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_COMPAT6 "compat6" 45ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_HWVERSION "hwversion" 46ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_BACKING_FILE "backing_file" 47ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_BACKING_FMT "backing_fmt" 48ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_CLUSTER_SIZE "cluster_size" 49ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_TABLE_SIZE "table_size" 50ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_PREALLOC "preallocation" 51ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_SUBFMT "subformat" 52ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_COMPAT_LEVEL "compat" 53ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_LAZY_REFCOUNTS "lazy_refcounts" 54ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_ADAPTER_TYPE "adapter_type" 55ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_REDUNDANCY "redundancy" 56ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_NOCOW "nocow" 57ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_EXTENT_SIZE_HINT "extent_size_hint" 58ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_OBJECT_SIZE "object_size" 59ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_REFCOUNT_BITS "refcount_bits" 60ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_DATA_FILE "data_file" 61ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_DATA_FILE_RAW "data_file_raw" 62ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_COMPRESSION_TYPE "compression_type" 63ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_OPT_EXTL2 "extended_l2" 64ebc2752bSEmanuele Giuseppe Esposito 65ebc2752bSEmanuele Giuseppe Esposito #define BLOCK_PROBE_BUF_SIZE 512 66ebc2752bSEmanuele Giuseppe Esposito 67ebc2752bSEmanuele Giuseppe Esposito enum BdrvTrackedRequestType { 68ebc2752bSEmanuele Giuseppe Esposito BDRV_TRACKED_READ, 69ebc2752bSEmanuele Giuseppe Esposito BDRV_TRACKED_WRITE, 70ebc2752bSEmanuele Giuseppe Esposito BDRV_TRACKED_DISCARD, 71ebc2752bSEmanuele Giuseppe Esposito BDRV_TRACKED_TRUNCATE, 72ebc2752bSEmanuele Giuseppe Esposito }; 73ebc2752bSEmanuele Giuseppe Esposito 74ebc2752bSEmanuele Giuseppe Esposito /* 75ebc2752bSEmanuele Giuseppe Esposito * That is not quite good that BdrvTrackedRequest structure is public, 76ebc2752bSEmanuele Giuseppe Esposito * as block/io.c is very careful about incoming offset/bytes being 77ebc2752bSEmanuele Giuseppe Esposito * correct. Be sure to assert bdrv_check_request() succeeded after any 78ebc2752bSEmanuele Giuseppe Esposito * modification of BdrvTrackedRequest object out of block/io.c 79ebc2752bSEmanuele Giuseppe Esposito */ 80ebc2752bSEmanuele Giuseppe Esposito typedef struct BdrvTrackedRequest { 81ebc2752bSEmanuele Giuseppe Esposito BlockDriverState *bs; 82ebc2752bSEmanuele Giuseppe Esposito int64_t offset; 83ebc2752bSEmanuele Giuseppe Esposito int64_t bytes; 84ebc2752bSEmanuele Giuseppe Esposito enum BdrvTrackedRequestType type; 85ebc2752bSEmanuele Giuseppe Esposito 86ebc2752bSEmanuele Giuseppe Esposito bool serialising; 87ebc2752bSEmanuele Giuseppe Esposito int64_t overlap_offset; 88ebc2752bSEmanuele Giuseppe Esposito int64_t overlap_bytes; 89ebc2752bSEmanuele Giuseppe Esposito 90ebc2752bSEmanuele Giuseppe Esposito QLIST_ENTRY(BdrvTrackedRequest) list; 91ebc2752bSEmanuele Giuseppe Esposito Coroutine *co; /* owner, used for deadlock detection */ 92ebc2752bSEmanuele Giuseppe Esposito CoQueue wait_queue; /* coroutines blocked on this request */ 93ebc2752bSEmanuele Giuseppe Esposito 94ebc2752bSEmanuele Giuseppe Esposito struct BdrvTrackedRequest *waiting_for; 95ebc2752bSEmanuele Giuseppe Esposito } BdrvTrackedRequest; 96ebc2752bSEmanuele Giuseppe Esposito 97ebc2752bSEmanuele Giuseppe Esposito 98ebc2752bSEmanuele Giuseppe Esposito struct BlockDriver { 9969c0bf11SEmanuele Giuseppe Esposito /* 10069c0bf11SEmanuele Giuseppe Esposito * These fields are initialized when this object is created, 10169c0bf11SEmanuele Giuseppe Esposito * and are never changed afterwards. 10269c0bf11SEmanuele Giuseppe Esposito */ 10369c0bf11SEmanuele Giuseppe Esposito 104ebc2752bSEmanuele Giuseppe Esposito const char *format_name; 105ebc2752bSEmanuele Giuseppe Esposito int instance_size; 106ebc2752bSEmanuele Giuseppe Esposito 107ebc2752bSEmanuele Giuseppe Esposito /* 108ebc2752bSEmanuele Giuseppe Esposito * Set to true if the BlockDriver is a block filter. Block filters pass 109ebc2752bSEmanuele Giuseppe Esposito * certain callbacks that refer to data (see block.c) to their bs->file 110ebc2752bSEmanuele Giuseppe Esposito * or bs->backing (whichever one exists) if the driver doesn't implement 111ebc2752bSEmanuele Giuseppe Esposito * them. Drivers that do not wish to forward must implement them and return 112ebc2752bSEmanuele Giuseppe Esposito * -ENOTSUP. 113ebc2752bSEmanuele Giuseppe Esposito * Note that filters are not allowed to modify data. 114ebc2752bSEmanuele Giuseppe Esposito * 115ebc2752bSEmanuele Giuseppe Esposito * Filters generally cannot have more than a single filtered child, 116ebc2752bSEmanuele Giuseppe Esposito * because the data they present must at all times be the same as 117ebc2752bSEmanuele Giuseppe Esposito * that on their filtered child. That would be impossible to 118ebc2752bSEmanuele Giuseppe Esposito * achieve for multiple filtered children. 119ebc2752bSEmanuele Giuseppe Esposito * (And this filtered child must then be bs->file or bs->backing.) 120ebc2752bSEmanuele Giuseppe Esposito */ 121ebc2752bSEmanuele Giuseppe Esposito bool is_filter; 122ebc2752bSEmanuele Giuseppe Esposito /* 123ebc2752bSEmanuele Giuseppe Esposito * Set to true if the BlockDriver is a format driver. Format nodes 124ebc2752bSEmanuele Giuseppe Esposito * generally do not expect their children to be other format nodes 125ebc2752bSEmanuele Giuseppe Esposito * (except for backing files), and so format probing is disabled 126ebc2752bSEmanuele Giuseppe Esposito * on those children. 127ebc2752bSEmanuele Giuseppe Esposito */ 128ebc2752bSEmanuele Giuseppe Esposito bool is_format; 129ebc2752bSEmanuele Giuseppe Esposito 130ebc2752bSEmanuele Giuseppe Esposito /* 131ebc2752bSEmanuele Giuseppe Esposito * Drivers not implementing bdrv_parse_filename nor bdrv_open should have 132ebc2752bSEmanuele Giuseppe Esposito * this field set to true, except ones that are defined only by their 133ebc2752bSEmanuele Giuseppe Esposito * child's bs. 134ebc2752bSEmanuele Giuseppe Esposito * An example of the last type will be the quorum block driver. 135ebc2752bSEmanuele Giuseppe Esposito */ 136ebc2752bSEmanuele Giuseppe Esposito bool bdrv_needs_filename; 137ebc2752bSEmanuele Giuseppe Esposito 138ebc2752bSEmanuele Giuseppe Esposito /* 139ebc2752bSEmanuele Giuseppe Esposito * Set if a driver can support backing files. This also implies the 140ebc2752bSEmanuele Giuseppe Esposito * following semantics: 141ebc2752bSEmanuele Giuseppe Esposito * 142ebc2752bSEmanuele Giuseppe Esposito * - Return status 0 of .bdrv_co_block_status means that corresponding 143ebc2752bSEmanuele Giuseppe Esposito * blocks are not allocated in this layer of backing-chain 144ebc2752bSEmanuele Giuseppe Esposito * - For such (unallocated) blocks, read will: 145ebc2752bSEmanuele Giuseppe Esposito * - fill buffer with zeros if there is no backing file 146ebc2752bSEmanuele Giuseppe Esposito * - read from the backing file otherwise, where the block layer 147ebc2752bSEmanuele Giuseppe Esposito * takes care of reading zeros beyond EOF if backing file is short 148ebc2752bSEmanuele Giuseppe Esposito */ 149ebc2752bSEmanuele Giuseppe Esposito bool supports_backing; 150ebc2752bSEmanuele Giuseppe Esposito 15169c0bf11SEmanuele Giuseppe Esposito bool has_variable_length; 15269c0bf11SEmanuele Giuseppe Esposito 15369c0bf11SEmanuele Giuseppe Esposito /* 15469c0bf11SEmanuele Giuseppe Esposito * Drivers setting this field must be able to work with just a plain 15569c0bf11SEmanuele Giuseppe Esposito * filename with '<protocol_name>:' as a prefix, and no other options. 15669c0bf11SEmanuele Giuseppe Esposito * Options may be extracted from the filename by implementing 15769c0bf11SEmanuele Giuseppe Esposito * bdrv_parse_filename. 15869c0bf11SEmanuele Giuseppe Esposito */ 15969c0bf11SEmanuele Giuseppe Esposito const char *protocol_name; 16069c0bf11SEmanuele Giuseppe Esposito 16169c0bf11SEmanuele Giuseppe Esposito /* List of options for creating images, terminated by name == NULL */ 16269c0bf11SEmanuele Giuseppe Esposito QemuOptsList *create_opts; 16369c0bf11SEmanuele Giuseppe Esposito 16469c0bf11SEmanuele Giuseppe Esposito /* List of options for image amend */ 16569c0bf11SEmanuele Giuseppe Esposito QemuOptsList *amend_opts; 16669c0bf11SEmanuele Giuseppe Esposito 16769c0bf11SEmanuele Giuseppe Esposito /* 16869c0bf11SEmanuele Giuseppe Esposito * If this driver supports reopening images this contains a 16969c0bf11SEmanuele Giuseppe Esposito * NULL-terminated list of the runtime options that can be 17069c0bf11SEmanuele Giuseppe Esposito * modified. If an option in this list is unspecified during 17169c0bf11SEmanuele Giuseppe Esposito * reopen then it _must_ be reset to its default value or return 17269c0bf11SEmanuele Giuseppe Esposito * an error. 17369c0bf11SEmanuele Giuseppe Esposito */ 17469c0bf11SEmanuele Giuseppe Esposito const char *const *mutable_opts; 17569c0bf11SEmanuele Giuseppe Esposito 17669c0bf11SEmanuele Giuseppe Esposito /* 17769c0bf11SEmanuele Giuseppe Esposito * Pointer to a NULL-terminated array of names of strong options 17869c0bf11SEmanuele Giuseppe Esposito * that can be specified for bdrv_open(). A strong option is one 17969c0bf11SEmanuele Giuseppe Esposito * that changes the data of a BDS. 18069c0bf11SEmanuele Giuseppe Esposito * If this pointer is NULL, the array is considered empty. 18169c0bf11SEmanuele Giuseppe Esposito * "filename" and "driver" are always considered strong. 18269c0bf11SEmanuele Giuseppe Esposito */ 18369c0bf11SEmanuele Giuseppe Esposito const char *const *strong_runtime_opts; 18469c0bf11SEmanuele Giuseppe Esposito 18569c0bf11SEmanuele Giuseppe Esposito 18669c0bf11SEmanuele Giuseppe Esposito /* 18769c0bf11SEmanuele Giuseppe Esposito * Global state (GS) API. These functions run under the BQL. 18869c0bf11SEmanuele Giuseppe Esposito * 18969c0bf11SEmanuele Giuseppe Esposito * See include/block/block-global-state.h for more information about 19069c0bf11SEmanuele Giuseppe Esposito * the GS API. 19169c0bf11SEmanuele Giuseppe Esposito */ 19269c0bf11SEmanuele Giuseppe Esposito 19369c0bf11SEmanuele Giuseppe Esposito /* 19469c0bf11SEmanuele Giuseppe Esposito * This function is invoked under BQL before .bdrv_co_amend() 19569c0bf11SEmanuele Giuseppe Esposito * (which in contrast does not necessarily run under the BQL) 19669c0bf11SEmanuele Giuseppe Esposito * to allow driver-specific initialization code that requires 19769c0bf11SEmanuele Giuseppe Esposito * the BQL, like setting up specific permission flags. 19869c0bf11SEmanuele Giuseppe Esposito */ 19969c0bf11SEmanuele Giuseppe Esposito int (*bdrv_amend_pre_run)(BlockDriverState *bs, Error **errp); 20069c0bf11SEmanuele Giuseppe Esposito /* 20169c0bf11SEmanuele Giuseppe Esposito * This function is invoked under BQL after .bdrv_co_amend() 20269c0bf11SEmanuele Giuseppe Esposito * to allow cleaning up what was done in .bdrv_amend_pre_run(). 20369c0bf11SEmanuele Giuseppe Esposito */ 20469c0bf11SEmanuele Giuseppe Esposito void (*bdrv_amend_clean)(BlockDriverState *bs); 20569c0bf11SEmanuele Giuseppe Esposito 20669c0bf11SEmanuele Giuseppe Esposito /* 20769c0bf11SEmanuele Giuseppe Esposito * Return true if @to_replace can be replaced by a BDS with the 20869c0bf11SEmanuele Giuseppe Esposito * same data as @bs without it affecting @bs's behavior (that is, 20969c0bf11SEmanuele Giuseppe Esposito * without it being visible to @bs's parents). 21069c0bf11SEmanuele Giuseppe Esposito */ 21169c0bf11SEmanuele Giuseppe Esposito bool (*bdrv_recurse_can_replace)(BlockDriverState *bs, 21269c0bf11SEmanuele Giuseppe Esposito BlockDriverState *to_replace); 21369c0bf11SEmanuele Giuseppe Esposito 21469c0bf11SEmanuele Giuseppe Esposito int (*bdrv_probe_device)(const char *filename); 21569c0bf11SEmanuele Giuseppe Esposito 21669c0bf11SEmanuele Giuseppe Esposito /* 21769c0bf11SEmanuele Giuseppe Esposito * Any driver implementing this callback is expected to be able to handle 21869c0bf11SEmanuele Giuseppe Esposito * NULL file names in its .bdrv_open() implementation. 21969c0bf11SEmanuele Giuseppe Esposito */ 22069c0bf11SEmanuele Giuseppe Esposito void (*bdrv_parse_filename)(const char *filename, QDict *options, 22169c0bf11SEmanuele Giuseppe Esposito Error **errp); 22269c0bf11SEmanuele Giuseppe Esposito 22369c0bf11SEmanuele Giuseppe Esposito /* For handling image reopen for split or non-split files. */ 224ebc2752bSEmanuele Giuseppe Esposito int (*bdrv_reopen_prepare)(BDRVReopenState *reopen_state, 225ebc2752bSEmanuele Giuseppe Esposito BlockReopenQueue *queue, Error **errp); 226ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_reopen_commit)(BDRVReopenState *reopen_state); 227ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_reopen_commit_post)(BDRVReopenState *reopen_state); 228ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_reopen_abort)(BDRVReopenState *reopen_state); 229ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_join_options)(QDict *options, QDict *old_options); 230ebc2752bSEmanuele Giuseppe Esposito 231ebc2752bSEmanuele Giuseppe Esposito int (*bdrv_open)(BlockDriverState *bs, QDict *options, int flags, 232ebc2752bSEmanuele Giuseppe Esposito Error **errp); 233ebc2752bSEmanuele Giuseppe Esposito 234ebc2752bSEmanuele Giuseppe Esposito /* Protocol drivers should implement this instead of bdrv_open */ 235ebc2752bSEmanuele Giuseppe Esposito int (*bdrv_file_open)(BlockDriverState *bs, QDict *options, int flags, 236ebc2752bSEmanuele Giuseppe Esposito Error **errp); 237ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_close)(BlockDriverState *bs); 238ebc2752bSEmanuele Giuseppe Esposito 239ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_create)(BlockdevCreateOptions *opts, 240ebc2752bSEmanuele Giuseppe Esposito Error **errp); 241ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_create_opts)(BlockDriver *drv, 242ebc2752bSEmanuele Giuseppe Esposito const char *filename, 243ebc2752bSEmanuele Giuseppe Esposito QemuOpts *opts, 244ebc2752bSEmanuele Giuseppe Esposito Error **errp); 245ebc2752bSEmanuele Giuseppe Esposito 246ebc2752bSEmanuele Giuseppe Esposito int (*bdrv_amend_options)(BlockDriverState *bs, 247ebc2752bSEmanuele Giuseppe Esposito QemuOpts *opts, 248ebc2752bSEmanuele Giuseppe Esposito BlockDriverAmendStatusCB *status_cb, 249ebc2752bSEmanuele Giuseppe Esposito void *cb_opaque, 250ebc2752bSEmanuele Giuseppe Esposito bool force, 251ebc2752bSEmanuele Giuseppe Esposito Error **errp); 252ebc2752bSEmanuele Giuseppe Esposito 253ebc2752bSEmanuele Giuseppe Esposito int (*bdrv_make_empty)(BlockDriverState *bs); 254ebc2752bSEmanuele Giuseppe Esposito 255ebc2752bSEmanuele Giuseppe Esposito /* 256ebc2752bSEmanuele Giuseppe Esposito * Refreshes the bs->exact_filename field. If that is impossible, 257ebc2752bSEmanuele Giuseppe Esposito * bs->exact_filename has to be left empty. 258ebc2752bSEmanuele Giuseppe Esposito */ 259ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_refresh_filename)(BlockDriverState *bs); 260ebc2752bSEmanuele Giuseppe Esposito 261ebc2752bSEmanuele Giuseppe Esposito /* 262ebc2752bSEmanuele Giuseppe Esposito * Gathers the open options for all children into @target. 263ebc2752bSEmanuele Giuseppe Esposito * A simple format driver (without backing file support) might 264ebc2752bSEmanuele Giuseppe Esposito * implement this function like this: 265ebc2752bSEmanuele Giuseppe Esposito * 266ebc2752bSEmanuele Giuseppe Esposito * QINCREF(bs->file->bs->full_open_options); 267ebc2752bSEmanuele Giuseppe Esposito * qdict_put(target, "file", bs->file->bs->full_open_options); 268ebc2752bSEmanuele Giuseppe Esposito * 269ebc2752bSEmanuele Giuseppe Esposito * If not specified, the generic implementation will simply put 270ebc2752bSEmanuele Giuseppe Esposito * all children's options under their respective name. 271ebc2752bSEmanuele Giuseppe Esposito * 272ebc2752bSEmanuele Giuseppe Esposito * @backing_overridden is true when bs->backing seems not to be 273ebc2752bSEmanuele Giuseppe Esposito * the child that would result from opening bs->backing_file. 274ebc2752bSEmanuele Giuseppe Esposito * Therefore, if it is true, the backing child's options should be 275ebc2752bSEmanuele Giuseppe Esposito * gathered; otherwise, there is no need since the backing child 276ebc2752bSEmanuele Giuseppe Esposito * is the one implied by the image header. 277ebc2752bSEmanuele Giuseppe Esposito * 278ebc2752bSEmanuele Giuseppe Esposito * Note that ideally this function would not be needed. Every 279ebc2752bSEmanuele Giuseppe Esposito * block driver which implements it is probably doing something 280ebc2752bSEmanuele Giuseppe Esposito * shady regarding its runtime option structure. 281ebc2752bSEmanuele Giuseppe Esposito */ 282ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_gather_child_options)(BlockDriverState *bs, QDict *target, 283ebc2752bSEmanuele Giuseppe Esposito bool backing_overridden); 284ebc2752bSEmanuele Giuseppe Esposito 285ebc2752bSEmanuele Giuseppe Esposito /* 286ebc2752bSEmanuele Giuseppe Esposito * Returns an allocated string which is the directory name of this BDS: It 287ebc2752bSEmanuele Giuseppe Esposito * will be used to make relative filenames absolute by prepending this 288ebc2752bSEmanuele Giuseppe Esposito * function's return value to them. 289ebc2752bSEmanuele Giuseppe Esposito */ 290ebc2752bSEmanuele Giuseppe Esposito char *(*bdrv_dirname)(BlockDriverState *bs, Error **errp); 291ebc2752bSEmanuele Giuseppe Esposito 29269c0bf11SEmanuele Giuseppe Esposito /* 29369c0bf11SEmanuele Giuseppe Esposito * This informs the driver that we are no longer interested in the result 29469c0bf11SEmanuele Giuseppe Esposito * of in-flight requests, so don't waste the time if possible. 29569c0bf11SEmanuele Giuseppe Esposito * 29669c0bf11SEmanuele Giuseppe Esposito * One example usage is to avoid waiting for an nbd target node reconnect 29769c0bf11SEmanuele Giuseppe Esposito * timeout during job-cancel with force=true. 29869c0bf11SEmanuele Giuseppe Esposito */ 29969c0bf11SEmanuele Giuseppe Esposito void (*bdrv_cancel_in_flight)(BlockDriverState *bs); 30069c0bf11SEmanuele Giuseppe Esposito 30169c0bf11SEmanuele Giuseppe Esposito int (*bdrv_inactivate)(BlockDriverState *bs); 30269c0bf11SEmanuele Giuseppe Esposito 30369c0bf11SEmanuele Giuseppe Esposito int (*bdrv_snapshot_create)(BlockDriverState *bs, 30469c0bf11SEmanuele Giuseppe Esposito QEMUSnapshotInfo *sn_info); 30569c0bf11SEmanuele Giuseppe Esposito int (*bdrv_snapshot_goto)(BlockDriverState *bs, 30669c0bf11SEmanuele Giuseppe Esposito const char *snapshot_id); 30769c0bf11SEmanuele Giuseppe Esposito int (*bdrv_snapshot_delete)(BlockDriverState *bs, 30869c0bf11SEmanuele Giuseppe Esposito const char *snapshot_id, 30969c0bf11SEmanuele Giuseppe Esposito const char *name, 31069c0bf11SEmanuele Giuseppe Esposito Error **errp); 31169c0bf11SEmanuele Giuseppe Esposito int (*bdrv_snapshot_list)(BlockDriverState *bs, 31269c0bf11SEmanuele Giuseppe Esposito QEMUSnapshotInfo **psn_info); 31369c0bf11SEmanuele Giuseppe Esposito int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs, 31469c0bf11SEmanuele Giuseppe Esposito const char *snapshot_id, 31569c0bf11SEmanuele Giuseppe Esposito const char *name, 31669c0bf11SEmanuele Giuseppe Esposito Error **errp); 31769c0bf11SEmanuele Giuseppe Esposito 31869c0bf11SEmanuele Giuseppe Esposito int (*bdrv_change_backing_file)(BlockDriverState *bs, 31969c0bf11SEmanuele Giuseppe Esposito const char *backing_file, const char *backing_fmt); 32069c0bf11SEmanuele Giuseppe Esposito 32169c0bf11SEmanuele Giuseppe Esposito /* TODO Better pass a option string/QDict/QemuOpts to add any rule? */ 32269c0bf11SEmanuele Giuseppe Esposito int (*bdrv_debug_breakpoint)(BlockDriverState *bs, const char *event, 32369c0bf11SEmanuele Giuseppe Esposito const char *tag); 32469c0bf11SEmanuele Giuseppe Esposito int (*bdrv_debug_remove_breakpoint)(BlockDriverState *bs, 32569c0bf11SEmanuele Giuseppe Esposito const char *tag); 32669c0bf11SEmanuele Giuseppe Esposito int (*bdrv_debug_resume)(BlockDriverState *bs, const char *tag); 32769c0bf11SEmanuele Giuseppe Esposito bool (*bdrv_debug_is_suspended)(BlockDriverState *bs, const char *tag); 32869c0bf11SEmanuele Giuseppe Esposito 32969c0bf11SEmanuele Giuseppe Esposito void (*bdrv_refresh_limits)(BlockDriverState *bs, Error **errp); 33069c0bf11SEmanuele Giuseppe Esposito 33169c0bf11SEmanuele Giuseppe Esposito /* 33269c0bf11SEmanuele Giuseppe Esposito * Returns 1 if newly created images are guaranteed to contain only 33369c0bf11SEmanuele Giuseppe Esposito * zeros, 0 otherwise. 33469c0bf11SEmanuele Giuseppe Esposito */ 33569c0bf11SEmanuele Giuseppe Esposito int (*bdrv_has_zero_init)(BlockDriverState *bs); 33669c0bf11SEmanuele Giuseppe Esposito 33769c0bf11SEmanuele Giuseppe Esposito /* 33869c0bf11SEmanuele Giuseppe Esposito * Remove fd handlers, timers, and other event loop callbacks so the event 33969c0bf11SEmanuele Giuseppe Esposito * loop is no longer in use. Called with no in-flight requests and in 34069c0bf11SEmanuele Giuseppe Esposito * depth-first traversal order with parents before child nodes. 34169c0bf11SEmanuele Giuseppe Esposito */ 34269c0bf11SEmanuele Giuseppe Esposito void (*bdrv_detach_aio_context)(BlockDriverState *bs); 34369c0bf11SEmanuele Giuseppe Esposito 34469c0bf11SEmanuele Giuseppe Esposito /* 34569c0bf11SEmanuele Giuseppe Esposito * Add fd handlers, timers, and other event loop callbacks so I/O requests 34669c0bf11SEmanuele Giuseppe Esposito * can be processed again. Called with no in-flight requests and in 34769c0bf11SEmanuele Giuseppe Esposito * depth-first traversal order with child nodes before parent nodes. 34869c0bf11SEmanuele Giuseppe Esposito */ 34969c0bf11SEmanuele Giuseppe Esposito void (*bdrv_attach_aio_context)(BlockDriverState *bs, 35069c0bf11SEmanuele Giuseppe Esposito AioContext *new_context); 35169c0bf11SEmanuele Giuseppe Esposito 35269c0bf11SEmanuele Giuseppe Esposito /** 35369c0bf11SEmanuele Giuseppe Esposito * Try to get @bs's logical and physical block size. 35469c0bf11SEmanuele Giuseppe Esposito * On success, store them in @bsz and return zero. 35569c0bf11SEmanuele Giuseppe Esposito * On failure, return negative errno. 35669c0bf11SEmanuele Giuseppe Esposito */ 35769c0bf11SEmanuele Giuseppe Esposito int (*bdrv_probe_blocksizes)(BlockDriverState *bs, BlockSizes *bsz); 35869c0bf11SEmanuele Giuseppe Esposito /** 35969c0bf11SEmanuele Giuseppe Esposito * Try to get @bs's geometry (cyls, heads, sectors) 36069c0bf11SEmanuele Giuseppe Esposito * On success, store them in @geo and return 0. 36169c0bf11SEmanuele Giuseppe Esposito * On failure return -errno. 36269c0bf11SEmanuele Giuseppe Esposito * Only drivers that want to override guest geometry implement this 36369c0bf11SEmanuele Giuseppe Esposito * callback; see hd_geometry_guess(). 36469c0bf11SEmanuele Giuseppe Esposito */ 36569c0bf11SEmanuele Giuseppe Esposito int (*bdrv_probe_geometry)(BlockDriverState *bs, HDGeometry *geo); 36669c0bf11SEmanuele Giuseppe Esposito 36769c0bf11SEmanuele Giuseppe Esposito void (*bdrv_add_child)(BlockDriverState *parent, BlockDriverState *child, 36869c0bf11SEmanuele Giuseppe Esposito Error **errp); 36969c0bf11SEmanuele Giuseppe Esposito void (*bdrv_del_child)(BlockDriverState *parent, BdrvChild *child, 37069c0bf11SEmanuele Giuseppe Esposito Error **errp); 37169c0bf11SEmanuele Giuseppe Esposito 37269c0bf11SEmanuele Giuseppe Esposito /** 37369c0bf11SEmanuele Giuseppe Esposito * Informs the block driver that a permission change is intended. The 37469c0bf11SEmanuele Giuseppe Esposito * driver checks whether the change is permissible and may take other 37569c0bf11SEmanuele Giuseppe Esposito * preparations for the change (e.g. get file system locks). This operation 37669c0bf11SEmanuele Giuseppe Esposito * is always followed either by a call to either .bdrv_set_perm or 37769c0bf11SEmanuele Giuseppe Esposito * .bdrv_abort_perm_update. 37869c0bf11SEmanuele Giuseppe Esposito * 37969c0bf11SEmanuele Giuseppe Esposito * Checks whether the requested set of cumulative permissions in @perm 38069c0bf11SEmanuele Giuseppe Esposito * can be granted for accessing @bs and whether no other users are using 38169c0bf11SEmanuele Giuseppe Esposito * permissions other than those given in @shared (both arguments take 38269c0bf11SEmanuele Giuseppe Esposito * BLK_PERM_* bitmasks). 38369c0bf11SEmanuele Giuseppe Esposito * 38469c0bf11SEmanuele Giuseppe Esposito * If both conditions are met, 0 is returned. Otherwise, -errno is returned 38569c0bf11SEmanuele Giuseppe Esposito * and errp is set to an error describing the conflict. 38669c0bf11SEmanuele Giuseppe Esposito */ 38769c0bf11SEmanuele Giuseppe Esposito int (*bdrv_check_perm)(BlockDriverState *bs, uint64_t perm, 38869c0bf11SEmanuele Giuseppe Esposito uint64_t shared, Error **errp); 38969c0bf11SEmanuele Giuseppe Esposito 39069c0bf11SEmanuele Giuseppe Esposito /** 39169c0bf11SEmanuele Giuseppe Esposito * Called to inform the driver that the set of cumulative set of used 39269c0bf11SEmanuele Giuseppe Esposito * permissions for @bs has changed to @perm, and the set of sharable 39369c0bf11SEmanuele Giuseppe Esposito * permission to @shared. The driver can use this to propagate changes to 39469c0bf11SEmanuele Giuseppe Esposito * its children (i.e. request permissions only if a parent actually needs 39569c0bf11SEmanuele Giuseppe Esposito * them). 39669c0bf11SEmanuele Giuseppe Esposito * 39769c0bf11SEmanuele Giuseppe Esposito * This function is only invoked after bdrv_check_perm(), so block drivers 39869c0bf11SEmanuele Giuseppe Esposito * may rely on preparations made in their .bdrv_check_perm implementation. 39969c0bf11SEmanuele Giuseppe Esposito */ 40069c0bf11SEmanuele Giuseppe Esposito void (*bdrv_set_perm)(BlockDriverState *bs, uint64_t perm, uint64_t shared); 40169c0bf11SEmanuele Giuseppe Esposito 40269c0bf11SEmanuele Giuseppe Esposito /* 40369c0bf11SEmanuele Giuseppe Esposito * Called to inform the driver that after a previous bdrv_check_perm() 40469c0bf11SEmanuele Giuseppe Esposito * call, the permission update is not performed and any preparations made 40569c0bf11SEmanuele Giuseppe Esposito * for it (e.g. taken file locks) need to be undone. 40669c0bf11SEmanuele Giuseppe Esposito * 40769c0bf11SEmanuele Giuseppe Esposito * This function can be called even for nodes that never saw a 40869c0bf11SEmanuele Giuseppe Esposito * bdrv_check_perm() call. It is a no-op then. 40969c0bf11SEmanuele Giuseppe Esposito */ 41069c0bf11SEmanuele Giuseppe Esposito void (*bdrv_abort_perm_update)(BlockDriverState *bs); 41169c0bf11SEmanuele Giuseppe Esposito 41269c0bf11SEmanuele Giuseppe Esposito /** 41369c0bf11SEmanuele Giuseppe Esposito * Returns in @nperm and @nshared the permissions that the driver for @bs 41469c0bf11SEmanuele Giuseppe Esposito * needs on its child @c, based on the cumulative permissions requested by 41569c0bf11SEmanuele Giuseppe Esposito * the parents in @parent_perm and @parent_shared. 41669c0bf11SEmanuele Giuseppe Esposito * 41769c0bf11SEmanuele Giuseppe Esposito * If @c is NULL, return the permissions for attaching a new child for the 41869c0bf11SEmanuele Giuseppe Esposito * given @child_class and @role. 41969c0bf11SEmanuele Giuseppe Esposito * 42069c0bf11SEmanuele Giuseppe Esposito * If @reopen_queue is non-NULL, don't return the currently needed 42169c0bf11SEmanuele Giuseppe Esposito * permissions, but those that will be needed after applying the 42269c0bf11SEmanuele Giuseppe Esposito * @reopen_queue. 42369c0bf11SEmanuele Giuseppe Esposito */ 42469c0bf11SEmanuele Giuseppe Esposito void (*bdrv_child_perm)(BlockDriverState *bs, BdrvChild *c, 42569c0bf11SEmanuele Giuseppe Esposito BdrvChildRole role, 42669c0bf11SEmanuele Giuseppe Esposito BlockReopenQueue *reopen_queue, 42769c0bf11SEmanuele Giuseppe Esposito uint64_t parent_perm, uint64_t parent_shared, 42869c0bf11SEmanuele Giuseppe Esposito uint64_t *nperm, uint64_t *nshared); 42969c0bf11SEmanuele Giuseppe Esposito 43069c0bf11SEmanuele Giuseppe Esposito /** 43169c0bf11SEmanuele Giuseppe Esposito * Register/unregister a buffer for I/O. For example, when the driver is 43269c0bf11SEmanuele Giuseppe Esposito * interested to know the memory areas that will later be used in iovs, so 43369c0bf11SEmanuele Giuseppe Esposito * that it can do IOMMU mapping with VFIO etc., in order to get better 43469c0bf11SEmanuele Giuseppe Esposito * performance. In the case of VFIO drivers, this callback is used to do 43569c0bf11SEmanuele Giuseppe Esposito * DMA mapping for hot buffers. 43669c0bf11SEmanuele Giuseppe Esposito */ 43769c0bf11SEmanuele Giuseppe Esposito void (*bdrv_register_buf)(BlockDriverState *bs, void *host, size_t size); 43869c0bf11SEmanuele Giuseppe Esposito void (*bdrv_unregister_buf)(BlockDriverState *bs, void *host); 43969c0bf11SEmanuele Giuseppe Esposito 44069c0bf11SEmanuele Giuseppe Esposito /* 44169c0bf11SEmanuele Giuseppe Esposito * This field is modified only under the BQL, and is part of 44269c0bf11SEmanuele Giuseppe Esposito * the global state. 44369c0bf11SEmanuele Giuseppe Esposito */ 44469c0bf11SEmanuele Giuseppe Esposito QLIST_ENTRY(BlockDriver) list; 44569c0bf11SEmanuele Giuseppe Esposito 44669c0bf11SEmanuele Giuseppe Esposito /* 44769c0bf11SEmanuele Giuseppe Esposito * I/O API functions. These functions are thread-safe. 44869c0bf11SEmanuele Giuseppe Esposito * 44969c0bf11SEmanuele Giuseppe Esposito * See include/block/block-io.h for more information about 45069c0bf11SEmanuele Giuseppe Esposito * the I/O API. 45169c0bf11SEmanuele Giuseppe Esposito */ 45269c0bf11SEmanuele Giuseppe Esposito 45369c0bf11SEmanuele Giuseppe Esposito int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename); 45469c0bf11SEmanuele Giuseppe Esposito 45569c0bf11SEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_amend)(BlockDriverState *bs, 45669c0bf11SEmanuele Giuseppe Esposito BlockdevAmendOptions *opts, 45769c0bf11SEmanuele Giuseppe Esposito bool force, 45869c0bf11SEmanuele Giuseppe Esposito Error **errp); 45969c0bf11SEmanuele Giuseppe Esposito 460ebc2752bSEmanuele Giuseppe Esposito /* aio */ 461ebc2752bSEmanuele Giuseppe Esposito BlockAIOCB *(*bdrv_aio_preadv)(BlockDriverState *bs, 462ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes, QEMUIOVector *qiov, 463ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags flags, BlockCompletionFunc *cb, void *opaque); 464ebc2752bSEmanuele Giuseppe Esposito BlockAIOCB *(*bdrv_aio_pwritev)(BlockDriverState *bs, 465ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes, QEMUIOVector *qiov, 466ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags flags, BlockCompletionFunc *cb, void *opaque); 467ebc2752bSEmanuele Giuseppe Esposito BlockAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs, 468ebc2752bSEmanuele Giuseppe Esposito BlockCompletionFunc *cb, void *opaque); 469ebc2752bSEmanuele Giuseppe Esposito BlockAIOCB *(*bdrv_aio_pdiscard)(BlockDriverState *bs, 470ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int bytes, 471ebc2752bSEmanuele Giuseppe Esposito BlockCompletionFunc *cb, void *opaque); 472ebc2752bSEmanuele Giuseppe Esposito 473ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs, 474ebc2752bSEmanuele Giuseppe Esposito int64_t sector_num, int nb_sectors, QEMUIOVector *qiov); 475ebc2752bSEmanuele Giuseppe Esposito 476ebc2752bSEmanuele Giuseppe Esposito /** 477ebc2752bSEmanuele Giuseppe Esposito * @offset: position in bytes to read at 478ebc2752bSEmanuele Giuseppe Esposito * @bytes: number of bytes to read 479ebc2752bSEmanuele Giuseppe Esposito * @qiov: the buffers to fill with read data 480ebc2752bSEmanuele Giuseppe Esposito * @flags: currently unused, always 0 481ebc2752bSEmanuele Giuseppe Esposito * 482ebc2752bSEmanuele Giuseppe Esposito * @offset and @bytes will be a multiple of 'request_alignment', 483ebc2752bSEmanuele Giuseppe Esposito * but the length of individual @qiov elements does not have to 484ebc2752bSEmanuele Giuseppe Esposito * be a multiple. 485ebc2752bSEmanuele Giuseppe Esposito * 486ebc2752bSEmanuele Giuseppe Esposito * @bytes will always equal the total size of @qiov, and will be 487ebc2752bSEmanuele Giuseppe Esposito * no larger than 'max_transfer'. 488ebc2752bSEmanuele Giuseppe Esposito * 489ebc2752bSEmanuele Giuseppe Esposito * The buffer in @qiov may point directly to guest memory. 490ebc2752bSEmanuele Giuseppe Esposito */ 491ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_preadv)(BlockDriverState *bs, 492ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes, QEMUIOVector *qiov, 493ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags flags); 494ebc2752bSEmanuele Giuseppe Esposito 495ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_preadv_part)(BlockDriverState *bs, 496ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes, 497ebc2752bSEmanuele Giuseppe Esposito QEMUIOVector *qiov, size_t qiov_offset, 498ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags flags); 499ebc2752bSEmanuele Giuseppe Esposito 500ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs, 501ebc2752bSEmanuele Giuseppe Esposito int64_t sector_num, int nb_sectors, QEMUIOVector *qiov, 502ebc2752bSEmanuele Giuseppe Esposito int flags); 503ebc2752bSEmanuele Giuseppe Esposito /** 504ebc2752bSEmanuele Giuseppe Esposito * @offset: position in bytes to write at 505ebc2752bSEmanuele Giuseppe Esposito * @bytes: number of bytes to write 506ebc2752bSEmanuele Giuseppe Esposito * @qiov: the buffers containing data to write 507ebc2752bSEmanuele Giuseppe Esposito * @flags: zero or more bits allowed by 'supported_write_flags' 508ebc2752bSEmanuele Giuseppe Esposito * 509ebc2752bSEmanuele Giuseppe Esposito * @offset and @bytes will be a multiple of 'request_alignment', 510ebc2752bSEmanuele Giuseppe Esposito * but the length of individual @qiov elements does not have to 511ebc2752bSEmanuele Giuseppe Esposito * be a multiple. 512ebc2752bSEmanuele Giuseppe Esposito * 513ebc2752bSEmanuele Giuseppe Esposito * @bytes will always equal the total size of @qiov, and will be 514ebc2752bSEmanuele Giuseppe Esposito * no larger than 'max_transfer'. 515ebc2752bSEmanuele Giuseppe Esposito * 516ebc2752bSEmanuele Giuseppe Esposito * The buffer in @qiov may point directly to guest memory. 517ebc2752bSEmanuele Giuseppe Esposito */ 518ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_pwritev)(BlockDriverState *bs, 519ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes, QEMUIOVector *qiov, 520ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags flags); 521ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_pwritev_part)(BlockDriverState *bs, 522ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes, QEMUIOVector *qiov, size_t qiov_offset, 523ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags flags); 524ebc2752bSEmanuele Giuseppe Esposito 525ebc2752bSEmanuele Giuseppe Esposito /* 526ebc2752bSEmanuele Giuseppe Esposito * Efficiently zero a region of the disk image. Typically an image format 527ebc2752bSEmanuele Giuseppe Esposito * would use a compact metadata representation to implement this. This 528ebc2752bSEmanuele Giuseppe Esposito * function pointer may be NULL or return -ENOSUP and .bdrv_co_writev() 529ebc2752bSEmanuele Giuseppe Esposito * will be called instead. 530ebc2752bSEmanuele Giuseppe Esposito */ 531ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_pwrite_zeroes)(BlockDriverState *bs, 532ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes, BdrvRequestFlags flags); 533ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_pdiscard)(BlockDriverState *bs, 534ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes); 535ebc2752bSEmanuele Giuseppe Esposito 536ebc2752bSEmanuele Giuseppe Esposito /* 537ebc2752bSEmanuele Giuseppe Esposito * Map [offset, offset + nbytes) range onto a child of @bs to copy from, 538ebc2752bSEmanuele Giuseppe Esposito * and invoke bdrv_co_copy_range_from(child, ...), or invoke 539ebc2752bSEmanuele Giuseppe Esposito * bdrv_co_copy_range_to() if @bs is the leaf child to copy data from. 540ebc2752bSEmanuele Giuseppe Esposito * 541ebc2752bSEmanuele Giuseppe Esposito * See the comment of bdrv_co_copy_range for the parameter and return value 542ebc2752bSEmanuele Giuseppe Esposito * semantics. 543ebc2752bSEmanuele Giuseppe Esposito */ 544ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_copy_range_from)(BlockDriverState *bs, 545ebc2752bSEmanuele Giuseppe Esposito BdrvChild *src, 546ebc2752bSEmanuele Giuseppe Esposito int64_t offset, 547ebc2752bSEmanuele Giuseppe Esposito BdrvChild *dst, 548ebc2752bSEmanuele Giuseppe Esposito int64_t dst_offset, 549ebc2752bSEmanuele Giuseppe Esposito int64_t bytes, 550ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags read_flags, 551ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags write_flags); 552ebc2752bSEmanuele Giuseppe Esposito 553ebc2752bSEmanuele Giuseppe Esposito /* 554ebc2752bSEmanuele Giuseppe Esposito * Map [offset, offset + nbytes) range onto a child of bs to copy data to, 555ebc2752bSEmanuele Giuseppe Esposito * and invoke bdrv_co_copy_range_to(child, src, ...), or perform the copy 556ebc2752bSEmanuele Giuseppe Esposito * operation if @bs is the leaf and @src has the same BlockDriver. Return 557ebc2752bSEmanuele Giuseppe Esposito * -ENOTSUP if @bs is the leaf but @src has a different BlockDriver. 558ebc2752bSEmanuele Giuseppe Esposito * 559ebc2752bSEmanuele Giuseppe Esposito * See the comment of bdrv_co_copy_range for the parameter and return value 560ebc2752bSEmanuele Giuseppe Esposito * semantics. 561ebc2752bSEmanuele Giuseppe Esposito */ 562ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_copy_range_to)(BlockDriverState *bs, 563ebc2752bSEmanuele Giuseppe Esposito BdrvChild *src, 564ebc2752bSEmanuele Giuseppe Esposito int64_t src_offset, 565ebc2752bSEmanuele Giuseppe Esposito BdrvChild *dst, 566ebc2752bSEmanuele Giuseppe Esposito int64_t dst_offset, 567ebc2752bSEmanuele Giuseppe Esposito int64_t bytes, 568ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags read_flags, 569ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags write_flags); 570ebc2752bSEmanuele Giuseppe Esposito 571ebc2752bSEmanuele Giuseppe Esposito /* 572ebc2752bSEmanuele Giuseppe Esposito * Building block for bdrv_block_status[_above] and 573ebc2752bSEmanuele Giuseppe Esposito * bdrv_is_allocated[_above]. The driver should answer only 574ebc2752bSEmanuele Giuseppe Esposito * according to the current layer, and should only need to set 575ebc2752bSEmanuele Giuseppe Esposito * BDRV_BLOCK_DATA, BDRV_BLOCK_ZERO, BDRV_BLOCK_OFFSET_VALID, 576ebc2752bSEmanuele Giuseppe Esposito * and/or BDRV_BLOCK_RAW; if the current layer defers to a backing 577ebc2752bSEmanuele Giuseppe Esposito * layer, the result should be 0 (and not BDRV_BLOCK_ZERO). See 578ebc2752bSEmanuele Giuseppe Esposito * block.h for the overall meaning of the bits. As a hint, the 579ebc2752bSEmanuele Giuseppe Esposito * flag want_zero is true if the caller cares more about precise 580ebc2752bSEmanuele Giuseppe Esposito * mappings (favor accurate _OFFSET_VALID/_ZERO) or false for 581ebc2752bSEmanuele Giuseppe Esposito * overall allocation (favor larger *pnum, perhaps by reporting 582ebc2752bSEmanuele Giuseppe Esposito * _DATA instead of _ZERO). The block layer guarantees input 583ebc2752bSEmanuele Giuseppe Esposito * clamped to bdrv_getlength() and aligned to request_alignment, 584ebc2752bSEmanuele Giuseppe Esposito * as well as non-NULL pnum, map, and file; in turn, the driver 585ebc2752bSEmanuele Giuseppe Esposito * must return an error or set pnum to an aligned non-zero value. 586ebc2752bSEmanuele Giuseppe Esposito * 587ebc2752bSEmanuele Giuseppe Esposito * Note that @bytes is just a hint on how big of a region the 588ebc2752bSEmanuele Giuseppe Esposito * caller wants to inspect. It is not a limit on *pnum. 589ebc2752bSEmanuele Giuseppe Esposito * Implementations are free to return larger values of *pnum if 590ebc2752bSEmanuele Giuseppe Esposito * doing so does not incur a performance penalty. 591ebc2752bSEmanuele Giuseppe Esposito * 592ebc2752bSEmanuele Giuseppe Esposito * block/io.c's bdrv_co_block_status() will utilize an unclamped 593ebc2752bSEmanuele Giuseppe Esposito * *pnum value for the block-status cache on protocol nodes, prior 594ebc2752bSEmanuele Giuseppe Esposito * to clamping *pnum for return to its caller. 595ebc2752bSEmanuele Giuseppe Esposito */ 596ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_block_status)(BlockDriverState *bs, 597ebc2752bSEmanuele Giuseppe Esposito bool want_zero, int64_t offset, int64_t bytes, int64_t *pnum, 598ebc2752bSEmanuele Giuseppe Esposito int64_t *map, BlockDriverState **file); 599ebc2752bSEmanuele Giuseppe Esposito 600ebc2752bSEmanuele Giuseppe Esposito /* 601*ce14f3b4SVladimir Sementsov-Ogievskiy * Snapshot-access API. 602*ce14f3b4SVladimir Sementsov-Ogievskiy * 603*ce14f3b4SVladimir Sementsov-Ogievskiy * Block-driver may provide snapshot-access API: special functions to access 604*ce14f3b4SVladimir Sementsov-Ogievskiy * some internal "snapshot". The functions are similar with normal 605*ce14f3b4SVladimir Sementsov-Ogievskiy * read/block_status/discard handler, but don't have any specific handling 606*ce14f3b4SVladimir Sementsov-Ogievskiy * in generic block-layer: no serializing, no alignment, no tracked 607*ce14f3b4SVladimir Sementsov-Ogievskiy * requests. So, block-driver that realizes these APIs is fully responsible 608*ce14f3b4SVladimir Sementsov-Ogievskiy * for synchronization between snapshot-access API and normal IO requests. 609*ce14f3b4SVladimir Sementsov-Ogievskiy */ 610*ce14f3b4SVladimir Sementsov-Ogievskiy int coroutine_fn (*bdrv_co_preadv_snapshot)(BlockDriverState *bs, 611*ce14f3b4SVladimir Sementsov-Ogievskiy int64_t offset, int64_t bytes, QEMUIOVector *qiov, size_t qiov_offset); 612*ce14f3b4SVladimir Sementsov-Ogievskiy int coroutine_fn (*bdrv_co_snapshot_block_status)(BlockDriverState *bs, 613*ce14f3b4SVladimir Sementsov-Ogievskiy bool want_zero, int64_t offset, int64_t bytes, int64_t *pnum, 614*ce14f3b4SVladimir Sementsov-Ogievskiy int64_t *map, BlockDriverState **file); 615*ce14f3b4SVladimir Sementsov-Ogievskiy int coroutine_fn (*bdrv_co_pdiscard_snapshot)(BlockDriverState *bs, 616*ce14f3b4SVladimir Sementsov-Ogievskiy int64_t offset, int64_t bytes); 617*ce14f3b4SVladimir Sementsov-Ogievskiy 618*ce14f3b4SVladimir Sementsov-Ogievskiy /* 619ebc2752bSEmanuele Giuseppe Esposito * Invalidate any cached meta-data. 620ebc2752bSEmanuele Giuseppe Esposito */ 621ebc2752bSEmanuele Giuseppe Esposito void coroutine_fn (*bdrv_co_invalidate_cache)(BlockDriverState *bs, 622ebc2752bSEmanuele Giuseppe Esposito Error **errp); 623ebc2752bSEmanuele Giuseppe Esposito 624ebc2752bSEmanuele Giuseppe Esposito /* 625ebc2752bSEmanuele Giuseppe Esposito * Flushes all data for all layers by calling bdrv_co_flush for underlying 626ebc2752bSEmanuele Giuseppe Esposito * layers, if needed. This function is needed for deterministic 627ebc2752bSEmanuele Giuseppe Esposito * synchronization of the flush finishing callback. 628ebc2752bSEmanuele Giuseppe Esposito */ 629ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_flush)(BlockDriverState *bs); 630ebc2752bSEmanuele Giuseppe Esposito 631ebc2752bSEmanuele Giuseppe Esposito /* Delete a created file. */ 632ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_delete_file)(BlockDriverState *bs, 633ebc2752bSEmanuele Giuseppe Esposito Error **errp); 634ebc2752bSEmanuele Giuseppe Esposito 635ebc2752bSEmanuele Giuseppe Esposito /* 636ebc2752bSEmanuele Giuseppe Esposito * Flushes all data that was already written to the OS all the way down to 637ebc2752bSEmanuele Giuseppe Esposito * the disk (for example file-posix.c calls fsync()). 638ebc2752bSEmanuele Giuseppe Esposito */ 639ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_flush_to_disk)(BlockDriverState *bs); 640ebc2752bSEmanuele Giuseppe Esposito 641ebc2752bSEmanuele Giuseppe Esposito /* 642ebc2752bSEmanuele Giuseppe Esposito * Flushes all internal caches to the OS. The data may still sit in a 643ebc2752bSEmanuele Giuseppe Esposito * writeback cache of the host OS, but it will survive a crash of the qemu 644ebc2752bSEmanuele Giuseppe Esposito * process. 645ebc2752bSEmanuele Giuseppe Esposito */ 646ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_flush_to_os)(BlockDriverState *bs); 647ebc2752bSEmanuele Giuseppe Esposito 648ebc2752bSEmanuele Giuseppe Esposito /* 649ebc2752bSEmanuele Giuseppe Esposito * Truncate @bs to @offset bytes using the given @prealloc mode 650ebc2752bSEmanuele Giuseppe Esposito * when growing. Modes other than PREALLOC_MODE_OFF should be 651ebc2752bSEmanuele Giuseppe Esposito * rejected when shrinking @bs. 652ebc2752bSEmanuele Giuseppe Esposito * 653ebc2752bSEmanuele Giuseppe Esposito * If @exact is true, @bs must be resized to exactly @offset. 654ebc2752bSEmanuele Giuseppe Esposito * Otherwise, it is sufficient for @bs (if it is a host block 655ebc2752bSEmanuele Giuseppe Esposito * device and thus there is no way to resize it) to be at least 656ebc2752bSEmanuele Giuseppe Esposito * @offset bytes in length. 657ebc2752bSEmanuele Giuseppe Esposito * 658ebc2752bSEmanuele Giuseppe Esposito * If @exact is true and this function fails but would succeed 659ebc2752bSEmanuele Giuseppe Esposito * with @exact = false, it should return -ENOTSUP. 660ebc2752bSEmanuele Giuseppe Esposito */ 661ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_truncate)(BlockDriverState *bs, int64_t offset, 662ebc2752bSEmanuele Giuseppe Esposito bool exact, PreallocMode prealloc, 663ebc2752bSEmanuele Giuseppe Esposito BdrvRequestFlags flags, Error **errp); 664ebc2752bSEmanuele Giuseppe Esposito int64_t (*bdrv_getlength)(BlockDriverState *bs); 665ebc2752bSEmanuele Giuseppe Esposito int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs); 666ebc2752bSEmanuele Giuseppe Esposito BlockMeasureInfo *(*bdrv_measure)(QemuOpts *opts, BlockDriverState *in_bs, 667ebc2752bSEmanuele Giuseppe Esposito Error **errp); 668ebc2752bSEmanuele Giuseppe Esposito 669ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_pwritev_compressed)(BlockDriverState *bs, 670ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes, QEMUIOVector *qiov); 671ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_pwritev_compressed_part)(BlockDriverState *bs, 672ebc2752bSEmanuele Giuseppe Esposito int64_t offset, int64_t bytes, QEMUIOVector *qiov, 673ebc2752bSEmanuele Giuseppe Esposito size_t qiov_offset); 674ebc2752bSEmanuele Giuseppe Esposito 675ebc2752bSEmanuele Giuseppe Esposito int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi); 676ebc2752bSEmanuele Giuseppe Esposito 677ebc2752bSEmanuele Giuseppe Esposito ImageInfoSpecific *(*bdrv_get_specific_info)(BlockDriverState *bs, 678ebc2752bSEmanuele Giuseppe Esposito Error **errp); 679ebc2752bSEmanuele Giuseppe Esposito BlockStatsSpecific *(*bdrv_get_specific_stats)(BlockDriverState *bs); 680ebc2752bSEmanuele Giuseppe Esposito 681ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_save_vmstate)(BlockDriverState *bs, 682ebc2752bSEmanuele Giuseppe Esposito QEMUIOVector *qiov, 683ebc2752bSEmanuele Giuseppe Esposito int64_t pos); 684ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_load_vmstate)(BlockDriverState *bs, 685ebc2752bSEmanuele Giuseppe Esposito QEMUIOVector *qiov, 686ebc2752bSEmanuele Giuseppe Esposito int64_t pos); 687ebc2752bSEmanuele Giuseppe Esposito 688ebc2752bSEmanuele Giuseppe Esposito /* removable device specific */ 689ebc2752bSEmanuele Giuseppe Esposito bool (*bdrv_is_inserted)(BlockDriverState *bs); 690ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_eject)(BlockDriverState *bs, bool eject_flag); 691ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked); 692ebc2752bSEmanuele Giuseppe Esposito 693ebc2752bSEmanuele Giuseppe Esposito /* to control generic scsi devices */ 694ebc2752bSEmanuele Giuseppe Esposito BlockAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs, 695ebc2752bSEmanuele Giuseppe Esposito unsigned long int req, void *buf, 696ebc2752bSEmanuele Giuseppe Esposito BlockCompletionFunc *cb, void *opaque); 697ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_ioctl)(BlockDriverState *bs, 698ebc2752bSEmanuele Giuseppe Esposito unsigned long int req, void *buf); 699ebc2752bSEmanuele Giuseppe Esposito 700ebc2752bSEmanuele Giuseppe Esposito /* 701ebc2752bSEmanuele Giuseppe Esposito * Returns 0 for completed check, -errno for internal errors. 702ebc2752bSEmanuele Giuseppe Esposito * The check results are stored in result. 703ebc2752bSEmanuele Giuseppe Esposito */ 704ebc2752bSEmanuele Giuseppe Esposito int coroutine_fn (*bdrv_co_check)(BlockDriverState *bs, 705ebc2752bSEmanuele Giuseppe Esposito BdrvCheckResult *result, 706ebc2752bSEmanuele Giuseppe Esposito BdrvCheckMode fix); 707ebc2752bSEmanuele Giuseppe Esposito 708ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_debug_event)(BlockDriverState *bs, BlkdebugEvent event); 709ebc2752bSEmanuele Giuseppe Esposito 710ebc2752bSEmanuele Giuseppe Esposito /* io queue for linux-aio */ 711ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_io_plug)(BlockDriverState *bs); 712ebc2752bSEmanuele Giuseppe Esposito void (*bdrv_io_unplug)(BlockDriverState *bs); 713ebc2752bSEmanuele Giuseppe Esposito 714ebc2752bSEmanuele Giuseppe Esposito /** 715ebc2752bSEmanuele Giuseppe Esposito * bdrv_co_drain_begin is called if implemented in the beginning of a 716ebc2752bSEmanuele Giuseppe Esposito * drain operation to drain and stop any internal sources of requests in 717ebc2752bSEmanuele Giuseppe Esposito * the driver. 718ebc2752bSEmanuele Giuseppe Esposito * bdrv_co_drain_end is called if implemented at the end of the drain. 719ebc2752bSEmanuele Giuseppe Esposito * 720ebc2752bSEmanuele Giuseppe Esposito * They should be used by the driver to e.g. manage scheduled I/O 721ebc2752bSEmanuele Giuseppe Esposito * requests, or toggle an internal state. After the end of the drain new 722ebc2752bSEmanuele Giuseppe Esposito * requests will continue normally. 723ebc2752bSEmanuele Giuseppe Esposito */ 724ebc2752bSEmanuele Giuseppe Esposito void coroutine_fn (*bdrv_co_drain_begin)(BlockDriverState *bs); 725ebc2752bSEmanuele Giuseppe Esposito void coroutine_fn (*bdrv_co_drain_end)(BlockDriverState *bs); 726ebc2752bSEmanuele Giuseppe Esposito 727ebc2752bSEmanuele Giuseppe Esposito bool (*bdrv_supports_persistent_dirty_bitmap)(BlockDriverState *bs); 728ebc2752bSEmanuele Giuseppe Esposito bool (*bdrv_co_can_store_new_dirty_bitmap)(BlockDriverState *bs, 729ebc2752bSEmanuele Giuseppe Esposito const char *name, 730ebc2752bSEmanuele Giuseppe Esposito uint32_t granularity, 731ebc2752bSEmanuele Giuseppe Esposito Error **errp); 732ebc2752bSEmanuele Giuseppe Esposito int (*bdrv_co_remove_persistent_dirty_bitmap)(BlockDriverState *bs, 733ebc2752bSEmanuele Giuseppe Esposito const char *name, 734ebc2752bSEmanuele Giuseppe Esposito Error **errp); 735ebc2752bSEmanuele Giuseppe Esposito }; 736ebc2752bSEmanuele Giuseppe Esposito 737ebc2752bSEmanuele Giuseppe Esposito static inline bool block_driver_can_compress(BlockDriver *drv) 738ebc2752bSEmanuele Giuseppe Esposito { 739ebc2752bSEmanuele Giuseppe Esposito return drv->bdrv_co_pwritev_compressed || 740ebc2752bSEmanuele Giuseppe Esposito drv->bdrv_co_pwritev_compressed_part; 741ebc2752bSEmanuele Giuseppe Esposito } 742ebc2752bSEmanuele Giuseppe Esposito 743ebc2752bSEmanuele Giuseppe Esposito typedef struct BlockLimits { 744ebc2752bSEmanuele Giuseppe Esposito /* 745ebc2752bSEmanuele Giuseppe Esposito * Alignment requirement, in bytes, for offset/length of I/O 746ebc2752bSEmanuele Giuseppe Esposito * requests. Must be a power of 2 less than INT_MAX; defaults to 747ebc2752bSEmanuele Giuseppe Esposito * 1 for drivers with modern byte interfaces, and to 512 748ebc2752bSEmanuele Giuseppe Esposito * otherwise. 749ebc2752bSEmanuele Giuseppe Esposito */ 750ebc2752bSEmanuele Giuseppe Esposito uint32_t request_alignment; 751ebc2752bSEmanuele Giuseppe Esposito 752ebc2752bSEmanuele Giuseppe Esposito /* 753ebc2752bSEmanuele Giuseppe Esposito * Maximum number of bytes that can be discarded at once. Must be multiple 754ebc2752bSEmanuele Giuseppe Esposito * of pdiscard_alignment, but need not be power of 2. May be 0 if no 755ebc2752bSEmanuele Giuseppe Esposito * inherent 64-bit limit. 756ebc2752bSEmanuele Giuseppe Esposito */ 757ebc2752bSEmanuele Giuseppe Esposito int64_t max_pdiscard; 758ebc2752bSEmanuele Giuseppe Esposito 759ebc2752bSEmanuele Giuseppe Esposito /* 760ebc2752bSEmanuele Giuseppe Esposito * Optimal alignment for discard requests in bytes. A power of 2 761ebc2752bSEmanuele Giuseppe Esposito * is best but not mandatory. Must be a multiple of 762ebc2752bSEmanuele Giuseppe Esposito * bl.request_alignment, and must be less than max_pdiscard if 763ebc2752bSEmanuele Giuseppe Esposito * that is set. May be 0 if bl.request_alignment is good enough 764ebc2752bSEmanuele Giuseppe Esposito */ 765ebc2752bSEmanuele Giuseppe Esposito uint32_t pdiscard_alignment; 766ebc2752bSEmanuele Giuseppe Esposito 767ebc2752bSEmanuele Giuseppe Esposito /* 768ebc2752bSEmanuele Giuseppe Esposito * Maximum number of bytes that can zeroized at once. Must be multiple of 769ebc2752bSEmanuele Giuseppe Esposito * pwrite_zeroes_alignment. 0 means no limit. 770ebc2752bSEmanuele Giuseppe Esposito */ 771ebc2752bSEmanuele Giuseppe Esposito int64_t max_pwrite_zeroes; 772ebc2752bSEmanuele Giuseppe Esposito 773ebc2752bSEmanuele Giuseppe Esposito /* 774ebc2752bSEmanuele Giuseppe Esposito * Optimal alignment for write zeroes requests in bytes. A power 775ebc2752bSEmanuele Giuseppe Esposito * of 2 is best but not mandatory. Must be a multiple of 776ebc2752bSEmanuele Giuseppe Esposito * bl.request_alignment, and must be less than max_pwrite_zeroes 777ebc2752bSEmanuele Giuseppe Esposito * if that is set. May be 0 if bl.request_alignment is good 778ebc2752bSEmanuele Giuseppe Esposito * enough 779ebc2752bSEmanuele Giuseppe Esposito */ 780ebc2752bSEmanuele Giuseppe Esposito uint32_t pwrite_zeroes_alignment; 781ebc2752bSEmanuele Giuseppe Esposito 782ebc2752bSEmanuele Giuseppe Esposito /* 783ebc2752bSEmanuele Giuseppe Esposito * Optimal transfer length in bytes. A power of 2 is best but not 784ebc2752bSEmanuele Giuseppe Esposito * mandatory. Must be a multiple of bl.request_alignment, or 0 if 785ebc2752bSEmanuele Giuseppe Esposito * no preferred size 786ebc2752bSEmanuele Giuseppe Esposito */ 787ebc2752bSEmanuele Giuseppe Esposito uint32_t opt_transfer; 788ebc2752bSEmanuele Giuseppe Esposito 789ebc2752bSEmanuele Giuseppe Esposito /* 790ebc2752bSEmanuele Giuseppe Esposito * Maximal transfer length in bytes. Need not be power of 2, but 791ebc2752bSEmanuele Giuseppe Esposito * must be multiple of opt_transfer and bl.request_alignment, or 0 792ebc2752bSEmanuele Giuseppe Esposito * for no 32-bit limit. For now, anything larger than INT_MAX is 793ebc2752bSEmanuele Giuseppe Esposito * clamped down. 794ebc2752bSEmanuele Giuseppe Esposito */ 795ebc2752bSEmanuele Giuseppe Esposito uint32_t max_transfer; 796ebc2752bSEmanuele Giuseppe Esposito 797ebc2752bSEmanuele Giuseppe Esposito /* 798ebc2752bSEmanuele Giuseppe Esposito * Maximal hardware transfer length in bytes. Applies whenever 799ebc2752bSEmanuele Giuseppe Esposito * transfers to the device bypass the kernel I/O scheduler, for 800ebc2752bSEmanuele Giuseppe Esposito * example with SG_IO. If larger than max_transfer or if zero, 801ebc2752bSEmanuele Giuseppe Esposito * blk_get_max_hw_transfer will fall back to max_transfer. 802ebc2752bSEmanuele Giuseppe Esposito */ 803ebc2752bSEmanuele Giuseppe Esposito uint64_t max_hw_transfer; 804ebc2752bSEmanuele Giuseppe Esposito 805ebc2752bSEmanuele Giuseppe Esposito /* 806ebc2752bSEmanuele Giuseppe Esposito * Maximal number of scatter/gather elements allowed by the hardware. 807ebc2752bSEmanuele Giuseppe Esposito * Applies whenever transfers to the device bypass the kernel I/O 808ebc2752bSEmanuele Giuseppe Esposito * scheduler, for example with SG_IO. If larger than max_iov 809ebc2752bSEmanuele Giuseppe Esposito * or if zero, blk_get_max_hw_iov will fall back to max_iov. 810ebc2752bSEmanuele Giuseppe Esposito */ 811ebc2752bSEmanuele Giuseppe Esposito int max_hw_iov; 812ebc2752bSEmanuele Giuseppe Esposito 813ebc2752bSEmanuele Giuseppe Esposito 814ebc2752bSEmanuele Giuseppe Esposito /* memory alignment, in bytes so that no bounce buffer is needed */ 815ebc2752bSEmanuele Giuseppe Esposito size_t min_mem_alignment; 816ebc2752bSEmanuele Giuseppe Esposito 817ebc2752bSEmanuele Giuseppe Esposito /* memory alignment, in bytes, for bounce buffer */ 818ebc2752bSEmanuele Giuseppe Esposito size_t opt_mem_alignment; 819ebc2752bSEmanuele Giuseppe Esposito 820ebc2752bSEmanuele Giuseppe Esposito /* maximum number of iovec elements */ 821ebc2752bSEmanuele Giuseppe Esposito int max_iov; 822ebc2752bSEmanuele Giuseppe Esposito } BlockLimits; 823ebc2752bSEmanuele Giuseppe Esposito 824ebc2752bSEmanuele Giuseppe Esposito typedef struct BdrvOpBlocker BdrvOpBlocker; 825ebc2752bSEmanuele Giuseppe Esposito 826ebc2752bSEmanuele Giuseppe Esposito typedef struct BdrvAioNotifier { 827ebc2752bSEmanuele Giuseppe Esposito void (*attached_aio_context)(AioContext *new_context, void *opaque); 828ebc2752bSEmanuele Giuseppe Esposito void (*detach_aio_context)(void *opaque); 829ebc2752bSEmanuele Giuseppe Esposito 830ebc2752bSEmanuele Giuseppe Esposito void *opaque; 831ebc2752bSEmanuele Giuseppe Esposito bool deleted; 832ebc2752bSEmanuele Giuseppe Esposito 833ebc2752bSEmanuele Giuseppe Esposito QLIST_ENTRY(BdrvAioNotifier) list; 834ebc2752bSEmanuele Giuseppe Esposito } BdrvAioNotifier; 835ebc2752bSEmanuele Giuseppe Esposito 836ebc2752bSEmanuele Giuseppe Esposito struct BdrvChildClass { 837ebc2752bSEmanuele Giuseppe Esposito /* 838ebc2752bSEmanuele Giuseppe Esposito * If true, bdrv_replace_node() doesn't change the node this BdrvChild 839ebc2752bSEmanuele Giuseppe Esposito * points to. 840ebc2752bSEmanuele Giuseppe Esposito */ 841ebc2752bSEmanuele Giuseppe Esposito bool stay_at_node; 842ebc2752bSEmanuele Giuseppe Esposito 843ebc2752bSEmanuele Giuseppe Esposito /* 844ebc2752bSEmanuele Giuseppe Esposito * If true, the parent is a BlockDriverState and bdrv_next_all_states() 845ebc2752bSEmanuele Giuseppe Esposito * will return it. This information is used for drain_all, where every node 846ebc2752bSEmanuele Giuseppe Esposito * will be drained separately, so the drain only needs to be propagated to 847ebc2752bSEmanuele Giuseppe Esposito * non-BDS parents. 848ebc2752bSEmanuele Giuseppe Esposito */ 849ebc2752bSEmanuele Giuseppe Esposito bool parent_is_bds; 850ebc2752bSEmanuele Giuseppe Esposito 851abc5a79cSEmanuele Giuseppe Esposito /* 852abc5a79cSEmanuele Giuseppe Esposito * Global state (GS) API. These functions run under the BQL. 853abc5a79cSEmanuele Giuseppe Esposito * 854abc5a79cSEmanuele Giuseppe Esposito * See include/block/block-global-state.h for more information about 855abc5a79cSEmanuele Giuseppe Esposito * the GS API. 856abc5a79cSEmanuele Giuseppe Esposito */ 857ebc2752bSEmanuele Giuseppe Esposito void (*inherit_options)(BdrvChildRole role, bool parent_is_format, 858ebc2752bSEmanuele Giuseppe Esposito int *child_flags, QDict *child_options, 859ebc2752bSEmanuele Giuseppe Esposito int parent_flags, QDict *parent_options); 860ebc2752bSEmanuele Giuseppe Esposito void (*change_media)(BdrvChild *child, bool load); 861ebc2752bSEmanuele Giuseppe Esposito 862ebc2752bSEmanuele Giuseppe Esposito /* 863ebc2752bSEmanuele Giuseppe Esposito * Returns a malloced string that describes the parent of the child for a 864ebc2752bSEmanuele Giuseppe Esposito * human reader. This could be a node-name, BlockBackend name, qdev ID or 865ebc2752bSEmanuele Giuseppe Esposito * QOM path of the device owning the BlockBackend, job type and ID etc. The 866ebc2752bSEmanuele Giuseppe Esposito * caller is responsible for freeing the memory. 867ebc2752bSEmanuele Giuseppe Esposito */ 868ebc2752bSEmanuele Giuseppe Esposito char *(*get_parent_desc)(BdrvChild *child); 869ebc2752bSEmanuele Giuseppe Esposito 870ebc2752bSEmanuele Giuseppe Esposito /* 871ebc2752bSEmanuele Giuseppe Esposito * Notifies the parent that the child has been activated/inactivated (e.g. 872ebc2752bSEmanuele Giuseppe Esposito * when migration is completing) and it can start/stop requesting 873ebc2752bSEmanuele Giuseppe Esposito * permissions and doing I/O on it. 874ebc2752bSEmanuele Giuseppe Esposito */ 875ebc2752bSEmanuele Giuseppe Esposito void (*activate)(BdrvChild *child, Error **errp); 876ebc2752bSEmanuele Giuseppe Esposito int (*inactivate)(BdrvChild *child); 877ebc2752bSEmanuele Giuseppe Esposito 878ebc2752bSEmanuele Giuseppe Esposito void (*attach)(BdrvChild *child); 879ebc2752bSEmanuele Giuseppe Esposito void (*detach)(BdrvChild *child); 880ebc2752bSEmanuele Giuseppe Esposito 881ebc2752bSEmanuele Giuseppe Esposito /* 882ebc2752bSEmanuele Giuseppe Esposito * Notifies the parent that the filename of its child has changed (e.g. 883ebc2752bSEmanuele Giuseppe Esposito * because the direct child was removed from the backing chain), so that it 884ebc2752bSEmanuele Giuseppe Esposito * can update its reference. 885ebc2752bSEmanuele Giuseppe Esposito */ 886ebc2752bSEmanuele Giuseppe Esposito int (*update_filename)(BdrvChild *child, BlockDriverState *new_base, 887ebc2752bSEmanuele Giuseppe Esposito const char *filename, Error **errp); 888ebc2752bSEmanuele Giuseppe Esposito 889ebc2752bSEmanuele Giuseppe Esposito bool (*can_set_aio_ctx)(BdrvChild *child, AioContext *ctx, 890ebc2752bSEmanuele Giuseppe Esposito GSList **ignore, Error **errp); 891ebc2752bSEmanuele Giuseppe Esposito void (*set_aio_ctx)(BdrvChild *child, AioContext *ctx, GSList **ignore); 892ebc2752bSEmanuele Giuseppe Esposito 893ebc2752bSEmanuele Giuseppe Esposito AioContext *(*get_parent_aio_context)(BdrvChild *child); 894abc5a79cSEmanuele Giuseppe Esposito 895abc5a79cSEmanuele Giuseppe Esposito /* 896abc5a79cSEmanuele Giuseppe Esposito * I/O API functions. These functions are thread-safe. 897abc5a79cSEmanuele Giuseppe Esposito * 898abc5a79cSEmanuele Giuseppe Esposito * See include/block/block-io.h for more information about 899abc5a79cSEmanuele Giuseppe Esposito * the I/O API. 900abc5a79cSEmanuele Giuseppe Esposito */ 901abc5a79cSEmanuele Giuseppe Esposito 902abc5a79cSEmanuele Giuseppe Esposito void (*resize)(BdrvChild *child); 903abc5a79cSEmanuele Giuseppe Esposito 904abc5a79cSEmanuele Giuseppe Esposito /* 905abc5a79cSEmanuele Giuseppe Esposito * Returns a name that is supposedly more useful for human users than the 906abc5a79cSEmanuele Giuseppe Esposito * node name for identifying the node in question (in particular, a BB 907abc5a79cSEmanuele Giuseppe Esposito * name), or NULL if the parent can't provide a better name. 908abc5a79cSEmanuele Giuseppe Esposito */ 909abc5a79cSEmanuele Giuseppe Esposito const char *(*get_name)(BdrvChild *child); 910abc5a79cSEmanuele Giuseppe Esposito 911abc5a79cSEmanuele Giuseppe Esposito /* 912abc5a79cSEmanuele Giuseppe Esposito * If this pair of functions is implemented, the parent doesn't issue new 913abc5a79cSEmanuele Giuseppe Esposito * requests after returning from .drained_begin() until .drained_end() is 914abc5a79cSEmanuele Giuseppe Esposito * called. 915abc5a79cSEmanuele Giuseppe Esposito * 916abc5a79cSEmanuele Giuseppe Esposito * These functions must not change the graph (and therefore also must not 917abc5a79cSEmanuele Giuseppe Esposito * call aio_poll(), which could change the graph indirectly). 918abc5a79cSEmanuele Giuseppe Esposito * 919abc5a79cSEmanuele Giuseppe Esposito * If drained_end() schedules background operations, it must atomically 920abc5a79cSEmanuele Giuseppe Esposito * increment *drained_end_counter for each such operation and atomically 921abc5a79cSEmanuele Giuseppe Esposito * decrement it once the operation has settled. 922abc5a79cSEmanuele Giuseppe Esposito * 923abc5a79cSEmanuele Giuseppe Esposito * Note that this can be nested. If drained_begin() was called twice, new 924abc5a79cSEmanuele Giuseppe Esposito * I/O is allowed only after drained_end() was called twice, too. 925abc5a79cSEmanuele Giuseppe Esposito */ 926abc5a79cSEmanuele Giuseppe Esposito void (*drained_begin)(BdrvChild *child); 927abc5a79cSEmanuele Giuseppe Esposito void (*drained_end)(BdrvChild *child, int *drained_end_counter); 928abc5a79cSEmanuele Giuseppe Esposito 929abc5a79cSEmanuele Giuseppe Esposito /* 930abc5a79cSEmanuele Giuseppe Esposito * Returns whether the parent has pending requests for the child. This 931abc5a79cSEmanuele Giuseppe Esposito * callback is polled after .drained_begin() has been called until all 932abc5a79cSEmanuele Giuseppe Esposito * activity on the child has stopped. 933abc5a79cSEmanuele Giuseppe Esposito */ 934abc5a79cSEmanuele Giuseppe Esposito bool (*drained_poll)(BdrvChild *child); 935ebc2752bSEmanuele Giuseppe Esposito }; 936ebc2752bSEmanuele Giuseppe Esposito 937ebc2752bSEmanuele Giuseppe Esposito extern const BdrvChildClass child_of_bds; 938ebc2752bSEmanuele Giuseppe Esposito 939ebc2752bSEmanuele Giuseppe Esposito struct BdrvChild { 940ebc2752bSEmanuele Giuseppe Esposito BlockDriverState *bs; 941ebc2752bSEmanuele Giuseppe Esposito char *name; 942ebc2752bSEmanuele Giuseppe Esposito const BdrvChildClass *klass; 943ebc2752bSEmanuele Giuseppe Esposito BdrvChildRole role; 944ebc2752bSEmanuele Giuseppe Esposito void *opaque; 945ebc2752bSEmanuele Giuseppe Esposito 946ebc2752bSEmanuele Giuseppe Esposito /** 947ebc2752bSEmanuele Giuseppe Esposito * Granted permissions for operating on this BdrvChild (BLK_PERM_* bitmask) 948ebc2752bSEmanuele Giuseppe Esposito */ 949ebc2752bSEmanuele Giuseppe Esposito uint64_t perm; 950ebc2752bSEmanuele Giuseppe Esposito 951ebc2752bSEmanuele Giuseppe Esposito /** 952ebc2752bSEmanuele Giuseppe Esposito * Permissions that can still be granted to other users of @bs while this 953ebc2752bSEmanuele Giuseppe Esposito * BdrvChild is still attached to it. (BLK_PERM_* bitmask) 954ebc2752bSEmanuele Giuseppe Esposito */ 955ebc2752bSEmanuele Giuseppe Esposito uint64_t shared_perm; 956ebc2752bSEmanuele Giuseppe Esposito 957ebc2752bSEmanuele Giuseppe Esposito /* 958ebc2752bSEmanuele Giuseppe Esposito * This link is frozen: the child can neither be replaced nor 959ebc2752bSEmanuele Giuseppe Esposito * detached from the parent. 960ebc2752bSEmanuele Giuseppe Esposito */ 961ebc2752bSEmanuele Giuseppe Esposito bool frozen; 962ebc2752bSEmanuele Giuseppe Esposito 963ebc2752bSEmanuele Giuseppe Esposito /* 964ebc2752bSEmanuele Giuseppe Esposito * How many times the parent of this child has been drained 965ebc2752bSEmanuele Giuseppe Esposito * (through klass->drained_*). 966ebc2752bSEmanuele Giuseppe Esposito * Usually, this is equal to bs->quiesce_counter (potentially 967ebc2752bSEmanuele Giuseppe Esposito * reduced by bdrv_drain_all_count). It may differ while the 968ebc2752bSEmanuele Giuseppe Esposito * child is entering or leaving a drained section. 969ebc2752bSEmanuele Giuseppe Esposito */ 970ebc2752bSEmanuele Giuseppe Esposito int parent_quiesce_counter; 971ebc2752bSEmanuele Giuseppe Esposito 972ebc2752bSEmanuele Giuseppe Esposito QLIST_ENTRY(BdrvChild) next; 973ebc2752bSEmanuele Giuseppe Esposito QLIST_ENTRY(BdrvChild) next_parent; 974ebc2752bSEmanuele Giuseppe Esposito }; 975ebc2752bSEmanuele Giuseppe Esposito 976ebc2752bSEmanuele Giuseppe Esposito /* 977ebc2752bSEmanuele Giuseppe Esposito * Allows bdrv_co_block_status() to cache one data region for a 978ebc2752bSEmanuele Giuseppe Esposito * protocol node. 979ebc2752bSEmanuele Giuseppe Esposito * 980ebc2752bSEmanuele Giuseppe Esposito * @valid: Whether the cache is valid (should be accessed with atomic 981ebc2752bSEmanuele Giuseppe Esposito * functions so this can be reset by RCU readers) 982ebc2752bSEmanuele Giuseppe Esposito * @data_start: Offset where we know (or strongly assume) is data 983ebc2752bSEmanuele Giuseppe Esposito * @data_end: Offset where the data region ends (which is not necessarily 984ebc2752bSEmanuele Giuseppe Esposito * the start of a zeroed region) 985ebc2752bSEmanuele Giuseppe Esposito */ 986ebc2752bSEmanuele Giuseppe Esposito typedef struct BdrvBlockStatusCache { 987ebc2752bSEmanuele Giuseppe Esposito struct rcu_head rcu; 988ebc2752bSEmanuele Giuseppe Esposito 989ebc2752bSEmanuele Giuseppe Esposito bool valid; 990ebc2752bSEmanuele Giuseppe Esposito int64_t data_start; 991ebc2752bSEmanuele Giuseppe Esposito int64_t data_end; 992ebc2752bSEmanuele Giuseppe Esposito } BdrvBlockStatusCache; 993ebc2752bSEmanuele Giuseppe Esposito 994ebc2752bSEmanuele Giuseppe Esposito struct BlockDriverState { 995ebc2752bSEmanuele Giuseppe Esposito /* 996ebc2752bSEmanuele Giuseppe Esposito * Protected by big QEMU lock or read-only after opening. No special 997ebc2752bSEmanuele Giuseppe Esposito * locking needed during I/O... 998ebc2752bSEmanuele Giuseppe Esposito */ 999ebc2752bSEmanuele Giuseppe Esposito int open_flags; /* flags used to open the file, re-used for re-open */ 1000ebc2752bSEmanuele Giuseppe Esposito bool encrypted; /* if true, the media is encrypted */ 1001ebc2752bSEmanuele Giuseppe Esposito bool sg; /* if true, the device is a /dev/sg* */ 1002ebc2752bSEmanuele Giuseppe Esposito bool probed; /* if true, format was probed rather than specified */ 1003ebc2752bSEmanuele Giuseppe Esposito bool force_share; /* if true, always allow all shared permissions */ 1004ebc2752bSEmanuele Giuseppe Esposito bool implicit; /* if true, this filter node was automatically inserted */ 1005ebc2752bSEmanuele Giuseppe Esposito 1006ebc2752bSEmanuele Giuseppe Esposito BlockDriver *drv; /* NULL means no media */ 1007ebc2752bSEmanuele Giuseppe Esposito void *opaque; 1008ebc2752bSEmanuele Giuseppe Esposito 1009ebc2752bSEmanuele Giuseppe Esposito AioContext *aio_context; /* event loop used for fd handlers, timers, etc */ 1010ebc2752bSEmanuele Giuseppe Esposito /* 1011ebc2752bSEmanuele Giuseppe Esposito * long-running tasks intended to always use the same AioContext as this 1012ebc2752bSEmanuele Giuseppe Esposito * BDS may register themselves in this list to be notified of changes 1013ebc2752bSEmanuele Giuseppe Esposito * regarding this BDS's context 1014ebc2752bSEmanuele Giuseppe Esposito */ 1015ebc2752bSEmanuele Giuseppe Esposito QLIST_HEAD(, BdrvAioNotifier) aio_notifiers; 1016ebc2752bSEmanuele Giuseppe Esposito bool walking_aio_notifiers; /* to make removal during iteration safe */ 1017ebc2752bSEmanuele Giuseppe Esposito 1018ebc2752bSEmanuele Giuseppe Esposito char filename[PATH_MAX]; 1019ebc2752bSEmanuele Giuseppe Esposito /* 1020ebc2752bSEmanuele Giuseppe Esposito * If not empty, this image is a diff in relation to backing_file. 1021ebc2752bSEmanuele Giuseppe Esposito * Note that this is the name given in the image header and 1022ebc2752bSEmanuele Giuseppe Esposito * therefore may or may not be equal to .backing->bs->filename. 1023ebc2752bSEmanuele Giuseppe Esposito * If this field contains a relative path, it is to be resolved 1024ebc2752bSEmanuele Giuseppe Esposito * relatively to the overlay's location. 1025ebc2752bSEmanuele Giuseppe Esposito */ 1026ebc2752bSEmanuele Giuseppe Esposito char backing_file[PATH_MAX]; 1027ebc2752bSEmanuele Giuseppe Esposito /* 1028ebc2752bSEmanuele Giuseppe Esposito * The backing filename indicated by the image header. Contrary 1029ebc2752bSEmanuele Giuseppe Esposito * to backing_file, if we ever open this file, auto_backing_file 1030ebc2752bSEmanuele Giuseppe Esposito * is replaced by the resulting BDS's filename (i.e. after a 1031ebc2752bSEmanuele Giuseppe Esposito * bdrv_refresh_filename() run). 1032ebc2752bSEmanuele Giuseppe Esposito */ 1033ebc2752bSEmanuele Giuseppe Esposito char auto_backing_file[PATH_MAX]; 1034ebc2752bSEmanuele Giuseppe Esposito char backing_format[16]; /* if non-zero and backing_file exists */ 1035ebc2752bSEmanuele Giuseppe Esposito 1036ebc2752bSEmanuele Giuseppe Esposito QDict *full_open_options; 1037ebc2752bSEmanuele Giuseppe Esposito char exact_filename[PATH_MAX]; 1038ebc2752bSEmanuele Giuseppe Esposito 1039ebc2752bSEmanuele Giuseppe Esposito BdrvChild *backing; 1040ebc2752bSEmanuele Giuseppe Esposito BdrvChild *file; 1041ebc2752bSEmanuele Giuseppe Esposito 1042ebc2752bSEmanuele Giuseppe Esposito /* I/O Limits */ 1043ebc2752bSEmanuele Giuseppe Esposito BlockLimits bl; 1044ebc2752bSEmanuele Giuseppe Esposito 1045ebc2752bSEmanuele Giuseppe Esposito /* 1046ebc2752bSEmanuele Giuseppe Esposito * Flags honored during pread 1047ebc2752bSEmanuele Giuseppe Esposito */ 1048ebc2752bSEmanuele Giuseppe Esposito unsigned int supported_read_flags; 1049ebc2752bSEmanuele Giuseppe Esposito /* 1050ebc2752bSEmanuele Giuseppe Esposito * Flags honored during pwrite (so far: BDRV_REQ_FUA, 1051ebc2752bSEmanuele Giuseppe Esposito * BDRV_REQ_WRITE_UNCHANGED). 1052ebc2752bSEmanuele Giuseppe Esposito * If a driver does not support BDRV_REQ_WRITE_UNCHANGED, those 1053ebc2752bSEmanuele Giuseppe Esposito * writes will be issued as normal writes without the flag set. 1054ebc2752bSEmanuele Giuseppe Esposito * This is important to note for drivers that do not explicitly 1055ebc2752bSEmanuele Giuseppe Esposito * request a WRITE permission for their children and instead take 1056ebc2752bSEmanuele Giuseppe Esposito * the same permissions as their parent did (this is commonly what 1057ebc2752bSEmanuele Giuseppe Esposito * block filters do). Such drivers have to be aware that the 1058ebc2752bSEmanuele Giuseppe Esposito * parent may have taken a WRITE_UNCHANGED permission only and is 1059ebc2752bSEmanuele Giuseppe Esposito * issuing such requests. Drivers either must make sure that 1060ebc2752bSEmanuele Giuseppe Esposito * these requests do not result in plain WRITE accesses (usually 1061ebc2752bSEmanuele Giuseppe Esposito * by supporting BDRV_REQ_WRITE_UNCHANGED, and then forwarding 1062ebc2752bSEmanuele Giuseppe Esposito * every incoming write request as-is, including potentially that 1063ebc2752bSEmanuele Giuseppe Esposito * flag), or they have to explicitly take the WRITE permission for 1064ebc2752bSEmanuele Giuseppe Esposito * their children. 1065ebc2752bSEmanuele Giuseppe Esposito */ 1066ebc2752bSEmanuele Giuseppe Esposito unsigned int supported_write_flags; 1067ebc2752bSEmanuele Giuseppe Esposito /* 1068ebc2752bSEmanuele Giuseppe Esposito * Flags honored during pwrite_zeroes (so far: BDRV_REQ_FUA, 1069ebc2752bSEmanuele Giuseppe Esposito * BDRV_REQ_MAY_UNMAP, BDRV_REQ_WRITE_UNCHANGED) 1070ebc2752bSEmanuele Giuseppe Esposito */ 1071ebc2752bSEmanuele Giuseppe Esposito unsigned int supported_zero_flags; 1072ebc2752bSEmanuele Giuseppe Esposito /* 1073ebc2752bSEmanuele Giuseppe Esposito * Flags honoured during truncate (so far: BDRV_REQ_ZERO_WRITE). 1074ebc2752bSEmanuele Giuseppe Esposito * 1075ebc2752bSEmanuele Giuseppe Esposito * If BDRV_REQ_ZERO_WRITE is given, the truncate operation must make sure 1076ebc2752bSEmanuele Giuseppe Esposito * that any added space reads as all zeros. If this can't be guaranteed, 1077ebc2752bSEmanuele Giuseppe Esposito * the operation must fail. 1078ebc2752bSEmanuele Giuseppe Esposito */ 1079ebc2752bSEmanuele Giuseppe Esposito unsigned int supported_truncate_flags; 1080ebc2752bSEmanuele Giuseppe Esposito 1081ebc2752bSEmanuele Giuseppe Esposito /* the following member gives a name to every node on the bs graph. */ 1082ebc2752bSEmanuele Giuseppe Esposito char node_name[32]; 1083ebc2752bSEmanuele Giuseppe Esposito /* element of the list of named nodes building the graph */ 1084ebc2752bSEmanuele Giuseppe Esposito QTAILQ_ENTRY(BlockDriverState) node_list; 1085ebc2752bSEmanuele Giuseppe Esposito /* element of the list of all BlockDriverStates (all_bdrv_states) */ 1086ebc2752bSEmanuele Giuseppe Esposito QTAILQ_ENTRY(BlockDriverState) bs_list; 1087ebc2752bSEmanuele Giuseppe Esposito /* element of the list of monitor-owned BDS */ 1088ebc2752bSEmanuele Giuseppe Esposito QTAILQ_ENTRY(BlockDriverState) monitor_list; 1089ebc2752bSEmanuele Giuseppe Esposito int refcnt; 1090ebc2752bSEmanuele Giuseppe Esposito 1091ebc2752bSEmanuele Giuseppe Esposito /* operation blockers. Protected by BQL. */ 1092ebc2752bSEmanuele Giuseppe Esposito QLIST_HEAD(, BdrvOpBlocker) op_blockers[BLOCK_OP_TYPE_MAX]; 1093ebc2752bSEmanuele Giuseppe Esposito 1094ebc2752bSEmanuele Giuseppe Esposito /* 1095ebc2752bSEmanuele Giuseppe Esposito * The node that this node inherited default options from (and a reopen on 1096ebc2752bSEmanuele Giuseppe Esposito * which can affect this node by changing these defaults). This is always a 1097ebc2752bSEmanuele Giuseppe Esposito * parent node of this node. 1098ebc2752bSEmanuele Giuseppe Esposito */ 1099ebc2752bSEmanuele Giuseppe Esposito BlockDriverState *inherits_from; 1100ebc2752bSEmanuele Giuseppe Esposito QLIST_HEAD(, BdrvChild) children; 1101ebc2752bSEmanuele Giuseppe Esposito QLIST_HEAD(, BdrvChild) parents; 1102ebc2752bSEmanuele Giuseppe Esposito 1103ebc2752bSEmanuele Giuseppe Esposito QDict *options; 1104ebc2752bSEmanuele Giuseppe Esposito QDict *explicit_options; 1105ebc2752bSEmanuele Giuseppe Esposito BlockdevDetectZeroesOptions detect_zeroes; 1106ebc2752bSEmanuele Giuseppe Esposito 1107ebc2752bSEmanuele Giuseppe Esposito /* The error object in use for blocking operations on backing_hd */ 1108ebc2752bSEmanuele Giuseppe Esposito Error *backing_blocker; 1109ebc2752bSEmanuele Giuseppe Esposito 1110ebc2752bSEmanuele Giuseppe Esposito /* Protected by AioContext lock */ 1111ebc2752bSEmanuele Giuseppe Esposito 1112ebc2752bSEmanuele Giuseppe Esposito /* 1113ebc2752bSEmanuele Giuseppe Esposito * If we are reading a disk image, give its size in sectors. 1114ebc2752bSEmanuele Giuseppe Esposito * Generally read-only; it is written to by load_snapshot and 1115ebc2752bSEmanuele Giuseppe Esposito * save_snaphost, but the block layer is quiescent during those. 1116ebc2752bSEmanuele Giuseppe Esposito */ 1117ebc2752bSEmanuele Giuseppe Esposito int64_t total_sectors; 1118ebc2752bSEmanuele Giuseppe Esposito 1119ebc2752bSEmanuele Giuseppe Esposito /* threshold limit for writes, in bytes. "High water mark". */ 1120ebc2752bSEmanuele Giuseppe Esposito uint64_t write_threshold_offset; 1121ebc2752bSEmanuele Giuseppe Esposito 1122ebc2752bSEmanuele Giuseppe Esposito /* 1123ebc2752bSEmanuele Giuseppe Esposito * Writing to the list requires the BQL _and_ the dirty_bitmap_mutex. 1124ebc2752bSEmanuele Giuseppe Esposito * Reading from the list can be done with either the BQL or the 1125ebc2752bSEmanuele Giuseppe Esposito * dirty_bitmap_mutex. Modifying a bitmap only requires 1126ebc2752bSEmanuele Giuseppe Esposito * dirty_bitmap_mutex. 1127ebc2752bSEmanuele Giuseppe Esposito */ 1128ebc2752bSEmanuele Giuseppe Esposito QemuMutex dirty_bitmap_mutex; 1129ebc2752bSEmanuele Giuseppe Esposito QLIST_HEAD(, BdrvDirtyBitmap) dirty_bitmaps; 1130ebc2752bSEmanuele Giuseppe Esposito 1131ebc2752bSEmanuele Giuseppe Esposito /* Offset after the highest byte written to */ 1132ebc2752bSEmanuele Giuseppe Esposito Stat64 wr_highest_offset; 1133ebc2752bSEmanuele Giuseppe Esposito 1134ebc2752bSEmanuele Giuseppe Esposito /* 1135ebc2752bSEmanuele Giuseppe Esposito * If true, copy read backing sectors into image. Can be >1 if more 1136ebc2752bSEmanuele Giuseppe Esposito * than one client has requested copy-on-read. Accessed with atomic 1137ebc2752bSEmanuele Giuseppe Esposito * ops. 1138ebc2752bSEmanuele Giuseppe Esposito */ 1139ebc2752bSEmanuele Giuseppe Esposito int copy_on_read; 1140ebc2752bSEmanuele Giuseppe Esposito 1141ebc2752bSEmanuele Giuseppe Esposito /* 1142ebc2752bSEmanuele Giuseppe Esposito * number of in-flight requests; overall and serialising. 1143ebc2752bSEmanuele Giuseppe Esposito * Accessed with atomic ops. 1144ebc2752bSEmanuele Giuseppe Esposito */ 1145ebc2752bSEmanuele Giuseppe Esposito unsigned int in_flight; 1146ebc2752bSEmanuele Giuseppe Esposito unsigned int serialising_in_flight; 1147ebc2752bSEmanuele Giuseppe Esposito 1148ebc2752bSEmanuele Giuseppe Esposito /* 1149ebc2752bSEmanuele Giuseppe Esposito * counter for nested bdrv_io_plug. 1150ebc2752bSEmanuele Giuseppe Esposito * Accessed with atomic ops. 1151ebc2752bSEmanuele Giuseppe Esposito */ 1152ebc2752bSEmanuele Giuseppe Esposito unsigned io_plugged; 1153ebc2752bSEmanuele Giuseppe Esposito 1154ebc2752bSEmanuele Giuseppe Esposito /* do we need to tell the quest if we have a volatile write cache? */ 1155ebc2752bSEmanuele Giuseppe Esposito int enable_write_cache; 1156ebc2752bSEmanuele Giuseppe Esposito 1157ebc2752bSEmanuele Giuseppe Esposito /* Accessed with atomic ops. */ 1158ebc2752bSEmanuele Giuseppe Esposito int quiesce_counter; 1159ebc2752bSEmanuele Giuseppe Esposito int recursive_quiesce_counter; 1160ebc2752bSEmanuele Giuseppe Esposito 1161ebc2752bSEmanuele Giuseppe Esposito unsigned int write_gen; /* Current data generation */ 1162ebc2752bSEmanuele Giuseppe Esposito 1163ebc2752bSEmanuele Giuseppe Esposito /* Protected by reqs_lock. */ 1164ebc2752bSEmanuele Giuseppe Esposito CoMutex reqs_lock; 1165ebc2752bSEmanuele Giuseppe Esposito QLIST_HEAD(, BdrvTrackedRequest) tracked_requests; 1166ebc2752bSEmanuele Giuseppe Esposito CoQueue flush_queue; /* Serializing flush queue */ 1167ebc2752bSEmanuele Giuseppe Esposito bool active_flush_req; /* Flush request in flight? */ 1168ebc2752bSEmanuele Giuseppe Esposito 1169ebc2752bSEmanuele Giuseppe Esposito /* Only read/written by whoever has set active_flush_req to true. */ 1170ebc2752bSEmanuele Giuseppe Esposito unsigned int flushed_gen; /* Flushed write generation */ 1171ebc2752bSEmanuele Giuseppe Esposito 1172ebc2752bSEmanuele Giuseppe Esposito /* BdrvChild links to this node may never be frozen */ 1173ebc2752bSEmanuele Giuseppe Esposito bool never_freeze; 1174ebc2752bSEmanuele Giuseppe Esposito 1175ebc2752bSEmanuele Giuseppe Esposito /* Lock for block-status cache RCU writers */ 1176ebc2752bSEmanuele Giuseppe Esposito CoMutex bsc_modify_lock; 1177ebc2752bSEmanuele Giuseppe Esposito /* Always non-NULL, but must only be dereferenced under an RCU read guard */ 1178ebc2752bSEmanuele Giuseppe Esposito BdrvBlockStatusCache *block_status_cache; 1179ebc2752bSEmanuele Giuseppe Esposito }; 1180ebc2752bSEmanuele Giuseppe Esposito 1181ebc2752bSEmanuele Giuseppe Esposito struct BlockBackendRootState { 1182ebc2752bSEmanuele Giuseppe Esposito int open_flags; 1183ebc2752bSEmanuele Giuseppe Esposito BlockdevDetectZeroesOptions detect_zeroes; 1184ebc2752bSEmanuele Giuseppe Esposito }; 1185ebc2752bSEmanuele Giuseppe Esposito 1186ebc2752bSEmanuele Giuseppe Esposito typedef enum BlockMirrorBackingMode { 1187ebc2752bSEmanuele Giuseppe Esposito /* 1188ebc2752bSEmanuele Giuseppe Esposito * Reuse the existing backing chain from the source for the target. 1189ebc2752bSEmanuele Giuseppe Esposito * - sync=full: Set backing BDS to NULL. 1190ebc2752bSEmanuele Giuseppe Esposito * - sync=top: Use source's backing BDS. 1191ebc2752bSEmanuele Giuseppe Esposito * - sync=none: Use source as the backing BDS. 1192ebc2752bSEmanuele Giuseppe Esposito */ 1193ebc2752bSEmanuele Giuseppe Esposito MIRROR_SOURCE_BACKING_CHAIN, 1194ebc2752bSEmanuele Giuseppe Esposito 1195ebc2752bSEmanuele Giuseppe Esposito /* Open the target's backing chain completely anew */ 1196ebc2752bSEmanuele Giuseppe Esposito MIRROR_OPEN_BACKING_CHAIN, 1197ebc2752bSEmanuele Giuseppe Esposito 1198ebc2752bSEmanuele Giuseppe Esposito /* Do not change the target's backing BDS after job completion */ 1199ebc2752bSEmanuele Giuseppe Esposito MIRROR_LEAVE_BACKING_CHAIN, 1200ebc2752bSEmanuele Giuseppe Esposito } BlockMirrorBackingMode; 1201ebc2752bSEmanuele Giuseppe Esposito 1202ebc2752bSEmanuele Giuseppe Esposito 1203ebc2752bSEmanuele Giuseppe Esposito /* 1204ebc2752bSEmanuele Giuseppe Esposito * Essential block drivers which must always be statically linked into qemu, and 1205ebc2752bSEmanuele Giuseppe Esposito * which therefore can be accessed without using bdrv_find_format() 1206ebc2752bSEmanuele Giuseppe Esposito */ 1207ebc2752bSEmanuele Giuseppe Esposito extern BlockDriver bdrv_file; 1208ebc2752bSEmanuele Giuseppe Esposito extern BlockDriver bdrv_raw; 1209ebc2752bSEmanuele Giuseppe Esposito extern BlockDriver bdrv_qcow2; 1210ebc2752bSEmanuele Giuseppe Esposito 1211ebc2752bSEmanuele Giuseppe Esposito extern unsigned int bdrv_drain_all_count; 1212ebc2752bSEmanuele Giuseppe Esposito extern QemuOptsList bdrv_create_opts_simple; 1213ebc2752bSEmanuele Giuseppe Esposito 1214ebc2752bSEmanuele Giuseppe Esposito /* 1215ebc2752bSEmanuele Giuseppe Esposito * Common functions that are neither I/O nor Global State. 1216ebc2752bSEmanuele Giuseppe Esposito * 1217ebc2752bSEmanuele Giuseppe Esposito * See include/block/block-commmon.h for more information about 1218ebc2752bSEmanuele Giuseppe Esposito * the Common API. 1219ebc2752bSEmanuele Giuseppe Esposito */ 1220ebc2752bSEmanuele Giuseppe Esposito 1221ebc2752bSEmanuele Giuseppe Esposito static inline BlockDriverState *child_bs(BdrvChild *child) 1222ebc2752bSEmanuele Giuseppe Esposito { 1223ebc2752bSEmanuele Giuseppe Esposito return child ? child->bs : NULL; 1224ebc2752bSEmanuele Giuseppe Esposito } 1225ebc2752bSEmanuele Giuseppe Esposito 1226ebc2752bSEmanuele Giuseppe Esposito int bdrv_check_request(int64_t offset, int64_t bytes, Error **errp); 1227ebc2752bSEmanuele Giuseppe Esposito int get_tmp_filename(char *filename, int size); 1228ebc2752bSEmanuele Giuseppe Esposito void bdrv_parse_filename_strip_prefix(const char *filename, const char *prefix, 1229ebc2752bSEmanuele Giuseppe Esposito QDict *options); 1230ebc2752bSEmanuele Giuseppe Esposito 1231ebc2752bSEmanuele Giuseppe Esposito 1232ebc2752bSEmanuele Giuseppe Esposito int bdrv_check_qiov_request(int64_t offset, int64_t bytes, 1233ebc2752bSEmanuele Giuseppe Esposito QEMUIOVector *qiov, size_t qiov_offset, 1234ebc2752bSEmanuele Giuseppe Esposito Error **errp); 1235ebc2752bSEmanuele Giuseppe Esposito 1236ebc2752bSEmanuele Giuseppe Esposito #ifdef _WIN32 1237ebc2752bSEmanuele Giuseppe Esposito int is_windows_drive(const char *filename); 1238ebc2752bSEmanuele Giuseppe Esposito #endif 1239ebc2752bSEmanuele Giuseppe Esposito 1240ebc2752bSEmanuele Giuseppe Esposito #endif /* BLOCK_INT_COMMON_H */ 1241