]> git.proxmox.com Git - mirror_qemu.git/blame - include/block/block.h
qemu-img: call aio_context_acquire/release around block job
[mirror_qemu.git] / include / block / block.h
CommitLineData
faf07963
PB
1#ifndef BLOCK_H
2#define BLOCK_H
3
737e150e 4#include "block/aio.h"
daf015ef 5#include "qemu/iov.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
74021bc4 36 * fail. Therefore we have to use bdrv_pwrite_zeroes with the
e1a5c4be
PL
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,
bfd18d1e 67 BDRV_REQ_FUA = 0x10,
29a298af 68 BDRV_REQ_WRITE_COMPRESSED = 0x20,
fa166538
EB
69
70 /* Mask of valid flags */
29a298af 71 BDRV_REQ_MASK = 0x3f,
6faac15f
PL
72} BdrvRequestFlags;
73
892b7de8
ET
74typedef struct BlockSizes {
75 uint32_t phys;
76 uint32_t log;
77} BlockSizes;
78
79typedef struct HDGeometry {
80 uint32_t heads;
81 uint32_t sectors;
82 uint32_t cylinders;
83} HDGeometry;
84
faf07963 85#define BDRV_O_RDWR 0x0002
faf07963 86#define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
8bfea15d 87#define BDRV_O_TEMPORARY 0x0010 /* delete the file after use */
9f7965c7 88#define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
5c6c3a6c 89#define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
b783e409 90#define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
016f5cf6 91#define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
53fec9d3 92#define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
04c01a5c 93#define BDRV_O_INACTIVE 0x0800 /* consistency hint for migration handoff */
058f8f16 94#define BDRV_O_CHECK 0x1000 /* open solely for consistency check */
be028adc 95#define BDRV_O_ALLOW_RDWR 0x2000 /* allow reopen to change from r/o to r/w */
9e8f1835 96#define BDRV_O_UNMAP 0x4000 /* execute guest UNMAP/TRIM operations */
2e40134b
HR
97#define BDRV_O_PROTOCOL 0x8000 /* if no block driver is explicitly given:
98 select an appropriate protocol driver,
99 ignoring the format layer */
abb06c5a 100#define BDRV_O_NO_IO 0x10000 /* don't initialize for I/O */
9f7965c7 101
61de4c68 102#define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_NO_FLUSH)
faf07963 103
54861b92
KW
104
105/* Option names of options parsed by the block layer */
106
107#define BDRV_OPT_CACHE_WB "cache.writeback"
108#define BDRV_OPT_CACHE_DIRECT "cache.direct"
109#define BDRV_OPT_CACHE_NO_FLUSH "cache.no-flush"
f87a0e29 110#define BDRV_OPT_READ_ONLY "read-only"
818584a4 111#define BDRV_OPT_DISCARD "discard"
54861b92
KW
112
113
6ea44308 114#define BDRV_SECTOR_BITS 9
c63782cb 115#define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
3abbc4d9 116#define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
6ea44308 117
75af1f34
PL
118#define BDRV_REQUEST_MAX_SECTORS MIN(SIZE_MAX >> BDRV_SECTOR_BITS, \
119 INT_MAX >> BDRV_SECTOR_BITS)
120
705be728
FZ
121/*
122 * Allocation status flags
67a0fd2a 123 * BDRV_BLOCK_DATA: data is read from a file returned by bdrv_get_block_status.
4333bb71 124 * BDRV_BLOCK_ZERO: sectors read as zero
67a0fd2a
FZ
125 * BDRV_BLOCK_OFFSET_VALID: sector stored as raw data in a file returned by
126 * bdrv_get_block_status.
e88ae226
KW
127 * BDRV_BLOCK_ALLOCATED: the content of the block is determined by this
128 * layer (as opposed to the backing file)
92bc50a5
PL
129 * BDRV_BLOCK_RAW: used internally to indicate that the request
130 * was answered by the raw driver and that one
131 * should look in bs->file directly.
4333bb71
PB
132 *
133 * If BDRV_BLOCK_OFFSET_VALID is set, bits 9-62 represent the offset in
134 * bs->file where sector data can be read from as raw data.
135 *
136 * DATA == 0 && ZERO == 0 means that data is read from backing_hd if present.
137 *
138 * DATA ZERO OFFSET_VALID
139 * t t t sectors read as zero, bs->file is zero at offset
140 * t f t sectors read as valid from bs->file at offset
141 * f t t sectors preallocated, read as zero, bs->file not
142 * necessarily zero at offset
143 * f f t sectors preallocated but read from backing_hd,
144 * bs->file contains garbage at offset
145 * t t f sectors preallocated, read as zero, unknown offset
146 * t f f sectors read from unknown file or offset
147 * f t f not allocated or unknown offset, read as zero
148 * f f f not allocated or unknown offset, read from backing_hd
149 */
e88ae226
KW
150#define BDRV_BLOCK_DATA 0x01
151#define BDRV_BLOCK_ZERO 0x02
152#define BDRV_BLOCK_OFFSET_VALID 0x04
153#define BDRV_BLOCK_RAW 0x08
154#define BDRV_BLOCK_ALLOCATED 0x10
4333bb71
PB
155#define BDRV_BLOCK_OFFSET_MASK BDRV_SECTOR_MASK
156
e971aa12
JC
157typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue;
158
159typedef struct BDRVReopenState {
160 BlockDriverState *bs;
161 int flags;
4d2cb092 162 QDict *options;
145f598e 163 QDict *explicit_options;
e971aa12
JC
164 void *opaque;
165} BDRVReopenState;
166
8574575f
FZ
167/*
168 * Block operation types
169 */
170typedef enum BlockOpType {
171 BLOCK_OP_TYPE_BACKUP_SOURCE,
172 BLOCK_OP_TYPE_BACKUP_TARGET,
173 BLOCK_OP_TYPE_CHANGE,
bb00021d
FZ
174 BLOCK_OP_TYPE_COMMIT_SOURCE,
175 BLOCK_OP_TYPE_COMMIT_TARGET,
8574575f
FZ
176 BLOCK_OP_TYPE_DATAPLANE,
177 BLOCK_OP_TYPE_DRIVE_DEL,
178 BLOCK_OP_TYPE_EJECT,
179 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
180 BLOCK_OP_TYPE_INTERNAL_SNAPSHOT,
181 BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE,
05e4d14b 182 BLOCK_OP_TYPE_MIRROR_SOURCE,
e40e5027 183 BLOCK_OP_TYPE_MIRROR_TARGET,
8574575f
FZ
184 BLOCK_OP_TYPE_RESIZE,
185 BLOCK_OP_TYPE_STREAM,
09158f00 186 BLOCK_OP_TYPE_REPLACE,
8574575f
FZ
187 BLOCK_OP_TYPE_MAX,
188} BlockOpType;
e971aa12 189
0563e191 190/* disk I/O throttling */
faf07963 191void bdrv_init(void);
eb852011 192void bdrv_init_with_whitelist(void);
e6ff69bf 193bool bdrv_uses_whitelist(void);
98289620 194BlockDriver *bdrv_find_protocol(const char *filename,
b65a5e12
HR
195 bool allow_protocol_prefix,
196 Error **errp);
faf07963 197BlockDriver *bdrv_find_format(const char *format_name);
0e7e1989 198int bdrv_create(BlockDriver *drv, const char* filename,
c282e1fd
CL
199 QemuOpts *opts, Error **errp);
200int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp);
e4e9986b 201BlockDriverState *bdrv_new(void);
8802d1fd 202void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
3f09bfbc
KW
203void bdrv_replace_in_backing_chain(BlockDriverState *old,
204 BlockDriverState *new);
205
baf5602e 206int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough);
9e8f1835 207int bdrv_parse_discard_flags(const char *mode, int *flags);
b4b059f6
KW
208BdrvChild *bdrv_open_child(const char *filename,
209 QDict *options, const char *bdref_key,
210 BlockDriverState* parent,
211 const BdrvChildRole *child_role,
212 bool allow_none, Error **errp);
8d24cce1 213void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd);
d9b7b057
KW
214int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options,
215 const char *bdref_key, Error **errp);
5b363937
HR
216BlockDriverState *bdrv_open(const char *filename, const char *reference,
217 QDict *options, int flags, Error **errp);
e971aa12 218BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
4d2cb092
KW
219 BlockDriverState *bs,
220 QDict *options, int flags);
720150f3 221int bdrv_reopen_multiple(AioContext *ctx, BlockReopenQueue *bs_queue, Error **errp);
e971aa12
JC
222int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
223int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
224 BlockReopenQueue *queue, Error **errp);
225void bdrv_reopen_commit(BDRVReopenState *reopen_state);
226void bdrv_reopen_abort(BDRVReopenState *reopen_state);
fbcbbf4e 227int bdrv_read(BdrvChild *child, int64_t sector_num,
faf07963 228 uint8_t *buf, int nb_sectors);
18d51c4b 229int bdrv_write(BdrvChild *child, int64_t sector_num,
faf07963 230 const uint8_t *buf, int nb_sectors);
720ff280 231int bdrv_pwrite_zeroes(BdrvChild *child, int64_t offset,
74021bc4 232 int count, BdrvRequestFlags flags);
720ff280 233int bdrv_make_zero(BdrvChild *child, BdrvRequestFlags flags);
cf2ab8fc
KW
234int bdrv_pread(BdrvChild *child, int64_t offset, void *buf, int bytes);
235int bdrv_preadv(BdrvChild *child, int64_t offset, QEMUIOVector *qiov);
d9ca2ea2
KW
236int bdrv_pwrite(BdrvChild *child, int64_t offset, const void *buf, int bytes);
237int bdrv_pwritev(BdrvChild *child, int64_t offset, QEMUIOVector *qiov);
238int bdrv_pwrite_sync(BdrvChild *child, int64_t offset,
239 const void *buf, int count);
28b04a8f
KW
240int coroutine_fn bdrv_co_readv(BdrvChild *child, int64_t sector_num,
241 int nb_sectors, QEMUIOVector *qiov);
25ec177d
KW
242int coroutine_fn bdrv_co_writev(BdrvChild *child, int64_t sector_num,
243 int nb_sectors, QEMUIOVector *qiov);
f08f2dda
SH
244/*
245 * Efficiently zero a region of the disk image. Note that this is a regular
246 * I/O request like read or write and should have a reasonable size. This
247 * function is not suitable for zeroing the entire image in a single request
248 * because it may allocate memory for the entire region.
249 */
a03ef88f
KW
250int coroutine_fn bdrv_co_pwrite_zeroes(BdrvChild *child, int64_t offset,
251 int count, BdrvRequestFlags flags);
e8a6bb9c
MT
252BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
253 const char *backing_file);
f198fd1c 254int bdrv_get_backing_file_depth(BlockDriverState *bs);
91af7014 255void bdrv_refresh_filename(BlockDriverState *bs);
faf07963 256int bdrv_truncate(BlockDriverState *bs, int64_t offset);
65a9bb25 257int64_t bdrv_nb_sectors(BlockDriverState *bs);
faf07963 258int64_t bdrv_getlength(BlockDriverState *bs);
4a1d5e1f 259int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
96b8f136 260void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
3baca891 261void bdrv_refresh_limits(BlockDriverState *bs, Error **errp);
faf07963 262int bdrv_commit(BlockDriverState *bs);
756e6736
KW
263int bdrv_change_backing_file(BlockDriverState *bs,
264 const char *backing_file, const char *backing_fmt);
5efa9d5a 265void bdrv_register(BlockDriver *bdrv);
6ebdcee2 266int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
54e26900
JC
267 BlockDriverState *base,
268 const char *backing_file_str);
6ebdcee2
JC
269BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
270 BlockDriverState *bs);
79fac568 271BlockDriverState *bdrv_find_base(BlockDriverState *bs);
5efa9d5a 272
e076f338
KW
273
274typedef struct BdrvCheckResult {
275 int corruptions;
276 int leaks;
277 int check_errors;
ccf34716
KW
278 int corruptions_fixed;
279 int leaks_fixed;
c6bb9ad1 280 int64_t image_end_offset;
f8111c24 281 BlockFragInfo bfi;
e076f338
KW
282} BdrvCheckResult;
283
4534ff54
KW
284typedef enum {
285 BDRV_FIX_LEAKS = 1,
286 BDRV_FIX_ERRORS = 2,
287} BdrvCheckMode;
288
289int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
e076f338 290
77485434
HR
291/* The units of offset and total_work_size may be chosen arbitrarily by the
292 * block driver; total_work_size may change during the course of the amendment
293 * operation */
294typedef void BlockDriverAmendStatusCB(BlockDriverState *bs, int64_t offset,
8b13976d 295 int64_t total_work_size, void *opaque);
77485434 296int bdrv_amend_options(BlockDriverState *bs_new, QemuOpts *opts,
8b13976d 297 BlockDriverAmendStatusCB *status_cb, void *cb_opaque);
6f176b48 298
f6186f49 299/* external snapshots */
212a5a8f
BC
300bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs,
301 BlockDriverState *candidate);
302bool bdrv_is_first_non_filter(BlockDriverState *candidate);
f6186f49 303
09158f00 304/* check if a named node can be replaced when doing drive-mirror */
e12f3784
WC
305BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs,
306 const char *node_name, Error **errp);
09158f00 307
faf07963 308/* async block I/O */
ebb7af21 309BlockAIOCB *bdrv_aio_readv(BdrvChild *child, int64_t sector_num,
7c84b1b8 310 QEMUIOVector *iov, int nb_sectors,
097310b5 311 BlockCompletionFunc *cb, void *opaque);
0d1049c7 312BlockAIOCB *bdrv_aio_writev(BdrvChild *child, int64_t sector_num,
7c84b1b8 313 QEMUIOVector *iov, int nb_sectors,
097310b5 314 BlockCompletionFunc *cb, void *opaque);
7c84b1b8 315BlockAIOCB *bdrv_aio_flush(BlockDriverState *bs,
097310b5 316 BlockCompletionFunc *cb, void *opaque);
7c84b1b8
MA
317void bdrv_aio_cancel(BlockAIOCB *acb);
318void bdrv_aio_cancel_async(BlockAIOCB *acb);
faf07963 319
7d780669 320/* sg packet commands */
48af776a 321int bdrv_co_ioctl(BlockDriverState *bs, int req, void *buf);
7d780669 322
0f15423c 323/* Invalidate any cached metadata used by image formats */
5a8a30db
KW
324void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp);
325void bdrv_invalidate_cache_all(Error **errp);
76b1c7fe 326int bdrv_inactivate_all(void);
0f15423c 327
faf07963 328/* Ensure contents are flushed to disk. */
205ef796 329int bdrv_flush(BlockDriverState *bs);
07f07615 330int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
4085f5c7 331int bdrv_flush_all(void);
2bc93fed 332void bdrv_close_all(void);
5b98db0a 333void bdrv_drain(BlockDriverState *bs);
a77fd4bb 334void coroutine_fn bdrv_co_drain(BlockDriverState *bs);
922453bc 335void bdrv_drain_all(void);
c6ca28d6 336
88b062c2
PB
337#define BDRV_POLL_WHILE(bs, cond) ({ \
338 bool waited_ = false; \
339 BlockDriverState *bs_ = (bs); \
340 while ((cond)) { \
341 aio_poll(bdrv_get_aio_context(bs_), true); \
342 waited_ = true; \
343 } \
344 waited_; })
345
0c51a893 346int bdrv_pdiscard(BlockDriverState *bs, int64_t offset, int count);
9f1963b3 347int bdrv_co_pdiscard(BlockDriverState *bs, int64_t offset, int count);
3ac21627 348int bdrv_has_zero_init_1(BlockDriverState *bs);
f2feebbd 349int bdrv_has_zero_init(BlockDriverState *bs);
4ce78691
PL
350bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs);
351bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs);
b6b8a333 352int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num,
67a0fd2a
FZ
353 int nb_sectors, int *pnum,
354 BlockDriverState **file);
ba3f0e25
FZ
355int64_t bdrv_get_block_status_above(BlockDriverState *bs,
356 BlockDriverState *base,
357 int64_t sector_num,
67a0fd2a
FZ
358 int nb_sectors, int *pnum,
359 BlockDriverState **file);
f58c7b35 360int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
39aa9a12 361 int *pnum);
b35b2bba
MR
362int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
363 int64_t sector_num, int nb_sectors, int *pnum);
faf07963 364
54115412
EB
365bool bdrv_is_read_only(BlockDriverState *bs);
366bool bdrv_is_sg(BlockDriverState *bs);
e031f750 367bool bdrv_is_inserted(BlockDriverState *bs);
faf07963 368int bdrv_media_changed(BlockDriverState *bs);
025e849a 369void bdrv_lock_medium(BlockDriverState *bs, bool locked);
f36f3949 370void bdrv_eject(BlockDriverState *bs, bool eject_flag);
f8d6bba1 371const char *bdrv_get_format_name(BlockDriverState *bs);
dc364f4c 372BlockDriverState *bdrv_find_node(const char *node_name);
d5a8ee60 373BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp);
12d3ba82
BC
374BlockDriverState *bdrv_lookup_bs(const char *device,
375 const char *node_name,
376 Error **errp);
5a6684d2 377bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base);
04df765a 378BlockDriverState *bdrv_next_node(BlockDriverState *bs);
88be7b4b
KW
379
380typedef struct BdrvNextIterator {
381 enum {
382 BDRV_NEXT_BACKEND_ROOTS,
383 BDRV_NEXT_MONITOR_OWNED,
384 } phase;
385 BlockBackend *blk;
386 BlockDriverState *bs;
387} BdrvNextIterator;
388
389BlockDriverState *bdrv_first(BdrvNextIterator *it);
390BlockDriverState *bdrv_next(BdrvNextIterator *it);
391
262b4e8f 392BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs);
54115412
EB
393bool bdrv_is_encrypted(BlockDriverState *bs);
394bool bdrv_key_required(BlockDriverState *bs);
faf07963 395int bdrv_set_key(BlockDriverState *bs, const char *key);
4d2855a3 396void bdrv_add_key(BlockDriverState *bs, const char *key, Error **errp);
faf07963
PB
397void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
398 void *opaque);
20a9e77d 399const char *bdrv_get_node_name(const BlockDriverState *bs);
bfb197e0 400const char *bdrv_get_device_name(const BlockDriverState *bs);
9b2aa84f 401const char *bdrv_get_device_or_node_name(const BlockDriverState *bs);
c8433287 402int bdrv_get_flags(BlockDriverState *bs);
faf07963 403int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
eae041fe 404ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs);
244483e6
KW
405void bdrv_round_sectors_to_clusters(BlockDriverState *bs,
406 int64_t sector_num, int nb_sectors,
407 int64_t *cluster_sector_num,
408 int *cluster_nb_sectors);
343bded4 409void bdrv_round_to_clusters(BlockDriverState *bs,
244483e6
KW
410 int64_t offset, unsigned int bytes,
411 int64_t *cluster_offset,
412 unsigned int *cluster_bytes);
faf07963 413
045df330 414const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
faf07963
PB
415void bdrv_get_backing_filename(BlockDriverState *bs,
416 char *filename, int filename_size);
dc5a1371 417void bdrv_get_full_backing_filename(BlockDriverState *bs,
9f07429e 418 char *dest, size_t sz, Error **errp);
0a82855a
HR
419void bdrv_get_full_backing_filename_from_filename(const char *backed,
420 const char *backing,
9f07429e
HR
421 char *dest, size_t sz,
422 Error **errp);
faf07963 423
5c98415b 424int path_has_protocol(const char *path);
faf07963
PB
425int path_is_absolute(const char *path);
426void path_combine(char *dest, int dest_size,
427 const char *base_path,
428 const char *filename);
429
5ddda0b8 430int bdrv_readv_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
cf8074b3 431int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
45566e9c
CH
432int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
433 int64_t pos, int size);
178e08a5 434
45566e9c
CH
435int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
436 int64_t pos, int size);
178e08a5 437
d92ada22
LC
438void bdrv_img_create(const char *filename, const char *fmt,
439 const char *base_filename, const char *base_fmt,
f382d43a
MR
440 char *options, uint64_t img_size, int flags,
441 Error **errp, bool quiet);
f88e1a42 442
339064d5
KW
443/* Returns the alignment in bytes that is required so that no bounce buffer
444 * is required throughout the stack */
4196d2f0
DL
445size_t bdrv_min_mem_align(BlockDriverState *bs);
446/* Returns optimal alignment in bytes for bounce buffer */
339064d5 447size_t bdrv_opt_mem_align(BlockDriverState *bs);
ba5b7ad4 448void *qemu_blockalign(BlockDriverState *bs, size_t size);
9ebd8448 449void *qemu_blockalign0(BlockDriverState *bs, size_t size);
7d2a35cc 450void *qemu_try_blockalign(BlockDriverState *bs, size_t size);
9ebd8448 451void *qemu_try_blockalign0(BlockDriverState *bs, size_t size);
c53b1c51 452bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
ba5b7ad4 453
53fec9d3
SH
454void bdrv_enable_copy_on_read(BlockDriverState *bs);
455void bdrv_disable_copy_on_read(BlockDriverState *bs);
456
9fcb0251
FZ
457void bdrv_ref(BlockDriverState *bs);
458void bdrv_unref(BlockDriverState *bs);
33a60407 459void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child);
98292c61
WC
460BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs,
461 BlockDriverState *child_bs,
462 const char *child_name,
463 const BdrvChildRole *child_role);
8b9b0cc2 464
fbe40ff7
FZ
465bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp);
466void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason);
467void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason);
468void bdrv_op_block_all(BlockDriverState *bs, Error *reason);
469void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason);
470bool bdrv_op_blocker_is_empty(BlockDriverState *bs);
471
9a4f4c31
KW
472#define BLKDBG_EVENT(child, evt) \
473 do { \
474 if (child) { \
475 bdrv_debug_event(child->bs, evt); \
476 } \
477 } while (0)
478
a31939e6 479void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event);
8b9b0cc2 480
41c695c7
KW
481int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
482 const char *tag);
4cc70e93 483int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag);
41c695c7
KW
484int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
485bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);
486
db519cba
FZ
487/**
488 * bdrv_get_aio_context:
489 *
490 * Returns: the currently bound #AioContext
491 */
492AioContext *bdrv_get_aio_context(BlockDriverState *bs);
493
dcd04228
SH
494/**
495 * bdrv_set_aio_context:
496 *
497 * Changes the #AioContext used for fd handlers, timers, and BHs by this
498 * BlockDriverState and all its children.
499 *
2e5b887c 500 * This function must be called with iothread lock held.
dcd04228
SH
501 */
502void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context);
892b7de8
ET
503int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz);
504int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo);
dcd04228 505
448ad91d
ML
506void bdrv_io_plug(BlockDriverState *bs);
507void bdrv_io_unplug(BlockDriverState *bs);
6b98bd64
PB
508void bdrv_io_unplugged_begin(BlockDriverState *bs);
509void bdrv_io_unplugged_end(BlockDriverState *bs);
448ad91d 510
51288d79
FZ
511/**
512 * bdrv_drained_begin:
513 *
514 * Begin a quiesced section for exclusive access to the BDS, by disabling
515 * external request sources including NBD server and device model. Note that
516 * this doesn't block timers or coroutines from submitting more requests, which
517 * means block_job_pause is still necessary.
518 *
519 * This function can be recursive.
520 */
521void bdrv_drained_begin(BlockDriverState *bs);
522
523/**
524 * bdrv_drained_end:
525 *
526 * End a quiescent section started by bdrv_drained_begin().
527 */
528void bdrv_drained_end(BlockDriverState *bs);
529
e06018ad
WC
530void bdrv_add_child(BlockDriverState *parent, BlockDriverState *child,
531 Error **errp);
532void bdrv_del_child(BlockDriverState *parent, BdrvChild *child, Error **errp);
533
8a4bc5aa 534#endif