ipsec: IPSec protection for multi-point tunnel interfaces
[vpp.git] / src / vlibmemory / memory_shared.c
index 084d0b7..1716f27 100644 (file)
 #include <vppinfra/format.h>
 #include <vppinfra/byte_order.h>
 #include <vppinfra/error.h>
+#include <vppinfra/elog.h>
 #include <svm/queue.h>
 #include <vlib/vlib.h>
 #include <vlib/unix/unix.h>
 #include <vlibmemory/memory_api.h>
 #include <vlibmemory/vl_memory_msg_enum.h>
+#include <vlibapi/api_common.h>
 
 #define vl_typedefs
 #include <vlibmemory/vl_memory_api_h.h>
@@ -41,8 +43,9 @@
 
 #define DEBUG_MESSAGE_BUFFER_OVERRUN 0
 
-static inline void *
-vl_msg_api_alloc_internal (int nbytes, int pool, int may_return_null)
+CLIB_NOSANITIZE_ADDR static inline void *
+vl_msg_api_alloc_internal (svm_region_t * vlib_rp, int nbytes, int pool,
+                          int may_return_null)
 {
   int i;
   msgbuf_t *rv;
@@ -50,9 +53,9 @@ vl_msg_api_alloc_internal (int nbytes, int pool, int may_return_null)
   svm_queue_t *q;
   void *oldheap;
   vl_shmem_hdr_t *shmem_hdr;
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
 
-  shmem_hdr = am->shmem_hdr;
+  shmem_hdr = (void *) vlib_rp->user_ctx;
 
 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
   nbytes += 4;
@@ -119,9 +122,9 @@ vl_msg_api_alloc_internal (int nbytes, int pool, int may_return_null)
                         q->head);
                      msg_idp = (u16 *) (rv->data);
                      msg_id = clib_net_to_host_u16 (*msg_idp);
-                     if (msg_id < vec_len (api_main.msg_names))
+                     if (msg_id < vec_len (vlibapi_get_main ()->msg_names))
                        clib_warning ("msg id %d name %s", (u32) msg_id,
-                                     api_main.msg_names[msg_id]);
+                                     vlibapi_get_main ()->msg_names[msg_id]);
                    }
                  shmem_hdr->garbage_collects++;
                  goto collected;
@@ -160,15 +163,13 @@ vl_msg_api_alloc_internal (int nbytes, int pool, int may_return_null)
    */
   am->ring_misses++;
 
-  pthread_mutex_lock (&am->vlib_rp->mutex);
-  oldheap = svm_push_data_heap (am->vlib_rp);
+  oldheap = vl_msg_push_heap_w_region (vlib_rp);
   if (may_return_null)
     {
       rv = clib_mem_alloc_or_null (nbytes);
       if (PREDICT_FALSE (rv == 0))
        {
-         svm_pop_heap (oldheap);
-         pthread_mutex_unlock (&am->vlib_rp->mutex);
+         vl_msg_pop_heap_w_region (vlib_rp, oldheap);
          return 0;
        }
     }
@@ -176,8 +177,8 @@ vl_msg_api_alloc_internal (int nbytes, int pool, int may_return_null)
     rv = clib_mem_alloc (nbytes);
 
   rv->q = 0;
-  svm_pop_heap (oldheap);
-  pthread_mutex_unlock (&am->vlib_rp->mutex);
+  rv->gc_mark_timestamp = 0;
+  vl_msg_pop_heap_w_region (vlib_rp, oldheap);
 
 out:
 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
@@ -190,6 +191,7 @@ out:
 #endif
   rv->data_len = htonl (nbytes - sizeof (msgbuf_t));
 
+  VL_MSG_API_UNPOISON (rv->data);
   return (rv->data);
 }
 
@@ -197,64 +199,77 @@ void *
 vl_msg_api_alloc (int nbytes)
 {
   int pool;
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
   vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
 
   /*
    * Clients use pool-0, vlib proc uses pool 1
    */
   pool = (am->our_pid == shmem_hdr->vl_pid);
-  return vl_msg_api_alloc_internal (nbytes, pool, 0 /* may_return_null */ );
+  return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, pool,
+                                   0 /* may_return_null */ );
+}
+
+void *
+vl_msg_api_alloc_zero (int nbytes)
+{
+  void *ret;
+
+  ret = vl_msg_api_alloc (nbytes);
+  clib_memset (ret, 0, nbytes);
+  return ret;
 }
 
 void *
 vl_msg_api_alloc_or_null (int nbytes)
 {
   int pool;
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
   vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
 
   pool = (am->our_pid == shmem_hdr->vl_pid);
-  return vl_msg_api_alloc_internal (nbytes, pool, 1 /* may_return_null */ );
+  return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, pool,
+                                   1 /* may_return_null */ );
 }
 
 void *
 vl_msg_api_alloc_as_if_client (int nbytes)
 {
-  return vl_msg_api_alloc_internal (nbytes, 0, 0 /* may_return_null */ );
+  api_main_t *am = vlibapi_get_main ();
+  return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, 0,
+                                   0 /* may_return_null */ );
+}
+
+void *
+vl_msg_api_alloc_zero_as_if_client (int nbytes)
+{
+  void *ret;
+
+  ret = vl_msg_api_alloc_as_if_client (nbytes);
+  clib_memset (ret, 0, nbytes);
+  return ret;
 }
 
 void *
 vl_msg_api_alloc_as_if_client_or_null (int nbytes)
 {
-  return vl_msg_api_alloc_internal (nbytes, 0, 1 /* may_return_null */ );
+  api_main_t *am = vlibapi_get_main ();
+  return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, 0,
+                                   1 /* may_return_null */ );
 }
 
 void *
 vl_mem_api_alloc_as_if_client_w_reg (vl_api_registration_t * reg, int nbytes)
 {
-  api_main_t *am = &api_main;
-  vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
-  svm_region_t *vlib_rp, *save_vlib_rp = am->vlib_rp;
-  void *msg;
-
-  vlib_rp = am->vlib_rp = reg->vlib_rp;
-  am->shmem_hdr = (void *) vlib_rp->user_ctx;
-
-  msg = vl_msg_api_alloc_internal (nbytes, 0, 0 /* may_return_null */ );
-
-  am->shmem_hdr = save_shmem_hdr;
-  am->vlib_rp = save_vlib_rp;
-
-  return msg;
+  return vl_msg_api_alloc_internal (reg->vlib_rp, nbytes, 0,
+                                   0 /* may_return_null */ );
 }
 
 void
-vl_msg_api_free (void *a)
+vl_msg_api_free_w_region (svm_region_t * vlib_rp, void *a)
 {
   msgbuf_t *rv;
   void *oldheap;
-  api_main_t *am = &api_main;
 
   rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
 
@@ -274,11 +289,11 @@ vl_msg_api_free (void *a)
        ASSERT (*overrun == 0x1badbabe);
       }
 #endif
+      VL_MSG_API_POISON (rv->data);
       return;
     }
 
-  pthread_mutex_lock (&am->vlib_rp->mutex);
-  oldheap = svm_push_data_heap (am->vlib_rp);
+  oldheap = vl_msg_push_heap_w_region (vlib_rp);
 
 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
   {
@@ -289,8 +304,14 @@ vl_msg_api_free (void *a)
 #endif
 
   clib_mem_free (rv);
-  svm_pop_heap (oldheap);
-  pthread_mutex_unlock (&am->vlib_rp->mutex);
+  vl_msg_pop_heap_w_region (vlib_rp, oldheap);
+}
+
+void
+vl_msg_api_free (void *a)
+{
+  api_main_t *am = vlibapi_get_main ();
+  vl_msg_api_free_w_region (am->vlib_rp, a);
 }
 
 static void
@@ -298,7 +319,7 @@ vl_msg_api_free_nolock (void *a)
 {
   msgbuf_t *rv;
   void *oldheap;
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
 
   rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
   /*
@@ -309,6 +330,7 @@ vl_msg_api_free_nolock (void *a)
   if (rv->q)
     {
       rv->q = 0;
+      VL_MSG_API_POISON (rv->data);
       return;
     }
 
@@ -320,7 +342,7 @@ vl_msg_api_free_nolock (void *a)
 void
 vl_set_memory_root_path (const char *name)
 {
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
 
   am->root_path = name;
 }
@@ -328,7 +350,7 @@ vl_set_memory_root_path (const char *name)
 void
 vl_set_memory_uid (int uid)
 {
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
 
   am->api_uid = uid;
 }
@@ -336,7 +358,7 @@ vl_set_memory_uid (int uid)
 void
 vl_set_memory_gid (int gid)
 {
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
 
   am->api_gid = gid;
 }
@@ -344,7 +366,7 @@ vl_set_memory_gid (int gid)
 void
 vl_set_global_memory_baseva (u64 baseva)
 {
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
 
   am->global_baseva = baseva;
 }
@@ -352,7 +374,7 @@ vl_set_global_memory_baseva (u64 baseva)
 void
 vl_set_global_memory_size (u64 size)
 {
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
 
   am->global_size = size;
 }
@@ -360,7 +382,7 @@ vl_set_global_memory_size (u64 size)
 void
 vl_set_api_memory_size (u64 size)
 {
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
 
   am->api_size = size;
 }
@@ -368,7 +390,7 @@ vl_set_api_memory_size (u64 size)
 void
 vl_set_global_pvt_heap_size (u64 size)
 {
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
 
   am->global_pvt_heap_size = size;
 }
@@ -376,7 +398,7 @@ vl_set_global_pvt_heap_size (u64 size)
 void
 vl_set_api_pvt_heap_size (u64 size)
 {
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
 
   am->api_pvt_heap_size = size;
 }
@@ -384,7 +406,7 @@ vl_set_api_pvt_heap_size (u64 size)
 static void
 vl_api_default_mem_config (vl_shmem_hdr_t * shmem_hdr)
 {
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
   u32 vlib_input_queue_length;
 
   /* vlib main input queue */
@@ -470,7 +492,7 @@ void
 vl_init_shmem (svm_region_t * vlib_rp, vl_api_shm_elem_config_t * config,
               int is_vlib, int is_private_region)
 {
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
   vl_shmem_hdr_t *shmem_hdr = 0;
   void *oldheap;
   ASSERT (vlib_rp);
@@ -513,12 +535,12 @@ vl_map_shmem (const char *region_name, int is_vlib)
 {
   svm_map_region_args_t _a, *a = &_a;
   svm_region_t *vlib_rp, *root_rp;
-  api_main_t *am = &api_main;
-  int i, rv;
+  api_main_t *am = vlibapi_get_main ();
+  int i;
   struct timespec ts, tsrem;
   char *vpe_api_region_suffix = "-vpe-api";
 
-  memset (a, 0, sizeof (*a));
+  clib_memset (a, 0, sizeof (*a));
 
   if (strstr (region_name, vpe_api_region_suffix))
     {
@@ -532,9 +554,36 @@ vl_map_shmem (const char *region_name, int is_vlib)
 
   if (is_vlib == 0)
     {
-      rv = svm_region_init_chroot (am->root_path);
-      if (rv)
-       return rv;
+      int tfd;
+      u8 *api_name;
+      /*
+       * Clients wait for vpp to set up the root / API regioins
+       */
+      if (am->root_path)
+       api_name = format (0, "/dev/shm/%s-%s%c", am->root_path,
+                          region_name + 1, 0);
+      else
+       api_name = format (0, "/dev/shm%s%c", region_name, 0);
+
+      /* Wait up to 100 seconds... */
+      for (i = 0; i < 10000; i++)
+       {
+         ts.tv_sec = 0;
+         ts.tv_nsec = 10000 * 1000;    /* 10 ms */
+         while (nanosleep (&ts, &tsrem) < 0)
+           ts = tsrem;
+         tfd = open ((char *) api_name, O_RDWR);
+         if (tfd >= 0)
+           break;
+       }
+      vec_free (api_name);
+      if (tfd < 0)
+       {
+         clib_warning ("region init fail");
+         return -2;
+       }
+      close (tfd);
+      svm_region_init_chroot_uid_gid (am->root_path, getuid (), getgid ());
     }
 
   if (a->root_path != NULL)
@@ -590,7 +639,7 @@ vl_map_shmem (const char *region_name, int is_vlib)
                ts = tsrem;
            }
          /* Mutex buggered, "fix" it */
-         memset (&q->mutex, 0, sizeof (q->mutex));
+         clib_memset (&q->mutex, 0, sizeof (q->mutex));
          clib_warning ("forcibly release main input queue mutex");
 
        mutex_ok:
@@ -656,7 +705,7 @@ vl_map_shmem (const char *region_name, int is_vlib)
 void
 vl_register_mapped_shmem_region (svm_region_t * rp)
 {
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
 
   vec_add1 (am->mapped_shmem_regions, rp);
 }
@@ -666,7 +715,7 @@ vl_unmap_shmem_internal (u8 is_client)
 {
   svm_region_t *rp;
   int i;
-  api_main_t *am = &api_main;
+  api_main_t *am = vlibapi_get_main ();
 
   if (!svm_get_root_rp ())
     return;
@@ -703,12 +752,41 @@ vl_unmap_shmem_client (void)
 void
 vl_msg_api_send_shmem (svm_queue_t * q, u8 * elem)
 {
-  api_main_t *am = &api_main;
-  uword *trace = (uword *) elem;
+  api_main_t *am = vlibapi_get_main ();
+  void *msg = (void *) *(uword *) elem;
 
   if (am->tx_trace && am->tx_trace->enabled)
-    vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
+    vl_msg_api_trace (am, am->tx_trace, msg);
 
+  /*
+   * Announce a probable binary API client bug:
+   * some client's input queue is stuffed.
+   * The situation may be recoverable, or not.
+   */
+  if (PREDICT_FALSE
+      (am->vl_clients /* vpp side */  && (q->cursize == q->maxsize)))
+    {
+      if (PREDICT_FALSE (am->elog_trace_api_messages))
+       {
+          /* *INDENT-OFF* */
+          ELOG_TYPE_DECLARE (e) =
+            {
+              .format = "api-client-queue-stuffed: %x%x",
+              .format_args = "i4i4",
+            };
+          /* *INDENT-ON* */
+         struct
+         {
+           u32 hi, low;
+         } *ed;
+         ed = ELOG_DATA (am->elog_main, e);
+         ed->hi = (uword) q >> 32;
+         ed->low = (uword) q & 0xFFFFFFFF;
+         clib_warning ("WARNING: client input queue at %llx is stuffed...",
+                       q);
+       }
+    }
+  VL_MSG_API_POISON (msg);
   (void) svm_queue_add (q, elem, 0 /* nowait */ );
 }
 
@@ -721,13 +799,14 @@ vl_mem_api_can_send (svm_queue_t * q)
 void
 vl_msg_api_send_shmem_nolock (svm_queue_t * q, u8 * elem)
 {
-  api_main_t *am = &api_main;
-  uword *trace = (uword *) elem;
+  api_main_t *am = vlibapi_get_main ();
+  void *msg = (void *) *(uword *) elem;
 
   if (am->tx_trace && am->tx_trace->enabled)
-    vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
+    vl_msg_api_trace (am, am->tx_trace, msg);
 
   (void) svm_queue_add_nolock (q, elem);
+  VL_MSG_API_POISON (msg);
 }
 
 /*