Skip to main content

MemoryPool

Struct MemoryPool 

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

A memory pool. Owned pools are destroyed on last-clone drop; borrowed pools (returned by default_pool / current_pool) are not.

Implementations§

Source§

impl MemoryPool

Source

pub fn new(device: &Device) -> Result<Self>

Create a fresh pool backed on device.

Source

pub unsafe fn from_borrowed(handle: cudaMemPool_t) -> Self

Wrap a raw pool handle without taking ownership.

§Safety

handle must outlive this wrapper.

Source

pub fn as_raw(&self) -> cudaMemPool_t

Source

pub fn set_release_threshold(&self, bytes: u64) -> Result<()>

Set the release threshold (bytes retained before the pool starts returning memory to the OS). Default is 0.

Source

pub fn release_threshold(&self) -> Result<u64>

Source

pub fn used_bytes(&self) -> Result<u64>

Current bytes handed out to allocations.

Source

pub fn reserved_bytes(&self) -> Result<u64>

Current bytes reserved for the pool (used + kept-free).

Source

pub fn trim_to(&self, min_bytes_to_keep: usize) -> Result<()>

Release memory down to min_bytes_to_keep.

Source

pub fn set_access(&self, device: &Device, flags: AccessFlags) -> Result<()>

Grant device the specified access to allocations from this pool.

Source

pub fn access(&self, device: &Device) -> Result<AccessFlags>

Query device’s access flags for this pool.

Source

pub fn alloc_async(&self, bytes: usize, stream: &Stream) -> Result<*mut c_void>

Allocate bytes bytes of device memory from this pool, ordered on stream. Returns a raw device pointer — free via crate::DeviceBuffer::free_async or by calling Self::free_async on the raw pointer.

Source

pub unsafe fn free_async(&self, ptr: *mut c_void, stream: &Stream) -> Result<()>

Free a device pointer previously returned by Self::alloc_async (routes through cudaFreeAsync).

§Safety

ptr must be a live allocation from this (or another) pool.

Source

pub unsafe fn export_pointer( &self, ptr: *mut c_void, ) -> Result<cudaMemPoolPtrExportData>

Export a pointer in this pool for sharing with a peer process.

§Safety

ptr must be a live allocation from this pool.

Source

pub fn import_pointer( &self, data: cudaMemPoolPtrExportData, ) -> Result<*mut c_void>

Import an exported pointer into this pool.

Trait Implementations§

Source§

impl Clone for MemoryPool

Source§

fn clone(&self) -> MemoryPool

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MemoryPool

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.