Struct IoMem

pub struct IoMem {
    kvirt_area: Arc<KVirtArea>,
    offset: usize,
    limit: usize,
    pa: Paddr,
}

I/O memory.

Fields

kvirt_area: Arc<KVirtArea>

offset: usize

limit: usize

pa: Paddr

Implementations

impl IoMem

pub fn acquire(range: Range<Paddr>) -> Result<IoMem>

Acquires an IoMem instance for the given range.

pub fn paddr(&self) -> Paddr

Returns the physical address of the I/O memory.

pub fn length(&self) -> usize

Returns the length of the I/O memory region.

pub fn slice(&self, range: Range<usize>) -> Self

Slices the IoMem, returning another IoMem representing the subslice.

Panics

This method will panic if the range is empty or out of bounds.

pub(crate) unsafe fn new( range: Range<Paddr>, flags: PageFlags, cache: CachePolicy, ) -> Self

Creates a new IoMem.

Safety

• The given physical address range must be in the I/O memory region.
• Reading from or writing to I/O memory regions may have side effects. Those side effects must not cause soundness problems (e.g., they must not corrupt the kernel memory).

impl IoMem

fn reader(&self) -> VmReader<'_, Infallible>

fn writer(&self) -> VmWriter<'_, Infallible>

Trait Implementations

impl Clone for IoMem

fn clone(&self) -> IoMem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IoMem

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

Formats the value using the given formatter.

impl Drop for IoMem

fn drop(&mut self)

Executes the destructor for this type.

impl HasPaddr for IoMem

fn paddr(&self) -> Paddr

Returns the physical address.

impl VmIo for IoMem

fn read(&self, offset: usize, writer: &mut VmWriter<'_>) -> Result<()>

Reads requested data at a specified offset into a given VmWriter.

fn write(&self, offset: usize, reader: &mut VmReader<'_>) -> Result<()>

Writes all data from a given VmReader at a specified offset.

fn read_bytes(&self, offset: usize, buf: &mut [u8]) -> Result<()>

Reads a specified number of bytes at a specified offset into a given buffer.

fn read_val<T: Pod>(&self, offset: usize) -> Result<T>

Reads a value of a specified type at a specified offset.

fn read_slice<T: Pod>(&self, offset: usize, slice: &mut [T]) -> Result<()>

Reads a slice of a specified type at a specified offset.

fn write_bytes(&self, offset: usize, buf: &[u8]) -> Result<()>

Writes a specified number of bytes from a given buffer at a specified offset.

fn write_val<T: Pod>(&self, offset: usize, new_val: &T) -> Result<()>

Writes a value of a specified type at a specified offset.

fn write_slice<T: Pod>(&self, offset: usize, slice: &[T]) -> Result<()>

Writes a slice of a specified type at a specified offset.

fn write_vals<'a, T: Pod + 'a, I: Iterator<Item = &'a T>>( &self, offset: usize, iter: I, align: usize, ) -> Result<usize>

Writes a sequence of values given by an iterator (iter) from the specified offset (offset).

impl VmIoOnce for IoMem

fn read_once<T: PodOnce>(&self, offset: usize) -> Result<T>

Reads a value of the PodOnce type at the specified offset using one non-tearing memory load.

fn write_once<T: PodOnce>(&self, offset: usize, new_val: &T) -> Result<()>

Writes a value of the PodOnce type at the specified offset using one non-tearing memory store.