1 /* 2 * QEMU System Emulator block driver 3 * 4 * Copyright (c) 2003 Fabrice Bellard 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy 7 * of this software and associated documentation files (the "Software"), to deal 8 * in the Software without restriction, including without limitation the rights 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 * copies of the Software, and to permit persons to whom the Software is 11 * furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in 14 * all copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 22 * THE SOFTWARE. 23 */ 24 #ifndef BLOCK_INT_H 25 #define BLOCK_INT_H 26 27 #include "block/accounting.h" 28 #include "block/block.h" 29 #include "block/aio-wait.h" 30 #include "qemu/queue.h" 31 #include "qemu/coroutine.h" 32 #include "qemu/stats64.h" 33 #include "qemu/timer.h" 34 #include "qemu/hbitmap.h" 35 #include "block/snapshot.h" 36 #include "qemu/throttle.h" 37 38 #define BLOCK_FLAG_LAZY_REFCOUNTS 8 39 40 #define BLOCK_OPT_SIZE "size" 41 #define BLOCK_OPT_ENCRYPT "encryption" 42 #define BLOCK_OPT_ENCRYPT_FORMAT "encrypt.format" 43 #define BLOCK_OPT_COMPAT6 "compat6" 44 #define BLOCK_OPT_HWVERSION "hwversion" 45 #define BLOCK_OPT_BACKING_FILE "backing_file" 46 #define BLOCK_OPT_BACKING_FMT "backing_fmt" 47 #define BLOCK_OPT_CLUSTER_SIZE "cluster_size" 48 #define BLOCK_OPT_TABLE_SIZE "table_size" 49 #define BLOCK_OPT_PREALLOC "preallocation" 50 #define BLOCK_OPT_SUBFMT "subformat" 51 #define BLOCK_OPT_COMPAT_LEVEL "compat" 52 #define BLOCK_OPT_LAZY_REFCOUNTS "lazy_refcounts" 53 #define BLOCK_OPT_ADAPTER_TYPE "adapter_type" 54 #define BLOCK_OPT_REDUNDANCY "redundancy" 55 #define BLOCK_OPT_NOCOW "nocow" 56 #define BLOCK_OPT_OBJECT_SIZE "object_size" 57 #define BLOCK_OPT_REFCOUNT_BITS "refcount_bits" 58 #define BLOCK_OPT_DATA_FILE "data_file" 59 #define BLOCK_OPT_DATA_FILE_RAW "data_file_raw" 60 61 #define BLOCK_PROBE_BUF_SIZE 512 62 63 enum BdrvTrackedRequestType { 64 BDRV_TRACKED_READ, 65 BDRV_TRACKED_WRITE, 66 BDRV_TRACKED_DISCARD, 67 BDRV_TRACKED_TRUNCATE, 68 }; 69 70 typedef struct BdrvTrackedRequest { 71 BlockDriverState *bs; 72 int64_t offset; 73 uint64_t bytes; 74 enum BdrvTrackedRequestType type; 75 76 bool serialising; 77 int64_t overlap_offset; 78 uint64_t overlap_bytes; 79 80 QLIST_ENTRY(BdrvTrackedRequest) list; 81 Coroutine *co; /* owner, used for deadlock detection */ 82 CoQueue wait_queue; /* coroutines blocked on this request */ 83 84 struct BdrvTrackedRequest *waiting_for; 85 } BdrvTrackedRequest; 86 87 struct BlockDriver { 88 const char *format_name; 89 int instance_size; 90 91 /* set to true if the BlockDriver is a block filter. Block filters pass 92 * certain callbacks that refer to data (see block.c) to their bs->file if 93 * the driver doesn't implement them. Drivers that do not wish to forward 94 * must implement them and return -ENOTSUP. 95 */ 96 bool is_filter; 97 /* 98 * Return true if @to_replace can be replaced by a BDS with the 99 * same data as @bs without it affecting @bs's behavior (that is, 100 * without it being visible to @bs's parents). 101 */ 102 bool (*bdrv_recurse_can_replace)(BlockDriverState *bs, 103 BlockDriverState *to_replace); 104 105 int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename); 106 int (*bdrv_probe_device)(const char *filename); 107 108 /* Any driver implementing this callback is expected to be able to handle 109 * NULL file names in its .bdrv_open() implementation */ 110 void (*bdrv_parse_filename)(const char *filename, QDict *options, Error **errp); 111 /* Drivers not implementing bdrv_parse_filename nor bdrv_open should have 112 * this field set to true, except ones that are defined only by their 113 * child's bs. 114 * An example of the last type will be the quorum block driver. 115 */ 116 bool bdrv_needs_filename; 117 118 /* Set if a driver can support backing files */ 119 bool supports_backing; 120 121 /* For handling image reopen for split or non-split files */ 122 int (*bdrv_reopen_prepare)(BDRVReopenState *reopen_state, 123 BlockReopenQueue *queue, Error **errp); 124 void (*bdrv_reopen_commit)(BDRVReopenState *reopen_state); 125 void (*bdrv_reopen_commit_post)(BDRVReopenState *reopen_state); 126 void (*bdrv_reopen_abort)(BDRVReopenState *reopen_state); 127 void (*bdrv_join_options)(QDict *options, QDict *old_options); 128 129 int (*bdrv_open)(BlockDriverState *bs, QDict *options, int flags, 130 Error **errp); 131 132 /* Protocol drivers should implement this instead of bdrv_open */ 133 int (*bdrv_file_open)(BlockDriverState *bs, QDict *options, int flags, 134 Error **errp); 135 void (*bdrv_close)(BlockDriverState *bs); 136 int coroutine_fn (*bdrv_co_create)(BlockdevCreateOptions *opts, 137 Error **errp); 138 int coroutine_fn (*bdrv_co_create_opts)(BlockDriver *drv, 139 const char *filename, 140 QemuOpts *opts, 141 Error **errp); 142 int (*bdrv_make_empty)(BlockDriverState *bs); 143 144 /* 145 * Refreshes the bs->exact_filename field. If that is impossible, 146 * bs->exact_filename has to be left empty. 147 */ 148 void (*bdrv_refresh_filename)(BlockDriverState *bs); 149 150 /* 151 * Gathers the open options for all children into @target. 152 * A simple format driver (without backing file support) might 153 * implement this function like this: 154 * 155 * QINCREF(bs->file->bs->full_open_options); 156 * qdict_put(target, "file", bs->file->bs->full_open_options); 157 * 158 * If not specified, the generic implementation will simply put 159 * all children's options under their respective name. 160 * 161 * @backing_overridden is true when bs->backing seems not to be 162 * the child that would result from opening bs->backing_file. 163 * Therefore, if it is true, the backing child's options should be 164 * gathered; otherwise, there is no need since the backing child 165 * is the one implied by the image header. 166 * 167 * Note that ideally this function would not be needed. Every 168 * block driver which implements it is probably doing something 169 * shady regarding its runtime option structure. 170 */ 171 void (*bdrv_gather_child_options)(BlockDriverState *bs, QDict *target, 172 bool backing_overridden); 173 174 /* 175 * Returns an allocated string which is the directory name of this BDS: It 176 * will be used to make relative filenames absolute by prepending this 177 * function's return value to them. 178 */ 179 char *(*bdrv_dirname)(BlockDriverState *bs, Error **errp); 180 181 /* aio */ 182 BlockAIOCB *(*bdrv_aio_preadv)(BlockDriverState *bs, 183 uint64_t offset, uint64_t bytes, QEMUIOVector *qiov, int flags, 184 BlockCompletionFunc *cb, void *opaque); 185 BlockAIOCB *(*bdrv_aio_pwritev)(BlockDriverState *bs, 186 uint64_t offset, uint64_t bytes, QEMUIOVector *qiov, int flags, 187 BlockCompletionFunc *cb, void *opaque); 188 BlockAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs, 189 BlockCompletionFunc *cb, void *opaque); 190 BlockAIOCB *(*bdrv_aio_pdiscard)(BlockDriverState *bs, 191 int64_t offset, int bytes, 192 BlockCompletionFunc *cb, void *opaque); 193 194 int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs, 195 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov); 196 197 /** 198 * @offset: position in bytes to read at 199 * @bytes: number of bytes to read 200 * @qiov: the buffers to fill with read data 201 * @flags: currently unused, always 0 202 * 203 * @offset and @bytes will be a multiple of 'request_alignment', 204 * but the length of individual @qiov elements does not have to 205 * be a multiple. 206 * 207 * @bytes will always equal the total size of @qiov, and will be 208 * no larger than 'max_transfer'. 209 * 210 * The buffer in @qiov may point directly to guest memory. 211 */ 212 int coroutine_fn (*bdrv_co_preadv)(BlockDriverState *bs, 213 uint64_t offset, uint64_t bytes, QEMUIOVector *qiov, int flags); 214 int coroutine_fn (*bdrv_co_preadv_part)(BlockDriverState *bs, 215 uint64_t offset, uint64_t bytes, 216 QEMUIOVector *qiov, size_t qiov_offset, int flags); 217 int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs, 218 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov, int flags); 219 /** 220 * @offset: position in bytes to write at 221 * @bytes: number of bytes to write 222 * @qiov: the buffers containing data to write 223 * @flags: zero or more bits allowed by 'supported_write_flags' 224 * 225 * @offset and @bytes will be a multiple of 'request_alignment', 226 * but the length of individual @qiov elements does not have to 227 * be a multiple. 228 * 229 * @bytes will always equal the total size of @qiov, and will be 230 * no larger than 'max_transfer'. 231 * 232 * The buffer in @qiov may point directly to guest memory. 233 */ 234 int coroutine_fn (*bdrv_co_pwritev)(BlockDriverState *bs, 235 uint64_t offset, uint64_t bytes, QEMUIOVector *qiov, int flags); 236 int coroutine_fn (*bdrv_co_pwritev_part)(BlockDriverState *bs, 237 uint64_t offset, uint64_t bytes, 238 QEMUIOVector *qiov, size_t qiov_offset, int flags); 239 240 /* 241 * Efficiently zero a region of the disk image. Typically an image format 242 * would use a compact metadata representation to implement this. This 243 * function pointer may be NULL or return -ENOSUP and .bdrv_co_writev() 244 * will be called instead. 245 */ 246 int coroutine_fn (*bdrv_co_pwrite_zeroes)(BlockDriverState *bs, 247 int64_t offset, int bytes, BdrvRequestFlags flags); 248 int coroutine_fn (*bdrv_co_pdiscard)(BlockDriverState *bs, 249 int64_t offset, int bytes); 250 251 /* Map [offset, offset + nbytes) range onto a child of @bs to copy from, 252 * and invoke bdrv_co_copy_range_from(child, ...), or invoke 253 * bdrv_co_copy_range_to() if @bs is the leaf child to copy data from. 254 * 255 * See the comment of bdrv_co_copy_range for the parameter and return value 256 * semantics. 257 */ 258 int coroutine_fn (*bdrv_co_copy_range_from)(BlockDriverState *bs, 259 BdrvChild *src, 260 uint64_t offset, 261 BdrvChild *dst, 262 uint64_t dst_offset, 263 uint64_t bytes, 264 BdrvRequestFlags read_flags, 265 BdrvRequestFlags write_flags); 266 267 /* Map [offset, offset + nbytes) range onto a child of bs to copy data to, 268 * and invoke bdrv_co_copy_range_to(child, src, ...), or perform the copy 269 * operation if @bs is the leaf and @src has the same BlockDriver. Return 270 * -ENOTSUP if @bs is the leaf but @src has a different BlockDriver. 271 * 272 * See the comment of bdrv_co_copy_range for the parameter and return value 273 * semantics. 274 */ 275 int coroutine_fn (*bdrv_co_copy_range_to)(BlockDriverState *bs, 276 BdrvChild *src, 277 uint64_t src_offset, 278 BdrvChild *dst, 279 uint64_t dst_offset, 280 uint64_t bytes, 281 BdrvRequestFlags read_flags, 282 BdrvRequestFlags write_flags); 283 284 /* 285 * Building block for bdrv_block_status[_above] and 286 * bdrv_is_allocated[_above]. The driver should answer only 287 * according to the current layer, and should only need to set 288 * BDRV_BLOCK_DATA, BDRV_BLOCK_ZERO, BDRV_BLOCK_OFFSET_VALID, 289 * and/or BDRV_BLOCK_RAW; if the current layer defers to a backing 290 * layer, the result should be 0 (and not BDRV_BLOCK_ZERO). See 291 * block.h for the overall meaning of the bits. As a hint, the 292 * flag want_zero is true if the caller cares more about precise 293 * mappings (favor accurate _OFFSET_VALID/_ZERO) or false for 294 * overall allocation (favor larger *pnum, perhaps by reporting 295 * _DATA instead of _ZERO). The block layer guarantees input 296 * clamped to bdrv_getlength() and aligned to request_alignment, 297 * as well as non-NULL pnum, map, and file; in turn, the driver 298 * must return an error or set pnum to an aligned non-zero value. 299 */ 300 int coroutine_fn (*bdrv_co_block_status)(BlockDriverState *bs, 301 bool want_zero, int64_t offset, int64_t bytes, int64_t *pnum, 302 int64_t *map, BlockDriverState **file); 303 304 /* 305 * Invalidate any cached meta-data. 306 */ 307 void coroutine_fn (*bdrv_co_invalidate_cache)(BlockDriverState *bs, 308 Error **errp); 309 int (*bdrv_inactivate)(BlockDriverState *bs); 310 311 /* 312 * Flushes all data for all layers by calling bdrv_co_flush for underlying 313 * layers, if needed. This function is needed for deterministic 314 * synchronization of the flush finishing callback. 315 */ 316 int coroutine_fn (*bdrv_co_flush)(BlockDriverState *bs); 317 318 /* Delete a created file. */ 319 int coroutine_fn (*bdrv_co_delete_file)(BlockDriverState *bs, 320 Error **errp); 321 322 /* 323 * Flushes all data that was already written to the OS all the way down to 324 * the disk (for example file-posix.c calls fsync()). 325 */ 326 int coroutine_fn (*bdrv_co_flush_to_disk)(BlockDriverState *bs); 327 328 /* 329 * Flushes all internal caches to the OS. The data may still sit in a 330 * writeback cache of the host OS, but it will survive a crash of the qemu 331 * process. 332 */ 333 int coroutine_fn (*bdrv_co_flush_to_os)(BlockDriverState *bs); 334 335 /* 336 * Drivers setting this field must be able to work with just a plain 337 * filename with '<protocol_name>:' as a prefix, and no other options. 338 * Options may be extracted from the filename by implementing 339 * bdrv_parse_filename. 340 */ 341 const char *protocol_name; 342 343 /* 344 * Truncate @bs to @offset bytes using the given @prealloc mode 345 * when growing. Modes other than PREALLOC_MODE_OFF should be 346 * rejected when shrinking @bs. 347 * 348 * If @exact is true, @bs must be resized to exactly @offset. 349 * Otherwise, it is sufficient for @bs (if it is a host block 350 * device and thus there is no way to resize it) to be at least 351 * @offset bytes in length. 352 * 353 * If @exact is true and this function fails but would succeed 354 * with @exact = false, it should return -ENOTSUP. 355 */ 356 int coroutine_fn (*bdrv_co_truncate)(BlockDriverState *bs, int64_t offset, 357 bool exact, PreallocMode prealloc, 358 BdrvRequestFlags flags, Error **errp); 359 360 int64_t (*bdrv_getlength)(BlockDriverState *bs); 361 bool has_variable_length; 362 int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs); 363 BlockMeasureInfo *(*bdrv_measure)(QemuOpts *opts, BlockDriverState *in_bs, 364 Error **errp); 365 366 int coroutine_fn (*bdrv_co_pwritev_compressed)(BlockDriverState *bs, 367 uint64_t offset, uint64_t bytes, QEMUIOVector *qiov); 368 int coroutine_fn (*bdrv_co_pwritev_compressed_part)(BlockDriverState *bs, 369 uint64_t offset, uint64_t bytes, QEMUIOVector *qiov, 370 size_t qiov_offset); 371 372 int (*bdrv_snapshot_create)(BlockDriverState *bs, 373 QEMUSnapshotInfo *sn_info); 374 int (*bdrv_snapshot_goto)(BlockDriverState *bs, 375 const char *snapshot_id); 376 int (*bdrv_snapshot_delete)(BlockDriverState *bs, 377 const char *snapshot_id, 378 const char *name, 379 Error **errp); 380 int (*bdrv_snapshot_list)(BlockDriverState *bs, 381 QEMUSnapshotInfo **psn_info); 382 int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs, 383 const char *snapshot_id, 384 const char *name, 385 Error **errp); 386 int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi); 387 ImageInfoSpecific *(*bdrv_get_specific_info)(BlockDriverState *bs, 388 Error **errp); 389 BlockStatsSpecific *(*bdrv_get_specific_stats)(BlockDriverState *bs); 390 391 int coroutine_fn (*bdrv_save_vmstate)(BlockDriverState *bs, 392 QEMUIOVector *qiov, 393 int64_t pos); 394 int coroutine_fn (*bdrv_load_vmstate)(BlockDriverState *bs, 395 QEMUIOVector *qiov, 396 int64_t pos); 397 398 int (*bdrv_change_backing_file)(BlockDriverState *bs, 399 const char *backing_file, const char *backing_fmt); 400 401 /* removable device specific */ 402 bool (*bdrv_is_inserted)(BlockDriverState *bs); 403 void (*bdrv_eject)(BlockDriverState *bs, bool eject_flag); 404 void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked); 405 406 /* to control generic scsi devices */ 407 BlockAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs, 408 unsigned long int req, void *buf, 409 BlockCompletionFunc *cb, void *opaque); 410 int coroutine_fn (*bdrv_co_ioctl)(BlockDriverState *bs, 411 unsigned long int req, void *buf); 412 413 /* List of options for creating images, terminated by name == NULL */ 414 QemuOptsList *create_opts; 415 /* 416 * If this driver supports reopening images this contains a 417 * NULL-terminated list of the runtime options that can be 418 * modified. If an option in this list is unspecified during 419 * reopen then it _must_ be reset to its default value or return 420 * an error. 421 */ 422 const char *const *mutable_opts; 423 424 /* 425 * Returns 0 for completed check, -errno for internal errors. 426 * The check results are stored in result. 427 */ 428 int coroutine_fn (*bdrv_co_check)(BlockDriverState *bs, 429 BdrvCheckResult *result, 430 BdrvCheckMode fix); 431 432 int (*bdrv_amend_options)(BlockDriverState *bs, QemuOpts *opts, 433 BlockDriverAmendStatusCB *status_cb, 434 void *cb_opaque, 435 Error **errp); 436 437 void (*bdrv_debug_event)(BlockDriverState *bs, BlkdebugEvent event); 438 439 /* TODO Better pass a option string/QDict/QemuOpts to add any rule? */ 440 int (*bdrv_debug_breakpoint)(BlockDriverState *bs, const char *event, 441 const char *tag); 442 int (*bdrv_debug_remove_breakpoint)(BlockDriverState *bs, 443 const char *tag); 444 int (*bdrv_debug_resume)(BlockDriverState *bs, const char *tag); 445 bool (*bdrv_debug_is_suspended)(BlockDriverState *bs, const char *tag); 446 447 void (*bdrv_refresh_limits)(BlockDriverState *bs, Error **errp); 448 449 /* 450 * Returns 1 if newly created images are guaranteed to contain only 451 * zeros, 0 otherwise. 452 */ 453 int (*bdrv_has_zero_init)(BlockDriverState *bs); 454 455 /* Remove fd handlers, timers, and other event loop callbacks so the event 456 * loop is no longer in use. Called with no in-flight requests and in 457 * depth-first traversal order with parents before child nodes. 458 */ 459 void (*bdrv_detach_aio_context)(BlockDriverState *bs); 460 461 /* Add fd handlers, timers, and other event loop callbacks so I/O requests 462 * can be processed again. Called with no in-flight requests and in 463 * depth-first traversal order with child nodes before parent nodes. 464 */ 465 void (*bdrv_attach_aio_context)(BlockDriverState *bs, 466 AioContext *new_context); 467 468 /* io queue for linux-aio */ 469 void (*bdrv_io_plug)(BlockDriverState *bs); 470 void (*bdrv_io_unplug)(BlockDriverState *bs); 471 472 /** 473 * Try to get @bs's logical and physical block size. 474 * On success, store them in @bsz and return zero. 475 * On failure, return negative errno. 476 */ 477 int (*bdrv_probe_blocksizes)(BlockDriverState *bs, BlockSizes *bsz); 478 /** 479 * Try to get @bs's geometry (cyls, heads, sectors) 480 * On success, store them in @geo and return 0. 481 * On failure return -errno. 482 * Only drivers that want to override guest geometry implement this 483 * callback; see hd_geometry_guess(). 484 */ 485 int (*bdrv_probe_geometry)(BlockDriverState *bs, HDGeometry *geo); 486 487 /** 488 * bdrv_co_drain_begin is called if implemented in the beginning of a 489 * drain operation to drain and stop any internal sources of requests in 490 * the driver. 491 * bdrv_co_drain_end is called if implemented at the end of the drain. 492 * 493 * They should be used by the driver to e.g. manage scheduled I/O 494 * requests, or toggle an internal state. After the end of the drain new 495 * requests will continue normally. 496 */ 497 void coroutine_fn (*bdrv_co_drain_begin)(BlockDriverState *bs); 498 void coroutine_fn (*bdrv_co_drain_end)(BlockDriverState *bs); 499 500 void (*bdrv_add_child)(BlockDriverState *parent, BlockDriverState *child, 501 Error **errp); 502 void (*bdrv_del_child)(BlockDriverState *parent, BdrvChild *child, 503 Error **errp); 504 505 /** 506 * Informs the block driver that a permission change is intended. The 507 * driver checks whether the change is permissible and may take other 508 * preparations for the change (e.g. get file system locks). This operation 509 * is always followed either by a call to either .bdrv_set_perm or 510 * .bdrv_abort_perm_update. 511 * 512 * Checks whether the requested set of cumulative permissions in @perm 513 * can be granted for accessing @bs and whether no other users are using 514 * permissions other than those given in @shared (both arguments take 515 * BLK_PERM_* bitmasks). 516 * 517 * If both conditions are met, 0 is returned. Otherwise, -errno is returned 518 * and errp is set to an error describing the conflict. 519 */ 520 int (*bdrv_check_perm)(BlockDriverState *bs, uint64_t perm, 521 uint64_t shared, Error **errp); 522 523 /** 524 * Called to inform the driver that the set of cumulative set of used 525 * permissions for @bs has changed to @perm, and the set of sharable 526 * permission to @shared. The driver can use this to propagate changes to 527 * its children (i.e. request permissions only if a parent actually needs 528 * them). 529 * 530 * This function is only invoked after bdrv_check_perm(), so block drivers 531 * may rely on preparations made in their .bdrv_check_perm implementation. 532 */ 533 void (*bdrv_set_perm)(BlockDriverState *bs, uint64_t perm, uint64_t shared); 534 535 /* 536 * Called to inform the driver that after a previous bdrv_check_perm() 537 * call, the permission update is not performed and any preparations made 538 * for it (e.g. taken file locks) need to be undone. 539 * 540 * This function can be called even for nodes that never saw a 541 * bdrv_check_perm() call. It is a no-op then. 542 */ 543 void (*bdrv_abort_perm_update)(BlockDriverState *bs); 544 545 /** 546 * Returns in @nperm and @nshared the permissions that the driver for @bs 547 * needs on its child @c, based on the cumulative permissions requested by 548 * the parents in @parent_perm and @parent_shared. 549 * 550 * If @c is NULL, return the permissions for attaching a new child for the 551 * given @role. 552 * 553 * If @reopen_queue is non-NULL, don't return the currently needed 554 * permissions, but those that will be needed after applying the 555 * @reopen_queue. 556 */ 557 void (*bdrv_child_perm)(BlockDriverState *bs, BdrvChild *c, 558 const BdrvChildRole *role, 559 BlockReopenQueue *reopen_queue, 560 uint64_t parent_perm, uint64_t parent_shared, 561 uint64_t *nperm, uint64_t *nshared); 562 563 bool (*bdrv_co_can_store_new_dirty_bitmap)(BlockDriverState *bs, 564 const char *name, 565 uint32_t granularity, 566 Error **errp); 567 int (*bdrv_co_remove_persistent_dirty_bitmap)(BlockDriverState *bs, 568 const char *name, 569 Error **errp); 570 571 /** 572 * Register/unregister a buffer for I/O. For example, when the driver is 573 * interested to know the memory areas that will later be used in iovs, so 574 * that it can do IOMMU mapping with VFIO etc., in order to get better 575 * performance. In the case of VFIO drivers, this callback is used to do 576 * DMA mapping for hot buffers. 577 */ 578 void (*bdrv_register_buf)(BlockDriverState *bs, void *host, size_t size); 579 void (*bdrv_unregister_buf)(BlockDriverState *bs, void *host); 580 QLIST_ENTRY(BlockDriver) list; 581 582 /* Pointer to a NULL-terminated array of names of strong options 583 * that can be specified for bdrv_open(). A strong option is one 584 * that changes the data of a BDS. 585 * If this pointer is NULL, the array is considered empty. 586 * "filename" and "driver" are always considered strong. */ 587 const char *const *strong_runtime_opts; 588 }; 589 590 static inline bool block_driver_can_compress(BlockDriver *drv) 591 { 592 return drv->bdrv_co_pwritev_compressed || 593 drv->bdrv_co_pwritev_compressed_part; 594 } 595 596 typedef struct BlockLimits { 597 /* Alignment requirement, in bytes, for offset/length of I/O 598 * requests. Must be a power of 2 less than INT_MAX; defaults to 599 * 1 for drivers with modern byte interfaces, and to 512 600 * otherwise. */ 601 uint32_t request_alignment; 602 603 /* Maximum number of bytes that can be discarded at once (since it 604 * is signed, it must be < 2G, if set). Must be multiple of 605 * pdiscard_alignment, but need not be power of 2. May be 0 if no 606 * inherent 32-bit limit */ 607 int32_t max_pdiscard; 608 609 /* Optimal alignment for discard requests in bytes. A power of 2 610 * is best but not mandatory. Must be a multiple of 611 * bl.request_alignment, and must be less than max_pdiscard if 612 * that is set. May be 0 if bl.request_alignment is good enough */ 613 uint32_t pdiscard_alignment; 614 615 /* Maximum number of bytes that can zeroized at once (since it is 616 * signed, it must be < 2G, if set). Must be multiple of 617 * pwrite_zeroes_alignment. May be 0 if no inherent 32-bit limit */ 618 int32_t max_pwrite_zeroes; 619 620 /* Optimal alignment for write zeroes requests in bytes. A power 621 * of 2 is best but not mandatory. Must be a multiple of 622 * bl.request_alignment, and must be less than max_pwrite_zeroes 623 * if that is set. May be 0 if bl.request_alignment is good 624 * enough */ 625 uint32_t pwrite_zeroes_alignment; 626 627 /* Optimal transfer length in bytes. A power of 2 is best but not 628 * mandatory. Must be a multiple of bl.request_alignment, or 0 if 629 * no preferred size */ 630 uint32_t opt_transfer; 631 632 /* Maximal transfer length in bytes. Need not be power of 2, but 633 * must be multiple of opt_transfer and bl.request_alignment, or 0 634 * for no 32-bit limit. For now, anything larger than INT_MAX is 635 * clamped down. */ 636 uint32_t max_transfer; 637 638 /* memory alignment, in bytes so that no bounce buffer is needed */ 639 size_t min_mem_alignment; 640 641 /* memory alignment, in bytes, for bounce buffer */ 642 size_t opt_mem_alignment; 643 644 /* maximum number of iovec elements */ 645 int max_iov; 646 } BlockLimits; 647 648 typedef struct BdrvOpBlocker BdrvOpBlocker; 649 650 typedef struct BdrvAioNotifier { 651 void (*attached_aio_context)(AioContext *new_context, void *opaque); 652 void (*detach_aio_context)(void *opaque); 653 654 void *opaque; 655 bool deleted; 656 657 QLIST_ENTRY(BdrvAioNotifier) list; 658 } BdrvAioNotifier; 659 660 struct BdrvChildRole { 661 /* If true, bdrv_replace_node() doesn't change the node this BdrvChild 662 * points to. */ 663 bool stay_at_node; 664 665 /* If true, the parent is a BlockDriverState and bdrv_next_all_states() 666 * will return it. This information is used for drain_all, where every node 667 * will be drained separately, so the drain only needs to be propagated to 668 * non-BDS parents. */ 669 bool parent_is_bds; 670 671 void (*inherit_options)(int *child_flags, QDict *child_options, 672 int parent_flags, QDict *parent_options); 673 674 void (*change_media)(BdrvChild *child, bool load); 675 void (*resize)(BdrvChild *child); 676 677 /* Returns a name that is supposedly more useful for human users than the 678 * node name for identifying the node in question (in particular, a BB 679 * name), or NULL if the parent can't provide a better name. */ 680 const char *(*get_name)(BdrvChild *child); 681 682 /* Returns a malloced string that describes the parent of the child for a 683 * human reader. This could be a node-name, BlockBackend name, qdev ID or 684 * QOM path of the device owning the BlockBackend, job type and ID etc. The 685 * caller is responsible for freeing the memory. */ 686 char *(*get_parent_desc)(BdrvChild *child); 687 688 /* 689 * If this pair of functions is implemented, the parent doesn't issue new 690 * requests after returning from .drained_begin() until .drained_end() is 691 * called. 692 * 693 * These functions must not change the graph (and therefore also must not 694 * call aio_poll(), which could change the graph indirectly). 695 * 696 * If drained_end() schedules background operations, it must atomically 697 * increment *drained_end_counter for each such operation and atomically 698 * decrement it once the operation has settled. 699 * 700 * Note that this can be nested. If drained_begin() was called twice, new 701 * I/O is allowed only after drained_end() was called twice, too. 702 */ 703 void (*drained_begin)(BdrvChild *child); 704 void (*drained_end)(BdrvChild *child, int *drained_end_counter); 705 706 /* 707 * Returns whether the parent has pending requests for the child. This 708 * callback is polled after .drained_begin() has been called until all 709 * activity on the child has stopped. 710 */ 711 bool (*drained_poll)(BdrvChild *child); 712 713 /* Notifies the parent that the child has been activated/inactivated (e.g. 714 * when migration is completing) and it can start/stop requesting 715 * permissions and doing I/O on it. */ 716 void (*activate)(BdrvChild *child, Error **errp); 717 int (*inactivate)(BdrvChild *child); 718 719 void (*attach)(BdrvChild *child); 720 void (*detach)(BdrvChild *child); 721 722 /* Notifies the parent that the filename of its child has changed (e.g. 723 * because the direct child was removed from the backing chain), so that it 724 * can update its reference. */ 725 int (*update_filename)(BdrvChild *child, BlockDriverState *new_base, 726 const char *filename, Error **errp); 727 728 bool (*can_set_aio_ctx)(BdrvChild *child, AioContext *ctx, 729 GSList **ignore, Error **errp); 730 void (*set_aio_ctx)(BdrvChild *child, AioContext *ctx, GSList **ignore); 731 }; 732 733 extern const BdrvChildRole child_file; 734 extern const BdrvChildRole child_format; 735 extern const BdrvChildRole child_backing; 736 737 struct BdrvChild { 738 BlockDriverState *bs; 739 char *name; 740 const BdrvChildRole *role; 741 void *opaque; 742 743 /** 744 * Granted permissions for operating on this BdrvChild (BLK_PERM_* bitmask) 745 */ 746 uint64_t perm; 747 748 /** 749 * Permissions that can still be granted to other users of @bs while this 750 * BdrvChild is still attached to it. (BLK_PERM_* bitmask) 751 */ 752 uint64_t shared_perm; 753 754 /* backup of permissions during permission update procedure */ 755 bool has_backup_perm; 756 uint64_t backup_perm; 757 uint64_t backup_shared_perm; 758 759 /* 760 * This link is frozen: the child can neither be replaced nor 761 * detached from the parent. 762 */ 763 bool frozen; 764 765 /* 766 * How many times the parent of this child has been drained 767 * (through role->drained_*). 768 * Usually, this is equal to bs->quiesce_counter (potentially 769 * reduced by bdrv_drain_all_count). It may differ while the 770 * child is entering or leaving a drained section. 771 */ 772 int parent_quiesce_counter; 773 774 QLIST_ENTRY(BdrvChild) next; 775 QLIST_ENTRY(BdrvChild) next_parent; 776 }; 777 778 /* 779 * Note: the function bdrv_append() copies and swaps contents of 780 * BlockDriverStates, so if you add new fields to this struct, please 781 * inspect bdrv_append() to determine if the new fields need to be 782 * copied as well. 783 */ 784 struct BlockDriverState { 785 /* Protected by big QEMU lock or read-only after opening. No special 786 * locking needed during I/O... 787 */ 788 int open_flags; /* flags used to open the file, re-used for re-open */ 789 bool read_only; /* if true, the media is read only */ 790 bool encrypted; /* if true, the media is encrypted */ 791 bool sg; /* if true, the device is a /dev/sg* */ 792 bool probed; /* if true, format was probed rather than specified */ 793 bool force_share; /* if true, always allow all shared permissions */ 794 bool implicit; /* if true, this filter node was automatically inserted */ 795 796 BlockDriver *drv; /* NULL means no media */ 797 void *opaque; 798 799 AioContext *aio_context; /* event loop used for fd handlers, timers, etc */ 800 /* long-running tasks intended to always use the same AioContext as this 801 * BDS may register themselves in this list to be notified of changes 802 * regarding this BDS's context */ 803 QLIST_HEAD(, BdrvAioNotifier) aio_notifiers; 804 bool walking_aio_notifiers; /* to make removal during iteration safe */ 805 806 char filename[PATH_MAX]; 807 char backing_file[PATH_MAX]; /* if non zero, the image is a diff of 808 this file image */ 809 /* The backing filename indicated by the image header; if we ever 810 * open this file, then this is replaced by the resulting BDS's 811 * filename (i.e. after a bdrv_refresh_filename() run). */ 812 char auto_backing_file[PATH_MAX]; 813 char backing_format[16]; /* if non-zero and backing_file exists */ 814 815 QDict *full_open_options; 816 char exact_filename[PATH_MAX]; 817 818 BdrvChild *backing; 819 BdrvChild *file; 820 821 /* I/O Limits */ 822 BlockLimits bl; 823 824 /* Flags honored during pwrite (so far: BDRV_REQ_FUA, 825 * BDRV_REQ_WRITE_UNCHANGED). 826 * If a driver does not support BDRV_REQ_WRITE_UNCHANGED, those 827 * writes will be issued as normal writes without the flag set. 828 * This is important to note for drivers that do not explicitly 829 * request a WRITE permission for their children and instead take 830 * the same permissions as their parent did (this is commonly what 831 * block filters do). Such drivers have to be aware that the 832 * parent may have taken a WRITE_UNCHANGED permission only and is 833 * issuing such requests. Drivers either must make sure that 834 * these requests do not result in plain WRITE accesses (usually 835 * by supporting BDRV_REQ_WRITE_UNCHANGED, and then forwarding 836 * every incoming write request as-is, including potentially that 837 * flag), or they have to explicitly take the WRITE permission for 838 * their children. */ 839 unsigned int supported_write_flags; 840 /* Flags honored during pwrite_zeroes (so far: BDRV_REQ_FUA, 841 * BDRV_REQ_MAY_UNMAP, BDRV_REQ_WRITE_UNCHANGED) */ 842 unsigned int supported_zero_flags; 843 /* 844 * Flags honoured during truncate (so far: BDRV_REQ_ZERO_WRITE). 845 * 846 * If BDRV_REQ_ZERO_WRITE is given, the truncate operation must make sure 847 * that any added space reads as all zeros. If this can't be guaranteed, 848 * the operation must fail. 849 */ 850 unsigned int supported_truncate_flags; 851 852 /* the following member gives a name to every node on the bs graph. */ 853 char node_name[32]; 854 /* element of the list of named nodes building the graph */ 855 QTAILQ_ENTRY(BlockDriverState) node_list; 856 /* element of the list of all BlockDriverStates (all_bdrv_states) */ 857 QTAILQ_ENTRY(BlockDriverState) bs_list; 858 /* element of the list of monitor-owned BDS */ 859 QTAILQ_ENTRY(BlockDriverState) monitor_list; 860 int refcnt; 861 862 /* operation blockers */ 863 QLIST_HEAD(, BdrvOpBlocker) op_blockers[BLOCK_OP_TYPE_MAX]; 864 865 /* The node that this node inherited default options from (and a reopen on 866 * which can affect this node by changing these defaults). This is always a 867 * parent node of this node. */ 868 BlockDriverState *inherits_from; 869 QLIST_HEAD(, BdrvChild) children; 870 QLIST_HEAD(, BdrvChild) parents; 871 872 QDict *options; 873 QDict *explicit_options; 874 BlockdevDetectZeroesOptions detect_zeroes; 875 876 /* The error object in use for blocking operations on backing_hd */ 877 Error *backing_blocker; 878 879 /* Protected by AioContext lock */ 880 881 /* If we are reading a disk image, give its size in sectors. 882 * Generally read-only; it is written to by load_snapshot and 883 * save_snaphost, but the block layer is quiescent during those. 884 */ 885 int64_t total_sectors; 886 887 /* Callback before write request is processed */ 888 NotifierWithReturnList before_write_notifiers; 889 890 /* threshold limit for writes, in bytes. "High water mark". */ 891 uint64_t write_threshold_offset; 892 NotifierWithReturn write_threshold_notifier; 893 894 /* Writing to the list requires the BQL _and_ the dirty_bitmap_mutex. 895 * Reading from the list can be done with either the BQL or the 896 * dirty_bitmap_mutex. Modifying a bitmap only requires 897 * dirty_bitmap_mutex. */ 898 QemuMutex dirty_bitmap_mutex; 899 QLIST_HEAD(, BdrvDirtyBitmap) dirty_bitmaps; 900 901 /* Offset after the highest byte written to */ 902 Stat64 wr_highest_offset; 903 904 /* If true, copy read backing sectors into image. Can be >1 if more 905 * than one client has requested copy-on-read. Accessed with atomic 906 * ops. 907 */ 908 int copy_on_read; 909 910 /* number of in-flight requests; overall and serialising. 911 * Accessed with atomic ops. 912 */ 913 unsigned int in_flight; 914 unsigned int serialising_in_flight; 915 916 /* counter for nested bdrv_io_plug. 917 * Accessed with atomic ops. 918 */ 919 unsigned io_plugged; 920 921 /* do we need to tell the quest if we have a volatile write cache? */ 922 int enable_write_cache; 923 924 /* Accessed with atomic ops. */ 925 int quiesce_counter; 926 int recursive_quiesce_counter; 927 928 unsigned int write_gen; /* Current data generation */ 929 930 /* Protected by reqs_lock. */ 931 CoMutex reqs_lock; 932 QLIST_HEAD(, BdrvTrackedRequest) tracked_requests; 933 CoQueue flush_queue; /* Serializing flush queue */ 934 bool active_flush_req; /* Flush request in flight? */ 935 936 /* Only read/written by whoever has set active_flush_req to true. */ 937 unsigned int flushed_gen; /* Flushed write generation */ 938 939 /* BdrvChild links to this node may never be frozen */ 940 bool never_freeze; 941 }; 942 943 struct BlockBackendRootState { 944 int open_flags; 945 bool read_only; 946 BlockdevDetectZeroesOptions detect_zeroes; 947 }; 948 949 typedef enum BlockMirrorBackingMode { 950 /* Reuse the existing backing chain from the source for the target. 951 * - sync=full: Set backing BDS to NULL. 952 * - sync=top: Use source's backing BDS. 953 * - sync=none: Use source as the backing BDS. */ 954 MIRROR_SOURCE_BACKING_CHAIN, 955 956 /* Open the target's backing chain completely anew */ 957 MIRROR_OPEN_BACKING_CHAIN, 958 959 /* Do not change the target's backing BDS after job completion */ 960 MIRROR_LEAVE_BACKING_CHAIN, 961 } BlockMirrorBackingMode; 962 963 static inline BlockDriverState *backing_bs(BlockDriverState *bs) 964 { 965 return bs->backing ? bs->backing->bs : NULL; 966 } 967 968 969 /* Essential block drivers which must always be statically linked into qemu, and 970 * which therefore can be accessed without using bdrv_find_format() */ 971 extern BlockDriver bdrv_file; 972 extern BlockDriver bdrv_raw; 973 extern BlockDriver bdrv_qcow2; 974 975 int coroutine_fn bdrv_co_preadv(BdrvChild *child, 976 int64_t offset, unsigned int bytes, QEMUIOVector *qiov, 977 BdrvRequestFlags flags); 978 int coroutine_fn bdrv_co_preadv_part(BdrvChild *child, 979 int64_t offset, unsigned int bytes, 980 QEMUIOVector *qiov, size_t qiov_offset, BdrvRequestFlags flags); 981 int coroutine_fn bdrv_co_pwritev(BdrvChild *child, 982 int64_t offset, unsigned int bytes, QEMUIOVector *qiov, 983 BdrvRequestFlags flags); 984 int coroutine_fn bdrv_co_pwritev_part(BdrvChild *child, 985 int64_t offset, unsigned int bytes, 986 QEMUIOVector *qiov, size_t qiov_offset, BdrvRequestFlags flags); 987 988 static inline int coroutine_fn bdrv_co_pread(BdrvChild *child, 989 int64_t offset, unsigned int bytes, void *buf, BdrvRequestFlags flags) 990 { 991 QEMUIOVector qiov = QEMU_IOVEC_INIT_BUF(qiov, buf, bytes); 992 993 return bdrv_co_preadv(child, offset, bytes, &qiov, flags); 994 } 995 996 static inline int coroutine_fn bdrv_co_pwrite(BdrvChild *child, 997 int64_t offset, unsigned int bytes, void *buf, BdrvRequestFlags flags) 998 { 999 QEMUIOVector qiov = QEMU_IOVEC_INIT_BUF(qiov, buf, bytes); 1000 1001 return bdrv_co_pwritev(child, offset, bytes, &qiov, flags); 1002 } 1003 1004 extern unsigned int bdrv_drain_all_count; 1005 void bdrv_apply_subtree_drain(BdrvChild *child, BlockDriverState *new_parent); 1006 void bdrv_unapply_subtree_drain(BdrvChild *child, BlockDriverState *old_parent); 1007 1008 bool coroutine_fn bdrv_mark_request_serialising(BdrvTrackedRequest *req, uint64_t align); 1009 BdrvTrackedRequest *coroutine_fn bdrv_co_get_self_request(BlockDriverState *bs); 1010 1011 int get_tmp_filename(char *filename, int size); 1012 BlockDriver *bdrv_probe_all(const uint8_t *buf, int buf_size, 1013 const char *filename); 1014 1015 void bdrv_parse_filename_strip_prefix(const char *filename, const char *prefix, 1016 QDict *options); 1017 1018 1019 /** 1020 * bdrv_add_before_write_notifier: 1021 * 1022 * Register a callback that is invoked before write requests are processed but 1023 * after any throttling or waiting for overlapping requests. 1024 */ 1025 void bdrv_add_before_write_notifier(BlockDriverState *bs, 1026 NotifierWithReturn *notifier); 1027 1028 /** 1029 * bdrv_add_aio_context_notifier: 1030 * 1031 * If a long-running job intends to be always run in the same AioContext as a 1032 * certain BDS, it may use this function to be notified of changes regarding the 1033 * association of the BDS to an AioContext. 1034 * 1035 * attached_aio_context() is called after the target BDS has been attached to a 1036 * new AioContext; detach_aio_context() is called before the target BDS is being 1037 * detached from its old AioContext. 1038 */ 1039 void bdrv_add_aio_context_notifier(BlockDriverState *bs, 1040 void (*attached_aio_context)(AioContext *new_context, void *opaque), 1041 void (*detach_aio_context)(void *opaque), void *opaque); 1042 1043 /** 1044 * bdrv_remove_aio_context_notifier: 1045 * 1046 * Unsubscribe of change notifications regarding the BDS's AioContext. The 1047 * parameters given here have to be the same as those given to 1048 * bdrv_add_aio_context_notifier(). 1049 */ 1050 void bdrv_remove_aio_context_notifier(BlockDriverState *bs, 1051 void (*aio_context_attached)(AioContext *, 1052 void *), 1053 void (*aio_context_detached)(void *), 1054 void *opaque); 1055 1056 /** 1057 * bdrv_wakeup: 1058 * @bs: The BlockDriverState for which an I/O operation has been completed. 1059 * 1060 * Wake up the main thread if it is waiting on BDRV_POLL_WHILE. During 1061 * synchronous I/O on a BlockDriverState that is attached to another 1062 * I/O thread, the main thread lets the I/O thread's event loop run, 1063 * waiting for the I/O operation to complete. A bdrv_wakeup will wake 1064 * up the main thread if necessary. 1065 * 1066 * Manual calls to bdrv_wakeup are rarely necessary, because 1067 * bdrv_dec_in_flight already calls it. 1068 */ 1069 void bdrv_wakeup(BlockDriverState *bs); 1070 1071 #ifdef _WIN32 1072 int is_windows_drive(const char *filename); 1073 #endif 1074 1075 /** 1076 * stream_start: 1077 * @job_id: The id of the newly-created job, or %NULL to use the 1078 * device name of @bs. 1079 * @bs: Block device to operate on. 1080 * @base: Block device that will become the new base, or %NULL to 1081 * flatten the whole backing file chain onto @bs. 1082 * @backing_file_str: The file name that will be written to @bs as the 1083 * the new backing file if the job completes. Ignored if @base is %NULL. 1084 * @creation_flags: Flags that control the behavior of the Job lifetime. 1085 * See @BlockJobCreateFlags 1086 * @speed: The maximum speed, in bytes per second, or 0 for unlimited. 1087 * @on_error: The action to take upon error. 1088 * @errp: Error object. 1089 * 1090 * Start a streaming operation on @bs. Clusters that are unallocated 1091 * in @bs, but allocated in any image between @base and @bs (both 1092 * exclusive) will be written to @bs. At the end of a successful 1093 * streaming job, the backing file of @bs will be changed to 1094 * @backing_file_str in the written image and to @base in the live 1095 * BlockDriverState. 1096 */ 1097 void stream_start(const char *job_id, BlockDriverState *bs, 1098 BlockDriverState *base, const char *backing_file_str, 1099 int creation_flags, int64_t speed, 1100 BlockdevOnError on_error, Error **errp); 1101 1102 /** 1103 * commit_start: 1104 * @job_id: The id of the newly-created job, or %NULL to use the 1105 * device name of @bs. 1106 * @bs: Active block device. 1107 * @top: Top block device to be committed. 1108 * @base: Block device that will be written into, and become the new top. 1109 * @creation_flags: Flags that control the behavior of the Job lifetime. 1110 * See @BlockJobCreateFlags 1111 * @speed: The maximum speed, in bytes per second, or 0 for unlimited. 1112 * @on_error: The action to take upon error. 1113 * @backing_file_str: String to use as the backing file in @top's overlay 1114 * @filter_node_name: The node name that should be assigned to the filter 1115 * driver that the commit job inserts into the graph above @top. NULL means 1116 * that a node name should be autogenerated. 1117 * @errp: Error object. 1118 * 1119 */ 1120 void commit_start(const char *job_id, BlockDriverState *bs, 1121 BlockDriverState *base, BlockDriverState *top, 1122 int creation_flags, int64_t speed, 1123 BlockdevOnError on_error, const char *backing_file_str, 1124 const char *filter_node_name, Error **errp); 1125 /** 1126 * commit_active_start: 1127 * @job_id: The id of the newly-created job, or %NULL to use the 1128 * device name of @bs. 1129 * @bs: Active block device to be committed. 1130 * @base: Block device that will be written into, and become the new top. 1131 * @creation_flags: Flags that control the behavior of the Job lifetime. 1132 * See @BlockJobCreateFlags 1133 * @speed: The maximum speed, in bytes per second, or 0 for unlimited. 1134 * @on_error: The action to take upon error. 1135 * @filter_node_name: The node name that should be assigned to the filter 1136 * driver that the commit job inserts into the graph above @bs. NULL means that 1137 * a node name should be autogenerated. 1138 * @cb: Completion function for the job. 1139 * @opaque: Opaque pointer value passed to @cb. 1140 * @auto_complete: Auto complete the job. 1141 * @errp: Error object. 1142 * 1143 */ 1144 BlockJob *commit_active_start(const char *job_id, BlockDriverState *bs, 1145 BlockDriverState *base, int creation_flags, 1146 int64_t speed, BlockdevOnError on_error, 1147 const char *filter_node_name, 1148 BlockCompletionFunc *cb, void *opaque, 1149 bool auto_complete, Error **errp); 1150 /* 1151 * mirror_start: 1152 * @job_id: The id of the newly-created job, or %NULL to use the 1153 * device name of @bs. 1154 * @bs: Block device to operate on. 1155 * @target: Block device to write to. 1156 * @replaces: Block graph node name to replace once the mirror is done. Can 1157 * only be used when full mirroring is selected. 1158 * @creation_flags: Flags that control the behavior of the Job lifetime. 1159 * See @BlockJobCreateFlags 1160 * @speed: The maximum speed, in bytes per second, or 0 for unlimited. 1161 * @granularity: The chosen granularity for the dirty bitmap. 1162 * @buf_size: The amount of data that can be in flight at one time. 1163 * @mode: Whether to collapse all images in the chain to the target. 1164 * @backing_mode: How to establish the target's backing chain after completion. 1165 * @zero_target: Whether the target should be explicitly zero-initialized 1166 * @on_source_error: The action to take upon error reading from the source. 1167 * @on_target_error: The action to take upon error writing to the target. 1168 * @unmap: Whether to unmap target where source sectors only contain zeroes. 1169 * @filter_node_name: The node name that should be assigned to the filter 1170 * driver that the mirror job inserts into the graph above @bs. NULL means that 1171 * a node name should be autogenerated. 1172 * @copy_mode: When to trigger writes to the target. 1173 * @errp: Error object. 1174 * 1175 * Start a mirroring operation on @bs. Clusters that are allocated 1176 * in @bs will be written to @target until the job is cancelled or 1177 * manually completed. At the end of a successful mirroring job, 1178 * @bs will be switched to read from @target. 1179 */ 1180 void mirror_start(const char *job_id, BlockDriverState *bs, 1181 BlockDriverState *target, const char *replaces, 1182 int creation_flags, int64_t speed, 1183 uint32_t granularity, int64_t buf_size, 1184 MirrorSyncMode mode, BlockMirrorBackingMode backing_mode, 1185 bool zero_target, 1186 BlockdevOnError on_source_error, 1187 BlockdevOnError on_target_error, 1188 bool unmap, const char *filter_node_name, 1189 MirrorCopyMode copy_mode, Error **errp); 1190 1191 /* 1192 * backup_job_create: 1193 * @job_id: The id of the newly-created job, or %NULL to use the 1194 * device name of @bs. 1195 * @bs: Block device to operate on. 1196 * @target: Block device to write to. 1197 * @speed: The maximum speed, in bytes per second, or 0 for unlimited. 1198 * @sync_mode: What parts of the disk image should be copied to the destination. 1199 * @sync_bitmap: The dirty bitmap if sync_mode is 'bitmap' or 'incremental' 1200 * @bitmap_mode: The bitmap synchronization policy to use. 1201 * @on_source_error: The action to take upon error reading from the source. 1202 * @on_target_error: The action to take upon error writing to the target. 1203 * @creation_flags: Flags that control the behavior of the Job lifetime. 1204 * See @BlockJobCreateFlags 1205 * @cb: Completion function for the job. 1206 * @opaque: Opaque pointer value passed to @cb. 1207 * @txn: Transaction that this job is part of (may be NULL). 1208 * 1209 * Create a backup operation on @bs. Clusters in @bs are written to @target 1210 * until the job is cancelled or manually completed. 1211 */ 1212 BlockJob *backup_job_create(const char *job_id, BlockDriverState *bs, 1213 BlockDriverState *target, int64_t speed, 1214 MirrorSyncMode sync_mode, 1215 BdrvDirtyBitmap *sync_bitmap, 1216 BitmapSyncMode bitmap_mode, 1217 bool compress, 1218 const char *filter_node_name, 1219 BlockdevOnError on_source_error, 1220 BlockdevOnError on_target_error, 1221 int creation_flags, 1222 BlockCompletionFunc *cb, void *opaque, 1223 JobTxn *txn, Error **errp); 1224 1225 BdrvChild *bdrv_root_attach_child(BlockDriverState *child_bs, 1226 const char *child_name, 1227 const BdrvChildRole *child_role, 1228 AioContext *ctx, 1229 uint64_t perm, uint64_t shared_perm, 1230 void *opaque, Error **errp); 1231 void bdrv_root_unref_child(BdrvChild *child); 1232 1233 void bdrv_get_cumulative_perm(BlockDriverState *bs, uint64_t *perm, 1234 uint64_t *shared_perm); 1235 1236 /** 1237 * Sets a BdrvChild's permissions. Avoid if the parent is a BDS; use 1238 * bdrv_child_refresh_perms() instead and make the parent's 1239 * .bdrv_child_perm() implementation return the correct values. 1240 */ 1241 int bdrv_child_try_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared, 1242 Error **errp); 1243 1244 /** 1245 * Calls bs->drv->bdrv_child_perm() and updates the child's permission 1246 * masks with the result. 1247 * Drivers should invoke this function whenever an event occurs that 1248 * makes their .bdrv_child_perm() implementation return different 1249 * values than before, but which will not result in the block layer 1250 * automatically refreshing the permissions. 1251 */ 1252 int bdrv_child_refresh_perms(BlockDriverState *bs, BdrvChild *c, Error **errp); 1253 1254 /* Default implementation for BlockDriver.bdrv_child_perm() that can be used by 1255 * block filters: Forward CONSISTENT_READ, WRITE, WRITE_UNCHANGED and RESIZE to 1256 * all children */ 1257 void bdrv_filter_default_perms(BlockDriverState *bs, BdrvChild *c, 1258 const BdrvChildRole *role, 1259 BlockReopenQueue *reopen_queue, 1260 uint64_t perm, uint64_t shared, 1261 uint64_t *nperm, uint64_t *nshared); 1262 1263 /* Default implementation for BlockDriver.bdrv_child_perm() that can be used by 1264 * (non-raw) image formats: Like above for bs->backing, but for bs->file it 1265 * requires WRITE | RESIZE for read-write images, always requires 1266 * CONSISTENT_READ and doesn't share WRITE. */ 1267 void bdrv_format_default_perms(BlockDriverState *bs, BdrvChild *c, 1268 const BdrvChildRole *role, 1269 BlockReopenQueue *reopen_queue, 1270 uint64_t perm, uint64_t shared, 1271 uint64_t *nperm, uint64_t *nshared); 1272 1273 bool bdrv_recurse_can_replace(BlockDriverState *bs, 1274 BlockDriverState *to_replace); 1275 1276 /* 1277 * Default implementation for drivers to pass bdrv_co_block_status() to 1278 * their file. 1279 */ 1280 int coroutine_fn bdrv_co_block_status_from_file(BlockDriverState *bs, 1281 bool want_zero, 1282 int64_t offset, 1283 int64_t bytes, 1284 int64_t *pnum, 1285 int64_t *map, 1286 BlockDriverState **file); 1287 /* 1288 * Default implementation for drivers to pass bdrv_co_block_status() to 1289 * their backing file. 1290 */ 1291 int coroutine_fn bdrv_co_block_status_from_backing(BlockDriverState *bs, 1292 bool want_zero, 1293 int64_t offset, 1294 int64_t bytes, 1295 int64_t *pnum, 1296 int64_t *map, 1297 BlockDriverState **file); 1298 const char *bdrv_get_parent_name(const BlockDriverState *bs); 1299 void blk_dev_change_media_cb(BlockBackend *blk, bool load, Error **errp); 1300 bool blk_dev_has_removable_media(BlockBackend *blk); 1301 bool blk_dev_has_tray(BlockBackend *blk); 1302 void blk_dev_eject_request(BlockBackend *blk, bool force); 1303 bool blk_dev_is_tray_open(BlockBackend *blk); 1304 bool blk_dev_is_medium_locked(BlockBackend *blk); 1305 1306 void bdrv_set_dirty(BlockDriverState *bs, int64_t offset, int64_t bytes); 1307 1308 void bdrv_clear_dirty_bitmap(BdrvDirtyBitmap *bitmap, HBitmap **out); 1309 void bdrv_restore_dirty_bitmap(BdrvDirtyBitmap *bitmap, HBitmap *backup); 1310 bool bdrv_dirty_bitmap_merge_internal(BdrvDirtyBitmap *dest, 1311 const BdrvDirtyBitmap *src, 1312 HBitmap **backup, bool lock); 1313 1314 void bdrv_inc_in_flight(BlockDriverState *bs); 1315 void bdrv_dec_in_flight(BlockDriverState *bs); 1316 1317 void blockdev_close_all_bdrv_states(void); 1318 1319 int coroutine_fn bdrv_co_copy_range_from(BdrvChild *src, uint64_t src_offset, 1320 BdrvChild *dst, uint64_t dst_offset, 1321 uint64_t bytes, 1322 BdrvRequestFlags read_flags, 1323 BdrvRequestFlags write_flags); 1324 int coroutine_fn bdrv_co_copy_range_to(BdrvChild *src, uint64_t src_offset, 1325 BdrvChild *dst, uint64_t dst_offset, 1326 uint64_t bytes, 1327 BdrvRequestFlags read_flags, 1328 BdrvRequestFlags write_flags); 1329 1330 int refresh_total_sectors(BlockDriverState *bs, int64_t hint); 1331 1332 void bdrv_set_monitor_owned(BlockDriverState *bs); 1333 BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp); 1334 1335 /** 1336 * Simple implementation of bdrv_co_create_opts for protocol drivers 1337 * which only support creation via opening a file 1338 * (usually existing raw storage device) 1339 */ 1340 int coroutine_fn bdrv_co_create_opts_simple(BlockDriver *drv, 1341 const char *filename, 1342 QemuOpts *opts, 1343 Error **errp); 1344 extern QemuOptsList bdrv_create_opts_simple; 1345 1346 #endif /* BLOCK_INT_H */ 1347