4 * Copyright (c) 2016-2017 Red Hat. Inc
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 #include "qemu/osdep.h"
25 #include "qapi/error.h"
27 #include "block/block_int.h"
28 #include "block/blockjob.h"
29 #include "qemu/main-loop.h"
31 struct BdrvDirtyBitmap
{
33 HBitmap
*bitmap
; /* Dirty bitmap implementation */
34 bool busy
; /* Bitmap is busy, it can't be used via QMP */
35 BdrvDirtyBitmap
*successor
; /* Anonymous child, if any. */
36 char *name
; /* Optional non-empty unique ID */
37 int64_t size
; /* Size of the bitmap, in bytes */
38 bool disabled
; /* Bitmap is disabled. It ignores all writes to
40 int active_iterators
; /* How many iterators are active */
41 bool readonly
; /* Bitmap is read-only. This field also
42 prevents the respective image from being
43 modified (i.e. blocks writes and discards).
44 Such operations must fail and both the image
45 and this bitmap must remain unchanged while
47 bool persistent
; /* bitmap must be saved to owner disk image */
48 bool inconsistent
; /* bitmap is persistent, but inconsistent.
49 It cannot be used at all in any way, except
50 a QMP user can remove it. */
51 bool skip_store
; /* We are either migrating or deleting this
52 * bitmap; it should not be stored on the next
54 QLIST_ENTRY(BdrvDirtyBitmap
) list
;
57 struct BdrvDirtyBitmapIter
{
59 BdrvDirtyBitmap
*bitmap
;
62 static inline void bdrv_dirty_bitmaps_lock(BlockDriverState
*bs
)
64 qemu_mutex_lock(&bs
->dirty_bitmap_mutex
);
67 static inline void bdrv_dirty_bitmaps_unlock(BlockDriverState
*bs
)
69 qemu_mutex_unlock(&bs
->dirty_bitmap_mutex
);
72 void bdrv_dirty_bitmap_lock(BdrvDirtyBitmap
*bitmap
)
74 qemu_mutex_lock(bitmap
->mutex
);
77 void bdrv_dirty_bitmap_unlock(BdrvDirtyBitmap
*bitmap
)
79 qemu_mutex_unlock(bitmap
->mutex
);
82 /* Called with BQL or dirty_bitmap lock taken. */
83 BdrvDirtyBitmap
*bdrv_find_dirty_bitmap(BlockDriverState
*bs
, const char *name
)
88 QLIST_FOREACH(bm
, &bs
->dirty_bitmaps
, list
) {
89 if (bm
->name
&& !strcmp(name
, bm
->name
)) {
96 /* Called with BQL taken. */
97 BdrvDirtyBitmap
*bdrv_create_dirty_bitmap(BlockDriverState
*bs
,
103 BdrvDirtyBitmap
*bitmap
;
105 assert(is_power_of_2(granularity
) && granularity
>= BDRV_SECTOR_SIZE
);
107 if (name
&& bdrv_find_dirty_bitmap(bs
, name
)) {
108 error_setg(errp
, "Bitmap already exists: %s", name
);
111 bitmap_size
= bdrv_getlength(bs
);
112 if (bitmap_size
< 0) {
113 error_setg_errno(errp
, -bitmap_size
, "could not get length of device");
114 errno
= -bitmap_size
;
117 bitmap
= g_new0(BdrvDirtyBitmap
, 1);
118 bitmap
->mutex
= &bs
->dirty_bitmap_mutex
;
119 bitmap
->bitmap
= hbitmap_alloc(bitmap_size
, ctz32(granularity
));
120 bitmap
->size
= bitmap_size
;
121 bitmap
->name
= g_strdup(name
);
122 bitmap
->disabled
= false;
123 bdrv_dirty_bitmaps_lock(bs
);
124 QLIST_INSERT_HEAD(&bs
->dirty_bitmaps
, bitmap
, list
);
125 bdrv_dirty_bitmaps_unlock(bs
);
129 int64_t bdrv_dirty_bitmap_size(const BdrvDirtyBitmap
*bitmap
)
134 const char *bdrv_dirty_bitmap_name(const BdrvDirtyBitmap
*bitmap
)
139 /* Called with BQL taken. */
140 bool bdrv_dirty_bitmap_has_successor(BdrvDirtyBitmap
*bitmap
)
142 return bitmap
->successor
;
145 static bool bdrv_dirty_bitmap_busy(const BdrvDirtyBitmap
*bitmap
)
150 void bdrv_dirty_bitmap_set_busy(BdrvDirtyBitmap
*bitmap
, bool busy
)
152 qemu_mutex_lock(bitmap
->mutex
);
154 qemu_mutex_unlock(bitmap
->mutex
);
157 /* Called with BQL taken. */
158 bool bdrv_dirty_bitmap_enabled(BdrvDirtyBitmap
*bitmap
)
160 return !bitmap
->disabled
;
164 * bdrv_dirty_bitmap_status: This API is now deprecated.
165 * Called with BQL taken.
167 * A BdrvDirtyBitmap can be in four possible user-visible states:
168 * (1) Active: successor is NULL, and disabled is false: full r/w mode
169 * (2) Disabled: successor is NULL, and disabled is true: qualified r/w mode,
170 * guest writes are dropped, but monitor writes are possible,
171 * through commands like merge and clear.
172 * (3) Frozen: successor is not NULL.
173 * A frozen bitmap cannot be renamed, deleted, cleared, set,
174 * enabled, merged to, etc. A frozen bitmap can only abdicate()
176 * In this state, the anonymous successor bitmap may be either
177 * Active and recording writes from the guest (e.g. backup jobs),
178 * or it can be Disabled and not recording writes.
179 * (4) Locked: Whether Active or Disabled, the user cannot modify this bitmap
180 * in any way from the monitor.
181 * (5) Inconsistent: This is a persistent bitmap whose "in use" bit is set, and
182 * is unusable by QEMU. It can be deleted to remove it from
185 DirtyBitmapStatus
bdrv_dirty_bitmap_status(BdrvDirtyBitmap
*bitmap
)
187 if (bdrv_dirty_bitmap_inconsistent(bitmap
)) {
188 return DIRTY_BITMAP_STATUS_INCONSISTENT
;
189 } else if (bdrv_dirty_bitmap_has_successor(bitmap
)) {
190 return DIRTY_BITMAP_STATUS_FROZEN
;
191 } else if (bdrv_dirty_bitmap_busy(bitmap
)) {
192 return DIRTY_BITMAP_STATUS_LOCKED
;
193 } else if (!bdrv_dirty_bitmap_enabled(bitmap
)) {
194 return DIRTY_BITMAP_STATUS_DISABLED
;
196 return DIRTY_BITMAP_STATUS_ACTIVE
;
200 /* Called with BQL taken. */
201 static bool bdrv_dirty_bitmap_recording(BdrvDirtyBitmap
*bitmap
)
203 return !bitmap
->disabled
|| (bitmap
->successor
&&
204 !bitmap
->successor
->disabled
);
207 int bdrv_dirty_bitmap_check(const BdrvDirtyBitmap
*bitmap
, uint32_t flags
,
210 if ((flags
& BDRV_BITMAP_BUSY
) && bdrv_dirty_bitmap_busy(bitmap
)) {
211 error_setg(errp
, "Bitmap '%s' is currently in use by another"
212 " operation and cannot be used", bitmap
->name
);
216 if ((flags
& BDRV_BITMAP_RO
) && bdrv_dirty_bitmap_readonly(bitmap
)) {
217 error_setg(errp
, "Bitmap '%s' is readonly and cannot be modified",
222 if ((flags
& BDRV_BITMAP_INCONSISTENT
) &&
223 bdrv_dirty_bitmap_inconsistent(bitmap
)) {
224 error_setg(errp
, "Bitmap '%s' is inconsistent and cannot be used",
226 error_append_hint(errp
, "Try block-dirty-bitmap-remove to delete"
227 " this bitmap from disk");
235 * Create a successor bitmap destined to replace this bitmap after an operation.
236 * Requires that the bitmap is not marked busy and has no successor.
237 * The successor will be enabled if the parent bitmap was.
238 * Called with BQL taken.
240 int bdrv_dirty_bitmap_create_successor(BlockDriverState
*bs
,
241 BdrvDirtyBitmap
*bitmap
, Error
**errp
)
243 uint64_t granularity
;
244 BdrvDirtyBitmap
*child
;
246 if (bdrv_dirty_bitmap_check(bitmap
, BDRV_BITMAP_BUSY
, errp
)) {
249 if (bdrv_dirty_bitmap_has_successor(bitmap
)) {
250 error_setg(errp
, "Cannot create a successor for a bitmap that already "
255 /* Create an anonymous successor */
256 granularity
= bdrv_dirty_bitmap_granularity(bitmap
);
257 child
= bdrv_create_dirty_bitmap(bs
, granularity
, NULL
, errp
);
262 /* Successor will be on or off based on our current state. */
263 child
->disabled
= bitmap
->disabled
;
264 bitmap
->disabled
= true;
266 /* Install the successor and mark the parent as busy */
267 bitmap
->successor
= child
;
272 void bdrv_enable_dirty_bitmap_locked(BdrvDirtyBitmap
*bitmap
)
274 bitmap
->disabled
= false;
277 /* Called with BQL taken. */
278 void bdrv_dirty_bitmap_enable_successor(BdrvDirtyBitmap
*bitmap
)
280 assert(bitmap
->mutex
== bitmap
->successor
->mutex
);
281 qemu_mutex_lock(bitmap
->mutex
);
282 bdrv_enable_dirty_bitmap_locked(bitmap
->successor
);
283 qemu_mutex_unlock(bitmap
->mutex
);
286 /* Called within bdrv_dirty_bitmap_lock..unlock and with BQL taken. */
287 static void bdrv_release_dirty_bitmap_locked(BdrvDirtyBitmap
*bitmap
)
289 assert(!bitmap
->active_iterators
);
290 assert(!bdrv_dirty_bitmap_busy(bitmap
));
291 assert(!bdrv_dirty_bitmap_has_successor(bitmap
));
292 QLIST_REMOVE(bitmap
, list
);
293 hbitmap_free(bitmap
->bitmap
);
294 g_free(bitmap
->name
);
299 * For a bitmap with a successor, yield our name to the successor,
300 * delete the old bitmap, and return a handle to the new bitmap.
301 * Called with BQL taken.
303 BdrvDirtyBitmap
*bdrv_dirty_bitmap_abdicate(BlockDriverState
*bs
,
304 BdrvDirtyBitmap
*bitmap
,
308 BdrvDirtyBitmap
*successor
= bitmap
->successor
;
310 if (successor
== NULL
) {
311 error_setg(errp
, "Cannot relinquish control if "
312 "there's no successor present");
318 successor
->name
= name
;
319 bitmap
->successor
= NULL
;
320 successor
->persistent
= bitmap
->persistent
;
321 bitmap
->persistent
= false;
322 bitmap
->busy
= false;
323 bdrv_release_dirty_bitmap(bs
, bitmap
);
329 * In cases of failure where we can no longer safely delete the parent,
330 * we may wish to re-join the parent and child/successor.
331 * The merged parent will be marked as not busy.
332 * The marged parent will be enabled if and only if the successor was enabled.
333 * Called within bdrv_dirty_bitmap_lock..unlock and with BQL taken.
335 BdrvDirtyBitmap
*bdrv_reclaim_dirty_bitmap_locked(BlockDriverState
*bs
,
336 BdrvDirtyBitmap
*parent
,
339 BdrvDirtyBitmap
*successor
= parent
->successor
;
342 error_setg(errp
, "Cannot reclaim a successor when none is present");
346 if (!hbitmap_merge(parent
->bitmap
, successor
->bitmap
, parent
->bitmap
)) {
347 error_setg(errp
, "Merging of parent and successor bitmap failed");
351 parent
->disabled
= successor
->disabled
;
352 parent
->busy
= false;
353 bdrv_release_dirty_bitmap_locked(successor
);
354 parent
->successor
= NULL
;
359 /* Called with BQL taken. */
360 BdrvDirtyBitmap
*bdrv_reclaim_dirty_bitmap(BlockDriverState
*bs
,
361 BdrvDirtyBitmap
*parent
,
364 BdrvDirtyBitmap
*ret
;
366 qemu_mutex_lock(parent
->mutex
);
367 ret
= bdrv_reclaim_dirty_bitmap_locked(bs
, parent
, errp
);
368 qemu_mutex_unlock(parent
->mutex
);
374 * Truncates _all_ bitmaps attached to a BDS.
375 * Called with BQL taken.
377 void bdrv_dirty_bitmap_truncate(BlockDriverState
*bs
, int64_t bytes
)
379 BdrvDirtyBitmap
*bitmap
;
381 bdrv_dirty_bitmaps_lock(bs
);
382 QLIST_FOREACH(bitmap
, &bs
->dirty_bitmaps
, list
) {
383 assert(!bdrv_dirty_bitmap_busy(bitmap
));
384 assert(!bdrv_dirty_bitmap_has_successor(bitmap
));
385 assert(!bitmap
->active_iterators
);
386 hbitmap_truncate(bitmap
->bitmap
, bytes
);
387 bitmap
->size
= bytes
;
389 bdrv_dirty_bitmaps_unlock(bs
);
392 /* Called with BQL taken. */
393 void bdrv_release_dirty_bitmap(BlockDriverState
*bs
, BdrvDirtyBitmap
*bitmap
)
395 bdrv_dirty_bitmaps_lock(bs
);
396 bdrv_release_dirty_bitmap_locked(bitmap
);
397 bdrv_dirty_bitmaps_unlock(bs
);
401 * Release all named dirty bitmaps attached to a BDS (for use in bdrv_close()).
402 * There must not be any busy bitmaps attached.
403 * This function does not remove persistent bitmaps from the storage.
404 * Called with BQL taken.
406 void bdrv_release_named_dirty_bitmaps(BlockDriverState
*bs
)
408 BdrvDirtyBitmap
*bm
, *next
;
410 bdrv_dirty_bitmaps_lock(bs
);
411 QLIST_FOREACH_SAFE(bm
, &bs
->dirty_bitmaps
, list
, next
) {
412 if (bdrv_dirty_bitmap_name(bm
)) {
413 bdrv_release_dirty_bitmap_locked(bm
);
416 bdrv_dirty_bitmaps_unlock(bs
);
420 * Remove persistent dirty bitmap from the storage if it exists.
421 * Absence of bitmap is not an error, because we have the following scenario:
422 * BdrvDirtyBitmap can have .persistent = true but not yet saved and have no
423 * stored version. For such bitmap bdrv_remove_persistent_dirty_bitmap() should
425 * This function doesn't release corresponding BdrvDirtyBitmap.
427 static int coroutine_fn
428 bdrv_co_remove_persistent_dirty_bitmap(BlockDriverState
*bs
, const char *name
,
431 if (bs
->drv
&& bs
->drv
->bdrv_co_remove_persistent_dirty_bitmap
) {
432 return bs
->drv
->bdrv_co_remove_persistent_dirty_bitmap(bs
, name
, errp
);
438 typedef struct BdrvRemovePersistentDirtyBitmapCo
{
439 BlockDriverState
*bs
;
443 } BdrvRemovePersistentDirtyBitmapCo
;
445 static void coroutine_fn
446 bdrv_co_remove_persistent_dirty_bitmap_entry(void *opaque
)
448 BdrvRemovePersistentDirtyBitmapCo
*s
= opaque
;
450 s
->ret
= bdrv_co_remove_persistent_dirty_bitmap(s
->bs
, s
->name
, s
->errp
);
454 int bdrv_remove_persistent_dirty_bitmap(BlockDriverState
*bs
, const char *name
,
457 if (qemu_in_coroutine()) {
458 return bdrv_co_remove_persistent_dirty_bitmap(bs
, name
, errp
);
461 BdrvRemovePersistentDirtyBitmapCo s
= {
468 co
= qemu_coroutine_create(bdrv_co_remove_persistent_dirty_bitmap_entry
,
470 bdrv_coroutine_enter(bs
, co
);
471 BDRV_POLL_WHILE(bs
, s
.ret
== -EINPROGRESS
);
477 static bool coroutine_fn
478 bdrv_co_can_store_new_dirty_bitmap(BlockDriverState
*bs
, const char *name
,
479 uint32_t granularity
, Error
**errp
)
481 BlockDriver
*drv
= bs
->drv
;
484 error_setg_errno(errp
, ENOMEDIUM
,
485 "Can't store persistent bitmaps to %s",
486 bdrv_get_device_or_node_name(bs
));
490 if (!drv
->bdrv_co_can_store_new_dirty_bitmap
) {
491 error_setg_errno(errp
, ENOTSUP
,
492 "Can't store persistent bitmaps to %s",
493 bdrv_get_device_or_node_name(bs
));
497 return drv
->bdrv_co_can_store_new_dirty_bitmap(bs
, name
, granularity
, errp
);
500 typedef struct BdrvCanStoreNewDirtyBitmapCo
{
501 BlockDriverState
*bs
;
503 uint32_t granularity
;
508 } BdrvCanStoreNewDirtyBitmapCo
;
510 static void coroutine_fn
bdrv_co_can_store_new_dirty_bitmap_entry(void *opaque
)
512 BdrvCanStoreNewDirtyBitmapCo
*s
= opaque
;
514 s
->ret
= bdrv_co_can_store_new_dirty_bitmap(s
->bs
, s
->name
, s
->granularity
,
516 s
->in_progress
= false;
520 bool bdrv_can_store_new_dirty_bitmap(BlockDriverState
*bs
, const char *name
,
521 uint32_t granularity
, Error
**errp
)
523 if (qemu_in_coroutine()) {
524 return bdrv_co_can_store_new_dirty_bitmap(bs
, name
, granularity
, errp
);
527 BdrvCanStoreNewDirtyBitmapCo s
= {
530 .granularity
= granularity
,
535 co
= qemu_coroutine_create(bdrv_co_can_store_new_dirty_bitmap_entry
,
537 bdrv_coroutine_enter(bs
, co
);
538 BDRV_POLL_WHILE(bs
, s
.in_progress
);
544 void bdrv_disable_dirty_bitmap(BdrvDirtyBitmap
*bitmap
)
546 bdrv_dirty_bitmap_lock(bitmap
);
547 bitmap
->disabled
= true;
548 bdrv_dirty_bitmap_unlock(bitmap
);
551 void bdrv_enable_dirty_bitmap(BdrvDirtyBitmap
*bitmap
)
553 bdrv_dirty_bitmap_lock(bitmap
);
554 bdrv_enable_dirty_bitmap_locked(bitmap
);
555 bdrv_dirty_bitmap_unlock(bitmap
);
558 BlockDirtyInfoList
*bdrv_query_dirty_bitmaps(BlockDriverState
*bs
)
561 BlockDirtyInfoList
*list
= NULL
;
562 BlockDirtyInfoList
**plist
= &list
;
564 bdrv_dirty_bitmaps_lock(bs
);
565 QLIST_FOREACH(bm
, &bs
->dirty_bitmaps
, list
) {
566 BlockDirtyInfo
*info
= g_new0(BlockDirtyInfo
, 1);
567 BlockDirtyInfoList
*entry
= g_new0(BlockDirtyInfoList
, 1);
568 info
->count
= bdrv_get_dirty_count(bm
);
569 info
->granularity
= bdrv_dirty_bitmap_granularity(bm
);
570 info
->has_name
= !!bm
->name
;
571 info
->name
= g_strdup(bm
->name
);
572 info
->status
= bdrv_dirty_bitmap_status(bm
);
573 info
->recording
= bdrv_dirty_bitmap_recording(bm
);
574 info
->busy
= bdrv_dirty_bitmap_busy(bm
);
575 info
->persistent
= bm
->persistent
;
576 info
->has_inconsistent
= bm
->inconsistent
;
577 info
->inconsistent
= bm
->inconsistent
;
580 plist
= &entry
->next
;
582 bdrv_dirty_bitmaps_unlock(bs
);
587 /* Called within bdrv_dirty_bitmap_lock..unlock */
588 bool bdrv_dirty_bitmap_get_locked(BdrvDirtyBitmap
*bitmap
, int64_t offset
)
590 return hbitmap_get(bitmap
->bitmap
, offset
);
593 bool bdrv_dirty_bitmap_get(BdrvDirtyBitmap
*bitmap
, int64_t offset
)
596 bdrv_dirty_bitmap_lock(bitmap
);
597 ret
= bdrv_dirty_bitmap_get_locked(bitmap
, offset
);
598 bdrv_dirty_bitmap_unlock(bitmap
);
604 * Chooses a default granularity based on the existing cluster size,
605 * but clamped between [4K, 64K]. Defaults to 64K in the case that there
606 * is no cluster size information available.
608 uint32_t bdrv_get_default_bitmap_granularity(BlockDriverState
*bs
)
611 uint32_t granularity
;
613 if (bdrv_get_info(bs
, &bdi
) >= 0 && bdi
.cluster_size
> 0) {
614 granularity
= MAX(4096, bdi
.cluster_size
);
615 granularity
= MIN(65536, granularity
);
623 uint32_t bdrv_dirty_bitmap_granularity(const BdrvDirtyBitmap
*bitmap
)
625 return 1U << hbitmap_granularity(bitmap
->bitmap
);
628 BdrvDirtyBitmapIter
*bdrv_dirty_iter_new(BdrvDirtyBitmap
*bitmap
)
630 BdrvDirtyBitmapIter
*iter
= g_new(BdrvDirtyBitmapIter
, 1);
631 hbitmap_iter_init(&iter
->hbi
, bitmap
->bitmap
, 0);
632 iter
->bitmap
= bitmap
;
633 bitmap
->active_iterators
++;
637 void bdrv_dirty_iter_free(BdrvDirtyBitmapIter
*iter
)
642 assert(iter
->bitmap
->active_iterators
> 0);
643 iter
->bitmap
->active_iterators
--;
647 int64_t bdrv_dirty_iter_next(BdrvDirtyBitmapIter
*iter
)
649 return hbitmap_iter_next(&iter
->hbi
);
652 /* Called within bdrv_dirty_bitmap_lock..unlock */
653 void bdrv_set_dirty_bitmap_locked(BdrvDirtyBitmap
*bitmap
,
654 int64_t offset
, int64_t bytes
)
656 assert(!bdrv_dirty_bitmap_readonly(bitmap
));
657 hbitmap_set(bitmap
->bitmap
, offset
, bytes
);
660 void bdrv_set_dirty_bitmap(BdrvDirtyBitmap
*bitmap
,
661 int64_t offset
, int64_t bytes
)
663 bdrv_dirty_bitmap_lock(bitmap
);
664 bdrv_set_dirty_bitmap_locked(bitmap
, offset
, bytes
);
665 bdrv_dirty_bitmap_unlock(bitmap
);
668 /* Called within bdrv_dirty_bitmap_lock..unlock */
669 void bdrv_reset_dirty_bitmap_locked(BdrvDirtyBitmap
*bitmap
,
670 int64_t offset
, int64_t bytes
)
672 assert(!bdrv_dirty_bitmap_readonly(bitmap
));
673 hbitmap_reset(bitmap
->bitmap
, offset
, bytes
);
676 void bdrv_reset_dirty_bitmap(BdrvDirtyBitmap
*bitmap
,
677 int64_t offset
, int64_t bytes
)
679 bdrv_dirty_bitmap_lock(bitmap
);
680 bdrv_reset_dirty_bitmap_locked(bitmap
, offset
, bytes
);
681 bdrv_dirty_bitmap_unlock(bitmap
);
684 void bdrv_clear_dirty_bitmap(BdrvDirtyBitmap
*bitmap
, HBitmap
**out
)
686 assert(!bdrv_dirty_bitmap_readonly(bitmap
));
687 bdrv_dirty_bitmap_lock(bitmap
);
689 hbitmap_reset_all(bitmap
->bitmap
);
691 HBitmap
*backup
= bitmap
->bitmap
;
692 bitmap
->bitmap
= hbitmap_alloc(bitmap
->size
,
693 hbitmap_granularity(backup
));
696 bdrv_dirty_bitmap_unlock(bitmap
);
699 void bdrv_restore_dirty_bitmap(BdrvDirtyBitmap
*bitmap
, HBitmap
*backup
)
701 HBitmap
*tmp
= bitmap
->bitmap
;
702 assert(!bdrv_dirty_bitmap_readonly(bitmap
));
703 bitmap
->bitmap
= backup
;
707 uint64_t bdrv_dirty_bitmap_serialization_size(const BdrvDirtyBitmap
*bitmap
,
708 uint64_t offset
, uint64_t bytes
)
710 return hbitmap_serialization_size(bitmap
->bitmap
, offset
, bytes
);
713 uint64_t bdrv_dirty_bitmap_serialization_align(const BdrvDirtyBitmap
*bitmap
)
715 return hbitmap_serialization_align(bitmap
->bitmap
);
718 void bdrv_dirty_bitmap_serialize_part(const BdrvDirtyBitmap
*bitmap
,
719 uint8_t *buf
, uint64_t offset
,
722 hbitmap_serialize_part(bitmap
->bitmap
, buf
, offset
, bytes
);
725 void bdrv_dirty_bitmap_deserialize_part(BdrvDirtyBitmap
*bitmap
,
726 uint8_t *buf
, uint64_t offset
,
727 uint64_t bytes
, bool finish
)
729 hbitmap_deserialize_part(bitmap
->bitmap
, buf
, offset
, bytes
, finish
);
732 void bdrv_dirty_bitmap_deserialize_zeroes(BdrvDirtyBitmap
*bitmap
,
733 uint64_t offset
, uint64_t bytes
,
736 hbitmap_deserialize_zeroes(bitmap
->bitmap
, offset
, bytes
, finish
);
739 void bdrv_dirty_bitmap_deserialize_ones(BdrvDirtyBitmap
*bitmap
,
740 uint64_t offset
, uint64_t bytes
,
743 hbitmap_deserialize_ones(bitmap
->bitmap
, offset
, bytes
, finish
);
746 void bdrv_dirty_bitmap_deserialize_finish(BdrvDirtyBitmap
*bitmap
)
748 hbitmap_deserialize_finish(bitmap
->bitmap
);
751 void bdrv_set_dirty(BlockDriverState
*bs
, int64_t offset
, int64_t bytes
)
753 BdrvDirtyBitmap
*bitmap
;
755 if (QLIST_EMPTY(&bs
->dirty_bitmaps
)) {
759 bdrv_dirty_bitmaps_lock(bs
);
760 QLIST_FOREACH(bitmap
, &bs
->dirty_bitmaps
, list
) {
761 if (!bdrv_dirty_bitmap_enabled(bitmap
)) {
764 assert(!bdrv_dirty_bitmap_readonly(bitmap
));
765 hbitmap_set(bitmap
->bitmap
, offset
, bytes
);
767 bdrv_dirty_bitmaps_unlock(bs
);
771 * Advance a BdrvDirtyBitmapIter to an arbitrary offset.
773 void bdrv_set_dirty_iter(BdrvDirtyBitmapIter
*iter
, int64_t offset
)
775 hbitmap_iter_init(&iter
->hbi
, iter
->hbi
.hb
, offset
);
778 int64_t bdrv_get_dirty_count(BdrvDirtyBitmap
*bitmap
)
780 return hbitmap_count(bitmap
->bitmap
);
783 bool bdrv_dirty_bitmap_readonly(const BdrvDirtyBitmap
*bitmap
)
785 return bitmap
->readonly
;
788 /* Called with BQL taken. */
789 void bdrv_dirty_bitmap_set_readonly(BdrvDirtyBitmap
*bitmap
, bool value
)
791 qemu_mutex_lock(bitmap
->mutex
);
792 bitmap
->readonly
= value
;
793 qemu_mutex_unlock(bitmap
->mutex
);
796 bool bdrv_has_readonly_bitmaps(BlockDriverState
*bs
)
799 QLIST_FOREACH(bm
, &bs
->dirty_bitmaps
, list
) {
808 /* Called with BQL taken. */
809 void bdrv_dirty_bitmap_set_persistence(BdrvDirtyBitmap
*bitmap
, bool persistent
)
811 qemu_mutex_lock(bitmap
->mutex
);
812 bitmap
->persistent
= persistent
;
813 qemu_mutex_unlock(bitmap
->mutex
);
816 /* Called with BQL taken. */
817 void bdrv_dirty_bitmap_set_inconsistent(BdrvDirtyBitmap
*bitmap
)
819 qemu_mutex_lock(bitmap
->mutex
);
820 assert(bitmap
->persistent
== true);
821 bitmap
->inconsistent
= true;
822 bitmap
->disabled
= true;
823 qemu_mutex_unlock(bitmap
->mutex
);
826 /* Called with BQL taken. */
827 void bdrv_dirty_bitmap_skip_store(BdrvDirtyBitmap
*bitmap
, bool skip
)
829 qemu_mutex_lock(bitmap
->mutex
);
830 bitmap
->skip_store
= skip
;
831 qemu_mutex_unlock(bitmap
->mutex
);
834 bool bdrv_dirty_bitmap_get_persistence(BdrvDirtyBitmap
*bitmap
)
836 return bitmap
->persistent
&& !bitmap
->skip_store
;
839 bool bdrv_dirty_bitmap_inconsistent(const BdrvDirtyBitmap
*bitmap
)
841 return bitmap
->inconsistent
;
844 bool bdrv_has_changed_persistent_bitmaps(BlockDriverState
*bs
)
847 QLIST_FOREACH(bm
, &bs
->dirty_bitmaps
, list
) {
848 if (bm
->persistent
&& !bm
->readonly
&& !bm
->skip_store
) {
856 BdrvDirtyBitmap
*bdrv_dirty_bitmap_next(BlockDriverState
*bs
,
857 BdrvDirtyBitmap
*bitmap
)
859 return bitmap
== NULL
? QLIST_FIRST(&bs
->dirty_bitmaps
) :
860 QLIST_NEXT(bitmap
, list
);
863 char *bdrv_dirty_bitmap_sha256(const BdrvDirtyBitmap
*bitmap
, Error
**errp
)
865 return hbitmap_sha256(bitmap
->bitmap
, errp
);
868 int64_t bdrv_dirty_bitmap_next_zero(BdrvDirtyBitmap
*bitmap
, uint64_t offset
,
871 return hbitmap_next_zero(bitmap
->bitmap
, offset
, bytes
);
874 bool bdrv_dirty_bitmap_next_dirty_area(BdrvDirtyBitmap
*bitmap
,
875 uint64_t *offset
, uint64_t *bytes
)
877 return hbitmap_next_dirty_area(bitmap
->bitmap
, offset
, bytes
);
881 * bdrv_merge_dirty_bitmap: merge src into dest.
882 * Ensures permissions on bitmaps are reasonable; use for public API.
884 * @backup: If provided, make a copy of dest here prior to merge.
886 void bdrv_merge_dirty_bitmap(BdrvDirtyBitmap
*dest
, const BdrvDirtyBitmap
*src
,
887 HBitmap
**backup
, Error
**errp
)
891 qemu_mutex_lock(dest
->mutex
);
892 if (src
->mutex
!= dest
->mutex
) {
893 qemu_mutex_lock(src
->mutex
);
896 if (bdrv_dirty_bitmap_check(dest
, BDRV_BITMAP_DEFAULT
, errp
)) {
900 if (bdrv_dirty_bitmap_check(src
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
904 if (!hbitmap_can_merge(dest
->bitmap
, src
->bitmap
)) {
905 error_setg(errp
, "Bitmaps are incompatible and can't be merged");
909 ret
= bdrv_dirty_bitmap_merge_internal(dest
, src
, backup
, false);
913 qemu_mutex_unlock(dest
->mutex
);
914 if (src
->mutex
!= dest
->mutex
) {
915 qemu_mutex_unlock(src
->mutex
);
920 * bdrv_dirty_bitmap_merge_internal: merge src into dest.
921 * Does NOT check bitmap permissions; not suitable for use as public API.
923 * @backup: If provided, make a copy of dest here prior to merge.
924 * @lock: If true, lock and unlock bitmaps on the way in/out.
925 * returns true if the merge succeeded; false if unattempted.
927 bool bdrv_dirty_bitmap_merge_internal(BdrvDirtyBitmap
*dest
,
928 const BdrvDirtyBitmap
*src
,
934 assert(!bdrv_dirty_bitmap_readonly(dest
));
935 assert(!bdrv_dirty_bitmap_inconsistent(dest
));
936 assert(!bdrv_dirty_bitmap_inconsistent(src
));
939 qemu_mutex_lock(dest
->mutex
);
940 if (src
->mutex
!= dest
->mutex
) {
941 qemu_mutex_lock(src
->mutex
);
946 *backup
= dest
->bitmap
;
947 dest
->bitmap
= hbitmap_alloc(dest
->size
, hbitmap_granularity(*backup
));
948 ret
= hbitmap_merge(*backup
, src
->bitmap
, dest
->bitmap
);
950 ret
= hbitmap_merge(dest
->bitmap
, src
->bitmap
, dest
->bitmap
);
954 qemu_mutex_unlock(dest
->mutex
);
955 if (src
->mutex
!= dest
->mutex
) {
956 qemu_mutex_unlock(src
->mutex
);