src/svm/message_queue.c

   1 /*
   2  * Copyright (c) 2018 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <svm/message_queue.h>
  17 #include <vppinfra/mem.h>
  18 #include <vppinfra/format.h>
  19 #include <sys/eventfd.h>
  20
  21 static inline svm_msg_q_ring_t *
  22 svm_msg_q_ring_inline (svm_msg_q_t * mq, u32 ring_index)
  23 {
  24   return vec_elt_at_index (mq->rings, ring_index);
  25 }
  26
  27 svm_msg_q_ring_t *
  28 svm_msg_q_ring (svm_msg_q_t * mq, u32 ring_index)
  29 {
  30   return svm_msg_q_ring_inline (mq, ring_index);
  31 }
  32
  33 static inline void *
  34 svm_msg_q_ring_data (svm_msg_q_ring_t * ring, u32 elt_index)
  35 {
  36   ASSERT (elt_index < ring->nitems);
  37   return (ring->data + elt_index * ring->elsize);
  38 }
  39
  40 svm_msg_q_t *
  41 svm_msg_q_init (void *base, svm_msg_q_cfg_t *cfg)
  42 {
  43   svm_msg_q_ring_t *ring;
  44   vec_header_t *vh;
  45   svm_msg_q_t *mq;
  46   u8 *rings_ptr;
  47   u32 q_sz;
  48   int i;
  49
  50   q_sz = sizeof (svm_queue_t) + cfg->q_nitems * sizeof (svm_msg_q_msg_t);
  51
  52   mq = (svm_msg_q_t *) base;
  53   mq->q = svm_queue_init (base + sizeof (svm_msg_q_t), cfg->q_nitems,
  54                           sizeof (svm_msg_q_msg_t));
  55   mq->q->consumer_pid = cfg->consumer_pid;
  56   vh = (vec_header_t *) ((u8 *) mq->q + q_sz);
  57   vh->len = cfg->n_rings;
  58   mq->rings = (svm_msg_q_ring_t *) (vh + 1);
  59   rings_ptr = (u8 *) mq->rings + sizeof (svm_msg_q_ring_t) * cfg->n_rings;
  60   for (i = 0; i < cfg->n_rings; i++)
  61     {
  62       ring = &mq->rings[i];
  63       ring->elsize = cfg->ring_cfgs[i].elsize;
  64       ring->nitems = cfg->ring_cfgs[i].nitems;
  65       ring->cursize = ring->head = ring->tail = 0;
  66       if (cfg->ring_cfgs[i].data)
  67         ring->data = cfg->ring_cfgs[i].data;
  68       else
  69         {
  70           ring->data = rings_ptr;
  71           rings_ptr += (uword) ring->nitems * ring->elsize;
  72         }
  73     }
  74
  75   return mq;
  76 }
  77
  78 uword
  79 svm_msg_q_size_to_alloc (svm_msg_q_cfg_t *cfg)
  80 {
  81   svm_msg_q_ring_cfg_t *ring_cfg;
  82   uword rings_sz = 0, mq_sz;
  83   u32 vec_sz, q_sz;
  84   int i;
  85
  86   ASSERT (cfg);
  87
  88   vec_sz = vec_header_bytes (0) + sizeof (svm_msg_q_ring_t) * cfg->n_rings;
  89   for (i = 0; i < cfg->n_rings; i++)
  90     {
  91       if (cfg->ring_cfgs[i].data)
  92         continue;
  93       ring_cfg = &cfg->ring_cfgs[i];
  94       rings_sz += (uword) ring_cfg->nitems * ring_cfg->elsize;
  95     }
  96
  97   q_sz = sizeof (svm_queue_t) + cfg->q_nitems * sizeof (svm_msg_q_msg_t);
  98   mq_sz = sizeof (svm_msg_q_t) + vec_sz + rings_sz + q_sz;
  99
 100   return mq_sz;
 101 }
 102
 103 svm_msg_q_t *
 104 svm_msg_q_alloc (svm_msg_q_cfg_t *cfg)
 105 {
 106   svm_msg_q_ring_cfg_t *ring_cfg;
 107   uword rings_sz = 0, mq_sz;
 108   u32 vec_sz, q_sz;
 109   u8 *base;
 110   int i;
 111
 112   ASSERT (cfg);
 113
 114   vec_sz = vec_header_bytes (0) + sizeof (svm_msg_q_ring_t) * cfg->n_rings;
 115   for (i = 0; i < cfg->n_rings; i++)
 116     {
 117       if (cfg->ring_cfgs[i].data)
 118         continue;
 119       ring_cfg = &cfg->ring_cfgs[i];
 120       rings_sz += (uword) ring_cfg->nitems * ring_cfg->elsize;
 121     }
 122
 123   q_sz = sizeof (svm_queue_t) + cfg->q_nitems * sizeof (svm_msg_q_msg_t);
 124   mq_sz = sizeof (svm_msg_q_t) + vec_sz + rings_sz + q_sz;
 125   base = clib_mem_alloc_aligned (mq_sz, CLIB_CACHE_LINE_BYTES);
 126   if (!base)
 127     return 0;
 128
 129   return svm_msg_q_init (base, cfg);
 130 }
 131
 132 void
 133 svm_msg_q_free (svm_msg_q_t * mq)
 134 {
 135   svm_queue_free (mq->q);
 136   clib_mem_free (mq);
 137 }
 138
 139 svm_msg_q_msg_t
 140 svm_msg_q_alloc_msg_w_ring (svm_msg_q_t * mq, u32 ring_index)
 141 {
 142   svm_msg_q_msg_t msg;
 143   svm_msg_q_ring_t *ring = svm_msg_q_ring_inline (mq, ring_index);
 144
 145   ASSERT (ring->cursize < ring->nitems);
 146   msg.ring_index = ring - mq->rings;
 147   msg.elt_index = ring->tail;
 148   ring->tail = (ring->tail + 1) % ring->nitems;
 149   clib_atomic_fetch_add (&ring->cursize, 1);
 150   return msg;
 151 }
 152
 153 int
 154 svm_msg_q_lock_and_alloc_msg_w_ring (svm_msg_q_t * mq, u32 ring_index,
 155                                      u8 noblock, svm_msg_q_msg_t * msg)
 156 {
 157   if (noblock)
 158     {
 159       if (svm_msg_q_try_lock (mq))
 160         return -1;
 161       if (PREDICT_FALSE (svm_msg_q_is_full (mq)
 162                          || svm_msg_q_ring_is_full (mq, ring_index)))
 163         {
 164           svm_msg_q_unlock (mq);
 165           return -2;
 166         }
 167       *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
 168     }
 169   else
 170     {
 171       svm_msg_q_lock (mq);
 172       while (svm_msg_q_is_full (mq)
 173              || svm_msg_q_ring_is_full (mq, ring_index))
 174         svm_msg_q_wait (mq);
 175       *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
 176     }
 177   return 0;
 178 }
 179
 180 svm_msg_q_msg_t
 181 svm_msg_q_alloc_msg (svm_msg_q_t * mq, u32 nbytes)
 182 {
 183   svm_msg_q_msg_t msg = {.as_u64 = ~0 };
 184   svm_msg_q_ring_t *ring;
 185
 186   vec_foreach (ring, mq->rings)
 187   {
 188     if (ring->elsize < nbytes || ring->cursize == ring->nitems)
 189       continue;
 190     msg.ring_index = ring - mq->rings;
 191     msg.elt_index = ring->tail;
 192     ring->tail = (ring->tail + 1) % ring->nitems;
 193     clib_atomic_fetch_add (&ring->cursize, 1);
 194     break;
 195   }
 196   return msg;
 197 }
 198
 199 void *
 200 svm_msg_q_msg_data (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 201 {
 202   svm_msg_q_ring_t *ring = svm_msg_q_ring_inline (mq, msg->ring_index);
 203   return svm_msg_q_ring_data (ring, msg->elt_index);
 204 }
 205
 206 void
 207 svm_msg_q_free_msg (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 208 {
 209   svm_msg_q_ring_t *ring;
 210   int need_signal;
 211
 212   ASSERT (vec_len (mq->rings) > msg->ring_index);
 213   ring = &mq->rings[msg->ring_index];
 214   if (msg->elt_index == ring->head)
 215     {
 216       ring->head = (ring->head + 1) % ring->nitems;
 217     }
 218   else
 219     {
 220       clib_warning ("message out of order");
 221       /* for now, expect messages to be processed in order */
 222       ASSERT (0);
 223     }
 224
 225   need_signal = ring->cursize == ring->nitems;
 226   clib_atomic_fetch_sub (&ring->cursize, 1);
 227
 228   if (PREDICT_FALSE (need_signal))
 229     svm_queue_send_signal (mq->q, 0);
 230 }
 231
 232 static int
 233 svm_msq_q_msg_is_valid (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 234 {
 235   u32 dist1, dist2, tail, head;
 236   svm_msg_q_ring_t *ring;
 237
 238   if (vec_len (mq->rings) <= msg->ring_index)
 239     return 0;
 240   ring = &mq->rings[msg->ring_index];
 241   tail = ring->tail;
 242   head = ring->head;
 243
 244   dist1 = ((ring->nitems + msg->elt_index) - head) % ring->nitems;
 245   if (tail == head)
 246     dist2 = (ring->cursize == 0) ? 0 : ring->nitems;
 247   else
 248     dist2 = ((ring->nitems + tail) - head) % ring->nitems;
 249   return (dist1 < dist2);
 250 }
 251
 252 int
 253 svm_msg_q_add (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, int nowait)
 254 {
 255   ASSERT (svm_msq_q_msg_is_valid (mq, msg));
 256   return svm_queue_add (mq->q, (u8 *) msg, nowait);
 257 }
 258
 259 void
 260 svm_msg_q_add_and_unlock (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 261 {
 262   ASSERT (svm_msq_q_msg_is_valid (mq, msg));
 263   svm_queue_add_raw (mq->q, (u8 *) msg);
 264   svm_msg_q_unlock (mq);
 265 }
 266
 267 int
 268 svm_msg_q_sub (svm_msg_q_t * mq, svm_msg_q_msg_t * msg,
 269                svm_q_conditional_wait_t cond, u32 time)
 270 {
 271   return svm_queue_sub (mq->q, (u8 *) msg, cond, time);
 272 }
 273
 274 void
 275 svm_msg_q_sub_w_lock (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 276 {
 277   svm_queue_sub_raw (mq->q, (u8 *) msg);
 278 }
 279
 280 void
 281 svm_msg_q_set_consumer_eventfd (svm_msg_q_t * mq, int fd)
 282 {
 283   mq->q->consumer_evtfd = fd;
 284 }
 285
 286 void
 287 svm_msg_q_set_producer_eventfd (svm_msg_q_t * mq, int fd)
 288 {
 289   mq->q->producer_evtfd = fd;
 290 }
 291
 292 int
 293 svm_msg_q_alloc_consumer_eventfd (svm_msg_q_t * mq)
 294 {
 295   int fd;
 296   if ((fd = eventfd (0, EFD_NONBLOCK)) < 0)
 297     return -1;
 298   svm_msg_q_set_consumer_eventfd (mq, fd);
 299   return 0;
 300 }
 301
 302 int
 303 svm_msg_q_alloc_producer_eventfd (svm_msg_q_t * mq)
 304 {
 305   int fd;
 306   if ((fd = eventfd (0, EFD_NONBLOCK)) < 0)
 307     return -1;
 308   svm_msg_q_set_producer_eventfd (mq, fd);
 309   return 0;
 310 }
 311
 312 u8 *
 313 format_svm_msg_q (u8 * s, va_list * args)
 314 {
 315   svm_msg_q_t *mq = va_arg (*args, svm_msg_q_t *);
 316   s = format (s, " [Q:%d/%d]", mq->q->cursize, mq->q->maxsize);
 317   for (u32 i = 0; i < vec_len (mq->rings); i++)
 318     {
 319       s = format (s, " [R%d:%d/%d]", i, mq->rings[i].cursize,
 320                   mq->rings[i].nitems);
 321     }
 322   return s;
 323 }
 324
 325 /*
 326  * fd.io coding-style-patch-verification: ON
 327  *
 328  * Local Variables:
 329  * eval: (c-set-style "gnu")
 330  * End:
 331  */