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     2                       // 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
  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 #define DEF_TR_LEN              (-1)                    // use default trace data len from context
  76
  77 #define UNSET_SUBID             (-1)                    // initial value on msg allocation indicating not set
  78 #define UNSET_MSGTYPE   (-1)
  79
  80 // -- header length/offset macros must ensure network conversion ----
  81 #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
  82 #define RMR_TR_LEN(h)           (ntohl(((uta_mhdr_t *)h)->len1))
  83 #define RMR_D1_LEN(h)           (ntohl(((uta_mhdr_t *)h)->len2))
  84 #define RMR_D2_LEN(h)           (ntohl(((uta_mhdr_t *)h)->len3))
  85
  86 #define TRACE_OFFSET(h)         ((ntohl(((uta_mhdr_t *)h)->len0)))
  87 #define DATA1_OFFSET(h)         (ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1))
  88 #define DATA2_OFFSET(h)         (ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2))
  89 #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))
  90
  91 #define TRACE_ADDR(h)           (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0))
  92 #define DATA1_ADDR(h)           (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1))
  93 #define DATA2_ADDR(h)           (((void *)h)+ntohl(((uta_mhdr_t *)h)->len0)+htonl(((uta_mhdr_t *)h)->len1)+htonl(((uta_mhdr_t *)h)->len2))
  94 #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))
  95
  96 #define SET_HDR_LEN(h)          (((uta_mhdr_t *)h)->len0=htonl((int32_t)sizeof(uta_mhdr_t)))            // convert to network byte order on insert
  97 #define SET_HDR_TR_LEN(h,l)     (((uta_mhdr_t *)h)->len1=htonl((int32_t)l))
  98 #define SET_HDR_D1_LEN(h,l)     (((uta_mhdr_t *)h)->len2=htonl((int32_t)l))
  99 #define SET_HDR_D2_LEN(h,l)     (((uta_mhdr_t *)h)->len3=htonl((int32_t)l))
 100
 101
 102 #define V1_PAYLOAD_OFFSET(h)    (sizeof(uta_v1mhdr_t))
 103
 104                                                                                 // v2 header flags
 105 #define HFL_HAS_TRACE   0x01                    // Trace data is populated
 106 #define HFL_SUBID               0x02                    // subscription ID is populated
 107
 108 /*
 109         Message header; interpreted by the other side, but never seen by
 110         the user application.
 111
 112         DANGER: Add new fields AT THE END of the struct. Adding them any where else
 113                         will break any code that is currently running.
 114
 115         The transport layer buffer allocated will be divided this way:
 116                 | RMr header | Trace data | data1 | data2 | User paylaod |
 117
 118                 Len 0 is the length of the RMr header
 119                 Len 1 is the length of the trace data
 120                 Len 2 and 3 are lengths of data1 and data2 and are unused at the moment
 121
 122         To point at the payload, we take the address of the header and add all 4 lengths.
 123 */
 124 typedef struct {
 125         int32_t mtype;                                          // message type  ("long" network integer)
 126         int32_t plen;                                           // payload length
 127         int32_t rmr_ver;                                        // our internal message version number
 128         unsigned char xid[RMR_MAX_XID];         // space for user transaction id or somesuch
 129         unsigned char sid[RMR_MAX_SID];         // sender ID for return to sender needs
 130         unsigned char src[RMR_MAX_SRC];         // name:port of the sender (source)
 131         unsigned char meid[RMR_MAX_MEID];       // managed element id.
 132         struct timespec ts;                                     // timestamp ???
 133
 134                                                                                 // V2 extension
 135         int32_t flags;                                          // HFL_* constants
 136         int32_t len0;                                           // length of the RMr header data
 137         int32_t len1;                                           // length of the tracing data
 138         int32_t len2;                                           // length of data 1 (d1)
 139         int32_t len3;                                           // length of data 2 (d2)
 140         int32_t sub_id;                                         // subscription id (-1 invalid)
 141 } uta_mhdr_t;
 142
 143
 144 typedef struct {                                                // old (inflexible) v1 header
 145         int32_t mtype;                                          // message type  ("long" network integer)
 146         int32_t plen;                                           // payload length
 147         int32_t rmr_ver;                                        // our internal message version number
 148         unsigned char xid[RMR_MAX_XID];         // space for user transaction id or somesuch
 149         unsigned char sid[RMR_MAX_SID];         // sender ID for return to sender needs
 150         unsigned char src[16];                          // name of the sender (source) (old size was 16)
 151         unsigned char meid[RMR_MAX_MEID];       // managed element id.
 152         struct timespec ts;                                     // timestamp ???
 153 } uta_v1mhdr_t;
 154
 155 /*
 156         Round robin group.
 157 */
 158 typedef struct {
 159         int     ep_idx;                         // next endpoint to send to
 160         int nused;                              // number of endpoints in the list
 161         int nendpts;                    // number allocated
 162         endpoint_t **epts;              // the list of endpoints that we RR over
 163 } rrgroup_t;
 164
 165 /*
 166         Routing table entry. This is a list of endpoints that can be sent
 167         messages of the given mtype.  If there is more than one, we will
 168         round robin messags across the list.
 169 */
 170 typedef struct {
 171         int mtype;                              // the message type for this list
 172         int     nrrgroups;                      // number of rr groups to send to
 173         rrgroup_t**     rrgroups;       // one or more set of endpoints to round robin messages to
 174 } rtable_ent_t;
 175
 176 /*
 177         The route table.
 178 */
 179 typedef struct {
 180         void*   hash;                   // hash table.
 181 } route_table_t;
 182
 183 /*
 184         A wormhole is a direct connection between two endpoints that the user app can
 185         send to without message type based routing.
 186 */
 187 typedef struct {
 188         int     nalloc;                         // number of ep pointers allocated
 189         endpoint_t** eps;               // end points directly referenced
 190 } wh_mgt_t;
 191
 192
 193 /*
 194         This manages an array of pointers to IP addresses that are associated with one of our interfaces.
 195         For now, we don't need to map the addr to a specific interface, just know that it is one of ours.
 196 */
 197 typedef struct {
 198         char**  addrs;                  // all ip addresses we found
 199         int             naddrs;                 // num actually used
 200 } if_addrs_t;
 201
 202
 203 // --------------- ring things  -------------------------------------------------
 204 typedef struct ring {
 205         uint16_t head;                          // index of the head of the ring (insert point)
 206         uint16_t tail;                          // index of the tail (extract point)
 207         uint16_t nelements;                     // number of elements in the ring
 208         void**  data;                           // the ring data (pointers to blobs of stuff)
 209 } ring_t;
 210
 211
 212
 213 // -------------- common static prototypes --------------------------------------
 214
 215 //---- tools ----------------------------------
 216 static int has_myip( char const* buf, if_addrs_t* list, char sep, int max );
 217 static int uta_tokenise( char* buf, char** tokens, int max, char sep );
 218 static char* uta_h2ip( char const* hname );
 219 static int uta_lookup_rtg( uta_ctx_t* ctx );
 220 static int uta_has_str( char const* buf, char const* str, char sep, int max );
 221
 222 // --- message ring --------------------------
 223 static void* uta_mk_ring( int size );
 224 static void uta_ring_free( void* vr );
 225 static inline void* uta_ring_extract( void* vr );
 226 static inline int uta_ring_insert( void* vr, void* new_data );
 227
 228 // --- message and context management --------
 229 static int ie_test( void* r, int i_factor, long inserts );
 230
 231
 232 // ----- route table generic static things ---------
 233 static inline uint64_t build_rt_key( int32_t sub_id, int32_t mtype );
 234 static void collect_things( void* st, void* entry, char const* name, void* thing, void* vthing_list );
 235 static void del_rte( void* st, void* entry, char const* name, void* thing, void* data );
 236 static char* uta_fib( char* fname );
 237 static route_table_t* uta_rt_init( );
 238 static route_table_t* uta_rt_clone( route_table_t* srt );
 239 static void uta_rt_drop( route_table_t* rt );
 240 static endpoint_t*  uta_add_ep( route_table_t* rt, rtable_ent_t* rte, char* ep_name, int group  );
 241 static rtable_ent_t* uta_add_rte( route_table_t* rt, uint64_t key, int nrrgroups );
 242 static endpoint_t* uta_get_ep( route_table_t* rt, char const* ep_name );
 243 static void read_static_rt( uta_ctx_t* ctx, int vlevel );
 244 static void parse_rt_rec( uta_ctx_t* ctx, char* buf, int vlevel );
 245 static rmr_mbuf_t* realloc_msg( rmr_mbuf_t* msg, int size );
 246 static void* rtc( void* vctx );
 247 static endpoint_t* rt_ensure_ep( route_table_t* rt, char const* ep_name );
 248
 249 #endif