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 "qemu/option.h" 30 #include "qemu/queue.h" 31 #include "block/coroutine.h" 32 #include "qemu/timer.h" 33 #include "qapi-types.h" 34 #include "qapi/qmp/qerror.h" 35 #include "monitor/monitor.h" 36 #include "qemu/hbitmap.h" 37 #include "block/snapshot.h" 38 #include "qemu/main-loop.h" 39 #include "qemu/throttle.h" 40 41 #define BLOCK_FLAG_ENCRYPT 1 42 #define BLOCK_FLAG_COMPAT6 4 43 #define BLOCK_FLAG_LAZY_REFCOUNTS 8 44 45 #define BLOCK_OPT_SIZE "size" 46 #define BLOCK_OPT_ENCRYPT "encryption" 47 #define BLOCK_OPT_COMPAT6 "compat6" 48 #define BLOCK_OPT_BACKING_FILE "backing_file" 49 #define BLOCK_OPT_BACKING_FMT "backing_fmt" 50 #define BLOCK_OPT_CLUSTER_SIZE "cluster_size" 51 #define BLOCK_OPT_TABLE_SIZE "table_size" 52 #define BLOCK_OPT_PREALLOC "preallocation" 53 #define BLOCK_OPT_SUBFMT "subformat" 54 #define BLOCK_OPT_COMPAT_LEVEL "compat" 55 #define BLOCK_OPT_LAZY_REFCOUNTS "lazy_refcounts" 56 #define BLOCK_OPT_ADAPTER_TYPE "adapter_type" 57 #define BLOCK_OPT_REDUNDANCY "redundancy" 58 #define BLOCK_OPT_NOCOW "nocow" 59 #define BLOCK_OPT_OBJECT_SIZE "object_size" 60 #define BLOCK_OPT_REFCOUNT_BITS "refcount_bits" 61 62 #define BLOCK_PROBE_BUF_SIZE 512 63 64 typedef struct BdrvTrackedRequest { 65 BlockDriverState *bs; 66 int64_t offset; 67 unsigned int bytes; 68 bool is_write; 69 70 bool serialising; 71 int64_t overlap_offset; 72 unsigned int overlap_bytes; 73 74 QLIST_ENTRY(BdrvTrackedRequest) list; 75 Coroutine *co; /* owner, used for deadlock detection */ 76 CoQueue wait_queue; /* coroutines blocked on this request */ 77 78 struct BdrvTrackedRequest *waiting_for; 79 } BdrvTrackedRequest; 80 81 struct BlockDriver { 82 const char *format_name; 83 int instance_size; 84 85 /* set to true if the BlockDriver is a block filter */ 86 bool is_filter; 87 /* for snapshots block filter like Quorum can implement the 88 * following recursive callback. 89 * It's purpose is to recurse on the filter children while calling 90 * bdrv_recurse_is_first_non_filter on them. 91 * For a sample implementation look in the future Quorum block filter. 92 */ 93 bool (*bdrv_recurse_is_first_non_filter)(BlockDriverState *bs, 94 BlockDriverState *candidate); 95 96 int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename); 97 int (*bdrv_probe_device)(const char *filename); 98 99 /* Any driver implementing this callback is expected to be able to handle 100 * NULL file names in its .bdrv_open() implementation */ 101 void (*bdrv_parse_filename)(const char *filename, QDict *options, Error **errp); 102 /* Drivers not implementing bdrv_parse_filename nor bdrv_open should have 103 * this field set to true, except ones that are defined only by their 104 * child's bs. 105 * An example of the last type will be the quorum block driver. 106 */ 107 bool bdrv_needs_filename; 108 109 /* Set if a driver can support backing files */ 110 bool supports_backing; 111 112 /* For handling image reopen for split or non-split files */ 113 int (*bdrv_reopen_prepare)(BDRVReopenState *reopen_state, 114 BlockReopenQueue *queue, Error **errp); 115 void (*bdrv_reopen_commit)(BDRVReopenState *reopen_state); 116 void (*bdrv_reopen_abort)(BDRVReopenState *reopen_state); 117 118 int (*bdrv_open)(BlockDriverState *bs, QDict *options, int flags, 119 Error **errp); 120 int (*bdrv_file_open)(BlockDriverState *bs, QDict *options, int flags, 121 Error **errp); 122 int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num, 123 uint8_t *buf, int nb_sectors); 124 int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num, 125 const uint8_t *buf, int nb_sectors); 126 void (*bdrv_close)(BlockDriverState *bs); 127 void (*bdrv_rebind)(BlockDriverState *bs); 128 int (*bdrv_create)(const char *filename, QemuOpts *opts, Error **errp); 129 int (*bdrv_set_key)(BlockDriverState *bs, const char *key); 130 int (*bdrv_make_empty)(BlockDriverState *bs); 131 132 void (*bdrv_refresh_filename)(BlockDriverState *bs); 133 134 /* aio */ 135 BlockAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs, 136 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, 137 BlockCompletionFunc *cb, void *opaque); 138 BlockAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs, 139 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, 140 BlockCompletionFunc *cb, void *opaque); 141 BlockAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs, 142 BlockCompletionFunc *cb, void *opaque); 143 BlockAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs, 144 int64_t sector_num, int nb_sectors, 145 BlockCompletionFunc *cb, void *opaque); 146 147 int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs, 148 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov); 149 int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs, 150 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov); 151 /* 152 * Efficiently zero a region of the disk image. Typically an image format 153 * would use a compact metadata representation to implement this. This 154 * function pointer may be NULL and .bdrv_co_writev() will be called 155 * instead. 156 */ 157 int coroutine_fn (*bdrv_co_write_zeroes)(BlockDriverState *bs, 158 int64_t sector_num, int nb_sectors, BdrvRequestFlags flags); 159 int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs, 160 int64_t sector_num, int nb_sectors); 161 int64_t coroutine_fn (*bdrv_co_get_block_status)(BlockDriverState *bs, 162 int64_t sector_num, int nb_sectors, int *pnum); 163 164 /* 165 * Invalidate any cached meta-data. 166 */ 167 void (*bdrv_invalidate_cache)(BlockDriverState *bs, Error **errp); 168 169 /* 170 * Flushes all data that was already written to the OS all the way down to 171 * the disk (for example raw-posix calls fsync()). 172 */ 173 int coroutine_fn (*bdrv_co_flush_to_disk)(BlockDriverState *bs); 174 175 /* 176 * Flushes all internal caches to the OS. The data may still sit in a 177 * writeback cache of the host OS, but it will survive a crash of the qemu 178 * process. 179 */ 180 int coroutine_fn (*bdrv_co_flush_to_os)(BlockDriverState *bs); 181 182 const char *protocol_name; 183 int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset); 184 185 int64_t (*bdrv_getlength)(BlockDriverState *bs); 186 bool has_variable_length; 187 int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs); 188 189 int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num, 190 const uint8_t *buf, int nb_sectors); 191 192 int (*bdrv_snapshot_create)(BlockDriverState *bs, 193 QEMUSnapshotInfo *sn_info); 194 int (*bdrv_snapshot_goto)(BlockDriverState *bs, 195 const char *snapshot_id); 196 int (*bdrv_snapshot_delete)(BlockDriverState *bs, 197 const char *snapshot_id, 198 const char *name, 199 Error **errp); 200 int (*bdrv_snapshot_list)(BlockDriverState *bs, 201 QEMUSnapshotInfo **psn_info); 202 int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs, 203 const char *snapshot_id, 204 const char *name, 205 Error **errp); 206 int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi); 207 ImageInfoSpecific *(*bdrv_get_specific_info)(BlockDriverState *bs); 208 209 int (*bdrv_save_vmstate)(BlockDriverState *bs, QEMUIOVector *qiov, 210 int64_t pos); 211 int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf, 212 int64_t pos, int size); 213 214 int (*bdrv_change_backing_file)(BlockDriverState *bs, 215 const char *backing_file, const char *backing_fmt); 216 217 /* removable device specific */ 218 int (*bdrv_is_inserted)(BlockDriverState *bs); 219 int (*bdrv_media_changed)(BlockDriverState *bs); 220 void (*bdrv_eject)(BlockDriverState *bs, bool eject_flag); 221 void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked); 222 223 /* to control generic scsi devices */ 224 int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf); 225 BlockAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs, 226 unsigned long int req, void *buf, 227 BlockCompletionFunc *cb, void *opaque); 228 229 /* List of options for creating images, terminated by name == NULL */ 230 QemuOptsList *create_opts; 231 232 /* 233 * Returns 0 for completed check, -errno for internal errors. 234 * The check results are stored in result. 235 */ 236 int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result, 237 BdrvCheckMode fix); 238 239 int (*bdrv_amend_options)(BlockDriverState *bs, QemuOpts *opts, 240 BlockDriverAmendStatusCB *status_cb); 241 242 void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event); 243 244 /* TODO Better pass a option string/QDict/QemuOpts to add any rule? */ 245 int (*bdrv_debug_breakpoint)(BlockDriverState *bs, const char *event, 246 const char *tag); 247 int (*bdrv_debug_remove_breakpoint)(BlockDriverState *bs, 248 const char *tag); 249 int (*bdrv_debug_resume)(BlockDriverState *bs, const char *tag); 250 bool (*bdrv_debug_is_suspended)(BlockDriverState *bs, const char *tag); 251 252 void (*bdrv_refresh_limits)(BlockDriverState *bs, Error **errp); 253 254 /* 255 * Returns 1 if newly created images are guaranteed to contain only 256 * zeros, 0 otherwise. 257 */ 258 int (*bdrv_has_zero_init)(BlockDriverState *bs); 259 260 /* Remove fd handlers, timers, and other event loop callbacks so the event 261 * loop is no longer in use. Called with no in-flight requests and in 262 * depth-first traversal order with parents before child nodes. 263 */ 264 void (*bdrv_detach_aio_context)(BlockDriverState *bs); 265 266 /* Add fd handlers, timers, and other event loop callbacks so I/O requests 267 * can be processed again. Called with no in-flight requests and in 268 * depth-first traversal order with child nodes before parent nodes. 269 */ 270 void (*bdrv_attach_aio_context)(BlockDriverState *bs, 271 AioContext *new_context); 272 273 /* io queue for linux-aio */ 274 void (*bdrv_io_plug)(BlockDriverState *bs); 275 void (*bdrv_io_unplug)(BlockDriverState *bs); 276 void (*bdrv_flush_io_queue)(BlockDriverState *bs); 277 278 /** 279 * Try to get @bs's logical and physical block size. 280 * On success, store them in @bsz and return zero. 281 * On failure, return negative errno. 282 */ 283 int (*bdrv_probe_blocksizes)(BlockDriverState *bs, BlockSizes *bsz); 284 /** 285 * Try to get @bs's geometry (cyls, heads, sectors) 286 * On success, store them in @geo and return 0. 287 * On failure return -errno. 288 * Only drivers that want to override guest geometry implement this 289 * callback; see hd_geometry_guess(). 290 */ 291 int (*bdrv_probe_geometry)(BlockDriverState *bs, HDGeometry *geo); 292 293 QLIST_ENTRY(BlockDriver) list; 294 }; 295 296 typedef struct BlockLimits { 297 /* maximum number of sectors that can be discarded at once */ 298 int max_discard; 299 300 /* optimal alignment for discard requests in sectors */ 301 int64_t discard_alignment; 302 303 /* maximum number of sectors that can zeroized at once */ 304 int max_write_zeroes; 305 306 /* optimal alignment for write zeroes requests in sectors */ 307 int64_t write_zeroes_alignment; 308 309 /* optimal transfer length in sectors */ 310 int opt_transfer_length; 311 312 /* maximal transfer length in sectors */ 313 int max_transfer_length; 314 315 /* memory alignment so that no bounce buffer is needed */ 316 size_t min_mem_alignment; 317 318 /* memory alignment for bounce buffer */ 319 size_t opt_mem_alignment; 320 } BlockLimits; 321 322 typedef struct BdrvOpBlocker BdrvOpBlocker; 323 324 typedef struct BdrvAioNotifier { 325 void (*attached_aio_context)(AioContext *new_context, void *opaque); 326 void (*detach_aio_context)(void *opaque); 327 328 void *opaque; 329 330 QLIST_ENTRY(BdrvAioNotifier) list; 331 } BdrvAioNotifier; 332 333 /* 334 * Note: the function bdrv_append() copies and swaps contents of 335 * BlockDriverStates, so if you add new fields to this struct, please 336 * inspect bdrv_append() to determine if the new fields need to be 337 * copied as well. 338 */ 339 struct BlockDriverState { 340 int64_t total_sectors; /* if we are reading a disk image, give its 341 size in sectors */ 342 int read_only; /* if true, the media is read only */ 343 int open_flags; /* flags used to open the file, re-used for re-open */ 344 int encrypted; /* if true, the media is encrypted */ 345 int valid_key; /* if true, a valid encryption key has been set */ 346 int sg; /* if true, the device is a /dev/sg* */ 347 int copy_on_read; /* if true, copy read backing sectors into image 348 note this is a reference count */ 349 bool probed; 350 351 BlockDriver *drv; /* NULL means no media */ 352 void *opaque; 353 354 BlockBackend *blk; /* owning backend, if any */ 355 356 AioContext *aio_context; /* event loop used for fd handlers, timers, etc */ 357 /* long-running tasks intended to always use the same AioContext as this 358 * BDS may register themselves in this list to be notified of changes 359 * regarding this BDS's context */ 360 QLIST_HEAD(, BdrvAioNotifier) aio_notifiers; 361 362 char filename[PATH_MAX]; 363 char backing_file[PATH_MAX]; /* if non zero, the image is a diff of 364 this file image */ 365 char backing_format[16]; /* if non-zero and backing_file exists */ 366 367 QDict *full_open_options; 368 char exact_filename[PATH_MAX]; 369 370 BlockDriverState *backing_hd; 371 BlockDriverState *file; 372 373 NotifierList close_notifiers; 374 375 /* Callback before write request is processed */ 376 NotifierWithReturnList before_write_notifiers; 377 378 /* number of in-flight serialising requests */ 379 unsigned int serialising_in_flight; 380 381 /* I/O throttling */ 382 ThrottleState throttle_state; 383 CoQueue throttled_reqs[2]; 384 bool io_limits_enabled; 385 386 /* I/O stats (display with "info blockstats"). */ 387 BlockAcctStats stats; 388 389 /* I/O Limits */ 390 BlockLimits bl; 391 392 /* Whether produces zeros when read beyond eof */ 393 bool zero_beyond_eof; 394 395 /* Alignment requirement for offset/length of I/O requests */ 396 unsigned int request_alignment; 397 398 /* the block size for which the guest device expects atomicity */ 399 int guest_block_size; 400 401 /* do we need to tell the quest if we have a volatile write cache? */ 402 int enable_write_cache; 403 404 /* NOTE: the following infos are only hints for real hardware 405 drivers. They are not used by the block driver */ 406 BlockdevOnError on_read_error, on_write_error; 407 bool iostatus_enabled; 408 BlockDeviceIoStatus iostatus; 409 410 /* the following member gives a name to every node on the bs graph. */ 411 char node_name[32]; 412 /* element of the list of named nodes building the graph */ 413 QTAILQ_ENTRY(BlockDriverState) node_list; 414 /* element of the list of "drives" the guest sees */ 415 QTAILQ_ENTRY(BlockDriverState) device_list; 416 QLIST_HEAD(, BdrvDirtyBitmap) dirty_bitmaps; 417 int refcnt; 418 419 QLIST_HEAD(, BdrvTrackedRequest) tracked_requests; 420 421 /* operation blockers */ 422 QLIST_HEAD(, BdrvOpBlocker) op_blockers[BLOCK_OP_TYPE_MAX]; 423 424 /* long-running background operation */ 425 BlockJob *job; 426 427 QDict *options; 428 BlockdevDetectZeroesOptions detect_zeroes; 429 430 /* The error object in use for blocking operations on backing_hd */ 431 Error *backing_blocker; 432 433 /* threshold limit for writes, in bytes. "High water mark". */ 434 uint64_t write_threshold_offset; 435 NotifierWithReturn write_threshold_notifier; 436 }; 437 438 439 /* Essential block drivers which must always be statically linked into qemu, and 440 * which therefore can be accessed without using bdrv_find_format() */ 441 extern BlockDriver bdrv_file; 442 extern BlockDriver bdrv_raw; 443 extern BlockDriver bdrv_qcow2; 444 445 /** 446 * bdrv_setup_io_funcs: 447 * 448 * Prepare a #BlockDriver for I/O request processing by populating 449 * unimplemented coroutine and AIO interfaces with generic wrapper functions 450 * that fall back to implemented interfaces. 451 */ 452 void bdrv_setup_io_funcs(BlockDriver *bdrv); 453 454 int get_tmp_filename(char *filename, int size); 455 BlockDriver *bdrv_probe_all(const uint8_t *buf, int buf_size, 456 const char *filename); 457 458 void bdrv_set_io_limits(BlockDriverState *bs, 459 ThrottleConfig *cfg); 460 461 462 /** 463 * bdrv_add_before_write_notifier: 464 * 465 * Register a callback that is invoked before write requests are processed but 466 * after any throttling or waiting for overlapping requests. 467 */ 468 void bdrv_add_before_write_notifier(BlockDriverState *bs, 469 NotifierWithReturn *notifier); 470 471 /** 472 * bdrv_detach_aio_context: 473 * 474 * May be called from .bdrv_detach_aio_context() to detach children from the 475 * current #AioContext. This is only needed by block drivers that manage their 476 * own children. Both ->file and ->backing_hd are automatically handled and 477 * block drivers should not call this function on them explicitly. 478 */ 479 void bdrv_detach_aio_context(BlockDriverState *bs); 480 481 /** 482 * bdrv_attach_aio_context: 483 * 484 * May be called from .bdrv_attach_aio_context() to attach children to the new 485 * #AioContext. This is only needed by block drivers that manage their own 486 * children. Both ->file and ->backing_hd are automatically handled and block 487 * drivers should not call this function on them explicitly. 488 */ 489 void bdrv_attach_aio_context(BlockDriverState *bs, 490 AioContext *new_context); 491 492 /** 493 * bdrv_add_aio_context_notifier: 494 * 495 * If a long-running job intends to be always run in the same AioContext as a 496 * certain BDS, it may use this function to be notified of changes regarding the 497 * association of the BDS to an AioContext. 498 * 499 * attached_aio_context() is called after the target BDS has been attached to a 500 * new AioContext; detach_aio_context() is called before the target BDS is being 501 * detached from its old AioContext. 502 */ 503 void bdrv_add_aio_context_notifier(BlockDriverState *bs, 504 void (*attached_aio_context)(AioContext *new_context, void *opaque), 505 void (*detach_aio_context)(void *opaque), void *opaque); 506 507 /** 508 * bdrv_remove_aio_context_notifier: 509 * 510 * Unsubscribe of change notifications regarding the BDS's AioContext. The 511 * parameters given here have to be the same as those given to 512 * bdrv_add_aio_context_notifier(). 513 */ 514 void bdrv_remove_aio_context_notifier(BlockDriverState *bs, 515 void (*aio_context_attached)(AioContext *, 516 void *), 517 void (*aio_context_detached)(void *), 518 void *opaque); 519 520 #ifdef _WIN32 521 int is_windows_drive(const char *filename); 522 #endif 523 524 /** 525 * stream_start: 526 * @bs: Block device to operate on. 527 * @base: Block device that will become the new base, or %NULL to 528 * flatten the whole backing file chain onto @bs. 529 * @base_id: The file name that will be written to @bs as the new 530 * backing file if the job completes. Ignored if @base is %NULL. 531 * @speed: The maximum speed, in bytes per second, or 0 for unlimited. 532 * @on_error: The action to take upon error. 533 * @cb: Completion function for the job. 534 * @opaque: Opaque pointer value passed to @cb. 535 * @errp: Error object. 536 * 537 * Start a streaming operation on @bs. Clusters that are unallocated 538 * in @bs, but allocated in any image between @base and @bs (both 539 * exclusive) will be written to @bs. At the end of a successful 540 * streaming job, the backing file of @bs will be changed to 541 * @base_id in the written image and to @base in the live BlockDriverState. 542 */ 543 void stream_start(BlockDriverState *bs, BlockDriverState *base, 544 const char *base_id, int64_t speed, BlockdevOnError on_error, 545 BlockCompletionFunc *cb, 546 void *opaque, Error **errp); 547 548 /** 549 * commit_start: 550 * @bs: Active block device. 551 * @top: Top block device to be committed. 552 * @base: Block device that will be written into, and become the new top. 553 * @speed: The maximum speed, in bytes per second, or 0 for unlimited. 554 * @on_error: The action to take upon error. 555 * @cb: Completion function for the job. 556 * @opaque: Opaque pointer value passed to @cb. 557 * @backing_file_str: String to use as the backing file in @top's overlay 558 * @errp: Error object. 559 * 560 */ 561 void commit_start(BlockDriverState *bs, BlockDriverState *base, 562 BlockDriverState *top, int64_t speed, 563 BlockdevOnError on_error, BlockCompletionFunc *cb, 564 void *opaque, const char *backing_file_str, Error **errp); 565 /** 566 * commit_active_start: 567 * @bs: Active block device to be committed. 568 * @base: Block device that will be written into, and become the new top. 569 * @speed: The maximum speed, in bytes per second, or 0 for unlimited. 570 * @on_error: The action to take upon error. 571 * @cb: Completion function for the job. 572 * @opaque: Opaque pointer value passed to @cb. 573 * @errp: Error object. 574 * 575 */ 576 void commit_active_start(BlockDriverState *bs, BlockDriverState *base, 577 int64_t speed, 578 BlockdevOnError on_error, 579 BlockCompletionFunc *cb, 580 void *opaque, Error **errp); 581 /* 582 * mirror_start: 583 * @bs: Block device to operate on. 584 * @target: Block device to write to. 585 * @replaces: Block graph node name to replace once the mirror is done. Can 586 * only be used when full mirroring is selected. 587 * @speed: The maximum speed, in bytes per second, or 0 for unlimited. 588 * @granularity: The chosen granularity for the dirty bitmap. 589 * @buf_size: The amount of data that can be in flight at one time. 590 * @mode: Whether to collapse all images in the chain to the target. 591 * @on_source_error: The action to take upon error reading from the source. 592 * @on_target_error: The action to take upon error writing to the target. 593 * @cb: Completion function for the job. 594 * @opaque: Opaque pointer value passed to @cb. 595 * @errp: Error object. 596 * 597 * Start a mirroring operation on @bs. Clusters that are allocated 598 * in @bs will be written to @bs until the job is cancelled or 599 * manually completed. At the end of a successful mirroring job, 600 * @bs will be switched to read from @target. 601 */ 602 void mirror_start(BlockDriverState *bs, BlockDriverState *target, 603 const char *replaces, 604 int64_t speed, uint32_t granularity, int64_t buf_size, 605 MirrorSyncMode mode, BlockdevOnError on_source_error, 606 BlockdevOnError on_target_error, 607 BlockCompletionFunc *cb, 608 void *opaque, Error **errp); 609 610 /* 611 * backup_start: 612 * @bs: Block device to operate on. 613 * @target: Block device to write to. 614 * @speed: The maximum speed, in bytes per second, or 0 for unlimited. 615 * @sync_mode: What parts of the disk image should be copied to the destination. 616 * @sync_bitmap: The dirty bitmap if sync_mode is MIRROR_SYNC_MODE_DIRTY_BITMAP. 617 * @on_source_error: The action to take upon error reading from the source. 618 * @on_target_error: The action to take upon error writing to the target. 619 * @cb: Completion function for the job. 620 * @opaque: Opaque pointer value passed to @cb. 621 * 622 * Start a backup operation on @bs. Clusters in @bs are written to @target 623 * until the job is cancelled or manually completed. 624 */ 625 void backup_start(BlockDriverState *bs, BlockDriverState *target, 626 int64_t speed, MirrorSyncMode sync_mode, 627 BdrvDirtyBitmap *sync_bitmap, 628 BlockdevOnError on_source_error, 629 BlockdevOnError on_target_error, 630 BlockCompletionFunc *cb, void *opaque, 631 Error **errp); 632 633 void blk_dev_change_media_cb(BlockBackend *blk, bool load); 634 bool blk_dev_has_removable_media(BlockBackend *blk); 635 void blk_dev_eject_request(BlockBackend *blk, bool force); 636 bool blk_dev_is_tray_open(BlockBackend *blk); 637 bool blk_dev_is_medium_locked(BlockBackend *blk); 638 void blk_dev_resize_cb(BlockBackend *blk); 639 640 void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors); 641 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, 642 int nr_sectors); 643 644 #endif /* BLOCK_INT_H */ 645