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
  34 #define BLOCK_FLAG_ENCRYPT      1
  35 #define BLOCK_FLAG_COMPAT6      4
  36
  37 #define BLOCK_IO_LIMIT_READ     0
  38 #define BLOCK_IO_LIMIT_WRITE    1
  39 #define BLOCK_IO_LIMIT_TOTAL    2
  40
  41 #define BLOCK_IO_SLICE_TIME     100000000
  42 #define NANOSECONDS_PER_SECOND  1000000000.0
  43
  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
  54 typedef struct BdrvTrackedRequest BdrvTrackedRequest;
  55
  56 typedef struct AIOPool {
  57     void (*cancel)(BlockDriverAIOCB *acb);
  58     int aiocb_size;
  59     BlockDriverAIOCB *free_aiocb;
  60 } AIOPool;
  61
  62 typedef struct BlockIOLimit {
  63     int64_t bps[3];
  64     int64_t iops[3];
  65 } BlockIOLimit;
  66
  67 typedef struct BlockIOBaseValue {
  68     uint64_t bytes[2];
  69     uint64_t ios[2];
  70 } BlockIOBaseValue;
  71
  72 typedef void BlockJobCancelFunc(void *opaque);
  73 typedef struct BlockJob BlockJob;
  74 typedef struct BlockJobType {
  75     /** Derived BlockJob struct size */
  76     size_t instance_size;
  77
  78     /** String describing the operation, part of query-block-jobs QMP API */
  79     const char *job_type;
  80
  81     /** Optional callback for job types that support setting a speed limit */
  82     int (*set_speed)(BlockJob *job, int64_t value);
  83 } BlockJobType;
  84
  85 /**
  86  * Long-running operation on a BlockDriverState
  87  */
  88 struct BlockJob {
  89     const BlockJobType *job_type;
  90     BlockDriverState *bs;
  91     bool cancelled;
  92
  93     /* These fields are published by the query-block-jobs QMP API */
  94     int64_t offset;
  95     int64_t len;
  96     int64_t speed;
  97
  98     BlockDriverCompletionFunc *cb;
  99     void *opaque;
 100 };
 101
 102 struct BlockDriver {
 103     const char *format_name;
 104     int instance_size;
 105     int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
 106     int (*bdrv_probe_device)(const char *filename);
 107     int (*bdrv_open)(BlockDriverState *bs, int flags);
 108     int (*bdrv_file_open)(BlockDriverState *bs, const char *filename, int flags);
 109     int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
 110                      uint8_t *buf, int nb_sectors);
 111     int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
 112                       const uint8_t *buf, int nb_sectors);
 113     void (*bdrv_close)(BlockDriverState *bs);
 114     int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
 115     int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
 116     int (*bdrv_make_empty)(BlockDriverState *bs);
 117     /* aio */
 118     BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
 119         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
 120         BlockDriverCompletionFunc *cb, void *opaque);
 121     BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
 122         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
 123         BlockDriverCompletionFunc *cb, void *opaque);
 124     BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
 125         BlockDriverCompletionFunc *cb, void *opaque);
 126     BlockDriverAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs,
 127         int64_t sector_num, int nb_sectors,
 128         BlockDriverCompletionFunc *cb, void *opaque);
 129
 130     int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs,
 131         int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
 132     int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs,
 133         int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
 134     /*
 135      * Efficiently zero a region of the disk image.  Typically an image format
 136      * would use a compact metadata representation to implement this.  This
 137      * function pointer may be NULL and .bdrv_co_writev() will be called
 138      * instead.
 139      */
 140     int coroutine_fn (*bdrv_co_write_zeroes)(BlockDriverState *bs,
 141         int64_t sector_num, int nb_sectors);
 142     int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs,
 143         int64_t sector_num, int nb_sectors);
 144     int coroutine_fn (*bdrv_co_is_allocated)(BlockDriverState *bs,
 145         int64_t sector_num, int nb_sectors, int *pnum);
 146
 147     /*
 148      * Invalidate any cached meta-data.
 149      */
 150     void (*bdrv_invalidate_cache)(BlockDriverState *bs);
 151
 152     /*
 153      * Flushes all data that was already written to the OS all the way down to
 154      * the disk (for example raw-posix calls fsync()).
 155      */
 156     int coroutine_fn (*bdrv_co_flush_to_disk)(BlockDriverState *bs);
 157
 158     /*
 159      * Flushes all internal caches to the OS. The data may still sit in a
 160      * writeback cache of the host OS, but it will survive a crash of the qemu
 161      * process.
 162      */
 163     int coroutine_fn (*bdrv_co_flush_to_os)(BlockDriverState *bs);
 164
 165     const char *protocol_name;
 166     int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
 167     int64_t (*bdrv_getlength)(BlockDriverState *bs);
 168     int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs);
 169     int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
 170                                  const uint8_t *buf, int nb_sectors);
 171
 172     int (*bdrv_snapshot_create)(BlockDriverState *bs,
 173                                 QEMUSnapshotInfo *sn_info);
 174     int (*bdrv_snapshot_goto)(BlockDriverState *bs,
 175                               const char *snapshot_id);
 176     int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
 177     int (*bdrv_snapshot_list)(BlockDriverState *bs,
 178                               QEMUSnapshotInfo **psn_info);
 179     int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
 180                                   const char *snapshot_name);
 181     int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
 182
 183     int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf,
 184                              int64_t pos, int size);
 185     int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
 186                              int64_t pos, int size);
 187
 188     int (*bdrv_change_backing_file)(BlockDriverState *bs,
 189         const char *backing_file, const char *backing_fmt);
 190
 191     /* removable device specific */
 192     int (*bdrv_is_inserted)(BlockDriverState *bs);
 193     int (*bdrv_media_changed)(BlockDriverState *bs);
 194     void (*bdrv_eject)(BlockDriverState *bs, bool eject_flag);
 195     void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked);
 196
 197     /* to control generic scsi devices */
 198     int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
 199     BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
 200         unsigned long int req, void *buf,
 201         BlockDriverCompletionFunc *cb, void *opaque);
 202
 203     /* List of options for creating images, terminated by name == NULL */
 204     QEMUOptionParameter *create_options;
 205
 206
 207     /*
 208      * Returns 0 for completed check, -errno for internal errors.
 209      * The check results are stored in result.
 210      */
 211     int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result);
 212
 213     void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);
 214
 215     /*
 216      * Returns 1 if newly created images are guaranteed to contain only
 217      * zeros, 0 otherwise.
 218      */
 219     int (*bdrv_has_zero_init)(BlockDriverState *bs);
 220
 221     QLIST_ENTRY(BlockDriver) list;
 222 };
 223
 224 /*
 225  * Note: the function bdrv_append() copies and swaps contents of
 226  * BlockDriverStates, so if you add new fields to this struct, please
 227  * inspect bdrv_append() to determine if the new fields need to be
 228  * copied as well.
 229  */
 230 struct BlockDriverState {
 231     int64_t total_sectors; /* if we are reading a disk image, give its
 232                               size in sectors */
 233     int read_only; /* if true, the media is read only */
 234     int keep_read_only; /* if true, the media was requested to stay read only */
 235     int open_flags; /* flags used to open the file, re-used for re-open */
 236     int encrypted; /* if true, the media is encrypted */
 237     int valid_key; /* if true, a valid encryption key has been set */
 238     int sg;        /* if true, the device is a /dev/sg* */
 239     int copy_on_read; /* if true, copy read backing sectors into image
 240                          note this is a reference count */
 241
 242     BlockDriver *drv; /* NULL means no media */
 243     void *opaque;
 244
 245     void *dev;                  /* attached device model, if any */
 246     /* TODO change to DeviceState when all users are qdevified */
 247     const BlockDevOps *dev_ops;
 248     void *dev_opaque;
 249
 250     char filename[1024];
 251     char backing_file[1024]; /* if non zero, the image is a diff of
 252                                 this file image */
 253     char backing_format[16]; /* if non-zero and backing_file exists */
 254     int is_temporary;
 255
 256     BlockDriverState *backing_hd;
 257     BlockDriverState *file;
 258
 259     /* number of in-flight copy-on-read requests */
 260     unsigned int copy_on_read_in_flight;
 261
 262     /* the time for latest disk I/O */
 263     int64_t slice_time;
 264     int64_t slice_start;
 265     int64_t slice_end;
 266     BlockIOLimit io_limits;
 267     BlockIOBaseValue  io_base;
 268     CoQueue      throttled_reqs;
 269     QEMUTimer    *block_timer;
 270     bool         io_limits_enabled;
 271
 272     /* I/O stats (display with "info blockstats"). */
 273     uint64_t nr_bytes[BDRV_MAX_IOTYPE];
 274     uint64_t nr_ops[BDRV_MAX_IOTYPE];
 275     uint64_t total_time_ns[BDRV_MAX_IOTYPE];
 276     uint64_t wr_highest_sector;
 277
 278     /* Whether the disk can expand beyond total_sectors */
 279     int growable;
 280
 281     /* the memory alignment required for the buffers handled by this driver */
 282     int buffer_alignment;
 283
 284     /* do we need to tell the quest if we have a volatile write cache? */
 285     int enable_write_cache;
 286
 287     /* NOTE: the following infos are only hints for real hardware
 288        drivers. They are not used by the block driver */
 289     int cyls, heads, secs, translation;
 290     BlockErrorAction on_read_error, on_write_error;
 291     bool iostatus_enabled;
 292     BlockDeviceIoStatus iostatus;
 293     char device_name[32];
 294     unsigned long *dirty_bitmap;
 295     int64_t dirty_count;
 296     int in_use; /* users other than guest access, eg. block migration */
 297     QTAILQ_ENTRY(BlockDriverState) list;
 298
 299     QLIST_HEAD(, BdrvTrackedRequest) tracked_requests;
 300
 301     /* long-running background operation */
 302     BlockJob *job;
 303 };
 304
 305 struct BlockDriverAIOCB {
 306     AIOPool *pool;
 307     BlockDriverState *bs;
 308     BlockDriverCompletionFunc *cb;
 309     void *opaque;
 310     BlockDriverAIOCB *next;
 311 };
 312
 313 void get_tmp_filename(char *filename, int size);
 314
 315 void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
 316                    BlockDriverCompletionFunc *cb, void *opaque);
 317 void qemu_aio_release(void *p);
 318
 319 void bdrv_set_io_limits(BlockDriverState *bs,
 320                         BlockIOLimit *io_limits);
 321
 322 #ifdef _WIN32
 323 int is_windows_drive(const char *filename);
 324 #endif
 325
 326 void *block_job_create(const BlockJobType *job_type, BlockDriverState *bs,
 327                        BlockDriverCompletionFunc *cb, void *opaque);
 328 void block_job_complete(BlockJob *job, int ret);
 329 int block_job_set_speed(BlockJob *job, int64_t value);
 330 void block_job_cancel(BlockJob *job);
 331 bool block_job_is_cancelled(BlockJob *job);
 332
 333 int stream_start(BlockDriverState *bs, BlockDriverState *base,
 334                  const char *base_id, BlockDriverCompletionFunc *cb,
 335                  void *opaque);
 336
 337 #endif /* BLOCK_INT_H */