org.openucx.jucx.ucp

Class UcpMemMapParams

java.lang.Object

org.openucx.jucx.UcxParams

org.openucx.jucx.ucp.UcpMemMapParams

public class UcpMemMapParams
extends UcxParams

Field Summary

Fields inherited from class org.openucx.jucx.UcxParams

fieldMask

Constructor Summary

Constructors

Constructor and Description
UcpMemMapParams()

Method Summary

Modifier and Type	Method and Description
UcpMemMapParams	allocate() Identify requirement for allocation, if passed address is not a null-pointer then it will be used as a hint or direct address for allocation.
UcpMemMapParams	clear() Reset state of parameters.
UcpMemMapParams	fixed() Don't interpret address as a hint: place the mapping at exactly that address.
long	getAddress()
long	getLength()
UcpMemMapParams	nonBlocking() Complete the registration faster, possibly by not populating the pages up-front, and mapping them later when they are accessed by communication routines.
UcpMemMapParams	setAddress(long address)
UcpMemMapParams	setLength(long length)
UcpMemMapParams	setMemoryType(int memoryType) Memory type (for possible memory types see UcsConstants.MEMORY_TYPE) It is an optimization hint to avoid memory type detection for map buffer.
UcpMemMapParams	setProtection(long protection) Memory protection mode, e.g.

Methods inherited from class org.openucx.jucx.UcxParams

checkArraySizes

Methods inherited from class java.lang.Object

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

Constructor Detail

UcpMemMapParams

public UcpMemMapParams()

Method Detail

clear

public UcpMemMapParams clear()

Description copied from class: UcxParams

Reset state of parameters.

Overrides:

clear in class UcxParams

setAddress

public UcpMemMapParams setAddress(long address)

getAddress

public long getAddress()

setLength

public UcpMemMapParams setLength(long length)

getLength

public long getLength()

allocate

public UcpMemMapParams allocate()

Identify requirement for allocation, if passed address is not a null-pointer then it will be used as a hint or direct address for allocation.

nonBlocking

public UcpMemMapParams nonBlocking()

Complete the registration faster, possibly by not populating the pages up-front, and mapping them later when they are accessed by communication routines.

fixed

public UcpMemMapParams fixed()

Don't interpret address as a hint: place the mapping at exactly that address. The address must be a multiple of the page size.

setProtection

public UcpMemMapParams setProtection(long protection)

Memory protection mode, e.g. UcpConstants.UCP_MEM_MAP_PROT_LOCAL_READ This value is optional. If it's not set, the UcpContext.memoryMap(UcpMemMapParams) routine will consider the flags as set to UCP_MEM_MAP_PROT_LOCAL_READ|UCP_MEM_MAP_PROT_LOCAL_WRITE| UCP_MEM_MAP_PROT_REMOTE_READ|UCP_MEM_MAP_PROT_REMOTE_WRITE.

setMemoryType

public UcpMemMapParams setMemoryType(int memoryType)

Memory type (for possible memory types see UcsConstants.MEMORY_TYPE) It is an optimization hint to avoid memory type detection for map buffer. The meaning of this field depends on the operation type. - Memory allocation: (allocate() is set) This field specifies the type of memory to allocate. If it's not set UcsConstants.MEMORY_TYPE.UCS_MEMORY_TYPE_HOST will be assumed by default. - Memory registration: This field specifies the type of memory which is pointed by setAddress(long). If it's not set, or set to UcsConstants.MEMORY_TYPE.UCS_MEMORY_TYPE_UNKNOWN, the memory type will be detected internally.