2 * QEMU System Emulator block driver
4 * Copyright (c) 2003 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
27 #include "block/accounting.h"
28 #include "block/block.h"
29 #include "block/throttle-groups.h"
30 #include "qemu/option.h"
31 #include "qemu/queue.h"
32 #include "qemu/coroutine.h"
33 #include "qemu/timer.h"
34 #include "qapi-types.h"
35 #include "qemu/hbitmap.h"
36 #include "block/snapshot.h"
37 #include "qemu/main-loop.h"
38 #include "qemu/throttle.h"
40 #define BLOCK_FLAG_ENCRYPT 1
41 #define BLOCK_FLAG_COMPAT6 4
42 #define BLOCK_FLAG_LAZY_REFCOUNTS 8
44 #define BLOCK_OPT_SIZE "size"
45 #define BLOCK_OPT_ENCRYPT "encryption"
46 #define BLOCK_OPT_COMPAT6 "compat6"
47 #define BLOCK_OPT_BACKING_FILE "backing_file"
48 #define BLOCK_OPT_BACKING_FMT "backing_fmt"
49 #define BLOCK_OPT_CLUSTER_SIZE "cluster_size"
50 #define BLOCK_OPT_TABLE_SIZE "table_size"
51 #define BLOCK_OPT_PREALLOC "preallocation"
52 #define BLOCK_OPT_SUBFMT "subformat"
53 #define BLOCK_OPT_COMPAT_LEVEL "compat"
54 #define BLOCK_OPT_LAZY_REFCOUNTS "lazy_refcounts"
55 #define BLOCK_OPT_ADAPTER_TYPE "adapter_type"
56 #define BLOCK_OPT_REDUNDANCY "redundancy"
57 #define BLOCK_OPT_NOCOW "nocow"
58 #define BLOCK_OPT_OBJECT_SIZE "object_size"
59 #define BLOCK_OPT_REFCOUNT_BITS "refcount_bits"
61 #define BLOCK_PROBE_BUF_SIZE 512
63 enum BdrvTrackedRequestType
{
71 typedef struct BdrvTrackedRequest
{
75 enum BdrvTrackedRequestType type
;
78 int64_t overlap_offset
;
79 unsigned int overlap_bytes
;
81 QLIST_ENTRY(BdrvTrackedRequest
) list
;
82 Coroutine
*co
; /* owner, used for deadlock detection */
83 CoQueue wait_queue
; /* coroutines blocked on this request */
85 struct BdrvTrackedRequest
*waiting_for
;
89 const char *format_name
;
92 /* set to true if the BlockDriver is a block filter */
94 /* for snapshots block filter like Quorum can implement the
95 * following recursive callback.
96 * It's purpose is to recurse on the filter children while calling
97 * bdrv_recurse_is_first_non_filter on them.
98 * For a sample implementation look in the future Quorum block filter.
100 bool (*bdrv_recurse_is_first_non_filter
)(BlockDriverState
*bs
,
101 BlockDriverState
*candidate
);
103 int (*bdrv_probe
)(const uint8_t *buf
, int buf_size
, const char *filename
);
104 int (*bdrv_probe_device
)(const char *filename
);
106 /* Any driver implementing this callback is expected to be able to handle
107 * NULL file names in its .bdrv_open() implementation */
108 void (*bdrv_parse_filename
)(const char *filename
, QDict
*options
, Error
**errp
);
109 /* Drivers not implementing bdrv_parse_filename nor bdrv_open should have
110 * this field set to true, except ones that are defined only by their
112 * An example of the last type will be the quorum block driver.
114 bool bdrv_needs_filename
;
116 /* Set if a driver can support backing files */
117 bool supports_backing
;
119 /* For handling image reopen for split or non-split files */
120 int (*bdrv_reopen_prepare
)(BDRVReopenState
*reopen_state
,
121 BlockReopenQueue
*queue
, Error
**errp
);
122 void (*bdrv_reopen_commit
)(BDRVReopenState
*reopen_state
);
123 void (*bdrv_reopen_abort
)(BDRVReopenState
*reopen_state
);
124 void (*bdrv_join_options
)(QDict
*options
, QDict
*old_options
);
126 int (*bdrv_open
)(BlockDriverState
*bs
, QDict
*options
, int flags
,
128 int (*bdrv_file_open
)(BlockDriverState
*bs
, QDict
*options
, int flags
,
130 int (*bdrv_read
)(BlockDriverState
*bs
, int64_t sector_num
,
131 uint8_t *buf
, int nb_sectors
);
132 int (*bdrv_write
)(BlockDriverState
*bs
, int64_t sector_num
,
133 const uint8_t *buf
, int nb_sectors
);
134 void (*bdrv_close
)(BlockDriverState
*bs
);
135 int (*bdrv_create
)(const char *filename
, QemuOpts
*opts
, Error
**errp
);
136 int (*bdrv_set_key
)(BlockDriverState
*bs
, const char *key
);
137 int (*bdrv_make_empty
)(BlockDriverState
*bs
);
139 void (*bdrv_refresh_filename
)(BlockDriverState
*bs
, QDict
*options
);
142 BlockAIOCB
*(*bdrv_aio_readv
)(BlockDriverState
*bs
,
143 int64_t sector_num
, QEMUIOVector
*qiov
, int nb_sectors
,
144 BlockCompletionFunc
*cb
, void *opaque
);
145 BlockAIOCB
*(*bdrv_aio_writev
)(BlockDriverState
*bs
,
146 int64_t sector_num
, QEMUIOVector
*qiov
, int nb_sectors
,
147 BlockCompletionFunc
*cb
, void *opaque
);
148 BlockAIOCB
*(*bdrv_aio_flush
)(BlockDriverState
*bs
,
149 BlockCompletionFunc
*cb
, void *opaque
);
150 BlockAIOCB
*(*bdrv_aio_discard
)(BlockDriverState
*bs
,
151 int64_t sector_num
, int nb_sectors
,
152 BlockCompletionFunc
*cb
, void *opaque
);
154 int coroutine_fn (*bdrv_co_readv
)(BlockDriverState
*bs
,
155 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
);
156 int coroutine_fn (*bdrv_co_writev
)(BlockDriverState
*bs
,
157 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
);
159 * Efficiently zero a region of the disk image. Typically an image format
160 * would use a compact metadata representation to implement this. This
161 * function pointer may be NULL and .bdrv_co_writev() will be called
164 int coroutine_fn (*bdrv_co_write_zeroes
)(BlockDriverState
*bs
,
165 int64_t sector_num
, int nb_sectors
, BdrvRequestFlags flags
);
166 int coroutine_fn (*bdrv_co_discard
)(BlockDriverState
*bs
,
167 int64_t sector_num
, int nb_sectors
);
168 int64_t coroutine_fn (*bdrv_co_get_block_status
)(BlockDriverState
*bs
,
169 int64_t sector_num
, int nb_sectors
, int *pnum
);
172 * Invalidate any cached meta-data.
174 void (*bdrv_invalidate_cache
)(BlockDriverState
*bs
, Error
**errp
);
175 int (*bdrv_inactivate
)(BlockDriverState
*bs
);
178 * Flushes all data that was already written to the OS all the way down to
179 * the disk (for example raw-posix calls fsync()).
181 int coroutine_fn (*bdrv_co_flush_to_disk
)(BlockDriverState
*bs
);
184 * Flushes all internal caches to the OS. The data may still sit in a
185 * writeback cache of the host OS, but it will survive a crash of the qemu
188 int coroutine_fn (*bdrv_co_flush_to_os
)(BlockDriverState
*bs
);
190 const char *protocol_name
;
191 int (*bdrv_truncate
)(BlockDriverState
*bs
, int64_t offset
);
193 int64_t (*bdrv_getlength
)(BlockDriverState
*bs
);
194 bool has_variable_length
;
195 int64_t (*bdrv_get_allocated_file_size
)(BlockDriverState
*bs
);
197 int (*bdrv_write_compressed
)(BlockDriverState
*bs
, int64_t sector_num
,
198 const uint8_t *buf
, int nb_sectors
);
200 int (*bdrv_snapshot_create
)(BlockDriverState
*bs
,
201 QEMUSnapshotInfo
*sn_info
);
202 int (*bdrv_snapshot_goto
)(BlockDriverState
*bs
,
203 const char *snapshot_id
);
204 int (*bdrv_snapshot_delete
)(BlockDriverState
*bs
,
205 const char *snapshot_id
,
208 int (*bdrv_snapshot_list
)(BlockDriverState
*bs
,
209 QEMUSnapshotInfo
**psn_info
);
210 int (*bdrv_snapshot_load_tmp
)(BlockDriverState
*bs
,
211 const char *snapshot_id
,
214 int (*bdrv_get_info
)(BlockDriverState
*bs
, BlockDriverInfo
*bdi
);
215 ImageInfoSpecific
*(*bdrv_get_specific_info
)(BlockDriverState
*bs
);
217 int (*bdrv_save_vmstate
)(BlockDriverState
*bs
, QEMUIOVector
*qiov
,
219 int (*bdrv_load_vmstate
)(BlockDriverState
*bs
, uint8_t *buf
,
220 int64_t pos
, int size
);
222 int (*bdrv_change_backing_file
)(BlockDriverState
*bs
,
223 const char *backing_file
, const char *backing_fmt
);
225 /* removable device specific */
226 bool (*bdrv_is_inserted
)(BlockDriverState
*bs
);
227 int (*bdrv_media_changed
)(BlockDriverState
*bs
);
228 void (*bdrv_eject
)(BlockDriverState
*bs
, bool eject_flag
);
229 void (*bdrv_lock_medium
)(BlockDriverState
*bs
, bool locked
);
231 /* to control generic scsi devices */
232 BlockAIOCB
*(*bdrv_aio_ioctl
)(BlockDriverState
*bs
,
233 unsigned long int req
, void *buf
,
234 BlockCompletionFunc
*cb
, void *opaque
);
236 /* List of options for creating images, terminated by name == NULL */
237 QemuOptsList
*create_opts
;
240 * Returns 0 for completed check, -errno for internal errors.
241 * The check results are stored in result.
243 int (*bdrv_check
)(BlockDriverState
* bs
, BdrvCheckResult
*result
,
246 int (*bdrv_amend_options
)(BlockDriverState
*bs
, QemuOpts
*opts
,
247 BlockDriverAmendStatusCB
*status_cb
,
250 void (*bdrv_debug_event
)(BlockDriverState
*bs
, BlkdebugEvent event
);
252 /* TODO Better pass a option string/QDict/QemuOpts to add any rule? */
253 int (*bdrv_debug_breakpoint
)(BlockDriverState
*bs
, const char *event
,
255 int (*bdrv_debug_remove_breakpoint
)(BlockDriverState
*bs
,
257 int (*bdrv_debug_resume
)(BlockDriverState
*bs
, const char *tag
);
258 bool (*bdrv_debug_is_suspended
)(BlockDriverState
*bs
, const char *tag
);
260 void (*bdrv_refresh_limits
)(BlockDriverState
*bs
, Error
**errp
);
263 * Returns 1 if newly created images are guaranteed to contain only
264 * zeros, 0 otherwise.
266 int (*bdrv_has_zero_init
)(BlockDriverState
*bs
);
268 /* Remove fd handlers, timers, and other event loop callbacks so the event
269 * loop is no longer in use. Called with no in-flight requests and in
270 * depth-first traversal order with parents before child nodes.
272 void (*bdrv_detach_aio_context
)(BlockDriverState
*bs
);
274 /* Add fd handlers, timers, and other event loop callbacks so I/O requests
275 * can be processed again. Called with no in-flight requests and in
276 * depth-first traversal order with child nodes before parent nodes.
278 void (*bdrv_attach_aio_context
)(BlockDriverState
*bs
,
279 AioContext
*new_context
);
281 /* io queue for linux-aio */
282 void (*bdrv_io_plug
)(BlockDriverState
*bs
);
283 void (*bdrv_io_unplug
)(BlockDriverState
*bs
);
284 void (*bdrv_flush_io_queue
)(BlockDriverState
*bs
);
287 * Try to get @bs's logical and physical block size.
288 * On success, store them in @bsz and return zero.
289 * On failure, return negative errno.
291 int (*bdrv_probe_blocksizes
)(BlockDriverState
*bs
, BlockSizes
*bsz
);
293 * Try to get @bs's geometry (cyls, heads, sectors)
294 * On success, store them in @geo and return 0.
295 * On failure return -errno.
296 * Only drivers that want to override guest geometry implement this
297 * callback; see hd_geometry_guess().
299 int (*bdrv_probe_geometry
)(BlockDriverState
*bs
, HDGeometry
*geo
);
302 * Drain and stop any internal sources of requests in the driver, and
303 * remain so until next I/O callback (e.g. bdrv_co_writev) is called.
305 void (*bdrv_drain
)(BlockDriverState
*bs
);
307 QLIST_ENTRY(BlockDriver
) list
;
310 typedef struct BlockLimits
{
311 /* maximum number of sectors that can be discarded at once */
314 /* optimal alignment for discard requests in sectors */
315 int64_t discard_alignment
;
317 /* maximum number of sectors that can zeroized at once */
318 int max_write_zeroes
;
320 /* optimal alignment for write zeroes requests in sectors */
321 int64_t write_zeroes_alignment
;
323 /* optimal transfer length in sectors */
324 int opt_transfer_length
;
326 /* maximal transfer length in sectors */
327 int max_transfer_length
;
329 /* memory alignment so that no bounce buffer is needed */
330 size_t min_mem_alignment
;
332 /* memory alignment for bounce buffer */
333 size_t opt_mem_alignment
;
335 /* maximum number of iovec elements */
339 typedef struct BdrvOpBlocker BdrvOpBlocker
;
341 typedef struct BdrvAioNotifier
{
342 void (*attached_aio_context
)(AioContext
*new_context
, void *opaque
);
343 void (*detach_aio_context
)(void *opaque
);
347 QLIST_ENTRY(BdrvAioNotifier
) list
;
350 struct BdrvChildRole
{
351 void (*inherit_options
)(int *child_flags
, QDict
*child_options
,
352 int parent_flags
, QDict
*parent_options
);
355 extern const BdrvChildRole child_file
;
356 extern const BdrvChildRole child_format
;
359 BlockDriverState
*bs
;
361 const BdrvChildRole
*role
;
362 QLIST_ENTRY(BdrvChild
) next
;
363 QLIST_ENTRY(BdrvChild
) next_parent
;
367 * Note: the function bdrv_append() copies and swaps contents of
368 * BlockDriverStates, so if you add new fields to this struct, please
369 * inspect bdrv_append() to determine if the new fields need to be
372 struct BlockDriverState
{
373 int64_t total_sectors
; /* if we are reading a disk image, give its
375 int read_only
; /* if true, the media is read only */
376 int open_flags
; /* flags used to open the file, re-used for re-open */
377 int encrypted
; /* if true, the media is encrypted */
378 int valid_key
; /* if true, a valid encryption key has been set */
379 int sg
; /* if true, the device is a /dev/sg* */
380 int copy_on_read
; /* if true, copy read backing sectors into image
381 note this is a reference count */
384 BlockDriver
*drv
; /* NULL means no media */
387 BlockBackend
*blk
; /* owning backend, if any */
389 AioContext
*aio_context
; /* event loop used for fd handlers, timers, etc */
390 /* long-running tasks intended to always use the same AioContext as this
391 * BDS may register themselves in this list to be notified of changes
392 * regarding this BDS's context */
393 QLIST_HEAD(, BdrvAioNotifier
) aio_notifiers
;
395 char filename
[PATH_MAX
];
396 char backing_file
[PATH_MAX
]; /* if non zero, the image is a diff of
398 char backing_format
[16]; /* if non-zero and backing_file exists */
400 QDict
*full_open_options
;
401 char exact_filename
[PATH_MAX
];
406 /* Callback before write request is processed */
407 NotifierWithReturnList before_write_notifiers
;
409 /* number of in-flight serialising requests */
410 unsigned int serialising_in_flight
;
413 * throttle_state tells us if this BDS has I/O limits configured.
414 * io_limits_enabled tells us if they are currently being
415 * enforced, but it can be temporarily set to false */
416 CoQueue throttled_reqs
[2];
417 bool io_limits_enabled
;
418 /* The following fields are protected by the ThrottleGroup lock.
419 * See the ThrottleGroup documentation for details. */
420 ThrottleState
*throttle_state
;
421 ThrottleTimers throttle_timers
;
422 unsigned pending_reqs
[2];
423 QLIST_ENTRY(BlockDriverState
) round_robin
;
425 /* Offset after the highest byte written to */
426 uint64_t wr_highest_offset
;
431 /* Whether produces zeros when read beyond eof */
432 bool zero_beyond_eof
;
434 /* Alignment requirement for offset/length of I/O requests */
435 unsigned int request_alignment
;
437 /* do we need to tell the quest if we have a volatile write cache? */
438 int enable_write_cache
;
440 /* the following member gives a name to every node on the bs graph. */
442 /* element of the list of named nodes building the graph */
443 QTAILQ_ENTRY(BlockDriverState
) node_list
;
444 /* element of the list of "drives" the guest sees */
445 QTAILQ_ENTRY(BlockDriverState
) device_list
;
446 QLIST_HEAD(, BdrvDirtyBitmap
) dirty_bitmaps
;
449 QLIST_HEAD(, BdrvTrackedRequest
) tracked_requests
;
451 /* operation blockers */
452 QLIST_HEAD(, BdrvOpBlocker
) op_blockers
[BLOCK_OP_TYPE_MAX
];
454 /* long-running background operation */
457 /* The node that this node inherited default options from (and a reopen on
458 * which can affect this node by changing these defaults). This is always a
459 * parent node of this node. */
460 BlockDriverState
*inherits_from
;
461 QLIST_HEAD(, BdrvChild
) children
;
462 QLIST_HEAD(, BdrvChild
) parents
;
465 QDict
*explicit_options
;
466 BlockdevDetectZeroesOptions detect_zeroes
;
468 /* The error object in use for blocking operations on backing_hd */
469 Error
*backing_blocker
;
471 /* threshold limit for writes, in bytes. "High water mark". */
472 uint64_t write_threshold_offset
;
473 NotifierWithReturn write_threshold_notifier
;
478 struct BlockBackendRootState
{
481 BlockdevDetectZeroesOptions detect_zeroes
;
483 char *throttle_group
;
484 ThrottleState
*throttle_state
;
487 static inline BlockDriverState
*backing_bs(BlockDriverState
*bs
)
489 return bs
->backing
? bs
->backing
->bs
: NULL
;
493 /* Essential block drivers which must always be statically linked into qemu, and
494 * which therefore can be accessed without using bdrv_find_format() */
495 extern BlockDriver bdrv_file
;
496 extern BlockDriver bdrv_raw
;
497 extern BlockDriver bdrv_qcow2
;
499 extern QTAILQ_HEAD(BdrvStates
, BlockDriverState
) bdrv_states
;
502 * bdrv_setup_io_funcs:
504 * Prepare a #BlockDriver for I/O request processing by populating
505 * unimplemented coroutine and AIO interfaces with generic wrapper functions
506 * that fall back to implemented interfaces.
508 void bdrv_setup_io_funcs(BlockDriver
*bdrv
);
510 int get_tmp_filename(char *filename
, int size
);
511 BlockDriver
*bdrv_probe_all(const uint8_t *buf
, int buf_size
,
512 const char *filename
);
514 void bdrv_set_io_limits(BlockDriverState
*bs
,
515 ThrottleConfig
*cfg
);
519 * bdrv_add_before_write_notifier:
521 * Register a callback that is invoked before write requests are processed but
522 * after any throttling or waiting for overlapping requests.
524 void bdrv_add_before_write_notifier(BlockDriverState
*bs
,
525 NotifierWithReturn
*notifier
);
528 * bdrv_detach_aio_context:
530 * May be called from .bdrv_detach_aio_context() to detach children from the
531 * current #AioContext. This is only needed by block drivers that manage their
532 * own children. Both ->file and ->backing are automatically handled and
533 * block drivers should not call this function on them explicitly.
535 void bdrv_detach_aio_context(BlockDriverState
*bs
);
538 * bdrv_attach_aio_context:
540 * May be called from .bdrv_attach_aio_context() to attach children to the new
541 * #AioContext. This is only needed by block drivers that manage their own
542 * children. Both ->file and ->backing are automatically handled and block
543 * drivers should not call this function on them explicitly.
545 void bdrv_attach_aio_context(BlockDriverState
*bs
,
546 AioContext
*new_context
);
549 * bdrv_add_aio_context_notifier:
551 * If a long-running job intends to be always run in the same AioContext as a
552 * certain BDS, it may use this function to be notified of changes regarding the
553 * association of the BDS to an AioContext.
555 * attached_aio_context() is called after the target BDS has been attached to a
556 * new AioContext; detach_aio_context() is called before the target BDS is being
557 * detached from its old AioContext.
559 void bdrv_add_aio_context_notifier(BlockDriverState
*bs
,
560 void (*attached_aio_context
)(AioContext
*new_context
, void *opaque
),
561 void (*detach_aio_context
)(void *opaque
), void *opaque
);
564 * bdrv_remove_aio_context_notifier:
566 * Unsubscribe of change notifications regarding the BDS's AioContext. The
567 * parameters given here have to be the same as those given to
568 * bdrv_add_aio_context_notifier().
570 void bdrv_remove_aio_context_notifier(BlockDriverState
*bs
,
571 void (*aio_context_attached
)(AioContext
*,
573 void (*aio_context_detached
)(void *),
577 int is_windows_drive(const char *filename
);
582 * @bs: Block device to operate on.
583 * @base: Block device that will become the new base, or %NULL to
584 * flatten the whole backing file chain onto @bs.
585 * @base_id: The file name that will be written to @bs as the new
586 * backing file if the job completes. Ignored if @base is %NULL.
587 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
588 * @on_error: The action to take upon error.
589 * @cb: Completion function for the job.
590 * @opaque: Opaque pointer value passed to @cb.
591 * @errp: Error object.
593 * Start a streaming operation on @bs. Clusters that are unallocated
594 * in @bs, but allocated in any image between @base and @bs (both
595 * exclusive) will be written to @bs. At the end of a successful
596 * streaming job, the backing file of @bs will be changed to
597 * @base_id in the written image and to @base in the live BlockDriverState.
599 void stream_start(BlockDriverState
*bs
, BlockDriverState
*base
,
600 const char *base_id
, int64_t speed
, BlockdevOnError on_error
,
601 BlockCompletionFunc
*cb
,
602 void *opaque
, Error
**errp
);
606 * @bs: Active block device.
607 * @top: Top block device to be committed.
608 * @base: Block device that will be written into, and become the new top.
609 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
610 * @on_error: The action to take upon error.
611 * @cb: Completion function for the job.
612 * @opaque: Opaque pointer value passed to @cb.
613 * @backing_file_str: String to use as the backing file in @top's overlay
614 * @errp: Error object.
617 void commit_start(BlockDriverState
*bs
, BlockDriverState
*base
,
618 BlockDriverState
*top
, int64_t speed
,
619 BlockdevOnError on_error
, BlockCompletionFunc
*cb
,
620 void *opaque
, const char *backing_file_str
, Error
**errp
);
622 * commit_active_start:
623 * @bs: Active block device to be committed.
624 * @base: Block device that will be written into, and become the new top.
625 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
626 * @on_error: The action to take upon error.
627 * @cb: Completion function for the job.
628 * @opaque: Opaque pointer value passed to @cb.
629 * @errp: Error object.
632 void commit_active_start(BlockDriverState
*bs
, BlockDriverState
*base
,
634 BlockdevOnError on_error
,
635 BlockCompletionFunc
*cb
,
636 void *opaque
, Error
**errp
);
639 * @bs: Block device to operate on.
640 * @target: Block device to write to.
641 * @replaces: Block graph node name to replace once the mirror is done. Can
642 * only be used when full mirroring is selected.
643 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
644 * @granularity: The chosen granularity for the dirty bitmap.
645 * @buf_size: The amount of data that can be in flight at one time.
646 * @mode: Whether to collapse all images in the chain to the target.
647 * @on_source_error: The action to take upon error reading from the source.
648 * @on_target_error: The action to take upon error writing to the target.
649 * @unmap: Whether to unmap target where source sectors only contain zeroes.
650 * @cb: Completion function for the job.
651 * @opaque: Opaque pointer value passed to @cb.
652 * @errp: Error object.
654 * Start a mirroring operation on @bs. Clusters that are allocated
655 * in @bs will be written to @bs until the job is cancelled or
656 * manually completed. At the end of a successful mirroring job,
657 * @bs will be switched to read from @target.
659 void mirror_start(BlockDriverState
*bs
, BlockDriverState
*target
,
660 const char *replaces
,
661 int64_t speed
, uint32_t granularity
, int64_t buf_size
,
662 MirrorSyncMode mode
, BlockdevOnError on_source_error
,
663 BlockdevOnError on_target_error
,
665 BlockCompletionFunc
*cb
,
666 void *opaque
, Error
**errp
);
670 * @bs: Block device to operate on.
671 * @target: Block device to write to.
672 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
673 * @sync_mode: What parts of the disk image should be copied to the destination.
674 * @sync_bitmap: The dirty bitmap if sync_mode is MIRROR_SYNC_MODE_INCREMENTAL.
675 * @on_source_error: The action to take upon error reading from the source.
676 * @on_target_error: The action to take upon error writing to the target.
677 * @cb: Completion function for the job.
678 * @opaque: Opaque pointer value passed to @cb.
679 * @txn: Transaction that this job is part of (may be NULL).
681 * Start a backup operation on @bs. Clusters in @bs are written to @target
682 * until the job is cancelled or manually completed.
684 void backup_start(BlockDriverState
*bs
, BlockDriverState
*target
,
685 int64_t speed
, MirrorSyncMode sync_mode
,
686 BdrvDirtyBitmap
*sync_bitmap
,
687 BlockdevOnError on_source_error
,
688 BlockdevOnError on_target_error
,
689 BlockCompletionFunc
*cb
, void *opaque
,
690 BlockJobTxn
*txn
, Error
**errp
);
692 void blk_set_bs(BlockBackend
*blk
, BlockDriverState
*bs
);
694 void blk_dev_change_media_cb(BlockBackend
*blk
, bool load
);
695 bool blk_dev_has_removable_media(BlockBackend
*blk
);
696 bool blk_dev_has_tray(BlockBackend
*blk
);
697 void blk_dev_eject_request(BlockBackend
*blk
, bool force
);
698 bool blk_dev_is_tray_open(BlockBackend
*blk
);
699 bool blk_dev_is_medium_locked(BlockBackend
*blk
);
700 void blk_dev_resize_cb(BlockBackend
*blk
);
702 void bdrv_set_dirty(BlockDriverState
*bs
, int64_t cur_sector
, int nr_sectors
);
703 bool bdrv_requests_pending(BlockDriverState
*bs
);
705 void bdrv_clear_dirty_bitmap(BdrvDirtyBitmap
*bitmap
, HBitmap
**out
);
706 void bdrv_undo_clear_dirty_bitmap(BdrvDirtyBitmap
*bitmap
, HBitmap
*in
);
708 #endif /* BLOCK_INT_H */