hipmempooldestroy Interface Reference

hipmempooldestroy Interface Reference#

HIPFORT API Reference: hipfort::hipmempooldestroy Interface Reference
hipfort::hipmempooldestroy Interface Reference

Destroys the specified memory pool. More...

Public Member Functions

integer(kind(hipsuccess)) function hipmempooldestroy_ (mem_pool)
 

Detailed Description

Destroys the specified memory pool.

If any pointers obtained from this pool haven't been freed or the pool has free operations that haven't completed when hipMemPoolDestroy is invoked, the function will return immediately and the resources associated with the pool will be released automatically once there are no more outstanding allocations.

Destroying the current mempool of a device sets the default mempool of that device as the current mempool for that device.

Parameters
[in]mem_poolMemory pool for destruction
Note
A device's default memory pool cannot be destroyed.
Returns
hipSuccess, hipErrorInvalidValue
See also
hipMallocFromPoolAsync, 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

◆ hipmempooldestroy_()

integer(kind(hipsuccess)) function hipfort::hipmempooldestroy::hipmempooldestroy_ ( type(c_ptr), value  mem_pool)

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