Struct ostd::mm::frame::segment::Segment

pub struct Segment { /* private fields */ }

A handle to a contiguous range of page frames (physical memory pages).

The biggest difference between Segment and FrameVec is that the page frames must be contiguous for Segment.

A cloned Segment refers to the same page frames as the original. As the original and cloned instances point to the same physical address,
they are treated as equal to each other.

#Example

let vm_segment = FrameAllocOptions::new(2)
    .is_contiguous(true)
    .alloc_contiguous()?;
vm_segment.write_bytes(0, buf)?;

Implementations

impl Segment

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

Returns a part of the Segment.

Panics

If range is not within the range of this Segment, then the method panics.

pub fn start_paddr(&self) -> Paddr

Returns the start physical address.

pub fn end_paddr(&self) -> Paddr

Returns the end physical address.

pub fn nframes(&self) -> usize

Returns the number of page frames.

pub fn nbytes(&self) -> usize

Returns the number of bytes.

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

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

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

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

impl<'a> Segment

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 Segment

fn clone(&self) -> Segment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Segment

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 Segment

fn paddr(&self) -> Paddr

Returns the physical address.

impl VmIo for Segment

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