block_int.h 16.5 KB
Newer Older
bellard's avatar
bellard committed
1
2
/*
 * QEMU System Emulator block driver
3
 *
bellard's avatar
bellard committed
4
 * Copyright (c) 2003 Fabrice Bellard
5
 *
bellard's avatar
bellard committed
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

27
#include "block/block.h"
28
29
#include "qemu/option.h"
#include "qemu/queue.h"
30
#include "block/coroutine.h"
31
#include "qemu/timer.h"
Luiz Capitulino's avatar
Luiz Capitulino committed
32
#include "qapi-types.h"
33
#include "qapi/qmp/qerror.h"
34
#include "monitor/monitor.h"
35
#include "qemu/hbitmap.h"
36
#include "block/snapshot.h"
pbrook's avatar
pbrook committed
37

38
39
40
#define BLOCK_FLAG_ENCRYPT          1
#define BLOCK_FLAG_COMPAT6          4
#define BLOCK_FLAG_LAZY_REFCOUNTS   8
41

42
43
44
45
46
#define BLOCK_IO_LIMIT_READ     0
#define BLOCK_IO_LIMIT_WRITE    1
#define BLOCK_IO_LIMIT_TOTAL    2

#define BLOCK_IO_SLICE_TIME     100000000
47
#define NANOSECONDS_PER_SECOND  1000000000.0
48

49
50
51
52
53
54
55
56
57
58
59
#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"
60
#define BLOCK_OPT_ADAPTER_TYPE      "adapter_type"
61

62
63
64
65
66
67
68
69
70
71
typedef struct BdrvTrackedRequest {
    BlockDriverState *bs;
    int64_t sector_num;
    int nb_sectors;
    bool is_write;
    QLIST_ENTRY(BdrvTrackedRequest) list;
    Coroutine *co; /* owner, used for deadlock detection */
    CoQueue wait_queue; /* coroutines blocked on this request */
} BdrvTrackedRequest;

Stefan Hajnoczi's avatar
Stefan Hajnoczi committed
72

73
74
75
76
77
78
79
80
81
82
typedef struct BlockIOLimit {
    int64_t bps[3];
    int64_t iops[3];
} BlockIOLimit;

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

bellard's avatar
bellard committed
83
84
85
86
struct BlockDriver {
    const char *format_name;
    int instance_size;
    int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
87
    int (*bdrv_probe_device)(const char *filename);
88
89
90

    /* Any driver implementing this callback is expected to be able to handle
     * NULL file names in its .bdrv_open() implementation */
91
    void (*bdrv_parse_filename)(const char *filename, QDict *options, Error **errp);
92
93
94
95
96
97
98

    /* 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);

99
    int (*bdrv_open)(BlockDriverState *bs, QDict *options, int flags);
100
    int (*bdrv_file_open)(BlockDriverState *bs, QDict *options, int flags);
101
    int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
bellard's avatar
bellard committed
102
                     uint8_t *buf, int nb_sectors);
103
    int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
bellard's avatar
bellard committed
104
                      const uint8_t *buf, int nb_sectors);
bellard's avatar
bellard committed
105
    void (*bdrv_close)(BlockDriverState *bs);
Paolo Bonzini's avatar
Paolo Bonzini committed
106
    void (*bdrv_rebind)(BlockDriverState *bs);
107
    int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
bellard's avatar
bellard committed
108
    int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
109
    int (*bdrv_make_empty)(BlockDriverState *bs);
bellard's avatar
bellard committed
110
    /* aio */
111
112
    BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
113
        BlockDriverCompletionFunc *cb, void *opaque);
114
115
    BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
116
        BlockDriverCompletionFunc *cb, void *opaque);
117
118
    BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
        BlockDriverCompletionFunc *cb, void *opaque);
119
120
121
    BlockDriverAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors,
        BlockDriverCompletionFunc *cb, void *opaque);
bellard's avatar
bellard committed
122

Kevin Wolf's avatar
Kevin Wolf committed
123
124
125
126
    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);
127
128
129
130
131
132
133
134
    /*
     * 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);
135
136
    int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors);
137
138
    int coroutine_fn (*bdrv_co_is_allocated)(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors, int *pnum);
Kevin Wolf's avatar
Kevin Wolf committed
139

140
141
142
143
144
    /*
     * Invalidate any cached meta-data.
     */
    void (*bdrv_invalidate_cache)(BlockDriverState *bs);

145
146
147
148
149
150
    /*
     * 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);

151
152
153
154
155
156
157
    /*
     * 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);

bellard's avatar
bellard committed
158
159
160
    const char *protocol_name;
    int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
    int64_t (*bdrv_getlength)(BlockDriverState *bs);
161
    int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs);
162
    int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
bellard's avatar
bellard committed
163
164
                                 const uint8_t *buf, int nb_sectors);

165
    int (*bdrv_snapshot_create)(BlockDriverState *bs,
bellard's avatar
bellard committed
166
                                QEMUSnapshotInfo *sn_info);
167
    int (*bdrv_snapshot_goto)(BlockDriverState *bs,
bellard's avatar
bellard committed
168
169
                              const char *snapshot_id);
    int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
170
    int (*bdrv_snapshot_list)(BlockDriverState *bs,
bellard's avatar
bellard committed
171
                              QEMUSnapshotInfo **psn_info);
edison's avatar
edison committed
172
173
    int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
                                  const char *snapshot_name);
bellard's avatar
bellard committed
174
    int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
bellard's avatar
bellard committed
175

176
177
    int (*bdrv_save_vmstate)(BlockDriverState *bs, QEMUIOVector *qiov,
                             int64_t pos);
178
179
    int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
                             int64_t pos, int size);
180

181
182
183
    int (*bdrv_change_backing_file)(BlockDriverState *bs,
        const char *backing_file, const char *backing_fmt);

bellard's avatar
bellard committed
184
185
186
    /* removable device specific */
    int (*bdrv_is_inserted)(BlockDriverState *bs);
    int (*bdrv_media_changed)(BlockDriverState *bs);
187
    void (*bdrv_eject)(BlockDriverState *bs, bool eject_flag);
188
    void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked);
189

190
191
    /* to control generic scsi devices */
    int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
192
193
194
    BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
        unsigned long int req, void *buf,
        BlockDriverCompletionFunc *cb, void *opaque);
195

196
197
198
    /* List of options for creating images, terminated by name == NULL */
    QEMUOptionParameter *create_options;

199

200
201
202
203
    /*
     * Returns 0 for completed check, -errno for internal errors.
     * The check results are stored in result.
     */
204
205
    int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result,
        BdrvCheckMode fix);
aliguori's avatar
aliguori committed
206

Kevin Wolf's avatar
Kevin Wolf committed
207
208
    void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);

209
210
211
212
213
214
    /* TODO Better pass a option string/QDict/QemuOpts to add any rule? */
    int (*bdrv_debug_breakpoint)(BlockDriverState *bs, const char *event,
        const char *tag);
    int (*bdrv_debug_resume)(BlockDriverState *bs, const char *tag);
    bool (*bdrv_debug_is_suspended)(BlockDriverState *bs, const char *tag);

Kevin Wolf's avatar
Kevin Wolf committed
215
216
217
218
219
    /*
     * Returns 1 if newly created images are guaranteed to contain only
     * zeros, 0 otherwise.
     */
    int (*bdrv_has_zero_init)(BlockDriverState *bs);
220

221
    QLIST_ENTRY(BlockDriver) list;
bellard's avatar
bellard committed
222
223
};

224
225
226
227
228
229
/*
 * 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.
 */
bellard's avatar
bellard committed
230
struct BlockDriverState {
231
232
    int64_t total_sectors; /* if we are reading a disk image, give its
                              size in sectors */
bellard's avatar
bellard committed
233
    int read_only; /* if true, the media is read only */
234
    int open_flags; /* flags used to open the file, re-used for re-open */
bellard's avatar
bellard committed
235
    int encrypted; /* if true, the media is encrypted */
236
    int valid_key; /* if true, a valid encryption key has been set */
237
    int sg;        /* if true, the device is a /dev/sg* */
238
239
    int copy_on_read; /* if true, copy read backing sectors into image
                         note this is a reference count */
bellard's avatar
bellard committed
240

bellard's avatar
bellard committed
241
    BlockDriver *drv; /* NULL means no media */
bellard's avatar
bellard committed
242
243
    void *opaque;

244
245
    void *dev;                  /* attached device model, if any */
    /* TODO change to DeviceState when all users are qdevified */
246
247
    const BlockDevOps *dev_ops;
    void *dev_opaque;
248

bellard's avatar
bellard committed
249
250
251
    char filename[1024];
    char backing_file[1024]; /* if non zero, the image is a diff of
                                this file image */
252
    char backing_format[16]; /* if non-zero and backing_file exists */
bellard's avatar
bellard committed
253
    int is_temporary;
bellard's avatar
bellard committed
254

bellard's avatar
bellard committed
255
    BlockDriverState *backing_hd;
256
257
    BlockDriverState *file;

Paolo Bonzini's avatar
Paolo Bonzini committed
258
259
    NotifierList close_notifiers;

260
261
262
    /* Callback before write request is processed */
    NotifierWithReturnList before_write_notifiers;

263
264
265
    /* number of in-flight copy-on-read requests */
    unsigned int copy_on_read_in_flight;

266
267
268
269
    /* the time for latest disk I/O */
    int64_t slice_start;
    int64_t slice_end;
    BlockIOLimit io_limits;
270
    BlockIOBaseValue slice_submitted;
271
272
273
274
    CoQueue      throttled_reqs;
    QEMUTimer    *block_timer;
    bool         io_limits_enabled;

275
    /* I/O stats (display with "info blockstats"). */
276
277
    uint64_t nr_bytes[BDRV_MAX_IOTYPE];
    uint64_t nr_ops[BDRV_MAX_IOTYPE];
Christoph Hellwig's avatar
Christoph Hellwig committed
278
    uint64_t total_time_ns[BDRV_MAX_IOTYPE];
279
    uint64_t wr_highest_sector;
280

281
282
283
    /* Whether the disk can expand beyond total_sectors */
    int growable;

284
285
286
    /* Whether produces zeros when read beyond eof */
    bool zero_beyond_eof;

287
288
289
    /* the memory alignment required for the buffers handled by this driver */
    int buffer_alignment;

290
291
292
    /* do we need to tell the quest if we have a volatile write cache? */
    int enable_write_cache;

bellard's avatar
bellard committed
293
294
    /* NOTE: the following infos are only hints for real hardware
       drivers. They are not used by the block driver */
295
    BlockdevOnError on_read_error, on_write_error;
296
    bool iostatus_enabled;
Luiz Capitulino's avatar
Luiz Capitulino committed
297
    BlockDeviceIoStatus iostatus;
bellard's avatar
bellard committed
298
    char device_name[32];
299
    HBitmap *dirty_bitmap;
300
    int in_use; /* users other than guest access, eg. block migration */
301
    QTAILQ_ENTRY(BlockDriverState) list;
Stefan Hajnoczi's avatar
Stefan Hajnoczi committed
302
303

    QLIST_HEAD(, BdrvTrackedRequest) tracked_requests;
304
305
306

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

308
    QDict *options;
bellard's avatar
bellard committed
309
310
};

311
int get_tmp_filename(char *filename, int size);
312

313
314
315
void bdrv_set_io_limits(BlockDriverState *bs,
                        BlockIOLimit *io_limits);

316
317
318
319
320
321
322
323
324
/**
 * bdrv_add_before_write_notifier:
 *
 * Register a callback that is invoked before write requests are processed but
 * after any throttling or waiting for overlapping requests.
 */
void bdrv_add_before_write_notifier(BlockDriverState *bs,
                                    NotifierWithReturn *notifier);

325
326
327
328
329
330
331
/**
 * bdrv_get_aio_context:
 *
 * Returns: the currently bound #AioContext
 */
AioContext *bdrv_get_aio_context(BlockDriverState *bs);

332
333
334
#ifdef _WIN32
int is_windows_drive(const char *filename);
#endif
335
336
337
void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
                               enum MonitorEvent ev,
                               BlockErrorAction action, bool is_read);
338

Paolo Bonzini's avatar
Paolo Bonzini committed
339
340
341
342
343
344
345
/**
 * 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.
346
 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
Paolo Bonzini's avatar
Paolo Bonzini committed
347
 * @on_error: The action to take upon error.
Paolo Bonzini's avatar
Paolo Bonzini committed
348
349
 * @cb: Completion function for the job.
 * @opaque: Opaque pointer value passed to @cb.
350
 * @errp: Error object.
Paolo Bonzini's avatar
Paolo Bonzini committed
351
352
353
354
355
356
357
 *
 * 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.
 */
358
void stream_start(BlockDriverState *bs, BlockDriverState *base,
Paolo Bonzini's avatar
Paolo Bonzini committed
359
                  const char *base_id, int64_t speed, BlockdevOnError on_error,
360
                  BlockDriverCompletionFunc *cb,
361
                  void *opaque, Error **errp);
362

363
364
365
366
367
368
369
370
371
372
373
374
375
/**
 * 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,
376
                 BlockdevOnError on_error, BlockDriverCompletionFunc *cb,
377
378
                 void *opaque, Error **errp);

Paolo Bonzini's avatar
Paolo Bonzini committed
379
380
381
382
383
/*
 * mirror_start:
 * @bs: Block device to operate on.
 * @target: Block device to write to.
 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
384
 * @granularity: The chosen granularity for the dirty bitmap.
385
 * @buf_size: The amount of data that can be in flight at one time.
Paolo Bonzini's avatar
Paolo Bonzini committed
386
 * @mode: Whether to collapse all images in the chain to the target.
387
388
 * @on_source_error: The action to take upon error reading from the source.
 * @on_target_error: The action to take upon error writing to the target.
Paolo Bonzini's avatar
Paolo Bonzini committed
389
390
391
392
393
394
395
396
397
398
 * @cb: Completion function for the job.
 * @opaque: Opaque pointer value passed to @cb.
 * @errp: Error object.
 *
 * Start a mirroring operation on @bs.  Clusters that are allocated
 * in @bs will be written to @bs until the job is cancelled or
 * manually completed.  At the end of a successful mirroring job,
 * @bs will be switched to read from @target.
 */
void mirror_start(BlockDriverState *bs, BlockDriverState *target,
399
400
                  int64_t speed, int64_t granularity, int64_t buf_size,
                  MirrorSyncMode mode, BlockdevOnError on_source_error,
401
                  BlockdevOnError on_target_error,
Paolo Bonzini's avatar
Paolo Bonzini committed
402
403
404
                  BlockDriverCompletionFunc *cb,
                  void *opaque, Error **errp);

405
406
407
408
409
/*
 * backup_start:
 * @bs: Block device to operate on.
 * @target: Block device to write to.
 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
410
 * @sync_mode: What parts of the disk image should be copied to the destination.
411
412
413
414
415
416
417
418
419
 * @on_source_error: The action to take upon error reading from the source.
 * @on_target_error: The action to take upon error writing to the target.
 * @cb: Completion function for the job.
 * @opaque: Opaque pointer value passed to @cb.
 *
 * Start a backup operation on @bs.  Clusters in @bs are written to @target
 * until the job is cancelled or manually completed.
 */
void backup_start(BlockDriverState *bs, BlockDriverState *target,
420
421
                  int64_t speed, MirrorSyncMode sync_mode,
                  BlockdevOnError on_source_error,
422
423
424
425
                  BlockdevOnError on_target_error,
                  BlockDriverCompletionFunc *cb, void *opaque,
                  Error **errp);

bellard's avatar
bellard committed
426
#endif /* BLOCK_INT_H */