include/block/block_int.h

   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 struct BdrvChildRole {
 334     int (*inherit_flags)(int parent_flags);
 335 };
 336
 337 extern const BdrvChildRole child_file;
 338 extern const BdrvChildRole child_format;
 339
 340 typedef struct BdrvChild {
 341     BlockDriverState *bs;
 342     const BdrvChildRole *role;
 343     QLIST_ENTRY(BdrvChild) next;
 344 } BdrvChild;
 345
 346 /*
 347  * Note: the function bdrv_append() copies and swaps contents of
 348  * BlockDriverStates, so if you add new fields to this struct, please
 349  * inspect bdrv_append() to determine if the new fields need to be
 350  * copied as well.
 351  */
 352 struct BlockDriverState {
 353     int64_t total_sectors; /* if we are reading a disk image, give its
 354                               size in sectors */
 355     int read_only; /* if true, the media is read only */
 356     int open_flags; /* flags used to open the file, re-used for re-open */
 357     int encrypted; /* if true, the media is encrypted */
 358     int valid_key; /* if true, a valid encryption key has been set */
 359     int sg;        /* if true, the device is a /dev/sg* */
 360     int copy_on_read; /* if true, copy read backing sectors into image
 361                          note this is a reference count */
 362     bool probed;
 363
 364     BlockDriver *drv; /* NULL means no media */
 365     void *opaque;
 366
 367     BlockBackend *blk;          /* owning backend, if any */
 368
 369     AioContext *aio_context; /* event loop used for fd handlers, timers, etc */
 370     /* long-running tasks intended to always use the same AioContext as this
 371      * BDS may register themselves in this list to be notified of changes
 372      * regarding this BDS's context */
 373     QLIST_HEAD(, BdrvAioNotifier) aio_notifiers;
 374
 375     char filename[PATH_MAX];
 376     char backing_file[PATH_MAX]; /* if non zero, the image is a diff of
 377                                     this file image */
 378     char backing_format[16]; /* if non-zero and backing_file exists */
 379
 380     QDict *full_open_options;
 381     char exact_filename[PATH_MAX];
 382
 383     BlockDriverState *backing_hd;
 384     BlockDriverState *file;
 385
 386     NotifierList close_notifiers;
 387
 388     /* Callback before write request is processed */
 389     NotifierWithReturnList before_write_notifiers;
 390
 391     /* number of in-flight serialising requests */
 392     unsigned int serialising_in_flight;
 393
 394     /* I/O throttling */
 395     ThrottleState throttle_state;
 396     CoQueue      throttled_reqs[2];
 397     bool         io_limits_enabled;
 398
 399     /* I/O stats (display with "info blockstats"). */
 400     BlockAcctStats stats;
 401
 402     /* I/O Limits */
 403     BlockLimits bl;
 404
 405     /* Whether produces zeros when read beyond eof */
 406     bool zero_beyond_eof;
 407
 408     /* Alignment requirement for offset/length of I/O requests */
 409     unsigned int request_alignment;
 410
 411     /* the block size for which the guest device expects atomicity */
 412     int guest_block_size;
 413
 414     /* do we need to tell the quest if we have a volatile write cache? */
 415     int enable_write_cache;
 416
 417     /* NOTE: the following infos are only hints for real hardware
 418        drivers. They are not used by the block driver */
 419     BlockdevOnError on_read_error, on_write_error;
 420     bool iostatus_enabled;
 421     BlockDeviceIoStatus iostatus;
 422
 423     /* the following member gives a name to every node on the bs graph. */
 424     char node_name[32];
 425     /* element of the list of named nodes building the graph */
 426     QTAILQ_ENTRY(BlockDriverState) node_list;
 427     /* element of the list of "drives" the guest sees */
 428     QTAILQ_ENTRY(BlockDriverState) device_list;
 429     QLIST_HEAD(, BdrvDirtyBitmap) dirty_bitmaps;
 430     int refcnt;
 431
 432     QLIST_HEAD(, BdrvTrackedRequest) tracked_requests;
 433
 434     /* operation blockers */
 435     QLIST_HEAD(, BdrvOpBlocker) op_blockers[BLOCK_OP_TYPE_MAX];
 436
 437     /* long-running background operation */
 438     BlockJob *job;
 439
 440     /* The node that this node inherited default options from (and a reopen on
 441      * which can affect this node by changing these defaults). This is always a
 442      * parent node of this node. */
 443     BlockDriverState *inherits_from;
 444     QLIST_HEAD(, BdrvChild) children;
 445
 446     QDict *options;
 447     BlockdevDetectZeroesOptions detect_zeroes;
 448
 449     /* The error object in use for blocking operations on backing_hd */
 450     Error *backing_blocker;
 451
 452     /* threshold limit for writes, in bytes. "High water mark". */
 453     uint64_t write_threshold_offset;
 454     NotifierWithReturn write_threshold_notifier;
 455 };
 456
 457
 458 /* Essential block drivers which must always be statically linked into qemu, and
 459  * which therefore can be accessed without using bdrv_find_format() */
 460 extern BlockDriver bdrv_file;
 461 extern BlockDriver bdrv_raw;
 462 extern BlockDriver bdrv_qcow2;
 463
 464 /**
 465  * bdrv_setup_io_funcs:
 466  *
 467  * Prepare a #BlockDriver for I/O request processing by populating
 468  * unimplemented coroutine and AIO interfaces with generic wrapper functions
 469  * that fall back to implemented interfaces.
 470  */
 471 void bdrv_setup_io_funcs(BlockDriver *bdrv);
 472
 473 int get_tmp_filename(char *filename, int size);
 474 BlockDriver *bdrv_probe_all(const uint8_t *buf, int buf_size,
 475                             const char *filename);
 476
 477 void bdrv_set_io_limits(BlockDriverState *bs,
 478                         ThrottleConfig *cfg);
 479
 480
 481 /**
 482  * bdrv_add_before_write_notifier:
 483  *
 484  * Register a callback that is invoked before write requests are processed but
 485  * after any throttling or waiting for overlapping requests.
 486  */
 487 void bdrv_add_before_write_notifier(BlockDriverState *bs,
 488                                     NotifierWithReturn *notifier);
 489
 490 /**
 491  * bdrv_detach_aio_context:
 492  *
 493  * May be called from .bdrv_detach_aio_context() to detach children from the
 494  * current #AioContext.  This is only needed by block drivers that manage their
 495  * own children.  Both ->file and ->backing_hd are automatically handled and
 496  * block drivers should not call this function on them explicitly.
 497  */
 498 void bdrv_detach_aio_context(BlockDriverState *bs);
 499
 500 /**
 501  * bdrv_attach_aio_context:
 502  *
 503  * May be called from .bdrv_attach_aio_context() to attach children to the new
 504  * #AioContext.  This is only needed by block drivers that manage their own
 505  * children.  Both ->file and ->backing_hd are automatically handled and block
 506  * drivers should not call this function on them explicitly.
 507  */
 508 void bdrv_attach_aio_context(BlockDriverState *bs,
 509                              AioContext *new_context);
 510
 511 /**
 512  * bdrv_add_aio_context_notifier:
 513  *
 514  * If a long-running job intends to be always run in the same AioContext as a
 515  * certain BDS, it may use this function to be notified of changes regarding the
 516  * association of the BDS to an AioContext.
 517  *
 518  * attached_aio_context() is called after the target BDS has been attached to a
 519  * new AioContext; detach_aio_context() is called before the target BDS is being
 520  * detached from its old AioContext.
 521  */
 522 void bdrv_add_aio_context_notifier(BlockDriverState *bs,
 523         void (*attached_aio_context)(AioContext *new_context, void *opaque),
 524         void (*detach_aio_context)(void *opaque), void *opaque);
 525
 526 /**
 527  * bdrv_remove_aio_context_notifier:
 528  *
 529  * Unsubscribe of change notifications regarding the BDS's AioContext. The
 530  * parameters given here have to be the same as those given to
 531  * bdrv_add_aio_context_notifier().
 532  */
 533 void bdrv_remove_aio_context_notifier(BlockDriverState *bs,
 534                                       void (*aio_context_attached)(AioContext *,
 535                                                                    void *),
 536                                       void (*aio_context_detached)(void *),
 537                                       void *opaque);
 538
 539 #ifdef _WIN32
 540 int is_windows_drive(const char *filename);
 541 #endif
 542
 543 /**
 544  * stream_start:
 545  * @bs: Block device to operate on.
 546  * @base: Block device that will become the new base, or %NULL to
 547  * flatten the whole backing file chain onto @bs.
 548  * @base_id: The file name that will be written to @bs as the new
 549  * backing file if the job completes.  Ignored if @base is %NULL.
 550  * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
 551  * @on_error: The action to take upon error.
 552  * @cb: Completion function for the job.
 553  * @opaque: Opaque pointer value passed to @cb.
 554  * @errp: Error object.
 555  *
 556  * Start a streaming operation on @bs.  Clusters that are unallocated
 557  * in @bs, but allocated in any image between @base and @bs (both
 558  * exclusive) will be written to @bs.  At the end of a successful
 559  * streaming job, the backing file of @bs will be changed to
 560  * @base_id in the written image and to @base in the live BlockDriverState.
 561  */
 562 void stream_start(BlockDriverState *bs, BlockDriverState *base,
 563                   const char *base_id, int64_t speed, BlockdevOnError on_error,
 564                   BlockCompletionFunc *cb,
 565                   void *opaque, Error **errp);
 566
 567 /**
 568  * commit_start:
 569  * @bs: Active block device.
 570  * @top: Top block device to be committed.
 571  * @base: Block device that will be written into, and become the new top.
 572  * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
 573  * @on_error: The action to take upon error.
 574  * @cb: Completion function for the job.
 575  * @opaque: Opaque pointer value passed to @cb.
 576  * @backing_file_str: String to use as the backing file in @top's overlay
 577  * @errp: Error object.
 578  *
 579  */
 580 void commit_start(BlockDriverState *bs, BlockDriverState *base,
 581                  BlockDriverState *top, int64_t speed,
 582                  BlockdevOnError on_error, BlockCompletionFunc *cb,
 583                  void *opaque, const char *backing_file_str, Error **errp);
 584 /**
 585  * commit_active_start:
 586  * @bs: Active block device to be committed.
 587  * @base: Block device that will be written into, and become the new top.
 588  * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
 589  * @on_error: The action to take upon error.
 590  * @cb: Completion function for the job.
 591  * @opaque: Opaque pointer value passed to @cb.
 592  * @errp: Error object.
 593  *
 594  */
 595 void commit_active_start(BlockDriverState *bs, BlockDriverState *base,
 596                          int64_t speed,
 597                          BlockdevOnError on_error,
 598                          BlockCompletionFunc *cb,
 599                          void *opaque, Error **errp);
 600 /*
 601  * mirror_start:
 602  * @bs: Block device to operate on.
 603  * @target: Block device to write to.
 604  * @replaces: Block graph node name to replace once the mirror is done. Can
 605  *            only be used when full mirroring is selected.
 606  * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
 607  * @granularity: The chosen granularity for the dirty bitmap.
 608  * @buf_size: The amount of data that can be in flight at one time.
 609  * @mode: Whether to collapse all images in the chain to the target.
 610  * @on_source_error: The action to take upon error reading from the source.
 611  * @on_target_error: The action to take upon error writing to the target.
 612  * @cb: Completion function for the job.
 613  * @opaque: Opaque pointer value passed to @cb.
 614  * @errp: Error object.
 615  *
 616  * Start a mirroring operation on @bs.  Clusters that are allocated
 617  * in @bs will be written to @bs until the job is cancelled or
 618  * manually completed.  At the end of a successful mirroring job,
 619  * @bs will be switched to read from @target.
 620  */
 621 void mirror_start(BlockDriverState *bs, BlockDriverState *target,
 622                   const char *replaces,
 623                   int64_t speed, uint32_t granularity, int64_t buf_size,
 624                   MirrorSyncMode mode, BlockdevOnError on_source_error,
 625                   BlockdevOnError on_target_error,
 626                   BlockCompletionFunc *cb,
 627                   void *opaque, Error **errp);
 628
 629 /*
 630  * backup_start:
 631  * @bs: Block device to operate on.
 632  * @target: Block device to write to.
 633  * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
 634  * @sync_mode: What parts of the disk image should be copied to the destination.
 635  * @sync_bitmap: The dirty bitmap if sync_mode is MIRROR_SYNC_MODE_DIRTY_BITMAP.
 636  * @on_source_error: The action to take upon error reading from the source.
 637  * @on_target_error: The action to take upon error writing to the target.
 638  * @cb: Completion function for the job.
 639  * @opaque: Opaque pointer value passed to @cb.
 640  *
 641  * Start a backup operation on @bs.  Clusters in @bs are written to @target
 642  * until the job is cancelled or manually completed.
 643  */
 644 void backup_start(BlockDriverState *bs, BlockDriverState *target,
 645                   int64_t speed, MirrorSyncMode sync_mode,
 646                   BdrvDirtyBitmap *sync_bitmap,
 647                   BlockdevOnError on_source_error,
 648                   BlockdevOnError on_target_error,
 649                   BlockCompletionFunc *cb, void *opaque,
 650                   Error **errp);
 651
 652 void blk_dev_change_media_cb(BlockBackend *blk, bool load);
 653 bool blk_dev_has_removable_media(BlockBackend *blk);
 654 void blk_dev_eject_request(BlockBackend *blk, bool force);
 655 bool blk_dev_is_tray_open(BlockBackend *blk);
 656 bool blk_dev_is_medium_locked(BlockBackend *blk);
 657 void blk_dev_resize_cb(BlockBackend *blk);
 658
 659 void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
 660 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
 661                       int nr_sectors);
 662
 663 #endif /* BLOCK_INT_H */