block_int.h 10.5 KB
Newer Older
B
bellard 已提交
1 2
/*
 * QEMU System Emulator block driver
3
 *
B
bellard 已提交
4
 * Copyright (c) 2003 Fabrice Bellard
5
 *
B
bellard 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef BLOCK_INT_H
#define BLOCK_INT_H

P
pbrook 已提交
27
#include "block.h"
28
#include "qemu-option.h"
29
#include "qemu-queue.h"
K
Kevin Wolf 已提交
30
#include "qemu-coroutine.h"
C
Christoph Hellwig 已提交
31
#include "qemu-timer.h"
L
Luiz Capitulino 已提交
32
#include "qapi-types.h"
P
pbrook 已提交
33

34 35 36
#define BLOCK_FLAG_ENCRYPT	1
#define BLOCK_FLAG_COMPAT6	4

37 38 39 40 41
#define BLOCK_IO_LIMIT_READ     0
#define BLOCK_IO_LIMIT_WRITE    1
#define BLOCK_IO_LIMIT_TOTAL    2

#define BLOCK_IO_SLICE_TIME     100000000
Z
Zhi Yong Wu 已提交
42
#define NANOSECONDS_PER_SECOND  1000000000.0
43

44 45 46 47 48
#define BLOCK_OPT_SIZE          "size"
#define BLOCK_OPT_ENCRYPT       "encryption"
#define BLOCK_OPT_COMPAT6       "compat6"
#define BLOCK_OPT_BACKING_FILE  "backing_file"
#define BLOCK_OPT_BACKING_FMT   "backing_fmt"
49
#define BLOCK_OPT_CLUSTER_SIZE  "cluster_size"
50
#define BLOCK_OPT_TABLE_SIZE    "table_size"
K
Kevin Wolf 已提交
51
#define BLOCK_OPT_PREALLOC      "preallocation"
F
Fam Zheng 已提交
52
#define BLOCK_OPT_SUBFMT        "subformat"
53

S
Stefan Hajnoczi 已提交
54 55
typedef struct BdrvTrackedRequest BdrvTrackedRequest;

56 57 58 59 60 61
typedef struct AIOPool {
    void (*cancel)(BlockDriverAIOCB *acb);
    int aiocb_size;
    BlockDriverAIOCB *free_aiocb;
} AIOPool;

62 63 64 65 66 67 68 69 70 71
typedef struct BlockIOLimit {
    int64_t bps[3];
    int64_t iops[3];
} BlockIOLimit;

typedef struct BlockIOBaseValue {
    uint64_t bytes[2];
    uint64_t ios[2];
} BlockIOBaseValue;

B
bellard 已提交
72 73 74 75
struct BlockDriver {
    const char *format_name;
    int instance_size;
    int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
76
    int (*bdrv_probe_device)(const char *filename);
77 78
    int (*bdrv_open)(BlockDriverState *bs, int flags);
    int (*bdrv_file_open)(BlockDriverState *bs, const char *filename, int flags);
79
    int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
80
                     uint8_t *buf, int nb_sectors);
81
    int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
82
                      const uint8_t *buf, int nb_sectors);
B
bellard 已提交
83
    void (*bdrv_close)(BlockDriverState *bs);
84
    int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
B
bellard 已提交
85
    int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
86
    int (*bdrv_make_empty)(BlockDriverState *bs);
B
bellard 已提交
87
    /* aio */
88 89
    BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
90
        BlockDriverCompletionFunc *cb, void *opaque);
91 92
    BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
93
        BlockDriverCompletionFunc *cb, void *opaque);
94 95
    BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
        BlockDriverCompletionFunc *cb, void *opaque);
96 97 98
    BlockDriverAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors,
        BlockDriverCompletionFunc *cb, void *opaque);
B
bellard 已提交
99

K
Kevin Wolf 已提交
100 101 102 103
    int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
    int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
104 105
    int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors);
106 107
    int coroutine_fn (*bdrv_co_is_allocated)(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors, int *pnum);
K
Kevin Wolf 已提交
108

109 110 111 112 113
    /*
     * Invalidate any cached meta-data.
     */
    void (*bdrv_invalidate_cache)(BlockDriverState *bs);

114 115 116 117 118 119
    /*
     * Flushes all data that was already written to the OS all the way down to
     * the disk (for example raw-posix calls fsync()).
     */
    int coroutine_fn (*bdrv_co_flush_to_disk)(BlockDriverState *bs);

K
Kevin Wolf 已提交
120 121 122 123 124 125 126
    /*
     * Flushes all internal caches to the OS. The data may still sit in a
     * writeback cache of the host OS, but it will survive a crash of the qemu
     * process.
     */
    int coroutine_fn (*bdrv_co_flush_to_os)(BlockDriverState *bs);

K
Kevin Wolf 已提交
127 128 129 130 131 132
    int (*bdrv_aio_multiwrite)(BlockDriverState *bs, BlockRequest *reqs,
        int num_reqs);
    int (*bdrv_merge_requests)(BlockDriverState *bs, BlockRequest* a,
        BlockRequest *b);


B
bellard 已提交
133 134 135
    const char *protocol_name;
    int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
    int64_t (*bdrv_getlength)(BlockDriverState *bs);
136
    int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs);
137
    int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
138 139
                                 const uint8_t *buf, int nb_sectors);

140
    int (*bdrv_snapshot_create)(BlockDriverState *bs,
B
bellard 已提交
141
                                QEMUSnapshotInfo *sn_info);
142
    int (*bdrv_snapshot_goto)(BlockDriverState *bs,
B
bellard 已提交
143 144
                              const char *snapshot_id);
    int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
145
    int (*bdrv_snapshot_list)(BlockDriverState *bs,
B
bellard 已提交
146
                              QEMUSnapshotInfo **psn_info);
E
edison 已提交
147 148
    int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
                                  const char *snapshot_name);
B
bellard 已提交
149
    int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
B
bellard 已提交
150

151 152 153 154
    int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf,
                             int64_t pos, int size);
    int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
                             int64_t pos, int size);
155

K
Kevin Wolf 已提交
156 157 158
    int (*bdrv_change_backing_file)(BlockDriverState *bs,
        const char *backing_file, const char *backing_fmt);

B
bellard 已提交
159 160 161
    /* removable device specific */
    int (*bdrv_is_inserted)(BlockDriverState *bs);
    int (*bdrv_media_changed)(BlockDriverState *bs);
162
    void (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
163
    void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked);
164

165 166
    /* to control generic scsi devices */
    int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
167 168 169
    BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
        unsigned long int req, void *buf,
        BlockDriverCompletionFunc *cb, void *opaque);
170

171 172 173
    /* List of options for creating images, terminated by name == NULL */
    QEMUOptionParameter *create_options;

174

175 176 177 178 179
    /*
     * Returns 0 for completed check, -errno for internal errors.
     * The check results are stored in result.
     */
    int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result);
A
aliguori 已提交
180

K
Kevin Wolf 已提交
181 182
    void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);

K
Kevin Wolf 已提交
183 184 185 186 187
    /*
     * Returns 1 if newly created images are guaranteed to contain only
     * zeros, 0 otherwise.
     */
    int (*bdrv_has_zero_init)(BlockDriverState *bs);
188

189
    QLIST_ENTRY(BlockDriver) list;
B
bellard 已提交
190 191 192
};

struct BlockDriverState {
193 194
    int64_t total_sectors; /* if we are reading a disk image, give its
                              size in sectors */
B
bellard 已提交
195
    int read_only; /* if true, the media is read only */
196 197
    int keep_read_only; /* if true, the media was requested to stay read only */
    int open_flags; /* flags used to open the file, re-used for re-open */
B
bellard 已提交
198
    int encrypted; /* if true, the media is encrypted */
199
    int valid_key; /* if true, a valid encryption key has been set */
200
    int sg;        /* if true, the device is a /dev/sg* */
201 202
    int copy_on_read; /* if true, copy read backing sectors into image
                         note this is a reference count */
B
bellard 已提交
203

B
bellard 已提交
204
    BlockDriver *drv; /* NULL means no media */
B
bellard 已提交
205 206
    void *opaque;

207 208
    void *dev;                  /* attached device model, if any */
    /* TODO change to DeviceState when all users are qdevified */
209 210
    const BlockDevOps *dev_ops;
    void *dev_opaque;
211

B
bellard 已提交
212 213 214
    char filename[1024];
    char backing_file[1024]; /* if non zero, the image is a diff of
                                this file image */
215
    char backing_format[16]; /* if non-zero and backing_file exists */
B
bellard 已提交
216
    int is_temporary;
B
bellard 已提交
217

B
bellard 已提交
218
    BlockDriverState *backing_hd;
219 220
    BlockDriverState *file;

221
    /* async read/write emulation */
B
bellard 已提交
222

223
    void *sync_aiocb;
224

225 226 227 228 229 230 231 232 233 234
    /* the time for latest disk I/O */
    int64_t slice_time;
    int64_t slice_start;
    int64_t slice_end;
    BlockIOLimit io_limits;
    BlockIOBaseValue  io_base;
    CoQueue      throttled_reqs;
    QEMUTimer    *block_timer;
    bool         io_limits_enabled;

235
    /* I/O stats (display with "info blockstats"). */
236 237
    uint64_t nr_bytes[BDRV_MAX_IOTYPE];
    uint64_t nr_ops[BDRV_MAX_IOTYPE];
C
Christoph Hellwig 已提交
238
    uint64_t total_time_ns[BDRV_MAX_IOTYPE];
239
    uint64_t wr_highest_sector;
240

241 242 243
    /* Whether the disk can expand beyond total_sectors */
    int growable;

244 245 246
    /* the memory alignment required for the buffers handled by this driver */
    int buffer_alignment;

247 248 249
    /* do we need to tell the quest if we have a volatile write cache? */
    int enable_write_cache;

B
bellard 已提交
250 251
    /* NOTE: the following infos are only hints for real hardware
       drivers. They are not used by the block driver */
B
bellard 已提交
252
    int cyls, heads, secs, translation;
253
    BlockErrorAction on_read_error, on_write_error;
254
    bool iostatus_enabled;
L
Luiz Capitulino 已提交
255
    BlockDeviceIoStatus iostatus;
B
bellard 已提交
256
    char device_name[32];
257
    unsigned long *dirty_bitmap;
258
    int64_t dirty_count;
259
    int in_use; /* users other than guest access, eg. block migration */
260
    QTAILQ_ENTRY(BlockDriverState) list;
261
    void *private;
S
Stefan Hajnoczi 已提交
262 263

    QLIST_HEAD(, BdrvTrackedRequest) tracked_requests;
B
bellard 已提交
264 265
};

B
bellard 已提交
266
struct BlockDriverAIOCB {
267
    AIOPool *pool;
B
bellard 已提交
268 269
    BlockDriverState *bs;
    BlockDriverCompletionFunc *cb;
270 271
    void *opaque;
    BlockDriverAIOCB *next;
B
bellard 已提交
272 273
};

274 275
void get_tmp_filename(char *filename, int size);

276 277
void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
                   BlockDriverCompletionFunc *cb, void *opaque);
278 279
void qemu_aio_release(void *p);

280 281 282
void bdrv_set_io_limits(BlockDriverState *bs,
                        BlockIOLimit *io_limits);

283 284 285 286
#ifdef _WIN32
int is_windows_drive(const char *filename);
#endif

B
bellard 已提交
287
#endif /* BLOCK_INT_H */