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_flush)(BlockDriverState *bs);
  66     int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num,
  67                              int nb_sectors, int *pnum);
  68     int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
  69     int (*bdrv_make_empty)(BlockDriverState *bs);
  70     /* aio */
  71     BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
  72         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
  73         BlockDriverCompletionFunc *cb, void *opaque);
  74     BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
  75         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
  76         BlockDriverCompletionFunc *cb, void *opaque);
  77     BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
  78         BlockDriverCompletionFunc *cb, void *opaque);
  79     int (*bdrv_discard)(BlockDriverState *bs, int64_t sector_num,
  80                         int nb_sectors);
  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
  87     int (*bdrv_aio_multiwrite)(BlockDriverState *bs, BlockRequest *reqs,
  88         int num_reqs);
  89     int (*bdrv_merge_requests)(BlockDriverState *bs, BlockRequest* a,
  90         BlockRequest *b);
  91
  92
  93     const char *protocol_name;
  94     int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
  95     int64_t (*bdrv_getlength)(BlockDriverState *bs);
  96     int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs);
  97     int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
  98                                  const uint8_t *buf, int nb_sectors);
  99
 100     int (*bdrv_snapshot_create)(BlockDriverState *bs,
 101                                 QEMUSnapshotInfo *sn_info);
 102     int (*bdrv_snapshot_goto)(BlockDriverState *bs,
 103                               const char *snapshot_id);
 104     int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
 105     int (*bdrv_snapshot_list)(BlockDriverState *bs,
 106                               QEMUSnapshotInfo **psn_info);
 107     int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
 108                                   const char *snapshot_name);
 109     int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
 110
 111     int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf,
 112                              int64_t pos, int size);
 113     int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
 114                              int64_t pos, int size);
 115
 116     int (*bdrv_change_backing_file)(BlockDriverState *bs,
 117         const char *backing_file, const char *backing_fmt);
 118
 119     /* removable device specific */
 120     int (*bdrv_is_inserted)(BlockDriverState *bs);
 121     int (*bdrv_media_changed)(BlockDriverState *bs);
 122     void (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
 123     void (*bdrv_set_locked)(BlockDriverState *bs, int locked);
 124
 125     /* to control generic scsi devices */
 126     int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
 127     BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
 128         unsigned long int req, void *buf,
 129         BlockDriverCompletionFunc *cb, void *opaque);
 130
 131     /* List of options for creating images, terminated by name == NULL */
 132     QEMUOptionParameter *create_options;
 133
 134
 135     /*
 136      * Returns 0 for completed check, -errno for internal errors.
 137      * The check results are stored in result.
 138      */
 139     int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result);
 140
 141     void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);
 142
 143     /*
 144      * Returns 1 if newly created images are guaranteed to contain only
 145      * zeros, 0 otherwise.
 146      */
 147     int (*bdrv_has_zero_init)(BlockDriverState *bs);
 148
 149     QLIST_ENTRY(BlockDriver) list;
 150 };
 151
 152 struct BlockDriverState {
 153     int64_t total_sectors; /* if we are reading a disk image, give its
 154                               size in sectors */
 155     int read_only; /* if true, the media is read only */
 156     int keep_read_only; /* if true, the media was requested to stay read only */
 157     int open_flags; /* flags used to open the file, re-used for re-open */
 158     int removable; /* if true, the media can be removed */
 159     int locked;    /* if true, the media cannot temporarily be ejected */
 160     int tray_open; /* if true, the virtual tray is 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     /* event callback when inserting/removing */
 165     void (*change_cb)(void *opaque, int reason);
 166     void *change_opaque;
 167
 168     BlockDriver *drv; /* NULL means no media */
 169     void *opaque;
 170
 171     DeviceState *peer;
 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     int media_changed;
 179
 180     BlockDriverState *backing_hd;
 181     BlockDriverState *file;
 182
 183     /* async read/write emulation */
 184
 185     void *sync_aiocb;
 186
 187     /* I/O stats (display with "info blockstats"). */
 188     uint64_t nr_bytes[BDRV_MAX_IOTYPE];
 189     uint64_t nr_ops[BDRV_MAX_IOTYPE];
 190     uint64_t total_time_ns[BDRV_MAX_IOTYPE];
 191     uint64_t wr_highest_sector;
 192
 193     /* Whether the disk can expand beyond total_sectors */
 194     int growable;
 195
 196     /* the memory alignment required for the buffers handled by this driver */
 197     int buffer_alignment;
 198
 199     /* do we need to tell the quest if we have a volatile write cache? */
 200     int enable_write_cache;
 201
 202     /* NOTE: the following infos are only hints for real hardware
 203        drivers. They are not used by the block driver */
 204     int cyls, heads, secs, translation;
 205     BlockErrorAction on_read_error, on_write_error;
 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 #define CHANGE_MEDIA    0x01
 215 #define CHANGE_SIZE     0x02
 216
 217 struct BlockDriverAIOCB {
 218     AIOPool *pool;
 219     BlockDriverState *bs;
 220     BlockDriverCompletionFunc *cb;
 221     void *opaque;
 222     BlockDriverAIOCB *next;
 223 };
 224
 225 void get_tmp_filename(char *filename, int size);
 226
 227 void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
 228                    BlockDriverCompletionFunc *cb, void *opaque);
 229 void qemu_aio_release(void *p);
 230
 231 void *qemu_blockalign(BlockDriverState *bs, size_t size);
 232
 233 #ifdef _WIN32
 234 int is_windows_drive(const char *filename);
 235 #endif
 236
 237 typedef struct BlockConf {
 238     BlockDriverState *bs;
 239     uint16_t physical_block_size;
 240     uint16_t logical_block_size;
 241     uint16_t min_io_size;
 242     uint32_t opt_io_size;
 243     int32_t bootindex;
 244     uint32_t discard_granularity;
 245 } BlockConf;
 246
 247 static inline unsigned int get_physical_block_exp(BlockConf *conf)
 248 {
 249     unsigned int exp = 0, size;
 250
 251     for (size = conf->physical_block_size;
 252         size > conf->logical_block_size;
 253         size >>= 1) {
 254         exp++;
 255     }
 256
 257     return exp;
 258 }
 259
 260 #define DEFINE_BLOCK_PROPERTIES(_state, _conf)                          \
 261     DEFINE_PROP_DRIVE("drive", _state, _conf.bs),                       \
 262     DEFINE_PROP_UINT16("logical_block_size", _state,                    \
 263                        _conf.logical_block_size, 512),                  \
 264     DEFINE_PROP_UINT16("physical_block_size", _state,                   \
 265                        _conf.physical_block_size, 512),                 \
 266     DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0),  \
 267     DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0),    \
 268     DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1),        \
 269     DEFINE_PROP_UINT32("discard_granularity", _state, \
 270                        _conf.discard_granularity, 0)
 271
 272 #endif /* BLOCK_INT_H */