xref: /qemu/include/block/dirty-bitmap.h (revision c4e4b0fa598ddc9cee6ba7a06899ce0a8dae6c61)
1ebab2259SFam Zheng #ifndef BLOCK_DIRTY_BITMAP_H
2ebab2259SFam Zheng #define BLOCK_DIRTY_BITMAP_H
3ebab2259SFam Zheng 
49af23989SMarkus Armbruster #include "qapi/qapi-types-block-core.h"
5ebab2259SFam Zheng #include "qemu/hbitmap.h"
6ebab2259SFam Zheng 
73ae96d66SJohn Snow typedef enum BitmapCheckFlags {
83ae96d66SJohn Snow     BDRV_BITMAP_BUSY = 1,
93ae96d66SJohn Snow     BDRV_BITMAP_RO = 2,
103ae96d66SJohn Snow     BDRV_BITMAP_INCONSISTENT = 4,
113ae96d66SJohn Snow } BitmapCheckFlags;
123ae96d66SJohn Snow 
133ae96d66SJohn Snow #define BDRV_BITMAP_DEFAULT (BDRV_BITMAP_BUSY | BDRV_BITMAP_RO |        \
143ae96d66SJohn Snow                              BDRV_BITMAP_INCONSISTENT)
153ae96d66SJohn Snow #define BDRV_BITMAP_ALLOW_RO (BDRV_BITMAP_BUSY | BDRV_BITMAP_INCONSISTENT)
163ae96d66SJohn Snow 
17ebab2259SFam Zheng BdrvDirtyBitmap *bdrv_create_dirty_bitmap(BlockDriverState *bs,
18ebab2259SFam Zheng                                           uint32_t granularity,
19ebab2259SFam Zheng                                           const char *name,
20ebab2259SFam Zheng                                           Error **errp);
21fb933437SFam Zheng void bdrv_create_meta_dirty_bitmap(BdrvDirtyBitmap *bitmap,
22fb933437SFam Zheng                                    int chunk_size);
23fb933437SFam Zheng void bdrv_release_meta_dirty_bitmap(BdrvDirtyBitmap *bitmap);
24ebab2259SFam Zheng int bdrv_dirty_bitmap_create_successor(BlockDriverState *bs,
25ebab2259SFam Zheng                                        BdrvDirtyBitmap *bitmap,
26ebab2259SFam Zheng                                        Error **errp);
27ebab2259SFam Zheng BdrvDirtyBitmap *bdrv_dirty_bitmap_abdicate(BlockDriverState *bs,
28ebab2259SFam Zheng                                             BdrvDirtyBitmap *bitmap,
29ebab2259SFam Zheng                                             Error **errp);
30ebab2259SFam Zheng BdrvDirtyBitmap *bdrv_reclaim_dirty_bitmap(BlockDriverState *bs,
31ebab2259SFam Zheng                                            BdrvDirtyBitmap *bitmap,
32ebab2259SFam Zheng                                            Error **errp);
33e73a265eSVladimir Sementsov-Ogievskiy void bdrv_dirty_bitmap_enable_successor(BdrvDirtyBitmap *bitmap);
34ebab2259SFam Zheng BdrvDirtyBitmap *bdrv_find_dirty_bitmap(BlockDriverState *bs,
35ebab2259SFam Zheng                                         const char *name);
363ae96d66SJohn Snow int bdrv_dirty_bitmap_check(const BdrvDirtyBitmap *bitmap, uint32_t flags,
373ae96d66SJohn Snow                             Error **errp);
38ebab2259SFam Zheng void bdrv_release_dirty_bitmap(BlockDriverState *bs, BdrvDirtyBitmap *bitmap);
39ebab2259SFam Zheng void bdrv_release_named_dirty_bitmaps(BlockDriverState *bs);
4056f364e6SVladimir Sementsov-Ogievskiy void bdrv_remove_persistent_dirty_bitmap(BlockDriverState *bs,
4156f364e6SVladimir Sementsov-Ogievskiy                                          const char *name,
4256f364e6SVladimir Sementsov-Ogievskiy                                          Error **errp);
43ebab2259SFam Zheng void bdrv_disable_dirty_bitmap(BdrvDirtyBitmap *bitmap);
44ebab2259SFam Zheng void bdrv_enable_dirty_bitmap(BdrvDirtyBitmap *bitmap);
4592bcea40SVladimir Sementsov-Ogievskiy void bdrv_enable_dirty_bitmap_locked(BdrvDirtyBitmap *bitmap);
46ebab2259SFam Zheng BlockDirtyInfoList *bdrv_query_dirty_bitmaps(BlockDriverState *bs);
47ebab2259SFam Zheng uint32_t bdrv_get_default_bitmap_granularity(BlockDriverState *bs);
48ba06ff1aSVladimir Sementsov-Ogievskiy uint32_t bdrv_dirty_bitmap_granularity(const BdrvDirtyBitmap *bitmap);
49ebab2259SFam Zheng bool bdrv_dirty_bitmap_enabled(BdrvDirtyBitmap *bitmap);
5050a47257SJohn Snow bool bdrv_dirty_bitmap_has_successor(BdrvDirtyBitmap *bitmap);
5115891facSFam Zheng const char *bdrv_dirty_bitmap_name(const BdrvDirtyBitmap *bitmap);
5215891facSFam Zheng int64_t bdrv_dirty_bitmap_size(const BdrvDirtyBitmap *bitmap);
53ebab2259SFam Zheng DirtyBitmapStatus bdrv_dirty_bitmap_status(BdrvDirtyBitmap *bitmap);
54ebab2259SFam Zheng void bdrv_set_dirty_bitmap(BdrvDirtyBitmap *bitmap,
55e0d7f73eSEric Blake                            int64_t offset, int64_t bytes);
56ebab2259SFam Zheng void bdrv_reset_dirty_bitmap(BdrvDirtyBitmap *bitmap,
57e0d7f73eSEric Blake                              int64_t offset, int64_t bytes);
586d3f4049SFam Zheng BdrvDirtyBitmapIter *bdrv_dirty_meta_iter_new(BdrvDirtyBitmap *bitmap);
59715a74d8SEric Blake BdrvDirtyBitmapIter *bdrv_dirty_iter_new(BdrvDirtyBitmap *bitmap);
60dc162c8eSFam Zheng void bdrv_dirty_iter_free(BdrvDirtyBitmapIter *iter);
61ebab2259SFam Zheng 
62882c36f5SVladimir Sementsov-Ogievskiy uint64_t bdrv_dirty_bitmap_serialization_size(const BdrvDirtyBitmap *bitmap,
6386f6ae67SEric Blake                                               uint64_t offset, uint64_t bytes);
64882c36f5SVladimir Sementsov-Ogievskiy uint64_t bdrv_dirty_bitmap_serialization_align(const BdrvDirtyBitmap *bitmap);
65882c36f5SVladimir Sementsov-Ogievskiy void bdrv_dirty_bitmap_serialize_part(const BdrvDirtyBitmap *bitmap,
6686f6ae67SEric Blake                                       uint8_t *buf, uint64_t offset,
6786f6ae67SEric Blake                                       uint64_t bytes);
68882c36f5SVladimir Sementsov-Ogievskiy void bdrv_dirty_bitmap_deserialize_part(BdrvDirtyBitmap *bitmap,
6986f6ae67SEric Blake                                         uint8_t *buf, uint64_t offset,
7086f6ae67SEric Blake                                         uint64_t bytes, bool finish);
71882c36f5SVladimir Sementsov-Ogievskiy void bdrv_dirty_bitmap_deserialize_zeroes(BdrvDirtyBitmap *bitmap,
7286f6ae67SEric Blake                                           uint64_t offset, uint64_t bytes,
73882c36f5SVladimir Sementsov-Ogievskiy                                           bool finish);
746bdc8b71SVladimir Sementsov-Ogievskiy void bdrv_dirty_bitmap_deserialize_ones(BdrvDirtyBitmap *bitmap,
7586f6ae67SEric Blake                                         uint64_t offset, uint64_t bytes,
766bdc8b71SVladimir Sementsov-Ogievskiy                                         bool finish);
77882c36f5SVladimir Sementsov-Ogievskiy void bdrv_dirty_bitmap_deserialize_finish(BdrvDirtyBitmap *bitmap);
78882c36f5SVladimir Sementsov-Ogievskiy 
79d6883bc9SVladimir Sementsov-Ogievskiy void bdrv_dirty_bitmap_set_readonly(BdrvDirtyBitmap *bitmap, bool value);
80796a3798SEric Blake void bdrv_dirty_bitmap_set_persistence(BdrvDirtyBitmap *bitmap,
81a88b179fSVladimir Sementsov-Ogievskiy                                        bool persistent);
82b0f45559SJohn Snow void bdrv_dirty_bitmap_set_inconsistent(BdrvDirtyBitmap *bitmap);
8327a1b301SJohn Snow void bdrv_dirty_bitmap_set_busy(BdrvDirtyBitmap *bitmap, bool busy);
84b598e531SVladimir Sementsov-Ogievskiy void bdrv_merge_dirty_bitmap(BdrvDirtyBitmap *dest, const BdrvDirtyBitmap *src,
85fa000f2fSVladimir Sementsov-Ogievskiy                              HBitmap **backup, Error **errp);
86*c4e4b0faSJohn Snow void bdrv_dirty_bitmap_skip_store(BdrvDirtyBitmap *bitmap, bool skip);
8728636b82SJohn Snow bool bdrv_dirty_bitmap_get(BdrvDirtyBitmap *bitmap, int64_t offset);
88d6883bc9SVladimir Sementsov-Ogievskiy 
89b64bd51eSPaolo Bonzini /* Functions that require manual locking.  */
90b64bd51eSPaolo Bonzini void bdrv_dirty_bitmap_lock(BdrvDirtyBitmap *bitmap);
91b64bd51eSPaolo Bonzini void bdrv_dirty_bitmap_unlock(BdrvDirtyBitmap *bitmap);
9228636b82SJohn Snow bool bdrv_dirty_bitmap_get_locked(BdrvDirtyBitmap *bitmap, int64_t offset);
93b64bd51eSPaolo Bonzini void bdrv_set_dirty_bitmap_locked(BdrvDirtyBitmap *bitmap,
94e0d7f73eSEric Blake                                   int64_t offset, int64_t bytes);
95b64bd51eSPaolo Bonzini void bdrv_reset_dirty_bitmap_locked(BdrvDirtyBitmap *bitmap,
96e0d7f73eSEric Blake                                     int64_t offset, int64_t bytes);
97b64bd51eSPaolo Bonzini int64_t bdrv_dirty_iter_next(BdrvDirtyBitmapIter *iter);
98715a74d8SEric Blake void bdrv_set_dirty_iter(BdrvDirtyBitmapIter *hbi, int64_t offset);
99b64bd51eSPaolo Bonzini int64_t bdrv_get_dirty_count(BdrvDirtyBitmap *bitmap);
100b64bd51eSPaolo Bonzini int64_t bdrv_get_meta_dirty_count(BdrvDirtyBitmap *bitmap);
1011b6cc579SEric Blake void bdrv_dirty_bitmap_truncate(BlockDriverState *bs, int64_t bytes);
102d6883bc9SVladimir Sementsov-Ogievskiy bool bdrv_dirty_bitmap_readonly(const BdrvDirtyBitmap *bitmap);
103d6883bc9SVladimir Sementsov-Ogievskiy bool bdrv_has_readonly_bitmaps(BlockDriverState *bs);
104a0319aacSVladimir Sementsov-Ogievskiy bool bdrv_dirty_bitmap_get_autoload(const BdrvDirtyBitmap *bitmap);
105796a3798SEric Blake bool bdrv_dirty_bitmap_get_persistence(BdrvDirtyBitmap *bitmap);
106b0f45559SJohn Snow bool bdrv_dirty_bitmap_inconsistent(const BdrvDirtyBitmap *bitmap);
107a88b179fSVladimir Sementsov-Ogievskiy bool bdrv_has_changed_persistent_bitmaps(BlockDriverState *bs);
1083dd10a06SVladimir Sementsov-Ogievskiy BdrvDirtyBitmap *bdrv_dirty_bitmap_next(BlockDriverState *bs,
1093dd10a06SVladimir Sementsov-Ogievskiy                                         BdrvDirtyBitmap *bitmap);
110a3b52535SVladimir Sementsov-Ogievskiy char *bdrv_dirty_bitmap_sha256(const BdrvDirtyBitmap *bitmap, Error **errp);
11176d570dcSVladimir Sementsov-Ogievskiy int64_t bdrv_dirty_bitmap_next_zero(BdrvDirtyBitmap *bitmap, uint64_t offset,
11276d570dcSVladimir Sementsov-Ogievskiy                                     uint64_t bytes);
113a78a1a48SVladimir Sementsov-Ogievskiy bool bdrv_dirty_bitmap_next_dirty_area(BdrvDirtyBitmap *bitmap,
114a78a1a48SVladimir Sementsov-Ogievskiy                                        uint64_t *offset, uint64_t *bytes);
115044ee8e1SVladimir Sementsov-Ogievskiy BdrvDirtyBitmap *bdrv_reclaim_dirty_bitmap_locked(BlockDriverState *bs,
116044ee8e1SVladimir Sementsov-Ogievskiy                                                   BdrvDirtyBitmap *bitmap,
117044ee8e1SVladimir Sementsov-Ogievskiy                                                   Error **errp);
118b64bd51eSPaolo Bonzini 
119ebab2259SFam Zheng #endif
120