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