Fix potential race in route table load

[ric-plt/lib/rmr.git] / src / rmr / common / include / rmr_agnostic.h

diff --git a/src/rmr/common/include/rmr_agnostic.h b/src/rmr/common/include/rmr_agnostic.h
index 27e1de8..f7eb324 100644 (file)
--- a/src/rmr/common/include/rmr_agnostic.h
+++ b/src/rmr/common/include/rmr_agnostic.h
@@ -30,6 +30,7 @@
 #define _rmr_agnostic_h
 
 #include <semaphore.h>                                 // needed to support some structs
+#include <pthread.h>
 
 typedef struct endpoint endpoint_t;            // place holder for structs defined in nano/nng private.h
 typedef struct uta_ctx  uta_ctx_t;
@@ -68,6 +69,7 @@ typedef struct uta_ctx  uta_ctx_t;
 #define ENV_LOG_HR             "RMR_HR_LOG"            // set to 0 to turn off human readable logging and write using some formatting
 #define ENV_LOG_VLEVEL "RMR_LOG_VLEVEL"        // set the verbosity level (0 == 0ff; 1 == crit .... 5 == debug )
 #define ENV_CTL_PORT   "RMR_CTL_PORT"          // route collector will listen here for control messages (4561 default)
+#define ENV_RTREQ_FREA  "RMR_RTREQ_FREQ"       // frequency we will request route table updates when we want one (1-300 inclusive)
 
 #define NO_FLAGS       0                               // no flags to pass to a function
 
@@ -99,6 +101,7 @@ typedef struct uta_ctx  uta_ctx_t;
 #define DEF_COMM_PORT  "tcp:4560"              // default port we use for normal communications
 #define DEF_RTG_WK_ADDR        "routemgr:4561" // well known address for the route manager
 #define DEF_TR_LEN             (-1)                    // use default trace data len from context
+#define DEF_RTREQ_FREQ 5                               // delay between route table requests
 
 #define UNSET_SUBID            (-1)                    // initial value on msg allocation indicating not set
 #define UNSET_MSGTYPE  (-1)
@@ -222,9 +225,12 @@ typedef struct {
        The route table.
 */
 typedef struct {
-       void*   hash;                   // hash table.
+       void*   hash;                   // hash table for msg type and meid.
+       void*   ephash;                 // hash for endpoint references
        int             updates;                // counter of update records received
        int             mupdates;               // counter of meid update records received
+       int             ref_count;              // num threads currently using
+       pthread_mutex_t*        gate;   // lock allowing update to ref counter
 } route_table_t;
 
 /*
@@ -283,7 +289,10 @@ static int has_myip( char const* buf, if_addrs_t* list, char sep, int max );
 static int uta_tokenise( char* buf, char** tokens, int max, char sep );
 static int uta_rmip_tokenise( char* buf, if_addrs_t* iplist, char** toks, int max, char sep );
 static char* uta_h2ip( char const* hname );
+#ifdef RTG_PUB
+// deprecated funciton -- step 1 of removal
 static int uta_lookup_rtg( uta_ctx_t* ctx );
+#endif
 static int uta_has_str( char const* buf, char const* str, char sep, int max );
 static char* get_default_ip( if_addrs_t* iplist );
 
@@ -302,18 +311,20 @@ static int ie_test( void* r, int i_factor, long inserts );
 static inline uint64_t build_rt_key( int32_t sub_id, int32_t mtype );
 static void collect_things( void* st, void* entry, char const* name, void* thing, void* vthing_list );
 static void del_rte( void* st, void* entry, char const* name, void* thing, void* data );
-static endpoint_t*  get_meid_owner( route_table_t *rt, char* meid );
-static char* uta_fib( char* fname );
-static route_table_t* uta_rt_init( );
-static route_table_t* uta_rt_clone( route_table_t* srt );
-static route_table_t* uta_rt_clone_all( route_table_t* srt );
+static endpoint_t*  get_meid_owner( route_table_t *rt, char const* meid );
+static char* uta_fib( char const* fname );
+static route_table_t* uta_rt_init( uta_ctx_t* ctx  );
+static route_table_t* uta_rt_clone( uta_ctx_t* ctx, route_table_t* srt, route_table_t* drt, int all );
 static void uta_rt_drop( route_table_t* rt );
+static inline route_table_t* get_rt( uta_ctx_t* ctx );
 static endpoint_t*  uta_add_ep( route_table_t* rt, rtable_ent_t* rte, char* ep_name, int group  );
 static rtable_ent_t* uta_add_rte( route_table_t* rt, uint64_t key, int nrrgroups );
 static endpoint_t* uta_get_ep( route_table_t* rt, char const* ep_name );
 static void read_static_rt( uta_ctx_t* ctx, int vlevel );
+static route_table_t* prep_new_rt( uta_ctx_t* ctx, int all );
 static void parse_rt_rec( uta_ctx_t* ctx,  uta_ctx_t* pctx, char* buf, int vlevel, rmr_mbuf_t* mbuf );
 static rmr_mbuf_t* realloc_msg( rmr_mbuf_t* msg, int size );
+static void release_rt( uta_ctx_t* ctx, route_table_t* rt );
 static void* rtc( void* vctx );
 static endpoint_t* rt_ensure_ep( route_table_t* rt, char const* ep_name );