ucx1-sys 0.1.0

Rust FFI bindings to UCX.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

/**
 * Copyright (C) Mellanox Technologies Ltd. 2001-2017.  ALL RIGHTS RESERVED.
 *
 * See file LICENSE for terms.
 */

#ifndef UCP_PROXY_EP_H_
#define UCP_PROXY_EP_H_

#include "ucp_types.h"

#include <uct/api/uct.h>
#include <ucs/type/class.h>


/**
 * Generic proxy endpoint, used to change behavior of a specific transport lane
 * without adding data-path checks when not needed.
 * By default, all transport endpoint operations are redirected to the underlying
 * UCT endpoint, and interface operations would result in a fatal error.
 * When this endpoint is destroyed, the lane in UCP endpoint is replaced with
 * the real transport endpoint.
 *
 * TODO make sure it works with err handling and print_ucp_info
 */
typedef struct ucp_proxy_ep {
    uct_ep_t        super;     /**< Derived from uct_ep */
    uct_iface_t     iface;     /**< Embedded stub interface */
    ucp_ep_h        ucp_ep;    /**< Pointer to UCP endpoint */
    uct_ep_h        uct_ep;    /**< Underlying transport endpoint */
    int             is_owner;  /**< Is uct_ep owned by this proxy ep */
    ucp_rsc_index_t rsc_index; /**< Resource index of underlying transport endpoint */
} ucp_proxy_ep_t;


UCS_CLASS_DECLARE(ucp_proxy_ep_t, const uct_iface_ops_t *ops, ucp_ep_h ucp_ep,
                  uct_ep_h uct_ep, int is_owner);


/**
 * Replace the proxy endpoint by the underlying transport endpoint, and destroy
 * the proxy endpoint.
 */
void ucp_proxy_ep_replace(ucp_proxy_ep_t *proxy_ep);

int ucp_proxy_ep_test(uct_ep_h ep);

uct_ep_h ucp_proxy_ep_extract(uct_ep_h ep);

void ucp_proxy_ep_set_uct_ep(ucp_proxy_ep_t *proxy_ep, uct_ep_h uct_ep,
                             int is_owner, ucp_rsc_index_t rsc_index);

#endif