Crate ucx1_sys

@ingroup UCP_CONTEXT @brief Operation parameters passed to @ref ucp_tag_send_nbx, @ref ucp_tag_send_sync_nbx, @ref ucp_tag_recv_nbx, @ref ucp_put_nbx, @ref ucp_get_nbx, @ref ucp_am_send_nbx and @ref ucp_am_recv_data_nbx.

ucp_rkey

ucp_send_am_flags

@ingroup UCP_WORKER @brief Flags for sending a UCP Active Message.

ucp_stream_poll_ep

@ingroup UCP_ENDPOINT @brief Output parameter of @ref ucp_stream_worker_poll function.

ucp_stream_recv_flags_t

@ingroup UCP_COMM @brief Flags to define behavior of @ref ucp_stream_recv_nb function

ucp_tag_recv_info

@ingroup UCP_CONTEXT @brief UCP receive information descriptor

ucp_worker

ucp_worker_address_attr

@ingroup UCP_WORKER @brief UCP worker address attributes.

ucp_worker_address_attr_field

@ingroup UCP_WORKER @brief UCP worker address attributes field mask.

ucp_worker_address_flags_t

@ingroup UCP_WORKER @brief UCP worker address flags.

ucp_worker_attr

@ingroup UCP_WORKER @brief UCP worker attributes.

ucp_worker_attr_field

@ingroup UCP_WORKER @brief UCP worker attributes field mask.

ucp_worker_flags_t

@ingroup UCP_WORKER @brief UCP worker flags

ucp_worker_params

@ingroup UCP_WORKER @brief Tuning parameters for the UCP worker.

ucp_worker_params_field

@ingroup UCP_WORKER @brief UCP worker parameters field mask.

ucs_async_context

ucs_callbackq

A queue of callback to execute

ucs_callbackq_elem

Callback queue element.

ucs_callbackq_flags

@ingroup UCS_RESOURCE Callback flags

ucs_config_allow_list_t

ucs_config_names_array_t

ucs_config_print_flags_t

Configuration printing flags

ucs_cpu_set_t

ucs_linear_func_t

A 1d linear function, represented as f(x) = c + x * m.

ucs_list_link

A link in a circular list.

ucs_log_component_config

Logging component.

ucs_sock_addr

@ingroup UCS_RESOURCE BSD socket address specification.

ucs_stats_class

ucs_stats_filter_node

@ingroup UCT_MD @brief Describes a memory allocated by UCT.

uct_cb_flags

@ingroup UCT_RESOURCE @brief Callback flags.

uct_cb_param_flags

@ingroup UCT_RESOURCE @brief Flags for active message and tag-matching offload callbacks (callback’s parameters).

uct_cm

uct_cm_attr

@ingroup UCT_CLIENT_SERVER @brief Connection manager attributes, capabilities and limitations.

uct_cm_attr_field

@ingroup UCT_CLIENT_SERVER @brief UCT connection manager attributes field mask.

uct_cm_config

uct_cm_ep_client_connect_args

@ingroup UCT_CLIENT_SERVER @brief Arguments to the client’s connect callback.

uct_cm_ep_client_connect_args_field

@ingroup UCT_CLIENT_SERVER @brief Field mask flags for client-side connection established callback.

uct_cm_ep_priv_data_pack_args

@ingroup UCT_CLIENT_SERVER @brief Arguments to the client-server private data pack callback.

uct_cm_ep_priv_data_pack_args_field

@ingroup UCT_CLIENT_SERVER @brief Client-Server private data pack callback arguments field mask.

uct_cm_ep_resolve_args

@ingroup UCT_CLIENT_SERVER @brief Arguments to the client-server resolved callback.

uct_cm_ep_resolve_args_field

@ingroup UCT_CLIENT_SERVER @brief Client-Server resolve callback arguments field mask.

uct_cm_ep_server_conn_notify_args

@ingroup UCT_CLIENT_SERVER @brief Arguments to the server’s notify callback.

uct_cm_ep_server_conn_notify_args_field

@ingroup UCT_CLIENT_SERVER @brief Field mask flags for server-side connection established notification callback.

uct_cm_listener_conn_request_args

@ingroup UCT_CLIENT_SERVER @brief Arguments to the listener’s connection request callback.

uct_cm_listener_conn_request_args_field

@ingroup UCT_CLIENT_SERVER @brief Listener’s connection request callback arguments field mask.

uct_cm_remote_data

@ingroup UCT_CLIENT_SERVER @brief Data received from the remote peer.

uct_cm_remote_data_field

@ingroup UCT_CLIENT_SERVER @brief Remote data attributes field mask.

uct_completion

@ingroup UCT_RESOURCE @brief Completion handle.

uct_component

uct_component_attr

@ingroup UCT_RESOURCE @brief UCT component attributes

uct_component_attr_field

@ingroup UCT_RESOURCE @brief UCT component attributes field mask

Remote endpoint

uct_ep_connect_params

@ingroup UCT_CLIENT_SERVER @brief Parameters for connecting a UCT endpoint by @ref uct_ep_connect.

uct_ep_connect_params_field

@ingroup UCT_CLIENT_SERVER @brief UCT endpoint connected by @ref uct_ep_connect parameters field mask.

uct_ep_params

@ingroup UCT_RESOURCE @brief Parameters for creating a UCT endpoint by @ref uct_ep_create

uct_ep_params_field

@ingroup UCT_RESOURCE @brief UCT endpoint created by @ref uct_ep_create parameters field mask.

uct_flush_flags

@ingroup UCT_RESOURCE @brief Flush modifiers.

uct_iface

Communication interface context

uct_iface_addr

uct_iface_attr

@ingroup UCT_RESOURCE @brief Interface attributes: capabilities and limitations.

uct_iface_attr__bindgen_ty_1

uct_iface_attr__bindgen_ty_1__bindgen_ty_1

uct_iface_attr__bindgen_ty_1__bindgen_ty_2

uct_iface_attr__bindgen_ty_1__bindgen_ty_3

uct_iface_attr__bindgen_ty_1__bindgen_ty_4

uct_iface_attr__bindgen_ty_1__bindgen_ty_4__bindgen_ty_1

uct_iface_attr__bindgen_ty_1__bindgen_ty_4__bindgen_ty_2

uct_iface_attr__bindgen_ty_1__bindgen_ty_4__bindgen_ty_3

uct_iface_attr__bindgen_ty_1__bindgen_ty_5

uct_iface_config

uct_iface_ops

Transport interface operations. Every operation exposed in the API must appear in the table below, to allow creating interface/endpoint with custom operations.

uct_iface_params

@ingroup UCT_RESOURCE @brief Parameters used for interface creation.

uct_iface_params__bindgen_ty_1__bindgen_ty_1

@anchor uct_iface_params_t_mode_device The fields in this structure (tl_name and dev_name) need to be set only when the @ref UCT_IFACE_OPEN_MODE_DEVICE bit is set in @ref uct_iface_params_t.open_mode This will make @ref uct_iface_open open the interface on the specified device.

uct_iface_params__bindgen_ty_1__bindgen_ty_2

@anchor uct_iface_params_t_mode_sockaddr These callbacks and address are only relevant for client-server connection establishment with sockaddr and are needed on the server side. The callbacks and address need to be set when the @ref UCT_IFACE_OPEN_MODE_SOCKADDR_SERVER bit is set in @ref uct_iface_params_t.open_mode. This will make @ref uct_iface_open open the interface on the specified address as a server.

uct_iface_params_field

@ingroup UCT_RESOURCE @brief UCT interface created by @ref uct_iface_open parameters field mask.

uct_iov

@ingroup UCT_RESOURCE @brief Structure for scatter-gather I/O.

uct_listener

Listener for incoming connections

uct_listener_attr

@ingroup UCT_CLIENT_SERVER @brief UCT listener attributes, capabilities and limitations.

uct_listener_attr_field

@ingroup UCT_CLIENT_SERVER @brief UCT listener attributes field mask.

uct_listener_params

@ingroup UCT_CLIENT_SERVER @brief Parameters for creating a listener object @ref uct_listener_h by @ref uct_listener_create

uct_listener_params_field

@ingroup UCT_CLIENT_SERVER @brief UCT listener created by @ref uct_listener_create parameters field mask.

uct_md

uct_md_attr

@ingroup UCT_MD @brief Memory domain attributes.

uct_md_attr__bindgen_ty_1

uct_md_config

uct_md_mem_attr

@ingroup UCT_MD @brief Memory domain attributes.

uct_md_mem_attr_field

@ingroup UCT_MD @brief UCT MD memory attributes field mask

uct_md_mem_flags

@ingroup UCT_MD @brief Memory allocation/registration flags.

uct_md_ops

uct_md_resource_desc

@ingroup UCT_RESOURCE @brief Memory domain resource descriptor.

uct_mem_alloc_params_t

@ingroup UCT_MD @brief Parameters for allocating memory using @ref uct_mem_alloc

uct_mem_alloc_params_t__bindgen_ty_1

uct_msg_flags

@ingroup UCT_AM @brief Flags for active message send operation.

uct_pending_req

@ingroup UCT_RESOURCE @brief Pending request.

uct_ppn_bandwidth

uct_recv_desc

Receive descriptor

uct_rkey_bundle

@ingroup UCT_MD @brief Remote key with its type

uct_tag_context

@ingroup UCT_TAG @brief Posted tag context.

uct_tl_resource_desc

@ingroup UCT_RESOURCE @brief Communication resource descriptor.

uct_worker

A progress engine and a domain for allocating communication resources. Different workers are progressed independently.

Enums

_bindgen_ty_5

@ingroup UCT_RESOURCE @brief Capability flags of @ref uct_component_h.

_bindgen_ty_6

@ingroup UCT_MD @brief Memory domain capability flags.

_bindgen_ty_7

@ingroup UCT_RESOURCE @brief flags of @ref uct_tag_context.

_bindgen_ty_8

@ingroup UCP_MEM @brief UCP memory mapping flags.

_bindgen_ty_9

@ingroup UCP_MEM @brief UCP memory mapping protection mode.

ucm_event_type

@brief Memory event types

ucm_mmap_hook_mode

@brief MMAP hook modes

ucm_module_unload_prevent_mode

@brief UCM module unload prevent mode

ucp_am_recv_attr_t

@ingroup UCP_COMM @brief UCP AM receive data parameter fields and flags

ucp_atomic_fetch_op_t

@ingroup UCP_COMM @brief Atomic operation requested for ucp_atomic_fetch

ucp_atomic_op_t

@ingroup UCP_COMM @brief Atomic operation requested for ucp_atomic_op_nbx

ucp_atomic_post_op_t

@ingroup UCP_COMM @brief Atomic operation requested for ucp_atomic_post

ucp_dt_type

@ingroup UCP_DATATYPE @brief UCP data type classification

ucp_ep_close_mode

@ingroup UCP_ENDPOINT @brief Close UCP endpoint modes.

ucp_err_handling_mode_t

@ingroup UCP_ENDPOINT @brief Error handling mode for the UCP endpoint.

ucp_mem_advice

@ingroup UCP_MEM @brief list of UCP memory use advice.

ucp_op_attr_t

@ingroup UCP_COMM @brief UCP operation fields and flags

ucp_wakeup_event_types

@ingroup UCP_WORKER @brief UCP worker wakeup events mask.

ucs_async_mode_t

Async progress mode.

ucs_config_allow_list_mode_t

Enum for representing possible modes of an “allow-list”

ucs_event_set_type_t

Event types that could be requested to notify

ucs_handle_error_t

Error handling modes

ucs_log_level_t

Logging levels.

ucs_memory_type

@ingroup UCS_RESOURCE @brief Memory types

ucs_on_off_auto_value

On/Off/Auto logic value.

ucs_stats_formats_t

ucs_status_t

@ingroup UCS_RESOURCE @brief Status codes

ucs_ternary_auto_value

Ternary logic or Auto value.

ucs_thread_mode_t

@ingroup UCS_RESOURCE @brief Thread sharing mode

uct_alloc_method_t

@ingroup UCT_CONTEXT @brief Memory allocation methods.

uct_am_trace_type

@ingroup UCT_AM @brief Trace types for active message tracer.

uct_atomic_op

@brief Atomic operation requested for uct_ep_atomic32_post, uct_ep_atomic64_post, uct_ep_atomic32_fetch and uct_ep_atomic64_fetch.

uct_device_type_t

@ingroup UCT_RESOURCE @brief List of UCX device types.

uct_iface_event_types

@ingroup UCT_RESOURCE @brief Asynchronous event types.

uct_iface_open_mode

@ingroup UCT_RESOURCE @brief Mode in which to open the interface.

uct_mem_advice_t

@ingroup UCT_MD @brief list of UCT memory use advice

uct_mem_alloc_params_field_t

@ingroup UCT_MD @brief UCT allocation parameters specification field mask

uct_progress_types

@ingroup UCT_RESOURCE @brief UCT progress types

uct_sockaddr_accessibility_t

@ingroup UCT_MD @brief Socket address accessibility type.

Constants

UCP_MEM_MAP_PROT_LOCAL_READ

UCP_MEM_MAP_PROT_LOCAL_WRITE

UCP_MEM_MAP_PROT_REMOTE_READ

UCP_MEM_MAP_PROT_REMOTE_WRITE

UCP_VERSION_MAJOR_SHIFT

UCP_VERSION_MINOR_SHIFT

UCS_ALLOCA_MAX_SIZE

UCS_CALLBACKQ_FAST_COUNT

UCS_CALLBACKQ_ID_NULL

UCS_CPU_SETSIZE

UCS_SYS_BDF_NAME_MAX

UCS_SYS_DEVICE_ID_MAX

UCS_SYS_DEVICE_ID_UNKNOWN

UCT_AM_ID_BITS

UCT_API

UCT_COMPONENT_FLAG_CM

UCT_COMPONENT_NAME_MAX

UCT_MD_FLAG_INVALIDATE

UCT_MD_FLAG_NEED_MEMH

UCT_MD_FLAG_NEED_RKEY

UCT_PENDING_REQ_PRIV_LEN

UCT_SCM_VERSION

UCT_TAG_PRIV_LEN

UCT_TAG_RECV_CB_INLINE_DATA

UCT_TL_NAME_MAX

UCT_TL_RESOURCE_DESC_FMT

UCT_VERNO_MAJOR

UCT_VERNO_MINOR

UCT_VERNO_STRING

Statics

ucm_global_opts

ucs_async_mode_names

ucs_memory_type_descs

Array of string descriptions for each memory type

ucs_memory_type_names

Array of string names for each memory type

ucs_stats_formats_names

ucs_sys_event_set_max_wait_events

ucs_thread_mode_names

ucs_topo_default_distance

uct_alloc_method_names

uct_device_type_names

Functions

@brief Call the original implementation of @ref brk and all handlers associated with it.

ucm_dlopen ^⚠

@brief Call the original implementation of @ref dlopen and all handlers associated with it.

ucm_library_init ^⚠

Initialize UCM library and set its configuration.

ucm_madvise ^⚠

@brief Call the original implementation of @ref madvise and all handlers associated with it.

ucm_mmap ^⚠

@brief Call the original implementation of @ref mmap and all handlers associated with it.

ucm_mremap ^⚠

@brief Call the original implementation of @ref mremap and all handlers associated with it.

ucm_munmap ^⚠

@brief Call the original implementation of @ref munmap and all handlers associated with it.

ucm_orig_brk ^⚠

@brief Call the original implementation of @ref brk without triggering events.

ucm_orig_madvise ^⚠

@brief Call the original implementation of @ref madvise without triggering events.

ucm_orig_mmap ^⚠

@brief Call the original implementation of @ref mmap without triggering events.

ucm_orig_mremap ^⚠

@brief Call the original implementation of @ref mremap without triggering events.

ucm_orig_munmap ^⚠

@brief Call the original implementation of @ref munmap without triggering events.

ucm_orig_sbrk ^⚠

@brief Call the original implementation of @ref sbrk without triggering events.

ucm_orig_shmat ^⚠

@brief Call the original implementation of @ref shmat without triggering events.

ucm_orig_shmdt ^⚠

@brief Call the original implementation of @ref shmdt without triggering events.

ucm_sbrk ^⚠

@brief Call the original implementation of @ref sbrk and all handlers associated with it.

ucm_set_event_handler ^⚠

@brief Install a handler for memory events.

ucm_set_external_event ^⚠

@brief Add memory events to the external events list.

ucm_shmat ^⚠

@brief Call the original implementation of @ref shmat and all handlers associated with it.

ucm_shmdt ^⚠

@brief Call the original implementation of @ref shmdt and all handlers associated with it.

ucm_test_events ^⚠

@brief Test event handlers

ucm_test_external_events ^⚠

@brief Test event external handlers

ucm_unset_event_handler ^⚠

@brief Remove a handler for memory events.

ucm_unset_external_event ^⚠

@brief Remove memory events from the external events list.

ucm_vm_mmap ^⚠

@brief Call the handlers registered for aggregated VM_MMAP event.

ucm_vm_munmap ^⚠

@brief Call the handlers registered for aggregated VM_MUNMAP event.

ucp_am_data_release ^⚠

@ingroup UCP_COMM @brief Releases Active Message data.

ucp_am_recv_data_nbx ^⚠

@ingroup UCP_COMM @brief Receive Active Message as defined by provided data descriptor.

ucp_am_send_nb ^⚠

@ingroup UCP_COMM @brief Send Active Message.

ucp_am_send_nbx ^⚠

@ingroup UCP_COMM @brief Send Active Message.

ucp_atomic_add32 ^⚠

@ingroup UCP_COMM @brief Blocking atomic add operation for 32 bit integers @deprecated Replaced by @ref ucp_atomic_post with opcode UCP_ATOMIC_POST_OP_ADD. @see ucp_put.

ucp_atomic_add64 ^⚠

@ingroup UCP_COMM @brief Blocking atomic add operation for 64 bit integers @deprecated Replaced by @ref ucp_atomic_post with opcode UCP_ATOMIC_POST_OP_ADD. @see ucp_put.

ucp_atomic_cswap32 ^⚠

@ingroup UCP_COMM @brief Blocking atomic conditional swap (cswap) operation for 32 bit values. @deprecated Replaced by @ref ucp_atomic_fetch_nb with opcode UCP_ATOMIC_FETCH_OP_CSWAP. @see ucp_put.

ucp_atomic_cswap64 ^⚠

@ingroup UCP_COMM @brief Blocking atomic conditional swap (cswap) operation for 64 bit values. @deprecated Replaced by @ref ucp_atomic_fetch_nb with opcode UCP_ATOMIC_FETCH_OP_CSWAP. @see ucp_put.

ucp_atomic_fadd32 ^⚠

@ingroup UCP_COMM @brief Blocking atomic fetch and add operation for 32 bit integers @deprecated Replaced by @ref ucp_atomic_fetch_nb with opcode UCP_ATOMIC_FETCH_OP_FADD. @see ucp_put.

ucp_atomic_fadd64 ^⚠

@ingroup UCP_COMM @brief Blocking atomic fetch and add operation for 64 bit integers @deprecated Replaced by @ref ucp_atomic_fetch_nb with opcode UCP_ATOMIC_FETCH_OP_FADD. @see ucp_put.

ucp_atomic_fetch_nb ^⚠

@ingroup UCP_COMM @brief Post an atomic fetch operation.

ucp_atomic_op_nbx ^⚠

@ingroup UCP_COMM @brief Post an atomic memory operation.

ucp_atomic_post ^⚠

@ingroup UCP_COMM @brief Post an atomic memory operation.

ucp_atomic_swap32 ^⚠

@ingroup UCP_COMM @brief Blocking atomic swap operation for 32 bit values @deprecated Replaced by @ref ucp_atomic_fetch_nb with opcode UCP_ATOMIC_FETCH_OP_SWAP. @see ucp_put.

ucp_atomic_swap64 ^⚠

@ingroup UCP_COMM @brief Blocking atomic swap operation for 64 bit values @deprecated Replaced by @ref ucp_atomic_fetch_nb with opcode UCP_ATOMIC_FETCH_OP_SWAP. @see ucp_put.

ucp_cleanup ^⚠

@ingroup UCP_CONTEXT @brief Release UCP application context.

ucp_config_modify ^⚠

@ingroup UCP_CONFIG @brief Modify context configuration.

ucp_config_print ^⚠

@ingroup UCP_CONFIG @brief Print configuration information

ucp_config_read ^⚠

@ingroup UCP_CONFIG @brief Read UCP configuration descriptor

ucp_config_release ^⚠

@ingroup UCP_CONFIG @brief Release configuration descriptor

ucp_conn_request_query ^⚠

@ingroup UCP_WORKER @brief Get attributes specific to a particular connection request received on the server side.

ucp_context_print_info ^⚠

@ingroup UCP_CONTEXT @brief Print context information.

ucp_context_query ^⚠

@ingroup UCP_CONTEXT @brief Get attributes specific to a particular context.

ucp_disconnect_nb ^⚠

@ingroup UCP_ENDPOINT @deprecated Replaced by @ref ucp_ep_close_nb.

ucp_dt_create_generic ^⚠

@ingroup UCP_DATATYPE @brief Create a generic datatype.

ucp_dt_destroy ^⚠

@ingroup UCP_DATATYPE @brief Destroy a datatype and release its resources.

ucp_dt_make_contig

@ingroup UCP_DATATYPE @brief Generate an identifier for contiguous data type.

ucp_ep_close_nb ^⚠

@ingroup UCP_ENDPOINT

ucp_ep_close_nbx ^⚠

@ingroup UCP_ENDPOINT

ucp_ep_create ^⚠

@ingroup UCP_ENDPOINT @brief Create and connect an endpoint.

ucp_ep_destroy ^⚠

@ingroup UCP_ENDPOINT @deprecated Replaced by @ref ucp_ep_close_nb.

ucp_ep_evaluate_perf ^⚠

@ingroup UCP_ENDPOINT @brief Estimate performance characteristics of a specific endpoint.

ucp_ep_flush ^⚠

@ingroup UCP_ENDPOINT @deprecated Replaced by @ref ucp_ep_flush_nb.

ucp_ep_flush_nb ^⚠

@ingroup UCP_ENDPOINT

ucp_ep_flush_nbx ^⚠

@ingroup UCP_ENDPOINT

ucp_ep_modify_nb ^⚠

@ingroup UCP_ENDPOINT @brief Modify endpoint parameters.

ucp_ep_print_info ^⚠

@ingroup UCP_ENDPOINT @brief Print endpoint information.

ucp_ep_query ^⚠

@ingroup UCP_ENDPOINT @brief Get attributes of a given endpoint.

ucp_ep_rkey_unpack ^⚠

@ingroup UCP_MEM @brief Create remote access key from packed buffer.

ucp_get ^⚠

@ingroup UCP_COMM @brief Blocking remote memory get operation. @deprecated Replaced by @ref ucp_get_nb. @see ucp_put.

ucp_get_nb ^⚠

@ingroup UCP_COMM @brief Non-blocking remote memory get operation.

ucp_get_nbi ^⚠

@ingroup UCP_COMM @brief Non-blocking implicit remote memory get operation.

ucp_get_nbx ^⚠

@ingroup UCP_COMM @brief Non-blocking remote memory get operation.

ucp_get_version ^⚠

@ingroup UCP_CONTEXT @brief Get UCP library version.

ucp_get_version_string ^⚠

@ingroup UCP_CONTEXT @brief Get UCP library version as a string.

ucp_init_version ^⚠

@cond PRIVATE_INTERFACE */ @ingroup UCP_CONTEXT @brief UCP context initialization with particular API version.

ucp_lib_query ^⚠

@ingroup UCP_CONTEXT @brief Get attributes of the UCP library.

ucp_listener_create ^⚠

@ingroup UCP_WORKER @brief Create a listener to accept connections on. Connection requests on the listener will arrive at a local address specified by the user.

ucp_listener_destroy ^⚠

@ingroup UCP_WORKER @brief Stop accepting connections on a local address of the worker object.

ucp_listener_query ^⚠

@ingroup UCP_WORKER @brief Get attributes specific to a particular listener.

ucp_listener_reject ^⚠

@ingroup UCP_WORKER

ucp_mem_advise ^⚠

@ingroup UCP_MEM @brief give advice about the use of memory

ucp_mem_map ^⚠

@ingroup UCP_MEM @brief Map or allocate memory for zero-copy operations.

ucp_mem_print_info ^⚠

@ingroup UCP_MEM @brief Print memory mapping information.

ucp_mem_query ^⚠

@ingroup UCP_MEM @brief query mapped memory segment

ucp_mem_unmap ^⚠

@ingroup UCP_MEM @brief Unmap memory segment

ucp_put ^⚠

@ingroup UCP_COMM @brief Blocking remote memory put operation. @deprecated Replaced by @ref ucp_put_nb. The following example implements the same functionality using @ref ucp_put_nb : @code void empty_callback(void *request, ucs_status_t status) { }

ucp_put_nb ^⚠

@ingroup UCP_COMM @brief Non-blocking remote memory put operation.

ucp_put_nbi ^⚠

@ingroup UCP_COMM @brief Non-blocking implicit remote memory put operation.

ucp_put_nbx ^⚠

@ingroup UCP_COMM @brief Non-blocking remote memory put operation.

ucp_request_alloc ^⚠

@ingroup UCP_COMM @brief Create an empty communications request.

ucp_request_cancel ^⚠

@ingroup UCP_COMM @brief Cancel an outstanding communications request.

ucp_request_check_status ^⚠

@ingroup UCP_COMM @brief Check the status of non-blocking request.

ucp_request_free ^⚠

@ingroup UCP_COMM @brief Release a communications request.

ucp_request_is_completed ^⚠

@ingroup UCP_COMM @deprecated Replaced by @ref ucp_request_test.

ucp_request_query ^⚠

@ingroup UCP_COMM @brief Get information about ucp_request.

ucp_request_release ^⚠

@ingroup UCP_ENDPOINT @deprecated Replaced by @ref ucp_request_free.

ucp_request_test ^⚠

@ingroup UCP_ENDPOINT @deprecated Replaced by @ref ucp_tag_recv_request_test and @ref ucp_request_check_status depends on use case.

ucp_rkey_buffer_release ^⚠

@ingroup UCP_MEM @brief Release packed remote key buffer.

ucp_rkey_destroy ^⚠

@ingroup UCP_MEM @brief Destroy the remote key

ucp_rkey_pack ^⚠

@ingroup UCP_MEM @brief Pack memory region remote access key.

ucp_rkey_ptr ^⚠

@ingroup UCP_MEM @brief Get a local pointer to remote memory.

ucp_stream_data_release ^⚠

@ingroup UCP_COMM @brief Release UCP data buffer returned by @ref ucp_stream_recv_data_nb.

ucp_stream_recv_data_nb ^⚠

@ingroup UCP_COMM @brief Non-blocking stream receive operation of unstructured data into a UCP-supplied buffer.

ucp_stream_recv_nb ^⚠

@ingroup UCP_COMM @brief Non-blocking stream receive operation of structured data into a user-supplied buffer.

ucp_stream_recv_nbx ^⚠

@ingroup UCP_COMM @brief Non-blocking stream receive operation of structured data into a user-supplied buffer.

ucp_stream_recv_request_test ^⚠

@ingroup UCP_COMM @brief Check the status and currently available state of non-blocking request returned from @ref ucp_stream_recv_nb routine.

ucp_stream_send_nb ^⚠

@ingroup UCP_COMM @brief Non-blocking stream send operation.

ucp_stream_send_nbx ^⚠

@ingroup UCP_COMM @brief Non-blocking stream send operation.

ucp_stream_worker_poll ^⚠

@ingroup UCP_WORKER @brief Poll for endpoints that are ready to consume streaming data.

ucp_tag_msg_recv_nb ^⚠

@ingroup UCP_COMM @brief Non-blocking receive operation for a probed message.

ucp_tag_msg_recv_nbx ^⚠

@ingroup UCP_COMM @brief Non-blocking receive operation for a probed message.

ucp_tag_probe_nb ^⚠

@ingroup UCP_COMM @brief Non-blocking probe and return a message.

ucp_tag_recv_nb ^⚠

@ingroup UCP_COMM @brief Non-blocking tagged-receive operation.

ucp_tag_recv_nbr ^⚠

@ingroup UCP_COMM @brief Non-blocking tagged-receive operation.

ucp_tag_recv_nbx ^⚠

@ingroup UCP_COMM @brief Non-blocking tagged-receive operation.

ucp_tag_recv_request_test ^⚠

@ingroup UCP_COMM @brief Check the status and currently available state of non-blocking request returned from @ref ucp_tag_recv_nb routine.

ucp_tag_send_nb ^⚠

@ingroup UCP_COMM @brief Non-blocking tagged-send operations

ucp_tag_send_nbr ^⚠

@ingroup UCP_COMM @brief Non-blocking tagged-send operations with user provided request

ucp_tag_send_nbx ^⚠

@ingroup UCP_COMM @brief Non-blocking tagged-send operation

ucp_tag_send_sync_nb ^⚠

@ingroup UCP_COMM @brief Non-blocking synchronous tagged-send operation.

ucp_tag_send_sync_nbx ^⚠

@ingroup UCP_COMM @brief Non-blocking synchronous tagged-send operation.

ucp_worker_address_query ^⚠

@ingroup UCP_WORKER @brief Get attributes of the particular worker address.

ucp_worker_arm ^⚠

@ingroup UCP_WAKEUP @brief Turn on event notification for the next event.

ucp_worker_create ^⚠

@ingroup UCP_WORKER @brief Create a worker object.

ucp_worker_destroy ^⚠

@ingroup UCP_WORKER @brief Destroy a worker object.

ucp_worker_fence ^⚠

@ingroup UCP_WORKER

ucp_worker_flush ^⚠

@ingroup UCP_WORKER

ucp_worker_flush_nb ^⚠

@ingroup UCP_WORKER

ucp_worker_flush_nbx ^⚠

@ingroup UCP_WORKER

ucp_worker_get_address ^⚠

@ingroup UCP_WORKER @brief Get the address of the worker object.

ucp_worker_get_efd ^⚠

@ingroup UCP_WAKEUP @brief Obtain an event file descriptor for event notification.

ucp_worker_print_info ^⚠

@ingroup UCP_WORKER @brief Print information about the worker.

ucp_worker_progress ^⚠

@ingroup UCP_WORKER @brief Progress all communications on a specific worker.

ucp_worker_query ^⚠

@ingroup UCP_WORKER @brief Get attributes specific to a particular worker.

ucp_worker_release_address ^⚠

@ingroup UCP_WORKER @brief Release an address of the worker object.

ucp_worker_set_am_handler ^⚠

@ingroup UCP_WORKER @brief Add user defined callback for Active Message.

ucp_worker_set_am_recv_handler ^⚠

@ingroup UCP_WORKER @brief Add user defined callback for Active Message.

ucp_worker_signal ^⚠

@ingroup UCP_WAKEUP @brief Cause an event of the worker.

ucp_worker_wait ^⚠

@ingroup UCP_WAKEUP @brief Wait for an event of the worker.

ucp_worker_wait_mem ^⚠

@ingroup UCP_WAKEUP @brief Wait for memory update on the address

ucs_async_add_timer ^⚠

@ingroup UCS_RESOURCE

ucs_async_context_create ^⚠

@ingroup UCS_RESOURCE @brief Create an asynchronous execution context

ucs_async_context_destroy ^⚠

@ingroup UCS_RESOURCE @brief Destroy the asynchronous execution context

ucs_async_modify_handler ^⚠

@ingroup UCS_RESOURCE

ucs_async_poll ^⚠

@ingroup UCS_RESOURCE

ucs_async_remove_handler ^⚠

@ingroup UCS_RESOURCE

ucs_async_set_event_handler ^⚠

@ingroup UCS_RESOURCE

ucs_callbackq_add ^⚠

Add a callback to the queue. This is not safe to call while another thread might be dispatching callbacks. However, it can be used from the dispatch context (e.g a callback may use this function to add another callback).

ucs_callbackq_add_safe ^⚠

Add a callback to the queue. This can be used from any context and any thread, including but not limited to:

ucs_callbackq_cleanup ^⚠

Clean up the callback queue and release associated memory.

ucs_callbackq_init ^⚠

Initialize the callback queue.

ucs_callbackq_remove ^⚠

Remove a callback from the queue immediately. This is not safe to call while another thread might be dispatching callbacks. However, it can be used from the dispatch context (e.g a callback may use this function to remove itself or another callback). In this case, the callback may still be dispatched once after this function returned.

ucs_callbackq_remove_if ^⚠

Remove all callbacks from the queue for which the given predicate returns “true” (nonzero) value. This is not safe to call while another thread might be dispatching callbacks. However, it can be used from the dispatch context (e.g a callback may use this function to remove itself or another callback). In this case, the callback may still be dispatched once after this function returned.

ucs_callbackq_remove_safe ^⚠

Remove a callback from the queue in a safe but lazy fashion. The callback will be removed at some point in the near future. This can be used from any context and any thread, including but not limited to:

ucs_event_set_add ^⚠

Register the target event.

ucs_event_set_cleanup ^⚠

Cleanup event set

ucs_event_set_create ^⚠

Allocate ucs_sys_event_set_t structure.

ucs_event_set_create_from_fd ^⚠

Allocate ucs_sys_event_set_t structure and assign provided file descriptor to wait for events on.

ucs_event_set_del ^⚠

Remove the target event.

ucs_event_set_fd_get ^⚠

Get file descriptor for watching events.

ucs_event_set_mod ^⚠

Modify the target event.

ucs_event_set_wait ^⚠

Wait for an I/O events

ucs_stats_get_root ^⚠

ucs_status_string ^⚠

@param status UCS status code.

ucs_topo_cleanup ^⚠

Cleanup UCS topology subsystem.

ucs_topo_distance_str ^⚠

Convert the distance to a human-readable string.

ucs_topo_find_device_by_bdf_name ^⚠

Find a system device by its BDF name: “[:]:.”.

ucs_topo_find_device_by_bus_id ^⚠

Find system device by pci bus id.

ucs_topo_get_device_bus_id ^⚠

Find pci bus id of the given system device.

ucs_topo_get_distance ^⚠

Find the distance between two system devices (in terms of latency, bandwidth, hops, etc).

ucs_topo_init ^⚠

Initialize UCS topology subsystem.

ucs_topo_num_devices ^⚠

Get the number of registered system devices.

ucs_topo_print_info ^⚠

Print a map indicating the topology information between system devices discovered.

ucs_topo_sys_device_bdf_name ^⚠

Return system device name in BDF format: “::.”.

ucs_topo_sys_device_get_name ^⚠

Get the name of a given system device. If the name was never set, it defaults to the BDF representation of the system device bus id.

ucs_topo_sys_device_set_name ^⚠

Set a name for a given system device. If the name was set previously, the new name will replace the old one.

uct_cm_client_ep_conn_notify ^⚠

@ingroup UCT_CLIENT_SERVER @brief Notify the server about client-side connection establishment.

uct_cm_close ^⚠

@ingroup UCT_CLIENT_SERVER @brief Close a connection manager.

uct_cm_config_read ^⚠

@ingroup UCT_CLIENT_SERVER @brief Read the configuration for a connection manager.

uct_cm_open ^⚠

@ingroup UCT_CLIENT_SERVER @brief Open a connection manager.

uct_cm_query ^⚠

@ingroup UCT_CLIENT_SERVER @brief Get connection manager attributes.

uct_component_query ^⚠

@ingroup UCT_RESOURCE @brief Get component attributes

uct_config_get ^⚠

@ingroup UCT_CONTEXT @brief Get value by name from interface configuration (@ref uct_iface_config_t), memory domain configuration (@ref uct_md_config_t) or connection manager configuration (@ref uct_cm_config_t).

uct_config_modify ^⚠

@ingroup UCT_CONTEXT @brief Modify interface configuration (@ref uct_iface_config_t), memory domain configuration (@ref uct_md_config_t) or connection manager configuration (@ref uct_cm_config_t).

uct_config_release ^⚠

@ingroup UCT_RESOURCE @brief Release configuration memory returned from uct_md_iface_config_read(), uct_md_config_read(), or from uct_cm_config_read().

uct_ep_check ^⚠

@ingroup UCT_RESOURCE @brief check if the destination endpoint is alive in respect to UCT library

uct_ep_connect ^⚠

@ingroup UCT_CLIENT_SERVER @brief Connect a client side endpoint after it is bound to a local network device, i.e. @ref uct_ep_params_t::cm_resolve_cb was invoked.

uct_ep_connect_to_ep ^⚠

@ingroup UCT_RESOURCE @brief Connect endpoint to a remote endpoint.

uct_ep_create ^⚠

@ingroup UCT_RESOURCE @brief Create new endpoint.

uct_ep_destroy ^⚠

@ingroup UCT_RESOURCE @brief Destroy an endpoint.

uct_ep_disconnect ^⚠

@ingroup UCT_CLIENT_SERVER @brief Initiate a disconnection of an endpoint connected to a sockaddr by a connection manager @ref uct_cm_h.

uct_ep_get_address ^⚠

@ingroup UCT_RESOURCE @brief Get endpoint address.

uct_iface_accept ^⚠

@ingroup UCT_CLIENT_SERVER @brief Accept connection request.

uct_iface_close ^⚠

@ingroup UCT_RESOURCE @brief Close and destroy an interface.

uct_iface_event_arm ^⚠

@ingroup UCT_RESOURCE @brief Turn on event notification for the next event.

uct_iface_event_fd_get ^⚠

@ingroup UCT_RESOURCE @brief Obtain a notification file descriptor for polling.

uct_iface_get_address ^⚠

@ingroup UCT_RESOURCE @brief Get interface address.

uct_iface_get_device_address ^⚠

@ingroup UCT_RESOURCE @brief Get address of the device the interface is using.

uct_iface_is_reachable ^⚠

@ingroup UCT_RESOURCE @brief Check if remote iface address is reachable.

uct_iface_mem_alloc ^⚠

@ingroup UCT_RESOURCE @brief Allocate memory which can be used for zero-copy communications.

uct_iface_mem_free ^⚠

@ingroup UCT_RESOURCE @brief Release memory allocated with @ref uct_iface_mem_alloc().

uct_iface_open ^⚠

@ingroup UCT_RESOURCE @brief Open a communication interface.

uct_iface_query ^⚠

@ingroup UCT_RESOURCE @brief Get interface attributes.

uct_iface_reject ^⚠

@ingroup UCT_CLIENT_SERVER @brief Reject connection request. Will invoke an error handler @ref uct_error_handler_t on the remote transport interface, if set.

uct_iface_set_am_handler ^⚠

@ingroup UCT_AM @brief Set active message handler for the interface.

uct_iface_set_am_tracer ^⚠

@ingroup UCT_AM @brief Set active message tracer for the interface.

uct_listener_create ^⚠

@ingroup UCT_CLIENT_SERVER @brief Create a new transport listener object.

uct_listener_destroy ^⚠

@ingroup UCT_CLIENT_SERVER @brief Destroy a transport listener.

uct_listener_query ^⚠

@ingroup UCT_CLIENT_SERVER @brief Get attributes specific to a particular listener.

uct_listener_reject ^⚠

@ingroup UCT_CLIENT_SERVER @brief Reject a connection request.

uct_md_close ^⚠

@ingroup UCT_RESOURCE @brief Close a memory domain.

uct_md_config_read ^⚠

@ingroup UCT_MD @brief Read the configuration for a memory domain.

uct_md_detect_memory_type ^⚠

@ingroup UCT_MD @brief Detect memory type

uct_md_iface_config_read ^⚠

@ingroup UCT_RESOURCE @brief Read transport-specific interface configuration.

uct_md_is_sockaddr_accessible ^⚠

@ingroup UCT_MD @brief Check if remote sock address is accessible from the memory domain.

uct_md_mem_advise ^⚠

@ingroup UCT_MD @brief Give advice about the use of memory

uct_md_mem_dereg ^⚠

@ingroup UCT_MD @brief Undo the operation of @ref uct_md_mem_reg().

uct_md_mem_query ^⚠

@ingroup UCT_MD @brief Query attributes of a given pointer

uct_md_mem_reg ^⚠

@ingroup UCT_MD @brief Register memory for zero-copy sends and remote access.

uct_md_mkey_pack ^⚠

@ingroup UCT_MD

uct_md_open ^⚠

@ingroup UCT_RESOURCE @brief Open a memory domain.

uct_md_query ^⚠

@ingroup UCT_MD @brief Query for memory domain attributes.

uct_md_query_tl_resources ^⚠

@ingroup UCT_RESOURCE @brief Query for transport resources.

uct_mem_alloc ^⚠

@ingroup UCT_MD @brief Allocate memory for zero-copy communications and remote access.

uct_mem_free ^⚠

@ingroup UCT_MD @brief Release allocated memory.

uct_query_components ^⚠

@ingroup UCT_RESOURCE @brief Query for list of components.

uct_release_component_list ^⚠

@ingroup UCT_RESOURCE @brief Release the list of components returned from @ref uct_query_components.

uct_release_tl_resource_list ^⚠

@ingroup UCT_RESOURCE @brief Release the list of resources returned from @ref uct_md_query_tl_resources.

@ingroup UCT_MD

@ingroup UCT_MD

@ingroup UCT_MD

@ingroup UCT_CONTEXT @brief Create a worker object.

uct_worker_destroy ^⚠

@ingroup UCT_CONTEXT @brief Destroy a worker object.

uct_worker_progress_register_safe ^⚠

@ingroup UCT_CONTEXT @brief Add a slow path callback function to a worker progress.

uct_worker_progress_unregister_safe ^⚠

@ingroup UCT_CONTEXT @brief Remove a slow path callback function from worker’s progress.

Type Definitions

@brief Memory event callback.

ucm_event_t

@brief Memory event parameters and result.

ucm_global_config_t

@brief Global UCM configuration.

ucp_address_t

@ingroup UCP_WORKER @brief UCP worker address

ucp_am_callback_t

@ingroup UCP_ENDPOINT @brief Callback to process incoming Active Message.

ucp_am_handler_param_t

@ingroup UCP_WORKER @brief Active Message handler parameters passed to @ref ucp_worker_set_am_recv_handler routine.

ucp_am_recv_callback_t

@ingroup UCP_ENDPOINT @brief Callback to process incoming Active Message sent by @ref ucp_am_send_nbx routine.

ucp_am_recv_data_nbx_callback_t

@ingroup UCP_COMM @brief Completion callback for non-blocking Active Message receives.

ucp_am_recv_param_t

@ingroup UCP_WORKER @brief Operation parameters provided in @ref ucp_am_recv_callback_t callback.

ucp_config_t

@ingroup UCP_CONFIG @brief UCP configuration descriptor

ucp_conn_request_attr_t

@ingroup UCP_WORKER @brief UCP listener’s connection request attributes.

ucp_conn_request_h

@ingroup UCP_ENDPOINT @brief UCP connection request

ucp_context_attr_t

@ingroup UCP_CONTEXT @brief Context attributes.

ucp_context_h

@ingroup UCP_CONTEXT @brief UCP Application Context

ucp_datatype_t

@ingroup UCP_COMM @brief UCP Datatype Identifier

ucp_dt_iov_t

@ingroup UCP_DATATYPE @brief Structure for scatter-gather I/O.

ucp_ep_attr_t

@ingroup UCP_ENDPOINT @brief UCP endpoint attributes.

ucp_ep_h

@ingroup UCP_ENDPOINT @brief UCP Endpoint

ucp_ep_params_t

@ingroup UCP_ENDPOINT @brief Tuning parameters for the UCP endpoint.

ucp_err_handler_cb_t

@ingroup UCP_COMM @brief Callback to process peer failure.

ucp_err_handler_t

@ingroup UCP_COMM @brief UCP endpoint error handling context.

ucp_generic_dt_ops_t

@ingroup UCP_DATATYPE @brief UCP generic data type descriptor

ucp_lib_attr_t

@ingroup UCP_CONTEXT @brief Lib attributes.

ucp_listener_accept_callback_t

@ingroup UCP_WORKER @brief A callback for accepting client/server connections on a listener @ref ucp_listener_h.

ucp_listener_accept_handler_t

@ingroup UCP_WORKER @deprecated Replaced by @ref ucp_listener_conn_handler_t.

ucp_listener_attr_t

@ingroup UCP_WORKER @brief UCP listener attributes.

ucp_listener_conn_callback_t

@ingroup UCP_WORKER @brief A callback for handling of incoming connection request @a conn_request from a client.

ucp_listener_conn_handler_t

@ingroup UCP_WORKER @brief UCP callback to handle the connection request in a client-server connection establishment flow.

ucp_listener_h

@ingroup UCP_WORKER @brief UCP listen handle.

ucp_listener_params_t

@ingroup UCP_WORKER @brief Parameters for a UCP listener object.

ucp_mem_advise_params_t

@ingroup UCP_MEM @brief Tuning parameters for the UCP memory advice.

ucp_mem_attr_t

@ingroup UCP_MEM @brief Attributes of the @ref ucp_mem_h “UCP Memory handle”, filled by @ref ucp_mem_query function.

ucp_mem_h

@ingroup UCP_MEM @brief UCP Memory handle

ucp_mem_map_params_t

@ingroup UCP_MEM @brief Tuning parameters for the UCP memory mapping.

ucp_params_t

@ingroup UCP_CONFIG @brief Tuning parameters for UCP library.

ucp_request_cleanup_callback_t

@ingroup UCP_CONTEXT @brief Request cleanup callback.

ucp_request_init_callback_t

@ingroup UCP_CONTEXT @brief Request initialization callback.

ucp_rkey_h

@ingroup UCP_MEM @brief UCP Remote memory handle

ucp_send_callback_t

@ingroup UCP_COMM @brief Completion callback for non-blocking sends.

ucp_send_nbx_callback_t

@ingroup UCP_COMM @brief Completion callback for non-blocking sends ucp_tag_send_nbx call.

ucp_stream_poll_ep_t

@ingroup UCP_ENDPOINT @brief Output parameter of @ref ucp_stream_worker_poll function.

ucp_stream_recv_callback_t

@ingroup UCP_COMM @brief Completion callback for non-blocking stream oriented receives.

ucp_stream_recv_nbx_callback_t

@ingroup UCP_COMM @brief Completion callback for non-blocking stream receives ucp_stream_recv_nbx call.

ucp_tag_message_h

@ingroup UCP_COMM @brief UCP Message descriptor.

ucp_tag_recv_callback_t

@ingroup UCP_COMM @brief Completion callback for non-blocking tag receives.

ucp_tag_recv_info_t

@ingroup UCP_CONTEXT @brief UCP receive information descriptor

ucp_tag_recv_nbx_callback_t

@ingroup UCP_COMM @brief Completion callback for non-blocking tag receives ucp_tag_recv_nbx call.

ucp_tag_t

@ingroup UCP_COMM @brief UCP Tag Identifier

ucp_worker_address_attr_t

@ingroup UCP_WORKER @brief UCP worker address attributes.

ucp_worker_attr_t

@ingroup UCP_WORKER @brief UCP worker attributes.

ucp_worker_h

@ingroup UCP_WORKER @brief UCP Worker

ucp_worker_params_t

@ingroup UCP_WORKER @brief Tuning parameters for the UCP worker.

ucs_async_context_t

ucs_async_event_cb_t

@ingroup UCS_RESOURCE

ucs_callback_t

Callback which can be placed in a queue.

ucs_callbackq_elem_t

Callback queue element.

ucs_callbackq_predicate_t

Callback queue element predicate.

ucs_callbackq_t

A queue of callback to execute

ucs_cpu_mask_t

ucs_event_set_handler_t

ucs_event_set_handler call this handler for notifying event

ucs_event_set_types_t

Bit set composed using the available event types

ucs_list_link_t

A link in a circular list.

ucs_log_component_config_t

Logging component.

ucs_sock_addr_t

@ingroup UCS_RESOURCE BSD socket address specification.

ucs_stats_class_t

ucs_stats_counter_t

@file stats_fwd.h

ucs_stats_filter_node_t

ucs_stats_node_t

ucs_status_ptr_t

@ingroup UCS_RESOURCE @brief Status pointer

ucs_sys_bus_id_t

ucs_sys_dev_distance_t

ucs_sys_device_t

@ingroup UCS_RESOURCE System Device Index Obtained from a translation of the device bus id into a short integer Refer ucs_topo_find_device_by_bus_id()

ucs_sys_event_set_t

ucs_sys_event_set_t structure used in ucs_event_set_XXX functions.

ucs_time_t

@ingroup UCS_RESOURCE

uct_allocated_memory_t

@ingroup UCT_MD @brief Describes a memory allocated by UCT.

uct_am_callback_t

@ingroup UCT_AM @brief Callback to process incoming active message

uct_am_tracer_t

@ingroup UCT_AM @brief Callback to trace active messages.

uct_async_event_cb_t

@ingroup UCT_RESOURCE @brief Callback to process asynchronous events.

uct_cm_attr_t

@ingroup UCT_CLIENT_SERVER @brief Connection manager attributes, capabilities and limitations.

uct_cm_config_t

uct_cm_ep_client_connect_args_t

@ingroup UCT_CLIENT_SERVER @brief Arguments to the client’s connect callback.

uct_cm_ep_client_connect_callback_t

@ingroup UCT_CLIENT_SERVER @brief Callback to process an incoming connection response on the client side from the server or handle a local error on a not-yet-connected endpoint.

uct_cm_ep_conn_notify_func_t

uct_cm_ep_priv_data_pack_args_t

@ingroup UCT_CLIENT_SERVER @brief Arguments to the client-server private data pack callback.

uct_cm_ep_priv_data_pack_callback_t

@ingroup UCT_CLIENT_SERVER @brief Callback to fill the user’s private data in a client-server flow.

uct_cm_ep_resolve_args_t

@ingroup UCT_CLIENT_SERVER @brief Arguments to the client-server resolved callback.

uct_cm_ep_resolve_callback_t

@ingroup UCT_CLIENT_SERVER @brief Callback to notify that the client side endpoint is bound to a local device.

uct_cm_ep_server_conn_notify_args_t

@ingroup UCT_CLIENT_SERVER @brief Arguments to the server’s notify callback.

uct_cm_ep_server_conn_notify_callback_t

@ingroup UCT_CLIENT_SERVER @brief Callback to process an incoming connection establishment acknowledgment on the server side listener, from the client, which indicates that the client side is connected. The callback also notifies the server side of a local error on a not-yet-connected endpoint.

uct_cm_h

uct_cm_listener_conn_request_args_t

@ingroup UCT_CLIENT_SERVER @brief Arguments to the listener’s connection request callback.

uct_cm_listener_conn_request_callback_t

@ingroup UCT_CLIENT_SERVER @brief Callback to process an incoming connection request on the server side listener in a connection manager.

uct_cm_remote_data_t

@ingroup UCT_CLIENT_SERVER @brief Data received from the remote peer.

uct_cm_t

uct_completion_callback_t

@ingroup UCT_RESOURCE @brief Callback to process send completion.

uct_completion_t

@ingroup UCT_RESOURCE @brief Completion handle.

uct_component_attr_t

@ingroup UCT_RESOURCE @brief UCT component attributes

uct_component_h

@addtogroup UCT_RESOURCE @{

uct_conn_request_h

uct_desc_release_callback_t

uct_device_addr_t

uct_ep_addr_t

uct_ep_am_bcopy_func_t

uct_ep_am_short_func_t

uct_ep_am_short_iov_func_t

uct_ep_am_zcopy_func_t

uct_ep_atomic32_fetch_func_t

uct_ep_atomic32_post_func_t

uct_ep_atomic64_fetch_func_t

uct_ep_atomic64_post_func_t

uct_ep_atomic_cswap32_func_t

uct_ep_atomic_cswap64_func_t

uct_ep_attr_t

uct_ep_check_func_t

uct_ep_connect_func_t

uct_ep_connect_params_t

@ingroup UCT_CLIENT_SERVER @brief Parameters for connecting a UCT endpoint by @ref uct_ep_connect.

uct_ep_connect_to_ep_func_t

uct_ep_create_func_t

uct_ep_destroy_func_t

uct_ep_disconnect_cb_t

@ingroup UCT_CLIENT_SERVER @brief Callback to handle the disconnection of the remote peer.

uct_ep_disconnect_func_t

uct_ep_fence_func_t

uct_ep_flush_func_t

uct_ep_get_address_func_t

uct_ep_get_bcopy_func_t

uct_ep_get_short_func_t

uct_ep_get_zcopy_func_t

uct_ep_h

uct_ep_params_t

@ingroup UCT_RESOURCE @brief Parameters for creating a UCT endpoint by @ref uct_ep_create

uct_ep_pending_add_func_t

uct_ep_pending_purge_func_t

uct_ep_put_bcopy_func_t

uct_ep_put_short_func_t

@file tl.h

uct_ep_put_zcopy_func_t

uct_ep_t

Remote endpoint

uct_ep_tag_eager_bcopy_func_t

uct_ep_tag_eager_short_func_t

uct_ep_tag_eager_zcopy_func_t

uct_ep_tag_rndv_cancel_func_t

uct_ep_tag_rndv_request_func_t

uct_ep_tag_rndv_zcopy_func_t

uct_error_handler_t

@ingroup UCT_RESOURCE @brief Callback to process peer failure.

uct_iface_accept_func_t

uct_iface_addr_t

uct_iface_attr_t

@ingroup UCT_RESOURCE @brief Interface attributes: capabilities and limitations.

uct_iface_close_func_t

uct_iface_config_t

uct_iface_event_arm_func_t

uct_iface_event_fd_get_func_t

uct_iface_fence_func_t

uct_iface_flush_func_t

uct_iface_get_address_func_t

uct_iface_get_device_address_func_t

uct_iface_h

uct_iface_is_reachable_func_t

uct_iface_ops_t

Transport interface operations. Every operation exposed in the API must appear in the table below, to allow creating interface/endpoint with custom operations.

uct_iface_params_t

@ingroup UCT_RESOURCE @brief Parameters used for interface creation.

uct_iface_progress_disable_func_t

uct_iface_progress_enable_func_t

uct_iface_progress_func_t

uct_iface_query_func_t

uct_iface_reject_func_t

uct_iface_t

Communication interface context

uct_iface_tag_recv_cancel_func_t

uct_iface_tag_recv_zcopy_func_t

uct_iov_t

@ingroup UCT_RESOURCE @brief Structure for scatter-gather I/O.

uct_listener_attr_t

@ingroup UCT_CLIENT_SERVER @brief UCT listener attributes, capabilities and limitations.

uct_listener_h

uct_listener_params_t

@ingroup UCT_CLIENT_SERVER @brief Parameters for creating a listener object @ref uct_listener_h by @ref uct_listener_create

uct_listener_t

Listener for incoming connections

uct_md_attr_t

@ingroup UCT_MD @brief Memory domain attributes.

uct_md_config_t

uct_md_h

uct_md_mem_attr_t

@ingroup UCT_MD @brief Memory domain attributes.

uct_md_ops_t

uct_md_resource_desc_t

@ingroup UCT_RESOURCE @brief Memory domain resource descriptor.

uct_md_t

uct_mem_h

uct_pack_callback_t

@ingroup UCT_RESOURCE @brief Callback for producing data.

uct_pending_callback_t

@ingroup UCT_RESOURCE @brief Callback to process pending requests.

uct_pending_purge_callback_t

@ingroup UCT_RESOURCE @brief Callback to purge pending requests.

uct_pending_req_t

@ingroup UCT_RESOURCE @brief Pending request.

uct_ppn_bandwidth_t

uct_recv_desc_t

Receive descriptor

uct_rkey_bundle_t

@ingroup UCT_MD @brief Remote key with its type

uct_rkey_ctx_h

uct_rkey_t

uct_sockaddr_conn_request_callback_t

@ingroup UCT_CLIENT_SERVER @brief Callback to process an incoming connection request on the server side.

uct_tag_context_t

@ingroup UCT_TAG @brief Posted tag context.

uct_tag_t

uct_tag_unexp_eager_cb_t

@ingroup UCT_TAG @brief Callback to process unexpected eager tagged message.

uct_tag_unexp_rndv_cb_t

@ingroup UCT_TAG @brief Callback to process unexpected rendezvous tagged message.

uct_tl_resource_desc_t

@ingroup UCT_RESOURCE @brief Communication resource descriptor.

uct_unpack_callback_t

@ingroup UCT_RESOURCE @brief Callback for consuming data.

uct_worker_cb_id_t

uct_worker_h

uct_worker_t

A progress engine and a domain for allocating communication resources. Different workers are progressed independently.

Unions

ucm_event

@brief Memory event parameters and result.

ucp_request_param_t__bindgen_ty_1

Callback function that is invoked whenever the send or receive operation is completed.

ucp_request_param_t__bindgen_ty_2

Pointer to the information where received data details are stored in case of an immediate completion of receive operation. The user has to provide a pointer to valid memory/variable which will be updated on function return.

uct_iface_params__bindgen_ty_1

Mode-specific parameters