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
  33 #define BLOCK_FLAG_ENCRYPT      1
  34 #define BLOCK_FLAG_COMPAT6      4
  35
  36 #define BLOCK_OPT_SIZE          "size"
  37 #define BLOCK_OPT_ENCRYPT       "encryption"
  38 #define BLOCK_OPT_COMPAT6       "compat6"
  39 #define BLOCK_OPT_BACKING_FILE  "backing_file"
  40 #define BLOCK_OPT_BACKING_FMT   "backing_fmt"
  41 #define BLOCK_OPT_CLUSTER_SIZE  "cluster_size"
  42 #define BLOCK_OPT_TABLE_SIZE    "table_size"
  43 #define BLOCK_OPT_PREALLOC      "preallocation"
  44 #define BLOCK_OPT_SUBFMT        "subformat"
  45
  46 typedef struct AIOPool {
  47     void (*cancel)(BlockDriverAIOCB *acb);
  48     int aiocb_size;
  49     BlockDriverAIOCB *free_aiocb;
  50 } AIOPool;
  51
  52 struct BlockDriver {
  53     const char *format_name;
  54     int instance_size;
  55     int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
  56     int (*bdrv_probe_device)(const char *filename);
  57     int (*bdrv_open)(BlockDriverState *bs, int flags);
  58     int (*bdrv_file_open)(BlockDriverState *bs, const char *filename, int flags);
  59     int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
  60                      uint8_t *buf, int nb_sectors);
  61     int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
  62                       const uint8_t *buf, int nb_sectors);
  63     void (*bdrv_close)(BlockDriverState *bs);
  64     int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
  65     int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num,
  66                              int nb_sectors, int *pnum);
  67     int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
  68     int (*bdrv_make_empty)(BlockDriverState *bs);
  69     /* aio */
  70     BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
  71         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
  72         BlockDriverCompletionFunc *cb, void *opaque);
  73     BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
  74         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
  75         BlockDriverCompletionFunc *cb, void *opaque);
  76     BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
  77         BlockDriverCompletionFunc *cb, void *opaque);
  78     BlockDriverAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs,
  79         int64_t sector_num, int nb_sectors,
  80         BlockDriverCompletionFunc *cb, void *opaque);
  81
  82     int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs,
  83         int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
  84     int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs,
  85         int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
  86     int coroutine_fn (*bdrv_co_flush)(BlockDriverState *bs);
  87     int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs,
  88         int64_t sector_num, int nb_sectors);
  89
  90     int (*bdrv_aio_multiwrite)(BlockDriverState *bs, BlockRequest *reqs,
  91         int num_reqs);
  92     int (*bdrv_merge_requests)(BlockDriverState *bs, BlockRequest* a,
  93         BlockRequest *b);
  94
  95
  96     const char *protocol_name;
  97     int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
  98     int64_t (*bdrv_getlength)(BlockDriverState *bs);
  99     int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs);
 100     int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
 101                                  const uint8_t *buf, int nb_sectors);
 102
 103     int (*bdrv_snapshot_create)(BlockDriverState *bs,
 104                                 QEMUSnapshotInfo *sn_info);
 105     int (*bdrv_snapshot_goto)(BlockDriverState *bs,
 106                               const char *snapshot_id);
 107     int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
 108     int (*bdrv_snapshot_list)(BlockDriverState *bs,
 109                               QEMUSnapshotInfo **psn_info);
 110     int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
 111                                   const char *snapshot_name);
 112     int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
 113
 114     int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf,
 115                              int64_t pos, int size);
 116     int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
 117                              int64_t pos, int size);
 118
 119     int (*bdrv_change_backing_file)(BlockDriverState *bs,
 120         const char *backing_file, const char *backing_fmt);
 121
 122     /* removable device specific */
 123     int (*bdrv_is_inserted)(BlockDriverState *bs);
 124     int (*bdrv_media_changed)(BlockDriverState *bs);
 125     void (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
 126     void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked);
 127
 128     /* to control generic scsi devices */
 129     int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
 130     BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
 131         unsigned long int req, void *buf,
 132         BlockDriverCompletionFunc *cb, void *opaque);
 133
 134     /* List of options for creating images, terminated by name == NULL */
 135     QEMUOptionParameter *create_options;
 136
 137
 138     /*
 139      * Returns 0 for completed check, -errno for internal errors.
 140      * The check results are stored in result.
 141      */
 142     int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result);
 143
 144     void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);
 145
 146     /*
 147      * Returns 1 if newly created images are guaranteed to contain only
 148      * zeros, 0 otherwise.
 149      */
 150     int (*bdrv_has_zero_init)(BlockDriverState *bs);
 151
 152     QLIST_ENTRY(BlockDriver) list;
 153 };
 154
 155 struct BlockDriverState {
 156     int64_t total_sectors; /* if we are reading a disk image, give its
 157                               size in sectors */
 158     int read_only; /* if true, the media is read only */
 159     int keep_read_only; /* if true, the media was requested to stay read only */
 160     int open_flags; /* flags used to open the file, re-used for re-open */
 161     int encrypted; /* if true, the media is encrypted */
 162     int valid_key; /* if true, a valid encryption key has been set */
 163     int sg;        /* if true, the device is a /dev/sg* */
 164
 165     BlockDriver *drv; /* NULL means no media */
 166     void *opaque;
 167
 168     void *dev;                  /* attached device model, if any */
 169     /* TODO change to DeviceState when all users are qdevified */
 170     const BlockDevOps *dev_ops;
 171     void *dev_opaque;
 172
 173     char filename[1024];
 174     char backing_file[1024]; /* if non zero, the image is a diff of
 175                                 this file image */
 176     char backing_format[16]; /* if non-zero and backing_file exists */
 177     int is_temporary;
 178
 179     BlockDriverState *backing_hd;
 180     BlockDriverState *file;
 181
 182     /* async read/write emulation */
 183
 184     void *sync_aiocb;
 185
 186     /* I/O stats (display with "info blockstats"). */
 187     uint64_t nr_bytes[BDRV_MAX_IOTYPE];
 188     uint64_t nr_ops[BDRV_MAX_IOTYPE];
 189     uint64_t total_time_ns[BDRV_MAX_IOTYPE];
 190     uint64_t wr_highest_sector;
 191
 192     /* Whether the disk can expand beyond total_sectors */
 193     int growable;
 194
 195     /* the memory alignment required for the buffers handled by this driver */
 196     int buffer_alignment;
 197
 198     /* do we need to tell the quest if we have a volatile write cache? */
 199     int enable_write_cache;
 200
 201     /* NOTE: the following infos are only hints for real hardware
 202        drivers. They are not used by the block driver */
 203     int cyls, heads, secs, translation;
 204     BlockErrorAction on_read_error, on_write_error;
 205     BlockIOStatus iostatus;
 206     char device_name[32];
 207     unsigned long *dirty_bitmap;
 208     int64_t dirty_count;
 209     int in_use; /* users other than guest access, eg. block migration */
 210     QTAILQ_ENTRY(BlockDriverState) list;
 211     void *private;
 212 };
 213
 214 struct BlockDriverAIOCB {
 215     AIOPool *pool;
 216     BlockDriverState *bs;
 217     BlockDriverCompletionFunc *cb;
 218     void *opaque;
 219     BlockDriverAIOCB *next;
 220 };
 221
 222 void get_tmp_filename(char *filename, int size);
 223
 224 void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
 225                    BlockDriverCompletionFunc *cb, void *opaque);
 226 void qemu_aio_release(void *p);
 227
 228 #ifdef _WIN32
 229 int is_windows_drive(const char *filename);
 230 #endif
 231
 232 #endif /* BLOCK_INT_H */