1 /*
2 * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
3 * University Research and Technology
4 * Corporation. All rights reserved.
5 * Copyright (c) 2004-2007 The University of Tennessee and The University
6 * of Tennessee Research Foundation. All rights
7 * reserved.
8 * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
9 * University of Stuttgart. All rights reserved.
10 * Copyright (c) 2004-2005 The Regents of the University of California.
11 * All rights reserved.
12 * Copyright (c) 2011 Cisco Systems, Inc. All rights reserved.
13 * $COPYRIGHT$
14 *
15 * Additional copyrights may follow
16 *
17 * $HEADER$
18 */
19
20 #ifndef MCA_BTL_TCP_ENDPOINT_H
21 #define MCA_BTL_TCP_ENDPOINT_H
22
23 #include "opal/class/opal_list.h"
24 #include "opal/mca/event/event.h"
25 #include "btl_tcp2_frag.h"
26 #include "btl_tcp2.h"
27 BEGIN_C_DECLS
28
29 #define MCA_BTL_TCP_ENDPOINT_CACHE 1
30
31 /**
32 * State of TCP endpoint connection.
33 */
34
35 typedef enum {
36 MCA_BTL_TCP_CONNECTING = 0,
37 MCA_BTL_TCP_CONNECT_ACK,
38 MCA_BTL_TCP_CLOSED,
39 MCA_BTL_TCP_FAILED,
40 MCA_BTL_TCP_CONNECTED
41 } mca_btl_tcp2_state_t;
42
43 /**
44 * An abstraction that represents a connection to a endpoint process.
45 * An instance of mca_btl_base_endpoint_t is associated w/ each process
46 * and BTL pair at startup. However, connections to the endpoint
47 * are established dynamically on an as-needed basis:
48 */
49
50 struct mca_btl_base_endpoint_t {
51 opal_list_item_t super;
52 struct mca_btl_tcp2_module_t* endpoint_btl; /**< BTL instance that created this connection */
53 struct mca_btl_tcp2_proc_t* endpoint_proc; /**< proc structure corresponding to endpoint */
54 struct mca_btl_tcp2_addr_t* endpoint_addr; /**< address of endpoint */
55 int endpoint_sd; /**< socket connection to endpoint */
56 #if MCA_BTL_TCP_ENDPOINT_CACHE
57 char* endpoint_cache; /**< cache for the recv (reduce the number of recv syscall) */
58 char* endpoint_cache_pos; /**< current position in the cache */
59 size_t endpoint_cache_length; /**< length of the data in the cache */
60 #endif /* MCA_BTL_TCP_ENDPOINT_CACHE */
61 struct mca_btl_tcp2_frag_t* endpoint_send_frag; /**< current send frag being processed */
62 struct mca_btl_tcp2_frag_t* endpoint_recv_frag; /**< current recv frag being processed */
63 mca_btl_tcp2_state_t endpoint_state; /**< current state of the connection */
64 size_t endpoint_retries; /**< number of connection retries attempted */
65 opal_list_t endpoint_frags; /**< list of pending frags to send */
66 opal_mutex_t endpoint_send_lock; /**< lock for concurrent access to endpoint state */
67 opal_mutex_t endpoint_recv_lock; /**< lock for concurrent access to endpoint state */
68 opal_event_t endpoint_send_event; /**< event for async processing of send frags */
69 opal_event_t endpoint_recv_event; /**< event for async processing of recv frags */
70 bool endpoint_nbo; /**< convert headers to network byte order? */
71 };
72
73 typedef struct mca_btl_base_endpoint_t mca_btl_base_endpoint_t;
74 typedef mca_btl_base_endpoint_t mca_btl_tcp2_endpoint_t;
75 OBJ_CLASS_DECLARATION(mca_btl_tcp2_endpoint_t);
76
77 void mca_btl_tcp2_set_socket_options(int sd);
78 void mca_btl_tcp2_endpoint_close(mca_btl_base_endpoint_t*);
79 int mca_btl_tcp2_endpoint_send(mca_btl_base_endpoint_t*, struct mca_btl_tcp2_frag_t*);
80 bool mca_btl_tcp2_endpoint_accept(mca_btl_base_endpoint_t*, struct sockaddr*, int);
81 void mca_btl_tcp2_endpoint_shutdown(mca_btl_base_endpoint_t*);
82
83 END_C_DECLS
84 #endif