1#ifndef BLOCK_DIRTY_BITMAP_H
2#define BLOCK_DIRTY_BITMAP_H
3
4#include "block/block-common.h"
5#include "qapi/qapi-types-block-core.h"
6#include "qemu/hbitmap.h"
7
8typedef enum BitmapCheckFlags {
9 BDRV_BITMAP_BUSY = 1,
10 BDRV_BITMAP_RO = 2,
11 BDRV_BITMAP_INCONSISTENT = 4,
12} BitmapCheckFlags;
13
14#define BDRV_BITMAP_DEFAULT (BDRV_BITMAP_BUSY | BDRV_BITMAP_RO | \
15 BDRV_BITMAP_INCONSISTENT)
16#define BDRV_BITMAP_ALLOW_RO (BDRV_BITMAP_BUSY | BDRV_BITMAP_INCONSISTENT)
17
18#define BDRV_BITMAP_MAX_NAME_SIZE 1023
19
20bool bdrv_supports_persistent_dirty_bitmap(BlockDriverState *bs);
21BdrvDirtyBitmap *bdrv_create_dirty_bitmap(BlockDriverState *bs,
22 uint32_t granularity,
23 const char *name,
24 Error **errp);
25int bdrv_dirty_bitmap_create_successor(BdrvDirtyBitmap *bitmap,
26 Error **errp);
27BdrvDirtyBitmap *bdrv_dirty_bitmap_abdicate(BdrvDirtyBitmap *bitmap,
28 Error **errp);
29BdrvDirtyBitmap *bdrv_reclaim_dirty_bitmap(BdrvDirtyBitmap *bitmap,
30 Error **errp);
31void bdrv_dirty_bitmap_enable_successor(BdrvDirtyBitmap *bitmap);
32BdrvDirtyBitmap *bdrv_find_dirty_bitmap(BlockDriverState *bs,
33 const char *name);
34int bdrv_dirty_bitmap_check(const BdrvDirtyBitmap *bitmap, uint32_t flags,
35 Error **errp);
36void bdrv_release_dirty_bitmap(BdrvDirtyBitmap *bitmap);
37void bdrv_release_named_dirty_bitmaps(BlockDriverState *bs);
38
39int coroutine_fn GRAPH_RDLOCK
40bdrv_co_remove_persistent_dirty_bitmap(BlockDriverState *bs, const char *name,
41 Error **errp);
42int co_wrapper_bdrv_rdlock
43bdrv_remove_persistent_dirty_bitmap(BlockDriverState *bs, const char *name,
44 Error **errp);
45
46void bdrv_disable_dirty_bitmap(BdrvDirtyBitmap *bitmap);
47void bdrv_enable_dirty_bitmap(BdrvDirtyBitmap *bitmap);
48void bdrv_enable_dirty_bitmap_locked(BdrvDirtyBitmap *bitmap);
49BlockDirtyInfoList *bdrv_query_dirty_bitmaps(BlockDriverState *bs);
50uint32_t bdrv_get_default_bitmap_granularity(BlockDriverState *bs);
51uint32_t bdrv_dirty_bitmap_granularity(const BdrvDirtyBitmap *bitmap);
52bool bdrv_dirty_bitmap_enabled(BdrvDirtyBitmap *bitmap);
53bool bdrv_dirty_bitmap_has_successor(BdrvDirtyBitmap *bitmap);
54const char *bdrv_dirty_bitmap_name(const BdrvDirtyBitmap *bitmap);
55int64_t bdrv_dirty_bitmap_size(const BdrvDirtyBitmap *bitmap);
56void bdrv_set_dirty_bitmap(BdrvDirtyBitmap *bitmap,
57 int64_t offset, int64_t bytes);
58void bdrv_reset_dirty_bitmap(BdrvDirtyBitmap *bitmap,
59 int64_t offset, int64_t bytes);
60BdrvDirtyBitmapIter *bdrv_dirty_iter_new(BdrvDirtyBitmap *bitmap);
61void bdrv_dirty_iter_free(BdrvDirtyBitmapIter *iter);
62
63uint64_t bdrv_dirty_bitmap_serialization_size(const BdrvDirtyBitmap *bitmap,
64 uint64_t offset, uint64_t bytes);
65uint64_t bdrv_dirty_bitmap_serialization_align(const BdrvDirtyBitmap *bitmap);
66uint64_t bdrv_dirty_bitmap_serialization_coverage(int serialized_chunk_size,
67 const BdrvDirtyBitmap *bitmap);
68void bdrv_dirty_bitmap_serialize_part(const BdrvDirtyBitmap *bitmap,
69 uint8_t *buf, uint64_t offset,
70 uint64_t bytes);
71void bdrv_dirty_bitmap_deserialize_part(BdrvDirtyBitmap *bitmap,
72 uint8_t *buf, uint64_t offset,
73 uint64_t bytes, bool finish);
74void bdrv_dirty_bitmap_deserialize_zeroes(BdrvDirtyBitmap *bitmap,
75 uint64_t offset, uint64_t bytes,
76 bool finish);
77void bdrv_dirty_bitmap_deserialize_ones(BdrvDirtyBitmap *bitmap,
78 uint64_t offset, uint64_t bytes,
79 bool finish);
80void bdrv_dirty_bitmap_deserialize_finish(BdrvDirtyBitmap *bitmap);
81
82void bdrv_dirty_bitmap_set_readonly(BdrvDirtyBitmap *bitmap, bool value);
83void bdrv_dirty_bitmap_set_persistence(BdrvDirtyBitmap *bitmap,
84 bool persistent);
85void bdrv_dirty_bitmap_set_inconsistent(BdrvDirtyBitmap *bitmap);
86void bdrv_dirty_bitmap_set_busy(BdrvDirtyBitmap *bitmap, bool busy);
87bool bdrv_merge_dirty_bitmap(BdrvDirtyBitmap *dest, const BdrvDirtyBitmap *src,
88 HBitmap **backup, Error **errp);
89void bdrv_dirty_bitmap_skip_store(BdrvDirtyBitmap *bitmap, bool skip);
90bool bdrv_dirty_bitmap_get(BdrvDirtyBitmap *bitmap, int64_t offset);
91
92
93void bdrv_dirty_bitmap_lock(BdrvDirtyBitmap *bitmap);
94void bdrv_dirty_bitmap_unlock(BdrvDirtyBitmap *bitmap);
95bool bdrv_dirty_bitmap_get_locked(BdrvDirtyBitmap *bitmap, int64_t offset);
96void bdrv_set_dirty_bitmap_locked(BdrvDirtyBitmap *bitmap,
97 int64_t offset, int64_t bytes);
98void bdrv_reset_dirty_bitmap_locked(BdrvDirtyBitmap *bitmap,
99 int64_t offset, int64_t bytes);
100int64_t bdrv_dirty_iter_next(BdrvDirtyBitmapIter *iter);
101void bdrv_set_dirty_iter(BdrvDirtyBitmapIter *hbi, int64_t offset);
102int64_t bdrv_get_dirty_count(BdrvDirtyBitmap *bitmap);
103void bdrv_dirty_bitmap_truncate(BlockDriverState *bs, int64_t bytes);
104bool bdrv_dirty_bitmap_readonly(const BdrvDirtyBitmap *bitmap);
105bool bdrv_has_readonly_bitmaps(BlockDriverState *bs);
106bool bdrv_has_named_bitmaps(BlockDriverState *bs);
107bool bdrv_dirty_bitmap_get_autoload(const BdrvDirtyBitmap *bitmap);
108bool bdrv_dirty_bitmap_get_persistence(BdrvDirtyBitmap *bitmap);
109bool bdrv_dirty_bitmap_inconsistent(const BdrvDirtyBitmap *bitmap);
110
111BdrvDirtyBitmap *bdrv_dirty_bitmap_first(BlockDriverState *bs);
112BdrvDirtyBitmap *bdrv_dirty_bitmap_next(BdrvDirtyBitmap *bitmap);
113#define FOR_EACH_DIRTY_BITMAP(bs, bitmap) \
114for (bitmap = bdrv_dirty_bitmap_first(bs); bitmap; \
115 bitmap = bdrv_dirty_bitmap_next(bitmap))
116
117char *bdrv_dirty_bitmap_sha256(const BdrvDirtyBitmap *bitmap, Error **errp);
118int64_t bdrv_dirty_bitmap_next_dirty(BdrvDirtyBitmap *bitmap, int64_t offset,
119 int64_t bytes);
120int64_t bdrv_dirty_bitmap_next_zero(BdrvDirtyBitmap *bitmap, int64_t offset,
121 int64_t bytes);
122bool bdrv_dirty_bitmap_next_dirty_area(BdrvDirtyBitmap *bitmap,
123 int64_t start, int64_t end, int64_t max_dirty_count,
124 int64_t *dirty_start, int64_t *dirty_count);
125bool bdrv_dirty_bitmap_status(BdrvDirtyBitmap *bitmap, int64_t offset,
126 int64_t bytes, int64_t *count);
127BdrvDirtyBitmap *bdrv_reclaim_dirty_bitmap_locked(BdrvDirtyBitmap *bitmap,
128 Error **errp);
129
130#endif
131
