hipmallocfrompoolasync Interface Reference

hipmallocfrompoolasync Interface Reference#

HIPFORT API Reference: hipfort::hipmallocfrompoolasync Interface Reference

Allocates memory from a specified pool with stream ordered semantics. More...

Public Member Functions
integer(kind(hipsuccess)) function	hipmallocfrompoolasync_ (dev_ptr, mysize, mem_pool, stream)

Detailed Description

Allocates memory from a specified pool with stream ordered semantics.

Inserts an allocation operation into stream. A pointer to the allocated memory is returned immediately in dev_ptr. The allocation must not be accessed until the allocation operation completes. The allocation comes from the specified memory pool.

Note: The specified memory pool may be from a device different than that of the specified stream.

Basic stream ordering allows future work submitted into the same stream to use the allocation. Stream query, stream synchronize, and HIP events can be used to guarantee that the allocation operation completes before work submitted in a separate stream runs.

Note: During stream capture, this function results in the creation of an allocation node. In this case, the allocation is owned by the graph instead of the memory pool. The memory pool's properties are used to set the node's creation parameters.

Parameters

[out]	dev_ptr	Returned device pointer
[in]	size	Number of bytes to allocate
[in]	mem_pool	The pool to allocate from
[in]	stream	The stream establishing the stream ordering semantic

Returns: hipSuccess, hipErrorInvalidValue, hipErrorNotSupported, hipErrorOutOfMemory

See also: hipMallocAsync, hipFreeAsync, hipMemPoolGetAttribute, hipMemPoolCreate hipMemPoolTrimTo, hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolSetAccess, hipMemPoolGetAccess,

Warning: This API is marked as Beta. While this feature is complete, it can change and might have outstanding issues.

Note: This API is implemented on Linux and is under development on Microsoft Windows.

Member Function/Subroutine Documentation