This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

hipipcgetmemhandle Interface Reference

hipipcgetmemhandle Interface Reference#

HIPFORT API Reference: hipfort::hipipcgetmemhandle Interface Reference
hipfort::hipipcgetmemhandle Interface Reference

Gets an interprocess memory handle for an existing device memory allocation. More...

Public Member Functions

integer(kind(hipsuccess)) function hipipcgetmemhandle_ (handle, devPtr)
 

Detailed Description

Gets an interprocess memory handle for an existing device memory allocation.

Takes a pointer to the base of an existing device memory allocation created with hipMalloc and exports it for use in another process. This is a lightweight operation and may be called multiple times on an allocation without adverse effects.

If a region of memory is freed with hipFree and a subsequent call to hipMalloc returns memory with the same device address, hipIpcGetMemHandle will return a unique handle for the new memory.

Parameters
handle- Pointer to user allocated hipIpcMemHandle to return the handle in.
devPtr- Base pointer to previously allocated device memory
Returns
hipSuccess, hipErrorInvalidHandle, hipErrorOutOfMemory, hipErrorMapFailed,

Member Function/Subroutine Documentation

◆ hipipcgetmemhandle_()

integer(kind(hipsuccess)) function hipfort::hipipcgetmemhandle::hipipcgetmemhandle_ ( type(c_ptr)  handle,
type(c_ptr), value  devPtr 
)

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