hipfreeasync Interface Reference

hipfreeasync Interface Reference#

HIPFORT API Reference: hipfort::hipfreeasync Interface Reference
hipfort::hipfreeasync Interface Reference

Frees memory with stream ordered semantics. More...

Public Member Functions

integer(kind(hipsuccess)) function hipfreeasync_ (dev_ptr, stream)
 

Detailed Description

Frees memory with stream ordered semantics.

Inserts a free operation into stream. The allocation must not be used after stream execution reaches the free. After this API returns, accessing the memory from any subsequent work launched on the GPU or querying its pointer attributes results in undefined behavior.

Note
During stream capture, this function results in the creation of a free node and must therefore be passed the address of a graph allocation.
Parameters
[in]dev_ptrPointer to device memory to free
[in]streamThe stream, where the destruciton will occur according to the execution order
Returns
hipSuccess, hipErrorInvalidValue, hipErrorNotSupported
See also
hipMallocFromPoolAsync, hipMallocAsync, hipMemPoolTrimTo, hipMemPoolGetAttribute, 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

◆ hipfreeasync_()

integer(kind(hipsuccess)) function hipfort::hipfreeasync::hipfreeasync_ ( type(c_ptr), value  dev_ptr,
type(c_ptr), value  stream 
)

The documentation for this interface was generated from the following file: