src/rmr/common/include/rmr_agnostic.h

   1 // : vi ts=4 sw=4 noet :
   2 /*
   3 ==================================================================================
   4         Copyright (c) 2019 Nokia
   5         Copyright (c) 2018-2019 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:       rmr_agnostic.h
  23         Abstract:       Header file for things that are agnostic to the underlying transport
  24                                 mechanism.
  25         Author:         E. Scott Daniels
  26         Date:           28 February 2018
  27 */
  28
  29 #ifndef _rmr_agnostic_h
  30 #define _rmr_agnostic_h
  31
  32 typedef struct endpoint endpoint_t;             // place holder for structs defined in nano/nng private.h
  33 typedef struct uta_ctx  uta_ctx_t;
  34
  35 // allow testing to override without changing this
  36 #ifndef DEBUG
  37 #define DEBUG 0
  38 #endif
  39
  40 #define FALSE 0
  41 #define TRUE  1
  42
  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) )
  45
  46
  47 #define RMR_MSG_VER     3                       // message version this code was designed to handle
  48
  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
  58 #define NO_FLAGS        0                               // no flags to pass to a function
  59
  60 #define FL_NOTHREAD     0x01                    // do not start an additional thread (must be 'user land' to support rtg
  61 #define UFL_MASK                0xff            // mask applied to some flag parms passed by the user to remove any internal flags
  62                                                                         // internal flags, must be > than UFLAG_MASK
  63 //#define IFL_....
  64
  65 #define CFL_MTC_ENABLED 0x01            // multi-threaded call is enabled
  66
  67                                                                         // context flags
  68 #define CTXFL_WARN              0x01            // ok to warn on stderr for some things that shouldn't happen
  69
  70                                                                         // msg buffer flags
  71 #define MFL_ZEROCOPY    0x01            // the message is an allocated zero copy message and can be sent.
  72 #define MFL_NOALLOC             0x02            // send should NOT allocate a new buffer before returning
  73 #define MFL_ADDSRC              0x04            // source must be added on send
  74 #define MFL_RAW                 0x08            // message is 'raw' and not from an RMr based sender (no header)
  75
  76 #define MAX_EP_GROUP    32                      // max number of endpoints in a group
  77 #define MAX_RTG_MSG_SZ  2048            // max expected message size from route generator
  78 #define MAX_CALL_ID             255                     // largest call ID that is supported
  79
  80 //#define DEF_RTG_MSGID ""                              // default to pick up all messages from rtg
  81 #define DEF_RTG_PORT    "tcp:4561"              // default port that we accept rtg connections on
  82 #define DEF_COMM_PORT   "tcp:4560"              // default port we use for normal communications
  83 #define DEF_TR_LEN              (-1)                    // use default trace data len from context
  84
  85 #define UNSET_SUBID             (-1)                    // initial value on msg allocation indicating not set
  86 #define UNSET_MSGTYPE   (-1)
  87
  88 // -- header length/offset macros must ensure network conversion ----
  89 #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
  90 #define RMR_TR_LEN(h)           (ntohl(((uta_mhdr_t *)h)->len1))
  91 #define RMR_D1_LEN(h)           (ntohl(((uta_mhdr_t *)h)->len2))
  92 #define RMR_D2_LEN(h)           (ntohl(((uta_mhdr_t *)h)->len3))
  93
  94 // CAUTION:  if using an offset with a header pointer, the pointer MUST be cast to void* before adding the offset!
  95 #define TRACE_OFFSET(h)         ((ntohl(((uta_mhdr_t *)h)->len0)))
  96 #define DATA1_OFFSET(h)         (ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1))
  97 #define DATA2_OFFSET(h)         (ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2))
  98 #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))
  99
 100 #define TRACE_ADDR(h)           (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0))
 101 #define DATA1_ADDR(h)           (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1))
 102 #define DATA2_ADDR(h)           (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2))
 103 #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))
 104
 105 #define SET_HDR_LEN(h)          (((uta_mhdr_t *)h)->len0=htonl((int32_t)sizeof(uta_mhdr_t)))            // convert to network byte order on insert
 106 #define SET_HDR_TR_LEN(h,l)     (((uta_mhdr_t *)h)->len1=htonl((int32_t)l))
 107 #define SET_HDR_D1_LEN(h,l)     (((uta_mhdr_t *)h)->len2=htonl((int32_t)l))
 108 #define SET_HDR_D2_LEN(h,l)     (((uta_mhdr_t *)h)->len3=htonl((int32_t)l))
 109
 110 #define HDR_VERSION(h)  htonl((((uta_mhdr_t *)h)->rmr_ver))
 111
 112                                                         // index of things in the d1 data space
 113 #define D1_CALLID_IDX   0       // the call-id to match on return
 114
 115 #define NO_CALL_ID              0       // no call id associated with the message (normal queue)
 116
 117 #define V1_PAYLOAD_OFFSET(h)    (sizeof(uta_v1mhdr_t))
 118
 119                                                                                 // v2 header flags
 120 #define HFL_HAS_TRACE   0x01                    // Trace data is populated
 121 #define HFL_SUBID               0x02                    // subscription ID is populated
 122 #define HFL_CALL_MSG    0x04                    // msg sent via blocking call
 123
 124 /*
 125         Message header; interpreted by the other side, but never seen by
 126         the user application.
 127
 128         DANGER: Add new fields AT THE END of the struct. Adding them any where else
 129                         will break any code that is currently running.
 130
 131         The transport layer buffer allocated will be divided this way:
 132                 | RMr header | Trace data | data1 | data2 | User paylaod |
 133
 134                 Len 0 is the length of the RMr header
 135                 Len 1 is the length of the trace data
 136                 Len 2 and 3 are lengths of data1 and data2 and are unused at the moment
 137
 138         To point at the payload, we take the address of the header and add all 4 lengths.
 139 */
 140 typedef struct {
 141         int32_t mtype;                                          // message type  ("long" network integer)
 142         int32_t plen;                                           // payload length
 143         int32_t rmr_ver;                                        // our internal message version number
 144         unsigned char xid[RMR_MAX_XID];         // space for user transaction id or somesuch
 145         unsigned char sid[RMR_MAX_SID];         // sender ID for return to sender needs
 146         unsigned char src[RMR_MAX_SRC];         // name:port of the sender (source)
 147         unsigned char meid[RMR_MAX_MEID];       // managed element id.
 148         struct timespec ts;                                     // timestamp ???
 149
 150                                                                                 // V2 extension
 151         int32_t flags;                                          // HFL_* constants
 152         int32_t len0;                                           // length of the RMr header data
 153         int32_t len1;                                           // length of the tracing data
 154         int32_t len2;                                           // length of data 1 (d1)
 155         int32_t len3;                                           // length of data 2 (d2)
 156         int32_t sub_id;                                         // subscription id (-1 invalid)
 157
 158                                                                                 // v3 extension
 159         unsigned char srcip[RMR_MAX_SRC];       // ip address and port of the source
 160 } uta_mhdr_t;
 161
 162
 163 typedef struct {                                                // old (inflexible) v1 header
 164         int32_t mtype;                                          // message type  ("long" network integer)
 165         int32_t plen;                                           // payload length
 166         int32_t rmr_ver;                                        // our internal message version number
 167         unsigned char xid[RMR_MAX_XID];         // space for user transaction id or somesuch
 168         unsigned char sid[RMR_MAX_SID];         // misc sender info/data
 169         unsigned char src[16];                          // name of the sender (source) (old size was 16)
 170         unsigned char meid[RMR_MAX_MEID];       // managed element id.
 171         struct timespec ts;                                     // timestamp ???
 172 } uta_v1mhdr_t;
 173
 174 /*
 175         Round robin group.
 176 */
 177 typedef struct {
 178         uint16_t        ep_idx;         // next endpoint to send to
 179         int nused;                              // number of endpoints in the list
 180         int nendpts;                    // number allocated
 181         endpoint_t **epts;              // the list of endpoints that we RR over
 182 } rrgroup_t;
 183
 184 /*
 185         Routing table entry. This is a list of endpoints that can be sent
 186         messages of the given mtype.  If there is more than one, we will
 187         round robin messags across the list.
 188 */
 189 typedef struct {
 190         uint64_t key;                   // key used to reinsert this entry into a new symtab
 191         int     refs;                           // number of symtabs which reference the entry
 192         int mtype;                              // the message type for this list
 193         int     nrrgroups;                      // number of rr groups to send to
 194         rrgroup_t**     rrgroups;       // one or more set of endpoints to round robin messages to
 195 } rtable_ent_t;
 196
 197 /*
 198         The route table.
 199 */
 200 typedef struct {
 201         void*   hash;                   // hash table.
 202         int             updates;                // counter of update records received
 203 } route_table_t;
 204
 205 /*
 206         A wormhole is a direct connection between two endpoints that the user app can
 207         send to without message type based routing.
 208 */
 209 typedef struct {
 210         int     nalloc;                         // number of ep pointers allocated
 211         endpoint_t** eps;               // end points directly referenced
 212 } wh_mgt_t;
 213
 214
 215 /*
 216         This manages an array of pointers to IP addresses that are associated with one of our interfaces.
 217         For now, we don't need to map the addr to a specific interface, just know that it is one of ours.
 218 */
 219 typedef struct {
 220         char**  addrs;                  // all ip addresses we found
 221         int             naddrs;                 // num actually used
 222 } if_addrs_t;
 223
 224
 225 // --------------- ring things  -------------------------------------------------
 226 typedef struct ring {
 227         uint16_t head;                          // index of the head of the ring (insert point)
 228         uint16_t tail;                          // index of the tail (extract point)
 229         uint16_t nelements;                     // number of elements in the ring
 230         void**  data;                           // the ring data (pointers to blobs of stuff)
 231 } ring_t;
 232
 233
 234 // --------- multi-threaded call things -----------------------------------------
 235 /*
 236         A chute provides a return path for a received message that a thread has blocked
 237         on.  The receive thread will set the mbuf pointer and tickler the barrier to
 238         signal to the call thread that data is ready.
 239 */
 240 typedef struct chute {
 241         rmr_mbuf_t*     mbuf;                                           // pointer to message buffer received
 242         sem_t   barrier;                                                // semaphore that the thread is waiting on
 243         unsigned char   expect[RMR_MAX_XID];    // the expected transaction ID
 244 } chute_t;
 245
 246
 247 // -------------- common static prototypes --------------------------------------
 248
 249 //---- tools ----------------------------------
 250 static int has_myip( char const* buf, if_addrs_t* list, char sep, int max );
 251 static int uta_tokenise( char* buf, char** tokens, int max, char sep );
 252 static int uta_rmip_tokenise( char* buf, if_addrs_t* iplist, char** toks, int max, char sep );
 253 static char* uta_h2ip( char const* hname );
 254 static int uta_lookup_rtg( uta_ctx_t* ctx );
 255 static int uta_has_str( char const* buf, char const* str, char sep, int max );
 256 static char* get_default_ip( if_addrs_t* iplist );
 257
 258 // --- message ring --------------------------
 259 static void* uta_mk_ring( int size );
 260 static void uta_ring_free( void* vr );
 261 static inline void* uta_ring_extract( void* vr );
 262 static inline int uta_ring_insert( void* vr, void* new_data );
 263
 264 // --- message and context management --------
 265 static int ie_test( void* r, int i_factor, long inserts );
 266
 267
 268 // ----- route table generic static things ---------
 269 static inline uint64_t build_rt_key( int32_t sub_id, int32_t mtype );
 270 static void collect_things( void* st, void* entry, char const* name, void* thing, void* vthing_list );
 271 static void del_rte( void* st, void* entry, char const* name, void* thing, void* data );
 272 static char* uta_fib( char* fname );
 273 static route_table_t* uta_rt_init( );
 274 static route_table_t* uta_rt_clone( route_table_t* srt );
 275 static route_table_t* uta_rt_clone_all( route_table_t* srt );
 276 static void uta_rt_drop( route_table_t* rt );
 277 static endpoint_t*  uta_add_ep( route_table_t* rt, rtable_ent_t* rte, char* ep_name, int group  );
 278 static rtable_ent_t* uta_add_rte( route_table_t* rt, uint64_t key, int nrrgroups );
 279 static endpoint_t* uta_get_ep( route_table_t* rt, char const* ep_name );
 280 static void read_static_rt( uta_ctx_t* ctx, int vlevel );
 281 static void parse_rt_rec( uta_ctx_t* ctx, char* buf, int vlevel );
 282 static rmr_mbuf_t* realloc_msg( rmr_mbuf_t* msg, int size );
 283 static void* rtc( void* vctx );
 284 static endpoint_t* rt_ensure_ep( route_table_t* rt, char const* ep_name );
 285
 286 #endif