Enum hip_sys::hiprt::hipMemPoolAttr

#[non_exhaustive]
#[repr(u32)]
pub enum hipMemPoolAttr {
    hipMemPoolReuseFollowEventDependencies,
    hipMemPoolReuseAllowOpportunistic,
    hipMemPoolReuseAllowInternalDependencies,
    hipMemPoolAttrReleaseThreshold,
    hipMemPoolAttrReservedMemCurrent,
    hipMemPoolAttrReservedMemHigh,
    hipMemPoolAttrUsedMemCurrent,
    hipMemPoolAttrUsedMemHigh,
}

@brief HIP memory pool attributes @enum @ingroup Enumerations

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

hipMemPoolReuseFollowEventDependencies

(value type = int) Allow @p hipMemAllocAsync to use memory asynchronously freed in another streams as long as a stream ordering dependency of the allocating stream on the free action exists. hip events and null stream interactions can create the required stream ordered dependencies. (default enabled)

hipMemPoolReuseAllowOpportunistic

(value type = int) Allow reuse of already completed frees when there is no dependency between the free and allocation. (default enabled)

hipMemPoolReuseAllowInternalDependencies

(value type = int) Allow @p hipMemAllocAsync to insert new stream dependencies in order to establish the stream ordering required to reuse a piece of memory released by cuFreeAsync (default enabled).

hipMemPoolAttrReleaseThreshold

(value type = uint64_t) Amount of reserved memory in bytes to hold onto before trying to release memory back to the OS. When more than the release threshold bytes of memory are held by the memory pool, the allocator will try to release memory back to the OS on the next call to stream, event or context synchronize. (default 0)

hipMemPoolAttrReservedMemCurrent

(value type = uint64_t) Amount of backing memory currently allocated for the mempool.

hipMemPoolAttrReservedMemHigh

(value type = uint64_t) High watermark of backing memory allocated for the mempool since the last time it was reset. High watermark can only be reset to zero.

hipMemPoolAttrUsedMemCurrent

(value type = uint64_t) Amount of memory from the pool that is currently in use by the application.

hipMemPoolAttrUsedMemHigh

(value type = uint64_t) High watermark of the amount of memory from the pool that was in use by the application since the last time it was reset. High watermark can only be reset to zero.

Trait Implementations

impl Clone for hipMemPoolAttr

fn clone(&self) -> hipMemPoolAttr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for hipMemPoolAttr

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

Formats the value using the given formatter.

impl Hash for hipMemPoolAttr

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for hipMemPoolAttr

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<hipMemPoolAttr> for hipMemPoolAttr

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<hipMemPoolAttr> for hipMemPoolAttr

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

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

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

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

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

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

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

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

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

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

impl Copy for hipMemPoolAttr

impl Eq for hipMemPoolAttr

impl StructuralEq for hipMemPoolAttr

impl StructuralPartialEq for hipMemPoolAttr