Struct ostd::mm::frame::Frame

pub struct Frame { /* private fields */ }

A handle to a physical memory page of untyped memory.

An instance of Frame is a handle to a page frame (a physical memory page). A cloned Frame refers to the same page frame as the original. As the original and cloned instances point to the same physical address,
they are treated as equal to each other. Behind the scene, a reference counter is maintained for each page frame so that when all instances of Frame that refer to the same page frame are dropped, the page frame will be globally freed.

Implementations

impl Frame

pub fn start_paddr(&self) -> Paddr

Returns the physical address of the page frame.

pub fn end_paddr(&self) -> Paddr

Returns the end physical address of the page frame.

pub const fn size(&self) -> usize

Returns the size of the frame

pub fn as_ptr(&self) -> *const u8

Returns a raw pointer to the starting virtual address of the frame.

pub fn as_mut_ptr(&self) -> *mut u8

Returns a mutable raw pointer to the starting virtual address of the frame.

pub fn copy_from(&self, src: &Frame)

Copies the content of src to the frame.

impl<'a> Frame

pub fn reader(&'a self) -> VmReader<'a>

Returns a reader to read data from it.

pub fn writer(&'a self) -> VmWriter<'a>

Returns a writer to write data into it.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl From<Frame> for Segment

fn from(frame: Frame) -> Self

Converts to this type from the input type.

impl HasPaddr for Frame

fn paddr(&self) -> Paddr

Returns the physical address.

impl ItemEntry for Frame

type Ref<'a> = FrameRef<'a> where Self: 'a

A type that behaves just like a shared references to the underleying data.

fn into_raw(self) -> *const ()

Converts the original value into a *const (), consuming the ownership of the original value.

unsafe fn from_raw(raw: *const ()) -> Self

Recovers the original value from a *const (), reclaiming the ownership of the original value.

unsafe fn raw_as_ref<'a>(raw: *const ()) -> Self::Ref<'a>

Obtains a shared reference to the original value.

impl VmIo for Frame

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 write_bytes(&self, offset: usize, buf: &[u8]) -> Result<()>

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

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_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).