block.h 22.8 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 "qapi/qmp/qobject.h"
11
#include "qapi-types.h"
F
Fam Zheng 已提交
12
#include "qemu/hbitmap.h"
13

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

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 已提交
26
    bool is_dirty;
27 28
    /*
     * True if unallocated blocks read back as zeroes. This is equivalent
29
     * to the LBPRZ flag in the SCSI logical block provisioning page.
30 31 32 33 34 35 36 37 38 39 40 41 42
     */
    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
     * fail. Therefore we have to use bdrv_write_zeroes with the
     * 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;
43 44 45 46
    /*
     * True if this block driver only supports compressed writes
     */
    bool needs_compressed_writes;
P
pbrook 已提交
47 48
} BlockDriverInfo;

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

P
Peter Lieven 已提交
56
typedef enum {
57 58
    BDRV_REQ_COPY_ON_READ       = 0x1,
    BDRV_REQ_ZERO_WRITE         = 0x2,
59 60 61 62 63 64
    /* 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.
     */
65
    BDRV_REQ_MAY_UNMAP          = 0x4,
66
    BDRV_REQ_NO_SERIALISING     = 0x8,
67
    BDRV_REQ_FUA                = 0x10,
P
Peter Lieven 已提交
68 69
} BdrvRequestFlags;

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

K
Kevin Wolf 已提交
99
#define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
P
pbrook 已提交
100

101 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"


J
Jan Kiszka 已提交
109
#define BDRV_SECTOR_BITS   9
110
#define BDRV_SECTOR_SIZE   (1ULL << BDRV_SECTOR_BITS)
111
#define BDRV_SECTOR_MASK   ~(BDRV_SECTOR_SIZE - 1)
J
Jan Kiszka 已提交
112

113 114 115
#define BDRV_REQUEST_MAX_SECTORS MIN(SIZE_MAX >> BDRV_SECTOR_BITS, \
                                     INT_MAX >> BDRV_SECTOR_BITS)

116 117
/*
 * Allocation status flags
118
 * BDRV_BLOCK_DATA: data is read from a file returned by bdrv_get_block_status.
119
 * BDRV_BLOCK_ZERO: sectors read as zero
120 121
 * BDRV_BLOCK_OFFSET_VALID: sector stored as raw data in a file returned by
 *                          bdrv_get_block_status.
122 123
 * BDRV_BLOCK_ALLOCATED: the content of the block is determined by this
 *                       layer (as opposed to the backing file)
124 125 126
 * 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.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
 *
 * 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
 */
145 146 147 148 149
#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
150 151
#define BDRV_BLOCK_OFFSET_MASK  BDRV_SECTOR_MASK

152 153 154 155 156
typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue;

typedef struct BDRVReopenState {
    BlockDriverState *bs;
    int flags;
157
    QDict *options;
K
Kevin Wolf 已提交
158
    QDict *explicit_options;
159 160 161
    void *opaque;
} BDRVReopenState;

F
Fam Zheng 已提交
162 163 164 165 166 167 168
/*
 * Block operation types
 */
typedef enum BlockOpType {
    BLOCK_OP_TYPE_BACKUP_SOURCE,
    BLOCK_OP_TYPE_BACKUP_TARGET,
    BLOCK_OP_TYPE_CHANGE,
169 170
    BLOCK_OP_TYPE_COMMIT_SOURCE,
    BLOCK_OP_TYPE_COMMIT_TARGET,
F
Fam Zheng 已提交
171 172 173 174 175 176
    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,
177
    BLOCK_OP_TYPE_MIRROR_SOURCE,
F
Fam Zheng 已提交
178
    BLOCK_OP_TYPE_MIRROR_TARGET,
F
Fam Zheng 已提交
179 180
    BLOCK_OP_TYPE_RESIZE,
    BLOCK_OP_TYPE_STREAM,
181
    BLOCK_OP_TYPE_REPLACE,
F
Fam Zheng 已提交
182 183
    BLOCK_OP_TYPE_MAX,
} BlockOpType;
184

185 186
void bdrv_info_print(Monitor *mon, const QObject *data);
void bdrv_info(Monitor *mon, QObject **ret_data);
187 188
void bdrv_stats_print(Monitor *mon, const QObject *data);
void bdrv_info_stats(Monitor *mon, QObject **ret_data);
P
pbrook 已提交
189

190
/* disk I/O throttling */
191
void bdrv_io_limits_enable(BlockDriverState *bs, const char *group);
Z
Zhi Yong Wu 已提交
192
void bdrv_io_limits_disable(BlockDriverState *bs);
193
void bdrv_io_limits_update_group(BlockDriverState *bs, const char *group);
194

P
pbrook 已提交
195
void bdrv_init(void);
196
void bdrv_init_with_whitelist(void);
197
bool bdrv_uses_whitelist(void);
198
BlockDriver *bdrv_find_protocol(const char *filename,
199 200
                                bool allow_protocol_prefix,
                                Error **errp);
P
pbrook 已提交
201
BlockDriver *bdrv_find_format(const char *format_name);
202
int bdrv_create(BlockDriver *drv, const char* filename,
C
Chunyan Liu 已提交
203 204
                QemuOpts *opts, Error **errp);
int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp);
205
BlockDriverState *bdrv_new_root(void);
206
BlockDriverState *bdrv_new(void);
207
void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
208 209 210
void bdrv_replace_in_backing_chain(BlockDriverState *old,
                                   BlockDriverState *new);

K
Kevin Wolf 已提交
211
int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough);
P
Paolo Bonzini 已提交
212
int bdrv_parse_discard_flags(const char *mode, int *flags);
K
Kevin Wolf 已提交
213 214 215 216 217
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 已提交
218
void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd);
219 220
int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options,
                           const char *bdref_key, Error **errp);
221
int bdrv_open(BlockDriverState **pbs, const char *filename,
222
              const char *reference, QDict *options, int flags, Error **errp);
223
BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
224 225
                                    BlockDriverState *bs,
                                    QDict *options, int flags);
226 227 228 229 230 231
int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp);
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);
P
pbrook 已提交
232 233 234 235
int bdrv_read(BlockDriverState *bs, int64_t sector_num,
              uint8_t *buf, int nb_sectors);
int bdrv_write(BlockDriverState *bs, int64_t sector_num,
               const uint8_t *buf, int nb_sectors);
P
Peter Lieven 已提交
236
int bdrv_write_zeroes(BlockDriverState *bs, int64_t sector_num,
237
               int nb_sectors, BdrvRequestFlags flags);
238 239
BlockAIOCB *bdrv_aio_write_zeroes(BlockDriverState *bs, int64_t sector_num,
                                  int nb_sectors, BdrvRequestFlags flags,
240
                                  BlockCompletionFunc *cb, void *opaque);
P
Peter Lieven 已提交
241
int bdrv_make_zero(BlockDriverState *bs, BdrvRequestFlags flags);
P
pbrook 已提交
242 243 244 245
int bdrv_pread(BlockDriverState *bs, int64_t offset,
               void *buf, int count);
int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
                const void *buf, int count);
246
int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov);
K
Kevin Wolf 已提交
247 248
int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
    const void *buf, int count);
K
Kevin Wolf 已提交
249 250
int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
    int nb_sectors, QEMUIOVector *qiov);
251 252
int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
    int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
253
int coroutine_fn bdrv_co_readv_no_serialising(BlockDriverState *bs,
254
    int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
K
Kevin Wolf 已提交
255 256
int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
    int nb_sectors, QEMUIOVector *qiov);
257 258 259 260 261 262 263
/*
 * 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.
 */
int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
264
    int nb_sectors, BdrvRequestFlags flags);
265 266
BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
    const char *backing_file);
267
int bdrv_get_backing_file_depth(BlockDriverState *bs);
M
Max Reitz 已提交
268
void bdrv_refresh_filename(BlockDriverState *bs);
P
pbrook 已提交
269
int bdrv_truncate(BlockDriverState *bs, int64_t offset);
M
Markus Armbruster 已提交
270
int64_t bdrv_nb_sectors(BlockDriverState *bs);
P
pbrook 已提交
271
int64_t bdrv_getlength(BlockDriverState *bs);
272
int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
273
void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
274
void bdrv_refresh_limits(BlockDriverState *bs, Error **errp);
P
pbrook 已提交
275
int bdrv_commit(BlockDriverState *bs);
K
Kevin Wolf 已提交
276 277
int bdrv_change_backing_file(BlockDriverState *bs,
    const char *backing_file, const char *backing_fmt);
278
void bdrv_register(BlockDriver *bdrv);
279
int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
280 281
                           BlockDriverState *base,
                           const char *backing_file_str);
282 283
BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
                                    BlockDriverState *bs);
284
BlockDriverState *bdrv_find_base(BlockDriverState *bs);
285

286 287 288 289 290

typedef struct BdrvCheckResult {
    int corruptions;
    int leaks;
    int check_errors;
291 292
    int corruptions_fixed;
    int leaks_fixed;
293
    int64_t image_end_offset;
294
    BlockFragInfo bfi;
295 296
} BdrvCheckResult;

297 298 299 300 301 302
typedef enum {
    BDRV_FIX_LEAKS    = 1,
    BDRV_FIX_ERRORS   = 2,
} BdrvCheckMode;

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

304 305 306 307
/* 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,
308
                                      int64_t total_work_size, void *opaque);
309
int bdrv_amend_options(BlockDriverState *bs_new, QemuOpts *opts,
310
                       BlockDriverAmendStatusCB *status_cb, void *cb_opaque);
M
Max Reitz 已提交
311

312
/* external snapshots */
313 314 315
bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs,
                                      BlockDriverState *candidate);
bool bdrv_is_first_non_filter(BlockDriverState *candidate);
316

317
/* check if a named node can be replaced when doing drive-mirror */
318 319
BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs,
                                        const char *node_name, Error **errp);
320

P
pbrook 已提交
321
/* async block I/O */
322 323
BlockAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
                           QEMUIOVector *iov, int nb_sectors,
324
                           BlockCompletionFunc *cb, void *opaque);
325 326
BlockAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
                            QEMUIOVector *iov, int nb_sectors,
327
                            BlockCompletionFunc *cb, void *opaque);
328
BlockAIOCB *bdrv_aio_flush(BlockDriverState *bs,
329
                           BlockCompletionFunc *cb, void *opaque);
330 331
BlockAIOCB *bdrv_aio_discard(BlockDriverState *bs,
                             int64_t sector_num, int nb_sectors,
332
                             BlockCompletionFunc *cb, void *opaque);
333 334
void bdrv_aio_cancel(BlockAIOCB *acb);
void bdrv_aio_cancel_async(BlockAIOCB *acb);
P
pbrook 已提交
335

K
Kevin Wolf 已提交
336 337
typedef struct BlockRequest {
    /* Fields to be filled by multiwrite caller */
338 339 340 341 342 343 344 345 346 347 348 349
    union {
        struct {
            int64_t sector;
            int nb_sectors;
            int flags;
            QEMUIOVector *qiov;
        };
        struct {
            int req;
            void *buf;
        };
    };
350
    BlockCompletionFunc *cb;
K
Kevin Wolf 已提交
351 352 353 354 355 356 357 358 359
    void *opaque;

    /* Filled by multiwrite implementation */
    int error;
} BlockRequest;

int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
    int num_reqs);

360
/* sg packet commands */
361
int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
362
BlockAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
363
        unsigned long int req, void *buf,
364
        BlockCompletionFunc *cb, void *opaque);
365

366
/* Invalidate any cached metadata used by image formats */
367 368
void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp);
void bdrv_invalidate_cache_all(Error **errp);
369
int bdrv_inactivate_all(void);
370

P
pbrook 已提交
371
/* Ensure contents are flushed to disk.  */
372
int bdrv_flush(BlockDriverState *bs);
P
Paolo Bonzini 已提交
373
int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
374
void bdrv_close_all(void);
S
Stefan Hajnoczi 已提交
375
void bdrv_drain(BlockDriverState *bs);
376
void bdrv_drain_all(void);
A
aliguori 已提交
377

C
Christoph Hellwig 已提交
378
int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
379
int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
380
int bdrv_has_zero_init_1(BlockDriverState *bs);
K
Kevin Wolf 已提交
381
int bdrv_has_zero_init(BlockDriverState *bs);
382 383
bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs);
bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs);
384
int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num,
385 386
                              int nb_sectors, int *pnum,
                              BlockDriverState **file);
387 388 389
int64_t bdrv_get_block_status_above(BlockDriverState *bs,
                                    BlockDriverState *base,
                                    int64_t sector_num,
390 391
                                    int nb_sectors, int *pnum,
                                    BlockDriverState **file);
392
int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
393
                      int *pnum);
394 395
int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
                            int64_t sector_num, int nb_sectors, int *pnum);
P
pbrook 已提交
396 397

int bdrv_is_read_only(BlockDriverState *bs);
398
int bdrv_is_sg(BlockDriverState *bs);
399
int bdrv_enable_write_cache(BlockDriverState *bs);
400
void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
401
bool bdrv_is_inserted(BlockDriverState *bs);
P
pbrook 已提交
402
int bdrv_media_changed(BlockDriverState *bs);
403
void bdrv_lock_medium(BlockDriverState *bs, bool locked);
404
void bdrv_eject(BlockDriverState *bs, bool eject_flag);
405
const char *bdrv_get_format_name(BlockDriverState *bs);
406
BlockDriverState *bdrv_find_node(const char *node_name);
407
BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp);
408 409 410
BlockDriverState *bdrv_lookup_bs(const char *device,
                                 const char *node_name,
                                 Error **errp);
411
bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base);
F
Fam Zheng 已提交
412
BlockDriverState *bdrv_next_node(BlockDriverState *bs);
M
Markus Armbruster 已提交
413
BlockDriverState *bdrv_next(BlockDriverState *bs);
M
Max Reitz 已提交
414
BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs);
P
pbrook 已提交
415
int bdrv_is_encrypted(BlockDriverState *bs);
416
int bdrv_key_required(BlockDriverState *bs);
P
pbrook 已提交
417
int bdrv_set_key(BlockDriverState *bs, const char *key);
418
void bdrv_add_key(BlockDriverState *bs, const char *key, Error **errp);
419
int bdrv_query_missing_keys(void);
P
pbrook 已提交
420 421
void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
                         void *opaque);
F
Fam Zheng 已提交
422
const char *bdrv_get_node_name(const BlockDriverState *bs);
423
const char *bdrv_get_device_name(const BlockDriverState *bs);
424
const char *bdrv_get_device_or_node_name(const BlockDriverState *bs);
M
Markus Armbruster 已提交
425
int bdrv_get_flags(BlockDriverState *bs);
P
pbrook 已提交
426 427 428
int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
                          const uint8_t *buf, int nb_sectors);
int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
M
Max Reitz 已提交
429
ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs);
430 431 432 433
void bdrv_round_to_clusters(BlockDriverState *bs,
                            int64_t sector_num, int nb_sectors,
                            int64_t *cluster_sector_num,
                            int *cluster_nb_sectors);
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);
444
int bdrv_is_snapshot(BlockDriverState *bs);
P
pbrook 已提交
445

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

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);
K
Kevin Wolf 已提交
481

482 483 484 485 486 487 488
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 已提交
489 490 491 492 493 494 495
#define BLKDBG_EVENT(child, evt) \
    do { \
        if (child) { \
            bdrv_debug_event(child->bs, evt); \
        } \
    } while (0)

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

K
Kevin Wolf 已提交
498 499
int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
                           const char *tag);
F
Fam Zheng 已提交
500
int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag);
K
Kevin Wolf 已提交
501 502 503
int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);

504 505 506 507 508 509 510
/**
 * bdrv_get_aio_context:
 *
 * Returns: the currently bound #AioContext
 */
AioContext *bdrv_get_aio_context(BlockDriverState *bs);

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

523 524 525 526
void bdrv_io_plug(BlockDriverState *bs);
void bdrv_io_unplug(BlockDriverState *bs);
void bdrv_flush_io_queue(BlockDriverState *bs);

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
/**
 * 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);

546
#endif