MmWithUser in kernel::mm - Rust
Skip to main content MmWithUser kernel :: mm Struct MmWith User Source pub struct MmWithUser { /* private fields */ } Expand description A wrapper for the kernel’s struct mm_struct . This type is like Mm , but with non-zero mm_users . It can only be used when mm_users can be proven to be non-zero at compile-time, usually because the relevant code holds an mmget refcount. It can be used to access the associated address space.
The ARef<MmWithUser> smart pointer holds an mmget refcount. Its destructor may sleep. § Invariants Values of this type are always refcounted using mmget . The value of mm_users is non-zero. Implementations § Source § impl MmWithUser Source pub fn into_mmput_async (me: ARef < MmWithUser >) -> ARef < MmWithUserAsync > Use mmput_async when dropping this refcount. Source § impl MmWithUser Source pub unsafe fn from_raw <'a>(ptr: *const mm_struct) -> &'a MmWithUser Obtain a reference from a raw pointer. § Safety The caller must ensure that ptr points at an mm_struct , and that mm_users remains non-zero for the duration of the lifetime ’a.
Source pub fn lock_vma_under_rcu (&self, vma_addr: usize ) -> Option < VmaReadGuard <'_>> Attempt to access a vma using the vma read lock. This is an optimistic trylock operation, so it may fail if there is contention. In that case, you should fall back to taking the mmap read lock. Source pub fn vma_start_read_unlocked ( &self, vma_addr: usize , ) -> Option < VmaReadGuard <'_>> Find the VMA covering ‘address’ and read-lock it.
The fast path does not take mmap_lock. Waits for writers to finish if the VMA is being modified by taking mmap_lock. Use when mmap_lock is not held, otherwise use vma_start_read_locked(). Nothing prevents VMAs being unmapped/mapped before or after the VMA is looked up, if a stronger guarantee is required, take an mmap_lock. Return: If a VMA exists which spans @address, return that VMA, read-locked. If no VMA is mapped there or, very unlikely, a reference count overflow occurred, return NULL.
Source pub fn mmap_read_lock (&self) -> MmapReadGuard <'_> Lock the mmap read lock. Source pub fn mmap_read_trylock (&self) -> Option < MmapReadGuard <'_>> Try to lock the mmap read lock. Methods from Deref <Target = Mm > § Source pub fn as_raw (&self) -> *mut mm_struct Returns a raw pointer to the inner mm_struct . Source pub fn mmget_not_zero (&self) -> Option < ARef < MmWithUser >> Calls mmget_not_zero and returns a handle if it succeeds.
Trait Implementations § Source § impl AlwaysRefCounted for MmWithUser Source § fn inc_ref (&self) Increments the reference count on the object. Source § unsafe fn dec_ref (obj: NonNull <Self>) Decrements the reference count on the object. Read more Source § impl Deref for MmWithUser Source § type Target = Mm The resulting type after dereferencing. Source § fn deref (&self) -> & Mm Dereferences the value. Source § impl Send for MmWithUser Source § impl Sync for MmWithUser Auto Trait Implementations § § impl !
Freeze for MmWithUser § impl ! RefUnwindSafe for MmWithUser § impl ! Unpin for MmWithUser § impl ! UnsafeUnpin for MmWithUser § impl UnwindSafe for MmWithUser 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<ST, DT> CastableFrom <ST, Initialized , Initialized > for DT where ST: ? Sized , DT: ? Sized , Source § impl<ST, DT> CastableFrom <ST, Uninit , Uninit > for DT where ST: ? Sized , DT: ? Sized , Source § impl<T> From <T> for T Source § fn from (t: T) -> T Returns the argument unchanged.
Source § impl<T> Init <T> for T Source § fn chain <F>(self, f: F) -> ChainInit <Self, F, T, E> where F: FnOnce ( &mut T ) -> Result < () , E>, First initializes the value using self then calls the function f with the initialized value. Read more 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<S, T> IntoSafeCast <T> for S where T: FromSafeCast <S>, Source § fn into_safe_cast (self) -> T Convert self into a T . This operation is guaranteed to be lossless. Source § impl<S, T> IntoSafeCastArch <T> for S where T: FromSafeCastArch <S>, Source § fn into_safe_cast_arch (self) -> T Convert self into a T . This operation is guaranteed to be lossless. Source § impl<T> KnownSize for T Source § const MIN_SIZE : usize = const MIN_SIZE: usize = size_of::<T>(); Minimum size of this type known at compile-time.
Source § const MIN_ALIGN : Alignment = const MIN_ALIGN: Alignment = Alignment::of::<T>(); Minimum alignment of this type known at compile-time. Source § fn size (_: *const T ) -> usize Get the size of an object of this type in bytes, with the metadata of the given pointer. Source § impl<T> PinInit <T> for T Source § unsafe fn __init (self, slot: *mut T ) -> Result < () , ! > Initializes slot . Read more Source § fn pin_chain <F>(self, f: F) -> ChainPinInit <Self, F, T, E> where F: FnOnce ( Pin < &mut T >) -> Result < () , E>, First initializes the value using self then calls the function f with the initialized value.
Read more Source § impl<T> Read < Exclusive , BecauseExclusive > for T where T: ? Sized , Source § impl<P, T> Receiver for P where P: Deref <Target = T> + ? Sized , T: ? Sized , Source § 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, U> TryFrom <U> for T where U: Into <T>, Source § type Error = ! The type returned in the event of a conversion error.
Source § fn try_from (value: U) -> Result <T, ! > 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. Source § impl<T, U, const N: u32 > TryIntoBounded <T, N> for U where T: Integer , U: TryInto <T>, Source § fn try_into_bounded (self) -> Option < Bounded <T, N>> Attempts to convert self into a Bounded using N bits.
Read more