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 typedef struct endpoint endpoint_t; // place holder for structs defined in nano/nng private.h
33 typedef struct uta_ctx uta_ctx_t;
35 // allow testing to override without changing this
43 #define QUOTE(a) #a // allow a constant to be quoted
44 #define QUOTE_DEF(a) QUOTE(a) // allow a #define value to be quoted (e.g. QUOTE(MAJOR_VERSION) )
47 #define RT_SIZE 10009 // primary entries in route table (prime) meids hash through this so larger than expected # meids
48 // space deginations in the hash table
49 #define RT_MT_SPACE 0 // (integer) message type as the key
50 #define RT_NAME_SPACE 1 // enpoint name/address is the key
51 #define RT_ME_SPACE 2 // message id is the key
53 #define RMR_MSG_VER 3 // message version this code was designed to handle
55 // environment variable names we'll suss out
56 #define ENV_BIND_IF "RMR_BIND_IF" // the interface to bind to for both normal comma and RTG (0.0.0.0 if missing)
57 #define ENV_RTG_PORT "RMR_RTG_SVC" // the port we'll listen on for rtg connections
58 #define ENV_SEED_RT "RMR_SEED_RT" // where we expect to find the name of the seed route table
59 #define ENV_SEED_MEMAP "RMR_SEED_MEMAP" // where we expect to find the name of the seed route table
60 #define ENV_RTG_RAW "RMR_RTG_ISRAW" // if > 0 we expect route table gen messages as raw (not sent from an RMr application)
61 #define ENV_VERBOSE_FILE "RMR_VCTL_FILE" // file where vlevel may be managed for some (non-time critical) functions
62 #define ENV_NAME_ONLY "RMR_SRC_NAMEONLY" // src in message is name only
63 #define ENV_WARNINGS "RMR_WARNINGS" // if == 1 then we write some, non-performance impacting, warnings
64 #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
66 #define NO_FLAGS 0 // no flags to pass to a function
68 #define FL_NOTHREAD 0x01 // do not start an additional thread (must be 'user land' to support rtg
69 #define UFL_MASK 0xff // mask applied to some flag parms passed by the user to remove any internal flags
70 // internal flags, must be > than UFLAG_MASK
73 #define CFL_MTC_ENABLED 0x01 // multi-threaded call is enabled
76 #define CTXFL_WARN 0x01 // ok to warn on stderr for some things that shouldn't happen
79 #define MFL_ZEROCOPY 0x01 // the message is an allocated zero copy message and can be sent.
80 #define MFL_NOALLOC 0x02 // send should NOT allocate a new buffer before returning
81 #define MFL_ADDSRC 0x04 // source must be added on send
82 #define MFL_RAW 0x08 // message is 'raw' and not from an RMr based sender (no header)
84 #define MAX_EP_GROUP 32 // max number of endpoints in a group
85 #define MAX_RTG_MSG_SZ 2048 // max expected message size from route generator
86 #define MAX_CALL_ID 255 // largest call ID that is supported
88 //#define DEF_RTG_MSGID "" // default to pick up all messages from rtg
89 #define DEF_RTG_PORT "tcp:4561" // default port that we accept rtg connections on
90 #define DEF_COMM_PORT "tcp:4560" // default port we use for normal communications
91 #define DEF_TR_LEN (-1) // use default trace data len from context
93 #define UNSET_SUBID (-1) // initial value on msg allocation indicating not set
94 #define UNSET_MSGTYPE (-1)
96 // index values into the send counters for an enpoint
97 #define EPSC_GOOD 0 // successful send
98 #define EPSC_FAIL 1 // hard failurs
99 #define EPSC_TRANS 2 // transient/soft faiures
100 #define EPSC_SIZE 3 // number of counters
102 // -- header length/offset macros must ensure network conversion ----
103 #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
104 #define RMR_TR_LEN(h) (ntohl(((uta_mhdr_t *)h)->len1))
105 #define RMR_D1_LEN(h) (ntohl(((uta_mhdr_t *)h)->len2))
106 #define RMR_D2_LEN(h) (ntohl(((uta_mhdr_t *)h)->len3))
108 // CAUTION: if using an offset with a header pointer, the pointer MUST be cast to void* before adding the offset!
109 #define TRACE_OFFSET(h) ((ntohl(((uta_mhdr_t *)h)->len0)))
110 #define DATA1_OFFSET(h) (ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1))
111 #define DATA2_OFFSET(h) (ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2))
112 #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))
114 #define TRACE_ADDR(h) (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0))
115 #define DATA1_ADDR(h) (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1))
116 #define DATA2_ADDR(h) (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2))
117 #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))
119 #define SET_HDR_LEN(h) (((uta_mhdr_t *)h)->len0=htonl((int32_t)sizeof(uta_mhdr_t))) // convert to network byte order on insert
120 #define SET_HDR_TR_LEN(h,l) (((uta_mhdr_t *)h)->len1=htonl((int32_t)l))
121 #define SET_HDR_D1_LEN(h,l) (((uta_mhdr_t *)h)->len2=htonl((int32_t)l))
122 #define SET_HDR_D2_LEN(h,l) (((uta_mhdr_t *)h)->len3=htonl((int32_t)l))
124 #define HDR_VERSION(h) htonl((((uta_mhdr_t *)h)->rmr_ver))
126 // index of things in the d1 data space
127 #define D1_CALLID_IDX 0 // the call-id to match on return
129 #define NO_CALL_ID 0 // no call id associated with the message (normal queue)
131 #define V1_PAYLOAD_OFFSET(h) (sizeof(uta_v1mhdr_t))
134 #define HFL_HAS_TRACE 0x01 // Trace data is populated
135 #define HFL_SUBID 0x02 // subscription ID is populated
136 #define HFL_CALL_MSG 0x04 // msg sent via blocking call
139 Message header; interpreted by the other side, but never seen by
140 the user application.
142 DANGER: Add new fields AT THE END of the struct. Adding them any where else
143 will break any code that is currently running.
145 The transport layer buffer allocated will be divided this way:
146 | RMr header | Trace data | data1 | data2 | User paylaod |
148 Len 0 is the length of the RMr header
149 Len 1 is the length of the trace data
150 Len 2 and 3 are lengths of data1 and data2 and are unused at the moment
152 To point at the payload, we take the address of the header and add all 4 lengths.
155 int32_t mtype; // message type ("long" network integer)
156 int32_t plen; // payload length (sender data length in payload)
157 int32_t rmr_ver; // our internal message version number
158 unsigned char xid[RMR_MAX_XID]; // space for user transaction id or somesuch
159 unsigned char sid[RMR_MAX_SID]; // sender ID for return to sender needs
160 unsigned char src[RMR_MAX_SRC]; // name:port of the sender (source)
161 unsigned char meid[RMR_MAX_MEID]; // managed element id.
162 struct timespec ts; // timestamp ???
165 int32_t flags; // HFL_* constants
166 int32_t len0; // length of the RMr header data
167 int32_t len1; // length of the tracing data
168 int32_t len2; // length of data 1 (d1)
169 int32_t len3; // length of data 2 (d2)
170 int32_t sub_id; // subscription id (-1 invalid)
173 unsigned char srcip[RMR_MAX_SRC]; // ip address and port of the source
177 typedef struct { // old (inflexible) v1 header
178 int32_t mtype; // message type ("long" network integer)
179 int32_t plen; // payload length
180 int32_t rmr_ver; // our internal message version number
181 unsigned char xid[RMR_MAX_XID]; // space for user transaction id or somesuch
182 unsigned char sid[RMR_MAX_SID]; // misc sender info/data
183 unsigned char src[16]; // name of the sender (source) (old size was 16)
184 unsigned char meid[RMR_MAX_MEID]; // managed element id.
185 struct timespec ts; // timestamp ???
192 uint16_t ep_idx; // next endpoint to send to
193 int nused; // number of endpoints in the list
194 int nendpts; // number allocated
195 endpoint_t **epts; // the list of endpoints that we RR over
199 Routing table entry. This is a list of endpoints that can be sent
200 messages of the given mtype. If there is more than one, we will
201 round robin messags across the list.
204 uint64_t key; // key used to reinsert this entry into a new symtab
205 int refs; // number of symtabs which reference the entry
206 int mtype; // the message type for this list
207 int nrrgroups; // number of rr groups to send to (if 0, the meid in a message determines endpoint)
208 rrgroup_t** rrgroups; // one or more set of endpoints to round robin messages to
215 void* hash; // hash table.
216 int updates; // counter of update records received
217 int mupdates; // counter of meid update records received
221 A wormhole is a direct connection between two endpoints that the user app can
222 send to without message type based routing.
225 int nalloc; // number of ep pointers allocated
226 endpoint_t** eps; // end points directly referenced
231 This manages an array of pointers to IP addresses that are associated with one of our interfaces.
232 For now, we don't need to map the addr to a specific interface, just know that it is one of ours.
235 char** addrs; // all ip addresses we found
236 int naddrs; // num actually used
240 // --------------- ring things -------------------------------------------------
241 typedef struct ring {
242 uint16_t head; // index of the head of the ring (insert point)
243 uint16_t tail; // index of the tail (extract point)
244 uint16_t nelements; // number of elements in the ring
245 void** data; // the ring data (pointers to blobs of stuff)
249 // --------- multi-threaded call things -----------------------------------------
251 A chute provides a return path for a received message that a thread has blocked
252 on. The receive thread will set the mbuf pointer and tickler the barrier to
253 signal to the call thread that data is ready.
255 typedef struct chute {
256 rmr_mbuf_t* mbuf; // pointer to message buffer received
257 sem_t barrier; // semaphore that the thread is waiting on
258 unsigned char expect[RMR_MAX_XID]; // the expected transaction ID
262 // -------------- common static prototypes --------------------------------------
264 //---- tools ----------------------------------
265 static int has_myip( char const* buf, if_addrs_t* list, char sep, int max );
266 static int uta_tokenise( char* buf, char** tokens, int max, char sep );
267 static int uta_rmip_tokenise( char* buf, if_addrs_t* iplist, char** toks, int max, char sep );
268 static char* uta_h2ip( char const* hname );
269 static int uta_lookup_rtg( uta_ctx_t* ctx );
270 static int uta_has_str( char const* buf, char const* str, char sep, int max );
271 static char* get_default_ip( if_addrs_t* iplist );
273 // --- message ring --------------------------
274 static void* uta_mk_ring( int size );
275 static void uta_ring_free( void* vr );
276 static inline void* uta_ring_extract( void* vr );
277 static inline int uta_ring_insert( void* vr, void* new_data );
279 // --- message and context management --------
280 static int ie_test( void* r, int i_factor, long inserts );
283 // ----- route table generic static things ---------
284 static inline uint64_t build_rt_key( int32_t sub_id, int32_t mtype );
285 static void collect_things( void* st, void* entry, char const* name, void* thing, void* vthing_list );
286 static void del_rte( void* st, void* entry, char const* name, void* thing, void* data );
287 static char* uta_fib( char* fname );
288 static route_table_t* uta_rt_init( );
289 static route_table_t* uta_rt_clone( route_table_t* srt );
290 static route_table_t* uta_rt_clone_all( route_table_t* srt );
291 static void uta_rt_drop( route_table_t* rt );
292 static endpoint_t* uta_add_ep( route_table_t* rt, rtable_ent_t* rte, char* ep_name, int group );
293 static rtable_ent_t* uta_add_rte( route_table_t* rt, uint64_t key, int nrrgroups );
294 static endpoint_t* uta_get_ep( route_table_t* rt, char const* ep_name );
295 static void read_static_rt( uta_ctx_t* ctx, int vlevel );
296 static void parse_rt_rec( uta_ctx_t* ctx, char* buf, int vlevel );
297 static rmr_mbuf_t* realloc_msg( rmr_mbuf_t* msg, int size );
298 static void* rtc( void* vctx );
299 static endpoint_t* rt_ensure_ep( route_table_t* rt, char const* ep_name );