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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #include <svm/message_queue.h>
17 #include <vppinfra/mem.h>
19 static inline svm_msg_q_ring_t *
20 svm_msg_q_ring_inline (svm_msg_q_t * mq, u32 ring_index)
22 return vec_elt_at_index (mq->rings, ring_index);
26 svm_msg_q_ring (svm_msg_q_t * mq, u32 ring_index)
28 return svm_msg_q_ring_inline (mq, ring_index);
32 svm_msg_q_ring_data (svm_msg_q_ring_t * ring, u32 elt_index)
34 ASSERT (elt_index < ring->nitems);
35 return (ring->data + elt_index * ring->elsize);
39 svm_msg_q_alloc (svm_msg_q_cfg_t * cfg)
41 svm_msg_q_ring_t *ring;
49 mq = clib_mem_alloc_aligned (sizeof (svm_msg_q_t), CLIB_CACHE_LINE_BYTES);
50 memset (mq, 0, sizeof (*mq));
51 mq->q = svm_queue_init (cfg->q_nitems, sizeof (svm_msg_q_msg_t),
52 cfg->consumer_pid, 0);
53 vec_validate (mq->rings, cfg->n_rings - 1);
54 for (i = 0; i < cfg->n_rings; i++)
57 ring->elsize = cfg->ring_cfgs[i].elsize;
58 ring->nitems = cfg->ring_cfgs[i].nitems;
59 if (cfg->ring_cfgs[i].data)
60 ring->data = cfg->ring_cfgs[i].data;
63 size = (uword) ring->nitems * ring->elsize;
64 ring->data = clib_mem_alloc_aligned (size, CLIB_CACHE_LINE_BYTES);
72 svm_msg_q_free (svm_msg_q_t * mq)
74 svm_msg_q_ring_t *ring;
76 vec_foreach (ring, mq->rings)
78 clib_mem_free (ring->data);
85 svm_msg_q_alloc_msg_w_ring (svm_msg_q_t * mq, u32 ring_index)
87 svm_msg_q_msg_t msg = {.as_u64 = ~0 };
88 svm_msg_q_ring_t *ring = svm_msg_q_ring_inline (mq, ring_index);
90 ASSERT (ring->cursize != ring->nitems);
91 msg.ring_index = ring - mq->rings;
92 msg.elt_index = ring->tail;
93 ring->tail = (ring->tail + 1) % ring->nitems;
94 __sync_fetch_and_add (&ring->cursize, 1);
99 svm_msg_q_lock_and_alloc_msg_w_ring (svm_msg_q_t * mq, u32 ring_index,
100 u8 noblock, svm_msg_q_msg_t * msg)
104 if (svm_msg_q_try_lock (mq))
106 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, ring_index)))
108 svm_msg_q_unlock (mq);
111 *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
112 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (msg)))
114 svm_msg_q_unlock (mq);
121 *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
122 while (svm_msg_q_msg_is_invalid (msg))
125 *msg = svm_msg_q_alloc_msg_w_ring (mq, ring_index);
132 svm_msg_q_alloc_msg (svm_msg_q_t * mq, u32 nbytes)
134 svm_msg_q_msg_t msg = {.as_u64 = ~0 };
135 svm_msg_q_ring_t *ring;
137 vec_foreach (ring, mq->rings)
139 if (ring->elsize < nbytes || ring->cursize == ring->nitems)
141 msg.ring_index = ring - mq->rings;
142 msg.elt_index = ring->tail;
143 ring->tail = (ring->tail + 1) % ring->nitems;
144 __sync_fetch_and_add (&ring->cursize, 1);
151 svm_msg_q_msg_data (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
153 svm_msg_q_ring_t *ring = svm_msg_q_ring_inline (mq, msg->ring_index);
154 return svm_msg_q_ring_data (ring, msg->elt_index);
158 svm_msg_q_free_msg (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
160 svm_msg_q_ring_t *ring;
162 if (vec_len (mq->rings) <= msg->ring_index)
164 ring = &mq->rings[msg->ring_index];
165 if (msg->elt_index == ring->head)
167 ring->head = (ring->head + 1) % ring->nitems;
171 /* for now, expect messages to be processed in order */
174 __sync_fetch_and_sub (&ring->cursize, 1);
178 svm_msq_q_msg_is_valid (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
180 svm_msg_q_ring_t *ring;
183 if (vec_len (mq->rings) <= msg->ring_index)
185 ring = &mq->rings[msg->ring_index];
187 dist1 = ((ring->nitems + msg->elt_index) - ring->head) % ring->nitems;
188 if (ring->tail == ring->head)
189 dist2 = (ring->cursize == 0) ? 0 : ring->nitems;
191 dist2 = ((ring->nitems + ring->tail) - ring->head) % ring->nitems;
192 return (dist1 < dist2);
196 svm_msg_q_add (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, int nowait)
198 ASSERT (svm_msq_q_msg_is_valid (mq, msg));
199 return svm_queue_add (mq->q, (u8 *) msg, nowait);
203 svm_msg_q_add_and_unlock (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
205 ASSERT (svm_msq_q_msg_is_valid (mq, msg));
206 svm_queue_add_raw (mq->q, (u8 *) msg);
207 svm_msg_q_unlock (mq);
211 svm_msg_q_sub (svm_msg_q_t * mq, svm_msg_q_msg_t * msg,
212 svm_q_conditional_wait_t cond, u32 time)
214 return svm_queue_sub (mq->q, (u8 *) msg, cond, time);
218 svm_msg_q_sub_w_lock (svm_msg_q_t * mq, svm_msg_q_msg_t * msg)
220 svm_queue_sub_raw (mq->q, (u8 *) msg);
224 * fd.io coding-style-patch-verification: ON
227 * eval: (c-set-style "gnu")