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   svm_msg_q_ring_t *ring;
  43   u8 *base, *rings_ptr;
  44   uword rings_sz = 0;
  45   vec_header_t *vh;
  46   svm_msg_q_t *mq;
  47   u32 vec_sz;
  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   base = clib_mem_alloc_aligned (sizeof (svm_msg_q_t) + vec_sz + rings_sz,
  62                                  CLIB_CACHE_LINE_BYTES);
  63   if (!base)
  64     return 0;
  65
  66   mq = (svm_msg_q_t *) base;
  67   vh = (vec_header_t *) (base + sizeof (svm_msg_q_t));
  68   vh->len = cfg->n_rings;
  69   mq->rings = (svm_msg_q_ring_t *) (vh + 1);
  70   rings_ptr = (u8 *) mq->rings + vec_sz;
  71   for (i = 0; i < cfg->n_rings; i++)
  72     {
  73       ring = &mq->rings[i];
  74       ring->elsize = cfg->ring_cfgs[i].elsize;
  75       ring->nitems = cfg->ring_cfgs[i].nitems;
  76       if (cfg->ring_cfgs[i].data)
  77         ring->data = cfg->ring_cfgs[i].data;
  78       else
  79         {
  80           ring->data = rings_ptr;
  81           rings_ptr += (uword) ring->nitems * ring->elsize;
  82         }
  83     }
  84   mq->q = svm_queue_init (cfg->q_nitems, sizeof (svm_msg_q_msg_t),
  85                           cfg->consumer_pid, 0);
  86
  87   return mq;
  88 }
  89
  90 void
  91 svm_msg_q_free (svm_msg_q_t * mq)
  92 {
  93   svm_queue_free (mq->q);
  94   clib_mem_free (mq);
  95 }
  96
  97 svm_msg_q_msg_t
  98 svm_msg_q_alloc_msg_w_ring (svm_msg_q_t * mq, u32 ring_index)
  99 {
 100   svm_msg_q_msg_t msg = {.as_u64 = ~0 };
 101   svm_msg_q_ring_t *ring = svm_msg_q_ring_inline (mq, ring_index);
 102
 103   ASSERT (ring->cursize != ring->nitems);
 104   msg.ring_index = ring - mq->rings;
 105   msg.elt_index = ring->tail;
 106   ring->tail = (ring->tail + 1) % ring->nitems;
 107   __sync_fetch_and_add (&ring->cursize, 1);
 108   return msg;
 109 }
 110
 111 int
 112 svm_msg_q_lock_and_alloc_msg_w_ring (svm_msg_q_t * mq, u32 ring_index,
 113                                      u8 noblock, svm_msg_q_msg_t * msg)
 114 {
 115   if (noblock)
 116     {
 117       if (svm_msg_q_try_lock (mq))
 118         return -1;
 119       if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, ring_index)))
 120         {
 121           svm_msg_q_unlock (mq);
 122           return -2;
 123         }
 124       *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
 125       if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (msg)))
 126         {
 127           svm_msg_q_unlock (mq);
 128           return -2;
 129         }
 130     }
 131   else
 132     {
 133       svm_msg_q_lock (mq);
 134       *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
 135       while (svm_msg_q_msg_is_invalid (msg))
 136         {
 137           svm_msg_q_wait (mq);
 138           *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
 139         }
 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   svm_msg_q_ring_t *ring;
 194   u32 dist1, dist2;
 195
 196   if (vec_len (mq->rings) <= msg->ring_index)
 197     return 0;
 198   ring = &mq->rings[msg->ring_index];
 199
 200   dist1 = ((ring->nitems + msg->elt_index) - ring->head) % ring->nitems;
 201   if (ring->tail == ring->head)
 202     dist2 = (ring->cursize == 0) ? 0 : ring->nitems;
 203   else
 204     dist2 = ((ring->nitems + ring->tail) - ring->head) % ring->nitems;
 205   return (dist1 < dist2);
 206 }
 207
 208 int
 209 svm_msg_q_add (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, int nowait)
 210 {
 211   ASSERT (svm_msq_q_msg_is_valid (mq, msg));
 212   return svm_queue_add (mq->q, (u8 *) msg, nowait);
 213 }
 214
 215 void
 216 svm_msg_q_add_and_unlock (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 217 {
 218   ASSERT (svm_msq_q_msg_is_valid (mq, msg));
 219   svm_queue_add_raw (mq->q, (u8 *) msg);
 220   svm_msg_q_unlock (mq);
 221 }
 222
 223 int
 224 svm_msg_q_sub (svm_msg_q_t * mq, svm_msg_q_msg_t * msg,
 225                svm_q_conditional_wait_t cond, u32 time)
 226 {
 227   return svm_queue_sub (mq->q, (u8 *) msg, cond, time);
 228 }
 229
 230 void
 231 svm_msg_q_sub_w_lock (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
 232 {
 233   svm_queue_sub_raw (mq->q, (u8 *) msg);
 234 }
 235
 236 /*
 237  * fd.io coding-style-patch-verification: ON
 238  *
 239  * Local Variables:
 240  * eval: (c-set-style "gnu")
 241  * End:
 242  */