ostd::mm

Struct DmaCoherent

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

A coherent (or consistent) DMA mapping, which guarantees that the device and the CPU can access the data in parallel.

The mapping will be destroyed automatically when the object is dropped.

Implementations§

Source§

impl DmaCoherent

Source

pub fn map(segment: USegment, is_cache_coherent: bool) -> Result<Self, DmaError>

Creates a coherent DMA mapping backed by segment.

The is_cache_coherent argument specifies whether the target device that the DMA mapping is prepared for can access the main memory in a CPU cache coherent way or not.

The method fails if any part of the given segment already belongs to a DMA mapping.

Methods from Deref<Target = USegment>§

Source

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

Gets an extra handle to the frames in the byte offset range.

The sliced byte offset range in indexed by the offset from the start of the contiguous frames. The resulting frames holds extra reference counts.

§Panics

The function panics if the byte offset range is out of bounds, or if any of the ends of the byte offset range is not base-page aligned.

Trait Implementations§

Source§

impl Debug for DmaCoherent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for DmaCoherent

Source§

type Target = Segment<dyn AnyUFrameMeta>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl Drop for DmaCoherent

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl HasDaddr for DmaCoherent

Source§

fn daddr(&self) -> Daddr

Returns the base address of the mapping in the device address space.
Source§

impl HasPaddr for DmaCoherent

Source§

fn paddr(&self) -> Paddr

Returns the start physical address of the memory object.
Source§

impl HasSize for DmaCoherent

Source§

fn size(&self) -> usize

Returns the size of the memory object in bytes.
Source§

impl HasVmReaderWriter for DmaCoherent

Source§

type Types = VmReaderWriterIdentity

A marker type that denotes the return types of Self::reader and Self::writer. Read more
Source§

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

Returns a reader to read data from it.
Source§

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

Returns a writer to write data to it.

Auto Trait Implementations§

§

impl Freeze for DmaCoherent

§

impl !RefUnwindSafe for DmaCoherent

§

impl Send for DmaCoherent

§

impl Sync for DmaCoherent

§

impl !Unpin for DmaCoherent

§

impl !UnwindSafe for DmaCoherent

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> HasPaddrRange for T
where T: HasPaddr + HasSize,

Source§

fn end_paddr(&self) -> usize

Returns the end physical address of the memory object.
Source§

fn paddr_range(&self) -> Range<usize>

Returns the physical address range of the memory object.
§

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

§

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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.
Source§

impl<S> VmIo for S
where S: HasVmReaderWriter + Send + Sync,

Source§

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

Reads requested data at a specified offset into a given VmWriter. Read more
Source§

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

Reads a specified number of bytes at a specified offset into a given buffer. Read more
Source§

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

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

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

Writes all data from a given VmReader at a specified offset. Read more
Source§

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

Writes a specified number of bytes from a given buffer at a specified offset. Read more
Source§

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

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

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

Reads a slice of a specified type at a specified offset. Read more
Source§

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

Writes a slice of a specified type at a specified offset. Read more
Source§

impl<S> VmIoFill for S
where S: HasVmReaderWriter,

Source§

fn fill_zeros(&self, offset: usize, len: usize) -> Result<(), (Error, usize)>

Writes len zeros at a specified offset. Read more
Source§

impl<S> VmIoOnce for S
where S: HasVmReaderWriter,

Source§

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

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

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

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