src/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     1                       // potental to treat messages differently if from backlevel version
  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
  56 #define NO_FLAGS        0                               // no flags to pass to a function
  57
  58 #define FL_NOTHREAD     0x01                    // do not start an additional thread (must be 'user land' to support rtg
  59 #define UFL_MASK                0xff            // mask applied to some flag parms passed by the user to remove any internal flags
  60                                                                         // internal flags, must be > than UFLAG_MASK
  61 //#define IFL_....
  62
  63                                                                         // msg buffer flags
  64 #define MFL_ZEROCOPY    0x01            // the message is an allocated zero copy message and can be sent.
  65 #define MFL_NOALLOC             0x02            // send should NOT allocate a new buffer before returning
  66 #define MFL_ADDSRC              0x04            // source must be added on send
  67 #define MFL_RAW                 0x08            // message is 'raw' and not from an RMr based sender (no header)
  68
  69 #define MAX_EP_GROUP    32                      // max number of endpoints in a group
  70 #define MAX_RTG_MSG_SZ  2048            // max expected message size from route generator
  71
  72 //#define DEF_RTG_MSGID ""                              // default to pick up all messages from rtg
  73 #define DEF_RTG_PORT    "tcp:4561"              // default port that we accept rtg connections on
  74 #define DEF_COMM_PORT   "tcp:4560"              // default port we use for normal communications
  75
  76 /*
  77         Message header; interpreted by the other side, but never seen by
  78         the user application.
  79
  80         DANGER: Add new fields AT THE END of the struct. Adding them any where else
  81                         will break any code that is currently running.
  82 */
  83 typedef struct {
  84         int32_t mtype;                                          // message type  ("long" network integer)
  85         int32_t plen;                                           // payload length
  86         int32_t rmr_ver;                                        // our internal message version number
  87         unsigned char xid[RMR_MAX_XID];         // space for user transaction id or somesuch
  88         unsigned char sid[RMR_MAX_SID];         // sender ID for return to sender needs
  89         unsigned char src[RMR_MAX_SRC];         // name of the sender (source)
  90         unsigned char meid[RMR_MAX_MEID];       // managed element id.
  91         struct timespec ts;                                     // timestamp ???
  92 } uta_mhdr_t;
  93
  94 /*
  95         Round robin group.
  96 */
  97 typedef struct {
  98         int     ep_idx;                         // next endpoint to send to
  99         int nused;                              // number of endpoints in the list
 100         int nendpts;                    // number allocated
 101         endpoint_t **epts;              // the list of endpoints that we RR over
 102 } rrgroup_t;
 103
 104 /*
 105         Routing table entry. This is a list of endpoints that can be sent
 106         messages of the given mtype.  If there is more than one, we will
 107         round robin messags across the list.
 108 */
 109 typedef struct {
 110         int mtype;                              // the message type for this list
 111         int     nrrgroups;                      // number of rr groups to send to
 112         rrgroup_t**     rrgroups;       // one or more set of endpoints to round robin messages to
 113 } rtable_ent_t;
 114
 115 /*
 116         The route table.
 117 */
 118 typedef struct {
 119         void*   hash;                   // hash table.
 120 } route_table_t;
 121
 122 /*
 123         A wormhole is a direct connection between two endpoints that the user app can
 124         send to without message type based routing.
 125 */
 126 typedef struct {
 127         int     nalloc;                         // number of ep pointers allocated
 128         endpoint_t** eps;               // end points directly referenced
 129 } wh_mgt_t;
 130
 131
 132 /*
 133         This manages an array of pointers to IP addresses that are associated with one of our interfaces.
 134         For now, we don't need to map the addr to a specific interface, just know that it is one of ours.
 135 */
 136 typedef struct {
 137         char**  addrs;                  // all ip addresses we found
 138         int             naddrs;                 // num actually used
 139 } if_addrs_t;
 140
 141
 142
 143 // --------------- ring things  -------------------------------------------------
 144 typedef struct ring {
 145         uint16_t head;                          // index of the head of the ring (insert point)
 146         uint16_t tail;                          // index of the tail (extract point)
 147         uint16_t nelements;                     // number of elements in the ring
 148         void**  data;                           // the ring data (pointers to blobs of stuff)
 149 } ring_t;
 150
 151
 152
 153 // -------------- common static prototypes --------------------------------------
 154
 155 //---- tools ----------------------------------
 156 static int has_myip( char const* buf, if_addrs_t* list, char sep, int max );
 157 static int uta_tokenise( char* buf, char** tokens, int max, char sep );
 158 static char* uta_h2ip( char const* hname );
 159 static int uta_lookup_rtg( uta_ctx_t* ctx );
 160 static int uta_has_str( char const* buf, char const* str, char sep, int max );
 161
 162 // --- message ring --------------------------
 163 static void* uta_mk_ring( int size );
 164 static void uta_ring_free( void* vr );
 165 static inline void* uta_ring_extract( void* vr );
 166 static inline int uta_ring_insert( void* vr, void* new_data );
 167
 168 // --- message and context management --------
 169 static int ie_test( void* r, int i_factor, long inserts );
 170
 171
 172 // ----- route table generic static things ---------
 173 static void collect_things( void* st, void* entry, char const* name, void* thing, void* vthing_list );
 174 static void del_rte( void* st, void* entry, char const* name, void* thing, void* data );
 175 static char* uta_fib( char* fname );
 176 static route_table_t* uta_rt_init( );
 177 static route_table_t* uta_rt_clone( route_table_t* srt );
 178 static void uta_rt_drop( route_table_t* rt );
 179 static endpoint_t*  uta_add_ep( route_table_t* rt, rtable_ent_t* rte, char* ep_name, int group  );
 180 static rtable_ent_t* uta_add_rte( route_table_t* rt, int mtype, int nrrgroups );
 181 static endpoint_t* uta_get_ep( route_table_t* rt, char const* ep_name );
 182 static void read_static_rt( uta_ctx_t* ctx, int vlevel );
 183 static void parse_rt_rec( uta_ctx_t* ctx, char* buf, int vlevel );
 184 static void* rtc( void* vctx );
 185 static endpoint_t* rt_ensure_ep( route_table_t* rt, char const* ep_name );
 186
 187 #endif