Struct context_allocator::memory_sources::mmap::MemoryMapSource

pub struct MemoryMapSource { /* fields omitted */ }

This NUMA-aware memory source allocates memory-mapped data, optionally using NUMA policy to allocate on a memory node closest to the current thread.

It is slow and uses system calls.

On Android, DragonFlyBSD, FreeBSD, Linux and OpenBSD mappings are omitted from core dumps for data privacy.

When dropped, any memory obtained with this allocator is NOT freed.

However, it is appropriate as a 'backing store' for other memory sources.

Methods

impl MemoryMapSource

pub fn new(
    lock: bool,
    prefault: bool,
    do_not_reserve_swap_space: bool,
    allocate_within_first_32Gb: bool,
    huge_page_size: HugePageSize,
    numa_settings: Option<NumaSettings>
) -> Self

Create a new instance.

• lock: Should allocated memory be locked (through a process equivalent to mlock()), thereby making out-of-memory fail fast. This setting will cause failures if rlimit() has not been increased.
• prefault: Should allocated memory be pre-faulted, ie all pages loaded and made resident in RAM when allocation occurs? This slows down allocation but make subsequent accesses faster. Only on Android, FreeBSD and Linux.
• do_not_reserve_swap_space: Do not reserve swap space for the mapping. Only on Android, Linux and NetBSD.
• allocate_within_first_32Gb: Useful for stacks and creating executable code. Only on Android, FreeBSD and Linux on 64-bit CPUs.
• huge_page_size: Huge page size to use with Transparent Huge Pages (THP). On operating systems other than Android and Linux, specifying a huge page size has no effect.
• numa_settings: NUMA policy settings for optimizing memory allocations to the nearest node. On operating systems other than Android and Linux, specifying a value has no effect.

Trait Implementations

impl MemorySource for MemoryMapSource

fn obtain(&self, non_zero_size: NonZeroUsize) -> Result<MemoryAddress, AllocErr>

Obtain memory from the operating system, say.

fn release(&self, non_zero_size: NonZeroUsize, current_memory: MemoryAddress)

Release memory to the operating system, say.

impl Eq for MemoryMapSource

impl PartialOrd<MemoryMapSource> for MemoryMapSource

fn partial_cmp(&self, other: &MemoryMapSource) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &MemoryMapSource) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &MemoryMapSource) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &MemoryMapSource) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &MemoryMapSource) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<MemoryMapSource> for MemoryMapSource

fn eq(&self, other: &MemoryMapSource) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MemoryMapSource) -> bool

This method tests for !=.

impl Clone for MemoryMapSource

fn clone(&self) -> MemoryMapSource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for MemoryMapSource

fn default() -> Self

Returns the "default value" for a type.

impl Ord for MemoryMapSource

fn cmp(&self, other: &MemoryMapSource) -> Ordering

This method returns an Ordering between self and other.

default fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

default fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

default fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Debug for MemoryMapSource

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

Formats the value using the given formatter.

impl Hash for MemoryMapSource

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].