]> Git Repo - qemu.git/blame - include/block/block.h
Merge remote-tracking branch 'remotes/mst/tags/for_upstream' into staging
[qemu.git] / include / block / block.h
CommitLineData
faf07963
PB
1#ifndef BLOCK_H
2#define BLOCK_H
3
737e150e 4#include "block/aio.h"
3b69e4b9 5#include "qemu-common.h"
1de7afc9 6#include "qemu/option.h"
10817bf0 7#include "qemu/coroutine.h"
5366d0c8 8#include "block/accounting.h"
ebab2259 9#include "block/dirty-bitmap.h"
7b1b5d19 10#include "qapi/qmp/qobject.h"
2f0c9fe6 11#include "qapi-types.h"
78f9dc85 12#include "qemu/hbitmap.h"
a76bab49 13
faf07963 14/* block.c */
faf07963 15typedef struct BlockDriver BlockDriver;
2f0c9fe6 16typedef struct BlockJob BlockJob;
b4b059f6 17typedef struct BdrvChild BdrvChild;
f3930ed0 18typedef struct BdrvChildRole BdrvChildRole;
c55a832f 19typedef struct BlockJobTxn BlockJobTxn;
faf07963 20
faf07963
PB
21typedef struct BlockDriverInfo {
22 /* in bytes, 0 if irrelevant */
23 int cluster_size;
24 /* offset at which the VM state can be saved (0 if not possible) */
25 int64_t vm_state_offset;
64c79160 26 bool is_dirty;
e1a5c4be
PL
27 /*
28 * True if unallocated blocks read back as zeroes. This is equivalent
b6af0975 29 * to the LBPRZ flag in the SCSI logical block provisioning page.
e1a5c4be
PL
30 */
31 bool unallocated_blocks_are_zero;
32 /*
33 * True if the driver can optimize writing zeroes by unmapping
34 * sectors. This is equivalent to the BLKDISCARDZEROES ioctl in Linux
35 * with the difference that in qemu a discard is allowed to silently
36 * fail. Therefore we have to use bdrv_write_zeroes with the
37 * BDRV_REQ_MAY_UNMAP flag for an optimized zero write with unmapping.
38 * After this call the driver has to guarantee that the contents read
39 * back as zero. It is additionally required that the block device is
40 * opened with BDRV_O_UNMAP flag for this to work.
41 */
42 bool can_write_zeroes_with_unmap;
85f49cad
FZ
43 /*
44 * True if this block driver only supports compressed writes
45 */
46 bool needs_compressed_writes;
faf07963
PB
47} BlockDriverInfo;
48
f8111c24
DXW
49typedef struct BlockFragInfo {
50 uint64_t allocated_clusters;
51 uint64_t total_clusters;
52 uint64_t fragmented_clusters;
e6439d78 53 uint64_t compressed_clusters;
f8111c24
DXW
54} BlockFragInfo;
55
6faac15f 56typedef enum {
9568b511
WC
57 BDRV_REQ_COPY_ON_READ = 0x1,
58 BDRV_REQ_ZERO_WRITE = 0x2,
d32f35cb
PL
59 /* The BDRV_REQ_MAY_UNMAP flag is used to indicate that the block driver
60 * is allowed to optimize a write zeroes request by unmapping (discarding)
61 * blocks if it is guaranteed that the result will read back as
62 * zeroes. The flag is only passed to the driver if the block device is
63 * opened with BDRV_O_UNMAP.
64 */
9568b511 65 BDRV_REQ_MAY_UNMAP = 0x4,
61408b25 66 BDRV_REQ_NO_SERIALISING = 0x8,
6faac15f
PL
67} BdrvRequestFlags;
68
892b7de8
ET
69typedef struct BlockSizes {
70 uint32_t phys;
71 uint32_t log;
72} BlockSizes;
73
74typedef struct HDGeometry {
75 uint32_t heads;
76 uint32_t sectors;
77 uint32_t cylinders;
78} HDGeometry;
79
faf07963 80#define BDRV_O_RDWR 0x0002
faf07963 81#define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
8bfea15d 82#define BDRV_O_TEMPORARY 0x0010 /* delete the file after use */
9f7965c7
AL
83#define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
84#define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
5c6c3a6c 85#define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
b783e409 86#define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
016f5cf6 87#define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
53fec9d3 88#define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
04c01a5c 89#define BDRV_O_INACTIVE 0x0800 /* consistency hint for migration handoff */
058f8f16 90#define BDRV_O_CHECK 0x1000 /* open solely for consistency check */
be028adc 91#define BDRV_O_ALLOW_RDWR 0x2000 /* allow reopen to change from r/o to r/w */
9e8f1835 92#define BDRV_O_UNMAP 0x4000 /* execute guest UNMAP/TRIM operations */
2e40134b
HR
93#define BDRV_O_PROTOCOL 0x8000 /* if no block driver is explicitly given:
94 select an appropriate protocol driver,
95 ignoring the format layer */
9f7965c7 96
ceb25e5c 97#define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
faf07963 98
54861b92
KW
99
100/* Option names of options parsed by the block layer */
101
102#define BDRV_OPT_CACHE_WB "cache.writeback"
103#define BDRV_OPT_CACHE_DIRECT "cache.direct"
104#define BDRV_OPT_CACHE_NO_FLUSH "cache.no-flush"
105
106
6ea44308 107#define BDRV_SECTOR_BITS 9
c63782cb 108#define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
3abbc4d9 109#define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
6ea44308 110
75af1f34
PL
111#define BDRV_REQUEST_MAX_SECTORS MIN(SIZE_MAX >> BDRV_SECTOR_BITS, \
112 INT_MAX >> BDRV_SECTOR_BITS)
113
705be728
FZ
114/*
115 * Allocation status flags
67a0fd2a 116 * BDRV_BLOCK_DATA: data is read from a file returned by bdrv_get_block_status.
4333bb71 117 * BDRV_BLOCK_ZERO: sectors read as zero
67a0fd2a
FZ
118 * BDRV_BLOCK_OFFSET_VALID: sector stored as raw data in a file returned by
119 * bdrv_get_block_status.
e88ae226
KW
120 * BDRV_BLOCK_ALLOCATED: the content of the block is determined by this
121 * layer (as opposed to the backing file)
92bc50a5
PL
122 * BDRV_BLOCK_RAW: used internally to indicate that the request
123 * was answered by the raw driver and that one
124 * should look in bs->file directly.
4333bb71
PB
125 *
126 * If BDRV_BLOCK_OFFSET_VALID is set, bits 9-62 represent the offset in
127 * bs->file where sector data can be read from as raw data.
128 *
129 * DATA == 0 && ZERO == 0 means that data is read from backing_hd if present.
130 *
131 * DATA ZERO OFFSET_VALID
132 * t t t sectors read as zero, bs->file is zero at offset
133 * t f t sectors read as valid from bs->file at offset
134 * f t t sectors preallocated, read as zero, bs->file not
135 * necessarily zero at offset
136 * f f t sectors preallocated but read from backing_hd,
137 * bs->file contains garbage at offset
138 * t t f sectors preallocated, read as zero, unknown offset
139 * t f f sectors read from unknown file or offset
140 * f t f not allocated or unknown offset, read as zero
141 * f f f not allocated or unknown offset, read from backing_hd
142 */
e88ae226
KW
143#define BDRV_BLOCK_DATA 0x01
144#define BDRV_BLOCK_ZERO 0x02
145#define BDRV_BLOCK_OFFSET_VALID 0x04
146#define BDRV_BLOCK_RAW 0x08
147#define BDRV_BLOCK_ALLOCATED 0x10
4333bb71
PB
148#define BDRV_BLOCK_OFFSET_MASK BDRV_SECTOR_MASK
149
e971aa12
JC
150typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue;
151
152typedef struct BDRVReopenState {
153 BlockDriverState *bs;
154 int flags;
4d2cb092 155 QDict *options;
145f598e 156 QDict *explicit_options;
e971aa12
JC
157 void *opaque;
158} BDRVReopenState;
159
8574575f
FZ
160/*
161 * Block operation types
162 */
163typedef enum BlockOpType {
164 BLOCK_OP_TYPE_BACKUP_SOURCE,
165 BLOCK_OP_TYPE_BACKUP_TARGET,
166 BLOCK_OP_TYPE_CHANGE,
bb00021d
FZ
167 BLOCK_OP_TYPE_COMMIT_SOURCE,
168 BLOCK_OP_TYPE_COMMIT_TARGET,
8574575f
FZ
169 BLOCK_OP_TYPE_DATAPLANE,
170 BLOCK_OP_TYPE_DRIVE_DEL,
171 BLOCK_OP_TYPE_EJECT,
172 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
173 BLOCK_OP_TYPE_INTERNAL_SNAPSHOT,
174 BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE,
05e4d14b 175 BLOCK_OP_TYPE_MIRROR_SOURCE,
e40e5027 176 BLOCK_OP_TYPE_MIRROR_TARGET,
8574575f
FZ
177 BLOCK_OP_TYPE_RESIZE,
178 BLOCK_OP_TYPE_STREAM,
09158f00 179 BLOCK_OP_TYPE_REPLACE,
8574575f
FZ
180 BLOCK_OP_TYPE_MAX,
181} BlockOpType;
e971aa12 182
d15e5465
LC
183void bdrv_info_print(Monitor *mon, const QObject *data);
184void bdrv_info(Monitor *mon, QObject **ret_data);
218a536a
LC
185void bdrv_stats_print(Monitor *mon, const QObject *data);
186void bdrv_info_stats(Monitor *mon, QObject **ret_data);
faf07963 187
0563e191 188/* disk I/O throttling */
76f4afb4 189void bdrv_io_limits_enable(BlockDriverState *bs, const char *group);
98f90dba 190void bdrv_io_limits_disable(BlockDriverState *bs);
76f4afb4 191void bdrv_io_limits_update_group(BlockDriverState *bs, const char *group);
0563e191 192
faf07963 193void bdrv_init(void);
eb852011 194void bdrv_init_with_whitelist(void);
98289620 195BlockDriver *bdrv_find_protocol(const char *filename,
b65a5e12
HR
196 bool allow_protocol_prefix,
197 Error **errp);
faf07963 198BlockDriver *bdrv_find_format(const char *format_name);
0e7e1989 199int bdrv_create(BlockDriver *drv, const char* filename,
c282e1fd
CL
200 QemuOpts *opts, Error **errp);
201int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp);
7f06d47e 202BlockDriverState *bdrv_new_root(void);
e4e9986b 203BlockDriverState *bdrv_new(void);
f8aa905a 204void bdrv_device_remove(BlockDriverState *bs);
d22b2f41 205void bdrv_make_anon(BlockDriverState *bs);
8802d1fd 206void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
3f09bfbc
KW
207void bdrv_replace_in_backing_chain(BlockDriverState *old,
208 BlockDriverState *new);
209
c3993cdc 210int bdrv_parse_cache_flags(const char *mode, int *flags);
9e8f1835 211int bdrv_parse_discard_flags(const char *mode, int *flags);
b4b059f6
KW
212BdrvChild *bdrv_open_child(const char *filename,
213 QDict *options, const char *bdref_key,
214 BlockDriverState* parent,
215 const BdrvChildRole *child_role,
216 bool allow_none, Error **errp);
8d24cce1 217void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd);
d9b7b057
KW
218int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options,
219 const char *bdref_key, Error **errp);
ddf5636d 220int bdrv_open(BlockDriverState **pbs, const char *filename,
6ebf9aa2 221 const char *reference, QDict *options, int flags, Error **errp);
e971aa12 222BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
4d2cb092
KW
223 BlockDriverState *bs,
224 QDict *options, int flags);
e971aa12
JC
225int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp);
226int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
227int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
228 BlockReopenQueue *queue, Error **errp);
229void bdrv_reopen_commit(BDRVReopenState *reopen_state);
230void bdrv_reopen_abort(BDRVReopenState *reopen_state);
faf07963
PB
231int bdrv_read(BlockDriverState *bs, int64_t sector_num,
232 uint8_t *buf, int nb_sectors);
07d27a44
MA
233int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
234 uint8_t *buf, int nb_sectors);
faf07963
PB
235int bdrv_write(BlockDriverState *bs, int64_t sector_num,
236 const uint8_t *buf, int nb_sectors);
4105eaaa 237int bdrv_write_zeroes(BlockDriverState *bs, int64_t sector_num,
aa7bfbff 238 int nb_sectors, BdrvRequestFlags flags);
7c84b1b8
MA
239BlockAIOCB *bdrv_aio_write_zeroes(BlockDriverState *bs, int64_t sector_num,
240 int nb_sectors, BdrvRequestFlags flags,
097310b5 241 BlockCompletionFunc *cb, void *opaque);
d75cbb5e 242int bdrv_make_zero(BlockDriverState *bs, BdrvRequestFlags flags);
faf07963
PB
243int bdrv_pread(BlockDriverState *bs, int64_t offset,
244 void *buf, int count);
245int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
246 const void *buf, int count);
8d3b1a2d 247int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov);
f08145fe
KW
248int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
249 const void *buf, int count);
da1fa91d
KW
250int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
251 int nb_sectors, QEMUIOVector *qiov);
470c0504
SH
252int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
253 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
61408b25 254int coroutine_fn bdrv_co_readv_no_serialising(BlockDriverState *bs,
9568b511 255 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
da1fa91d
KW
256int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
257 int nb_sectors, QEMUIOVector *qiov);
f08f2dda
SH
258/*
259 * Efficiently zero a region of the disk image. Note that this is a regular
260 * I/O request like read or write and should have a reasonable size. This
261 * function is not suitable for zeroing the entire image in a single request
262 * because it may allocate memory for the entire region.
263 */
264int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
aa7bfbff 265 int nb_sectors, BdrvRequestFlags flags);
e8a6bb9c
MT
266BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
267 const char *backing_file);
f198fd1c 268int bdrv_get_backing_file_depth(BlockDriverState *bs);
91af7014 269void bdrv_refresh_filename(BlockDriverState *bs);
faf07963 270int bdrv_truncate(BlockDriverState *bs, int64_t offset);
65a9bb25 271int64_t bdrv_nb_sectors(BlockDriverState *bs);
faf07963 272int64_t bdrv_getlength(BlockDriverState *bs);
4a1d5e1f 273int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
96b8f136 274void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
3baca891 275void bdrv_refresh_limits(BlockDriverState *bs, Error **errp);
faf07963 276int bdrv_commit(BlockDriverState *bs);
e8877497 277int bdrv_commit_all(void);
756e6736
KW
278int bdrv_change_backing_file(BlockDriverState *bs,
279 const char *backing_file, const char *backing_fmt);
5efa9d5a 280void bdrv_register(BlockDriver *bdrv);
6ebdcee2 281int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
54e26900
JC
282 BlockDriverState *base,
283 const char *backing_file_str);
6ebdcee2
JC
284BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
285 BlockDriverState *bs);
79fac568 286BlockDriverState *bdrv_find_base(BlockDriverState *bs);
5efa9d5a 287
e076f338
KW
288
289typedef struct BdrvCheckResult {
290 int corruptions;
291 int leaks;
292 int check_errors;
ccf34716
KW
293 int corruptions_fixed;
294 int leaks_fixed;
c6bb9ad1 295 int64_t image_end_offset;
f8111c24 296 BlockFragInfo bfi;
e076f338
KW
297} BdrvCheckResult;
298
4534ff54
KW
299typedef enum {
300 BDRV_FIX_LEAKS = 1,
301 BDRV_FIX_ERRORS = 2,
302} BdrvCheckMode;
303
304int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
e076f338 305
77485434
HR
306/* The units of offset and total_work_size may be chosen arbitrarily by the
307 * block driver; total_work_size may change during the course of the amendment
308 * operation */
309typedef void BlockDriverAmendStatusCB(BlockDriverState *bs, int64_t offset,
8b13976d 310 int64_t total_work_size, void *opaque);
77485434 311int bdrv_amend_options(BlockDriverState *bs_new, QemuOpts *opts,
8b13976d 312 BlockDriverAmendStatusCB *status_cb, void *cb_opaque);
6f176b48 313
f6186f49 314/* external snapshots */
212a5a8f
BC
315bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs,
316 BlockDriverState *candidate);
317bool bdrv_is_first_non_filter(BlockDriverState *candidate);
f6186f49 318
09158f00 319/* check if a named node can be replaced when doing drive-mirror */
e12f3784
WC
320BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs,
321 const char *node_name, Error **errp);
09158f00 322
faf07963 323/* async block I/O */
7c84b1b8
MA
324BlockAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
325 QEMUIOVector *iov, int nb_sectors,
097310b5 326 BlockCompletionFunc *cb, void *opaque);
7c84b1b8
MA
327BlockAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
328 QEMUIOVector *iov, int nb_sectors,
097310b5 329 BlockCompletionFunc *cb, void *opaque);
7c84b1b8 330BlockAIOCB *bdrv_aio_flush(BlockDriverState *bs,
097310b5 331 BlockCompletionFunc *cb, void *opaque);
7c84b1b8
MA
332BlockAIOCB *bdrv_aio_discard(BlockDriverState *bs,
333 int64_t sector_num, int nb_sectors,
097310b5 334 BlockCompletionFunc *cb, void *opaque);
7c84b1b8
MA
335void bdrv_aio_cancel(BlockAIOCB *acb);
336void bdrv_aio_cancel_async(BlockAIOCB *acb);
faf07963 337
40b4f539
KW
338typedef struct BlockRequest {
339 /* Fields to be filled by multiwrite caller */
8b45f687
FZ
340 union {
341 struct {
342 int64_t sector;
343 int nb_sectors;
344 int flags;
345 QEMUIOVector *qiov;
346 };
347 struct {
348 int req;
349 void *buf;
350 };
351 };
097310b5 352 BlockCompletionFunc *cb;
40b4f539
KW
353 void *opaque;
354
355 /* Filled by multiwrite implementation */
356 int error;
357} BlockRequest;
358
359int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
360 int num_reqs);
361
7d780669 362/* sg packet commands */
221f715d 363int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
7c84b1b8 364BlockAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
221f715d 365 unsigned long int req, void *buf,
097310b5 366 BlockCompletionFunc *cb, void *opaque);
7d780669 367
0f15423c 368/* Invalidate any cached metadata used by image formats */
5a8a30db
KW
369void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp);
370void bdrv_invalidate_cache_all(Error **errp);
76b1c7fe 371int bdrv_inactivate_all(void);
0f15423c 372
faf07963 373/* Ensure contents are flushed to disk. */
205ef796 374int bdrv_flush(BlockDriverState *bs);
07f07615 375int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
f0f0fdfe 376int bdrv_flush_all(void);
2bc93fed 377void bdrv_close_all(void);
5b98db0a 378void bdrv_drain(BlockDriverState *bs);
922453bc 379void bdrv_drain_all(void);
c6ca28d6 380
bb8bf76f 381int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
4265d620 382int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
3ac21627 383int bdrv_has_zero_init_1(BlockDriverState *bs);
f2feebbd 384int bdrv_has_zero_init(BlockDriverState *bs);
4ce78691
PL
385bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs);
386bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs);
b6b8a333 387int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num,
67a0fd2a
FZ
388 int nb_sectors, int *pnum,
389 BlockDriverState **file);
ba3f0e25
FZ
390int64_t bdrv_get_block_status_above(BlockDriverState *bs,
391 BlockDriverState *base,
392 int64_t sector_num,
67a0fd2a
FZ
393 int nb_sectors, int *pnum,
394 BlockDriverState **file);
f58c7b35 395int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
39aa9a12 396 int *pnum);
b35b2bba
MR
397int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
398 int64_t sector_num, int nb_sectors, int *pnum);
faf07963 399
faf07963 400int bdrv_is_read_only(BlockDriverState *bs);
985a03b0 401int bdrv_is_sg(BlockDriverState *bs);
e900a7b7 402int bdrv_enable_write_cache(BlockDriverState *bs);
425b0148 403void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
e031f750 404bool bdrv_is_inserted(BlockDriverState *bs);
faf07963 405int bdrv_media_changed(BlockDriverState *bs);
025e849a 406void bdrv_lock_medium(BlockDriverState *bs, bool locked);
f36f3949 407void bdrv_eject(BlockDriverState *bs, bool eject_flag);
f8d6bba1 408const char *bdrv_get_format_name(BlockDriverState *bs);
dc364f4c 409BlockDriverState *bdrv_find_node(const char *node_name);
d5a8ee60 410BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp);
12d3ba82
BC
411BlockDriverState *bdrv_lookup_bs(const char *device,
412 const char *node_name,
413 Error **errp);
5a6684d2 414bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base);
04df765a 415BlockDriverState *bdrv_next_node(BlockDriverState *bs);
2f399b0a 416BlockDriverState *bdrv_next(BlockDriverState *bs);
faf07963 417int bdrv_is_encrypted(BlockDriverState *bs);
c0f4ce77 418int bdrv_key_required(BlockDriverState *bs);
faf07963 419int bdrv_set_key(BlockDriverState *bs, const char *key);
4d2855a3 420void bdrv_add_key(BlockDriverState *bs, const char *key, Error **errp);
c0f4ce77 421int bdrv_query_missing_keys(void);
faf07963
PB
422void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
423 void *opaque);
20a9e77d 424const char *bdrv_get_node_name(const BlockDriverState *bs);
bfb197e0 425const char *bdrv_get_device_name(const BlockDriverState *bs);
9b2aa84f 426const char *bdrv_get_device_or_node_name(const BlockDriverState *bs);
c8433287 427int bdrv_get_flags(BlockDriverState *bs);
faf07963
PB
428int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
429 const uint8_t *buf, int nb_sectors);
430int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
eae041fe 431ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs);
343bded4
PB
432void bdrv_round_to_clusters(BlockDriverState *bs,
433 int64_t sector_num, int nb_sectors,
434 int64_t *cluster_sector_num,
435 int *cluster_nb_sectors);
faf07963 436
045df330 437const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
faf07963
PB
438void bdrv_get_backing_filename(BlockDriverState *bs,
439 char *filename, int filename_size);
dc5a1371 440void bdrv_get_full_backing_filename(BlockDriverState *bs,
9f07429e 441 char *dest, size_t sz, Error **errp);
0a82855a
HR
442void bdrv_get_full_backing_filename_from_filename(const char *backed,
443 const char *backing,
9f07429e
HR
444 char *dest, size_t sz,
445 Error **errp);
199630b6 446int bdrv_is_snapshot(BlockDriverState *bs);
faf07963 447
5c98415b 448int path_has_protocol(const char *path);
faf07963
PB
449int path_is_absolute(const char *path);
450void path_combine(char *dest, int dest_size,
451 const char *base_path,
452 const char *filename);
453
cf8074b3 454int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
45566e9c
CH
455int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
456 int64_t pos, int size);
178e08a5 457
45566e9c
CH
458int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
459 int64_t pos, int size);
178e08a5 460
d92ada22
LC
461void bdrv_img_create(const char *filename, const char *fmt,
462 const char *base_filename, const char *base_fmt,
f382d43a
MR
463 char *options, uint64_t img_size, int flags,
464 Error **errp, bool quiet);
f88e1a42 465
339064d5
KW
466/* Returns the alignment in bytes that is required so that no bounce buffer
467 * is required throughout the stack */
4196d2f0
DL
468size_t bdrv_min_mem_align(BlockDriverState *bs);
469/* Returns optimal alignment in bytes for bounce buffer */
339064d5 470size_t bdrv_opt_mem_align(BlockDriverState *bs);
ba5b7ad4 471void *qemu_blockalign(BlockDriverState *bs, size_t size);
9ebd8448 472void *qemu_blockalign0(BlockDriverState *bs, size_t size);
7d2a35cc 473void *qemu_try_blockalign(BlockDriverState *bs, size_t size);
9ebd8448 474void *qemu_try_blockalign0(BlockDriverState *bs, size_t size);
c53b1c51 475bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
ba5b7ad4 476
53fec9d3
SH
477void bdrv_enable_copy_on_read(BlockDriverState *bs);
478void bdrv_disable_copy_on_read(BlockDriverState *bs);
479
9fcb0251
FZ
480void bdrv_ref(BlockDriverState *bs);
481void bdrv_unref(BlockDriverState *bs);
33a60407 482void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child);
8b9b0cc2 483
fbe40ff7
FZ
484bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp);
485void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason);
486void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason);
487void bdrv_op_block_all(BlockDriverState *bs, Error *reason);
488void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason);
489bool bdrv_op_blocker_is_empty(BlockDriverState *bs);
490
9a4f4c31
KW
491#define BLKDBG_EVENT(child, evt) \
492 do { \
493 if (child) { \
494 bdrv_debug_event(child->bs, evt); \
495 } \
496 } while (0)
497
a31939e6 498void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event);
8b9b0cc2 499
41c695c7
KW
500int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
501 const char *tag);
4cc70e93 502int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag);
41c695c7
KW
503int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
504bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);
505
db519cba
FZ
506/**
507 * bdrv_get_aio_context:
508 *
509 * Returns: the currently bound #AioContext
510 */
511AioContext *bdrv_get_aio_context(BlockDriverState *bs);
512
dcd04228
SH
513/**
514 * bdrv_set_aio_context:
515 *
516 * Changes the #AioContext used for fd handlers, timers, and BHs by this
517 * BlockDriverState and all its children.
518 *
2e5b887c 519 * This function must be called with iothread lock held.
dcd04228
SH
520 */
521void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context);
892b7de8
ET
522int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz);
523int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo);
dcd04228 524
448ad91d
ML
525void bdrv_io_plug(BlockDriverState *bs);
526void bdrv_io_unplug(BlockDriverState *bs);
527void bdrv_flush_io_queue(BlockDriverState *bs);
528
51288d79
FZ
529/**
530 * bdrv_drained_begin:
531 *
532 * Begin a quiesced section for exclusive access to the BDS, by disabling
533 * external request sources including NBD server and device model. Note that
534 * this doesn't block timers or coroutines from submitting more requests, which
535 * means block_job_pause is still necessary.
536 *
537 * This function can be recursive.
538 */
539void bdrv_drained_begin(BlockDriverState *bs);
540
541/**
542 * bdrv_drained_end:
543 *
544 * End a quiescent section started by bdrv_drained_begin().
545 */
546void bdrv_drained_end(BlockDriverState *bs);
547
8a4bc5aa 548#endif
This page took 0.635538 seconds and 4 git commands to generate.