blob: c41f32f70f909f5518977cfa2b22df1de75da20a [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>
28#include <vppinfra/format.h>
29#include <vppinfra/byte_order.h>
30#include <vppinfra/error.h>
31#include <vlib/vlib.h>
32#include <vlib/unix/unix.h>
33#include <vlibmemory/api.h>
34#include <vlibmemory/unix_shared_memory_queue.h>
35
Dave Barach371e4e12016-07-08 09:38:52 -040036#include <vlibmemory/vl_memory_msg_enum.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070037
Dave Barach371e4e12016-07-08 09:38:52 -040038#define vl_typedefs
Ed Warnickecb9cada2015-12-08 15:45:58 -070039#include <vlibmemory/vl_memory_api_h.h>
40#undef vl_typedefs
41
Dave Barach371e4e12016-07-08 09:38:52 -040042static inline void *
Dave Barach77378332016-10-13 17:35:09 -040043vl_msg_api_alloc_internal (int nbytes, int pool, int may_return_null)
Ed Warnickecb9cada2015-12-08 15:45:58 -070044{
Dave Barach371e4e12016-07-08 09:38:52 -040045 int i;
46 msgbuf_t *rv;
47 ring_alloc_t *ap;
48 unix_shared_memory_queue_t *q;
49 void *oldheap;
50 vl_shmem_hdr_t *shmem_hdr;
51 api_main_t *am = &api_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -070052
Dave Barach371e4e12016-07-08 09:38:52 -040053 shmem_hdr = am->shmem_hdr;
Ed Warnickecb9cada2015-12-08 15:45:58 -070054
Dave Barach371e4e12016-07-08 09:38:52 -040055 if (shmem_hdr == 0)
56 {
57 clib_warning ("shared memory header NULL");
58 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -070059 }
60
Dave Barach371e4e12016-07-08 09:38:52 -040061 /* account for the msgbuf_t header */
62 nbytes += sizeof (msgbuf_t);
Ed Warnickecb9cada2015-12-08 15:45:58 -070063
Dave Barach371e4e12016-07-08 09:38:52 -040064 if (shmem_hdr->vl_rings == 0)
65 {
66 clib_warning ("vl_rings NULL");
Dave Barach77378332016-10-13 17:35:09 -040067 ASSERT (0);
68 abort ();
Ed Warnickecb9cada2015-12-08 15:45:58 -070069 }
70
Dave Barach371e4e12016-07-08 09:38:52 -040071 if (shmem_hdr->client_rings == 0)
72 {
73 clib_warning ("client_rings NULL");
Dave Barach77378332016-10-13 17:35:09 -040074 ASSERT (0);
75 abort ();
Ed Warnickecb9cada2015-12-08 15:45:58 -070076 }
77
Dave Barach371e4e12016-07-08 09:38:52 -040078 ap = pool ? shmem_hdr->vl_rings : shmem_hdr->client_rings;
79 for (i = 0; i < vec_len (ap); i++)
80 {
81 /* Too big? */
82 if (nbytes > ap[i].size)
83 {
84 continue;
85 }
Ed Warnickecb9cada2015-12-08 15:45:58 -070086
Dave Barach371e4e12016-07-08 09:38:52 -040087 q = ap[i].rp;
88 if (pool == 0)
89 {
90 pthread_mutex_lock (&q->mutex);
91 }
92 rv = (msgbuf_t *) (&q->data[0] + q->head * q->elsize);
93 /*
94 * Is this item still in use?
95 */
96 if (rv->q)
97 {
Dave Barach842b9c52017-01-09 15:54:00 -050098 u32 now = (u32) time (0);
99
100 if (PREDICT_TRUE (rv->gc_mark_timestamp == 0))
101 rv->gc_mark_timestamp = now;
102 else
103 {
104 if (now - rv->gc_mark_timestamp > 10)
105 {
106 if (CLIB_DEBUG > 0)
107 clib_warning ("garbage collect pool %d ring %d index %d",
108 pool, i, q->head);
109 shmem_hdr->garbage_collects++;
110 goto collected;
111 }
112 }
113
114
Dave Barach371e4e12016-07-08 09:38:52 -0400115 /* yes, loser; try next larger pool */
116 ap[i].misses++;
117 if (pool == 0)
118 pthread_mutex_unlock (&q->mutex);
119 continue;
120 }
Dave Barach842b9c52017-01-09 15:54:00 -0500121 collected:
122
Dave Barach371e4e12016-07-08 09:38:52 -0400123 /* OK, we have a winner */
124 ap[i].hits++;
125 /*
126 * Remember the source queue, although we
127 * don't need to know the queue to free the item.
128 */
129 rv->q = q;
Dave Barach842b9c52017-01-09 15:54:00 -0500130 rv->gc_mark_timestamp = 0;
Dave Barach371e4e12016-07-08 09:38:52 -0400131 q->head++;
132 if (q->head == q->maxsize)
133 q->head = 0;
134
135 if (pool == 0)
136 pthread_mutex_unlock (&q->mutex);
137 goto out;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700138 }
139
Dave Barach371e4e12016-07-08 09:38:52 -0400140 /*
141 * Request too big, or head element of all size-compatible rings
142 * still in use. Fall back to shared-memory malloc.
143 */
144 am->ring_misses++;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700145
Dave Barach371e4e12016-07-08 09:38:52 -0400146 pthread_mutex_lock (&am->vlib_rp->mutex);
147 oldheap = svm_push_data_heap (am->vlib_rp);
Dave Barach77378332016-10-13 17:35:09 -0400148 if (may_return_null)
149 {
150 rv = clib_mem_alloc_or_null (nbytes);
151 if (PREDICT_FALSE (rv == 0))
152 {
153 svm_pop_heap (oldheap);
154 pthread_mutex_unlock (&am->vlib_rp->mutex);
155 return 0;
156 }
157 }
158 else
159 rv = clib_mem_alloc (nbytes);
160
Dave Barach371e4e12016-07-08 09:38:52 -0400161 rv->q = 0;
162 svm_pop_heap (oldheap);
163 pthread_mutex_unlock (&am->vlib_rp->mutex);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700164
Dave Barach371e4e12016-07-08 09:38:52 -0400165out:
166 rv->data_len = htonl (nbytes - sizeof (msgbuf_t));
167 return (rv->data);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700168}
169
Dave Barach371e4e12016-07-08 09:38:52 -0400170void *
171vl_msg_api_alloc (int nbytes)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700172{
Dave Barach371e4e12016-07-08 09:38:52 -0400173 int pool;
174 api_main_t *am = &api_main;
175 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700176
Dave Barach371e4e12016-07-08 09:38:52 -0400177 /*
178 * Clients use pool-0, vlib proc uses pool 1
179 */
180 pool = (am->our_pid == shmem_hdr->vl_pid);
Dave Barach77378332016-10-13 17:35:09 -0400181 return vl_msg_api_alloc_internal (nbytes, pool, 0 /* may_return_null */ );
182}
183
184void *
185vl_msg_api_alloc_or_null (int nbytes)
186{
187 int pool;
188 api_main_t *am = &api_main;
189 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
190
191 pool = (am->our_pid == shmem_hdr->vl_pid);
192 return vl_msg_api_alloc_internal (nbytes, pool, 1 /* may_return_null */ );
Ed Warnickecb9cada2015-12-08 15:45:58 -0700193}
194
Dave Barach371e4e12016-07-08 09:38:52 -0400195void *
196vl_msg_api_alloc_as_if_client (int nbytes)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700197{
Dave Barach77378332016-10-13 17:35:09 -0400198 return vl_msg_api_alloc_internal (nbytes, 0, 0 /* may_return_null */ );
199}
200
201void *
202vl_msg_api_alloc_as_if_client_or_null (int nbytes)
203{
204 return vl_msg_api_alloc_internal (nbytes, 0, 1 /* may_return_null */ );
Ed Warnickecb9cada2015-12-08 15:45:58 -0700205}
206
Dave Barach371e4e12016-07-08 09:38:52 -0400207void
208vl_msg_api_free (void *a)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700209{
Dave Barach371e4e12016-07-08 09:38:52 -0400210 msgbuf_t *rv;
211 void *oldheap;
212 api_main_t *am = &api_main;
Ole Troan6855f6c2016-04-09 03:16:30 +0200213
Dave Barach371e4e12016-07-08 09:38:52 -0400214 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
215
216 /*
217 * Here's the beauty of the scheme. Only one proc/thread has
218 * control of a given message buffer. To free a buffer, we just clear the
219 * queue field, and leave. No locks, no hits, no errors...
220 */
221 if (rv->q)
222 {
223 rv->q = 0;
Dave Barach842b9c52017-01-09 15:54:00 -0500224 rv->gc_mark_timestamp = 0;
Dave Barach371e4e12016-07-08 09:38:52 -0400225 return;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700226 }
227
Dave Barach371e4e12016-07-08 09:38:52 -0400228 pthread_mutex_lock (&am->vlib_rp->mutex);
229 oldheap = svm_push_data_heap (am->vlib_rp);
230 clib_mem_free (rv);
231 svm_pop_heap (oldheap);
232 pthread_mutex_unlock (&am->vlib_rp->mutex);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700233}
234
Dave Barach371e4e12016-07-08 09:38:52 -0400235static void
236vl_msg_api_free_nolock (void *a)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700237{
Dave Barach371e4e12016-07-08 09:38:52 -0400238 msgbuf_t *rv;
239 void *oldheap;
240 api_main_t *am = &api_main;
241
242 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
243 /*
244 * Here's the beauty of the scheme. Only one proc/thread has
245 * control of a given message buffer. To free a buffer, we just clear the
246 * queue field, and leave. No locks, no hits, no errors...
247 */
248 if (rv->q)
249 {
250 rv->q = 0;
251 return;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700252 }
253
Dave Barach371e4e12016-07-08 09:38:52 -0400254 oldheap = svm_push_data_heap (am->vlib_rp);
255 clib_mem_free (rv);
256 svm_pop_heap (oldheap);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700257}
258
Dave Barach371e4e12016-07-08 09:38:52 -0400259void
260vl_set_memory_root_path (char *name)
Dave Barach309bef22016-01-22 16:09:52 -0500261{
Dave Barach371e4e12016-07-08 09:38:52 -0400262 api_main_t *am = &api_main;
Dave Barach309bef22016-01-22 16:09:52 -0500263
Dave Barach371e4e12016-07-08 09:38:52 -0400264 am->root_path = name;
Dave Barach309bef22016-01-22 16:09:52 -0500265}
266
Dave Barach371e4e12016-07-08 09:38:52 -0400267void
268vl_set_memory_uid (int uid)
Dave Barach16c75df2016-05-31 14:05:46 -0400269{
Dave Barach371e4e12016-07-08 09:38:52 -0400270 api_main_t *am = &api_main;
Dave Barach16c75df2016-05-31 14:05:46 -0400271
Dave Barach371e4e12016-07-08 09:38:52 -0400272 am->api_uid = uid;
Dave Barach16c75df2016-05-31 14:05:46 -0400273}
274
Dave Barach371e4e12016-07-08 09:38:52 -0400275void
276vl_set_memory_gid (int gid)
Dave Barach16c75df2016-05-31 14:05:46 -0400277{
Dave Barach371e4e12016-07-08 09:38:52 -0400278 api_main_t *am = &api_main;
Dave Barach16c75df2016-05-31 14:05:46 -0400279
Dave Barach371e4e12016-07-08 09:38:52 -0400280 am->api_gid = gid;
Dave Barach16c75df2016-05-31 14:05:46 -0400281}
282
Dave Barachb3d93da2016-08-03 14:34:38 -0400283void
284vl_set_global_memory_baseva (u64 baseva)
285{
286 api_main_t *am = &api_main;
287
288 am->global_baseva = baseva;
289}
290
291void
292vl_set_global_memory_size (u64 size)
293{
294 api_main_t *am = &api_main;
295
296 am->global_size = size;
297}
298
299void
300vl_set_api_memory_size (u64 size)
301{
302 api_main_t *am = &api_main;
303
304 am->api_size = size;
305}
306
307void
308vl_set_global_pvt_heap_size (u64 size)
309{
310 api_main_t *am = &api_main;
311
312 am->global_pvt_heap_size = size;
313}
314
315void
316vl_set_api_pvt_heap_size (u64 size)
317{
318 api_main_t *am = &api_main;
319
320 am->api_pvt_heap_size = size;
321}
322
Dave Barach371e4e12016-07-08 09:38:52 -0400323int
324vl_map_shmem (char *region_name, int is_vlib)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700325{
Dave Barach371e4e12016-07-08 09:38:52 -0400326 svm_map_region_args_t _a, *a = &_a;
327 svm_region_t *vlib_rp, *root_rp;
328 void *oldheap;
329 vl_shmem_hdr_t *shmem_hdr = 0;
330 api_main_t *am = &api_main;
331 int i;
332 struct timespec ts, tsrem;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700333
Dave Barach371e4e12016-07-08 09:38:52 -0400334 if (is_vlib == 0)
335 svm_region_init_chroot (am->root_path);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700336
Dave Barach371e4e12016-07-08 09:38:52 -0400337 memset (a, 0, sizeof (*a));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700338
Dave Barach371e4e12016-07-08 09:38:52 -0400339 a->name = region_name;
Dave Barachc3799992016-08-15 11:12:27 -0400340 a->size = am->api_size ? am->api_size : (16 << 20);
Dave Barach371e4e12016-07-08 09:38:52 -0400341 a->flags = SVM_FLAGS_MHEAP;
342 a->uid = am->api_uid;
343 a->gid = am->api_gid;
Dave Barachb3d93da2016-08-03 14:34:38 -0400344 a->pvt_heap_size = am->api_pvt_heap_size;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700345
Dave Barach371e4e12016-07-08 09:38:52 -0400346 vlib_rp = svm_region_find_or_create (a);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700347
Dave Barach371e4e12016-07-08 09:38:52 -0400348 if (vlib_rp == 0)
349 return (-2);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700350
Dave Barach371e4e12016-07-08 09:38:52 -0400351 pthread_mutex_lock (&vlib_rp->mutex);
352 /* Has someone else set up the shared-memory variable table? */
353 if (vlib_rp->user_ctx)
354 {
355 am->shmem_hdr = (void *) vlib_rp->user_ctx;
356 am->our_pid = getpid ();
357 if (is_vlib)
358 {
359 unix_shared_memory_queue_t *q;
360 uword old_msg;
361 /*
362 * application restart. Reset cached pids, API message
363 * rings, list of clients; otherwise, various things
364 * fail. (e.g. queue non-empty notification)
365 */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700366
Dave Barach371e4e12016-07-08 09:38:52 -0400367 /* ghosts keep the region from disappearing properly */
368 svm_client_scan_this_region_nolock (vlib_rp);
369 am->shmem_hdr->application_restarts++;
370 q = am->shmem_hdr->vl_input_queue;
371 am->shmem_hdr->vl_pid = getpid ();
372 q->consumer_pid = am->shmem_hdr->vl_pid;
373 /* Drain the input queue, freeing msgs */
374 for (i = 0; i < 10; i++)
375 {
376 if (pthread_mutex_trylock (&q->mutex) == 0)
377 {
378 pthread_mutex_unlock (&q->mutex);
379 goto mutex_ok;
380 }
381 ts.tv_sec = 0;
382 ts.tv_nsec = 10000 * 1000; /* 10 ms */
383 while (nanosleep (&ts, &tsrem) < 0)
384 ts = tsrem;
385 }
386 /* Mutex buggered, "fix" it */
387 memset (&q->mutex, 0, sizeof (q->mutex));
388 clib_warning ("forcibly release main input queue mutex");
389
390 mutex_ok:
391 am->vlib_rp = vlib_rp;
392 while (unix_shared_memory_queue_sub (q,
393 (u8 *) & old_msg,
394 1 /* nowait */ )
395 != -2 /* queue underflow */ )
396 {
397 vl_msg_api_free_nolock ((void *) old_msg);
398 am->shmem_hdr->restart_reclaims++;
399 }
400 pthread_mutex_unlock (&vlib_rp->mutex);
401 root_rp = svm_get_root_rp ();
402 ASSERT (root_rp);
403 /* Clean up the root region client list */
404 pthread_mutex_lock (&root_rp->mutex);
405 svm_client_scan_this_region_nolock (root_rp);
406 pthread_mutex_unlock (&root_rp->mutex);
407 }
408 else
409 {
410 pthread_mutex_unlock (&vlib_rp->mutex);
411 }
412 am->vlib_rp = vlib_rp;
413 vec_add1 (am->mapped_shmem_regions, vlib_rp);
414 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700415 }
Dave Barach371e4e12016-07-08 09:38:52 -0400416 /* Clients simply have to wait... */
417 if (!is_vlib)
418 {
419 pthread_mutex_unlock (&vlib_rp->mutex);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700420
Dave Barach371e4e12016-07-08 09:38:52 -0400421 /* Wait up to 100 seconds... */
422 for (i = 0; i < 10000; i++)
423 {
424 ts.tv_sec = 0;
425 ts.tv_nsec = 10000 * 1000; /* 10 ms */
426 while (nanosleep (&ts, &tsrem) < 0)
427 ts = tsrem;
428 if (vlib_rp->user_ctx)
429 goto ready;
430 }
431 /* Clean up and leave... */
432 svm_region_unmap (vlib_rp);
433 clib_warning ("region init fail");
434 return (-2);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700435
436 ready:
Dave Barach371e4e12016-07-08 09:38:52 -0400437 am->shmem_hdr = (void *) vlib_rp->user_ctx;
438 am->our_pid = getpid ();
439 am->vlib_rp = vlib_rp;
440 vec_add1 (am->mapped_shmem_regions, vlib_rp);
441 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700442 }
443
Dave Barach371e4e12016-07-08 09:38:52 -0400444 /* Nope, it's our problem... */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700445
Dave Barach371e4e12016-07-08 09:38:52 -0400446 oldheap = svm_push_data_heap (vlib_rp);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700447
Dave Barach371e4e12016-07-08 09:38:52 -0400448 vec_validate (shmem_hdr, 0);
449 shmem_hdr->version = VL_SHM_VERSION;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700450
Dave Barach371e4e12016-07-08 09:38:52 -0400451 /* vlib main input queue */
452 shmem_hdr->vl_input_queue =
453 unix_shared_memory_queue_init (1024, sizeof (uword), getpid (),
454 am->vlib_signal);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700455
Dave Barach371e4e12016-07-08 09:38:52 -0400456 /* Set up the msg ring allocator */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700457#define _(sz,n) \
458 do { \
459 ring_alloc_t _rp; \
460 _rp.rp = unix_shared_memory_queue_init ((n), (sz), 0, 0); \
461 _rp.size = (sz); \
462 _rp.nitems = n; \
463 _rp.hits = 0; \
464 _rp.misses = 0; \
465 vec_add1(shmem_hdr->vl_rings, _rp); \
466 } while (0);
467
Dave Barach371e4e12016-07-08 09:38:52 -0400468 foreach_vl_aring_size;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700469#undef _
470
471#define _(sz,n) \
472 do { \
473 ring_alloc_t _rp; \
474 _rp.rp = unix_shared_memory_queue_init ((n), (sz), 0, 0); \
475 _rp.size = (sz); \
476 _rp.nitems = n; \
477 _rp.hits = 0; \
478 _rp.misses = 0; \
479 vec_add1(shmem_hdr->client_rings, _rp); \
480 } while (0);
481
Dave Barach371e4e12016-07-08 09:38:52 -0400482 foreach_clnt_aring_size;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700483#undef _
484
Dave Barach371e4e12016-07-08 09:38:52 -0400485 am->shmem_hdr = shmem_hdr;
486 am->vlib_rp = vlib_rp;
487 am->our_pid = getpid ();
488 if (is_vlib)
489 am->shmem_hdr->vl_pid = am->our_pid;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700490
Dave Barach371e4e12016-07-08 09:38:52 -0400491 svm_pop_heap (oldheap);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700492
Dave Barach371e4e12016-07-08 09:38:52 -0400493 /*
494 * After absolutely everything that a client might see is set up,
495 * declare the shmem region valid
496 */
497 vlib_rp->user_ctx = shmem_hdr;
498
499 pthread_mutex_unlock (&vlib_rp->mutex);
500 vec_add1 (am->mapped_shmem_regions, vlib_rp);
501 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700502}
503
Dave Barach371e4e12016-07-08 09:38:52 -0400504void
505vl_register_mapped_shmem_region (svm_region_t * rp)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700506{
Dave Barach371e4e12016-07-08 09:38:52 -0400507 api_main_t *am = &api_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700508
Dave Barach371e4e12016-07-08 09:38:52 -0400509 vec_add1 (am->mapped_shmem_regions, rp);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700510}
511
Dave Barach371e4e12016-07-08 09:38:52 -0400512void
513vl_unmap_shmem (void)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700514{
Dave Barach371e4e12016-07-08 09:38:52 -0400515 svm_region_t *rp;
516 int i;
517 api_main_t *am = &api_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700518
Dave Barach371e4e12016-07-08 09:38:52 -0400519 if (!svm_get_root_rp ())
520 return;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700521
Dave Barach371e4e12016-07-08 09:38:52 -0400522 for (i = 0; i < vec_len (am->mapped_shmem_regions); i++)
523 {
524 rp = am->mapped_shmem_regions[i];
525 svm_region_unmap (rp);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700526 }
527
Dave Barach371e4e12016-07-08 09:38:52 -0400528 vec_free (am->mapped_shmem_regions);
529 am->shmem_hdr = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700530
Dave Barach371e4e12016-07-08 09:38:52 -0400531 svm_region_exit ();
532 /* $$$ more careful cleanup, valgrind run... */
533 vec_free (am->msg_handlers);
534 vec_free (am->msg_endian_handlers);
535 vec_free (am->msg_print_handlers);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700536}
537
Dave Barach371e4e12016-07-08 09:38:52 -0400538void
539vl_msg_api_send_shmem (unix_shared_memory_queue_t * q, u8 * elem)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700540{
Dave Barach371e4e12016-07-08 09:38:52 -0400541 api_main_t *am = &api_main;
542 uword *trace = (uword *) elem;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700543
Dave Barach371e4e12016-07-08 09:38:52 -0400544 if (am->tx_trace && am->tx_trace->enabled)
545 vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700546
Dave Barach371e4e12016-07-08 09:38:52 -0400547 (void) unix_shared_memory_queue_add (q, elem, 0 /* nowait */ );
Ed Warnickecb9cada2015-12-08 15:45:58 -0700548}
549
Dave Barach371e4e12016-07-08 09:38:52 -0400550void
551vl_msg_api_send_shmem_nolock (unix_shared_memory_queue_t * q, u8 * elem)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700552{
Dave Barach371e4e12016-07-08 09:38:52 -0400553 api_main_t *am = &api_main;
554 uword *trace = (uword *) elem;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700555
Dave Barach371e4e12016-07-08 09:38:52 -0400556 if (am->tx_trace && am->tx_trace->enabled)
557 vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700558
Dave Barach371e4e12016-07-08 09:38:52 -0400559 (void) unix_shared_memory_queue_add_nolock (q, elem);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700560}
561
Dave Barach371e4e12016-07-08 09:38:52 -0400562static void
563vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700564{
Dave Barach557d1282016-11-10 14:22:49 -0500565 serialize_main_t _sm, *sm = &_sm;
Dave Barach371e4e12016-07-08 09:38:52 -0400566 api_main_t *am = &api_main;
Dave Barach557d1282016-11-10 14:22:49 -0500567 u8 *tblv;
568 u32 nmsgs;
569 int i;
570 u8 *name_and_crc;
571 u32 msg_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700572
Dave Barach371e4e12016-07-08 09:38:52 -0400573 am->my_client_index = mp->index;
574 am->my_registration = (vl_api_registration_t *) (uword) mp->handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700575
Dave Barach557d1282016-11-10 14:22:49 -0500576 /* Clean out any previous hash table (unlikely) */
577 if (am->msg_index_by_name_and_crc)
578 {
579 int i;
580 u8 **keys = 0;
581 hash_pair_t *hp;
582 /* *INDENT-OFF* */
583 hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
584 ({
585 vec_add1 (keys, (u8 *) hp->key);
586 }));
587 /* *INDENT-ON* */
588 for (i = 0; i < vec_len (keys); i++)
589 vec_free (keys[i]);
590 vec_free (keys);
591 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700592
Dave Barach557d1282016-11-10 14:22:49 -0500593 am->msg_index_by_name_and_crc = hash_create_string (0, sizeof (uword));
594
595 /* Recreate the vnet-side API message handler table */
596 tblv = (u8 *) mp->message_table;
597 serialize_open_vector (sm, tblv);
598 unserialize_integer (sm, &nmsgs, sizeof (u32));
599
600 for (i = 0; i < nmsgs; i++)
601 {
602 msg_index = unserialize_likely_small_unsigned_integer (sm);
603 unserialize_cstring (sm, (char **) &name_and_crc);
604 hash_set_mem (am->msg_index_by_name_and_crc, name_and_crc, msg_index);
605 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700606}
607
Dave Barach557d1282016-11-10 14:22:49 -0500608u32
609vl_api_get_msg_index (u8 * name_and_crc)
Dave Barach371e4e12016-07-08 09:38:52 -0400610{
Dave Barach557d1282016-11-10 14:22:49 -0500611 api_main_t *am = &api_main;
612 uword *p;
Dave Barach371e4e12016-07-08 09:38:52 -0400613
Dave Barach557d1282016-11-10 14:22:49 -0500614 if (am->msg_index_by_name_and_crc)
615 {
616 p = hash_get_mem (am->msg_index_by_name_and_crc, name_and_crc);
617 if (p)
618 return p[0];
619 }
620 return ~0;
Dave Barach371e4e12016-07-08 09:38:52 -0400621}
622
623int
624vl_client_connect (char *name, int ctx_quota, int input_queue_size)
625{
626 svm_region_t *svm;
627 vl_api_memclnt_create_t *mp;
628 vl_api_memclnt_create_reply_t *rp;
629 unix_shared_memory_queue_t *vl_input_queue;
630 vl_shmem_hdr_t *shmem_hdr;
631 int rv = 0;
632 void *oldheap;
633 api_main_t *am = &api_main;
634
635 if (am->my_registration)
636 {
637 clib_warning ("client %s already connected...", name);
638 return -1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700639 }
640
Dave Barach371e4e12016-07-08 09:38:52 -0400641 if (am->vlib_rp == 0)
642 {
643 clib_warning ("am->vlib_rp NULL");
644 return -1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700645 }
646
Dave Barach371e4e12016-07-08 09:38:52 -0400647 svm = am->vlib_rp;
648 shmem_hdr = am->shmem_hdr;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700649
Dave Barach371e4e12016-07-08 09:38:52 -0400650 if (shmem_hdr == 0 || shmem_hdr->vl_input_queue == 0)
651 {
652 clib_warning ("shmem_hdr / input queue NULL");
653 return -1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700654 }
655
Dave Barach371e4e12016-07-08 09:38:52 -0400656 pthread_mutex_lock (&svm->mutex);
657 oldheap = svm_push_data_heap (svm);
658 vl_input_queue =
659 unix_shared_memory_queue_init (input_queue_size, sizeof (uword),
660 getpid (), 0);
661 pthread_mutex_unlock (&svm->mutex);
662 svm_pop_heap (oldheap);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700663
Dave Barach371e4e12016-07-08 09:38:52 -0400664 am->my_client_index = ~0;
665 am->my_registration = 0;
666 am->vl_input_queue = vl_input_queue;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700667
Dave Barach371e4e12016-07-08 09:38:52 -0400668 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_create_t));
669 memset (mp, 0, sizeof (*mp));
670 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE);
671 mp->ctx_quota = ctx_quota;
672 mp->input_queue = (uword) vl_input_queue;
673 strncpy ((char *) mp->name, name, sizeof (mp->name) - 1);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700674
Dave Barach371e4e12016-07-08 09:38:52 -0400675 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700676
Dave Barach371e4e12016-07-08 09:38:52 -0400677 while (1)
678 {
679 int qstatus;
680 struct timespec ts, tsrem;
681 int i;
682
683 /* Wait up to 10 seconds */
684 for (i = 0; i < 1000; i++)
685 {
686 qstatus = unix_shared_memory_queue_sub (vl_input_queue, (u8 *) & rp,
687 1 /* nowait */ );
688 if (qstatus == 0)
689 goto read_one_msg;
690 ts.tv_sec = 0;
691 ts.tv_nsec = 10000 * 1000; /* 10 ms */
692 while (nanosleep (&ts, &tsrem) < 0)
693 ts = tsrem;
694 }
695 /* Timeout... */
696 clib_warning ("memclnt_create_reply timeout");
697 return -1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700698
699 read_one_msg:
Dave Barach371e4e12016-07-08 09:38:52 -0400700 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_CREATE_REPLY)
701 {
702 clib_warning ("unexpected reply: id %d", ntohs (rp->_vl_msg_id));
703 continue;
704 }
705 rv = clib_net_to_host_u32 (rp->response);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700706
Dave Barach371e4e12016-07-08 09:38:52 -0400707 vl_msg_api_handler ((void *) rp);
708 break;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700709 }
Dave Barach371e4e12016-07-08 09:38:52 -0400710 return (rv);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700711}
712
Dave Barach371e4e12016-07-08 09:38:52 -0400713static void
714vl_api_memclnt_delete_reply_t_handler (vl_api_memclnt_delete_reply_t * mp)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700715{
Dave Barach371e4e12016-07-08 09:38:52 -0400716 void *oldheap;
717 api_main_t *am = &api_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700718
Dave Barach371e4e12016-07-08 09:38:52 -0400719 pthread_mutex_lock (&am->vlib_rp->mutex);
720 oldheap = svm_push_data_heap (am->vlib_rp);
721 unix_shared_memory_queue_free (am->vl_input_queue);
722 pthread_mutex_unlock (&am->vlib_rp->mutex);
723 svm_pop_heap (oldheap);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700724
Dave Barach371e4e12016-07-08 09:38:52 -0400725 am->my_client_index = ~0;
726 am->my_registration = 0;
727 am->vl_input_queue = 0;
728}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700729
Dave Barach371e4e12016-07-08 09:38:52 -0400730void
731vl_client_disconnect (void)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700732{
Dave Barach371e4e12016-07-08 09:38:52 -0400733 vl_api_memclnt_delete_t *mp;
734 vl_api_memclnt_delete_reply_t *rp;
735 unix_shared_memory_queue_t *vl_input_queue;
736 vl_shmem_hdr_t *shmem_hdr;
737 time_t begin;
738 api_main_t *am = &api_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700739
Dave Barach371e4e12016-07-08 09:38:52 -0400740 ASSERT (am->vlib_rp);
741 shmem_hdr = am->shmem_hdr;
742 ASSERT (shmem_hdr && shmem_hdr->vl_input_queue);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700743
Dave Barach371e4e12016-07-08 09:38:52 -0400744 vl_input_queue = am->vl_input_queue;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700745
Dave Barach371e4e12016-07-08 09:38:52 -0400746 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_delete_t));
747 memset (mp, 0, sizeof (*mp));
748 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE);
749 mp->index = am->my_client_index;
750 mp->handle = (uword) am->my_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700751
Dave Barach371e4e12016-07-08 09:38:52 -0400752 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700753
Dave Barach371e4e12016-07-08 09:38:52 -0400754 /*
755 * Have to be careful here, in case the client is disconnecting
756 * because e.g. the vlib process died, or is unresponsive.
757 */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700758
Dave Barach371e4e12016-07-08 09:38:52 -0400759 begin = time (0);
760 while (1)
761 {
762 time_t now;
763
764 now = time (0);
765
766 if (now >= (begin + 2))
767 {
768 clib_warning ("peer unresponsive, give up");
769 am->my_client_index = ~0;
770 am->my_registration = 0;
771 am->shmem_hdr = 0;
772 break;
773 }
774 if (unix_shared_memory_queue_sub (vl_input_queue, (u8 *) & rp, 1) < 0)
775 continue;
776
777 /* drain the queue */
778 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_DELETE_REPLY)
779 {
780 vl_msg_api_handler ((void *) rp);
781 continue;
782 }
783 vl_msg_api_handler ((void *) rp);
784 break;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700785 }
786}
787
Dave Barach371e4e12016-07-08 09:38:52 -0400788static inline vl_api_registration_t *
789vl_api_client_index_to_registration_internal (u32 handle)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700790{
Dave Barach371e4e12016-07-08 09:38:52 -0400791 vl_api_registration_t **regpp;
792 vl_api_registration_t *regp;
793 api_main_t *am = &api_main;
794 u32 index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700795
Dave Barach371e4e12016-07-08 09:38:52 -0400796 index = vl_msg_api_handle_get_index (handle);
797 if ((am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK)
798 != vl_msg_api_handle_get_epoch (handle))
799 {
800 vl_msg_api_increment_missing_client_counter ();
801 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700802 }
803
Dave Barach371e4e12016-07-08 09:38:52 -0400804 regpp = am->vl_clients + index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700805
Dave Barach371e4e12016-07-08 09:38:52 -0400806 if (pool_is_free (am->vl_clients, regpp))
807 {
808 vl_msg_api_increment_missing_client_counter ();
809 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700810 }
Dave Barach371e4e12016-07-08 09:38:52 -0400811 regp = *regpp;
812 return (regp);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700813}
814
Dave Barach371e4e12016-07-08 09:38:52 -0400815vl_api_registration_t *
816vl_api_client_index_to_registration (u32 index)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700817{
Dave Barach371e4e12016-07-08 09:38:52 -0400818 return (vl_api_client_index_to_registration_internal (index));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700819}
820
Dave Barach371e4e12016-07-08 09:38:52 -0400821unix_shared_memory_queue_t *
822vl_api_client_index_to_input_queue (u32 index)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700823{
Dave Barach371e4e12016-07-08 09:38:52 -0400824 vl_api_registration_t *regp;
Dave Barachfc262a02016-12-14 14:49:55 -0500825 api_main_t *am = &api_main;
826
827 /* Special case: vlib trying to send itself a message */
828 if (index == (u32) ~ 0)
829 return (am->shmem_hdr->vl_input_queue);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700830
Dave Barach371e4e12016-07-08 09:38:52 -0400831 regp = vl_api_client_index_to_registration_internal (index);
832 if (!regp)
833 return 0;
834 return (regp->vl_input_queue);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700835}
836
837#define foreach_api_client_msg \
838_(MEMCLNT_CREATE_REPLY, memclnt_create_reply) \
839_(MEMCLNT_DELETE_REPLY, memclnt_delete_reply)
840
Dave Barach371e4e12016-07-08 09:38:52 -0400841int
842vl_client_api_map (char *region_name)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700843{
Dave Barach371e4e12016-07-08 09:38:52 -0400844 int rv;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700845
Dave Barach371e4e12016-07-08 09:38:52 -0400846 if ((rv = vl_map_shmem (region_name, 0 /* is_vlib */ )) < 0)
847 {
848 return rv;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700849 }
850
851#define _(N,n) \
852 vl_msg_api_set_handlers(VL_API_##N, 0 /* name */, \
853 vl_api_##n##_t_handler, \
854 0/* cleanup */, 0/* endian */, 0/* print */, \
Dave Barach371e4e12016-07-08 09:38:52 -0400855 sizeof(vl_api_##n##_t), 1);
856 foreach_api_client_msg;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700857#undef _
Dave Barach371e4e12016-07-08 09:38:52 -0400858 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700859}
860
Dave Barach371e4e12016-07-08 09:38:52 -0400861void
862vl_client_api_unmap (void)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700863{
Dave Barach371e4e12016-07-08 09:38:52 -0400864 vl_unmap_shmem ();
Ed Warnickecb9cada2015-12-08 15:45:58 -0700865}
Dave Barach371e4e12016-07-08 09:38:52 -0400866
867/*
868 * fd.io coding-style-patch-verification: ON
869 *
870 * Local Variables:
871 * eval: (c-set-style "gnu")
872 * End:
873 */