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.h"
  28 #include "qemu-option.h"
  29 #include "qemu-queue.h"
  30 #include "qemu-coroutine.h"
  31 #include "qemu-timer.h"
  32 #include "qapi-types.h"
  33 #include "qerror.h"
  34
  35 #define BLOCK_FLAG_ENCRYPT          1
  36 #define BLOCK_FLAG_COMPAT6          4
  37 #define BLOCK_FLAG_LAZY_REFCOUNTS   8
  38
  39 #define BLOCK_IO_LIMIT_READ     0
  40 #define BLOCK_IO_LIMIT_WRITE    1
  41 #define BLOCK_IO_LIMIT_TOTAL    2
  42
  43 #define BLOCK_IO_SLICE_TIME     100000000
  44 #define NANOSECONDS_PER_SECOND  1000000000.0
  45
  46 #define BLOCK_OPT_SIZE              "size"
  47 #define BLOCK_OPT_ENCRYPT           "encryption"
  48 #define BLOCK_OPT_COMPAT6           "compat6"
  49 #define BLOCK_OPT_BACKING_FILE      "backing_file"
  50 #define BLOCK_OPT_BACKING_FMT       "backing_fmt"
  51 #define BLOCK_OPT_CLUSTER_SIZE      "cluster_size"
  52 #define BLOCK_OPT_TABLE_SIZE        "table_size"
  53 #define BLOCK_OPT_PREALLOC          "preallocation"
  54 #define BLOCK_OPT_SUBFMT            "subformat"
  55 #define BLOCK_OPT_COMPAT_LEVEL      "compat"
  56 #define BLOCK_OPT_LAZY_REFCOUNTS    "lazy_refcounts"
  57
  58 typedef struct BdrvTrackedRequest BdrvTrackedRequest;
  59
  60 typedef struct BlockIOLimit {
  61     int64_t bps[3];
  62     int64_t iops[3];
  63 } BlockIOLimit;
  64
  65 typedef struct BlockIOBaseValue {
  66     uint64_t bytes[2];
  67     uint64_t ios[2];
  68 } BlockIOBaseValue;
  69
  70 typedef struct BlockJob BlockJob;
  71
  72 /**
  73  * BlockJobType:
  74  *
  75  * A class type for block job objects.
  76  */
  77 typedef struct BlockJobType {
  78     /** Derived BlockJob struct size */
  79     size_t instance_size;
  80
  81     /** String describing the operation, part of query-block-jobs QMP API */
  82     const char *job_type;
  83
  84     /** Optional callback for job types that support setting a speed limit */
  85     void (*set_speed)(BlockJob *job, int64_t speed, Error **errp);
  86 } BlockJobType;
  87
  88 /**
  89  * BlockJob:
  90  *
  91  * Long-running operation on a BlockDriverState.
  92  */
  93 struct BlockJob {
  94     /** The job type, including the job vtable.  */
  95     const BlockJobType *job_type;
  96
  97     /** The block device on which the job is operating.  */
  98     BlockDriverState *bs;
  99
 100     /**
 101      * The coroutine that executes the job.  If not NULL, it is
 102      * reentered when busy is false and the job is cancelled.
 103      */
 104     Coroutine *co;
 105
 106     /**
 107      * Set to true if the job should cancel itself.  The flag must
 108      * always be tested just before toggling the busy flag from false
 109      * to true.  After a job has been cancelled, it should only yield
 110      * if #qemu_aio_wait will ("sooner or later") reenter the coroutine.
 111      */
 112     bool cancelled;
 113
 114     /**
 115      * Set to false by the job while it is in a quiescent state, where
 116      * no I/O is pending and the job has yielded on any condition
 117      * that is not detected by #qemu_aio_wait, such as a timer.
 118      */
 119     bool busy;
 120
 121     /** Offset that is published by the query-block-jobs QMP API */
 122     int64_t offset;
 123
 124     /** Length that is published by the query-block-jobs QMP API */
 125     int64_t len;
 126
 127     /** Speed that was set with @block_job_set_speed.  */
 128     int64_t speed;
 129
 130     /** The completion function that will be called when the job completes.  */
 131     BlockDriverCompletionFunc *cb;
 132
 133     /** The opaque value that is passed to the completion function.  */
 134     void *opaque;
 135 };
 136
 137 struct BlockDriver {
 138     const char *format_name;
 139     int instance_size;
 140     int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
 141     int (*bdrv_probe_device)(const char *filename);
 142     int (*bdrv_open)(BlockDriverState *bs, int flags);
 143     int (*bdrv_file_open)(BlockDriverState *bs, const char *filename, int flags);
 144     int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
 145                      uint8_t *buf, int nb_sectors);
 146     int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
 147                       const uint8_t *buf, int nb_sectors);
 148     void (*bdrv_close)(BlockDriverState *bs);
 149     void (*bdrv_rebind)(BlockDriverState *bs);
 150     int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
 151     int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
 152     int (*bdrv_make_empty)(BlockDriverState *bs);
 153     /* aio */
 154     BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
 155         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
 156         BlockDriverCompletionFunc *cb, void *opaque);
 157     BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
 158         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
 159         BlockDriverCompletionFunc *cb, void *opaque);
 160     BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
 161         BlockDriverCompletionFunc *cb, void *opaque);
 162     BlockDriverAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs,
 163         int64_t sector_num, int nb_sectors,
 164         BlockDriverCompletionFunc *cb, void *opaque);
 165
 166     int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs,
 167         int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
 168     int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs,
 169         int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
 170     /*
 171      * Efficiently zero a region of the disk image.  Typically an image format
 172      * would use a compact metadata representation to implement this.  This
 173      * function pointer may be NULL and .bdrv_co_writev() will be called
 174      * instead.
 175      */
 176     int coroutine_fn (*bdrv_co_write_zeroes)(BlockDriverState *bs,
 177         int64_t sector_num, int nb_sectors);
 178     int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs,
 179         int64_t sector_num, int nb_sectors);
 180     int coroutine_fn (*bdrv_co_is_allocated)(BlockDriverState *bs,
 181         int64_t sector_num, int nb_sectors, int *pnum);
 182
 183     /*
 184      * Invalidate any cached meta-data.
 185      */
 186     void (*bdrv_invalidate_cache)(BlockDriverState *bs);
 187
 188     /*
 189      * Flushes all data that was already written to the OS all the way down to
 190      * the disk (for example raw-posix calls fsync()).
 191      */
 192     int coroutine_fn (*bdrv_co_flush_to_disk)(BlockDriverState *bs);
 193
 194     /*
 195      * Flushes all internal caches to the OS. The data may still sit in a
 196      * writeback cache of the host OS, but it will survive a crash of the qemu
 197      * process.
 198      */
 199     int coroutine_fn (*bdrv_co_flush_to_os)(BlockDriverState *bs);
 200
 201     const char *protocol_name;
 202     int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
 203     int64_t (*bdrv_getlength)(BlockDriverState *bs);
 204     int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs);
 205     int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
 206                                  const uint8_t *buf, int nb_sectors);
 207
 208     int (*bdrv_snapshot_create)(BlockDriverState *bs,
 209                                 QEMUSnapshotInfo *sn_info);
 210     int (*bdrv_snapshot_goto)(BlockDriverState *bs,
 211                               const char *snapshot_id);
 212     int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
 213     int (*bdrv_snapshot_list)(BlockDriverState *bs,
 214                               QEMUSnapshotInfo **psn_info);
 215     int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
 216                                   const char *snapshot_name);
 217     int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
 218
 219     int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf,
 220                              int64_t pos, int size);
 221     int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
 222                              int64_t pos, int size);
 223
 224     int (*bdrv_change_backing_file)(BlockDriverState *bs,
 225         const char *backing_file, const char *backing_fmt);
 226
 227     /* removable device specific */
 228     int (*bdrv_is_inserted)(BlockDriverState *bs);
 229     int (*bdrv_media_changed)(BlockDriverState *bs);
 230     void (*bdrv_eject)(BlockDriverState *bs, bool eject_flag);
 231     void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked);
 232
 233     /* to control generic scsi devices */
 234     int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
 235     BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
 236         unsigned long int req, void *buf,
 237         BlockDriverCompletionFunc *cb, void *opaque);
 238
 239     /* List of options for creating images, terminated by name == NULL */
 240     QEMUOptionParameter *create_options;
 241
 242
 243     /*
 244      * Returns 0 for completed check, -errno for internal errors.
 245      * The check results are stored in result.
 246      */
 247     int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result,
 248         BdrvCheckMode fix);
 249
 250     void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);
 251
 252     /*
 253      * Returns 1 if newly created images are guaranteed to contain only
 254      * zeros, 0 otherwise.
 255      */
 256     int (*bdrv_has_zero_init)(BlockDriverState *bs);
 257
 258     QLIST_ENTRY(BlockDriver) list;
 259 };
 260
 261 /*
 262  * Note: the function bdrv_append() copies and swaps contents of
 263  * BlockDriverStates, so if you add new fields to this struct, please
 264  * inspect bdrv_append() to determine if the new fields need to be
 265  * copied as well.
 266  */
 267 struct BlockDriverState {
 268     int64_t total_sectors; /* if we are reading a disk image, give its
 269                               size in sectors */
 270     int read_only; /* if true, the media is read only */
 271     int keep_read_only; /* if true, the media was requested to stay read only */
 272     int open_flags; /* flags used to open the file, re-used for re-open */
 273     int encrypted; /* if true, the media is encrypted */
 274     int valid_key; /* if true, a valid encryption key has been set */
 275     int sg;        /* if true, the device is a /dev/sg* */
 276     int copy_on_read; /* if true, copy read backing sectors into image
 277                          note this is a reference count */
 278
 279     BlockDriver *drv; /* NULL means no media */
 280     void *opaque;
 281
 282     void *dev;                  /* attached device model, if any */
 283     /* TODO change to DeviceState when all users are qdevified */
 284     const BlockDevOps *dev_ops;
 285     void *dev_opaque;
 286
 287     char filename[1024];
 288     char backing_file[1024]; /* if non zero, the image is a diff of
 289                                 this file image */
 290     char backing_format[16]; /* if non-zero and backing_file exists */
 291     int is_temporary;
 292
 293     BlockDriverState *backing_hd;
 294     BlockDriverState *file;
 295
 296     /* number of in-flight copy-on-read requests */
 297     unsigned int copy_on_read_in_flight;
 298
 299     /* the time for latest disk I/O */
 300     int64_t slice_time;
 301     int64_t slice_start;
 302     int64_t slice_end;
 303     BlockIOLimit io_limits;
 304     BlockIOBaseValue  io_base;
 305     CoQueue      throttled_reqs;
 306     QEMUTimer    *block_timer;
 307     bool         io_limits_enabled;
 308
 309     /* I/O stats (display with "info blockstats"). */
 310     uint64_t nr_bytes[BDRV_MAX_IOTYPE];
 311     uint64_t nr_ops[BDRV_MAX_IOTYPE];
 312     uint64_t total_time_ns[BDRV_MAX_IOTYPE];
 313     uint64_t wr_highest_sector;
 314
 315     /* Whether the disk can expand beyond total_sectors */
 316     int growable;
 317
 318     /* the memory alignment required for the buffers handled by this driver */
 319     int buffer_alignment;
 320
 321     /* do we need to tell the quest if we have a volatile write cache? */
 322     int enable_write_cache;
 323
 324     /* NOTE: the following infos are only hints for real hardware
 325        drivers. They are not used by the block driver */
 326     BlockErrorAction on_read_error, on_write_error;
 327     bool iostatus_enabled;
 328     BlockDeviceIoStatus iostatus;
 329     char device_name[32];
 330     unsigned long *dirty_bitmap;
 331     int64_t dirty_count;
 332     int in_use; /* users other than guest access, eg. block migration */
 333     QTAILQ_ENTRY(BlockDriverState) list;
 334
 335     QLIST_HEAD(, BdrvTrackedRequest) tracked_requests;
 336
 337     /* long-running background operation */
 338     BlockJob *job;
 339 };
 340
 341 int get_tmp_filename(char *filename, int size);
 342
 343 void bdrv_set_io_limits(BlockDriverState *bs,
 344                         BlockIOLimit *io_limits);
 345
 346 #ifdef _WIN32
 347 int is_windows_drive(const char *filename);
 348 #endif
 349
 350 /**
 351  * block_job_create:
 352  * @job_type: The class object for the newly-created job.
 353  * @bs: The block
 354  * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
 355  * @cb: Completion function for the job.
 356  * @opaque: Opaque pointer value passed to @cb.
 357  * @errp: Error object.
 358  *
 359  * Create a new long-running block device job and return it.  The job
 360  * will call @cb asynchronously when the job completes.  Note that
 361  * @bs may have been closed at the time the @cb it is called.  If
 362  * this is the case, the job may be reported as either cancelled or
 363  * completed.
 364  *
 365  * This function is not part of the public job interface; it should be
 366  * called from a wrapper that is specific to the job type.
 367  */
 368 void *block_job_create(const BlockJobType *job_type, BlockDriverState *bs,
 369                        int64_t speed, BlockDriverCompletionFunc *cb,
 370                        void *opaque, Error **errp);
 371
 372 /**
 373  * block_job_sleep_ns:
 374  * @job: The job that calls the function.
 375  * @clock: The clock to sleep on.
 376  * @ns: How many nanoseconds to stop for.
 377  *
 378  * Put the job to sleep (assuming that it wasn't canceled) for @ns
 379  * nanoseconds.  Canceling the job will interrupt the wait immediately.
 380  */
 381 void block_job_sleep_ns(BlockJob *job, QEMUClock *clock, int64_t ns);
 382
 383 /**
 384  * block_job_complete:
 385  * @job: The job being completed.
 386  * @ret: The status code.
 387  *
 388  * Call the completion function that was registered at creation time, and
 389  * free @job.
 390  */
 391 void block_job_complete(BlockJob *job, int ret);
 392
 393 /**
 394  * block_job_set_speed:
 395  * @job: The job to set the speed for.
 396  * @speed: The new value
 397  * @errp: Error object.
 398  *
 399  * Set a rate-limiting parameter for the job; the actual meaning may
 400  * vary depending on the job type.
 401  */
 402 void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp);
 403
 404 /**
 405  * block_job_cancel:
 406  * @job: The job to be canceled.
 407  *
 408  * Asynchronously cancel the specified job.
 409  */
 410 void block_job_cancel(BlockJob *job);
 411
 412 /**
 413  * block_job_is_cancelled:
 414  * @job: The job being queried.
 415  *
 416  * Returns whether the job is scheduled for cancellation.
 417  */
 418 bool block_job_is_cancelled(BlockJob *job);
 419
 420 /**
 421  * block_job_cancel:
 422  * @job: The job to be canceled.
 423  *
 424  * Asynchronously cancel the job and wait for it to reach a quiescent
 425  * state.  Note that the completion callback will still be called
 426  * asynchronously, hence it is *not* valid to call #bdrv_delete
 427  * immediately after #block_job_cancel_sync.  Users of block jobs
 428  * will usually protect the BlockDriverState objects with a reference
 429  * count, should this be a concern.
 430  *
 431  * Returns the return value from the job if the job actually completed
 432  * during the call, or -ECANCELED if it was canceled.
 433  */
 434 int block_job_cancel_sync(BlockJob *job);
 435
 436 /**
 437  * stream_start:
 438  * @bs: Block device to operate on.
 439  * @base: Block device that will become the new base, or %NULL to
 440  * flatten the whole backing file chain onto @bs.
 441  * @base_id: The file name that will be written to @bs as the new
 442  * backing file if the job completes.  Ignored if @base is %NULL.
 443  * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
 444  * @cb: Completion function for the job.
 445  * @opaque: Opaque pointer value passed to @cb.
 446  * @errp: Error object.
 447  *
 448  * Start a streaming operation on @bs.  Clusters that are unallocated
 449  * in @bs, but allocated in any image between @base and @bs (both
 450  * exclusive) will be written to @bs.  At the end of a successful
 451  * streaming job, the backing file of @bs will be changed to
 452  * @base_id in the written image and to @base in the live BlockDriverState.
 453  */
 454 void stream_start(BlockDriverState *bs, BlockDriverState *base,
 455                   const char *base_id, int64_t speed,
 456                   BlockDriverCompletionFunc *cb,
 457                   void *opaque, Error **errp);
 458
 459 #endif /* BLOCK_INT_H */