Expand description
Interfaces to read and write guest memory.
Modules§
- ranges
GuestMemory-backed readers and writers for guest memory ranges.
Structs§
- Aligned
Heap Memory - A page-aligned heap allocation for use with
GuestMemory. - Bitmap
Info - Returned by
GuestMemoryAccess::access_bitmap. - Guest
Memory - A wrapper around a
GuestMemoryAccessthat provides methods for safely reading and writing guest memory. - Guest
Memory Backing Error - A memory access error returned by a
GuestMemoryAccesstrait method. - Guest
Memory Error - A memory access error returned by one of the
GuestMemorymethods. - Guest
Memory Sharing - Opaque control object for accessing the shareable backing of guest
memory. Not all
GuestMemoryinstances support this — those backed by private memory or heap allocations returnNone. - Invalid
Gpn - Limit
- Wraps a
MemoryRead/MemoryWritewith a byte cap. - Locked
Pages - Locked
Range Impl - Page
Fault Error - An error returned by a page fault handler in
GuestMemoryAccess::page_fault. - Shareable
Region - A shareable region of guest memory backed by a file (Unix) or section handle (Windows).
Enums§
- Access
Error - An error accessing byte-oriented guest memory via
MemoryReadorMemoryWrite. - Access
Type - The type of access that guest memory will be used for.
- Guest
Memory Error Kind - The kind of memory access error.
- Guest
Memory Operation - Describes the guest-memory operation that failed.
- Multi
Region Error - Page
Fault Action - The action to take after
GuestMemoryAccess::page_faultreturns to continue the operation.
Constants§
- PAGE_
SIZE - Effective page size for page-related operations shared with
guestmem.
Traits§
- Doorbell
Registration - Doorbell provides a mechanism to register for notifications on writes to specific addresses in guest memory.
- Guest
Memory Access - A trait for a guest memory backing.
- Linear
Guest Memory - A trait for a guest memory backing that is fully available via a virtual
address mapping, as opposed to the fallback functions such as
GuestMemoryAccess::read_fallback. - Locked
Range - Represents a range of locked guest pages as an ordered list of the VA sub-ranges to which the guest pages are mapped. The range may only partially span the first and last page and must fully span all intermediate pages.
- MapRom
- Trait to map a ROM at one or more locations in guest memory.
- Mappable
Guest Memory - Trait implemented to allow mapping and unmapping a region of memory at a particular guest address.
- Mapped
Memory Region - Trait implemented for a region of memory that can have memory mapped into it.
- Memory
Mapper - Trait implemented to allow the creation of memory regions.
- Memory
Read - Memory
Write - A trait for sequentially updating a region of memory.
- Provide
Shareable Regions - Trait for providing shareable region information.
- Unmap
Rom - Trait to unmap a ROM from guest memory.
Functions§
- rcu
- The RCU domain memory accesses occur under. Updates to any memory access bitmaps must be synchronized under this domain.
Type Aliases§
- Page
- The
[AtomicU8; PAGE_SIZE]representation of a single page. - Shareable
Region Error - Error type for
ProvideShareableRegions::get_regions.