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
  19 static inline svm_msg_q_ring_t *
  20 svm_msg_q_ring_inline (svm_msg_q_t * mq, u32 ring_index)
  21 {
  22   return vec_elt_at_index (mq->rings, ring_index);
  23 }
  24
  25 svm_msg_q_ring_t *
  26 svm_msg_q_ring (svm_msg_q_t * mq, u32 ring_index)
  27 {
  28   return svm_msg_q_ring_inline (mq, ring_index);
  29 }
  30
  31 static inline void *
  32 svm_msg_q_ring_data (svm_msg_q_ring_t * ring, u32 elt_index)
  33 {
  34   ASSERT (elt_index < ring->nitems);
  35   return (ring->data + elt_index * ring->elsize);
  36 }
  37
  38 svm_msg_q_t *
  39 svm_msg_q_alloc (svm_msg_q_cfg_t * cfg)
  40 {
  41   svm_msg_q_ring_cfg_t *ring_cfg;
  42   uword rings_sz = 0, mq_sz;
  43   svm_msg_q_ring_t *ring;
  44   u8 *base, *rings_ptr;
  45   vec_header_t *vh;
  46   u32 vec_sz, q_sz;
  47   svm_msg_q_t *mq;
  48   int i;
  49
  50   ASSERT (cfg);
  51
  52   vec_sz = vec_header_bytes (0) + sizeof (svm_msg_q_ring_t) * cfg->n_rings;
  53   for (i = 0; i < cfg->n_rings; i++)
  54     {
  55       if (cfg->ring_cfgs[i].data)
  56         continue;
  57       ring_cfg = &cfg->ring_cfgs[i];
  58       rings_sz += (uword) ring_cfg->nitems * ring_cfg->elsize;
  59     }
  60
  61   q_sz = sizeof (svm_queue_t) + cfg->q_nitems * sizeof (svm_msg_q_msg_t);
  62   mq_sz = sizeof (svm_msg_q_t) + vec_sz + rings_sz + q_sz;
  63   base = clib_mem_alloc_aligned (mq_sz, CLIB_CACHE_LINE_BYTES);
  64   if (!base)
  65     return 0;
  66
  67   mq = (svm_msg_q_t *) base;
  68   mq->q = svm_queue_init (base + sizeof (svm_msg_q_t), cfg->q_nitems,
  69                           sizeof (svm_msg_q_msg_t));
  70   mq->q->consumer_pid = cfg->consumer_pid;
  71   vh = (vec_header_t *) ((u8 *) mq->q + q_sz);
  72   vh->len = cfg->n_rings;
  73   mq->rings = (svm_msg_q_ring_t *) (vh + 1);
  74   rings_ptr = (u8 *) mq->rings + vec_sz;
  75   for (i = 0; i < cfg->n_rings; i++)
  76     {
  77       ring = &mq->rings[i];
  78       ring->elsize = cfg->ring_cfgs[i].elsize;
  79       ring->nitems = cfg->ring_cfgs[i].nitems;
  80       ring->cursize = ring->head = ring->tail = 0;
  81       if (cfg->ring_cfgs[i].data)
  82         ring->data = cfg->ring_cfgs[i].data;
  83       else
  84         {
  85           ring->data = rings_ptr;
  86           rings_ptr += (uword) ring->nitems * ring->elsize;
  87         }
  88     }
  89
  90   return mq;
  91 }
  92
  93 void
  94 svm_msg_q_free (svm_msg_q_t * mq)
  95 {
  96   svm_queue_free (mq->q);
  97   clib_mem_free (mq);
  98 }
  99
 100 svm_msg_q_msg_t
 101 svm_msg_q_alloc_msg_w_ring (svm_msg_q_t * mq, u32 ring_index)
 102 {
 103   svm_msg_q_msg_t msg;
 104   svm_msg_q_ring_t *ring = svm_msg_q_ring_inline (mq, ring_index);
 105
 106   ASSERT (ring->cursize < ring->nitems);
 107   msg.ring_index = ring - mq->rings;
 108   msg.elt_index = ring->tail;
 109   ring->tail = (ring->tail + 1) % ring->nitems;
 110   __sync_fetch_and_add (&ring->cursize, 1);
 111   return msg;
 112 }
 113
 114 int
 115 svm_msg_q_lock_and_alloc_msg_w_ring (svm_msg_q_t * mq, u32 ring_index,
 116                                      u8 noblock, svm_msg_q_msg_t * msg)
 117 {
 118   if (noblock)
 119     {
 120       if (svm_msg_q_try_lock (mq))
 121         return -1;
 122       if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, ring_index)))
 123         {
 124           svm_msg_q_unlock (mq);
 125           return -2;
 126         }
 127       *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
 128       if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (msg)))
 129         {
 130           svm_msg_q_unlock (mq);
 131           return -2;
 132         }
 133     }
 134   else
 135     {
 136       svm_msg_q_lock (mq);
 137       while (svm_msg_q_ring_is_full (mq, ring_index))
 138         svm_msg_q_wait (mq);
 139       *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
 140     }
 141   return 0;
 142 }
 143
 144 svm_msg_q_msg_t
 145 svm_msg_q_alloc_msg (svm_msg_q_t * mq, u32 nbytes)
 146 {
 147   svm_msg_q_msg_t msg = {.as_u64 = ~0 };
 148   svm_msg_q_ring_t *ring;
 149
 150   vec_foreach (ring, mq->rings)
 151   {
 152     if (ring->elsize < nbytes || ring->cursize == ring->nitems)
 153       continue;
 154     msg.ring_index = ring - mq->rings;
 155     msg.elt_index = ring->tail;
 156     ring->tail = (ring->tail + 1) % ring->nitems;
 157     __sync_fetch_and_add (&ring->cursize, 1);
 158     break;
 159   }
 160   return msg;
 161 }
 162
 163 void *
 164 svm_msg_q_msg_data (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 165 {
 166   svm_msg_q_ring_t *ring = svm_msg_q_ring_inline (mq, msg->ring_index);
 167   return svm_msg_q_ring_data (ring, msg->elt_index);
 168 }
 169
 170 void
 171 svm_msg_q_free_msg (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 172 {
 173   svm_msg_q_ring_t *ring;
 174
 175   if (vec_len (mq->rings) <= msg->ring_index)
 176     return;
 177   ring = &mq->rings[msg->ring_index];
 178   if (msg->elt_index == ring->head)
 179     {
 180       ring->head = (ring->head + 1) % ring->nitems;
 181     }
 182   else
 183     {
 184       /* for now, expect messages to be processed in order */
 185       ASSERT (0);
 186     }
 187   __sync_fetch_and_sub (&ring->cursize, 1);
 188 }
 189
 190 static int
 191 svm_msq_q_msg_is_valid (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 192 {
 193   u32 dist1, dist2, tail, head;
 194   svm_msg_q_ring_t *ring;
 195
 196   if (vec_len (mq->rings) <= msg->ring_index)
 197     return 0;
 198   ring = &mq->rings[msg->ring_index];
 199   tail = ring->tail;
 200   head = ring->head;
 201
 202   dist1 = ((ring->nitems + msg->elt_index) - head) % ring->nitems;
 203   if (tail == head)
 204     dist2 = (ring->cursize == 0) ? 0 : ring->nitems;
 205   else
 206     dist2 = ((ring->nitems + tail) - head) % ring->nitems;
 207   return (dist1 < dist2);
 208 }
 209
 210 int
 211 svm_msg_q_add (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, int nowait)
 212 {
 213   ASSERT (svm_msq_q_msg_is_valid (mq, msg));
 214   return svm_queue_add (mq->q, (u8 *) msg, nowait);
 215 }
 216
 217 void
 218 svm_msg_q_add_and_unlock (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 219 {
 220   ASSERT (svm_msq_q_msg_is_valid (mq, msg));
 221   svm_queue_add_raw (mq->q, (u8 *) msg);
 222   svm_msg_q_unlock (mq);
 223 }
 224
 225 int
 226 svm_msg_q_sub (svm_msg_q_t * mq, svm_msg_q_msg_t * msg,
 227                svm_q_conditional_wait_t cond, u32 time)
 228 {
 229   return svm_queue_sub (mq->q, (u8 *) msg, cond, time);
 230 }
 231
 232 void
 233 svm_msg_q_sub_w_lock (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 234 {
 235   svm_queue_sub_raw (mq->q, (u8 *) msg);
 236 }
 237
 238 /*
 239  * fd.io coding-style-patch-verification: ON
 240  *
 241  * Local Variables:
 242  * eval: (c-set-style "gnu")
 243  * End:
 244  */