Struct AtomicBitmap

pub struct AtomicBitmap { /* private fields */ }

Available on crate feature backend-bitmap only.

AtomicBitmap implements a simple bit map on the page level with test and set operations. It is page-size aware, so it converts addresses to page numbers before setting or clearing the bits.

Implementations

impl AtomicBitmap

pub fn new(byte_size: usize, page_size: NonZeroUsize) -> Self

Create a new bitmap of byte_size, with one bit per page. This is effectively rounded up, and we get a new vector of the next multiple of 64 bigger than bit_size.

pub fn enlarge(&mut self, additional_size: usize)

Enlarge this bitmap with enough bits to track additional_size additional bytes at page granularity. New bits are initialized to zero.

pub fn is_bit_set(&self, index: usize) -> bool

Is bit n set? Bits outside the range of the bitmap are always unset.

pub fn is_addr_set(&self, addr: usize) -> bool

Is the bit corresponding to address addr set?

pub fn set_addr_range(&self, start_addr: usize, len: usize)

Set a range of len bytes starting at start_addr. The first bit set in the bitmap is for the page corresponding to start_addr, and the last bit that we set corresponds to address start_addr + len - 1.

pub fn reset_addr_range(&self, start_addr: usize, len: usize)

Reset a range of len bytes starting at start_addr. The first bit set in the bitmap is for the page corresponding to start_addr, and the last bit that we set corresponds to address start_addr + len - 1.

pub fn set_bit(&self, index: usize)

Set bit to corresponding index

pub fn reset_bit(&self, index: usize)

Reset bit to corresponding index

pub fn len(&self) -> usize

Get the length of the bitmap in bits (i.e. in how many pages it can represent).

pub fn byte_size(&self) -> usize

Get the size in bytes i.e how many bytes the bitmap can represent, one bit per page.

pub fn get_and_reset(&self) -> Vec<u64>

Atomically get and reset the dirty page bitmap.

pub fn reset(&self)

Reset all bitmap bits to 0.

Trait Implementations

impl Bitmap for AtomicBitmap

fn mark_dirty(&self, offset: usize, len: usize)

Mark the memory range specified by the given offset and len as dirtied.

fn dirty_at(&self, offset: usize) -> bool

Check whether the specified offset is marked as dirty.

fn slice_at(&self, offset: usize) -> <Self as WithBitmapSlice<'_>>::S

Return a <Self as WithBitmapSlice>::S slice of the current bitmap, starting at the specified offset.

impl Clone for AtomicBitmap

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AtomicBitmap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AtomicBitmap

fn default() -> Self

Returns the “default value” for a type.

impl NewBitmap for AtomicBitmap

Available on crate feature backend-mmap only.

fn with_len(len: usize) -> Self

Create a new object based on the specified length in bytes.

impl<'a> WithBitmapSlice<'a> for AtomicBitmap

type S = BaseSlice<&'a AtomicBitmap>

Type of the bitmap slice.