Struct vhost_user_backend::bitmap::BitmapMmapRegion

pub struct BitmapMmapRegion { /* private fields */ }

BitmapMmapRegion implements a bitmap tha can be replaced at runtime. The main use case is to support live migration on vhost-user backends (see VHOST_USER_PROTOCOL_F_LOG_SHMFD and VHOST_USER_SET_LOG_BASE in the vhost-user protocol specification). It uses a fixed memory page size of VHOST_LOG_PAGE bytes (i.e., 4096 bytes), so it converts addresses to page numbers before setting or clearing the bits.

To use this bitmap you need to define the memory as GuestMemoryMmap<BitmapMmapRegion>.

Note: This implementation uses std::sync::RwLock, the priority policy of the lock is dependent on the underlying operating system’s implementation and does not guarantee any particular policy, in systems other than linux a thread trying to acquire the lock may starve.

Trait Implementations

impl Bitmap for BitmapMmapRegion

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 BitmapReplace for BitmapMmapRegion

type InnerBitmap = AtomicBitmapMmap

fn replace(&self, bitmap: AtomicBitmapMmap)

Replace the internal Bitmap

impl Clone for BitmapMmapRegion

fn clone(&self) -> BitmapMmapRegion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitmapMmapRegion

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

Formats the value using the given formatter.

impl Default for BitmapMmapRegion

fn default() -> BitmapMmapRegion

Returns the “default value” for a type.

impl NewBitmap for BitmapMmapRegion

fn with_len(_len: usize) -> Self

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

impl<'a> WithBitmapSlice<'a> for BitmapMmapRegion

type S = BitmapMmapRegion

Type of the bitmap slice.

impl BitmapSlice for BitmapMmapRegion