FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
memory_shared.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * memclnt_shared.c - API message handling, common code for both clients
4  * and the vlib process itself.
5  *
6  *
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>
24 #include <stddef.h>
25 #include <string.h>
26 #include <unistd.h>
27 #include <signal.h>
28 
29 #include <vppinfra/format.h>
30 #include <vppinfra/byte_order.h>
31 #include <vppinfra/error.h>
32 #include <svm/queue.h>
33 #include <vlib/vlib.h>
34 #include <vlib/unix/unix.h>
35 #include <vlibmemory/memory_api.h>
37 
38 #define vl_typedefs
40 #undef vl_typedefs
41 
42 #define DEBUG_MESSAGE_BUFFER_OVERRUN 0
43 
44 static inline void *
45 vl_msg_api_alloc_internal (int nbytes, int pool, int may_return_null)
46 {
47  int i;
48  msgbuf_t *rv;
49  ring_alloc_t *ap;
50  svm_queue_t *q;
51  void *oldheap;
52  vl_shmem_hdr_t *shmem_hdr;
53  api_main_t *am = &api_main;
54 
55  shmem_hdr = am->shmem_hdr;
56 
57 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
58  nbytes += 4;
59 #endif
60 
61  ASSERT (pool == 0 || vlib_get_thread_index () == 0);
62 
63  if (shmem_hdr == 0)
64  {
65  clib_warning ("shared memory header NULL");
66  return 0;
67  }
68 
69  /* account for the msgbuf_t header */
70  nbytes += sizeof (msgbuf_t);
71 
72  if (shmem_hdr->vl_rings == 0)
73  {
74  clib_warning ("vl_rings NULL");
75  ASSERT (0);
76  abort ();
77  }
78 
79  if (shmem_hdr->client_rings == 0)
80  {
81  clib_warning ("client_rings NULL");
82  ASSERT (0);
83  abort ();
84  }
85 
86  ap = pool ? shmem_hdr->vl_rings : shmem_hdr->client_rings;
87  for (i = 0; i < vec_len (ap); i++)
88  {
89  /* Too big? */
90  if (nbytes > ap[i].size)
91  {
92  continue;
93  }
94 
95  q = ap[i].rp;
96  if (pool == 0)
97  {
98  pthread_mutex_lock (&q->mutex);
99  }
100  rv = (msgbuf_t *) (&q->data[0] + q->head * q->elsize);
101  /*
102  * Is this item still in use?
103  */
104  if (rv->q)
105  {
106  u32 now = (u32) time (0);
107 
108  if (PREDICT_TRUE (rv->gc_mark_timestamp == 0))
109  rv->gc_mark_timestamp = now;
110  else
111  {
112  if (now - rv->gc_mark_timestamp > 10)
113  {
114  if (CLIB_DEBUG > 0)
115  {
116  u16 *msg_idp, msg_id;
118  ("garbage collect pool %d ring %d index %d", pool, i,
119  q->head);
120  msg_idp = (u16 *) (rv->data);
121  msg_id = clib_net_to_host_u16 (*msg_idp);
122  if (msg_id < vec_len (api_main.msg_names))
123  clib_warning ("msg id %d name %s", (u32) msg_id,
124  api_main.msg_names[msg_id]);
125  }
126  shmem_hdr->garbage_collects++;
127  goto collected;
128  }
129  }
130 
131 
132  /* yes, loser; try next larger pool */
133  ap[i].misses++;
134  if (pool == 0)
135  pthread_mutex_unlock (&q->mutex);
136  continue;
137  }
138  collected:
139 
140  /* OK, we have a winner */
141  ap[i].hits++;
142  /*
143  * Remember the source queue, although we
144  * don't need to know the queue to free the item.
145  */
146  rv->q = q;
147  rv->gc_mark_timestamp = 0;
148  q->head++;
149  if (q->head == q->maxsize)
150  q->head = 0;
151 
152  if (pool == 0)
153  pthread_mutex_unlock (&q->mutex);
154  goto out;
155  }
156 
157  /*
158  * Request too big, or head element of all size-compatible rings
159  * still in use. Fall back to shared-memory malloc.
160  */
161  am->ring_misses++;
162 
163  pthread_mutex_lock (&am->vlib_rp->mutex);
164  oldheap = svm_push_data_heap (am->vlib_rp);
165  if (may_return_null)
166  {
167  rv = clib_mem_alloc_or_null (nbytes);
168  if (PREDICT_FALSE (rv == 0))
169  {
170  svm_pop_heap (oldheap);
171  pthread_mutex_unlock (&am->vlib_rp->mutex);
172  return 0;
173  }
174  }
175  else
176  rv = clib_mem_alloc (nbytes);
177 
178  rv->q = 0;
179  svm_pop_heap (oldheap);
180  pthread_mutex_unlock (&am->vlib_rp->mutex);
181 
182 out:
183 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
184  {
185  nbytes -= 4;
186  u32 *overrun;
187  overrun = (u32 *) (rv->data + nbytes - sizeof (msgbuf_t));
188  *overrun = 0x1badbabe;
189  }
190 #endif
191  rv->data_len = htonl (nbytes - sizeof (msgbuf_t));
192 
193  return (rv->data);
194 }
195 
196 void *
197 vl_msg_api_alloc (int nbytes)
198 {
199  int pool;
200  api_main_t *am = &api_main;
201  vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
202 
203  /*
204  * Clients use pool-0, vlib proc uses pool 1
205  */
206  pool = (am->our_pid == shmem_hdr->vl_pid);
207  return vl_msg_api_alloc_internal (nbytes, pool, 0 /* may_return_null */ );
208 }
209 
210 void *
212 {
213  int pool;
214  api_main_t *am = &api_main;
215  vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
216 
217  pool = (am->our_pid == shmem_hdr->vl_pid);
218  return vl_msg_api_alloc_internal (nbytes, pool, 1 /* may_return_null */ );
219 }
220 
221 void *
223 {
224  return vl_msg_api_alloc_internal (nbytes, 0, 0 /* may_return_null */ );
225 }
226 
227 void *
229 {
230  return vl_msg_api_alloc_internal (nbytes, 0, 1 /* may_return_null */ );
231 }
232 
233 void *
235 {
236  api_main_t *am = &api_main;
237  vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
238  svm_region_t *vlib_rp, *save_vlib_rp = am->vlib_rp;
239  void *msg;
240 
241  vlib_rp = am->vlib_rp = reg->vlib_rp;
242  am->shmem_hdr = (void *) vlib_rp->user_ctx;
243 
244  msg = vl_msg_api_alloc_internal (nbytes, 0, 0 /* may_return_null */ );
245 
246  am->shmem_hdr = save_shmem_hdr;
247  am->vlib_rp = save_vlib_rp;
248 
249  return msg;
250 }
251 
252 void
254 {
255  msgbuf_t *rv;
256  void *oldheap;
257  api_main_t *am = &api_main;
258 
259  rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
260 
261  /*
262  * Here's the beauty of the scheme. Only one proc/thread has
263  * control of a given message buffer. To free a buffer, we just clear the
264  * queue field, and leave. No locks, no hits, no errors...
265  */
266  if (rv->q)
267  {
268  rv->q = 0;
269  rv->gc_mark_timestamp = 0;
270 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
271  {
272  u32 *overrun;
273  overrun = (u32 *) (rv->data + ntohl (rv->data_len));
274  ASSERT (*overrun == 0x1badbabe);
275  }
276 #endif
277  return;
278  }
279 
280  pthread_mutex_lock (&am->vlib_rp->mutex);
281  oldheap = svm_push_data_heap (am->vlib_rp);
282 
283 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
284  {
285  u32 *overrun;
286  overrun = (u32 *) (rv->data + ntohl (rv->data_len));
287  ASSERT (*overrun == 0x1badbabe);
288  }
289 #endif
290 
291  clib_mem_free (rv);
292  svm_pop_heap (oldheap);
293  pthread_mutex_unlock (&am->vlib_rp->mutex);
294 }
295 
296 static void
298 {
299  msgbuf_t *rv;
300  void *oldheap;
301  api_main_t *am = &api_main;
302 
303  rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
304  /*
305  * Here's the beauty of the scheme. Only one proc/thread has
306  * control of a given message buffer. To free a buffer, we just clear the
307  * queue field, and leave. No locks, no hits, no errors...
308  */
309  if (rv->q)
310  {
311  rv->q = 0;
312  return;
313  }
314 
315  oldheap = svm_push_data_heap (am->vlib_rp);
316  clib_mem_free (rv);
317  svm_pop_heap (oldheap);
318 }
319 
320 void
322 {
323  api_main_t *am = &api_main;
324 
325  am->root_path = name;
326 }
327 
328 void
330 {
331  api_main_t *am = &api_main;
332 
333  am->api_uid = uid;
334 }
335 
336 void
338 {
339  api_main_t *am = &api_main;
340 
341  am->api_gid = gid;
342 }
343 
344 void
346 {
347  api_main_t *am = &api_main;
348 
349  am->global_baseva = baseva;
350 }
351 
352 void
354 {
355  api_main_t *am = &api_main;
356 
357  am->global_size = size;
358 }
359 
360 void
362 {
363  api_main_t *am = &api_main;
364 
365  am->api_size = size;
366 }
367 
368 void
370 {
371  api_main_t *am = &api_main;
372 
374 }
375 
376 void
378 {
379  api_main_t *am = &api_main;
380 
381  am->api_pvt_heap_size = size;
382 }
383 
384 static void
386 {
387  api_main_t *am = &api_main;
388  u32 vlib_input_queue_length;
389 
390  /* vlib main input queue */
391  vlib_input_queue_length = 1024;
392  if (am->vlib_input_queue_length)
393  vlib_input_queue_length = am->vlib_input_queue_length;
394 
395  shmem_hdr->vl_input_queue =
396  svm_queue_alloc_and_init (vlib_input_queue_length, sizeof (uword),
397  getpid ());
398 
399 #define _(sz,n) \
400  do { \
401  ring_alloc_t _rp; \
402  _rp.rp = svm_queue_alloc_and_init ((n), (sz), 0); \
403  _rp.size = (sz); \
404  _rp.nitems = n; \
405  _rp.hits = 0; \
406  _rp.misses = 0; \
407  vec_add1(shmem_hdr->vl_rings, _rp); \
408  } while (0);
409 
411 #undef _
412 
413 #define _(sz,n) \
414  do { \
415  ring_alloc_t _rp; \
416  _rp.rp = svm_queue_alloc_and_init ((n), (sz), 0); \
417  _rp.size = (sz); \
418  _rp.nitems = n; \
419  _rp.hits = 0; \
420  _rp.misses = 0; \
421  vec_add1(shmem_hdr->client_rings, _rp); \
422  } while (0);
423 
425 #undef _
426 }
427 
428 void
430 {
432  ring_alloc_t *rp;
433  u32 size;
434 
435  if (!config)
436  {
438  return;
439  }
440 
441  vec_foreach (c, config)
442  {
443  switch (c->type)
444  {
445  case VL_API_QUEUE:
447  getpid ());
448  continue;
449  case VL_API_VLIB_RING:
450  vec_add2 (hdr->vl_rings, rp, 1);
451  break;
452  case VL_API_CLIENT_RING:
453  vec_add2 (hdr->client_rings, rp, 1);
454  break;
455  default:
456  clib_warning ("unknown config type: %d", c->type);
457  continue;
458  }
459 
460  size = sizeof (ring_alloc_t) + c->size;
461  rp->rp = svm_queue_alloc_and_init (c->count, size, 0);
462  rp->size = size;
463  rp->nitems = c->count;
464  rp->hits = 0;
465  rp->misses = 0;
466  }
467 }
468 
469 void
471  int is_vlib, int is_private_region)
472 {
473  api_main_t *am = &api_main;
474  vl_shmem_hdr_t *shmem_hdr = 0;
475  void *oldheap;
476  ASSERT (vlib_rp);
477 
478  /* $$$$ need private region config parameters */
479 
480  oldheap = svm_push_data_heap (vlib_rp);
481 
482  vec_validate (shmem_hdr, 0);
483  shmem_hdr->version = VL_SHM_VERSION;
484  shmem_hdr->clib_file_index = VL_API_INVALID_FI;
485 
486  /* Set up the queue and msg ring allocator */
487  vl_api_mem_config (shmem_hdr, config);
488 
489  if (is_private_region == 0)
490  {
491  am->shmem_hdr = shmem_hdr;
492  am->vlib_rp = vlib_rp;
493  am->our_pid = getpid ();
494  if (is_vlib)
495  am->shmem_hdr->vl_pid = am->our_pid;
496  }
497  else
498  shmem_hdr->vl_pid = am->our_pid;
499 
500  svm_pop_heap (oldheap);
501 
502  /*
503  * After absolutely everything that a client might see is set up,
504  * declare the shmem region valid
505  */
506  vlib_rp->user_ctx = shmem_hdr;
507 
508  pthread_mutex_unlock (&vlib_rp->mutex);
509 }
510 
511 int
512 vl_map_shmem (const char *region_name, int is_vlib)
513 {
514  svm_map_region_args_t _a, *a = &_a;
515  svm_region_t *vlib_rp, *root_rp;
516  api_main_t *am = &api_main;
517  int i, rv;
518  struct timespec ts, tsrem;
519  char *vpe_api_region_suffix = "-vpe-api";
520 
521  clib_memset (a, 0, sizeof (*a));
522 
523  if (strstr (region_name, vpe_api_region_suffix))
524  {
525  u8 *root_path = format (0, "%s", region_name);
526  _vec_len (root_path) = (vec_len (root_path) -
527  strlen (vpe_api_region_suffix));
528  vec_terminate_c_string (root_path);
529  a->root_path = (const char *) root_path;
530  am->root_path = (const char *) root_path;
531  }
532 
533  if (is_vlib == 0)
534  {
535  int tfd;
536  u8 *api_name;
537  /*
538  * Clients wait for vpp to set up the root / API regioins
539  */
540  if (am->root_path)
541  api_name = format (0, "/dev/shm/%s-%s%c", am->root_path,
542  region_name + 1, 0);
543  else
544  api_name = format (0, "/dev/shm%s%c", region_name, 0);
545 
546  /* Wait up to 100 seconds... */
547  for (i = 0; i < 10000; i++)
548  {
549  ts.tv_sec = 0;
550  ts.tv_nsec = 10000 * 1000; /* 10 ms */
551  while (nanosleep (&ts, &tsrem) < 0)
552  ts = tsrem;
553  tfd = open ((char *) api_name, O_RDWR);
554  if (tfd > 0)
555  break;
556  }
557  vec_free (api_name);
558  if (tfd < 0)
559  {
560  clib_warning ("region init fail");
561  return -2;
562  }
563  close (tfd);
565  if (rv)
566  return rv;
567  }
568 
569  if (a->root_path != NULL)
570  {
571  a->name = "/vpe-api";
572  }
573  else
574  a->name = region_name;
575  a->size = am->api_size ? am->api_size : (16 << 20);
576  a->flags = SVM_FLAGS_MHEAP;
577  a->uid = am->api_uid;
578  a->gid = am->api_gid;
580 
581  vlib_rp = svm_region_find_or_create (a);
582 
583  if (vlib_rp == 0)
584  return (-2);
585 
586  pthread_mutex_lock (&vlib_rp->mutex);
587  /* Has someone else set up the shared-memory variable table? */
588  if (vlib_rp->user_ctx)
589  {
590  am->shmem_hdr = (void *) vlib_rp->user_ctx;
591  am->our_pid = getpid ();
592  if (is_vlib)
593  {
594  svm_queue_t *q;
595  uword old_msg;
596  /*
597  * application restart. Reset cached pids, API message
598  * rings, list of clients; otherwise, various things
599  * fail. (e.g. queue non-empty notification)
600  */
601 
602  /* ghosts keep the region from disappearing properly */
605  q = am->shmem_hdr->vl_input_queue;
606  am->shmem_hdr->vl_pid = getpid ();
607  q->consumer_pid = am->shmem_hdr->vl_pid;
608  /* Drain the input queue, freeing msgs */
609  for (i = 0; i < 10; i++)
610  {
611  if (pthread_mutex_trylock (&q->mutex) == 0)
612  {
613  pthread_mutex_unlock (&q->mutex);
614  goto mutex_ok;
615  }
616  ts.tv_sec = 0;
617  ts.tv_nsec = 10000 * 1000; /* 10 ms */
618  while (nanosleep (&ts, &tsrem) < 0)
619  ts = tsrem;
620  }
621  /* Mutex buggered, "fix" it */
622  clib_memset (&q->mutex, 0, sizeof (q->mutex));
623  clib_warning ("forcibly release main input queue mutex");
624 
625  mutex_ok:
626  am->vlib_rp = vlib_rp;
627  while (svm_queue_sub (q, (u8 *) & old_msg, SVM_Q_NOWAIT, 0)
628  != -2 /* queue underflow */ )
629  {
630  vl_msg_api_free_nolock ((void *) old_msg);
632  }
633  pthread_mutex_unlock (&vlib_rp->mutex);
634  root_rp = svm_get_root_rp ();
635  ASSERT (root_rp);
636  /* Clean up the root region client list */
637  pthread_mutex_lock (&root_rp->mutex);
639  pthread_mutex_unlock (&root_rp->mutex);
640  }
641  else
642  {
643  pthread_mutex_unlock (&vlib_rp->mutex);
644  }
645  am->vlib_rp = vlib_rp;
646  vec_add1 (am->mapped_shmem_regions, vlib_rp);
647  return 0;
648  }
649  /* Clients simply have to wait... */
650  if (!is_vlib)
651  {
652  pthread_mutex_unlock (&vlib_rp->mutex);
653 
654  /* Wait up to 100 seconds... */
655  for (i = 0; i < 10000; i++)
656  {
657  ts.tv_sec = 0;
658  ts.tv_nsec = 10000 * 1000; /* 10 ms */
659  while (nanosleep (&ts, &tsrem) < 0)
660  ts = tsrem;
661  if (vlib_rp->user_ctx)
662  goto ready;
663  }
664  /* Clean up and leave... */
665  svm_region_unmap (vlib_rp);
666  clib_warning ("region init fail");
667  return (-2);
668 
669  ready:
670  am->shmem_hdr = (void *) vlib_rp->user_ctx;
671  am->our_pid = getpid ();
672  am->vlib_rp = vlib_rp;
673  vec_add1 (am->mapped_shmem_regions, vlib_rp);
674  return 0;
675  }
676 
677  /* Nope, it's our problem... */
678  vl_init_shmem (vlib_rp, 0 /* default config */ , 1 /* is vlib */ ,
679  0 /* is_private_region */ );
680 
681  vec_add1 (am->mapped_shmem_regions, vlib_rp);
682  return 0;
683 }
684 
685 void
687 {
688  api_main_t *am = &api_main;
689 
690  vec_add1 (am->mapped_shmem_regions, rp);
691 }
692 
693 static void
695 {
696  svm_region_t *rp;
697  int i;
698  api_main_t *am = &api_main;
699 
700  if (!svm_get_root_rp ())
701  return;
702 
703  for (i = 0; i < vec_len (am->mapped_shmem_regions); i++)
704  {
705  rp = am->mapped_shmem_regions[i];
706  is_client ? svm_region_unmap_client (rp) : svm_region_unmap (rp);
707  }
708 
710  am->shmem_hdr = 0;
711 
712  is_client ? svm_region_exit_client () : svm_region_exit ();
713 
714  /* $$$ more careful cleanup, valgrind run... */
715  vec_free (am->msg_handlers);
718 }
719 
720 void
722 {
724 }
725 
726 void
728 {
730 }
731 
732 void
734 {
735  api_main_t *am = &api_main;
736  uword *trace = (uword *) elem;
737 
738  if (am->tx_trace && am->tx_trace->enabled)
739  vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
740 
741  /*
742  * Announce a probable binary API client bug:
743  * some client's input queue is stuffed.
744  * The situation may be recoverable, or not.
745  */
746  if (PREDICT_FALSE
747  (am->vl_clients /* vpp side */ && (q->cursize == q->maxsize)))
748  clib_warning ("WARNING: client input queue at %llx is stuffed...", q);
749  (void) svm_queue_add (q, elem, 0 /* nowait */ );
750 }
751 
752 int
754 {
755  return (q->cursize < q->maxsize);
756 }
757 
758 void
760 {
761  api_main_t *am = &api_main;
762  uword *trace = (uword *) elem;
763 
764  if (am->tx_trace && am->tx_trace->enabled)
765  vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
766 
767  (void) svm_queue_add_nolock (q, elem);
768 }
769 
770 /*
771  * fd.io coding-style-patch-verification: ON
772  *
773  * Local Variables:
774  * eval: (c-set-style "gnu")
775  * End:
776  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:439
u64 api_pvt_heap_size
size of the api private mheap
Definition: api_common.h:301
static vlib_cli_command_t trace
(constructor) VLIB_CLI_COMMAND (trace)
Definition: vlib_api_cli.c:862
svm_region_t * svm_get_root_rp(void)
Definition: svm.c:54
const char * root_path
Definition: svm_common.h:67
static void svm_pop_heap(void *oldheap)
Definition: svm.h:94
int svm_queue_add(svm_queue_t *q, u8 *elem, int nowait)
Definition: queue.c:239
a
Definition: bitmap.h:538
void vl_set_global_memory_baseva(u64 baseva)
int vl_map_shmem(const char *region_name, int is_vlib)
u64 api_size
size of the API region
Definition: api_common.h:295
Optimized string handling code, including c11-compliant "safe C library" variants.
u32 application_restarts
Definition: memory_shared.h:95
#define PREDICT_TRUE(x)
Definition: clib.h:112
void vl_set_memory_uid(int uid)
unsigned long u64
Definition: types.h:89
void vl_set_global_pvt_heap_size(u64 size)
#define NULL
Definition: clib.h:58
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
void vl_unmap_shmem(void)
u32 gc_mark_timestamp
message garbage collector mark TS
Definition: api_common.h:140
#define vec_terminate_c_string(V)
(If necessary) NULL terminate a vector containing a c-string.
Definition: vec.h:1018
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:525
static void vl_unmap_shmem_internal(u8 is_client)
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:564
int i
int api_uid
uid for the api shared memory region
Definition: api_common.h:283
void svm_region_unmap_client(void *rp_arg)
Definition: svm.c:1190
ring_alloc_t * client_rings
Definition: memory_shared.h:92
svm_queue_t * q
message allocated in this shmem ring
Definition: api_common.h:138
int vl_mem_api_can_send(svm_queue_t *q)
void svm_region_exit_client(void)
Definition: svm.c:1256
u8 data[0]
actual message begins here
Definition: api_common.h:141
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
struct msgbuf_ msgbuf_t
Message header structure.
void * vl_msg_api_alloc(int nbytes)
int api_gid
gid for the api shared memory region
Definition: api_common.h:286
unsigned char u8
Definition: types.h:56
void vl_set_global_memory_size(u64 size)
int our_pid
Current process PID.
Definition: api_common.h:252
void svm_region_exit(void)
Definition: svm.c:1250
int svm_queue_sub(svm_queue_t *q, u8 *elem, svm_q_conditional_wait_t cond, u32 time)
Definition: queue.c:348
#define foreach_clnt_aring_size
Definition: memory_shared.h:71
static void * svm_push_data_heap(svm_region_t *rp)
Definition: svm.h:86
vl_api_registration_t ** vl_clients
vlib/vpp only: vector of client registrations
Definition: api_common.h:268
void * svm_region_find_or_create(svm_map_region_args_t *a)
Definition: svm.c:922
volatile void * user_ctx
Definition: svm_common.h:47
const char * root_path
Chroot path to the shared memory API files.
Definition: api_common.h:331
svm_region_t * vlib_rp
Current binary api segment descriptor.
Definition: api_common.h:255
struct vl_shmem_hdr_ * shmem_hdr
Binary API shared-memory segment header pointer.
Definition: api_common.h:265
unsigned int u32
Definition: types.h:88
svm_queue_t * rp
Definition: memory_shared.h:37
struct ring_alloc_ ring_alloc_t
void vl_set_memory_root_path(const char *name)
#define SVM_FLAGS_MHEAP
Definition: svm_common.h:27
volatile int vl_pid
Definition: memory_shared.h:81
uword size
void vl_register_mapped_shmem_region(svm_region_t *rp)
void vl_init_shmem(svm_region_t *vlib_rp, vl_api_shm_elem_config_t *config, int is_vlib, int is_private_region)
#define VL_API_INVALID_FI
Definition: api_common.h:76
void(** msg_print_handlers)(void *, void *)
Message print function vector.
Definition: api_common.h:216
unsigned short u16
Definition: types.h:57
#define PREDICT_FALSE(x)
Definition: clib.h:111
#define VL_SHM_VERSION
u8 name[64]
Definition: memclnt.api:152
void vl_set_api_pvt_heap_size(u64 size)
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:202
u64 global_size
size of the global VM region
Definition: api_common.h:292
u8 enabled
trace is enabled
Definition: api_common.h:92
An API client registration, only in vpp/vlib.
Definition: api_common.h:45
void vl_msg_api_send_shmem(svm_queue_t *q, u8 *elem)
ring_alloc_t * vl_rings
Definition: memory_shared.h:89
svmdb_client_t * c
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:212
static void * clib_mem_alloc_or_null(uword size)
Definition: mem.h:148
u64 global_baseva
base virtual address for global VM region
Definition: api_common.h:289
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
#define clib_warning(format, args...)
Definition: error.h:59
void vl_msg_api_trace(api_main_t *am, vl_api_trace_t *tp, void *msg)
Definition: api_shared.c:66
void vl_set_memory_gid(int gid)
static void vl_msg_api_free_nolock(void *a)
void vl_msg_api_free(void *a)
const char ** msg_names
Message name vector.
Definition: api_common.h:219
svm_queue_t * vl_input_queue
Definition: memory_shared.h:84
void vl_unmap_shmem_client(void)
vl_api_trace_t * tx_trace
Sent message trace configuration.
Definition: api_common.h:243
#define ASSERT(truth)
u32 data_len
message length not including header
Definition: api_common.h:139
Message header structure.
Definition: api_common.h:136
svm_queue_t * svm_queue_alloc_and_init(int nels, int elsize, int consumer_pid)
Allocate and initialize svm queue.
Definition: queue.c:72
static void clib_mem_free(void *p)
Definition: mem.h:205
u64 global_pvt_heap_size
size of the global VM private mheap
Definition: api_common.h:298
static void vl_api_default_mem_config(vl_shmem_hdr_t *shmem_hdr)
static void * clib_mem_alloc(uword size)
Definition: mem.h:132
#define foreach_vl_aring_size
Definition: memory_shared.h:66
void vl_api_mem_config(vl_shmem_hdr_t *hdr, vl_api_shm_elem_config_t *config)
void(** msg_endian_handlers)(void *)
Message endian handler vector.
Definition: api_common.h:213
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
const char * name
Definition: svm_common.h:68
u64 uword
Definition: types.h:112
void svm_region_unmap(void *rp_arg)
Definition: svm.c:1184
void svm_client_scan_this_region_nolock(svm_region_t *rp)
Definition: svm.c:1262
int svm_queue_add_nolock(svm_queue_t *q, u8 *elem)
Definition: queue.c:192
static void * vl_msg_api_alloc_internal(int nbytes, int pool, int may_return_null)
Definition: memory_shared.c:45
struct _svm_queue svm_queue_t
void * vl_msg_api_alloc_as_if_client_or_null(int nbytes)
void * vl_mem_api_alloc_as_if_client_w_reg(vl_api_registration_t *reg, int nbytes)
void(** msg_handlers)(void *)
Message handler vector.
Definition: api_common.h:205
void vl_set_api_memory_size(u64 size)
#define vec_foreach(var, vec)
Vector iterator.
void * vl_msg_api_alloc_as_if_client(int nbytes)
void * vl_msg_api_alloc_or_null(int nbytes)
svm_region_t ** mapped_shmem_regions
Definition: api_common.h:262
api_main_t api_main
Definition: api_shared.c:35
void vl_msg_api_send_shmem_nolock(svm_queue_t *q, u8 *elem)
svm_region_t * vlib_rp
Definition: api_common.h:61
u32 vlib_input_queue_length
vpp/vlib input queue length
Definition: api_common.h:319
pthread_mutex_t mutex
Definition: svm_common.h:37
non-blocking call - works with both condvar and eventfd signaling
Definition: queue.h:44
static svm_region_t * root_rp
Definition: svm.c:46
int svm_region_init_chroot(const char *root_path)
Definition: svm.c:882