svm: allow mq attachments at random offsets
[vpp.git] / src / svm / message_queue.c
index a73a56d..0ebce70 100644 (file)
@@ -15,6 +15,7 @@
 
 #include <svm/message_queue.h>
 #include <vppinfra/mem.h>
+#include <vppinfra/format.h>
 #include <sys/eventfd.h>
 
 static inline svm_msg_q_ring_t *
@@ -33,24 +34,47 @@ static inline void *
 svm_msg_q_ring_data (svm_msg_q_ring_t * ring, u32 elt_index)
 {
   ASSERT (elt_index < ring->nitems);
-  return (ring->data + elt_index * ring->elsize);
+  return (ring->shr->data + elt_index * ring->elsize);
 }
 
-svm_msg_q_t *
-svm_msg_q_alloc (svm_msg_q_cfg_t * cfg)
+svm_msg_q_shared_t *
+svm_msg_q_init (void *base, svm_msg_q_cfg_t *cfg)
+{
+  svm_msg_q_ring_shared_t *ring;
+  svm_msg_q_shared_t *smq;
+  u32 q_sz, offset;
+  int i;
+
+  q_sz = sizeof (svm_queue_t) + cfg->q_nitems * sizeof (svm_msg_q_msg_t);
+
+  smq = (svm_msg_q_shared_t *) base;
+  svm_queue_init (&smq->q, cfg->q_nitems, sizeof (svm_msg_q_msg_t));
+  smq->q->consumer_pid = cfg->consumer_pid;
+  smq->n_rings = cfg->n_rings;
+  ring = (void *) ((u8 *) smq->q + q_sz);
+  for (i = 0; i < cfg->n_rings; i++)
+    {
+      ring->elsize = cfg->ring_cfgs[i].elsize;
+      ring->nitems = cfg->ring_cfgs[i].nitems;
+      ring->cursize = ring->head = ring->tail = 0;
+      offset = sizeof (*ring) + ring->nitems * ring->elsize;
+      ring = (void *) ((u8 *) ring + offset);
+    }
+
+  return smq;
+}
+
+uword
+svm_msg_q_size_to_alloc (svm_msg_q_cfg_t *cfg)
 {
   svm_msg_q_ring_cfg_t *ring_cfg;
   uword rings_sz = 0, mq_sz;
-  svm_msg_q_ring_t *ring;
-  u8 *base, *rings_ptr;
-  vec_header_t *vh;
-  u32 vec_sz, q_sz;
-  svm_msg_q_t *mq;
+  u32 q_sz;
   int i;
 
   ASSERT (cfg);
 
-  vec_sz = vec_header_bytes (0) + sizeof (svm_msg_q_ring_t) * cfg->n_rings;
+  rings_sz = sizeof (svm_msg_q_ring_shared_t) * cfg->n_rings;
   for (i = 0; i < cfg->n_rings; i++)
     {
       if (cfg->ring_cfgs[i].data)
@@ -60,35 +84,46 @@ svm_msg_q_alloc (svm_msg_q_cfg_t * cfg)
     }
 
   q_sz = sizeof (svm_queue_t) + cfg->q_nitems * sizeof (svm_msg_q_msg_t);
-  mq_sz = sizeof (svm_msg_q_t) + vec_sz + rings_sz + q_sz;
+  mq_sz = sizeof (svm_msg_q_shared_t) + q_sz + rings_sz;
+
+  return mq_sz;
+}
+
+svm_msg_q_shared_t *
+svm_msg_q_alloc (svm_msg_q_cfg_t *cfg)
+{
+  uword mq_sz;
+  u8 *base;
+
+  mq_sz = svm_msg_q_size_to_alloc (cfg);
   base = clib_mem_alloc_aligned (mq_sz, CLIB_CACHE_LINE_BYTES);
   if (!base)
     return 0;
 
-  mq = (svm_msg_q_t *) base;
-  mq->q = svm_queue_init (base + sizeof (svm_msg_q_t), cfg->q_nitems,
-                         sizeof (svm_msg_q_msg_t));
-  mq->q->consumer_pid = cfg->consumer_pid;
-  vh = (vec_header_t *) ((u8 *) mq->q + q_sz);
-  vh->len = cfg->n_rings;
-  mq->rings = (svm_msg_q_ring_t *) (vh + 1);
-  rings_ptr = (u8 *) mq->rings + vec_sz;
-  for (i = 0; i < cfg->n_rings; i++)
+  return svm_msg_q_init (base, cfg);
+}
+
+void
+svm_msg_q_attach (svm_msg_q_t *mq, void *smq_base)
+{
+  svm_msg_q_ring_shared_t *ring;
+  svm_msg_q_shared_t *smq;
+  u32 i, n_rings, q_sz, offset;
+
+  smq = (svm_msg_q_shared_t *) smq_base;
+  mq->q = smq->q;
+  n_rings = smq->n_rings;
+  vec_validate (mq->rings, n_rings - 1);
+  q_sz = sizeof (svm_queue_t) + mq->q->maxsize * sizeof (svm_msg_q_msg_t);
+  ring = (void *) ((u8 *) smq->q + q_sz);
+  for (i = 0; i < n_rings; i++)
     {
-      ring = &mq->rings[i];
-      ring->elsize = cfg->ring_cfgs[i].elsize;
-      ring->nitems = cfg->ring_cfgs[i].nitems;
-      ring->cursize = ring->head = ring->tail = 0;
-      if (cfg->ring_cfgs[i].data)
-       ring->data = cfg->ring_cfgs[i].data;
-      else
-       {
-         ring->data = rings_ptr;
-         rings_ptr += (uword) ring->nitems * ring->elsize;
-       }
+      mq->rings[i].nitems = ring->nitems;
+      mq->rings[i].elsize = ring->elsize;
+      mq->rings[i].shr = ring;
+      offset = sizeof (*ring) + ring->nitems * ring->elsize;
+      ring = (void *) ((u8 *) ring + offset);
     }
-
-  return mq;
 }
 
 void
@@ -101,14 +136,18 @@ svm_msg_q_free (svm_msg_q_t * mq)
 svm_msg_q_msg_t
 svm_msg_q_alloc_msg_w_ring (svm_msg_q_t * mq, u32 ring_index)
 {
+  svm_msg_q_ring_shared_t *sr;
+  svm_msg_q_ring_t *ring;
   svm_msg_q_msg_t msg;
-  svm_msg_q_ring_t *ring = svm_msg_q_ring_inline (mq, ring_index);
 
-  ASSERT (ring->cursize < ring->nitems);
+  ring = svm_msg_q_ring_inline (mq, ring_index);
+  sr = ring->shr;
+
+  ASSERT (sr->cursize < ring->nitems);
   msg.ring_index = ring - mq->rings;
-  msg.elt_index = ring->tail;
-  ring->tail = (ring->tail + 1) % ring->nitems;
-  __sync_fetch_and_add (&ring->cursize, 1);
+  msg.elt_index = sr->tail;
+  sr->tail = (sr->tail + 1) % ring->nitems;
+  clib_atomic_fetch_add (&sr->cursize, 1);
   return msg;
 }
 
@@ -120,22 +159,19 @@ svm_msg_q_lock_and_alloc_msg_w_ring (svm_msg_q_t * mq, u32 ring_index,
     {
       if (svm_msg_q_try_lock (mq))
        return -1;
-      if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, ring_index)))
+      if (PREDICT_FALSE (svm_msg_q_is_full (mq)
+                        || svm_msg_q_ring_is_full (mq, ring_index)))
        {
          svm_msg_q_unlock (mq);
          return -2;
        }
       *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
-      if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (msg)))
-       {
-         svm_msg_q_unlock (mq);
-         return -2;
-       }
     }
   else
     {
       svm_msg_q_lock (mq);
-      while (svm_msg_q_ring_is_full (mq, ring_index))
+      while (svm_msg_q_is_full (mq)
+            || svm_msg_q_ring_is_full (mq, ring_index))
        svm_msg_q_wait (mq);
       *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
     }
@@ -146,16 +182,18 @@ svm_msg_q_msg_t
 svm_msg_q_alloc_msg (svm_msg_q_t * mq, u32 nbytes)
 {
   svm_msg_q_msg_t msg = {.as_u64 = ~0 };
+  svm_msg_q_ring_shared_t *sr;
   svm_msg_q_ring_t *ring;
 
   vec_foreach (ring, mq->rings)
   {
-    if (ring->elsize < nbytes || ring->cursize == ring->nitems)
+    sr = ring->shr;
+    if (ring->elsize < nbytes || sr->cursize == ring->nitems)
       continue;
     msg.ring_index = ring - mq->rings;
-    msg.elt_index = ring->tail;
-    ring->tail = (ring->tail + 1) % ring->nitems;
-    __sync_fetch_and_add (&ring->cursize, 1);
+    msg.elt_index = sr->tail;
+    sr->tail = (sr->tail + 1) % ring->nitems;
+    clib_atomic_fetch_add (&sr->cursize, 1);
     break;
   }
   return msg;
@@ -171,13 +209,16 @@ svm_msg_q_msg_data (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 void
 svm_msg_q_free_msg (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 {
+  svm_msg_q_ring_shared_t *sr;
   svm_msg_q_ring_t *ring;
+  int need_signal;
 
   ASSERT (vec_len (mq->rings) > msg->ring_index);
-  ring = &mq->rings[msg->ring_index];
-  if (msg->elt_index == ring->head)
+  ring = svm_msg_q_ring_inline (mq, msg->ring_index);
+  sr = ring->shr;
+  if (msg->elt_index == sr->head)
     {
-      ring->head = (ring->head + 1) % ring->nitems;
+      sr->head = (sr->head + 1) % ring->nitems;
     }
   else
     {
@@ -185,24 +226,32 @@ svm_msg_q_free_msg (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
       /* for now, expect messages to be processed in order */
       ASSERT (0);
     }
-  __sync_fetch_and_sub (&ring->cursize, 1);
+
+  need_signal = sr->cursize == ring->nitems;
+  clib_atomic_fetch_sub (&sr->cursize, 1);
+
+  if (PREDICT_FALSE (need_signal))
+    svm_queue_send_signal (mq->q, 0);
 }
 
 static int
 svm_msq_q_msg_is_valid (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 {
   u32 dist1, dist2, tail, head;
+  svm_msg_q_ring_shared_t *sr;
   svm_msg_q_ring_t *ring;
 
   if (vec_len (mq->rings) <= msg->ring_index)
     return 0;
-  ring = &mq->rings[msg->ring_index];
-  tail = ring->tail;
-  head = ring->head;
+
+  ring = svm_msg_q_ring_inline (mq, msg->ring_index);
+  sr = ring->shr;
+  tail = sr->tail;
+  head = sr->head;
 
   dist1 = ((ring->nitems + msg->elt_index) - head) % ring->nitems;
   if (tail == head)
-    dist2 = (ring->cursize == 0) ? 0 : ring->nitems;
+    dist2 = (sr->cursize == 0) ? 0 : ring->nitems;
   else
     dist2 = ((ring->nitems + tail) - head) % ring->nitems;
   return (dist1 < dist2);
@@ -268,6 +317,19 @@ svm_msg_q_alloc_producer_eventfd (svm_msg_q_t * mq)
   return 0;
 }
 
+u8 *
+format_svm_msg_q (u8 * s, va_list * args)
+{
+  svm_msg_q_t *mq = va_arg (*args, svm_msg_q_t *);
+  s = format (s, " [Q:%d/%d]", mq->q->cursize, mq->q->maxsize);
+  for (u32 i = 0; i < vec_len (mq->rings); i++)
+    {
+      s = format (s, " [R%d:%d/%d]", i, mq->rings[i].shr->cursize,
+                 mq->rings[i].nitems);
+    }
+  return s;
+}
+
 /*
  * fd.io coding-style-patch-verification: ON
  *