hipmempoolexporttoshareablehandle Interface Reference

• hipfort
• hipmempoolexporttoshareablehandle

Public Member Functions | List of all members

hipfort::hipmempoolexporttoshareablehandle Interface Reference

Exports a memory pool to the requested handle type. More...

Public Member Functions
integer(kind(hipsuccess)) function	hipmempoolexporttoshareablehandle_ (shared_handle, mem_pool, handle_type, flags)

Detailed Description

Exports a memory pool to the requested handle type.

Given an IPC capable mempool, create an OS handle to share the pool with another process. A recipient process can convert the shareable handle into a mempool with hipMemPoolImportFromShareableHandle. Individual pointers can then be shared with the hipMemPoolExportPointer and hipMemPoolImportPointer APIs. The implementation of what the shareable handle is and how it can be transferred is defined by the requested handle type.

Note

To create an IPC capable mempool, create a mempool with a hipMemAllocationHandleType other than hipMemHandleTypeNone.

Parameters

[out]	shared_handle	Pointer to the location in which to store the requested handle
[in]	mem_pool	Pool to export
[in]	handle_type	The type of handle to create
[in]	flags	Must be 0

Returns

hipSuccess, hipErrorInvalidValue, hipErrorOutOfMemory

See also

hipMemPoolImportFromShareableHandle

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

◆ hipmempoolexporttoshareablehandle_()

integer(kind(hipsuccess)) function hipfort::hipmempoolexporttoshareablehandle::hipmempoolexporttoshareablehandle_	(	type(c_ptr), value	shared_handle,
		type(c_ptr), value	mem_pool,
		integer(kind(hipmemhandletypenone)), value	handle_type,
		integer(c_int), value	flags
	)

---

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

• hipfort.F90