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 RMR_MSG_VER 3 // message version this code was designed to handle
49 // environment variable names we'll suss out
50 #define ENV_BIND_IF "RMR_BIND_IF" // the interface to bind to for both normal comma and RTG (0.0.0.0 if missing)
51 #define ENV_RTG_PORT "RMR_RTG_SVC" // the port we'll listen on for rtg connections
52 #define ENV_SEED_RT "RMR_SEED_RT" // where we expect to find the name of the seed route table
53 #define ENV_RTG_RAW "RMR_RTG_ISRAW" // if > 0 we expect route table gen messages as raw (not sent from an RMr application)
54 #define ENV_VERBOSE_FILE "RMR_VCTL_FILE" // file where vlevel may be managed for some (non-time critical) functions
55 #define ENV_NAME_ONLY "RMR_SRC_NAMEONLY" // src in message is name only
56 #define ENV_WARNINGS "RMR_WARNINGS" // if == 1 then we write some, non-performance impacting, warnings
57 #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
59 #define NO_FLAGS 0 // no flags to pass to a function
61 #define FL_NOTHREAD 0x01 // do not start an additional thread (must be 'user land' to support rtg
62 #define UFL_MASK 0xff // mask applied to some flag parms passed by the user to remove any internal flags
63 // internal flags, must be > than UFLAG_MASK
66 #define CFL_MTC_ENABLED 0x01 // multi-threaded call is enabled
69 #define CTXFL_WARN 0x01 // ok to warn on stderr for some things that shouldn't happen
72 #define MFL_ZEROCOPY 0x01 // the message is an allocated zero copy message and can be sent.
73 #define MFL_NOALLOC 0x02 // send should NOT allocate a new buffer before returning
74 #define MFL_ADDSRC 0x04 // source must be added on send
75 #define MFL_RAW 0x08 // message is 'raw' and not from an RMr based sender (no header)
77 #define MAX_EP_GROUP 32 // max number of endpoints in a group
78 #define MAX_RTG_MSG_SZ 2048 // max expected message size from route generator
79 #define MAX_CALL_ID 255 // largest call ID that is supported
81 //#define DEF_RTG_MSGID "" // default to pick up all messages from rtg
82 #define DEF_RTG_PORT "tcp:4561" // default port that we accept rtg connections on
83 #define DEF_COMM_PORT "tcp:4560" // default port we use for normal communications
84 #define DEF_TR_LEN (-1) // use default trace data len from context
86 #define UNSET_SUBID (-1) // initial value on msg allocation indicating not set
87 #define UNSET_MSGTYPE (-1)
89 // -- header length/offset macros must ensure network conversion ----
90 #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
91 #define RMR_TR_LEN(h) (ntohl(((uta_mhdr_t *)h)->len1))
92 #define RMR_D1_LEN(h) (ntohl(((uta_mhdr_t *)h)->len2))
93 #define RMR_D2_LEN(h) (ntohl(((uta_mhdr_t *)h)->len3))
95 // CAUTION: if using an offset with a header pointer, the pointer MUST be cast to void* before adding the offset!
96 #define TRACE_OFFSET(h) ((ntohl(((uta_mhdr_t *)h)->len0)))
97 #define DATA1_OFFSET(h) (ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1))
98 #define DATA2_OFFSET(h) (ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2))
99 #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))
101 #define TRACE_ADDR(h) (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0))
102 #define DATA1_ADDR(h) (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1))
103 #define DATA2_ADDR(h) (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2))
104 #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))
106 #define SET_HDR_LEN(h) (((uta_mhdr_t *)h)->len0=htonl((int32_t)sizeof(uta_mhdr_t))) // convert to network byte order on insert
107 #define SET_HDR_TR_LEN(h,l) (((uta_mhdr_t *)h)->len1=htonl((int32_t)l))
108 #define SET_HDR_D1_LEN(h,l) (((uta_mhdr_t *)h)->len2=htonl((int32_t)l))
109 #define SET_HDR_D2_LEN(h,l) (((uta_mhdr_t *)h)->len3=htonl((int32_t)l))
111 #define HDR_VERSION(h) htonl((((uta_mhdr_t *)h)->rmr_ver))
113 // index of things in the d1 data space
114 #define D1_CALLID_IDX 0 // the call-id to match on return
116 #define NO_CALL_ID 0 // no call id associated with the message (normal queue)
118 #define V1_PAYLOAD_OFFSET(h) (sizeof(uta_v1mhdr_t))
121 #define HFL_HAS_TRACE 0x01 // Trace data is populated
122 #define HFL_SUBID 0x02 // subscription ID is populated
123 #define HFL_CALL_MSG 0x04 // msg sent via blocking call
126 Message header; interpreted by the other side, but never seen by
127 the user application.
129 DANGER: Add new fields AT THE END of the struct. Adding them any where else
130 will break any code that is currently running.
132 The transport layer buffer allocated will be divided this way:
133 | RMr header | Trace data | data1 | data2 | User paylaod |
135 Len 0 is the length of the RMr header
136 Len 1 is the length of the trace data
137 Len 2 and 3 are lengths of data1 and data2 and are unused at the moment
139 To point at the payload, we take the address of the header and add all 4 lengths.
142 int32_t mtype; // message type ("long" network integer)
143 int32_t plen; // payload length
144 int32_t rmr_ver; // our internal message version number
145 unsigned char xid[RMR_MAX_XID]; // space for user transaction id or somesuch
146 unsigned char sid[RMR_MAX_SID]; // sender ID for return to sender needs
147 unsigned char src[RMR_MAX_SRC]; // name:port of the sender (source)
148 unsigned char meid[RMR_MAX_MEID]; // managed element id.
149 struct timespec ts; // timestamp ???
152 int32_t flags; // HFL_* constants
153 int32_t len0; // length of the RMr header data
154 int32_t len1; // length of the tracing data
155 int32_t len2; // length of data 1 (d1)
156 int32_t len3; // length of data 2 (d2)
157 int32_t sub_id; // subscription id (-1 invalid)
160 unsigned char srcip[RMR_MAX_SRC]; // ip address and port of the source
164 typedef struct { // old (inflexible) v1 header
165 int32_t mtype; // message type ("long" network integer)
166 int32_t plen; // payload length
167 int32_t rmr_ver; // our internal message version number
168 unsigned char xid[RMR_MAX_XID]; // space for user transaction id or somesuch
169 unsigned char sid[RMR_MAX_SID]; // misc sender info/data
170 unsigned char src[16]; // name of the sender (source) (old size was 16)
171 unsigned char meid[RMR_MAX_MEID]; // managed element id.
172 struct timespec ts; // timestamp ???
179 uint16_t ep_idx; // next endpoint to send to
180 int nused; // number of endpoints in the list
181 int nendpts; // number allocated
182 endpoint_t **epts; // the list of endpoints that we RR over
186 Routing table entry. This is a list of endpoints that can be sent
187 messages of the given mtype. If there is more than one, we will
188 round robin messags across the list.
191 uint64_t key; // key used to reinsert this entry into a new symtab
192 int refs; // number of symtabs which reference the entry
193 int mtype; // the message type for this list
194 int nrrgroups; // number of rr groups to send to
195 rrgroup_t** rrgroups; // one or more set of endpoints to round robin messages to
202 void* hash; // hash table.
203 int updates; // counter of update records received
207 A wormhole is a direct connection between two endpoints that the user app can
208 send to without message type based routing.
211 int nalloc; // number of ep pointers allocated
212 endpoint_t** eps; // end points directly referenced
217 This manages an array of pointers to IP addresses that are associated with one of our interfaces.
218 For now, we don't need to map the addr to a specific interface, just know that it is one of ours.
221 char** addrs; // all ip addresses we found
222 int naddrs; // num actually used
226 // --------------- ring things -------------------------------------------------
227 typedef struct ring {
228 uint16_t head; // index of the head of the ring (insert point)
229 uint16_t tail; // index of the tail (extract point)
230 uint16_t nelements; // number of elements in the ring
231 void** data; // the ring data (pointers to blobs of stuff)
235 // --------- multi-threaded call things -----------------------------------------
237 A chute provides a return path for a received message that a thread has blocked
238 on. The receive thread will set the mbuf pointer and tickler the barrier to
239 signal to the call thread that data is ready.
241 typedef struct chute {
242 rmr_mbuf_t* mbuf; // pointer to message buffer received
243 sem_t barrier; // semaphore that the thread is waiting on
244 unsigned char expect[RMR_MAX_XID]; // the expected transaction ID
248 // -------------- common static prototypes --------------------------------------
250 //---- tools ----------------------------------
251 static int has_myip( char const* buf, if_addrs_t* list, char sep, int max );
252 static int uta_tokenise( char* buf, char** tokens, int max, char sep );
253 static int uta_rmip_tokenise( char* buf, if_addrs_t* iplist, char** toks, int max, char sep );
254 static char* uta_h2ip( char const* hname );
255 static int uta_lookup_rtg( uta_ctx_t* ctx );
256 static int uta_has_str( char const* buf, char const* str, char sep, int max );
257 static char* get_default_ip( if_addrs_t* iplist );
259 // --- message ring --------------------------
260 static void* uta_mk_ring( int size );
261 static void uta_ring_free( void* vr );
262 static inline void* uta_ring_extract( void* vr );
263 static inline int uta_ring_insert( void* vr, void* new_data );
265 // --- message and context management --------
266 static int ie_test( void* r, int i_factor, long inserts );
269 // ----- route table generic static things ---------
270 static inline uint64_t build_rt_key( int32_t sub_id, int32_t mtype );
271 static void collect_things( void* st, void* entry, char const* name, void* thing, void* vthing_list );
272 static void del_rte( void* st, void* entry, char const* name, void* thing, void* data );
273 static char* uta_fib( char* fname );
274 static route_table_t* uta_rt_init( );
275 static route_table_t* uta_rt_clone( route_table_t* srt );
276 static route_table_t* uta_rt_clone_all( route_table_t* srt );
277 static void uta_rt_drop( route_table_t* rt );
278 static endpoint_t* uta_add_ep( route_table_t* rt, rtable_ent_t* rte, char* ep_name, int group );
279 static rtable_ent_t* uta_add_rte( route_table_t* rt, uint64_t key, int nrrgroups );
280 static endpoint_t* uta_get_ep( route_table_t* rt, char const* ep_name );
281 static void read_static_rt( uta_ctx_t* ctx, int vlevel );
282 static void parse_rt_rec( uta_ctx_t* ctx, char* buf, int vlevel );
283 static rmr_mbuf_t* realloc_msg( rmr_mbuf_t* msg, int size );
284 static void* rtc( void* vctx );
285 static endpoint_t* rt_ensure_ep( route_table_t* rt, char const* ep_name );