[mirror_qemu.git] / include / block / dirty-bitmap.h

#ifndef BLOCK_DIRTY_BITMAP_H
#define BLOCK_DIRTY_BITMAP_H

#include "qemu-common.h"
#include "qemu/hbitmap.h"

BdrvDirtyBitmap *bdrv_create_dirty_bitmap(BlockDriverState *bs,
                                          uint32_t granularity,
                                          const char *name,
                                          Error **errp);
void bdrv_create_meta_dirty_bitmap(BdrvDirtyBitmap *bitmap,
                                   int chunk_size);
void bdrv_release_meta_dirty_bitmap(BdrvDirtyBitmap *bitmap);
int bdrv_dirty_bitmap_create_successor(BlockDriverState *bs,
                                       BdrvDirtyBitmap *bitmap,
                                       Error **errp);
BdrvDirtyBitmap *bdrv_dirty_bitmap_abdicate(BlockDriverState *bs,
                                            BdrvDirtyBitmap *bitmap,
                                            Error **errp);
BdrvDirtyBitmap *bdrv_reclaim_dirty_bitmap(BlockDriverState *bs,
                                           BdrvDirtyBitmap *bitmap,
                                           Error **errp);
BdrvDirtyBitmap *bdrv_find_dirty_bitmap(BlockDriverState *bs,
                                        const char *name);
void bdrv_dirty_bitmap_make_anon(BdrvDirtyBitmap *bitmap);
void bdrv_release_dirty_bitmap(BlockDriverState *bs, BdrvDirtyBitmap *bitmap);
void bdrv_release_named_dirty_bitmaps(BlockDriverState *bs);
void bdrv_release_persistent_dirty_bitmaps(BlockDriverState *bs);
void bdrv_remove_persistent_dirty_bitmap(BlockDriverState *bs,
                                         const char *name,
                                         Error **errp);
void bdrv_disable_dirty_bitmap(BdrvDirtyBitmap *bitmap);
void bdrv_enable_dirty_bitmap(BdrvDirtyBitmap *bitmap);
BlockDirtyInfoList *bdrv_query_dirty_bitmaps(BlockDriverState *bs);
uint32_t bdrv_get_default_bitmap_granularity(BlockDriverState *bs);
uint32_t bdrv_dirty_bitmap_granularity(const BdrvDirtyBitmap *bitmap);
uint32_t bdrv_dirty_bitmap_meta_granularity(BdrvDirtyBitmap *bitmap);
bool bdrv_dirty_bitmap_enabled(BdrvDirtyBitmap *bitmap);
bool bdrv_dirty_bitmap_frozen(BdrvDirtyBitmap *bitmap);
const char *bdrv_dirty_bitmap_name(const BdrvDirtyBitmap *bitmap);
int64_t bdrv_dirty_bitmap_size(const BdrvDirtyBitmap *bitmap);
DirtyBitmapStatus bdrv_dirty_bitmap_status(BdrvDirtyBitmap *bitmap);
void bdrv_set_dirty_bitmap(BdrvDirtyBitmap *bitmap,
                           int64_t cur_sector, int64_t nr_sectors);
void bdrv_reset_dirty_bitmap(BdrvDirtyBitmap *bitmap,
                             int64_t cur_sector, int64_t nr_sectors);
int bdrv_dirty_bitmap_get_meta(BlockDriverState *bs,
                               BdrvDirtyBitmap *bitmap, int64_t sector,
                               int nb_sectors);
int bdrv_dirty_bitmap_get_meta_locked(BlockDriverState *bs,
                                      BdrvDirtyBitmap *bitmap, int64_t sector,
                                      int nb_sectors);
void bdrv_dirty_bitmap_reset_meta(BlockDriverState *bs,
                                  BdrvDirtyBitmap *bitmap, int64_t sector,
                                  int nb_sectors);
BdrvDirtyBitmapIter *bdrv_dirty_meta_iter_new(BdrvDirtyBitmap *bitmap);
BdrvDirtyBitmapIter *bdrv_dirty_iter_new(BdrvDirtyBitmap *bitmap,
                                         uint64_t first_sector);
void bdrv_dirty_iter_free(BdrvDirtyBitmapIter *iter);

uint64_t bdrv_dirty_bitmap_serialization_size(const BdrvDirtyBitmap *bitmap,
                                              uint64_t start, uint64_t count);
uint64_t bdrv_dirty_bitmap_serialization_align(const BdrvDirtyBitmap *bitmap);
void bdrv_dirty_bitmap_serialize_part(const BdrvDirtyBitmap *bitmap,
                                      uint8_t *buf, uint64_t start,
                                      uint64_t count);
void bdrv_dirty_bitmap_deserialize_part(BdrvDirtyBitmap *bitmap,
                                        uint8_t *buf, uint64_t start,
                                        uint64_t count, bool finish);
void bdrv_dirty_bitmap_deserialize_zeroes(BdrvDirtyBitmap *bitmap,
                                          uint64_t start, uint64_t count,
                                          bool finish);
void bdrv_dirty_bitmap_deserialize_ones(BdrvDirtyBitmap *bitmap,
                                        uint64_t start, uint64_t count,
                                        bool finish);
void bdrv_dirty_bitmap_deserialize_finish(BdrvDirtyBitmap *bitmap);

void bdrv_dirty_bitmap_set_readonly(BdrvDirtyBitmap *bitmap, bool value);
void bdrv_dirty_bitmap_set_autoload(BdrvDirtyBitmap *bitmap, bool autoload);
void bdrv_dirty_bitmap_set_persistance(BdrvDirtyBitmap *bitmap,
                                       bool persistent);

/* Functions that require manual locking.  */
void bdrv_dirty_bitmap_lock(BdrvDirtyBitmap *bitmap);
void bdrv_dirty_bitmap_unlock(BdrvDirtyBitmap *bitmap);
int bdrv_get_dirty_locked(BlockDriverState *bs, BdrvDirtyBitmap *bitmap,
                          int64_t sector);
void bdrv_set_dirty_bitmap_locked(BdrvDirtyBitmap *bitmap,
                                  int64_t cur_sector, int64_t nr_sectors);
void bdrv_reset_dirty_bitmap_locked(BdrvDirtyBitmap *bitmap,
                                    int64_t cur_sector, int64_t nr_sectors);
int64_t bdrv_dirty_iter_next(BdrvDirtyBitmapIter *iter);
void bdrv_set_dirty_iter(BdrvDirtyBitmapIter *hbi, int64_t sector_num);
int64_t bdrv_get_dirty_count(BdrvDirtyBitmap *bitmap);
int64_t bdrv_get_meta_dirty_count(BdrvDirtyBitmap *bitmap);
void bdrv_dirty_bitmap_truncate(BlockDriverState *bs);
bool bdrv_dirty_bitmap_readonly(const BdrvDirtyBitmap *bitmap);
bool bdrv_has_readonly_bitmaps(BlockDriverState *bs);
bool bdrv_dirty_bitmap_get_autoload(const BdrvDirtyBitmap *bitmap);
bool bdrv_dirty_bitmap_get_persistance(BdrvDirtyBitmap *bitmap);
bool bdrv_has_changed_persistent_bitmaps(BlockDriverState *bs);
BdrvDirtyBitmap *bdrv_dirty_bitmap_next(BlockDriverState *bs,
                                        BdrvDirtyBitmap *bitmap);
char *bdrv_dirty_bitmap_sha256(const BdrvDirtyBitmap *bitmap, Error **errp);

#endif
Commit	Line	Data
ebab2259 FZ	1	#ifndef BLOCK_DIRTY_BITMAP_H
	2	#define BLOCK_DIRTY_BITMAP_H
	3
	4	#include "qemu-common.h"
	5	#include "qemu/hbitmap.h"
	6
	7	BdrvDirtyBitmap bdrv_create_dirty_bitmap(BlockDriverState bs,
	8	uint32_t granularity,
	9	const char *name,
	10	Error **errp);
fb933437 FZ	11	void bdrv_create_meta_dirty_bitmap(BdrvDirtyBitmap *bitmap,
	12	int chunk_size);
	13	void bdrv_release_meta_dirty_bitmap(BdrvDirtyBitmap *bitmap);
ebab2259 FZ	14	int bdrv_dirty_bitmap_create_successor(BlockDriverState *bs,
	15	BdrvDirtyBitmap *bitmap,
	16	Error **errp);
	17	BdrvDirtyBitmap bdrv_dirty_bitmap_abdicate(BlockDriverState bs,
	18	BdrvDirtyBitmap *bitmap,
	19	Error **errp);
	20	BdrvDirtyBitmap bdrv_reclaim_dirty_bitmap(BlockDriverState bs,
	21	BdrvDirtyBitmap *bitmap,
	22	Error **errp);
	23	BdrvDirtyBitmap bdrv_find_dirty_bitmap(BlockDriverState bs,
	24	const char *name);
	25	void bdrv_dirty_bitmap_make_anon(BdrvDirtyBitmap *bitmap);
	26	void bdrv_release_dirty_bitmap(BlockDriverState bs, BdrvDirtyBitmap bitmap);
	27	void bdrv_release_named_dirty_bitmaps(BlockDriverState *bs);
615b5dcf	28	void bdrv_release_persistent_dirty_bitmaps(BlockDriverState *bs);
56f364e6 VSO	29	void bdrv_remove_persistent_dirty_bitmap(BlockDriverState *bs,
	30	const char *name,
	31	Error **errp);
ebab2259 FZ	32	void bdrv_disable_dirty_bitmap(BdrvDirtyBitmap *bitmap);
	33	void bdrv_enable_dirty_bitmap(BdrvDirtyBitmap *bitmap);
	34	BlockDirtyInfoList bdrv_query_dirty_bitmaps(BlockDriverState bs);
	35	uint32_t bdrv_get_default_bitmap_granularity(BlockDriverState *bs);
ba06ff1a	36	uint32_t bdrv_dirty_bitmap_granularity(const BdrvDirtyBitmap *bitmap);
6d3f4049	37	uint32_t bdrv_dirty_bitmap_meta_granularity(BdrvDirtyBitmap *bitmap);
ebab2259 FZ	38	bool bdrv_dirty_bitmap_enabled(BdrvDirtyBitmap *bitmap);
ebab2259 FZ	39	bool bdrv_dirty_bitmap_frozen(BdrvDirtyBitmap *bitmap);
15891fac FZ	40	const char bdrv_dirty_bitmap_name(const BdrvDirtyBitmap bitmap);
15891fac FZ	41	int64_t bdrv_dirty_bitmap_size(const BdrvDirtyBitmap *bitmap);
ebab2259	42	DirtyBitmapStatus bdrv_dirty_bitmap_status(BdrvDirtyBitmap *bitmap);
ebab2259	43	void bdrv_set_dirty_bitmap(BdrvDirtyBitmap *bitmap,
6d078599	44	int64_t cur_sector, int64_t nr_sectors);
ebab2259	45	void bdrv_reset_dirty_bitmap(BdrvDirtyBitmap *bitmap,
6d078599	46	int64_t cur_sector, int64_t nr_sectors);
fb933437 FZ	47	int bdrv_dirty_bitmap_get_meta(BlockDriverState *bs,
	48	BdrvDirtyBitmap *bitmap, int64_t sector,
	49	int nb_sectors);
b64bd51e PB	50	int bdrv_dirty_bitmap_get_meta_locked(BlockDriverState *bs,
	51	BdrvDirtyBitmap *bitmap, int64_t sector,
	52	int nb_sectors);
fb933437 FZ	53	void bdrv_dirty_bitmap_reset_meta(BlockDriverState *bs,
	54	BdrvDirtyBitmap *bitmap, int64_t sector,
	55	int nb_sectors);
6d3f4049	56	BdrvDirtyBitmapIter bdrv_dirty_meta_iter_new(BdrvDirtyBitmap bitmap);
dc162c8e FZ	57	BdrvDirtyBitmapIter bdrv_dirty_iter_new(BdrvDirtyBitmap bitmap,
	58	uint64_t first_sector);
	59	void bdrv_dirty_iter_free(BdrvDirtyBitmapIter *iter);
ebab2259	60
882c36f5 VSO	61	uint64_t bdrv_dirty_bitmap_serialization_size(const BdrvDirtyBitmap *bitmap,
	62	uint64_t start, uint64_t count);
	63	uint64_t bdrv_dirty_bitmap_serialization_align(const BdrvDirtyBitmap *bitmap);
	64	void bdrv_dirty_bitmap_serialize_part(const BdrvDirtyBitmap *bitmap,
	65	uint8_t *buf, uint64_t start,
	66	uint64_t count);
	67	void bdrv_dirty_bitmap_deserialize_part(BdrvDirtyBitmap *bitmap,
	68	uint8_t *buf, uint64_t start,
	69	uint64_t count, bool finish);
	70	void bdrv_dirty_bitmap_deserialize_zeroes(BdrvDirtyBitmap *bitmap,
	71	uint64_t start, uint64_t count,
	72	bool finish);
6bdc8b71 VSO	73	void bdrv_dirty_bitmap_deserialize_ones(BdrvDirtyBitmap *bitmap,
	74	uint64_t start, uint64_t count,
	75	bool finish);
882c36f5 VSO	76	void bdrv_dirty_bitmap_deserialize_finish(BdrvDirtyBitmap *bitmap);
882c36f5 VSO	77
d6883bc9	78	void bdrv_dirty_bitmap_set_readonly(BdrvDirtyBitmap *bitmap, bool value);
a0319aac	79	void bdrv_dirty_bitmap_set_autoload(BdrvDirtyBitmap *bitmap, bool autoload);
a88b179f VSO	80	void bdrv_dirty_bitmap_set_persistance(BdrvDirtyBitmap *bitmap,
a88b179f VSO	81	bool persistent);
d6883bc9	82
b64bd51e PB	83	/* Functions that require manual locking. */
	84	void bdrv_dirty_bitmap_lock(BdrvDirtyBitmap *bitmap);
	85	void bdrv_dirty_bitmap_unlock(BdrvDirtyBitmap *bitmap);
	86	int bdrv_get_dirty_locked(BlockDriverState bs, BdrvDirtyBitmap bitmap,
	87	int64_t sector);
	88	void bdrv_set_dirty_bitmap_locked(BdrvDirtyBitmap *bitmap,
	89	int64_t cur_sector, int64_t nr_sectors);
	90	void bdrv_reset_dirty_bitmap_locked(BdrvDirtyBitmap *bitmap,
	91	int64_t cur_sector, int64_t nr_sectors);
	92	int64_t bdrv_dirty_iter_next(BdrvDirtyBitmapIter *iter);
	93	void bdrv_set_dirty_iter(BdrvDirtyBitmapIter *hbi, int64_t sector_num);
	94	int64_t bdrv_get_dirty_count(BdrvDirtyBitmap *bitmap);
	95	int64_t bdrv_get_meta_dirty_count(BdrvDirtyBitmap *bitmap);
	96	void bdrv_dirty_bitmap_truncate(BlockDriverState *bs);
d6883bc9 VSO	97	bool bdrv_dirty_bitmap_readonly(const BdrvDirtyBitmap *bitmap);
d6883bc9 VSO	98	bool bdrv_has_readonly_bitmaps(BlockDriverState *bs);
a0319aac	99	bool bdrv_dirty_bitmap_get_autoload(const BdrvDirtyBitmap *bitmap);
a88b179f VSO	100	bool bdrv_dirty_bitmap_get_persistance(BdrvDirtyBitmap *bitmap);
a88b179f VSO	101	bool bdrv_has_changed_persistent_bitmaps(BlockDriverState *bs);
3dd10a06 VSO	102	BdrvDirtyBitmap bdrv_dirty_bitmap_next(BlockDriverState bs,
3dd10a06 VSO	103	BdrvDirtyBitmap *bitmap);
a3b52535	104	char bdrv_dirty_bitmap_sha256(const BdrvDirtyBitmap bitmap, Error **errp);
b64bd51e	105
ebab2259	106	#endif