UCX  1.10
Unified Communication X
uct_def.h
1 
7 #ifndef UCT_DEF_H_
8 #define UCT_DEF_H_
9 
10 #include <ucs/config/types.h>
11 #include <ucs/type/status.h>
12 
13 #include <stddef.h>
14 #include <stdint.h>
15 #include <sys/types.h>
16 
17 
18 #define UCT_COMPONENT_NAME_MAX 16
19 #define UCT_TL_NAME_MAX 10
20 #define UCT_MD_NAME_MAX 16
21 #define UCT_DEVICE_NAME_MAX 32
22 #define UCT_PENDING_REQ_PRIV_LEN 40
23 #define UCT_TAG_PRIV_LEN 32
24 #define UCT_AM_ID_BITS 5
25 #define UCT_AM_ID_MAX UCS_BIT(UCT_AM_ID_BITS)
26 #define UCT_MEM_HANDLE_NULL NULL
27 #define UCT_INVALID_RKEY ((uintptr_t)(-1))
28 #define UCT_INLINE_API static UCS_F_ALWAYS_INLINE
29 
30 
41 };
42 
43 
67  UCT_CB_PARAM_FLAG_DESC = UCS_BIT(0),
70 };
71 
76 typedef struct uct_component *uct_component_h;
77 typedef struct uct_iface *uct_iface_h;
78 typedef struct uct_iface_config uct_iface_config_t;
79 typedef struct uct_md_config uct_md_config_t;
80 typedef struct uct_cm_config uct_cm_config_t;
81 typedef struct uct_ep *uct_ep_h;
82 typedef void * uct_mem_h;
83 typedef uintptr_t uct_rkey_t;
84 typedef struct uct_md *uct_md_h;
85 typedef struct uct_md_ops uct_md_ops_t;
86 typedef void *uct_rkey_ctx_h;
89 typedef struct uct_md_attr uct_md_attr_t;
92 typedef struct uct_worker *uct_worker_h;
93 typedef struct uct_md uct_md_t;
95 typedef struct uct_device_addr uct_device_addr_t;
96 typedef struct uct_iface_addr uct_iface_addr_t;
97 typedef struct uct_ep_addr uct_ep_addr_t;
99 typedef struct uct_cm_attr uct_cm_attr_t;
100 typedef struct uct_cm uct_cm_t;
103 typedef struct uct_listener *uct_listener_h;
106 typedef uint64_t uct_tag_t; /* tag type - 64 bit */
107 typedef int uct_worker_cb_id_t;
108 typedef void* uct_conn_request_h;
109 
143 typedef struct uct_iov {
144  void *buffer;
145  size_t length;
147  size_t stride;
149  unsigned count;
150 } uct_iov_t;
151 
152 
165 };
166 
167 
180  uint64_t field_mask;
181 
188  char dev_name[UCT_DEVICE_NAME_MAX];
190 
191 
202 
205 
208 
211 };
212 
213 
221 typedef struct uct_cm_remote_data {
227  uint64_t field_mask;
228 
233 
238 
243  const void *conn_priv_data;
244 
250 
251 
266 
272 
278 
284 };
285 
286 
300  uint64_t field_mask;
301 
305  char dev_name[UCT_DEVICE_NAME_MAX];
306 
313 
318 
324 
325 
337 
340 };
341 
342 
355  uint64_t field_mask;
356 
361 
373 
374 
389 };
390 
391 
404  uint64_t field_mask;
405 
418 
419 
446 typedef ucs_status_t (*uct_am_callback_t)(void *arg, void *data, size_t length,
447  unsigned flags);
448 
449 
464 typedef void (*uct_am_tracer_t)(void *arg, uct_am_trace_type_t type, uint8_t id,
465  const void *data, size_t length, char *buffer,
466  size_t max);
467 
468 
477 
478 
494 
495 
511 typedef ucs_status_t (*uct_error_handler_t)(void *arg, uct_ep_h ep,
512  ucs_status_t status);
513 
514 
524  void *arg);
525 
535 typedef size_t (*uct_pack_callback_t)(void *dest, void *arg);
536 
537 
548 typedef void (*uct_unpack_callback_t)(void *arg, const void *data, size_t length);
549 
550 
578 typedef void
580  uct_conn_request_h conn_request,
581  const void *conn_priv_data,
582  size_t length);
583 
584 
603 typedef void
606  *conn_req_args);
607 
608 
634  (uct_ep_h ep, void *arg,
635  const uct_cm_ep_server_conn_notify_args_t *connect_args);
636 
637 
658 typedef void (*uct_cm_ep_client_connect_callback_t)(uct_ep_h ep, void *arg,
660  *connect_args);
661 
662 
680 typedef void (*uct_ep_disconnect_cb_t)(uct_ep_h ep, void *arg);
681 
682 
707 typedef ssize_t
710  *pack_args, void *priv_data);
711 
712 
759 typedef ucs_status_t (*uct_tag_unexp_eager_cb_t)(void *arg, void *data,
760  size_t length, unsigned flags,
761  uct_tag_t stag, uint64_t imm,
762  void **context);
763 
764 
796 typedef ucs_status_t (*uct_tag_unexp_rndv_cb_t)(void *arg, unsigned flags,
797  uint64_t stag, const void *header,
798  unsigned header_length,
799  uint64_t remote_addr, size_t length,
800  const void *rkey_buf);
801 
802 
811 typedef void (*uct_async_event_cb_t)(void *arg, unsigned flags);
812 
813 
814 #endif
Definition: uct_def.h:68
struct uct_cm_ep_client_connect_args uct_cm_ep_client_connect_args_t
Arguments to the client's connect callback.
struct uct_md uct_md_t
Definition: uct_def.h:93
Definition: uct_def.h:201
uct_am_trace_type
Trace types for active message tracer.
Definition: uct_def.h:35
void(* uct_async_event_cb_t)(void *arg, unsigned flags)
Callback to process asynchronous events.
Definition: uct_def.h:811
struct uct_cm_remote_data uct_cm_remote_data_t
Data received from the remote peer.
void * uct_mem_h
Definition: uct_def.h:82
void(* uct_sockaddr_conn_request_callback_t)(uct_iface_h iface, void *arg, uct_conn_request_h conn_request, const void *conn_priv_data, size_t length)
Callback to process an incoming connection request on the server side.
Definition: uct_def.h:579
Structure for scatter-gather I/O.
Definition: uct_def.h:143
size_t conn_priv_data_length
Definition: uct_def.h:248
void(* uct_ep_disconnect_cb_t)(uct_ep_h ep, void *arg)
Callback to handle the disconnection of the remote peer.
Definition: uct_def.h:680
Arguments to the client-server private data pack callback.
Definition: uct_def.h:174
ucs_status_t status
Definition: uct_def.h:416
struct uct_md_ops uct_md_ops_t
Definition: uct_def.h:85
struct uct_iov uct_iov_t
Structure for scatter-gather I/O.
Parameters used for interface creation.
Definition: uct.h:1011
struct uct_md_config uct_md_config_t
Definition: uct_def.h:79
void(* uct_pending_purge_callback_t)(uct_pending_req_t *self, void *arg)
Callback to purge pending requests.
Definition: uct_def.h:523
Arguments to the listener's connection request callback.
Definition: uct_def.h:294
Arguments to the client's connect callback.
Definition: uct_def.h:349
uct_cm_t * uct_cm_h
Definition: uct_def.h:101
uct_cb_param_flags
Flags for active message and tag-matching offload callbacks (callback's parameters).
Definition: uct_def.h:66
void * buffer
Definition: uct_def.h:144
ucs_sock_addr_t client_address
Definition: uct_def.h:322
uct_cm_listener_conn_request_args_field
Listener's connection request callback arguments field mask.
Definition: uct_def.h:260
void(* uct_cm_listener_conn_request_callback_t)(uct_listener_h listener, void *arg, const uct_cm_listener_conn_request_args_t *conn_req_args)
Callback to process an incoming connection request on the server side listener in a connection manage...
Definition: uct_def.h:604
void(* uct_cm_ep_server_conn_notify_callback_t)(uct_ep_h ep, void *arg, const uct_cm_ep_server_conn_notify_args_t *connect_args)
Callback to process an incoming connection establishment acknowledgment on the server side listener,...
Definition: uct_def.h:634
UCT listener attributes, capabilities and limitations.
Definition: uct.h:1212
struct uct_worker * uct_worker_h
Definition: uct_def.h:92
Interface attributes: capabilities and limitations.
Definition: uct.h:876
int uct_worker_cb_id_t
Definition: uct_def.h:107
ucs_status_t(* uct_error_handler_t)(void *arg, uct_ep_h ep, ucs_status_t status)
Callback to process peer failure.
Definition: uct_def.h:511
uint64_t field_mask
Definition: uct_def.h:227
Definition: uct_def.h:69
uint64_t field_mask
Definition: uct_def.h:355
struct uct_iface_addr uct_iface_addr_t
Definition: uct_def.h:96
void(* uct_completion_callback_t)(uct_completion_t *self)
Callback to process send completion.
Definition: uct_def.h:476
struct uct_cm_ep_server_conn_notify_args uct_cm_ep_server_conn_notify_args_t
Arguments to the server's notify callback.
struct uct_cm_config uct_cm_config_t
Definition: uct_def.h:80
struct uct_ep_addr uct_ep_addr_t
Definition: uct_def.h:97
struct uct_md * uct_md_h
Memory domain handler.
Definition: uct_def.h:84
const uct_cm_remote_data_t * remote_data
Definition: uct_def.h:360
ucs_status_t(* uct_tag_unexp_rndv_cb_t)(void *arg, unsigned flags, uint64_t stag, const void *header, unsigned header_length, uint64_t remote_addr, size_t length, const void *rkey_buf)
Callback to process unexpected rendezvous tagged message.
Definition: uct_def.h:796
Definition: uct_def.h:39
size_t(* uct_pack_callback_t)(void *dest, void *arg)
Callback for producing data.
Definition: uct_def.h:535
const void * conn_priv_data
Definition: uct_def.h:243
size_t length
Definition: uct_def.h:145
ucs_status_t
Status codes.
Definition: status.h:45
uint64_t field_mask
Definition: uct_def.h:404
Parameters for creating a listener object uct_listener_h by uct_listener_create.
Definition: uct.h:1232
uct_cm_ep_priv_data_pack_args_field
Client-Server private data pack callback arguments field mask.
Definition: uct_def.h:160
uct_cm_remote_data_field
Remote data attributes field mask.
Definition: uct_def.h:199
ucs_status_t status
Definition: uct_def.h:371
Connection manager attributes, capabilities and limitations.
Definition: uct.h:1192
struct uct_listener * uct_listener_h
Definition: uct_def.h:103
void(* uct_unpack_callback_t)(void *arg, const void *data, size_t length)
Callback for consuming data.
Definition: uct_def.h:548
uint64_t field_mask
Definition: uct_def.h:300
struct uct_component * uct_component_h
Definition: uct_def.h:76
const uct_cm_remote_data_t * remote_data
Definition: uct_def.h:317
uint64_t uct_tag_t
Definition: uct_def.h:106
struct uct_iface_config uct_iface_config_t
Definition: uct_def.h:78
unsigned count
Definition: uct_def.h:149
ssize_t(* uct_cm_ep_priv_data_pack_callback_t)(void *arg, const uct_cm_ep_priv_data_pack_args_t *pack_args, void *priv_data)
Callback to fill the user's private data in a client-server flow.
Definition: uct_def.h:708
struct uct_cm_ep_priv_data_pack_args uct_cm_ep_priv_data_pack_args_t
Arguments to the client-server private data pack callback.
uct_cm_ep_server_conn_notify_args_field
Field mask flags for server-side connection established notification callback.
Definition: uct_def.h:384
char dev_name[UCT_DEVICE_NAME_MAX]
Definition: uct_def.h:188
Arguments to the server's notify callback.
Definition: uct_def.h:398
Parameters for creating a UCT endpoint by uct_ep_create.
Definition: uct.h:1089
uct_mem_h memh
Definition: uct_def.h:146
Definition: uct_def.h:67
char dev_name[UCT_DEVICE_NAME_MAX]
Definition: uct_def.h:305
uct_conn_request_h conn_request
Definition: uct_def.h:312
Memory domain attributes.
Definition: uct.h:1268
void * uct_conn_request_h
Definition: uct_def.h:108
uct_cm_ep_client_connect_args_field
Field mask flags for client-side connection established callback.
Definition: uct_def.h:334
size_t dev_addr_length
Definition: uct_def.h:237
void(* uct_am_tracer_t)(void *arg, uct_am_trace_type_t type, uint8_t id, const void *data, size_t length, char *buffer, size_t max)
Callback to trace active messages.
Definition: uct_def.h:464
ucs_status_t(* uct_pending_callback_t)(uct_pending_req_t *self)
Callback to process pending requests.
Definition: uct_def.h:493
Pending request.
Definition: uct.h:1425
size_t stride
Definition: uct_def.h:147
void(* uct_cm_ep_client_connect_callback_t)(uct_ep_h ep, void *arg, const uct_cm_ep_client_connect_args_t *connect_args)
Callback to process an incoming connection response on the client side from the server or handle a lo...
Definition: uct_def.h:658
struct uct_cm_listener_conn_request_args uct_cm_listener_conn_request_args_t
Arguments to the listener's connection request callback.
struct uct_iface * uct_iface_h
Definition: uct_def.h:77
Definition: types.h:118
const uct_device_addr_t * dev_addr
Definition: uct_def.h:232
struct uct_ep * uct_ep_h
Definition: uct_def.h:81
Definition: uct_def.h:36
Posted tag context.
Definition: uct.h:1438
Definition: uct_def.h:37
Definition: uct_def.h:38
ucs_status_t(* uct_tag_unexp_eager_cb_t)(void *arg, void *data, size_t length, unsigned flags, uct_tag_t stag, uint64_t imm, void **context)
Callback to process unexpected eager tagged message.
Definition: uct_def.h:759
enum uct_am_trace_type uct_am_trace_type_t
Definition: uct_def.h:94
Completion handle.
Definition: uct.h:1409
void * uct_rkey_ctx_h
Definition: uct_def.h:86
Definition: uct_def.h:40
struct uct_device_addr uct_device_addr_t
Definition: uct_def.h:95
ucs_status_t(* uct_am_callback_t)(void *arg, void *data, size_t length, unsigned flags)
Callback to process incoming active message.
Definition: uct_def.h:446
uintptr_t uct_rkey_t
Definition: uct_def.h:83
Data received from the remote peer.
Definition: uct_def.h:221
struct uct_cm uct_cm_t
Definition: uct_def.h:100
uint64_t field_mask
Definition: uct_def.h:180