Struct ucp_params

#[repr(C)]
pub struct ucp_params {
    pub field_mask: u64,
    pub features: u64,
    pub request_size: size_t,
    pub request_init: ucp_request_init_callback_t,
    pub request_cleanup: ucp_request_cleanup_callback_t,
    pub tag_sender_mask: u64,
    pub mt_workers_shared: c_int,
    pub estimated_num_eps: size_t,
    pub estimated_num_ppn: size_t,
    pub name: *const c_char,
}

@ingroup UCP_CONFIG @brief Tuning parameters for UCP library.

The structure defines the parameters that are used for UCP library tuning during UCP library @ref ucp_init “initialization”.

@note UCP library implementation uses the @ref ucp_feature “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.

Fields

field_mask: u64

Mask of valid fields in this structure, using bits from @ref ucp_params_field. Fields not specified in this mask will be ignored. Provides ABI compatibility with respect to adding new fields.

features: u64

UCP @ref ucp_feature “features” that are used for library initialization. It is recommended for applications only to request the features that are required for an optimal functionality This field must be specified.

request_size: size_t

The size of a reserved space in a non-blocking requests. Typically applications use this space for caching own structures in order to avoid costly memory allocations, pointer dereferences, and cache misses. For example, MPI implementation can use this memory for caching MPI descriptors This field defaults to 0 if not specified.

request_init: ucp_request_init_callback_t

Pointer to a routine that is used for the request initialization. This function will be called only on the very first time a request memory is initialized, and may not be called again if a request is reused. If a request should be reset before the next reuse, it can be done before calling @ref ucp_request_free.

@e NULL can be used if no such is function required, which is also the default if this field is not specified by @ref field_mask.

request_cleanup: ucp_request_cleanup_callback_t

Pointer to a routine that is responsible for final cleanup of the memory associated with the request. This routine may not be called every time a request is released. For some implementations, the cleanup call may be delayed and only invoked at @ref ucp_worker_destroy.

@e NULL can be used if no such function is required, which is also the default if this field is not specified by @ref field_mask.

tag_sender_mask: u64

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.

mt_workers_shared: c_int

This flag 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 @ref ucp_init. To get actual thread mode use @ref ucp_context_query.

estimated_num_eps: size_t

An optimization hint of how many endpoints will be created on this context. For example, when used from MPI or SHMEM libraries, this number will specify the number of ranks (or processing elements) in the job. 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 @e estimated_num_eps

estimated_num_ppn: size_t

An optimization hint for a single node. For example, when used from MPI or OpenSHMEM libraries, this number will specify the number of Processes Per Node (PPN) in the job. Does not affect semantics, only transport selection criteria and the resulting performance. The value can be also set by the UCX_NUM_PPN environment variable, which will override the number of endpoints set by @e estimated_num_ppn

name: *const c_char

Tracing and analysis tools can identify the context using this name. To retrieve the context’s name, use @ref ucp_context_query, as the name you supply may be changed by UCX under some circumstances, e.g. a name conflict. This field is only assigned if you set @ref UCP_PARAM_FIELD_NAME in the field mask. If not, then a default unique name will be created for you.

Trait Implementations

impl Clone for ucp_params

fn clone(&self) -> ucp_params

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ucp_params

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for ucp_params