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->shr->data + elt_index * ring->elsize);
  38 }
  39
  40 svm_msg_q_shared_t *
  41 svm_msg_q_init (void *base, svm_msg_q_cfg_t *cfg)
  42 {
  43   svm_msg_q_ring_shared_t *ring;
  44   svm_msg_q_shared_t *smq;
  45   u32 q_sz, offset;
  46   int i;
  47
  48   q_sz = sizeof (svm_queue_t) + cfg->q_nitems * sizeof (svm_msg_q_msg_t);
  49
  50   smq = (svm_msg_q_shared_t *) base;
  51   svm_queue_init (&smq->q, cfg->q_nitems, sizeof (svm_msg_q_msg_t));
  52   smq->q->consumer_pid = cfg->consumer_pid;
  53   smq->n_rings = cfg->n_rings;
  54   ring = (void *) ((u8 *) smq->q + q_sz);
  55   for (i = 0; i < cfg->n_rings; i++)
  56     {
  57       ring->elsize = cfg->ring_cfgs[i].elsize;
  58       ring->nitems = cfg->ring_cfgs[i].nitems;
  59       ring->cursize = ring->head = ring->tail = 0;
  60       offset = sizeof (*ring) + ring->nitems * ring->elsize;
  61       ring = (void *) ((u8 *) ring + offset);
  62     }
  63
  64   return smq;
  65 }
  66
  67 uword
  68 svm_msg_q_size_to_alloc (svm_msg_q_cfg_t *cfg)
  69 {
  70   svm_msg_q_ring_cfg_t *ring_cfg;
  71   uword rings_sz = 0, mq_sz;
  72   u32 q_sz;
  73   int i;
  74
  75   ASSERT (cfg);
  76
  77   rings_sz = sizeof (svm_msg_q_ring_shared_t) * cfg->n_rings;
  78   for (i = 0; i < cfg->n_rings; i++)
  79     {
  80       if (cfg->ring_cfgs[i].data)
  81         continue;
  82       ring_cfg = &cfg->ring_cfgs[i];
  83       rings_sz += (uword) ring_cfg->nitems * ring_cfg->elsize;
  84     }
  85
  86   q_sz = sizeof (svm_queue_t) + cfg->q_nitems * sizeof (svm_msg_q_msg_t);
  87   mq_sz = sizeof (svm_msg_q_shared_t) + q_sz + rings_sz;
  88
  89   return mq_sz;
  90 }
  91
  92 svm_msg_q_shared_t *
  93 svm_msg_q_alloc (svm_msg_q_cfg_t *cfg)
  94 {
  95   uword mq_sz;
  96   u8 *base;
  97
  98   mq_sz = svm_msg_q_size_to_alloc (cfg);
  99   base = clib_mem_alloc_aligned (mq_sz, CLIB_CACHE_LINE_BYTES);
 100   if (!base)
 101     return 0;
 102
 103   return svm_msg_q_init (base, cfg);
 104 }
 105
 106 void
 107 svm_msg_q_attach (svm_msg_q_t *mq, void *smq_base)
 108 {
 109   svm_msg_q_ring_shared_t *ring;
 110   svm_msg_q_shared_t *smq;
 111   u32 i, n_rings, q_sz, offset;
 112
 113   smq = (svm_msg_q_shared_t *) smq_base;
 114   mq->q = smq->q;
 115   n_rings = smq->n_rings;
 116   vec_validate (mq->rings, n_rings - 1);
 117   q_sz = sizeof (svm_queue_t) + mq->q->maxsize * sizeof (svm_msg_q_msg_t);
 118   ring = (void *) ((u8 *) smq->q + q_sz);
 119   for (i = 0; i < n_rings; i++)
 120     {
 121       mq->rings[i].nitems = ring->nitems;
 122       mq->rings[i].elsize = ring->elsize;
 123       mq->rings[i].shr = ring;
 124       offset = sizeof (*ring) + ring->nitems * ring->elsize;
 125       ring = (void *) ((u8 *) ring + offset);
 126     }
 127 }
 128
 129 void
 130 svm_msg_q_free (svm_msg_q_t * mq)
 131 {
 132   svm_queue_free (mq->q);
 133   clib_mem_free (mq);
 134 }
 135
 136 svm_msg_q_msg_t
 137 svm_msg_q_alloc_msg_w_ring (svm_msg_q_t * mq, u32 ring_index)
 138 {
 139   svm_msg_q_ring_shared_t *sr;
 140   svm_msg_q_ring_t *ring;
 141   svm_msg_q_msg_t msg;
 142
 143   ring = svm_msg_q_ring_inline (mq, ring_index);
 144   sr = ring->shr;
 145
 146   ASSERT (sr->cursize < ring->nitems);
 147   msg.ring_index = ring - mq->rings;
 148   msg.elt_index = sr->tail;
 149   sr->tail = (sr->tail + 1) % ring->nitems;
 150   clib_atomic_fetch_add (&sr->cursize, 1);
 151   return msg;
 152 }
 153
 154 int
 155 svm_msg_q_lock_and_alloc_msg_w_ring (svm_msg_q_t * mq, u32 ring_index,
 156                                      u8 noblock, svm_msg_q_msg_t * msg)
 157 {
 158   if (noblock)
 159     {
 160       if (svm_msg_q_try_lock (mq))
 161         return -1;
 162       if (PREDICT_FALSE (svm_msg_q_is_full (mq)
 163                          || svm_msg_q_ring_is_full (mq, ring_index)))
 164         {
 165           svm_msg_q_unlock (mq);
 166           return -2;
 167         }
 168       *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
 169     }
 170   else
 171     {
 172       svm_msg_q_lock (mq);
 173       while (svm_msg_q_is_full (mq)
 174              || svm_msg_q_ring_is_full (mq, ring_index))
 175         svm_msg_q_wait (mq);
 176       *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
 177     }
 178   return 0;
 179 }
 180
 181 svm_msg_q_msg_t
 182 svm_msg_q_alloc_msg (svm_msg_q_t * mq, u32 nbytes)
 183 {
 184   svm_msg_q_msg_t msg = {.as_u64 = ~0 };
 185   svm_msg_q_ring_shared_t *sr;
 186   svm_msg_q_ring_t *ring;
 187
 188   vec_foreach (ring, mq->rings)
 189   {
 190     sr = ring->shr;
 191     if (ring->elsize < nbytes || sr->cursize == ring->nitems)
 192       continue;
 193     msg.ring_index = ring - mq->rings;
 194     msg.elt_index = sr->tail;
 195     sr->tail = (sr->tail + 1) % ring->nitems;
 196     clib_atomic_fetch_add (&sr->cursize, 1);
 197     break;
 198   }
 199   return msg;
 200 }
 201
 202 void *
 203 svm_msg_q_msg_data (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 204 {
 205   svm_msg_q_ring_t *ring = svm_msg_q_ring_inline (mq, msg->ring_index);
 206   return svm_msg_q_ring_data (ring, msg->elt_index);
 207 }
 208
 209 void
 210 svm_msg_q_free_msg (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 211 {
 212   svm_msg_q_ring_shared_t *sr;
 213   svm_msg_q_ring_t *ring;
 214   int need_signal;
 215
 216   ASSERT (vec_len (mq->rings) > msg->ring_index);
 217   ring = svm_msg_q_ring_inline (mq, msg->ring_index);
 218   sr = ring->shr;
 219   if (msg->elt_index == sr->head)
 220     {
 221       sr->head = (sr->head + 1) % ring->nitems;
 222     }
 223   else
 224     {
 225       clib_warning ("message out of order");
 226       /* for now, expect messages to be processed in order */
 227       ASSERT (0);
 228     }
 229
 230   need_signal = sr->cursize == ring->nitems;
 231   clib_atomic_fetch_sub (&sr->cursize, 1);
 232
 233   if (PREDICT_FALSE (need_signal))
 234     svm_queue_send_signal (mq->q, 0);
 235 }
 236
 237 static int
 238 svm_msq_q_msg_is_valid (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 239 {
 240   u32 dist1, dist2, tail, head;
 241   svm_msg_q_ring_shared_t *sr;
 242   svm_msg_q_ring_t *ring;
 243
 244   if (vec_len (mq->rings) <= msg->ring_index)
 245     return 0;
 246
 247   ring = svm_msg_q_ring_inline (mq, msg->ring_index);
 248   sr = ring->shr;
 249   tail = sr->tail;
 250   head = sr->head;
 251
 252   dist1 = ((ring->nitems + msg->elt_index) - head) % ring->nitems;
 253   if (tail == head)
 254     dist2 = (sr->cursize == 0) ? 0 : ring->nitems;
 255   else
 256     dist2 = ((ring->nitems + tail) - head) % ring->nitems;
 257   return (dist1 < dist2);
 258 }
 259
 260 int
 261 svm_msg_q_add (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, int nowait)
 262 {
 263   ASSERT (svm_msq_q_msg_is_valid (mq, msg));
 264   return svm_queue_add (mq->q, (u8 *) msg, nowait);
 265 }
 266
 267 void
 268 svm_msg_q_add_and_unlock (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 269 {
 270   ASSERT (svm_msq_q_msg_is_valid (mq, msg));
 271   svm_queue_add_raw (mq->q, (u8 *) msg);
 272   svm_msg_q_unlock (mq);
 273 }
 274
 275 int
 276 svm_msg_q_sub (svm_msg_q_t * mq, svm_msg_q_msg_t * msg,
 277                svm_q_conditional_wait_t cond, u32 time)
 278 {
 279   return svm_queue_sub (mq->q, (u8 *) msg, cond, time);
 280 }
 281
 282 void
 283 svm_msg_q_sub_w_lock (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 284 {
 285   svm_queue_sub_raw (mq->q, (u8 *) msg);
 286 }
 287
 288 void
 289 svm_msg_q_set_consumer_eventfd (svm_msg_q_t * mq, int fd)
 290 {
 291   mq->q->consumer_evtfd = fd;
 292 }
 293
 294 void
 295 svm_msg_q_set_producer_eventfd (svm_msg_q_t * mq, int fd)
 296 {
 297   mq->q->producer_evtfd = fd;
 298 }
 299
 300 int
 301 svm_msg_q_alloc_consumer_eventfd (svm_msg_q_t * mq)
 302 {
 303   int fd;
 304   if ((fd = eventfd (0, EFD_NONBLOCK)) < 0)
 305     return -1;
 306   svm_msg_q_set_consumer_eventfd (mq, fd);
 307   return 0;
 308 }
 309
 310 int
 311 svm_msg_q_alloc_producer_eventfd (svm_msg_q_t * mq)
 312 {
 313   int fd;
 314   if ((fd = eventfd (0, EFD_NONBLOCK)) < 0)
 315     return -1;
 316   svm_msg_q_set_producer_eventfd (mq, fd);
 317   return 0;
 318 }
 319
 320 u8 *
 321 format_svm_msg_q (u8 * s, va_list * args)
 322 {
 323   svm_msg_q_t *mq = va_arg (*args, svm_msg_q_t *);
 324   s = format (s, " [Q:%d/%d]", mq->q->cursize, mq->q->maxsize);
 325   for (u32 i = 0; i < vec_len (mq->rings); i++)
 326     {
 327       s = format (s, " [R%d:%d/%d]", i, mq->rings[i].shr->cursize,
 328                   mq->rings[i].nitems);
 329     }
 330   return s;
 331 }
 332
 333 /*
 334  * fd.io coding-style-patch-verification: ON
 335  *
 336  * Local Variables:
 337  * eval: (c-set-style "gnu")
 338  * End:
 339  */