]> git.proxmox.com Git - mirror_qemu.git/blame - include/block/block.h
blkdebug: add "remove_break" command
[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"
3b69e4b9 5#include "qemu-common.h"
1de7afc9 6#include "qemu/option.h"
737e150e 7#include "block/coroutine.h"
7b1b5d19 8#include "qapi/qmp/qobject.h"
2f0c9fe6 9#include "qapi-types.h"
a76bab49 10
faf07963 11/* block.c */
faf07963 12typedef struct BlockDriver BlockDriver;
2f0c9fe6 13typedef struct BlockJob BlockJob;
faf07963 14
faf07963
PB
15typedef struct BlockDriverInfo {
16 /* in bytes, 0 if irrelevant */
17 int cluster_size;
18 /* offset at which the VM state can be saved (0 if not possible) */
19 int64_t vm_state_offset;
64c79160 20 bool is_dirty;
e1a5c4be
PL
21 /*
22 * True if unallocated blocks read back as zeroes. This is equivalent
23 * to the the LBPRZ flag in the SCSI logical block provisioning page.
24 */
25 bool unallocated_blocks_are_zero;
26 /*
27 * True if the driver can optimize writing zeroes by unmapping
28 * sectors. This is equivalent to the BLKDISCARDZEROES ioctl in Linux
29 * with the difference that in qemu a discard is allowed to silently
30 * fail. Therefore we have to use bdrv_write_zeroes with the
31 * BDRV_REQ_MAY_UNMAP flag for an optimized zero write with unmapping.
32 * After this call the driver has to guarantee that the contents read
33 * back as zero. It is additionally required that the block device is
34 * opened with BDRV_O_UNMAP flag for this to work.
35 */
36 bool can_write_zeroes_with_unmap;
faf07963
PB
37} BlockDriverInfo;
38
f8111c24
DXW
39typedef struct BlockFragInfo {
40 uint64_t allocated_clusters;
41 uint64_t total_clusters;
42 uint64_t fragmented_clusters;
e6439d78 43 uint64_t compressed_clusters;
f8111c24
DXW
44} BlockFragInfo;
45
145feb17 46/* Callbacks for block device models */
0e49de52 47typedef struct BlockDevOps {
145feb17
MA
48 /*
49 * Runs when virtual media changed (monitor commands eject, change)
7d4b4ba5 50 * Argument load is true on load and false on eject.
145feb17
MA
51 * Beware: doesn't run when a host device's physical media
52 * changes. Sure would be useful if it did.
2c6942fa 53 * Device models with removable media must implement this callback.
145feb17 54 */
7d4b4ba5 55 void (*change_media_cb)(void *opaque, bool load);
025ccaa7
PB
56 /*
57 * Runs when an eject request is issued from the monitor, the tray
58 * is closed, and the medium is locked.
59 * Device models that do not implement is_medium_locked will not need
60 * this callback. Device models that can lock the medium or tray might
61 * want to implement the callback and unlock the tray when "force" is
62 * true, even if they do not support eject requests.
63 */
64 void (*eject_request_cb)(void *opaque, bool force);
e4def80b
MA
65 /*
66 * Is the virtual tray open?
67 * Device models implement this only when the device has a tray.
68 */
69 bool (*is_tray_open)(void *opaque);
f107639a
MA
70 /*
71 * Is the virtual medium locked into the device?
72 * Device models implement this only when device has such a lock.
73 */
74 bool (*is_medium_locked)(void *opaque);
145feb17
MA
75 /*
76 * Runs when the size changed (e.g. monitor command block_resize)
77 */
78 void (*resize_cb)(void *opaque);
0e49de52
MA
79} BlockDevOps;
80
6faac15f
PL
81typedef enum {
82 BDRV_REQ_COPY_ON_READ = 0x1,
83 BDRV_REQ_ZERO_WRITE = 0x2,
d32f35cb
PL
84 /* The BDRV_REQ_MAY_UNMAP flag is used to indicate that the block driver
85 * is allowed to optimize a write zeroes request by unmapping (discarding)
86 * blocks if it is guaranteed that the result will read back as
87 * zeroes. The flag is only passed to the driver if the block device is
88 * opened with BDRV_O_UNMAP.
89 */
90 BDRV_REQ_MAY_UNMAP = 0x4,
6faac15f
PL
91} BdrvRequestFlags;
92
faf07963 93#define BDRV_O_RDWR 0x0002
faf07963 94#define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
9f7965c7
AL
95#define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
96#define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
5c6c3a6c 97#define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
b783e409 98#define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
016f5cf6 99#define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
53fec9d3 100#define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
ccb1f4a7 101#define BDRV_O_INCOMING 0x0800 /* consistency hint for incoming migration */
058f8f16 102#define BDRV_O_CHECK 0x1000 /* open solely for consistency check */
be028adc 103#define BDRV_O_ALLOW_RDWR 0x2000 /* allow reopen to change from r/o to r/w */
9e8f1835 104#define BDRV_O_UNMAP 0x4000 /* execute guest UNMAP/TRIM operations */
9f7965c7 105
ceb25e5c 106#define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
faf07963 107
6ea44308 108#define BDRV_SECTOR_BITS 9
c63782cb 109#define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
3abbc4d9 110#define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
6ea44308 111
4333bb71
PB
112/* BDRV_BLOCK_DATA: data is read from bs->file or another file
113 * BDRV_BLOCK_ZERO: sectors read as zero
114 * BDRV_BLOCK_OFFSET_VALID: sector stored in bs->file as raw data
92bc50a5
PL
115 * BDRV_BLOCK_RAW: used internally to indicate that the request
116 * was answered by the raw driver and that one
117 * should look in bs->file directly.
4333bb71
PB
118 *
119 * If BDRV_BLOCK_OFFSET_VALID is set, bits 9-62 represent the offset in
120 * bs->file where sector data can be read from as raw data.
121 *
122 * DATA == 0 && ZERO == 0 means that data is read from backing_hd if present.
123 *
124 * DATA ZERO OFFSET_VALID
125 * t t t sectors read as zero, bs->file is zero at offset
126 * t f t sectors read as valid from bs->file at offset
127 * f t t sectors preallocated, read as zero, bs->file not
128 * necessarily zero at offset
129 * f f t sectors preallocated but read from backing_hd,
130 * bs->file contains garbage at offset
131 * t t f sectors preallocated, read as zero, unknown offset
132 * t f f sectors read from unknown file or offset
133 * f t f not allocated or unknown offset, read as zero
134 * f f f not allocated or unknown offset, read from backing_hd
135 */
136#define BDRV_BLOCK_DATA 1
137#define BDRV_BLOCK_ZERO 2
138#define BDRV_BLOCK_OFFSET_VALID 4
92bc50a5 139#define BDRV_BLOCK_RAW 8
4333bb71
PB
140#define BDRV_BLOCK_OFFSET_MASK BDRV_SECTOR_MASK
141
2582bfed
LC
142typedef enum {
143 BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
ff06f5f3 144} BlockErrorAction;
2582bfed 145
e971aa12
JC
146typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue;
147
148typedef struct BDRVReopenState {
149 BlockDriverState *bs;
150 int flags;
151 void *opaque;
152} BDRVReopenState;
153
154
28a7282a
LC
155void bdrv_iostatus_enable(BlockDriverState *bs);
156void bdrv_iostatus_reset(BlockDriverState *bs);
157void bdrv_iostatus_disable(BlockDriverState *bs);
158bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
159void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
d15e5465
LC
160void bdrv_info_print(Monitor *mon, const QObject *data);
161void bdrv_info(Monitor *mon, QObject **ret_data);
218a536a
LC
162void bdrv_stats_print(Monitor *mon, const QObject *data);
163void bdrv_info_stats(Monitor *mon, QObject **ret_data);
faf07963 164
0563e191
ZYW
165/* disk I/O throttling */
166void bdrv_io_limits_enable(BlockDriverState *bs);
98f90dba 167void bdrv_io_limits_disable(BlockDriverState *bs);
0563e191 168
faf07963 169void bdrv_init(void);
eb852011 170void bdrv_init_with_whitelist(void);
98289620
KW
171BlockDriver *bdrv_find_protocol(const char *filename,
172 bool allow_protocol_prefix);
faf07963 173BlockDriver *bdrv_find_format(const char *format_name);
b64ec4e4
FZ
174BlockDriver *bdrv_find_whitelisted_format(const char *format_name,
175 bool readonly);
0e7e1989 176int bdrv_create(BlockDriver *drv, const char* filename,
cc84d90f
HR
177 QEMUOptionParameter *options, Error **errp);
178int bdrv_create_file(const char* filename, QEMUOptionParameter *options,
179 Error **errp);
faf07963 180BlockDriverState *bdrv_new(const char *device_name);
d22b2f41 181void bdrv_make_anon(BlockDriverState *bs);
4ddc07ca 182void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old);
8802d1fd 183void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
c3993cdc 184int bdrv_parse_cache_flags(const char *mode, int *flags);
9e8f1835 185int bdrv_parse_discard_flags(const char *mode, int *flags);
787e4a85 186int bdrv_file_open(BlockDriverState **pbs, const char *filename,
34b5d2c6
HR
187 QDict *options, int flags, Error **errp);
188int bdrv_open_backing_file(BlockDriverState *bs, QDict *options, Error **errp);
de9c0cec 189int bdrv_open(BlockDriverState *bs, const char *filename, QDict *options,
34b5d2c6 190 int flags, BlockDriver *drv, Error **errp);
e971aa12
JC
191BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
192 BlockDriverState *bs, int flags);
193int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp);
194int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
195int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
196 BlockReopenQueue *queue, Error **errp);
197void bdrv_reopen_commit(BDRVReopenState *reopen_state);
198void bdrv_reopen_abort(BDRVReopenState *reopen_state);
faf07963 199void bdrv_close(BlockDriverState *bs);
d7d512f6 200void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify);
fa879d62
MA
201int bdrv_attach_dev(BlockDriverState *bs, void *dev);
202void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev);
203void bdrv_detach_dev(BlockDriverState *bs, void *dev);
204void *bdrv_get_attached_dev(BlockDriverState *bs);
0e49de52
MA
205void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
206 void *opaque);
025ccaa7 207void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
2c6942fa 208bool bdrv_dev_has_removable_media(BlockDriverState *bs);
e4def80b 209bool bdrv_dev_is_tray_open(BlockDriverState *bs);
f107639a 210bool bdrv_dev_is_medium_locked(BlockDriverState *bs);
faf07963
PB
211int bdrv_read(BlockDriverState *bs, int64_t sector_num,
212 uint8_t *buf, int nb_sectors);
07d27a44
MA
213int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
214 uint8_t *buf, int nb_sectors);
faf07963
PB
215int bdrv_write(BlockDriverState *bs, int64_t sector_num,
216 const uint8_t *buf, int nb_sectors);
4105eaaa 217int bdrv_write_zeroes(BlockDriverState *bs, int64_t sector_num,
aa7bfbff 218 int nb_sectors, BdrvRequestFlags flags);
d75cbb5e 219int bdrv_make_zero(BlockDriverState *bs, BdrvRequestFlags flags);
8d3b1a2d 220int bdrv_writev(BlockDriverState *bs, int64_t sector_num, QEMUIOVector *qiov);
faf07963
PB
221int bdrv_pread(BlockDriverState *bs, int64_t offset,
222 void *buf, int count);
223int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
224 const void *buf, int count);
8d3b1a2d 225int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov);
f08145fe
KW
226int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
227 const void *buf, int count);
da1fa91d
KW
228int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
229 int nb_sectors, QEMUIOVector *qiov);
470c0504
SH
230int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
231 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
da1fa91d
KW
232int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
233 int nb_sectors, QEMUIOVector *qiov);
f08f2dda
SH
234/*
235 * Efficiently zero a region of the disk image. Note that this is a regular
236 * I/O request like read or write and should have a reasonable size. This
237 * function is not suitable for zeroing the entire image in a single request
238 * because it may allocate memory for the entire region.
239 */
240int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
aa7bfbff 241 int nb_sectors, BdrvRequestFlags flags);
e8a6bb9c
MT
242BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
243 const char *backing_file);
f198fd1c 244int bdrv_get_backing_file_depth(BlockDriverState *bs);
faf07963
PB
245int bdrv_truncate(BlockDriverState *bs, int64_t offset);
246int64_t bdrv_getlength(BlockDriverState *bs);
4a1d5e1f 247int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
96b8f136 248void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
faf07963 249int bdrv_commit(BlockDriverState *bs);
e8877497 250int bdrv_commit_all(void);
756e6736
KW
251int bdrv_change_backing_file(BlockDriverState *bs,
252 const char *backing_file, const char *backing_fmt);
5efa9d5a 253void bdrv_register(BlockDriver *bdrv);
6ebdcee2
JC
254int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
255 BlockDriverState *base);
256BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
257 BlockDriverState *bs);
79fac568 258BlockDriverState *bdrv_find_base(BlockDriverState *bs);
5efa9d5a 259
e076f338
KW
260
261typedef struct BdrvCheckResult {
262 int corruptions;
263 int leaks;
264 int check_errors;
ccf34716
KW
265 int corruptions_fixed;
266 int leaks_fixed;
c6bb9ad1 267 int64_t image_end_offset;
f8111c24 268 BlockFragInfo bfi;
e076f338
KW
269} BdrvCheckResult;
270
4534ff54
KW
271typedef enum {
272 BDRV_FIX_LEAKS = 1,
273 BDRV_FIX_ERRORS = 2,
274} BdrvCheckMode;
275
276int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
e076f338 277
6f176b48
HR
278int bdrv_amend_options(BlockDriverState *bs_new, QEMUOptionParameter *options);
279
f6186f49
BC
280/* external snapshots */
281
282typedef enum {
283 EXT_SNAPSHOT_ALLOWED,
284 EXT_SNAPSHOT_FORBIDDEN,
285} ExtSnapshotPerm;
286
287/* return EXT_SNAPSHOT_ALLOWED if external snapshot is allowed
288 * return EXT_SNAPSHOT_FORBIDDEN if external snapshot is forbidden
289 */
290ExtSnapshotPerm bdrv_check_ext_snapshot(BlockDriverState *bs);
291/* helper used to forbid external snapshots like in blkverify */
292ExtSnapshotPerm bdrv_check_ext_snapshot_forbidden(BlockDriverState *bs);
293
faf07963 294/* async block I/O */
7cd1e32a 295typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
39aa9a12 296 int sector_num);
3b69e4b9
AL
297BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
298 QEMUIOVector *iov, int nb_sectors,
299 BlockDriverCompletionFunc *cb, void *opaque);
300BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
301 QEMUIOVector *iov, int nb_sectors,
302 BlockDriverCompletionFunc *cb, void *opaque);
b2e12bc6 303BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
39aa9a12 304 BlockDriverCompletionFunc *cb, void *opaque);
4265d620
PB
305BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
306 int64_t sector_num, int nb_sectors,
307 BlockDriverCompletionFunc *cb, void *opaque);
faf07963
PB
308void bdrv_aio_cancel(BlockDriverAIOCB *acb);
309
40b4f539
KW
310typedef struct BlockRequest {
311 /* Fields to be filled by multiwrite caller */
312 int64_t sector;
313 int nb_sectors;
314 QEMUIOVector *qiov;
315 BlockDriverCompletionFunc *cb;
316 void *opaque;
317
318 /* Filled by multiwrite implementation */
319 int error;
320} BlockRequest;
321
322int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
323 int num_reqs);
324
7d780669 325/* sg packet commands */
221f715d
AL
326int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
327BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
328 unsigned long int req, void *buf,
329 BlockDriverCompletionFunc *cb, void *opaque);
7d780669 330
0f15423c
AL
331/* Invalidate any cached metadata used by image formats */
332void bdrv_invalidate_cache(BlockDriverState *bs);
333void bdrv_invalidate_cache_all(void);
334
07789269
BC
335void bdrv_clear_incoming_migration_all(void);
336
faf07963 337/* Ensure contents are flushed to disk. */
205ef796 338int bdrv_flush(BlockDriverState *bs);
07f07615 339int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
f0f0fdfe 340int bdrv_flush_all(void);
2bc93fed 341void bdrv_close_all(void);
922453bc 342void bdrv_drain_all(void);
c6ca28d6 343
bb8bf76f 344int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
4265d620 345int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
3ac21627 346int bdrv_has_zero_init_1(BlockDriverState *bs);
f2feebbd 347int bdrv_has_zero_init(BlockDriverState *bs);
4ce78691
PL
348bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs);
349bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs);
b6b8a333
PB
350int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num,
351 int nb_sectors, int *pnum);
f58c7b35 352int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
39aa9a12 353 int *pnum);
b35b2bba
MR
354int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
355 int64_t sector_num, int nb_sectors, int *pnum);
faf07963 356
ff06f5f3
PB
357void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error,
358 BlockdevOnError on_write_error);
1ceee0d5 359BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read);
3e1caa5f
PB
360BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error);
361void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action,
362 bool is_read, int error);
faf07963 363int bdrv_is_read_only(BlockDriverState *bs);
985a03b0 364int bdrv_is_sg(BlockDriverState *bs);
e900a7b7 365int bdrv_enable_write_cache(BlockDriverState *bs);
425b0148 366void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
faf07963
PB
367int bdrv_is_inserted(BlockDriverState *bs);
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);
faf07963 372BlockDriverState *bdrv_find(const char *name);
2f399b0a 373BlockDriverState *bdrv_next(BlockDriverState *bs);
51de9760
AL
374void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
375 void *opaque);
faf07963 376int bdrv_is_encrypted(BlockDriverState *bs);
c0f4ce77 377int bdrv_key_required(BlockDriverState *bs);
faf07963 378int bdrv_set_key(BlockDriverState *bs, const char *key);
c0f4ce77 379int bdrv_query_missing_keys(void);
faf07963
PB
380void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
381 void *opaque);
382const char *bdrv_get_device_name(BlockDriverState *bs);
c8433287 383int bdrv_get_flags(BlockDriverState *bs);
faf07963
PB
384int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
385 const uint8_t *buf, int nb_sectors);
386int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
eae041fe 387ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs);
343bded4
PB
388void bdrv_round_to_clusters(BlockDriverState *bs,
389 int64_t sector_num, int nb_sectors,
390 int64_t *cluster_sector_num,
391 int *cluster_nb_sectors);
faf07963 392
045df330 393const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
faf07963
PB
394void bdrv_get_backing_filename(BlockDriverState *bs,
395 char *filename, int filename_size);
dc5a1371
PB
396void bdrv_get_full_backing_filename(BlockDriverState *bs,
397 char *dest, size_t sz);
199630b6 398int bdrv_is_snapshot(BlockDriverState *bs);
faf07963 399
faf07963
PB
400int path_is_absolute(const char *path);
401void path_combine(char *dest, int dest_size,
402 const char *base_path,
403 const char *filename);
404
cf8074b3 405int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
45566e9c
CH
406int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
407 int64_t pos, int size);
178e08a5 408
45566e9c
CH
409int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
410 int64_t pos, int size);
178e08a5 411
d92ada22
LC
412void bdrv_img_create(const char *filename, const char *fmt,
413 const char *base_filename, const char *base_fmt,
f382d43a
MR
414 char *options, uint64_t img_size, int flags,
415 Error **errp, bool quiet);
f88e1a42 416
7b6f9300 417void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
ba5b7ad4 418void *qemu_blockalign(BlockDriverState *bs, size_t size);
c53b1c51 419bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
ba5b7ad4 420
8f0720ec 421struct HBitmapIter;
e4654d2d
FZ
422typedef struct BdrvDirtyBitmap BdrvDirtyBitmap;
423BdrvDirtyBitmap *bdrv_create_dirty_bitmap(BlockDriverState *bs, int granularity);
424void bdrv_release_dirty_bitmap(BlockDriverState *bs, BdrvDirtyBitmap *bitmap);
21b56835 425BlockDirtyInfoList *bdrv_query_dirty_bitmaps(BlockDriverState *bs);
e4654d2d 426int bdrv_get_dirty(BlockDriverState *bs, BdrvDirtyBitmap *bitmap, int64_t sector);
1755da16
PB
427void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
428void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
e4654d2d
FZ
429void bdrv_dirty_iter_init(BlockDriverState *bs,
430 BdrvDirtyBitmap *bitmap, struct HBitmapIter *hbi);
431int64_t bdrv_get_dirty_count(BlockDriverState *bs, BdrvDirtyBitmap *bitmap);
8b9b0cc2 432
53fec9d3
SH
433void bdrv_enable_copy_on_read(BlockDriverState *bs);
434void bdrv_disable_copy_on_read(BlockDriverState *bs);
435
9fcb0251
FZ
436void bdrv_ref(BlockDriverState *bs);
437void bdrv_unref(BlockDriverState *bs);
db593f25
MT
438void bdrv_set_in_use(BlockDriverState *bs, int in_use);
439int bdrv_in_use(BlockDriverState *bs);
8b9b0cc2 440
4065742a
SH
441#ifdef CONFIG_LINUX_AIO
442int raw_get_aio_fd(BlockDriverState *bs);
443#else
444static inline int raw_get_aio_fd(BlockDriverState *bs)
445{
446 return -ENOTSUP;
447}
448#endif
449
a597e79c
CH
450enum BlockAcctType {
451 BDRV_ACCT_READ,
452 BDRV_ACCT_WRITE,
453 BDRV_ACCT_FLUSH,
454 BDRV_MAX_IOTYPE,
455};
456
457typedef struct BlockAcctCookie {
458 int64_t bytes;
c488c7f6 459 int64_t start_time_ns;
a597e79c
CH
460 enum BlockAcctType type;
461} BlockAcctCookie;
462
463void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
464 int64_t bytes, enum BlockAcctType type);
465void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);
466
8b9b0cc2 467typedef enum {
8252278a
KW
468 BLKDBG_L1_UPDATE,
469
470 BLKDBG_L1_GROW_ALLOC_TABLE,
471 BLKDBG_L1_GROW_WRITE_TABLE,
472 BLKDBG_L1_GROW_ACTIVATE_TABLE,
473
474 BLKDBG_L2_LOAD,
475 BLKDBG_L2_UPDATE,
476 BLKDBG_L2_UPDATE_COMPRESSED,
477 BLKDBG_L2_ALLOC_COW_READ,
478 BLKDBG_L2_ALLOC_WRITE,
479
8252278a 480 BLKDBG_READ_AIO,
8252278a
KW
481 BLKDBG_READ_BACKING_AIO,
482 BLKDBG_READ_COMPRESSED,
483
484 BLKDBG_WRITE_AIO,
485 BLKDBG_WRITE_COMPRESSED,
486
487 BLKDBG_VMSTATE_LOAD,
488 BLKDBG_VMSTATE_SAVE,
489
490 BLKDBG_COW_READ,
491 BLKDBG_COW_WRITE,
492
493 BLKDBG_REFTABLE_LOAD,
494 BLKDBG_REFTABLE_GROW,
afa50193 495 BLKDBG_REFTABLE_UPDATE,
8252278a
KW
496
497 BLKDBG_REFBLOCK_LOAD,
498 BLKDBG_REFBLOCK_UPDATE,
499 BLKDBG_REFBLOCK_UPDATE_PART,
500 BLKDBG_REFBLOCK_ALLOC,
501 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
502 BLKDBG_REFBLOCK_ALLOC_WRITE,
503 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
504 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
505 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
506
507 BLKDBG_CLUSTER_ALLOC,
508 BLKDBG_CLUSTER_ALLOC_BYTES,
509 BLKDBG_CLUSTER_FREE,
510
bf736fe3
KW
511 BLKDBG_FLUSH_TO_OS,
512 BLKDBG_FLUSH_TO_DISK,
513
8b9b0cc2
KW
514 BLKDBG_EVENT_MAX,
515} BlkDebugEvent;
516
517#define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
518void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
519
41c695c7
KW
520int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
521 const char *tag);
4cc70e93 522int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag);
41c695c7
KW
523int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
524bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);
525
8a4bc5aa 526#endif