org.openucx.jucx.ucp

Class UcpParams

java.lang.Object

org.openucx.jucx.UcxParams

org.openucx.jucx.ucp.UcpParams

public class UcpParams
extends UcxParams

Tuning parameters for UCP library. The structure defines the parameters that are used for UCP library tuning during UCP library UcpContext "initialization".

UCP library implementation uses the "features" parameter to optimize the library functionality that minimize memory footprint. For example, if the application does not require send/receive semantics UCP library may avoid allocation of expensive resources associated with send/receive queues.

Field Summary

Fields inherited from class org.openucx.jucx.UcxParams

fieldMask

Constructor Summary

Constructors

Constructor and Description
UcpParams()

Method Summary

Modifier and Type	Method and Description
UcpParams	clear() Reset state of parameters.
UcpParams	requestAmFeature() Request Active Message support feature.
UcpParams	requestAtomic32BitFeature() Request 32-bit atomic operations support.
UcpParams	requestAtomic64BitFeature() Request 64-bit atomic operations support.
UcpParams	requestRmaFeature() Request remote memory access support.
UcpParams	requestStreamFeature() Request stream support.
UcpParams	requestTagFeature() Request tag matching support.
UcpParams	requestWakeupFeature() Request interrupt notification support.
UcpParams	setConfig(String key, String value) The routine sets runtime UCP library configuration.
UcpParams	setEstimatedNumEps(long estimatedNumEps) An optimization hint of how many endpoints would be created on this context.
UcpParams	setMtWorkersShared(boolean mtWorkersShared) Indicates if this context is shared by multiple workers from different threads.
UcpParams	setTagSenderMask(long tagSenderMask) Mask which specifies particular bits of the tag which can uniquely identify the sender (UCP endpoint) in tagged operations.

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

UcpParams

public UcpParams()

Method Detail

clear

public UcpParams clear()

Description copied from class: UcxParams

Reset state of parameters.

Overrides:

clear in class UcxParams

setTagSenderMask

public UcpParams setTagSenderMask(long tagSenderMask)

Mask which specifies particular bits of the tag which can uniquely identify the sender (UCP endpoint) in tagged operations. This field defaults to 0 if not specified.

setMtWorkersShared

public UcpParams setMtWorkersShared(boolean mtWorkersShared)

Indicates if this context is shared by multiple workers from different threads. If so, this context needs thread safety support; otherwise, the context does not need to provide thread safety. For example, if the context is used by single worker, and that worker is shared by multiple threads, this context does not need thread safety; if the context is used by worker 1 and worker 2, and worker 1 is used by thread 1 and worker 2 is used by thread 2, then this context needs thread safety. Note that actual thread mode may be different from mode passed to UcpContext.

setEstimatedNumEps

public UcpParams setEstimatedNumEps(long estimatedNumEps)

An optimization hint of how many endpoints would be created on this context. Does not affect semantics, but only transport selection criteria and the resulting performance. The value can be also set by UCX_NUM_EPS environment variable. In such case it will override the number of endpoints set by setEstimatedNumEps(long).

requestTagFeature

public UcpParams requestTagFeature()

Request tag matching support.

requestAmFeature

public UcpParams requestAmFeature()

Request Active Message support feature.

requestRmaFeature

public UcpParams requestRmaFeature()

Request remote memory access support.

requestAtomic32BitFeature

public UcpParams requestAtomic32BitFeature()

Request 32-bit atomic operations support.

requestAtomic64BitFeature

public UcpParams requestAtomic64BitFeature()

Request 64-bit atomic operations support.

requestWakeupFeature

public UcpParams requestWakeupFeature()

Request interrupt notification support.

requestStreamFeature

public UcpParams requestStreamFeature()

Request stream support.

setConfig

public UcpParams setConfig(String key,
                           String value)

The routine sets runtime UCP library configuration.