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: rmr_agnostic.h
23 Abstract: Header file for things that are agnostic to the underlying transport
25 Author: E. Scott Daniels
26 Date: 28 February 2018
29 #ifndef _rmr_agnostic_h
30 #define _rmr_agnostic_h
32 #include <semaphore.h> // needed to support some structs
34 typedef struct endpoint endpoint_t; // place holder for structs defined in nano/nng private.h
35 typedef struct uta_ctx uta_ctx_t;
37 // allow testing to override without changing this
45 #define QUOTE(a) #a // allow a constant to be quoted
46 #define QUOTE_DEF(a) QUOTE(a) // allow a #define value to be quoted (e.g. QUOTE(MAJOR_VERSION) )
49 #define RT_SIZE 10009 // primary entries in route table (prime) meids hash through this so larger than expected # meids
50 // space deginations in the hash table
51 #define RT_MT_SPACE 0 // (integer) message type as the key
52 #define RT_NAME_SPACE 1 // enpoint name/address is the key
53 #define RT_ME_SPACE 2 // message id is the key
55 #define RMR_MSG_VER 3 // message version this code was designed to handle
57 // environment variable names we'll suss out
58 #define ENV_BIND_IF "RMR_BIND_IF" // the interface to bind to for both normal comma and RTG (0.0.0.0 if missing)
59 #define ENV_RTG_PORT "RMR_RTG_SVC" // the port we'll listen on for rtg connections (deprecated; see RTG_SVC and CTL_PORT)
60 #define ENV_RTG_ADDR "RMR_RTG_SVC" // the address we will connect to for route manager updates
61 #define ENV_SEED_RT "RMR_SEED_RT" // where we expect to find the name of the seed route table
62 #define ENV_SEED_MEMAP "RMR_SEED_MEMAP" // where we expect to find the name of the seed route table
63 #define ENV_RTG_RAW "RMR_RTG_ISRAW" // if > 0 we expect route table gen messages as raw (not sent from an RMr application)
64 #define ENV_VERBOSE_FILE "RMR_VCTL_FILE" // file where vlevel may be managed for some (non-time critical) functions
65 #define ENV_NAME_ONLY "RMR_SRC_NAMEONLY" // src in message is name only
66 #define ENV_WARNINGS "RMR_WARNINGS" // if == 1 then we write some, non-performance impacting, warnings
67 #define ENV_SRC_ID "RMR_SRC_ID" // forces this string (adding :port, max 63 ch) into the source field; host name used if not set
68 #define ENV_LOG_HR "RMR_HR_LOG" // set to 0 to turn off human readable logging and write using some formatting
69 #define ENV_LOG_VLEVEL "RMR_LOG_VLEVEL" // set the verbosity level (0 == 0ff; 1 == crit .... 5 == debug )
70 #define ENV_CTL_PORT "RMR_CTL_PORT" // route collector will listen here for control messages (4561 default)
71 #define ENV_RTREQ_FREA "RMR_RTREQ_FREQ" // frequency we will request route table updates when we want one (1-300 inclusive)
73 #define NO_FLAGS 0 // no flags to pass to a function
75 #define FL_NOTHREAD 0x01 // do not start an additional thread (must be 'user land' to support rtg
76 #define UFL_MASK 0xff // mask applied to some flag parms passed by the user to remove any internal flags
77 // internal flags, must be > than UFLAG_MASK
80 #define CFL_MTC_ENABLED 0x01 // multi-threaded call is enabled
81 #define CFL_NO_RTACK 0x02 // no route table ack needed when end received
84 #define CTXFL_WARN 0x01 // ok to warn on stderr for some things that shouldn't happen
87 #define MFL_ZEROCOPY 0x01 // the message is an allocated zero copy message and can be sent.
88 #define MFL_NOALLOC 0x02 // send should NOT allocate a new buffer before returning
89 #define MFL_ADDSRC 0x04 // source must be added on send
90 #define MFL_RAW 0x08 // message is 'raw' and not from an RMr based sender (no header)
91 #define MFL_HUGE 0x10 // buffer was larger than applications indicated usual max; don't cache
93 #define MAX_EP_GROUP 32 // max number of endpoints in a group
94 #define MAX_RTG_MSG_SZ 2048 // max expected message size from route generator
95 #define MAX_CALL_ID 255 // largest call ID that is supported
97 //#define DEF_RTG_MSGID "" // default to pick up all messages from rtg
98 #define DEF_CTL_PORT "4561" // default control port that rtc listens on
99 #define DEF_RTG_PORT "tcp:4561" // default port that we accept rtg connections on (deprecated)
100 #define DEF_COMM_PORT "tcp:4560" // default port we use for normal communications
101 #define DEF_RTG_WK_ADDR "routemgr:4561" // well known address for the route manager
102 #define DEF_TR_LEN (-1) // use default trace data len from context
103 #define DEF_RTREQ_FREQ 5 // delay between route table requests
105 #define UNSET_SUBID (-1) // initial value on msg allocation indicating not set
106 #define UNSET_MSGTYPE (-1)
108 // index values into the send counters for an enpoint
109 #define EPSC_GOOD 0 // successful send
110 #define EPSC_FAIL 1 // hard failurs
111 #define EPSC_TRANS 2 // transient/soft faiures
112 #define EPSC_SIZE 3 // number of counters
114 // -- header length/offset macros must ensure network conversion ----
115 #define RMR_HDR_LEN(h) (ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2)+htonl(((uta_mhdr_t *)h)->len3)) // ALL things, not just formal struct
116 #define RMR_TR_LEN(h) (ntohl(((uta_mhdr_t *)h)->len1))
117 #define RMR_D1_LEN(h) (ntohl(((uta_mhdr_t *)h)->len2))
118 #define RMR_D2_LEN(h) (ntohl(((uta_mhdr_t *)h)->len3))
120 // CAUTION: if using an offset with a header pointer, the pointer MUST be cast to void* before adding the offset!
121 #define TRACE_OFFSET(h) ((ntohl(((uta_mhdr_t *)h)->len0)))
122 #define DATA1_OFFSET(h) (ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1))
123 #define DATA2_OFFSET(h) (ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2))
124 #define PAYLOAD_OFFSET(h) (ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2)+htonl(((uta_mhdr_t *)h)->len3))
126 #define TRACE_ADDR(h) (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0))
127 #define DATA1_ADDR(h) (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1))
128 #define DATA2_ADDR(h) (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2))
129 #define PAYLOAD_ADDR(h) (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2)+htonl(((uta_mhdr_t *)h)->len3))
131 #define SET_HDR_LEN(h) (((uta_mhdr_t *)h)->len0=htonl((int32_t)sizeof(uta_mhdr_t))) // convert to network byte order on insert
132 #define SET_HDR_TR_LEN(h,l) (((uta_mhdr_t *)h)->len1=htonl((int32_t)l))
133 #define SET_HDR_D1_LEN(h,l) (((uta_mhdr_t *)h)->len2=htonl((int32_t)l))
134 #define SET_HDR_D2_LEN(h,l) (((uta_mhdr_t *)h)->len3=htonl((int32_t)l))
136 #define HDR_VERSION(h) htonl((((uta_mhdr_t *)h)->rmr_ver))
138 // index of things in the d1 data space
139 #define D1_CALLID_IDX 0 // the call-id to match on return
141 #define NO_CALL_ID 0 // no call id associated with the message (normal queue)
143 #define V1_PAYLOAD_OFFSET(h) (sizeof(uta_v1mhdr_t))
146 #define HFL_HAS_TRACE 0x01 // Trace data is populated
147 #define HFL_SUBID 0x02 // subscription ID is populated
148 #define HFL_CALL_MSG 0x04 // msg sent via blocking call
151 Message header; interpreted by the other side, but never seen by
152 the user application.
154 DANGER: Add new fields AT THE END of the struct. Adding them any where else
155 will break any code that is currently running.
157 The transport layer buffer allocated will be divided this way:
158 | RMr header | Trace data | data1 | data2 | User paylaod |
160 Len 0 is the length of the RMr header
161 Len 1 is the length of the trace data
162 Len 2 and 3 are lengths of data1 and data2 and are unused at the moment
164 To point at the payload, we take the address of the header and add all 4 lengths.
167 int32_t mtype; // message type ("long" network integer)
168 int32_t plen; // payload length (sender data length in payload)
169 int32_t rmr_ver; // our internal message version number
170 unsigned char xid[RMR_MAX_XID]; // space for user transaction id or somesuch
171 unsigned char sid[RMR_MAX_SID]; // sender ID for return to sender needs
172 unsigned char src[RMR_MAX_SRC]; // name:port of the sender (source)
173 unsigned char meid[RMR_MAX_MEID]; // managed element id.
174 struct timespec ts; // timestamp ???
177 int32_t flags; // HFL_* constants
178 int32_t len0; // length of the RMr header data
179 int32_t len1; // length of the tracing data
180 int32_t len2; // length of data 1 (d1)
181 int32_t len3; // length of data 2 (d2)
182 int32_t sub_id; // subscription id (-1 invalid)
185 unsigned char srcip[RMR_MAX_SRC]; // ip address and port of the source
189 typedef struct { // old (inflexible) v1 header
190 int32_t mtype; // message type ("long" network integer)
191 int32_t plen; // payload length
192 int32_t rmr_ver; // our internal message version number
193 unsigned char xid[RMR_MAX_XID]; // space for user transaction id or somesuch
194 unsigned char sid[RMR_MAX_SID]; // misc sender info/data
195 unsigned char src[16]; // name of the sender (source) (old size was 16)
196 unsigned char meid[RMR_MAX_MEID]; // managed element id.
197 struct timespec ts; // timestamp ???
204 uint16_t ep_idx; // next endpoint to send to
205 int nused; // number of endpoints in the list
206 int nendpts; // number allocated
207 endpoint_t **epts; // the list of endpoints that we RR over
211 Routing table entry. This is a list of endpoints that can be sent
212 messages of the given mtype. If there is more than one, we will
213 round robin messags across the list.
216 uint64_t key; // key used to reinsert this entry into a new symtab
217 int refs; // number of symtabs which reference the entry
218 int mtype; // the message type for this list
219 int nrrgroups; // number of rr groups to send to (if 0, the meid in a message determines endpoint)
220 rrgroup_t** rrgroups; // one or more set of endpoints to round robin messages to
227 void* hash; // hash table.
228 int updates; // counter of update records received
229 int mupdates; // counter of meid update records received
233 A wormhole is a direct connection between two endpoints that the user app can
234 send to without message type based routing.
237 int nalloc; // number of ep pointers allocated
238 endpoint_t** eps; // end points directly referenced
243 This manages an array of pointers to IP addresses that are associated with one of our interfaces.
244 For now, we don't need to map the addr to a specific interface, just know that it is one of ours.
247 char** addrs; // all ip addresses we found
248 int naddrs; // num actually used
252 // --------------- ring things -------------------------------------------------
253 #define RING_NONE 0 // no options
254 #define RING_RLOCK 0x01 // create/destroy the read lock on the ring
255 #define RING_WLOCK 0x02 // create/destroy the write lockk on the ring
257 typedef struct ring {
258 uint16_t head; // index of the head of the ring (insert point)
259 uint16_t tail; // index of the tail (extract point)
260 uint16_t nelements; // number of elements in the ring
261 void** data; // the ring data (pointers to blobs of stuff)
262 int pfd; // event fd for the ring for epoll
263 pthread_mutex_t* rgate; // read lock if used
264 pthread_mutex_t* wgate; // write lock if used
268 // --------- multi-threaded call things -----------------------------------------
270 A chute provides a return path for a received message that a thread has blocked
271 on. The receive thread will set the mbuf pointer and tickler the barrier to
272 signal to the call thread that data is ready.
274 typedef struct chute {
275 rmr_mbuf_t* mbuf; // pointer to message buffer received
276 sem_t barrier; // semaphore that the thread is waiting on
277 unsigned char expect[RMR_MAX_XID]; // the expected transaction ID
281 // -------------- common static prototypes --------------------------------------
283 //---- tools ----------------------------------
284 static int has_myip( char const* buf, if_addrs_t* list, char sep, int max );
285 static int uta_tokenise( char* buf, char** tokens, int max, char sep );
286 static int uta_rmip_tokenise( char* buf, if_addrs_t* iplist, char** toks, int max, char sep );
287 static char* uta_h2ip( char const* hname );
288 static int uta_lookup_rtg( uta_ctx_t* ctx );
289 static int uta_has_str( char const* buf, char const* str, char sep, int max );
290 static char* get_default_ip( if_addrs_t* iplist );
292 // --- message ring --------------------------
293 static void* uta_mk_ring( int size );
294 static int uta_ring_config( void* vr, int options );
295 static void uta_ring_free( void* vr );
296 static inline void* uta_ring_extract( void* vr );
297 static inline int uta_ring_insert( void* vr, void* new_data );
299 // --- message and context management --------
300 static int ie_test( void* r, int i_factor, long inserts );
303 // ----- route table generic static things ---------
304 static inline uint64_t build_rt_key( int32_t sub_id, int32_t mtype );
305 static void collect_things( void* st, void* entry, char const* name, void* thing, void* vthing_list );
306 static void del_rte( void* st, void* entry, char const* name, void* thing, void* data );
307 static endpoint_t* get_meid_owner( route_table_t *rt, char* meid );
308 static char* uta_fib( char* fname );
309 static route_table_t* uta_rt_init( );
310 static route_table_t* uta_rt_clone( route_table_t* srt );
311 static route_table_t* uta_rt_clone_all( route_table_t* srt );
312 static void uta_rt_drop( route_table_t* rt );
313 static endpoint_t* uta_add_ep( route_table_t* rt, rtable_ent_t* rte, char* ep_name, int group );
314 static rtable_ent_t* uta_add_rte( route_table_t* rt, uint64_t key, int nrrgroups );
315 static endpoint_t* uta_get_ep( route_table_t* rt, char const* ep_name );
316 static void read_static_rt( uta_ctx_t* ctx, int vlevel );
317 static void parse_rt_rec( uta_ctx_t* ctx, uta_ctx_t* pctx, char* buf, int vlevel, rmr_mbuf_t* mbuf );
318 static rmr_mbuf_t* realloc_msg( rmr_mbuf_t* msg, int size );
319 static void* rtc( void* vctx );
320 static endpoint_t* rt_ensure_ep( route_table_t* rt, char const* ep_name );
322 // --------- route manager communications -----------------
323 static void send_rt_ack( uta_ctx_t* ctx, rmr_mbuf_t* mbuf, char* table_id, int state, char* reason );
324 static int send_update_req( uta_ctx_t* pctx, uta_ctx_t* ctx );
326 // -------- internal functions that can be referenced by common functions -------
327 static rmr_mbuf_t* mt_call( void* vctx, rmr_mbuf_t* mbuf, int call_id, int max_wait, endpoint_t* ep );