Skip to main content

UserSliceRead

Struct UserSliceRead 

Source
pub struct UserSliceRead { /* private fields */ }
Expand description

A validated read-only reference to a user-space memory region.

Construction validates that [ptr, ptr+len) is mapped and readable by the current process. After construction, the kernel can safely read from this region.

Note: The mapping could theoretically be changed by another thread between validation and use. On our single-core kernel this can’t happen because we don’t preempt during a syscall handler (interrupts are re-enabled but the scheduler won’t remove our mappings). For SMP this would need additional protection (e.g. pinning pages).

Implementations§

Source§

impl UserSliceRead

Source

pub fn new(ptr: u64, len: usize) -> Result<Self, UserSliceError>

Create a new validated read-only user slice.

Fails if:

  • ptr is null
  • ptr + len overflows or crosses into kernel space
  • Any page in the range is not mapped or not user-accessible
Source

pub fn len(&self) -> usize

The length of the validated region in bytes.

Source

pub fn is_empty(&self) -> bool

Whether the region is empty (zero length).

Source

pub fn read_to_vec(&self) -> Vec<u8>

Copy validated user data into a kernel-owned Vec<u8>.

Returns a vector containing a copy of the user memory.

Source

pub fn copy_to(&self, dest: &mut [u8]) -> usize

Copy validated user data into a kernel buffer.

Copies min(self.len, dest.len()) bytes and returns how many were copied.

Source

pub fn read_u8(&self, offset: usize) -> Result<u8, UserSliceError>

Read a single byte from the user slice at the given offset.

Source

pub fn read_u64(&self, offset: usize) -> Result<u64, UserSliceError>

Read a u64 from the user slice at the given offset.

Source

pub fn read_val<T: Copy>(&self) -> Result<T, UserSliceError>

Read a value of type T from the user slice.

§Safety

The caller must ensure that T is Pod (plain old data) and that the slice is at least size_of::() bytes.

Source

pub fn as_ptr(&self) -> u64

Get the raw pointer (for logging/debugging only).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.