org.openucx.jucx.ucp

Class UcpMemory

java.lang.Object

org.openucx.jucx.UcxNativeStruct

org.openucx.jucx.ucp.UcpMemory

All Implemented Interfaces:

Closeable, AutoCloseable

public class UcpMemory
extends UcxNativeStruct
implements Closeable

Memory handle is an opaque object representing a memory region allocated through UCP library, which is optimized for remote memory access operations (zero-copy operations). The memory could be registered to one or multiple network resources that are supported by UCP, such as InfiniBand, Gemini, and others.

Method Summary

Modifier and Type	Method and Description
void	close()
void	deregister() This routine unmaps a user specified memory segment.
long	getAddress() Address of registered memory.
long	getLength() Length of registered memory
int	getMemType() Type of allocated memory.
ByteBuffer	getRemoteKeyBuffer() This routine allocates memory buffer and packs into the buffer a remote access key (RKEY) object.

Methods inherited from class org.openucx.jucx.UcxNativeStruct

equals, getNativeId, hashCode, setNativeId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

deregister

public void deregister()

This routine unmaps a user specified memory segment. When the function returns, the data and associated "remote key" will be invalid and cannot be used with any UCP routine. Another well know terminology for the "unmap" operation that is typically used in the context of networking is memory "de-registration". The UCP library de-registers the memory the available hardware so it can be returned back to the operation system.

getRemoteKeyBuffer

public ByteBuffer getRemoteKeyBuffer()

This routine allocates memory buffer and packs into the buffer a remote access key (RKEY) object. RKEY is an opaque object that provides the information that is necessary for remote memory access. This routine packs the RKEY object in a portable format such that the object can be "unpacked" on any platform supported by the UCP library. RKEYs for InfiniBand and Cray Aries networks typically includes InifiniBand and Aries key. In order to enable remote direct memory access to the memory associated with the memory handle the application is responsible for sharing the RKEY with the peers that will initiate the access.

getAddress

public long getAddress()

Address of registered memory.

getLength

public long getLength()

Length of registered memory

getMemType

public int getMemType()

Type of allocated memory.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable