Fix potential race in route table load
[ric-plt/lib/rmr.git] / src / rmr / si / include / rmr_si_private.h
1 //  vim: ts=4 sw=4 noet :
2 /*
3 ==================================================================================
4         Copyright (c) 2019-2020 Nokia
5         Copyright (c) 2018-2020 AT&T Intellectual Property.
6
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
10
11            http://www.apache.org/licenses/LICENSE-2.0
12
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 ==================================================================================
19 */
20
21 /*
22         Mnemonic:       uta_si_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.
26
27         Author:         E. Scott Daniels
28         Date:           31 November 2018
29
30         Mods:           28 Feb 2019 -- moved the majority to the agnostic header.
31 */
32
33 #ifndef _uta_private_h
34 #define _uta_private_h
35
36 // if pmode is off we don't compile in some checks in hopes of speeding things up
37 #ifndef PARANOID_CHECKS
38 #       define PARANOID_CHECKS 0
39 #endif
40
41
42 // ---- si specific things  -------------------------------------------
43
44 #define TP_HDR_LEN      50              // bytes added to each message for transport needs
45
46                                                         // river states
47 #define RS_NEW          0               // river is unitialised
48 #define RS_GOOD         1               // flow is in progress
49 #define RS_RESET        2               // flow was interrupted; reset on next receive
50
51 #define RF_NOTIFIED     0x01    // notification made about river issue
52 #define RF_DROP         0x02    // this message is large and being dropped
53
54 #define TP_SZFIELD_LEN  ((sizeof(uint32_t)*2)+1)        // number of bytes needed for msg size in transport header
55 #define TP_SZ_MARKER    '$'                                                     // marker indicating net byte order used
56
57
58 #define SI_MAX_ADDR_LEN         512
59
60 /*
61         Manages a river of inbound bytes.
62 */
63 typedef struct {
64         int             state;          // RS_* constants
65         char*   accum;          // bytes being accumulated
66         int             nbytes;         // allocated size of accumulator
67         int             ipt;            // insertion point in accumulator
68         int             msg_size;       // size of the message being accumulated
69         int             flags;          // RF_* constants
70 } river_t;
71
72
73 /*
74         Callback context.
75 typedef struct {
76         uta_ctx_t*      ctx;
77         
78 } cbctx_t;
79 */
80
81 // ---------------------------- mainline rmr things ----------------
82
83
84 /*
85         Manages an endpoint. Type def for this is defined in agnostic.
86 */
87 struct endpoint {
88         char*   name;                   // end point name (symtab reference)
89         char*   proto;                  // connection proto (should only be TCP, but future might bring others)
90         char*   addr;                   // address used for connection
91         int             nn_sock;                // we'll keep calling it nn_ because it's less changes to the code
92         //nng_dialer    dialer;         // the connection specific information (retry timout etc)
93         int             open;                   // set to true if we've connected as socket cannot be checked directly)
94         pthread_mutex_t gate;   // we must serialise when we open/link to the endpoint
95         long long scounts[EPSC_SIZE];           // send counts (indexed by EPSCOUNT_* constants
96
97                                                         // SI specific things
98         int notify;                             // if we fail, we log once until a connection happens; notify if set
99 };
100
101 /*
102         Epoll information needed for the rmr_torcv_msg() funciton
103 */
104 typedef struct epoll_stuff {
105         struct epoll_event events[1];                           // wait on 1 possible events
106         struct epoll_event epe;                                         // event definition for event to listen to
107         int ep_fd;                                                                      // file des from nng
108         int poll_fd;                                                            // fd from nng
109 } epoll_stuff_t;
110
111 /*
112         Context describing our world. Should be returned to user programme on
113         call to initialise, and passed as first parm on all calls to other
114         visible functions.
115
116         The typedef is declared in the agnostic header.
117 */
118 struct uta_ctx {
119         char*   my_name;                        // dns name of this host to set in sender field of a message
120         char*   my_ip;                          // the ip address we _think_ we are using sent in src_ip of the message for rts
121         int     shutdown;                               // thread notification if we need to tell them to stop
122         int max_mlen;                           // max message length payload+header
123         int     max_plen;                               // max payload length
124         int     flags;                                  // CTXFL_ constants
125         int nrtele;                                     // number of elements in the routing table
126         int send_retries;                       // number of retries send_msg() should attempt if eagain/timeout indicated by nng
127         int     trace_data_len;                 // number of bytes to allocate in header for trace data
128         int d1_len;                                     // extra header data 1 length
129         int d2_len;                                     // extra header data 2 length   (future)
130         int     nn_sock;                                // our general listen socket
131         int rtable_ready;                       // set to true when rt is received or loaded
132         route_table_t* rtable;          // the active route table
133         route_table_t* old_rtable;      // the previously used rt, sits here to allow for draining
134         route_table_t* new_rtable;      // route table under construction
135         if_addrs_t*     ip_list;                // list manager of the IP addresses that are on our known interfaces
136         void*   mring;                          // ring where msgs are queued while waiting for a call response msg
137         chute_t*        chutes;
138
139         char*   rtg_addr;                       // addr/port of the route table generation publisher
140         int             rtg_port;                       // the port that the rtg listens on
141
142         wh_mgt_t*       wormholes;              // management of user opened wormholes
143         epoll_stuff_t*  eps;            // epoll information needed for the rcv with timeout call
144
145         pthread_t       rtc_th;                 // thread info for the rtc listener
146         pthread_t       mtc_th;                 // thread info for the multi-thread call receive process
147
148                                                                 // added for route manager request/states
149         rmr_whid_t      rtg_whid;               // wormhole id to the route manager for acks/requests
150         char*           table_id;               // table ID of the route table load in progress
151
152                                                                 // added for SI95 support
153         si_ctx_t*       si_ctx;                 // the socket context
154         int                     nrivers;                // allocated rivers
155         river_t*        rivers;                 // inbound flows (index is the socket fd)
156         int                     max_ibm;                // max size of an inbound message (river accum alloc size)
157         void*           zcb_mring;              // zero copy buffer mbuf ring
158         void*           fd2ep;                          // the symtab mapping file des to endpoints for cleanup on disconnect
159         void*           ephash;                         // hash  host:port or ip:port to endpoint struct
160
161         pthread_mutex_t *fd2ep_gate;    // we must gate add/deletes to the fd2 symtab
162         pthread_mutex_t *rtgate;                // master gate for accessing/moving route tables
163 };
164
165 typedef uta_ctx_t uta_ctx;
166
167
168 /*
169         Static prototypes for functions located here. All common protos are in the
170         agnostic header file.
171 */
172
173 // --- initialisation and housekeeping -------
174 static void* init(  char* uproto_port, int max_msg_size, int flags );
175 static void free_ctx( uta_ctx_t* ctx );
176
177 // --- rt table things ---------------------------
178 static void uta_ep_failed( endpoint_t* ep );
179 static int uta_link2( uta_ctx_t *ctx, endpoint_t* ep );
180
181 static int rt_link2_ep( void* vctx, endpoint_t* ep );
182 static rtable_ent_t* uta_get_rte( route_table_t *rt, int sid, int mtype, int try_alt );
183 static inline int xlate_si_state( int state, int def_state );
184
185 // --- these have changes for si
186 static int uta_epsock_byname( uta_ctx_t* ctx, char* ep_name, int* nn_sock, endpoint_t** uepp );
187 //static int uta_epsock_rr( rtable_ent_t *rte, int group, int* more, int* nn_sock, endpoint_t** uepp, si_ctx_t* si_ctx );
188 static int uta_epsock_rr( uta_ctx_t* ctx, rtable_ent_t *rte, int group, int* more, int* nn_sock, endpoint_t** uepp );
189
190
191 // --- msg ---------------------------------------
192 static rmr_mbuf_t* alloc_zcmsg( uta_ctx_t* ctx, rmr_mbuf_t* msg, int size, int state, int trlo );
193 static rmr_mbuf_t* alloc_mbuf( uta_ctx_t* ctx, int state );
194 static void ref_tpbuf( rmr_mbuf_t* msg, size_t alen ) ;
195 static inline rmr_mbuf_t* clone_msg( rmr_mbuf_t* old_msg  );
196 static rmr_mbuf_t* rcv_msg( uta_ctx_t* ctx, rmr_mbuf_t* old_msg );
197 static inline rmr_mbuf_t* realloc_msg( rmr_mbuf_t* old_msg, int tr_len  );
198 static rmr_mbuf_t* send2ep( uta_ctx_t* ctx, endpoint_t* ep, rmr_mbuf_t* msg );
199
200 static rmr_mbuf_t* send_msg( uta_ctx_t* ctx, rmr_mbuf_t* msg, int nn_sock, int retries );
201
202 // ---- fd to endpoint translation ------------------------------
203 static endpoint_t*  fd2ep_del( uta_ctx_t* ctx, int fd );
204 static endpoint_t*  fd2ep_get( uta_ctx_t* ctx, int fd );
205 static void fd2ep_init( uta_ctx_t* ctx );
206 static void fd2ep_add( uta_ctx_t* ctx, int fd, endpoint_t* ep );
207
208 #endif