1 // : vi ts=4 sw=4 noet :
3 ==================================================================================
4 Copyright (c) 2019 Nokia
5 Copyright (c) 2018-2019 AT&T Intellectual Property.
7 Licensed under the Apache License, Version 2.0 (the "License");
8 you may not use this file except in compliance with the License.
9 You may obtain a copy of the License at
11 http://www.apache.org/licenses/LICENSE-2.0
13 Unless required by applicable law or agreed to in writing, software
14 distributed under the License is distributed on an "AS IS" BASIS,
15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 See the License for the specific language governing permissions and
17 limitations under the License.
18 ==================================================================================
22 Mnemonic: uta_nng_private.h
23 Abstract: Private header information for the uta nng library functions.
24 These are structs which have specific NNG types; anything that
25 does not can be included in the common/rmr_agnostic.h header.
27 Author: E. Scott Daniels
28 Date: 31 November 2018
30 Mods: 28 Feb 2019 -- moved the majority to the agnostic header.
33 #ifndef _uta_private_h
34 #define _uta_private_h
37 Manages an endpoint. Type def for this is defined in agnostic.
40 char* name; // end point name (symtab reference)
41 char* proto; // connection proto (should only be TCP, but future might bring others)
42 char* addr; // address used for connection
43 nng_socket nn_sock; // the nano-msg socket to write to for this entry
44 nng_dialer dialer; // the connection specific information (retry timout etc)
45 int open; // set to true if we've connected as socket cannot be checked directly)
46 pthread_mutex_t gate; // we must serialise when we open/link to the endpoint
50 Epoll information needed for the rmr_torcv_msg() funciton
52 typedef struct epoll_stuff {
53 struct epoll_event events[1]; // wait on 10 possible events
54 struct epoll_event epe; // event definition for event to listen to
55 int ep_fd; // file des from nng
56 int nng_fd; // fd from nng
60 Context describing our world. Should be returned to user programme on
61 call to initialise, and passed as first parm on all calls to other
64 The typedef is declared in the agnostic header.
67 char* my_name; // dns name of this host to set in sender field of a message
68 int shutdown; // thread notification if we need to tell them to stop
69 int max_mlen; // max message length payload+header
70 int max_plen; // max payload length
71 int flags; // CTXFL_ constants
72 int nrtele; // number of elements in the routing table
73 int send_retries; // number of retries send_msg() should attempt if eagain/timeout indicated by nng
74 int trace_data_len; // number of bytes to allocate in header for trace data
75 int d1_len; // extra header data 1 length
76 int d2_len; // extra header data 2 length (future)
77 nng_socket nn_sock; // our general listen socket
78 route_table_t* rtable; // the active route table
79 route_table_t* old_rtable; // the previously used rt, sits here to allow for draining
80 route_table_t* new_rtable; // route table under construction
81 if_addrs_t* ip_list; // list manager of the IP addresses that are on our known interfaces
82 void* mring; // ring where msgs are queued while waiting for a call response msg
85 char* rtg_addr; // addr/port of the route table generation publisher
86 int rtg_port; // the port that the rtg listens on
88 wh_mgt_t* wormholes; // management of user opened wormholes
89 epoll_stuff_t* eps; // epoll information needed for the rcv with timeout call
91 pthread_t rtc_th; // thread info for the rtc listener
92 pthread_t mtc_th; // thread info for the multi-thread call receive process
98 Static prototypes for functions located here. All common protos are in the
102 // --- initialisation and housekeeping -------
103 static void* init( char* uproto_port, int max_msg_size, int flags );
104 static void free_ctx( uta_ctx_t* ctx );
106 // --- rt table things ---------------------------
107 static int uta_link2( endpoint_t* ep );
108 static int rt_link2_ep( endpoint_t* ep );
109 static int uta_epsock_byname( route_table_t* rt, char* ep_name, nng_socket* nn_sock );
110 static int uta_epsock_rr( route_table_t *rt, uint64_t key, int group, int* more, nng_socket* nn_sock );
111 static inline int xlate_nng_state( int state, int def_state );
114 // --- msg ---------------------------------------
115 static rmr_mbuf_t* alloc_zcmsg( uta_ctx_t* ctx, rmr_mbuf_t* msg, int size, int state, int trlo );
116 static rmr_mbuf_t* alloc_mbuf( uta_ctx_t* ctx, int state );
117 static void ref_tpbuf( rmr_mbuf_t* msg, size_t alen ) ;
118 static inline rmr_mbuf_t* clone_msg( rmr_mbuf_t* old_msg );
119 static rmr_mbuf_t* rcv_msg( uta_ctx_t* ctx, rmr_mbuf_t* old_msg );
120 static void* rcv_payload( uta_ctx_t* ctx, rmr_mbuf_t* old_msg );
121 static inline rmr_mbuf_t* realloc_msg( rmr_mbuf_t* old_msg, int tr_len );
122 static rmr_mbuf_t* send_msg( uta_ctx_t* ctx, rmr_mbuf_t* msg, nng_socket nn_sock, int retries );
123 static rmr_mbuf_t* send2ep( uta_ctx_t* ctx, endpoint_t* ep, rmr_mbuf_t* msg );