]> git.proxmox.com Git - mirror_qemu.git/blame - include/block/block.h
qapi: Add "backing" to BlockStats
[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,
72daa72e
HR
187 const char *reference, QDict *options, int flags,
188 Error **errp);
da557aac
HR
189int bdrv_open_image(BlockDriverState **pbs, const char *filename,
190 QDict *options, const char *bdref_key, int flags,
191 bool force_raw, bool allow_none, Error **errp);
34b5d2c6 192int bdrv_open_backing_file(BlockDriverState *bs, QDict *options, Error **errp);
de9c0cec 193int bdrv_open(BlockDriverState *bs, const char *filename, QDict *options,
34b5d2c6 194 int flags, BlockDriver *drv, Error **errp);
e971aa12
JC
195BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
196 BlockDriverState *bs, int flags);
197int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp);
198int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
199int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
200 BlockReopenQueue *queue, Error **errp);
201void bdrv_reopen_commit(BDRVReopenState *reopen_state);
202void bdrv_reopen_abort(BDRVReopenState *reopen_state);
faf07963 203void bdrv_close(BlockDriverState *bs);
d7d512f6 204void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify);
fa879d62
MA
205int bdrv_attach_dev(BlockDriverState *bs, void *dev);
206void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev);
207void bdrv_detach_dev(BlockDriverState *bs, void *dev);
208void *bdrv_get_attached_dev(BlockDriverState *bs);
0e49de52
MA
209void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
210 void *opaque);
025ccaa7 211void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
2c6942fa 212bool bdrv_dev_has_removable_media(BlockDriverState *bs);
e4def80b 213bool bdrv_dev_is_tray_open(BlockDriverState *bs);
f107639a 214bool bdrv_dev_is_medium_locked(BlockDriverState *bs);
faf07963
PB
215int bdrv_read(BlockDriverState *bs, int64_t sector_num,
216 uint8_t *buf, int nb_sectors);
07d27a44
MA
217int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
218 uint8_t *buf, int nb_sectors);
faf07963
PB
219int bdrv_write(BlockDriverState *bs, int64_t sector_num,
220 const uint8_t *buf, int nb_sectors);
4105eaaa 221int bdrv_write_zeroes(BlockDriverState *bs, int64_t sector_num,
aa7bfbff 222 int nb_sectors, BdrvRequestFlags flags);
d5ef94d4
PB
223BlockDriverAIOCB *bdrv_aio_write_zeroes(BlockDriverState *bs, int64_t sector_num,
224 int nb_sectors, BdrvRequestFlags flags,
225 BlockDriverCompletionFunc *cb, void *opaque);
d75cbb5e 226int bdrv_make_zero(BlockDriverState *bs, BdrvRequestFlags flags);
8d3b1a2d 227int bdrv_writev(BlockDriverState *bs, int64_t sector_num, QEMUIOVector *qiov);
faf07963
PB
228int bdrv_pread(BlockDriverState *bs, int64_t offset,
229 void *buf, int count);
230int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
231 const void *buf, int count);
8d3b1a2d 232int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov);
f08145fe
KW
233int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
234 const void *buf, int count);
da1fa91d
KW
235int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
236 int nb_sectors, QEMUIOVector *qiov);
470c0504
SH
237int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
238 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
da1fa91d
KW
239int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
240 int nb_sectors, QEMUIOVector *qiov);
f08f2dda
SH
241/*
242 * Efficiently zero a region of the disk image. Note that this is a regular
243 * I/O request like read or write and should have a reasonable size. This
244 * function is not suitable for zeroing the entire image in a single request
245 * because it may allocate memory for the entire region.
246 */
247int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
aa7bfbff 248 int nb_sectors, BdrvRequestFlags flags);
e8a6bb9c
MT
249BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
250 const char *backing_file);
f198fd1c 251int bdrv_get_backing_file_depth(BlockDriverState *bs);
faf07963
PB
252int bdrv_truncate(BlockDriverState *bs, int64_t offset);
253int64_t bdrv_getlength(BlockDriverState *bs);
4a1d5e1f 254int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
96b8f136 255void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
faf07963 256int bdrv_commit(BlockDriverState *bs);
e8877497 257int bdrv_commit_all(void);
756e6736
KW
258int bdrv_change_backing_file(BlockDriverState *bs,
259 const char *backing_file, const char *backing_fmt);
5efa9d5a 260void bdrv_register(BlockDriver *bdrv);
6ebdcee2
JC
261int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
262 BlockDriverState *base);
263BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
264 BlockDriverState *bs);
79fac568 265BlockDriverState *bdrv_find_base(BlockDriverState *bs);
5efa9d5a 266
e076f338
KW
267
268typedef struct BdrvCheckResult {
269 int corruptions;
270 int leaks;
271 int check_errors;
ccf34716
KW
272 int corruptions_fixed;
273 int leaks_fixed;
c6bb9ad1 274 int64_t image_end_offset;
f8111c24 275 BlockFragInfo bfi;
e076f338
KW
276} BdrvCheckResult;
277
4534ff54
KW
278typedef enum {
279 BDRV_FIX_LEAKS = 1,
280 BDRV_FIX_ERRORS = 2,
281} BdrvCheckMode;
282
283int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
e076f338 284
6f176b48
HR
285int bdrv_amend_options(BlockDriverState *bs_new, QEMUOptionParameter *options);
286
f6186f49
BC
287/* external snapshots */
288
289typedef enum {
290 EXT_SNAPSHOT_ALLOWED,
291 EXT_SNAPSHOT_FORBIDDEN,
292} ExtSnapshotPerm;
293
294/* return EXT_SNAPSHOT_ALLOWED if external snapshot is allowed
295 * return EXT_SNAPSHOT_FORBIDDEN if external snapshot is forbidden
296 */
297ExtSnapshotPerm bdrv_check_ext_snapshot(BlockDriverState *bs);
298/* helper used to forbid external snapshots like in blkverify */
299ExtSnapshotPerm bdrv_check_ext_snapshot_forbidden(BlockDriverState *bs);
300
faf07963 301/* async block I/O */
7cd1e32a 302typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
39aa9a12 303 int sector_num);
3b69e4b9
AL
304BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
305 QEMUIOVector *iov, int nb_sectors,
306 BlockDriverCompletionFunc *cb, void *opaque);
307BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
308 QEMUIOVector *iov, int nb_sectors,
309 BlockDriverCompletionFunc *cb, void *opaque);
b2e12bc6 310BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
39aa9a12 311 BlockDriverCompletionFunc *cb, void *opaque);
4265d620
PB
312BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
313 int64_t sector_num, int nb_sectors,
314 BlockDriverCompletionFunc *cb, void *opaque);
faf07963
PB
315void bdrv_aio_cancel(BlockDriverAIOCB *acb);
316
40b4f539
KW
317typedef struct BlockRequest {
318 /* Fields to be filled by multiwrite caller */
319 int64_t sector;
320 int nb_sectors;
d20d9b7c 321 int flags;
40b4f539
KW
322 QEMUIOVector *qiov;
323 BlockDriverCompletionFunc *cb;
324 void *opaque;
325
326 /* Filled by multiwrite implementation */
327 int error;
328} BlockRequest;
329
330int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
331 int num_reqs);
332
7d780669 333/* sg packet commands */
221f715d
AL
334int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
335BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
336 unsigned long int req, void *buf,
337 BlockDriverCompletionFunc *cb, void *opaque);
7d780669 338
0f15423c
AL
339/* Invalidate any cached metadata used by image formats */
340void bdrv_invalidate_cache(BlockDriverState *bs);
341void bdrv_invalidate_cache_all(void);
342
07789269
BC
343void bdrv_clear_incoming_migration_all(void);
344
faf07963 345/* Ensure contents are flushed to disk. */
205ef796 346int bdrv_flush(BlockDriverState *bs);
07f07615 347int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
f0f0fdfe 348int bdrv_flush_all(void);
2bc93fed 349void bdrv_close_all(void);
922453bc 350void bdrv_drain_all(void);
c6ca28d6 351
bb8bf76f 352int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
4265d620 353int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
3ac21627 354int bdrv_has_zero_init_1(BlockDriverState *bs);
f2feebbd 355int bdrv_has_zero_init(BlockDriverState *bs);
4ce78691
PL
356bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs);
357bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs);
b6b8a333
PB
358int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num,
359 int nb_sectors, int *pnum);
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
ff06f5f3
PB
365void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error,
366 BlockdevOnError on_write_error);
1ceee0d5 367BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read);
3e1caa5f
PB
368BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error);
369void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action,
370 bool is_read, int error);
faf07963 371int bdrv_is_read_only(BlockDriverState *bs);
985a03b0 372int bdrv_is_sg(BlockDriverState *bs);
e900a7b7 373int bdrv_enable_write_cache(BlockDriverState *bs);
425b0148 374void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
faf07963
PB
375int bdrv_is_inserted(BlockDriverState *bs);
376int bdrv_media_changed(BlockDriverState *bs);
025e849a 377void bdrv_lock_medium(BlockDriverState *bs, bool locked);
f36f3949 378void bdrv_eject(BlockDriverState *bs, bool eject_flag);
f8d6bba1 379const char *bdrv_get_format_name(BlockDriverState *bs);
faf07963 380BlockDriverState *bdrv_find(const char *name);
2f399b0a 381BlockDriverState *bdrv_next(BlockDriverState *bs);
51de9760
AL
382void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
383 void *opaque);
faf07963 384int bdrv_is_encrypted(BlockDriverState *bs);
c0f4ce77 385int bdrv_key_required(BlockDriverState *bs);
faf07963 386int bdrv_set_key(BlockDriverState *bs, const char *key);
c0f4ce77 387int bdrv_query_missing_keys(void);
faf07963
PB
388void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
389 void *opaque);
390const char *bdrv_get_device_name(BlockDriverState *bs);
c8433287 391int bdrv_get_flags(BlockDriverState *bs);
faf07963
PB
392int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
393 const uint8_t *buf, int nb_sectors);
394int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
eae041fe 395ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs);
343bded4
PB
396void bdrv_round_to_clusters(BlockDriverState *bs,
397 int64_t sector_num, int nb_sectors,
398 int64_t *cluster_sector_num,
399 int *cluster_nb_sectors);
faf07963 400
045df330 401const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
faf07963
PB
402void bdrv_get_backing_filename(BlockDriverState *bs,
403 char *filename, int filename_size);
dc5a1371
PB
404void bdrv_get_full_backing_filename(BlockDriverState *bs,
405 char *dest, size_t sz);
199630b6 406int bdrv_is_snapshot(BlockDriverState *bs);
faf07963 407
faf07963
PB
408int path_is_absolute(const char *path);
409void path_combine(char *dest, int dest_size,
410 const char *base_path,
411 const char *filename);
412
cf8074b3 413int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
45566e9c
CH
414int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
415 int64_t pos, int size);
178e08a5 416
45566e9c
CH
417int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
418 int64_t pos, int size);
178e08a5 419
d92ada22
LC
420void bdrv_img_create(const char *filename, const char *fmt,
421 const char *base_filename, const char *base_fmt,
f382d43a
MR
422 char *options, uint64_t img_size, int flags,
423 Error **errp, bool quiet);
f88e1a42 424
7b6f9300 425void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
ba5b7ad4 426void *qemu_blockalign(BlockDriverState *bs, size_t size);
c53b1c51 427bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
ba5b7ad4 428
8f0720ec 429struct HBitmapIter;
e4654d2d
FZ
430typedef struct BdrvDirtyBitmap BdrvDirtyBitmap;
431BdrvDirtyBitmap *bdrv_create_dirty_bitmap(BlockDriverState *bs, int granularity);
432void bdrv_release_dirty_bitmap(BlockDriverState *bs, BdrvDirtyBitmap *bitmap);
21b56835 433BlockDirtyInfoList *bdrv_query_dirty_bitmaps(BlockDriverState *bs);
e4654d2d 434int bdrv_get_dirty(BlockDriverState *bs, BdrvDirtyBitmap *bitmap, int64_t sector);
1755da16
PB
435void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
436void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
e4654d2d
FZ
437void bdrv_dirty_iter_init(BlockDriverState *bs,
438 BdrvDirtyBitmap *bitmap, struct HBitmapIter *hbi);
439int64_t bdrv_get_dirty_count(BlockDriverState *bs, BdrvDirtyBitmap *bitmap);
8b9b0cc2 440
53fec9d3
SH
441void bdrv_enable_copy_on_read(BlockDriverState *bs);
442void bdrv_disable_copy_on_read(BlockDriverState *bs);
443
9fcb0251
FZ
444void bdrv_ref(BlockDriverState *bs);
445void bdrv_unref(BlockDriverState *bs);
db593f25
MT
446void bdrv_set_in_use(BlockDriverState *bs, int in_use);
447int bdrv_in_use(BlockDriverState *bs);
8b9b0cc2 448
4065742a
SH
449#ifdef CONFIG_LINUX_AIO
450int raw_get_aio_fd(BlockDriverState *bs);
451#else
452static inline int raw_get_aio_fd(BlockDriverState *bs)
453{
454 return -ENOTSUP;
455}
456#endif
457
a597e79c
CH
458enum BlockAcctType {
459 BDRV_ACCT_READ,
460 BDRV_ACCT_WRITE,
461 BDRV_ACCT_FLUSH,
462 BDRV_MAX_IOTYPE,
463};
464
465typedef struct BlockAcctCookie {
466 int64_t bytes;
c488c7f6 467 int64_t start_time_ns;
a597e79c
CH
468 enum BlockAcctType type;
469} BlockAcctCookie;
470
471void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
472 int64_t bytes, enum BlockAcctType type);
473void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);
474
8b9b0cc2 475typedef enum {
8252278a
KW
476 BLKDBG_L1_UPDATE,
477
478 BLKDBG_L1_GROW_ALLOC_TABLE,
479 BLKDBG_L1_GROW_WRITE_TABLE,
480 BLKDBG_L1_GROW_ACTIVATE_TABLE,
481
482 BLKDBG_L2_LOAD,
483 BLKDBG_L2_UPDATE,
484 BLKDBG_L2_UPDATE_COMPRESSED,
485 BLKDBG_L2_ALLOC_COW_READ,
486 BLKDBG_L2_ALLOC_WRITE,
487
8252278a 488 BLKDBG_READ_AIO,
8252278a
KW
489 BLKDBG_READ_BACKING_AIO,
490 BLKDBG_READ_COMPRESSED,
491
492 BLKDBG_WRITE_AIO,
493 BLKDBG_WRITE_COMPRESSED,
494
495 BLKDBG_VMSTATE_LOAD,
496 BLKDBG_VMSTATE_SAVE,
497
498 BLKDBG_COW_READ,
499 BLKDBG_COW_WRITE,
500
501 BLKDBG_REFTABLE_LOAD,
502 BLKDBG_REFTABLE_GROW,
afa50193 503 BLKDBG_REFTABLE_UPDATE,
8252278a
KW
504
505 BLKDBG_REFBLOCK_LOAD,
506 BLKDBG_REFBLOCK_UPDATE,
507 BLKDBG_REFBLOCK_UPDATE_PART,
508 BLKDBG_REFBLOCK_ALLOC,
509 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
510 BLKDBG_REFBLOCK_ALLOC_WRITE,
511 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
512 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
513 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
514
515 BLKDBG_CLUSTER_ALLOC,
516 BLKDBG_CLUSTER_ALLOC_BYTES,
517 BLKDBG_CLUSTER_FREE,
518
bf736fe3
KW
519 BLKDBG_FLUSH_TO_OS,
520 BLKDBG_FLUSH_TO_DISK,
521
8b9b0cc2
KW
522 BLKDBG_EVENT_MAX,
523} BlkDebugEvent;
524
525#define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
526void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
527
41c695c7
KW
528int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
529 const char *tag);
4cc70e93 530int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag);
41c695c7
KW
531int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
532bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);
533
8a4bc5aa 534#endif