block_int.h 12.9 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"
33
#include "qerror.h"
P
Paolo Bonzini 已提交
34
#include "monitor.h"
P
pbrook 已提交
35

36 37 38
#define BLOCK_FLAG_ENCRYPT          1
#define BLOCK_FLAG_COMPAT6          4
#define BLOCK_FLAG_LAZY_REFCOUNTS   8
39

40 41 42 43 44
#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 已提交
45
#define NANOSECONDS_PER_SECOND  1000000000.0
46

47 48 49 50 51 52 53 54 55 56 57
#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"
#define BLOCK_OPT_CLUSTER_SIZE      "cluster_size"
#define BLOCK_OPT_TABLE_SIZE        "table_size"
#define BLOCK_OPT_PREALLOC          "preallocation"
#define BLOCK_OPT_SUBFMT            "subformat"
#define BLOCK_OPT_COMPAT_LEVEL      "compat"
#define BLOCK_OPT_LAZY_REFCOUNTS    "lazy_refcounts"
58

S
Stefan Hajnoczi 已提交
59 60
typedef struct BdrvTrackedRequest BdrvTrackedRequest;

61 62 63 64 65 66 67 68 69 70
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 已提交
71 72 73 74
struct BlockDriver {
    const char *format_name;
    int instance_size;
    int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
75
    int (*bdrv_probe_device)(const char *filename);
76 77 78 79 80 81 82

    /* For handling image reopen for split or non-split files */
    int (*bdrv_reopen_prepare)(BDRVReopenState *reopen_state,
                               BlockReopenQueue *queue, Error **errp);
    void (*bdrv_reopen_commit)(BDRVReopenState *reopen_state);
    void (*bdrv_reopen_abort)(BDRVReopenState *reopen_state);

83 84
    int (*bdrv_open)(BlockDriverState *bs, int flags);
    int (*bdrv_file_open)(BlockDriverState *bs, const char *filename, int flags);
85
    int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
86
                     uint8_t *buf, int nb_sectors);
87
    int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
88
                      const uint8_t *buf, int nb_sectors);
B
bellard 已提交
89
    void (*bdrv_close)(BlockDriverState *bs);
P
Paolo Bonzini 已提交
90
    void (*bdrv_rebind)(BlockDriverState *bs);
91
    int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
B
bellard 已提交
92
    int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
93
    int (*bdrv_make_empty)(BlockDriverState *bs);
B
bellard 已提交
94
    /* aio */
95 96
    BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
97
        BlockDriverCompletionFunc *cb, void *opaque);
98 99
    BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
100
        BlockDriverCompletionFunc *cb, void *opaque);
101 102
    BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
        BlockDriverCompletionFunc *cb, void *opaque);
103 104 105
    BlockDriverAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors,
        BlockDriverCompletionFunc *cb, void *opaque);
B
bellard 已提交
106

K
Kevin Wolf 已提交
107 108 109 110
    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);
111 112 113 114 115 116 117 118
    /*
     * Efficiently zero a region of the disk image.  Typically an image format
     * would use a compact metadata representation to implement this.  This
     * function pointer may be NULL and .bdrv_co_writev() will be called
     * instead.
     */
    int coroutine_fn (*bdrv_co_write_zeroes)(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors);
119 120
    int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors);
121 122
    int coroutine_fn (*bdrv_co_is_allocated)(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors, int *pnum);
K
Kevin Wolf 已提交
123

124 125 126 127 128
    /*
     * Invalidate any cached meta-data.
     */
    void (*bdrv_invalidate_cache)(BlockDriverState *bs);

129 130 131 132 133 134
    /*
     * 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 已提交
135 136 137 138 139 140 141
    /*
     * 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);

B
bellard 已提交
142 143 144
    const char *protocol_name;
    int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
    int64_t (*bdrv_getlength)(BlockDriverState *bs);
145
    int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs);
146
    int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
147 148
                                 const uint8_t *buf, int nb_sectors);

149
    int (*bdrv_snapshot_create)(BlockDriverState *bs,
B
bellard 已提交
150
                                QEMUSnapshotInfo *sn_info);
151
    int (*bdrv_snapshot_goto)(BlockDriverState *bs,
B
bellard 已提交
152 153
                              const char *snapshot_id);
    int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
154
    int (*bdrv_snapshot_list)(BlockDriverState *bs,
B
bellard 已提交
155
                              QEMUSnapshotInfo **psn_info);
E
edison 已提交
156 157
    int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
                                  const char *snapshot_name);
B
bellard 已提交
158
    int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
B
bellard 已提交
159

160 161 162 163
    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);
164

K
Kevin Wolf 已提交
165 166 167
    int (*bdrv_change_backing_file)(BlockDriverState *bs,
        const char *backing_file, const char *backing_fmt);

B
bellard 已提交
168 169 170
    /* removable device specific */
    int (*bdrv_is_inserted)(BlockDriverState *bs);
    int (*bdrv_media_changed)(BlockDriverState *bs);
171
    void (*bdrv_eject)(BlockDriverState *bs, bool eject_flag);
172
    void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked);
173

174 175
    /* to control generic scsi devices */
    int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
176 177 178
    BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
        unsigned long int req, void *buf,
        BlockDriverCompletionFunc *cb, void *opaque);
179

180 181 182
    /* List of options for creating images, terminated by name == NULL */
    QEMUOptionParameter *create_options;

183

184 185 186 187
    /*
     * Returns 0 for completed check, -errno for internal errors.
     * The check results are stored in result.
     */
188 189
    int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result,
        BdrvCheckMode fix);
A
aliguori 已提交
190

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

K
Kevin Wolf 已提交
193 194 195 196 197
    /*
     * Returns 1 if newly created images are guaranteed to contain only
     * zeros, 0 otherwise.
     */
    int (*bdrv_has_zero_init)(BlockDriverState *bs);
198

199
    QLIST_ENTRY(BlockDriver) list;
B
bellard 已提交
200 201
};

202 203 204 205 206 207
/*
 * Note: the function bdrv_append() copies and swaps contents of
 * BlockDriverStates, so if you add new fields to this struct, please
 * inspect bdrv_append() to determine if the new fields need to be
 * copied as well.
 */
B
bellard 已提交
208
struct BlockDriverState {
209 210
    int64_t total_sectors; /* if we are reading a disk image, give its
                              size in sectors */
B
bellard 已提交
211
    int read_only; /* if true, the media is read only */
212
    int open_flags; /* flags used to open the file, re-used for re-open */
B
bellard 已提交
213
    int encrypted; /* if true, the media is encrypted */
214
    int valid_key; /* if true, a valid encryption key has been set */
215
    int sg;        /* if true, the device is a /dev/sg* */
216 217
    int copy_on_read; /* if true, copy read backing sectors into image
                         note this is a reference count */
B
bellard 已提交
218

B
bellard 已提交
219
    BlockDriver *drv; /* NULL means no media */
B
bellard 已提交
220 221
    void *opaque;

222 223
    void *dev;                  /* attached device model, if any */
    /* TODO change to DeviceState when all users are qdevified */
224 225
    const BlockDevOps *dev_ops;
    void *dev_opaque;
226

B
bellard 已提交
227 228 229
    char filename[1024];
    char backing_file[1024]; /* if non zero, the image is a diff of
                                this file image */
230
    char backing_format[16]; /* if non-zero and backing_file exists */
B
bellard 已提交
231
    int is_temporary;
B
bellard 已提交
232

B
bellard 已提交
233
    BlockDriverState *backing_hd;
234 235
    BlockDriverState *file;

P
Paolo Bonzini 已提交
236 237
    NotifierList close_notifiers;

238 239 240
    /* number of in-flight copy-on-read requests */
    unsigned int copy_on_read_in_flight;

241 242 243 244 245 246 247 248 249 250
    /* 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;

251
    /* I/O stats (display with "info blockstats"). */
252 253
    uint64_t nr_bytes[BDRV_MAX_IOTYPE];
    uint64_t nr_ops[BDRV_MAX_IOTYPE];
C
Christoph Hellwig 已提交
254
    uint64_t total_time_ns[BDRV_MAX_IOTYPE];
255
    uint64_t wr_highest_sector;
256

257 258 259
    /* Whether the disk can expand beyond total_sectors */
    int growable;

260 261 262
    /* the memory alignment required for the buffers handled by this driver */
    int buffer_alignment;

263 264 265
    /* do we need to tell the quest if we have a volatile write cache? */
    int enable_write_cache;

B
bellard 已提交
266 267
    /* NOTE: the following infos are only hints for real hardware
       drivers. They are not used by the block driver */
268
    BlockdevOnError on_read_error, on_write_error;
269
    bool iostatus_enabled;
L
Luiz Capitulino 已提交
270
    BlockDeviceIoStatus iostatus;
B
bellard 已提交
271
    char device_name[32];
272
    unsigned long *dirty_bitmap;
273
    int64_t dirty_count;
274
    int in_use; /* users other than guest access, eg. block migration */
275
    QTAILQ_ENTRY(BlockDriverState) list;
S
Stefan Hajnoczi 已提交
276 277

    QLIST_HEAD(, BdrvTrackedRequest) tracked_requests;
278 279 280

    /* long-running background operation */
    BlockJob *job;
281

B
bellard 已提交
282 283
};

284
int get_tmp_filename(char *filename, int size);
285

286 287 288
void bdrv_set_io_limits(BlockDriverState *bs,
                        BlockIOLimit *io_limits);

289 290 291
#ifdef _WIN32
int is_windows_drive(const char *filename);
#endif
P
Paolo Bonzini 已提交
292 293 294
void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
                               enum MonitorEvent ev,
                               BlockErrorAction action, bool is_read);
295

P
Paolo Bonzini 已提交
296 297 298 299 300 301 302
/**
 * stream_start:
 * @bs: Block device to operate on.
 * @base: Block device that will become the new base, or %NULL to
 * flatten the whole backing file chain onto @bs.
 * @base_id: The file name that will be written to @bs as the new
 * backing file if the job completes.  Ignored if @base is %NULL.
303
 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
P
Paolo Bonzini 已提交
304
 * @on_error: The action to take upon error.
P
Paolo Bonzini 已提交
305 306
 * @cb: Completion function for the job.
 * @opaque: Opaque pointer value passed to @cb.
307
 * @errp: Error object.
P
Paolo Bonzini 已提交
308 309 310 311 312 313 314
 *
 * Start a streaming operation on @bs.  Clusters that are unallocated
 * in @bs, but allocated in any image between @base and @bs (both
 * exclusive) will be written to @bs.  At the end of a successful
 * streaming job, the backing file of @bs will be changed to
 * @base_id in the written image and to @base in the live BlockDriverState.
 */
315
void stream_start(BlockDriverState *bs, BlockDriverState *base,
P
Paolo Bonzini 已提交
316
                  const char *base_id, int64_t speed, BlockdevOnError on_error,
317
                  BlockDriverCompletionFunc *cb,
318
                  void *opaque, Error **errp);
319

320 321 322 323 324 325 326 327 328 329 330 331 332
/**
 * commit_start:
 * @bs: Top Block device
 * @base: Block device that will be written into, and become the new top
 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
 * @on_error: The action to take upon error.
 * @cb: Completion function for the job.
 * @opaque: Opaque pointer value passed to @cb.
 * @errp: Error object.
 *
 */
void commit_start(BlockDriverState *bs, BlockDriverState *base,
                 BlockDriverState *top, int64_t speed,
333
                 BlockdevOnError on_error, BlockDriverCompletionFunc *cb,
334 335
                 void *opaque, Error **errp);

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