hipmempoolcreate Interface Reference

hipmempoolcreate Interface Reference#

HIPFORT API Reference: hipfort::hipmempoolcreate Interface Reference
hipfort::hipmempoolcreate Interface Reference

Creates a memory pool. More...

Public Member Functions

integer(kind(hipsuccess)) function hipmempoolcreate_ (mem_pool, pool_props)
 

Detailed Description

Creates a memory pool.

Creates a HIP memory pool and returns the handle in mem_pool. The pool_props determines the properties of the pool such as the backing device and IPC capabilities.

By default, the memory pool will be accessible from the device it is allocated on.

Parameters
[out]mem_poolContains createed memory pool
[in]pool_propsMemory pool properties
Note
Specifying hipMemHandleTypeNone creates a memory pool that will not support IPC.
Returns
hipSuccess, hipErrorInvalidValue, hipErrorNotSupported
See also
hipMallocFromPoolAsync, hipMallocAsync, hipFreeAsync, hipMemPoolGetAttribute, hipMemPoolDestroy, 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

◆ hipmempoolcreate_()

integer(kind(hipsuccess)) function hipfort::hipmempoolcreate::hipmempoolcreate_ ( type(c_ptr)  mem_pool,
type(hipmempoolprops pool_props 
)

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