blob: 5244b27ad376b47effce6135b316b81ab3bed2ef [file] [log] [blame]
Dave Barach371e4e12016-07-08 09:38:52 -04001/*
Ed Warnickecb9cada2015-12-08 15:45:58 -07002 *------------------------------------------------------------------
3 * memclnt_shared.c - API message handling, common code for both clients
4 * and the vlib process itself.
Dave Barach371e4e12016-07-08 09:38:52 -04005 *
Ed Warnickecb9cada2015-12-08 15:45:58 -07006 *
7 * Copyright (c) 2009 Cisco and/or its affiliates.
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at:
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 *------------------------------------------------------------------
20 */
21
22#include <stdio.h>
23#include <stdlib.h>
Ole Troan6855f6c2016-04-09 03:16:30 +020024#include <stddef.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070025#include <string.h>
26#include <unistd.h>
27#include <signal.h>
Florin Corase86a8ed2018-01-05 03:20:25 -080028
Ed Warnickecb9cada2015-12-08 15:45:58 -070029#include <vppinfra/format.h>
30#include <vppinfra/byte_order.h>
31#include <vppinfra/error.h>
Dave Barachb09f4d02019-07-15 16:00:03 -040032#include <vppinfra/elog.h>
Florin Corase86a8ed2018-01-05 03:20:25 -080033#include <svm/queue.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070034#include <vlib/vlib.h>
35#include <vlib/unix/unix.h>
Florin Corase86a8ed2018-01-05 03:20:25 -080036#include <vlibmemory/memory_api.h>
Dave Barach371e4e12016-07-08 09:38:52 -040037#include <vlibmemory/vl_memory_msg_enum.h>
Dave Barach39d69112019-11-27 11:42:13 -050038#include <vlibapi/api_common.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070039
Dave Barach371e4e12016-07-08 09:38:52 -040040#define vl_typedefs
Ed Warnickecb9cada2015-12-08 15:45:58 -070041#include <vlibmemory/vl_memory_api_h.h>
42#undef vl_typedefs
43
Dave Barach59b25652017-09-10 15:04:27 -040044#define DEBUG_MESSAGE_BUFFER_OVERRUN 0
45
Benoît Ganne9fb6d402019-04-15 15:28:21 +020046CLIB_NOSANITIZE_ADDR static inline void *
Florin Coras8d820852019-11-27 09:15:25 -080047vl_msg_api_alloc_internal (svm_region_t * vlib_rp, int nbytes, int pool,
48 int may_return_null)
Ed Warnickecb9cada2015-12-08 15:45:58 -070049{
Dave Barach371e4e12016-07-08 09:38:52 -040050 int i;
51 msgbuf_t *rv;
52 ring_alloc_t *ap;
Florin Corase86a8ed2018-01-05 03:20:25 -080053 svm_queue_t *q;
Dave Barach371e4e12016-07-08 09:38:52 -040054 void *oldheap;
55 vl_shmem_hdr_t *shmem_hdr;
Dave Barach39d69112019-11-27 11:42:13 -050056 api_main_t *am = vlibapi_get_main ();
Ed Warnickecb9cada2015-12-08 15:45:58 -070057
Florin Coras8d820852019-11-27 09:15:25 -080058 shmem_hdr = (void *) vlib_rp->user_ctx;
Ed Warnickecb9cada2015-12-08 15:45:58 -070059
Dave Barach59b25652017-09-10 15:04:27 -040060#if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
61 nbytes += 4;
62#endif
63
Florin Coras7a2e1bd2017-11-30 16:07:39 -050064 ASSERT (pool == 0 || vlib_get_thread_index () == 0);
65
Dave Barach371e4e12016-07-08 09:38:52 -040066 if (shmem_hdr == 0)
67 {
68 clib_warning ("shared memory header NULL");
69 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -070070 }
71
Dave Barach371e4e12016-07-08 09:38:52 -040072 /* account for the msgbuf_t header */
73 nbytes += sizeof (msgbuf_t);
Ed Warnickecb9cada2015-12-08 15:45:58 -070074
Dave Barach371e4e12016-07-08 09:38:52 -040075 if (shmem_hdr->vl_rings == 0)
76 {
77 clib_warning ("vl_rings NULL");
Dave Barach77378332016-10-13 17:35:09 -040078 ASSERT (0);
79 abort ();
Ed Warnickecb9cada2015-12-08 15:45:58 -070080 }
81
Dave Barach371e4e12016-07-08 09:38:52 -040082 if (shmem_hdr->client_rings == 0)
83 {
84 clib_warning ("client_rings NULL");
Dave Barach77378332016-10-13 17:35:09 -040085 ASSERT (0);
86 abort ();
Ed Warnickecb9cada2015-12-08 15:45:58 -070087 }
88
Dave Barach371e4e12016-07-08 09:38:52 -040089 ap = pool ? shmem_hdr->vl_rings : shmem_hdr->client_rings;
90 for (i = 0; i < vec_len (ap); i++)
91 {
92 /* Too big? */
93 if (nbytes > ap[i].size)
94 {
95 continue;
96 }
Ed Warnickecb9cada2015-12-08 15:45:58 -070097
Dave Barach371e4e12016-07-08 09:38:52 -040098 q = ap[i].rp;
99 if (pool == 0)
100 {
101 pthread_mutex_lock (&q->mutex);
102 }
103 rv = (msgbuf_t *) (&q->data[0] + q->head * q->elsize);
104 /*
105 * Is this item still in use?
106 */
107 if (rv->q)
108 {
Dave Barach842b9c52017-01-09 15:54:00 -0500109 u32 now = (u32) time (0);
110
111 if (PREDICT_TRUE (rv->gc_mark_timestamp == 0))
112 rv->gc_mark_timestamp = now;
113 else
114 {
115 if (now - rv->gc_mark_timestamp > 10)
116 {
117 if (CLIB_DEBUG > 0)
Dave Barach10d8cc62017-05-30 09:30:07 -0400118 {
119 u16 *msg_idp, msg_id;
120 clib_warning
121 ("garbage collect pool %d ring %d index %d", pool, i,
122 q->head);
123 msg_idp = (u16 *) (rv->data);
124 msg_id = clib_net_to_host_u16 (*msg_idp);
Dave Barach39d69112019-11-27 11:42:13 -0500125 if (msg_id < vec_len (vlibapi_get_main ()->msg_names))
Dave Barach10d8cc62017-05-30 09:30:07 -0400126 clib_warning ("msg id %d name %s", (u32) msg_id,
Dave Barach39d69112019-11-27 11:42:13 -0500127 vlibapi_get_main ()->msg_names[msg_id]);
Dave Barach10d8cc62017-05-30 09:30:07 -0400128 }
Dave Barach842b9c52017-01-09 15:54:00 -0500129 shmem_hdr->garbage_collects++;
130 goto collected;
131 }
132 }
133
134
Dave Barach371e4e12016-07-08 09:38:52 -0400135 /* yes, loser; try next larger pool */
136 ap[i].misses++;
137 if (pool == 0)
138 pthread_mutex_unlock (&q->mutex);
139 continue;
140 }
Dave Barach842b9c52017-01-09 15:54:00 -0500141 collected:
142
Dave Barach371e4e12016-07-08 09:38:52 -0400143 /* OK, we have a winner */
144 ap[i].hits++;
145 /*
146 * Remember the source queue, although we
147 * don't need to know the queue to free the item.
148 */
149 rv->q = q;
Dave Barach842b9c52017-01-09 15:54:00 -0500150 rv->gc_mark_timestamp = 0;
Dave Barach371e4e12016-07-08 09:38:52 -0400151 q->head++;
152 if (q->head == q->maxsize)
153 q->head = 0;
154
155 if (pool == 0)
156 pthread_mutex_unlock (&q->mutex);
157 goto out;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700158 }
159
Dave Barach371e4e12016-07-08 09:38:52 -0400160 /*
161 * Request too big, or head element of all size-compatible rings
162 * still in use. Fall back to shared-memory malloc.
163 */
164 am->ring_misses++;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700165
Nathan Skrzypczak0aa40132019-11-25 16:29:38 +0100166 oldheap = vl_msg_push_heap_w_region (vlib_rp);
Dave Barach77378332016-10-13 17:35:09 -0400167 if (may_return_null)
168 {
169 rv = clib_mem_alloc_or_null (nbytes);
170 if (PREDICT_FALSE (rv == 0))
171 {
Nathan Skrzypczak0aa40132019-11-25 16:29:38 +0100172 vl_msg_pop_heap_w_region (vlib_rp, oldheap);
Dave Barach77378332016-10-13 17:35:09 -0400173 return 0;
174 }
175 }
176 else
177 rv = clib_mem_alloc (nbytes);
178
Dave Barach371e4e12016-07-08 09:38:52 -0400179 rv->q = 0;
Brian Nesbitt194212c2019-01-22 14:47:53 +0000180 rv->gc_mark_timestamp = 0;
Nathan Skrzypczak0aa40132019-11-25 16:29:38 +0100181 vl_msg_pop_heap_w_region (vlib_rp, oldheap);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700182
Dave Barach371e4e12016-07-08 09:38:52 -0400183out:
Dave Barach59b25652017-09-10 15:04:27 -0400184#if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
185 {
186 nbytes -= 4;
187 u32 *overrun;
188 overrun = (u32 *) (rv->data + nbytes - sizeof (msgbuf_t));
189 *overrun = 0x1badbabe;
190 }
191#endif
Dave Barach371e4e12016-07-08 09:38:52 -0400192 rv->data_len = htonl (nbytes - sizeof (msgbuf_t));
Dave Barach59b25652017-09-10 15:04:27 -0400193
Benoît Ganne9fb6d402019-04-15 15:28:21 +0200194 VL_MSG_API_UNPOISON (rv->data);
Dave Barach371e4e12016-07-08 09:38:52 -0400195 return (rv->data);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700196}
197
Dave Barach371e4e12016-07-08 09:38:52 -0400198void *
199vl_msg_api_alloc (int nbytes)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700200{
Dave Barach371e4e12016-07-08 09:38:52 -0400201 int pool;
Dave Barach39d69112019-11-27 11:42:13 -0500202 api_main_t *am = vlibapi_get_main ();
Dave Barach371e4e12016-07-08 09:38:52 -0400203 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700204
Dave Barach371e4e12016-07-08 09:38:52 -0400205 /*
206 * Clients use pool-0, vlib proc uses pool 1
207 */
208 pool = (am->our_pid == shmem_hdr->vl_pid);
Florin Coras8d820852019-11-27 09:15:25 -0800209 return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, pool,
210 0 /* may_return_null */ );
Dave Barach77378332016-10-13 17:35:09 -0400211}
212
213void *
Vratko Polakfc4828c2019-07-02 11:07:24 +0200214vl_msg_api_alloc_zero (int nbytes)
215{
216 void *ret;
217
218 ret = vl_msg_api_alloc (nbytes);
219 clib_memset (ret, 0, nbytes);
220 return ret;
221}
222
223void *
Dave Barach77378332016-10-13 17:35:09 -0400224vl_msg_api_alloc_or_null (int nbytes)
225{
226 int pool;
Dave Barach39d69112019-11-27 11:42:13 -0500227 api_main_t *am = vlibapi_get_main ();
Dave Barach77378332016-10-13 17:35:09 -0400228 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
229
230 pool = (am->our_pid == shmem_hdr->vl_pid);
Florin Coras8d820852019-11-27 09:15:25 -0800231 return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, pool,
232 1 /* may_return_null */ );
Ed Warnickecb9cada2015-12-08 15:45:58 -0700233}
234
Dave Barach371e4e12016-07-08 09:38:52 -0400235void *
236vl_msg_api_alloc_as_if_client (int nbytes)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700237{
Dave Barach39d69112019-11-27 11:42:13 -0500238 api_main_t *am = vlibapi_get_main ();
239 return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, 0,
Florin Coras8d820852019-11-27 09:15:25 -0800240 0 /* may_return_null */ );
Dave Barach77378332016-10-13 17:35:09 -0400241}
242
243void *
Vratko Polakfc4828c2019-07-02 11:07:24 +0200244vl_msg_api_alloc_zero_as_if_client (int nbytes)
245{
246 void *ret;
247
248 ret = vl_msg_api_alloc_as_if_client (nbytes);
249 clib_memset (ret, 0, nbytes);
250 return ret;
251}
252
253void *
Dave Barach77378332016-10-13 17:35:09 -0400254vl_msg_api_alloc_as_if_client_or_null (int nbytes)
255{
Dave Barach39d69112019-11-27 11:42:13 -0500256 api_main_t *am = vlibapi_get_main ();
257 return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, 0,
Florin Coras8d820852019-11-27 09:15:25 -0800258 1 /* may_return_null */ );
Ed Warnickecb9cada2015-12-08 15:45:58 -0700259}
260
Florin Corasb384b542018-01-15 01:08:33 -0800261void *
262vl_mem_api_alloc_as_if_client_w_reg (vl_api_registration_t * reg, int nbytes)
263{
Florin Coras8d820852019-11-27 09:15:25 -0800264 return vl_msg_api_alloc_internal (reg->vlib_rp, nbytes, 0,
265 0 /* may_return_null */ );
Florin Corasb384b542018-01-15 01:08:33 -0800266}
267
Dave Barach371e4e12016-07-08 09:38:52 -0400268void
Florin Coras8d820852019-11-27 09:15:25 -0800269vl_msg_api_free_w_region (svm_region_t * vlib_rp, void *a)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700270{
Dave Barach371e4e12016-07-08 09:38:52 -0400271 msgbuf_t *rv;
272 void *oldheap;
Ole Troan6855f6c2016-04-09 03:16:30 +0200273
Dave Barach371e4e12016-07-08 09:38:52 -0400274 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
275
276 /*
277 * Here's the beauty of the scheme. Only one proc/thread has
278 * control of a given message buffer. To free a buffer, we just clear the
279 * queue field, and leave. No locks, no hits, no errors...
280 */
281 if (rv->q)
282 {
283 rv->q = 0;
Dave Barach842b9c52017-01-09 15:54:00 -0500284 rv->gc_mark_timestamp = 0;
Dave Barach59b25652017-09-10 15:04:27 -0400285#if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
286 {
287 u32 *overrun;
288 overrun = (u32 *) (rv->data + ntohl (rv->data_len));
289 ASSERT (*overrun == 0x1badbabe);
290 }
291#endif
Benoît Ganne9fb6d402019-04-15 15:28:21 +0200292 VL_MSG_API_POISON (rv->data);
Dave Barach371e4e12016-07-08 09:38:52 -0400293 return;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700294 }
295
Nathan Skrzypczak0aa40132019-11-25 16:29:38 +0100296 oldheap = vl_msg_push_heap_w_region (vlib_rp);
Dave Barach59b25652017-09-10 15:04:27 -0400297
298#if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
299 {
300 u32 *overrun;
301 overrun = (u32 *) (rv->data + ntohl (rv->data_len));
302 ASSERT (*overrun == 0x1badbabe);
303 }
304#endif
305
Dave Barach371e4e12016-07-08 09:38:52 -0400306 clib_mem_free (rv);
Nathan Skrzypczak0aa40132019-11-25 16:29:38 +0100307 vl_msg_pop_heap_w_region (vlib_rp, oldheap);
Florin Coras8d820852019-11-27 09:15:25 -0800308}
309
310void
311vl_msg_api_free (void *a)
312{
Dave Barach39d69112019-11-27 11:42:13 -0500313 api_main_t *am = vlibapi_get_main ();
314 vl_msg_api_free_w_region (am->vlib_rp, a);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700315}
316
Dave Barach371e4e12016-07-08 09:38:52 -0400317static void
318vl_msg_api_free_nolock (void *a)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700319{
Dave Barach371e4e12016-07-08 09:38:52 -0400320 msgbuf_t *rv;
321 void *oldheap;
Dave Barach39d69112019-11-27 11:42:13 -0500322 api_main_t *am = vlibapi_get_main ();
Dave Barach371e4e12016-07-08 09:38:52 -0400323
324 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
325 /*
326 * Here's the beauty of the scheme. Only one proc/thread has
327 * control of a given message buffer. To free a buffer, we just clear the
328 * queue field, and leave. No locks, no hits, no errors...
329 */
330 if (rv->q)
331 {
332 rv->q = 0;
Benoît Ganne9fb6d402019-04-15 15:28:21 +0200333 VL_MSG_API_POISON (rv->data);
Dave Barach371e4e12016-07-08 09:38:52 -0400334 return;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700335 }
336
Dave Barach371e4e12016-07-08 09:38:52 -0400337 oldheap = svm_push_data_heap (am->vlib_rp);
338 clib_mem_free (rv);
339 svm_pop_heap (oldheap);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700340}
341
Dave Barach371e4e12016-07-08 09:38:52 -0400342void
Neale Rannse72be392017-04-26 13:59:20 -0700343vl_set_memory_root_path (const char *name)
Dave Barach309bef22016-01-22 16:09:52 -0500344{
Dave Barach39d69112019-11-27 11:42:13 -0500345 api_main_t *am = vlibapi_get_main ();
Dave Barach309bef22016-01-22 16:09:52 -0500346
Dave Barach371e4e12016-07-08 09:38:52 -0400347 am->root_path = name;
Dave Barach309bef22016-01-22 16:09:52 -0500348}
349
Dave Barach371e4e12016-07-08 09:38:52 -0400350void
351vl_set_memory_uid (int uid)
Dave Barach16c75df2016-05-31 14:05:46 -0400352{
Dave Barach39d69112019-11-27 11:42:13 -0500353 api_main_t *am = vlibapi_get_main ();
Dave Barach16c75df2016-05-31 14:05:46 -0400354
Dave Barach371e4e12016-07-08 09:38:52 -0400355 am->api_uid = uid;
Dave Barach16c75df2016-05-31 14:05:46 -0400356}
357
Dave Barach371e4e12016-07-08 09:38:52 -0400358void
359vl_set_memory_gid (int gid)
Dave Barach16c75df2016-05-31 14:05:46 -0400360{
Dave Barach39d69112019-11-27 11:42:13 -0500361 api_main_t *am = vlibapi_get_main ();
Dave Barach16c75df2016-05-31 14:05:46 -0400362
Dave Barach371e4e12016-07-08 09:38:52 -0400363 am->api_gid = gid;
Dave Barach16c75df2016-05-31 14:05:46 -0400364}
365
Dave Barachb3d93da2016-08-03 14:34:38 -0400366void
367vl_set_global_memory_baseva (u64 baseva)
368{
Dave Barach39d69112019-11-27 11:42:13 -0500369 api_main_t *am = vlibapi_get_main ();
Dave Barachb3d93da2016-08-03 14:34:38 -0400370
371 am->global_baseva = baseva;
372}
373
374void
375vl_set_global_memory_size (u64 size)
376{
Dave Barach39d69112019-11-27 11:42:13 -0500377 api_main_t *am = vlibapi_get_main ();
Dave Barachb3d93da2016-08-03 14:34:38 -0400378
379 am->global_size = size;
380}
381
382void
383vl_set_api_memory_size (u64 size)
384{
Dave Barach39d69112019-11-27 11:42:13 -0500385 api_main_t *am = vlibapi_get_main ();
Dave Barachb3d93da2016-08-03 14:34:38 -0400386
387 am->api_size = size;
388}
389
390void
391vl_set_global_pvt_heap_size (u64 size)
392{
Dave Barach39d69112019-11-27 11:42:13 -0500393 api_main_t *am = vlibapi_get_main ();
Dave Barachb3d93da2016-08-03 14:34:38 -0400394
395 am->global_pvt_heap_size = size;
396}
397
398void
399vl_set_api_pvt_heap_size (u64 size)
400{
Dave Barach39d69112019-11-27 11:42:13 -0500401 api_main_t *am = vlibapi_get_main ();
Dave Barachb3d93da2016-08-03 14:34:38 -0400402
403 am->api_pvt_heap_size = size;
404}
405
Florin Coras90a63982017-12-19 04:50:01 -0800406static void
407vl_api_default_mem_config (vl_shmem_hdr_t * shmem_hdr)
Dave Barach59b25652017-09-10 15:04:27 -0400408{
Dave Barach39d69112019-11-27 11:42:13 -0500409 api_main_t *am = vlibapi_get_main ();
Dave Barach59b25652017-09-10 15:04:27 -0400410 u32 vlib_input_queue_length;
Dave Barach59b25652017-09-10 15:04:27 -0400411
412 /* vlib main input queue */
413 vlib_input_queue_length = 1024;
414 if (am->vlib_input_queue_length)
415 vlib_input_queue_length = am->vlib_input_queue_length;
416
417 shmem_hdr->vl_input_queue =
Florin Corasc470e222018-08-01 07:53:18 -0700418 svm_queue_alloc_and_init (vlib_input_queue_length, sizeof (uword),
419 getpid ());
Dave Barach59b25652017-09-10 15:04:27 -0400420
Dave Barach59b25652017-09-10 15:04:27 -0400421#define _(sz,n) \
422 do { \
423 ring_alloc_t _rp; \
Florin Corasc470e222018-08-01 07:53:18 -0700424 _rp.rp = svm_queue_alloc_and_init ((n), (sz), 0); \
Dave Barach59b25652017-09-10 15:04:27 -0400425 _rp.size = (sz); \
426 _rp.nitems = n; \
427 _rp.hits = 0; \
428 _rp.misses = 0; \
429 vec_add1(shmem_hdr->vl_rings, _rp); \
430 } while (0);
431
432 foreach_vl_aring_size;
433#undef _
434
435#define _(sz,n) \
436 do { \
437 ring_alloc_t _rp; \
Florin Corasc470e222018-08-01 07:53:18 -0700438 _rp.rp = svm_queue_alloc_and_init ((n), (sz), 0); \
Dave Barach59b25652017-09-10 15:04:27 -0400439 _rp.size = (sz); \
440 _rp.nitems = n; \
441 _rp.hits = 0; \
442 _rp.misses = 0; \
443 vec_add1(shmem_hdr->client_rings, _rp); \
444 } while (0);
445
446 foreach_clnt_aring_size;
447#undef _
Florin Coras90a63982017-12-19 04:50:01 -0800448}
449
450void
451vl_api_mem_config (vl_shmem_hdr_t * hdr, vl_api_shm_elem_config_t * config)
452{
Florin Coras90a63982017-12-19 04:50:01 -0800453 vl_api_shm_elem_config_t *c;
454 ring_alloc_t *rp;
455 u32 size;
456
457 if (!config)
458 {
459 vl_api_default_mem_config (hdr);
460 return;
461 }
462
463 vec_foreach (c, config)
464 {
465 switch (c->type)
466 {
467 case VL_API_QUEUE:
Florin Corasc470e222018-08-01 07:53:18 -0700468 hdr->vl_input_queue = svm_queue_alloc_and_init (c->count, c->size,
469 getpid ());
Florin Coras90a63982017-12-19 04:50:01 -0800470 continue;
471 case VL_API_VLIB_RING:
472 vec_add2 (hdr->vl_rings, rp, 1);
473 break;
474 case VL_API_CLIENT_RING:
475 vec_add2 (hdr->client_rings, rp, 1);
476 break;
477 default:
478 clib_warning ("unknown config type: %d", c->type);
479 continue;
480 }
481
482 size = sizeof (ring_alloc_t) + c->size;
Florin Corasc470e222018-08-01 07:53:18 -0700483 rp->rp = svm_queue_alloc_and_init (c->count, size, 0);
Florin Coras90a63982017-12-19 04:50:01 -0800484 rp->size = size;
485 rp->nitems = c->count;
486 rp->hits = 0;
487 rp->misses = 0;
488 }
489}
490
491void
492vl_init_shmem (svm_region_t * vlib_rp, vl_api_shm_elem_config_t * config,
493 int is_vlib, int is_private_region)
494{
Dave Barach39d69112019-11-27 11:42:13 -0500495 api_main_t *am = vlibapi_get_main ();
Florin Coras90a63982017-12-19 04:50:01 -0800496 vl_shmem_hdr_t *shmem_hdr = 0;
497 void *oldheap;
498 ASSERT (vlib_rp);
499
500 /* $$$$ need private region config parameters */
501
502 oldheap = svm_push_data_heap (vlib_rp);
503
504 vec_validate (shmem_hdr, 0);
505 shmem_hdr->version = VL_SHM_VERSION;
Florin Corasb384b542018-01-15 01:08:33 -0800506 shmem_hdr->clib_file_index = VL_API_INVALID_FI;
Florin Coras90a63982017-12-19 04:50:01 -0800507
508 /* Set up the queue and msg ring allocator */
509 vl_api_mem_config (shmem_hdr, config);
Dave Barach59b25652017-09-10 15:04:27 -0400510
511 if (is_private_region == 0)
512 {
513 am->shmem_hdr = shmem_hdr;
514 am->vlib_rp = vlib_rp;
515 am->our_pid = getpid ();
516 if (is_vlib)
517 am->shmem_hdr->vl_pid = am->our_pid;
518 }
519 else
520 shmem_hdr->vl_pid = am->our_pid;
521
522 svm_pop_heap (oldheap);
523
524 /*
525 * After absolutely everything that a client might see is set up,
526 * declare the shmem region valid
527 */
528 vlib_rp->user_ctx = shmem_hdr;
529
530 pthread_mutex_unlock (&vlib_rp->mutex);
531}
532
Dave Barach371e4e12016-07-08 09:38:52 -0400533int
Neale Rannse72be392017-04-26 13:59:20 -0700534vl_map_shmem (const char *region_name, int is_vlib)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700535{
Dave Barach371e4e12016-07-08 09:38:52 -0400536 svm_map_region_args_t _a, *a = &_a;
537 svm_region_t *vlib_rp, *root_rp;
Dave Barach39d69112019-11-27 11:42:13 -0500538 api_main_t *am = vlibapi_get_main ();
Neale Ranns30307af2019-02-19 00:41:22 -0800539 int i;
Dave Barach371e4e12016-07-08 09:38:52 -0400540 struct timespec ts, tsrem;
Dave Wallacecfc997e2017-08-22 18:32:34 -0400541 char *vpe_api_region_suffix = "-vpe-api";
Ed Warnickecb9cada2015-12-08 15:45:58 -0700542
Dave Barachb7b92992018-10-17 10:38:51 -0400543 clib_memset (a, 0, sizeof (*a));
Jan Srnicek5beec812017-03-24 10:18:11 +0100544
Dave Wallacecfc997e2017-08-22 18:32:34 -0400545 if (strstr (region_name, vpe_api_region_suffix))
Jan Srnicek5beec812017-03-24 10:18:11 +0100546 {
Dave Wallacecfc997e2017-08-22 18:32:34 -0400547 u8 *root_path = format (0, "%s", region_name);
Damjan Marion8bea5892022-04-04 22:40:45 +0200548 vec_set_len (root_path,
549 vec_len (root_path) - strlen (vpe_api_region_suffix));
Dave Wallacecfc997e2017-08-22 18:32:34 -0400550 vec_terminate_c_string (root_path);
551 a->root_path = (const char *) root_path;
552 am->root_path = (const char *) root_path;
Jan Srnicek5beec812017-03-24 10:18:11 +0100553 }
554
Dave Barach371e4e12016-07-08 09:38:52 -0400555 if (is_vlib == 0)
Ole Troan3cdc25f2017-08-17 11:07:33 +0200556 {
Dave Barach22af4472018-12-27 13:57:41 -0500557 int tfd;
558 u8 *api_name;
559 /*
560 * Clients wait for vpp to set up the root / API regioins
561 */
562 if (am->root_path)
563 api_name = format (0, "/dev/shm/%s-%s%c", am->root_path,
564 region_name + 1, 0);
565 else
566 api_name = format (0, "/dev/shm%s%c", region_name, 0);
567
568 /* Wait up to 100 seconds... */
569 for (i = 0; i < 10000; i++)
570 {
571 ts.tv_sec = 0;
572 ts.tv_nsec = 10000 * 1000; /* 10 ms */
573 while (nanosleep (&ts, &tsrem) < 0)
574 ts = tsrem;
575 tfd = open ((char *) api_name, O_RDWR);
Steven Luong89053472019-03-05 20:07:31 -0800576 if (tfd >= 0)
Dave Barach22af4472018-12-27 13:57:41 -0500577 break;
578 }
579 vec_free (api_name);
580 if (tfd < 0)
581 {
582 clib_warning ("region init fail");
583 return -2;
584 }
585 close (tfd);
Neale Ranns30307af2019-02-19 00:41:22 -0800586 svm_region_init_chroot_uid_gid (am->root_path, getuid (), getgid ());
Ole Troan3cdc25f2017-08-17 11:07:33 +0200587 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700588
Jan Srnicek5beec812017-03-24 10:18:11 +0100589 if (a->root_path != NULL)
590 {
591 a->name = "/vpe-api";
592 }
593 else
594 a->name = region_name;
Dave Barachc3799992016-08-15 11:12:27 -0400595 a->size = am->api_size ? am->api_size : (16 << 20);
Dave Barach371e4e12016-07-08 09:38:52 -0400596 a->flags = SVM_FLAGS_MHEAP;
597 a->uid = am->api_uid;
598 a->gid = am->api_gid;
Dave Barachb3d93da2016-08-03 14:34:38 -0400599 a->pvt_heap_size = am->api_pvt_heap_size;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700600
Dave Barach371e4e12016-07-08 09:38:52 -0400601 vlib_rp = svm_region_find_or_create (a);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700602
Dave Barach371e4e12016-07-08 09:38:52 -0400603 if (vlib_rp == 0)
604 return (-2);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700605
Dave Barach371e4e12016-07-08 09:38:52 -0400606 pthread_mutex_lock (&vlib_rp->mutex);
607 /* Has someone else set up the shared-memory variable table? */
608 if (vlib_rp->user_ctx)
609 {
610 am->shmem_hdr = (void *) vlib_rp->user_ctx;
611 am->our_pid = getpid ();
612 if (is_vlib)
613 {
Florin Corase86a8ed2018-01-05 03:20:25 -0800614 svm_queue_t *q;
Dave Barach371e4e12016-07-08 09:38:52 -0400615 uword old_msg;
616 /*
617 * application restart. Reset cached pids, API message
618 * rings, list of clients; otherwise, various things
619 * fail. (e.g. queue non-empty notification)
620 */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700621
Dave Barach371e4e12016-07-08 09:38:52 -0400622 /* ghosts keep the region from disappearing properly */
623 svm_client_scan_this_region_nolock (vlib_rp);
624 am->shmem_hdr->application_restarts++;
625 q = am->shmem_hdr->vl_input_queue;
626 am->shmem_hdr->vl_pid = getpid ();
627 q->consumer_pid = am->shmem_hdr->vl_pid;
628 /* Drain the input queue, freeing msgs */
629 for (i = 0; i < 10; i++)
630 {
631 if (pthread_mutex_trylock (&q->mutex) == 0)
632 {
633 pthread_mutex_unlock (&q->mutex);
634 goto mutex_ok;
635 }
636 ts.tv_sec = 0;
637 ts.tv_nsec = 10000 * 1000; /* 10 ms */
638 while (nanosleep (&ts, &tsrem) < 0)
639 ts = tsrem;
640 }
641 /* Mutex buggered, "fix" it */
Dave Barachb7b92992018-10-17 10:38:51 -0400642 clib_memset (&q->mutex, 0, sizeof (q->mutex));
Dave Barach371e4e12016-07-08 09:38:52 -0400643 clib_warning ("forcibly release main input queue mutex");
644
645 mutex_ok:
646 am->vlib_rp = vlib_rp;
Mohsin Kazmi3fca5672018-01-04 18:57:26 +0100647 while (svm_queue_sub (q, (u8 *) & old_msg, SVM_Q_NOWAIT, 0)
Dave Barach371e4e12016-07-08 09:38:52 -0400648 != -2 /* queue underflow */ )
649 {
650 vl_msg_api_free_nolock ((void *) old_msg);
651 am->shmem_hdr->restart_reclaims++;
652 }
653 pthread_mutex_unlock (&vlib_rp->mutex);
654 root_rp = svm_get_root_rp ();
655 ASSERT (root_rp);
656 /* Clean up the root region client list */
657 pthread_mutex_lock (&root_rp->mutex);
658 svm_client_scan_this_region_nolock (root_rp);
659 pthread_mutex_unlock (&root_rp->mutex);
660 }
661 else
662 {
663 pthread_mutex_unlock (&vlib_rp->mutex);
664 }
665 am->vlib_rp = vlib_rp;
666 vec_add1 (am->mapped_shmem_regions, vlib_rp);
667 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700668 }
Dave Barach371e4e12016-07-08 09:38:52 -0400669 /* Clients simply have to wait... */
670 if (!is_vlib)
671 {
672 pthread_mutex_unlock (&vlib_rp->mutex);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700673
Dave Barach371e4e12016-07-08 09:38:52 -0400674 /* Wait up to 100 seconds... */
675 for (i = 0; i < 10000; i++)
676 {
677 ts.tv_sec = 0;
678 ts.tv_nsec = 10000 * 1000; /* 10 ms */
679 while (nanosleep (&ts, &tsrem) < 0)
680 ts = tsrem;
681 if (vlib_rp->user_ctx)
682 goto ready;
683 }
684 /* Clean up and leave... */
685 svm_region_unmap (vlib_rp);
686 clib_warning ("region init fail");
687 return (-2);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700688
689 ready:
Dave Barach371e4e12016-07-08 09:38:52 -0400690 am->shmem_hdr = (void *) vlib_rp->user_ctx;
691 am->our_pid = getpid ();
692 am->vlib_rp = vlib_rp;
693 vec_add1 (am->mapped_shmem_regions, vlib_rp);
694 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700695 }
696
Dave Barach371e4e12016-07-08 09:38:52 -0400697 /* Nope, it's our problem... */
Florin Coras90a63982017-12-19 04:50:01 -0800698 vl_init_shmem (vlib_rp, 0 /* default config */ , 1 /* is vlib */ ,
699 0 /* is_private_region */ );
Ed Warnickecb9cada2015-12-08 15:45:58 -0700700
Dave Barach371e4e12016-07-08 09:38:52 -0400701 vec_add1 (am->mapped_shmem_regions, vlib_rp);
702 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700703}
704
Dave Barach371e4e12016-07-08 09:38:52 -0400705void
706vl_register_mapped_shmem_region (svm_region_t * rp)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700707{
Dave Barach39d69112019-11-27 11:42:13 -0500708 api_main_t *am = vlibapi_get_main ();
Ed Warnickecb9cada2015-12-08 15:45:58 -0700709
Dave Barach371e4e12016-07-08 09:38:52 -0400710 vec_add1 (am->mapped_shmem_regions, rp);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700711}
712
Florin Corasd6c30d92018-01-29 05:11:24 -0800713static void
714vl_unmap_shmem_internal (u8 is_client)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700715{
Dave Barach371e4e12016-07-08 09:38:52 -0400716 svm_region_t *rp;
717 int i;
Dave Barach39d69112019-11-27 11:42:13 -0500718 api_main_t *am = vlibapi_get_main ();
Ed Warnickecb9cada2015-12-08 15:45:58 -0700719
Dave Barach371e4e12016-07-08 09:38:52 -0400720 if (!svm_get_root_rp ())
721 return;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700722
Dave Barach371e4e12016-07-08 09:38:52 -0400723 for (i = 0; i < vec_len (am->mapped_shmem_regions); i++)
724 {
725 rp = am->mapped_shmem_regions[i];
Florin Corasd6c30d92018-01-29 05:11:24 -0800726 is_client ? svm_region_unmap_client (rp) : svm_region_unmap (rp);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700727 }
728
Dave Barach371e4e12016-07-08 09:38:52 -0400729 vec_free (am->mapped_shmem_regions);
730 am->shmem_hdr = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700731
Florin Corasd6c30d92018-01-29 05:11:24 -0800732 is_client ? svm_region_exit_client () : svm_region_exit ();
733
Dave Barach371e4e12016-07-08 09:38:52 -0400734 /* $$$ more careful cleanup, valgrind run... */
735 vec_free (am->msg_handlers);
736 vec_free (am->msg_endian_handlers);
737 vec_free (am->msg_print_handlers);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700738}
739
Dave Barach371e4e12016-07-08 09:38:52 -0400740void
Florin Corasd6c30d92018-01-29 05:11:24 -0800741vl_unmap_shmem (void)
742{
743 vl_unmap_shmem_internal (0);
744}
745
746void
747vl_unmap_shmem_client (void)
748{
749 vl_unmap_shmem_internal (1);
750}
751
752void
Florin Corase86a8ed2018-01-05 03:20:25 -0800753vl_msg_api_send_shmem (svm_queue_t * q, u8 * elem)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700754{
Dave Barach39d69112019-11-27 11:42:13 -0500755 api_main_t *am = vlibapi_get_main ();
Benoît Ganne9fb6d402019-04-15 15:28:21 +0200756 void *msg = (void *) *(uword *) elem;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700757
Dave Barach371e4e12016-07-08 09:38:52 -0400758 if (am->tx_trace && am->tx_trace->enabled)
Benoît Ganne9fb6d402019-04-15 15:28:21 +0200759 vl_msg_api_trace (am, am->tx_trace, msg);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700760
Dave Barach0c4fec02018-11-18 12:03:48 -0500761 /*
762 * Announce a probable binary API client bug:
763 * some client's input queue is stuffed.
764 * The situation may be recoverable, or not.
765 */
766 if (PREDICT_FALSE
767 (am->vl_clients /* vpp side */ && (q->cursize == q->maxsize)))
Dave Barachb09f4d02019-07-15 16:00:03 -0400768 {
769 if (PREDICT_FALSE (am->elog_trace_api_messages))
770 {
771 /* *INDENT-OFF* */
772 ELOG_TYPE_DECLARE (e) =
773 {
774 .format = "api-client-queue-stuffed: %x%x",
775 .format_args = "i4i4",
776 };
777 /* *INDENT-ON* */
778 struct
779 {
780 u32 hi, low;
781 } *ed;
782 ed = ELOG_DATA (am->elog_main, e);
783 ed->hi = (uword) q >> 32;
784 ed->low = (uword) q & 0xFFFFFFFF;
785 clib_warning ("WARNING: client input queue at %llx is stuffed...",
786 q);
787 }
788 }
Benoît Ganne9fb6d402019-04-15 15:28:21 +0200789 VL_MSG_API_POISON (msg);
Florin Corase86a8ed2018-01-05 03:20:25 -0800790 (void) svm_queue_add (q, elem, 0 /* nowait */ );
Ed Warnickecb9cada2015-12-08 15:45:58 -0700791}
792
Florin Corasaf0ff5a2018-01-10 08:17:03 -0800793int
794vl_mem_api_can_send (svm_queue_t * q)
795{
796 return (q->cursize < q->maxsize);
797}
798
Dave Barach371e4e12016-07-08 09:38:52 -0400799void
Florin Corase86a8ed2018-01-05 03:20:25 -0800800vl_msg_api_send_shmem_nolock (svm_queue_t * q, u8 * elem)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700801{
Dave Barach39d69112019-11-27 11:42:13 -0500802 api_main_t *am = vlibapi_get_main ();
Benoît Ganne9fb6d402019-04-15 15:28:21 +0200803 void *msg = (void *) *(uword *) elem;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700804
Dave Barach371e4e12016-07-08 09:38:52 -0400805 if (am->tx_trace && am->tx_trace->enabled)
Benoît Ganne9fb6d402019-04-15 15:28:21 +0200806 vl_msg_api_trace (am, am->tx_trace, msg);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700807
Florin Corase86a8ed2018-01-05 03:20:25 -0800808 (void) svm_queue_add_nolock (q, elem);
Benoît Ganne9fb6d402019-04-15 15:28:21 +0200809 VL_MSG_API_POISON (msg);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700810}
811
Dave Barach371e4e12016-07-08 09:38:52 -0400812/*
813 * fd.io coding-style-patch-verification: ON
814 *
815 * Local Variables:
816 * eval: (c-set-style "gnu")
817 * End:
818 */