block.h 23.6 KB
Newer Older
P
pbrook 已提交
1 2 3
#ifndef BLOCK_H
#define BLOCK_H

4
#include "block/aio.h"
5
#include "qemu/iov.h"
6
#include "qemu/option.h"
7
#include "qemu/coroutine.h"
8
#include "block/accounting.h"
9
#include "block/dirty-bitmap.h"
10
#include "block/blockjob.h"
11
#include "qapi/qmp/qobject.h"
12
#include "qapi-types.h"
F
Fam Zheng 已提交
13
#include "qemu/hbitmap.h"
14

P
pbrook 已提交
15 16
/* block.c */
typedef struct BlockDriver BlockDriver;
K
Kevin Wolf 已提交
17
typedef struct BdrvChild BdrvChild;
18
typedef struct BdrvChildRole BdrvChildRole;
P
pbrook 已提交
19 20 21 22 23 24

typedef struct BlockDriverInfo {
    /* in bytes, 0 if irrelevant */
    int cluster_size;
    /* offset at which the VM state can be saved (0 if not possible) */
    int64_t vm_state_offset;
D
Dong Xu Wang 已提交
25
    bool is_dirty;
26 27
    /*
     * True if unallocated blocks read back as zeroes. This is equivalent
28
     * to the LBPRZ flag in the SCSI logical block provisioning page.
29 30 31 32 33 34
     */
    bool unallocated_blocks_are_zero;
    /*
     * True if the driver can optimize writing zeroes by unmapping
     * sectors. This is equivalent to the BLKDISCARDZEROES ioctl in Linux
     * with the difference that in qemu a discard is allowed to silently
35
     * fail. Therefore we have to use bdrv_pwrite_zeroes with the
36 37 38 39 40 41
     * BDRV_REQ_MAY_UNMAP flag for an optimized zero write with unmapping.
     * After this call the driver has to guarantee that the contents read
     * back as zero. It is additionally required that the block device is
     * opened with BDRV_O_UNMAP flag for this to work.
     */
    bool can_write_zeroes_with_unmap;
42 43 44 45
    /*
     * True if this block driver only supports compressed writes
     */
    bool needs_compressed_writes;
P
pbrook 已提交
46 47
} BlockDriverInfo;

48 49 50 51
typedef struct BlockFragInfo {
    uint64_t allocated_clusters;
    uint64_t total_clusters;
    uint64_t fragmented_clusters;
52
    uint64_t compressed_clusters;
53 54
} BlockFragInfo;

P
Peter Lieven 已提交
55
typedef enum {
56 57
    BDRV_REQ_COPY_ON_READ       = 0x1,
    BDRV_REQ_ZERO_WRITE         = 0x2,
58 59 60 61 62 63
    /* The BDRV_REQ_MAY_UNMAP flag is used to indicate that the block driver
     * is allowed to optimize a write zeroes request by unmapping (discarding)
     * blocks if it is guaranteed that the result will read back as
     * zeroes. The flag is only passed to the driver if the block device is
     * opened with BDRV_O_UNMAP.
     */
64
    BDRV_REQ_MAY_UNMAP          = 0x4,
65
    BDRV_REQ_NO_SERIALISING     = 0x8,
66
    BDRV_REQ_FUA                = 0x10,
67
    BDRV_REQ_WRITE_COMPRESSED   = 0x20,
68 69

    /* Mask of valid flags */
70
    BDRV_REQ_MASK               = 0x3f,
P
Peter Lieven 已提交
71 72
} BdrvRequestFlags;

73 74 75 76 77 78 79 80 81 82 83
typedef struct BlockSizes {
    uint32_t phys;
    uint32_t log;
} BlockSizes;

typedef struct HDGeometry {
    uint32_t heads;
    uint32_t sectors;
    uint32_t cylinders;
} HDGeometry;

P
pbrook 已提交
84 85
#define BDRV_O_RDWR        0x0002
#define BDRV_O_SNAPSHOT    0x0008 /* open the file read only and save writes in a snapshot */
86
#define BDRV_O_TEMPORARY   0x0010 /* delete the file after use */
87
#define BDRV_O_NOCACHE     0x0020 /* do not use the host page cache */
88
#define BDRV_O_NATIVE_AIO  0x0080 /* use native AIO instead of the thread pool */
K
Kevin Wolf 已提交
89
#define BDRV_O_NO_BACKING  0x0100 /* don't open the backing file */
90
#define BDRV_O_NO_FLUSH    0x0200 /* disable flushing on this disk */
91
#define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
92
#define BDRV_O_INACTIVE    0x0800  /* consistency hint for migration handoff */
93
#define BDRV_O_CHECK       0x1000  /* open solely for consistency check */
94
#define BDRV_O_ALLOW_RDWR  0x2000  /* allow reopen to change from r/o to r/w */
P
Paolo Bonzini 已提交
95
#define BDRV_O_UNMAP       0x4000  /* execute guest UNMAP/TRIM operations */
M
Max Reitz 已提交
96 97 98
#define BDRV_O_PROTOCOL    0x8000  /* if no block driver is explicitly given:
                                      select an appropriate protocol driver,
                                      ignoring the format layer */
99
#define BDRV_O_NO_IO       0x10000 /* don't initialize for I/O */
100

K
Kevin Wolf 已提交
101
#define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_NO_FLUSH)
P
pbrook 已提交
102

103 104 105 106 107 108

/* Option names of options parsed by the block layer */

#define BDRV_OPT_CACHE_WB       "cache.writeback"
#define BDRV_OPT_CACHE_DIRECT   "cache.direct"
#define BDRV_OPT_CACHE_NO_FLUSH "cache.no-flush"
109
#define BDRV_OPT_READ_ONLY      "read-only"
110
#define BDRV_OPT_DISCARD        "discard"
111 112


J
Jan Kiszka 已提交
113
#define BDRV_SECTOR_BITS   9
114
#define BDRV_SECTOR_SIZE   (1ULL << BDRV_SECTOR_BITS)
115
#define BDRV_SECTOR_MASK   ~(BDRV_SECTOR_SIZE - 1)
J
Jan Kiszka 已提交
116

117 118 119
#define BDRV_REQUEST_MAX_SECTORS MIN(SIZE_MAX >> BDRV_SECTOR_BITS, \
                                     INT_MAX >> BDRV_SECTOR_BITS)

120 121
/*
 * Allocation status flags
122
 * BDRV_BLOCK_DATA: data is read from a file returned by bdrv_get_block_status.
123
 * BDRV_BLOCK_ZERO: sectors read as zero
124 125
 * BDRV_BLOCK_OFFSET_VALID: sector stored as raw data in a file returned by
 *                          bdrv_get_block_status.
126 127
 * BDRV_BLOCK_ALLOCATED: the content of the block is determined by this
 *                       layer (as opposed to the backing file)
128 129 130
 * BDRV_BLOCK_RAW: used internally to indicate that the request
 *                 was answered by the raw driver and that one
 *                 should look in bs->file directly.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
 *
 * If BDRV_BLOCK_OFFSET_VALID is set, bits 9-62 represent the offset in
 * bs->file where sector data can be read from as raw data.
 *
 * DATA == 0 && ZERO == 0 means that data is read from backing_hd if present.
 *
 * DATA ZERO OFFSET_VALID
 *  t    t        t       sectors read as zero, bs->file is zero at offset
 *  t    f        t       sectors read as valid from bs->file at offset
 *  f    t        t       sectors preallocated, read as zero, bs->file not
 *                        necessarily zero at offset
 *  f    f        t       sectors preallocated but read from backing_hd,
 *                        bs->file contains garbage at offset
 *  t    t        f       sectors preallocated, read as zero, unknown offset
 *  t    f        f       sectors read from unknown file or offset
 *  f    t        f       not allocated or unknown offset, read as zero
 *  f    f        f       not allocated or unknown offset, read from backing_hd
 */
149 150 151 152 153
#define BDRV_BLOCK_DATA         0x01
#define BDRV_BLOCK_ZERO         0x02
#define BDRV_BLOCK_OFFSET_VALID 0x04
#define BDRV_BLOCK_RAW          0x08
#define BDRV_BLOCK_ALLOCATED    0x10
154 155
#define BDRV_BLOCK_OFFSET_MASK  BDRV_SECTOR_MASK

156 157 158 159 160
typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue;

typedef struct BDRVReopenState {
    BlockDriverState *bs;
    int flags;
161
    QDict *options;
K
Kevin Wolf 已提交
162
    QDict *explicit_options;
163 164 165
    void *opaque;
} BDRVReopenState;

F
Fam Zheng 已提交
166 167 168 169 170 171 172
/*
 * Block operation types
 */
typedef enum BlockOpType {
    BLOCK_OP_TYPE_BACKUP_SOURCE,
    BLOCK_OP_TYPE_BACKUP_TARGET,
    BLOCK_OP_TYPE_CHANGE,
173 174
    BLOCK_OP_TYPE_COMMIT_SOURCE,
    BLOCK_OP_TYPE_COMMIT_TARGET,
F
Fam Zheng 已提交
175 176 177 178 179 180
    BLOCK_OP_TYPE_DATAPLANE,
    BLOCK_OP_TYPE_DRIVE_DEL,
    BLOCK_OP_TYPE_EJECT,
    BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
    BLOCK_OP_TYPE_INTERNAL_SNAPSHOT,
    BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE,
181
    BLOCK_OP_TYPE_MIRROR_SOURCE,
F
Fam Zheng 已提交
182
    BLOCK_OP_TYPE_MIRROR_TARGET,
F
Fam Zheng 已提交
183 184
    BLOCK_OP_TYPE_RESIZE,
    BLOCK_OP_TYPE_STREAM,
185
    BLOCK_OP_TYPE_REPLACE,
F
Fam Zheng 已提交
186 187
    BLOCK_OP_TYPE_MAX,
} BlockOpType;
188

189
/* disk I/O throttling */
P
pbrook 已提交
190
void bdrv_init(void);
191
void bdrv_init_with_whitelist(void);
192
bool bdrv_uses_whitelist(void);
193
BlockDriver *bdrv_find_protocol(const char *filename,
194 195
                                bool allow_protocol_prefix,
                                Error **errp);
P
pbrook 已提交
196
BlockDriver *bdrv_find_format(const char *format_name);
197
int bdrv_create(BlockDriver *drv, const char* filename,
C
Chunyan Liu 已提交
198 199
                QemuOpts *opts, Error **errp);
int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp);
200
BlockDriverState *bdrv_new(void);
201
void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
202 203 204
void bdrv_replace_in_backing_chain(BlockDriverState *old,
                                   BlockDriverState *new);

K
Kevin Wolf 已提交
205
int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough);
P
Paolo Bonzini 已提交
206
int bdrv_parse_discard_flags(const char *mode, int *flags);
K
Kevin Wolf 已提交
207 208 209 210 211
BdrvChild *bdrv_open_child(const char *filename,
                           QDict *options, const char *bdref_key,
                           BlockDriverState* parent,
                           const BdrvChildRole *child_role,
                           bool allow_none, Error **errp);
F
Fam Zheng 已提交
212
void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd);
213 214
int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options,
                           const char *bdref_key, Error **errp);
M
Max Reitz 已提交
215 216
BlockDriverState *bdrv_open(const char *filename, const char *reference,
                            QDict *options, int flags, Error **errp);
217
BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
218 219
                                    BlockDriverState *bs,
                                    QDict *options, int flags);
220
int bdrv_reopen_multiple(AioContext *ctx, BlockReopenQueue *bs_queue, Error **errp);
221 222 223 224 225
int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
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);
226
int bdrv_read(BdrvChild *child, int64_t sector_num,
P
pbrook 已提交
227
              uint8_t *buf, int nb_sectors);
228
int bdrv_write(BdrvChild *child, int64_t sector_num,
P
pbrook 已提交
229
               const uint8_t *buf, int nb_sectors);
230
int bdrv_pwrite_zeroes(BdrvChild *child, int64_t offset,
231
                       int count, BdrvRequestFlags flags);
232
int bdrv_make_zero(BdrvChild *child, BdrvRequestFlags flags);
233 234
int bdrv_pread(BdrvChild *child, int64_t offset, void *buf, int bytes);
int bdrv_preadv(BdrvChild *child, int64_t offset, QEMUIOVector *qiov);
235 236 237 238
int bdrv_pwrite(BdrvChild *child, int64_t offset, const void *buf, int bytes);
int bdrv_pwritev(BdrvChild *child, int64_t offset, QEMUIOVector *qiov);
int bdrv_pwrite_sync(BdrvChild *child, int64_t offset,
                     const void *buf, int count);
239 240
int coroutine_fn bdrv_co_readv(BdrvChild *child, int64_t sector_num,
                               int nb_sectors, QEMUIOVector *qiov);
241 242
int coroutine_fn bdrv_co_writev(BdrvChild *child, int64_t sector_num,
                               int nb_sectors, QEMUIOVector *qiov);
243 244 245 246 247 248
/*
 * Efficiently zero a region of the disk image.  Note that this is a regular
 * I/O request like read or write and should have a reasonable size.  This
 * function is not suitable for zeroing the entire image in a single request
 * because it may allocate memory for the entire region.
 */
249 250
int coroutine_fn bdrv_co_pwrite_zeroes(BdrvChild *child, int64_t offset,
                                       int count, BdrvRequestFlags flags);
251 252
BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
    const char *backing_file);
253
int bdrv_get_backing_file_depth(BlockDriverState *bs);
M
Max Reitz 已提交
254
void bdrv_refresh_filename(BlockDriverState *bs);
P
pbrook 已提交
255
int bdrv_truncate(BlockDriverState *bs, int64_t offset);
M
Markus Armbruster 已提交
256
int64_t bdrv_nb_sectors(BlockDriverState *bs);
P
pbrook 已提交
257
int64_t bdrv_getlength(BlockDriverState *bs);
258
int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
259
void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
260
void bdrv_refresh_limits(BlockDriverState *bs, Error **errp);
P
pbrook 已提交
261
int bdrv_commit(BlockDriverState *bs);
K
Kevin Wolf 已提交
262 263
int bdrv_change_backing_file(BlockDriverState *bs,
    const char *backing_file, const char *backing_fmt);
264
void bdrv_register(BlockDriver *bdrv);
265
int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
266 267
                           BlockDriverState *base,
                           const char *backing_file_str);
268 269
BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
                                    BlockDriverState *bs);
270
BlockDriverState *bdrv_find_base(BlockDriverState *bs);
271

272 273 274 275 276

typedef struct BdrvCheckResult {
    int corruptions;
    int leaks;
    int check_errors;
277 278
    int corruptions_fixed;
    int leaks_fixed;
279
    int64_t image_end_offset;
280
    BlockFragInfo bfi;
281 282
} BdrvCheckResult;

283 284 285 286 287 288
typedef enum {
    BDRV_FIX_LEAKS    = 1,
    BDRV_FIX_ERRORS   = 2,
} BdrvCheckMode;

int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
289

290 291 292 293
/* The units of offset and total_work_size may be chosen arbitrarily by the
 * block driver; total_work_size may change during the course of the amendment
 * operation */
typedef void BlockDriverAmendStatusCB(BlockDriverState *bs, int64_t offset,
294
                                      int64_t total_work_size, void *opaque);
295
int bdrv_amend_options(BlockDriverState *bs_new, QemuOpts *opts,
296
                       BlockDriverAmendStatusCB *status_cb, void *cb_opaque);
M
Max Reitz 已提交
297

298
/* external snapshots */
299 300 301
bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs,
                                      BlockDriverState *candidate);
bool bdrv_is_first_non_filter(BlockDriverState *candidate);
302

303
/* check if a named node can be replaced when doing drive-mirror */
304 305
BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs,
                                        const char *node_name, Error **errp);
306

P
pbrook 已提交
307
/* async block I/O */
308
BlockAIOCB *bdrv_aio_readv(BdrvChild *child, int64_t sector_num,
309
                           QEMUIOVector *iov, int nb_sectors,
310
                           BlockCompletionFunc *cb, void *opaque);
311
BlockAIOCB *bdrv_aio_writev(BdrvChild *child, int64_t sector_num,
312
                            QEMUIOVector *iov, int nb_sectors,
313
                            BlockCompletionFunc *cb, void *opaque);
314
BlockAIOCB *bdrv_aio_flush(BlockDriverState *bs,
315
                           BlockCompletionFunc *cb, void *opaque);
316 317
void bdrv_aio_cancel(BlockAIOCB *acb);
void bdrv_aio_cancel_async(BlockAIOCB *acb);
P
pbrook 已提交
318

319
/* sg packet commands */
320
int bdrv_co_ioctl(BlockDriverState *bs, int req, void *buf);
321

322
/* Invalidate any cached metadata used by image formats */
323 324
void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp);
void bdrv_invalidate_cache_all(Error **errp);
325
int bdrv_inactivate_all(void);
326

P
pbrook 已提交
327
/* Ensure contents are flushed to disk.  */
328
int bdrv_flush(BlockDriverState *bs);
P
Paolo Bonzini 已提交
329
int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
J
John Snow 已提交
330
int bdrv_flush_all(void);
331
void bdrv_close_all(void);
S
Stefan Hajnoczi 已提交
332
void bdrv_drain(BlockDriverState *bs);
F
Fam Zheng 已提交
333
void coroutine_fn bdrv_co_drain(BlockDriverState *bs);
334 335
void bdrv_drain_all_begin(void);
void bdrv_drain_all_end(void);
336
void bdrv_drain_all(void);
A
aliguori 已提交
337

P
Paolo Bonzini 已提交
338 339 340
#define BDRV_POLL_WHILE(bs, cond) ({                       \
    bool waited_ = false;                                  \
    BlockDriverState *bs_ = (bs);                          \
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
    AioContext *ctx_ = bdrv_get_aio_context(bs_);          \
    if (aio_context_in_iothread(ctx_)) {                   \
        while ((cond)) {                                   \
            aio_poll(ctx_, true);                          \
            waited_ = true;                                \
        }                                                  \
    } else {                                               \
        assert(qemu_get_current_aio_context() ==           \
               qemu_get_aio_context());                    \
        /* Ask bdrv_dec_in_flight to wake up the main      \
         * QEMU AioContext.  Extra I/O threads never take  \
         * other I/O threads' AioContexts (see for example \
         * block_job_defer_to_main_loop for how to do it). \
         */                                                \
        assert(!bs_->wakeup);                              \
        bs_->wakeup = true;                                \
        while ((cond)) {                                   \
            aio_context_release(ctx_);                     \
            aio_poll(qemu_get_aio_context(), true);        \
            aio_context_acquire(ctx_);                     \
            waited_ = true;                                \
        }                                                  \
        bs_->wakeup = false;                               \
P
Paolo Bonzini 已提交
364 365 366
    }                                                      \
    waited_; })

367
int bdrv_pdiscard(BlockDriverState *bs, int64_t offset, int count);
368
int bdrv_co_pdiscard(BlockDriverState *bs, int64_t offset, int count);
369
int bdrv_has_zero_init_1(BlockDriverState *bs);
K
Kevin Wolf 已提交
370
int bdrv_has_zero_init(BlockDriverState *bs);
371 372
bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs);
bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs);
373
int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num,
374 375
                              int nb_sectors, int *pnum,
                              BlockDriverState **file);
376 377 378
int64_t bdrv_get_block_status_above(BlockDriverState *bs,
                                    BlockDriverState *base,
                                    int64_t sector_num,
379 380
                                    int nb_sectors, int *pnum,
                                    BlockDriverState **file);
381
int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
382
                      int *pnum);
383 384
int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
                            int64_t sector_num, int nb_sectors, int *pnum);
P
pbrook 已提交
385

386 387
bool bdrv_is_read_only(BlockDriverState *bs);
bool bdrv_is_sg(BlockDriverState *bs);
388
bool bdrv_is_inserted(BlockDriverState *bs);
P
pbrook 已提交
389
int bdrv_media_changed(BlockDriverState *bs);
390
void bdrv_lock_medium(BlockDriverState *bs, bool locked);
391
void bdrv_eject(BlockDriverState *bs, bool eject_flag);
392
const char *bdrv_get_format_name(BlockDriverState *bs);
393
BlockDriverState *bdrv_find_node(const char *node_name);
394
BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp);
395 396 397
BlockDriverState *bdrv_lookup_bs(const char *device,
                                 const char *node_name,
                                 Error **errp);
398
bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base);
F
Fam Zheng 已提交
399
BlockDriverState *bdrv_next_node(BlockDriverState *bs);
K
Kevin Wolf 已提交
400 401 402 403 404 405 406 407 408 409 410 411 412

typedef struct BdrvNextIterator {
    enum {
        BDRV_NEXT_BACKEND_ROOTS,
        BDRV_NEXT_MONITOR_OWNED,
    } phase;
    BlockBackend *blk;
    BlockDriverState *bs;
} BdrvNextIterator;

BlockDriverState *bdrv_first(BdrvNextIterator *it);
BlockDriverState *bdrv_next(BdrvNextIterator *it);

M
Max Reitz 已提交
413
BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs);
414 415
bool bdrv_is_encrypted(BlockDriverState *bs);
bool bdrv_key_required(BlockDriverState *bs);
P
pbrook 已提交
416
int bdrv_set_key(BlockDriverState *bs, const char *key);
417
void bdrv_add_key(BlockDriverState *bs, const char *key, Error **errp);
P
pbrook 已提交
418 419
void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
                         void *opaque);
F
Fam Zheng 已提交
420
const char *bdrv_get_node_name(const BlockDriverState *bs);
421
const char *bdrv_get_device_name(const BlockDriverState *bs);
422
const char *bdrv_get_device_or_node_name(const BlockDriverState *bs);
M
Markus Armbruster 已提交
423
int bdrv_get_flags(BlockDriverState *bs);
P
pbrook 已提交
424
int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
M
Max Reitz 已提交
425
ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs);
426 427 428 429
void bdrv_round_sectors_to_clusters(BlockDriverState *bs,
                                    int64_t sector_num, int nb_sectors,
                                    int64_t *cluster_sector_num,
                                    int *cluster_nb_sectors);
430
void bdrv_round_to_clusters(BlockDriverState *bs,
431 432 433
                            int64_t offset, unsigned int bytes,
                            int64_t *cluster_offset,
                            unsigned int *cluster_bytes);
P
pbrook 已提交
434

435
const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
P
pbrook 已提交
436 437
void bdrv_get_backing_filename(BlockDriverState *bs,
                               char *filename, int filename_size);
438
void bdrv_get_full_backing_filename(BlockDriverState *bs,
439
                                    char *dest, size_t sz, Error **errp);
440 441
void bdrv_get_full_backing_filename_from_filename(const char *backed,
                                                  const char *backing,
442 443
                                                  char *dest, size_t sz,
                                                  Error **errp);
P
pbrook 已提交
444

445
int path_has_protocol(const char *path);
P
pbrook 已提交
446 447 448 449 450
int path_is_absolute(const char *path);
void path_combine(char *dest, int dest_size,
                  const char *base_path,
                  const char *filename);

451
int bdrv_readv_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
452
int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
453 454
int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
                      int64_t pos, int size);
455

456 457
int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
                      int64_t pos, int size);
458

459 460
void bdrv_img_create(const char *filename, const char *fmt,
                     const char *base_filename, const char *base_fmt,
461 462
                     char *options, uint64_t img_size, int flags,
                     Error **errp, bool quiet);
J
Jes Sorensen 已提交
463

464 465
/* Returns the alignment in bytes that is required so that no bounce buffer
 * is required throughout the stack */
466 467
size_t bdrv_min_mem_align(BlockDriverState *bs);
/* Returns optimal alignment in bytes for bounce buffer */
468
size_t bdrv_opt_mem_align(BlockDriverState *bs);
469
void *qemu_blockalign(BlockDriverState *bs, size_t size);
M
Max Reitz 已提交
470
void *qemu_blockalign0(BlockDriverState *bs, size_t size);
471
void *qemu_try_blockalign(BlockDriverState *bs, size_t size);
M
Max Reitz 已提交
472
void *qemu_try_blockalign0(BlockDriverState *bs, size_t size);
473
bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
474

475 476 477
void bdrv_enable_copy_on_read(BlockDriverState *bs);
void bdrv_disable_copy_on_read(BlockDriverState *bs);

478 479
void bdrv_ref(BlockDriverState *bs);
void bdrv_unref(BlockDriverState *bs);
K
Kevin Wolf 已提交
480
void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child);
481 482 483 484
BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs,
                             BlockDriverState *child_bs,
                             const char *child_name,
                             const BdrvChildRole *child_role);
K
Kevin Wolf 已提交
485

486 487 488 489 490 491 492
bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp);
void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason);
void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason);
void bdrv_op_block_all(BlockDriverState *bs, Error *reason);
void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason);
bool bdrv_op_blocker_is_empty(BlockDriverState *bs);

K
Kevin Wolf 已提交
493 494 495 496 497 498 499
#define BLKDBG_EVENT(child, evt) \
    do { \
        if (child) { \
            bdrv_debug_event(child->bs, evt); \
        } \
    } while (0)

500
void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event);
K
Kevin Wolf 已提交
501

K
Kevin Wolf 已提交
502 503
int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
                           const char *tag);
F
Fam Zheng 已提交
504
int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag);
K
Kevin Wolf 已提交
505 506 507
int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);

508 509 510 511 512 513 514
/**
 * bdrv_get_aio_context:
 *
 * Returns: the currently bound #AioContext
 */
AioContext *bdrv_get_aio_context(BlockDriverState *bs);

515 516 517 518 519 520
/**
 * bdrv_set_aio_context:
 *
 * Changes the #AioContext used for fd handlers, timers, and BHs by this
 * BlockDriverState and all its children.
 *
521
 * This function must be called with iothread lock held.
522 523
 */
void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context);
524 525
int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz);
int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo);
526

527 528 529
void bdrv_io_plug(BlockDriverState *bs);
void bdrv_io_unplug(BlockDriverState *bs);

530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
/**
 * bdrv_drained_begin:
 *
 * Begin a quiesced section for exclusive access to the BDS, by disabling
 * external request sources including NBD server and device model. Note that
 * this doesn't block timers or coroutines from submitting more requests, which
 * means block_job_pause is still necessary.
 *
 * This function can be recursive.
 */
void bdrv_drained_begin(BlockDriverState *bs);

/**
 * bdrv_drained_end:
 *
 * End a quiescent section started by bdrv_drained_begin().
 */
void bdrv_drained_end(BlockDriverState *bs);

549 550 551 552
void bdrv_add_child(BlockDriverState *parent, BlockDriverState *child,
                    Error **errp);
void bdrv_del_child(BlockDriverState *parent, BdrvChild *child, Error **errp);

553
#endif