FD.io VPP  v19.04-6-g6f05f72
Vector Packet Processing
memory_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * Copyright (c) 2018 Cisco and/or its affiliates.
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *------------------------------------------------------------------
16  */
17 #include <signal.h>
18 
19 #include <vlib/vlib.h>
20 #include <vlibapi/api.h>
21 #include <vlibmemory/api.h>
22 #include <vlibmemory/memory_api.h>
23 
24 #include <vlibmemory/vl_memory_msg_enum.h> /* enumerate all vlib messages */
25 
26 #define vl_typedefs /* define message structures */
28 #undef vl_typedefs
29 
30 /* instantiate all the print functions we know about */
31 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
32 #define vl_printfun
34 #undef vl_printfun
35 
36 /* instantiate all the endian swap functions we know about */
37 #define vl_endianfun
39 #undef vl_endianfun
40 
41 static inline void *
43 {
44  vl_print (handle, "vl_api_memclnt_create_t:\n");
45  vl_print (handle, "name: %s\n", a->name);
46  vl_print (handle, "input_queue: 0x%wx\n", a->input_queue);
47  vl_print (handle, "context: %u\n", (unsigned) a->context);
48  vl_print (handle, "ctx_quota: %ld\n", (long) a->ctx_quota);
49  return handle;
50 }
51 
52 static inline void *
54 {
55  vl_print (handle, "vl_api_memclnt_delete_t:\n");
56  vl_print (handle, "index: %u\n", (unsigned) a->index);
57  vl_print (handle, "handle: 0x%wx\n", a->handle);
58  return handle;
59 }
60 
61 volatile int **vl_api_queue_cursizes;
62 
63 static void
65 {
66  int i;
67  api_main_t *am = &api_main;
68 
70  1 + vec_len (am->vlib_private_rps)))
71  {
72  vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
73  svm_queue_t *q;
74 
75  if (shmem_hdr == 0)
76  return;
77 
78  q = shmem_hdr->vl_input_queue;
79  if (q == 0)
80  return;
81 
82  vec_add1 (vl_api_queue_cursizes, &q->cursize);
83 
84  for (i = 0; i < vec_len (am->vlib_private_rps); i++)
85  {
86  svm_region_t *vlib_rp = am->vlib_private_rps[i];
87 
88  shmem_hdr = (void *) vlib_rp->user_ctx;
89  q = shmem_hdr->vl_input_queue;
90  vec_add1 (vl_api_queue_cursizes, &q->cursize);
91  }
92  }
93 
94  for (i = 0; i < vec_len (vl_api_queue_cursizes); i++)
95  {
96  if (*vl_api_queue_cursizes[i])
97  {
98  vm->queue_signal_pending = 1;
99  vm->api_queue_nonempty = 1;
101  /* event_type */ QUEUE_SIGNAL_EVENT,
102  /* event_data */ 0);
103  break;
104  }
105  }
106  if (vec_len (vm->pending_rpc_requests))
107  {
108  vm->queue_signal_pending = 1;
109  vm->api_queue_nonempty = 1;
111  /* event_type */ QUEUE_SIGNAL_EVENT,
112  /* event_data */ 0);
113  }
114 }
115 
116 /*
117  * vl_api_memclnt_create_internal
118  */
119 u32
121 {
122  vl_api_registration_t **regpp;
123  vl_api_registration_t *regp;
124  svm_region_t *svm;
125  void *oldheap;
126  api_main_t *am = &api_main;
127 
128  ASSERT (vlib_get_thread_index () == 0);
129  pool_get (am->vl_clients, regpp);
130 
131  svm = am->vlib_rp;
132 
133  pthread_mutex_lock (&svm->mutex);
134  oldheap = svm_push_data_heap (svm);
135  *regpp = clib_mem_alloc (sizeof (vl_api_registration_t));
136 
137  regp = *regpp;
138  clib_memset (regp, 0, sizeof (*regp));
140  regp->vl_api_registration_pool_index = regpp - am->vl_clients;
141  regp->vlib_rp = svm;
142  regp->shmem_hdr = am->shmem_hdr;
143 
144  regp->vl_input_queue = q;
145  regp->name = format (0, "%s%c", name, 0);
146 
147  pthread_mutex_unlock (&svm->mutex);
148  svm_pop_heap (oldheap);
152 }
153 
154 /*
155  * vl_api_memclnt_create_t_handler
156  */
157 void
159 {
160  vl_api_registration_t **regpp;
161  vl_api_registration_t *regp;
163  svm_region_t *svm;
164  svm_queue_t *q;
165  int rv = 0;
166  void *oldheap;
167  api_main_t *am = &api_main;
168  u8 *msg_table;
169 
170  /*
171  * This is tortured. Maintain a vlib-address-space private
172  * pool of client registrations. We use the shared-memory virtual
173  * address of client structure as a handle, to allow direct
174  * manipulation of context quota vbls from the client library.
175  *
176  * This scheme causes trouble w/ API message trace replay, since
177  * some random VA from clib_mem_alloc() certainly won't
178  * occur in the Linux sim. The (very) few places
179  * that care need to use the pool index.
180  *
181  * Putting the registration object(s) into a pool in shared memory and
182  * using the pool index as a handle seems like a great idea.
183  * Unfortunately, each and every reference to that pool would need
184  * to be protected by a mutex:
185  *
186  * Client VLIB
187  * ------ ----
188  * convert pool index to
189  * pointer.
190  * <deschedule>
191  * expand pool
192  * <deschedule>
193  * kaboom!
194  */
195 
196  pool_get (am->vl_clients, regpp);
197 
198  svm = am->vlib_rp;
199 
200  pthread_mutex_lock (&svm->mutex);
201  oldheap = svm_push_data_heap (svm);
202  *regpp = clib_mem_alloc (sizeof (vl_api_registration_t));
203 
204  regp = *regpp;
205  clib_memset (regp, 0, sizeof (*regp));
207  regp->vl_api_registration_pool_index = regpp - am->vl_clients;
208  regp->vlib_rp = svm;
209  regp->shmem_hdr = am->shmem_hdr;
211 
212  q = regp->vl_input_queue = (svm_queue_t *) (uword) mp->input_queue;
213 
214  regp->name = format (0, "%s", mp->name);
215  vec_add1 (regp->name, 0);
216 
220 
221  if (am->vlib_rp != am->vlib_primary_rp)
222  msg_table = vl_api_serialize_message_table (am, 0);
223  else
224  msg_table = am->serialized_message_table_in_shmem;
225 
226  pthread_mutex_unlock (&svm->mutex);
227  svm_pop_heap (oldheap);
228 
229  rp = vl_msg_api_alloc (sizeof (*rp));
230  rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE_REPLY);
231  rp->handle = (uword) regp;
235  rp->context = mp->context;
236  rp->response = ntohl (rv);
237  rp->message_table = pointer_to_uword (msg_table);
238 
239  vl_msg_api_send_shmem (q, (u8 *) & rp);
240 }
241 
242 int
244 {
245  clib_error_t *error = 0;
246  _vl_msg_api_function_list_elt_t *i;
247 
249  while (i)
250  {
251  error = i->f (client_index);
252  if (error)
253  clib_error_report (error);
254  i = i->next_init_function;
255  }
256  return 0;
257 }
258 
259 /*
260  * vl_api_memclnt_delete_t_handler
261  */
262 void
264 {
265  vl_api_registration_t **regpp;
266  vl_api_registration_t *regp;
268  svm_region_t *svm;
269  void *oldheap;
270  api_main_t *am = &api_main;
271  u32 handle, client_index, epoch;
272 
273  handle = mp->index;
274 
275  if (vl_api_call_reaper_functions (handle))
276  return;
277 
278  epoch = vl_msg_api_handle_get_epoch (handle);
279  client_index = vl_msg_api_handle_get_index (handle);
280 
281  if (epoch != (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK))
282  {
284  ("Stale clnt delete index %d old epoch %d cur epoch %d",
285  client_index, epoch,
287  return;
288  }
289 
290  regpp = pool_elt_at_index (am->vl_clients, client_index);
291 
292  if (!pool_is_free (am->vl_clients, regpp))
293  {
294  int i;
295  regp = *regpp;
296  svm = am->vlib_rp;
297  int private_registration = 0;
298 
299  /* Send reply unless client asked us to do the cleanup */
300  if (!mp->do_cleanup)
301  {
302  /*
303  * Note: the API message handling path will set am->vlib_rp
304  * as appropriate for pairwise / private memory segments
305  */
306  rp = vl_msg_api_alloc (sizeof (*rp));
307  rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE_REPLY);
308  rp->handle = mp->handle;
309  rp->response = 1;
310 
311  vl_msg_api_send_shmem (regp->vl_input_queue, (u8 *) & rp);
312  if (client_index != regp->vl_api_registration_pool_index)
313  {
314  clib_warning ("mismatch client_index %d pool_index %d",
315  client_index,
317  vl_msg_api_free (rp);
318  return;
319  }
320  }
321 
322  /* For horizontal scaling, add a hash table... */
323  for (i = 0; i < vec_len (am->vlib_private_rps); i++)
324  {
325  /* Is this a pairwise / private API segment? */
326  if (am->vlib_private_rps[i] == svm)
327  {
328  /* Note: account for the memfd header page */
329  uword virtual_base = svm->virtual_base - MMAP_PAGESIZE;
330  uword virtual_size = svm->virtual_size + MMAP_PAGESIZE;
331 
332  /*
333  * Kill the registration pool element before we make
334  * the index vanish forever
335  */
338 
339  vec_delete (am->vlib_private_rps, 1, i);
340  /* Kill it, accounting for the memfd header page */
341  if (munmap ((void *) virtual_base, virtual_size) < 0)
342  clib_unix_warning ("munmap");
343  /* Reset the queue-length-address cache */
345  private_registration = 1;
346  break;
347  }
348  }
349 
350  /* No dangling references, please */
351  *regpp = 0;
352 
353  if (private_registration == 0)
354  {
357  pthread_mutex_lock (&svm->mutex);
358  oldheap = svm_push_data_heap (svm);
359  if (mp->do_cleanup)
361  vec_free (regp->name);
362  /* Poison the old registration */
363  clib_memset (regp, 0xF1, sizeof (*regp));
364  clib_mem_free (regp);
365  pthread_mutex_unlock (&svm->mutex);
366  svm_pop_heap (oldheap);
367  /*
368  * These messages must be freed manually, since they're set up
369  * as "bounce" messages. In the private_registration == 1 case,
370  * we kill the shared-memory segment which contains the message
371  * with munmap.
372  */
373  vl_msg_api_free (mp);
374  }
375  }
376  else
377  {
378  clib_warning ("unknown client ID %d", mp->index);
379  }
380 }
381 
382 /**
383  * client answered a ping, stave off the grim reaper...
384  */
385 void
387  (vl_api_memclnt_keepalive_reply_t * mp)
388 {
389  vl_api_registration_t *regp;
391 
392  regp = vl_api_client_index_to_registration (mp->context);
393  if (regp)
394  {
395  regp->last_heard = vlib_time_now (vm);
396  regp->unanswered_pings = 0;
397  }
398  else
399  clib_warning ("BUG: anonymous memclnt_keepalive_reply");
400 }
401 
402 /**
403  * We can send ourselves these messages if someone uses the
404  * builtin binary api test tool...
405  */
406 static void
408 {
409  vl_api_memclnt_keepalive_reply_t *rmp;
410  api_main_t *am;
411  vl_shmem_hdr_t *shmem_hdr;
412 
413  am = &api_main;
414  shmem_hdr = am->shmem_hdr;
415 
416  rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
417  clib_memset (rmp, 0, sizeof (*rmp));
418  rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
419  rmp->context = mp->context;
420  vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
421 }
422 
423 #define foreach_vlib_api_msg \
424 _(MEMCLNT_CREATE, memclnt_create) \
425 _(MEMCLNT_DELETE, memclnt_delete) \
426 _(MEMCLNT_KEEPALIVE, memclnt_keepalive) \
427 _(MEMCLNT_KEEPALIVE_REPLY, memclnt_keepalive_reply) \
428 
429 /*
430  * memory_api_init
431  */
432 int
433 vl_mem_api_init (const char *region_name)
434 {
435  int rv;
436  api_main_t *am = &api_main;
438  vl_msg_api_msg_config_t *c = &cfg;
439  vl_shmem_hdr_t *shm;
441 
442  clib_memset (c, 0, sizeof (*c));
443 
444  if ((rv = vl_map_shmem (region_name, 1 /* is_vlib */ )) < 0)
445  return rv;
446 
447 #define _(N,n) do { \
448  c->id = VL_API_##N; \
449  c->name = #n; \
450  c->handler = vl_api_##n##_t_handler; \
451  c->cleanup = vl_noop_handler; \
452  c->endian = vl_api_##n##_t_endian; \
453  c->print = vl_api_##n##_t_print; \
454  c->size = sizeof(vl_api_##n##_t); \
455  c->traced = 1; /* trace, so these msgs print */ \
456  c->replay = 0; /* don't replay client create/delete msgs */ \
457  c->message_bounce = 0; /* don't bounce this message */ \
458  vl_msg_api_config(c);} while (0);
459 
461 #undef _
462 
463  /*
464  * special-case freeing of memclnt_delete messages, so we can
465  * simply munmap pairwise / private API segments...
466  */
467  am->message_bounce[VL_API_MEMCLNT_DELETE] = 1;
468  am->is_mp_safe[VL_API_MEMCLNT_KEEPALIVE_REPLY] = 1;
469 
471 
472  shm = am->shmem_hdr;
473  ASSERT (shm && shm->vl_input_queue);
474 
475  /* Make a note so we can always find the primary region easily */
476  am->vlib_primary_rp = am->vlib_rp;
477 
478  return 0;
479 }
480 
481 clib_error_t *
483 {
484  api_main_t *am = &api_main;
485  int rv;
486 
487  if ((rv = vl_mem_api_init (am->region_name)) < 0)
488  {
489  return clib_error_return (0, "vl_mem_api_init (%s) failed",
490  am->region_name);
491  }
492  return 0;
493 }
494 
495 static void
497 {
499  svm_queue_t *q;
500  api_main_t *am = &api_main;
501  svm_region_t *save_vlib_rp = am->vlib_rp;
502  vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
503 
504  q = regp->vl_input_queue;
505 
506  /*
507  * If the queue head is moving, assume that the client is processing
508  * messages and skip the ping. This heuristic may fail if the queue
509  * is in the same position as last time, net of wrapping; in which
510  * case, the client will receive a keepalive.
511  */
512  if (regp->last_queue_head != q->head)
513  {
514  regp->last_heard = now;
515  regp->unanswered_pings = 0;
516  regp->last_queue_head = q->head;
517  return;
518  }
519 
520  /*
521  * push/pop shared memory segment, so this routine
522  * will work with "normal" as well as "private segment"
523  * memory clients..
524  */
525 
526  am->vlib_rp = regp->vlib_rp;
527  am->shmem_hdr = regp->shmem_hdr;
528 
529  mp = vl_msg_api_alloc (sizeof (*mp));
530  clib_memset (mp, 0, sizeof (*mp));
531  mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MEMCLNT_KEEPALIVE);
532  mp->context = mp->client_index =
536 
537  regp->unanswered_pings++;
538 
539  /* Failure-to-send due to a stuffed queue is absolutely expected */
540  if (svm_queue_add (q, (u8 *) & mp, 1 /* nowait */ ))
541  vl_msg_api_free (mp);
542 
543  am->vlib_rp = save_vlib_rp;
544  am->shmem_hdr = save_shmem_hdr;
545 }
546 
547 static void
549  vl_api_registration_t ** regpp,
550  u32 ** dead_indices,
551  u32 ** confused_indices)
552 {
553  vl_api_registration_t *regp = *regpp;
554  if (regp)
555  {
556  /* If we haven't heard from this client recently... */
557  if (regp->last_heard < (now - 10.0))
558  {
559  if (regp->unanswered_pings == 2)
560  {
561  svm_queue_t *q;
562  q = regp->vl_input_queue;
563  if (kill (q->consumer_pid, 0) >= 0)
564  {
565  clib_warning ("REAPER: lazy binary API client '%s'",
566  regp->name);
567  regp->unanswered_pings = 0;
568  regp->last_heard = now;
569  }
570  else
571  {
572  clib_warning ("REAPER: binary API client '%s' died",
573  regp->name);
574  vec_add1 (*dead_indices, regpp - am->vl_clients);
575  }
576  }
577  else
578  send_memclnt_keepalive (regp, now);
579  }
580  else
581  regp->unanswered_pings = 0;
582  }
583  else
584  {
585  clib_warning ("NULL client registration index %d",
586  regpp - am->vl_clients);
587  vec_add1 (*confused_indices, regpp - am->vl_clients);
588  }
589 }
590 
591 void
593 {
594  vl_api_registration_t **regpp;
595  static u32 *dead_indices;
596  static u32 *confused_indices;
597 
598  vec_reset_length (dead_indices);
599  vec_reset_length (confused_indices);
600 
601  /* *INDENT-OFF* */
602  pool_foreach (regpp, am->vl_clients, ({
603  vl_mem_send_client_keepalive_w_reg (am, now, regpp, &dead_indices,
604  &confused_indices);
605  }));
606  /* *INDENT-ON* */
607 
608  /* This should "never happen," but if it does, fix it... */
609  if (PREDICT_FALSE (vec_len (confused_indices) > 0))
610  {
611  int i;
612  for (i = 0; i < vec_len (confused_indices); i++)
613  {
614  pool_put_index (am->vl_clients, confused_indices[i]);
615  }
616  }
617 
618  if (PREDICT_FALSE (vec_len (dead_indices) > 0))
619  {
620  int i;
621  svm_region_t *svm;
622  void *oldheap;
623 
624  /* Allow the application to clean up its registrations */
625  for (i = 0; i < vec_len (dead_indices); i++)
626  {
627  regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
628  if (regpp)
629  {
630  u32 handle;
631 
633  (dead_indices[i], shm->application_restarts);
634  (void) vl_api_call_reaper_functions (handle);
635  }
636  }
637 
638  svm = am->vlib_rp;
639  pthread_mutex_lock (&svm->mutex);
640  oldheap = svm_push_data_heap (svm);
641 
642  for (i = 0; i < vec_len (dead_indices); i++)
643  {
644  regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
645  if (regpp)
646  {
647  /* Is this a pairwise SVM segment? */
648  if ((*regpp)->vlib_rp != svm)
649  {
650  int i;
651  svm_region_t *dead_rp = (*regpp)->vlib_rp;
652  /* Note: account for the memfd header page */
653  uword virtual_base = dead_rp->virtual_base - MMAP_PAGESIZE;
654  uword virtual_size = dead_rp->virtual_size + MMAP_PAGESIZE;
655 
656  /* For horizontal scaling, add a hash table... */
657  for (i = 0; i < vec_len (am->vlib_private_rps); i++)
658  if (am->vlib_private_rps[i] == dead_rp)
659  {
660  vec_delete (am->vlib_private_rps, 1, i);
661  goto found;
662  }
663  clib_warning ("private rp %llx AWOL", dead_rp);
664 
665  found:
666  /* Kill it, accounting for the memfd header page */
667  if (munmap ((void *) virtual_base, virtual_size) < 0)
668  clib_unix_warning ("munmap");
669  /* Reset the queue-length-address cache */
671  }
672  else
673  {
674  /* Poison the old registration */
675  clib_memset (*regpp, 0xF3, sizeof (**regpp));
676  clib_mem_free (*regpp);
677  }
678  /* no dangling references, please */
679  *regpp = 0;
680  }
681  else
682  {
683  svm_pop_heap (oldheap);
684  clib_warning ("Duplicate free, client index %d",
685  regpp - am->vl_clients);
686  oldheap = svm_push_data_heap (svm);
687  }
688  }
689 
691 
692  pthread_mutex_unlock (&svm->mutex);
693  svm_pop_heap (oldheap);
694  for (i = 0; i < vec_len (dead_indices); i++)
695  pool_put_index (am->vl_clients, dead_indices[i]);
696  }
697 }
698 
699 static inline int
701  vlib_node_runtime_t * node, svm_queue_t * q)
702 {
703  uword mp;
704  if (!svm_queue_sub2 (q, (u8 *) & mp))
705  {
706  vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
707  return 0;
708  }
709  return -1;
710 }
711 
712 int
714 {
715  api_main_t *am = &api_main;
716  return void_mem_api_handle_msg_i (am, vm, node,
718 }
719 
720 int
722 {
723  api_main_t *am = &api_main;
724  int i;
725  uword *tmp, mp;
726 
727  /*
728  * Swap pending and processing vectors, then process the RPCs
729  * Avoid deadlock conditions by construction.
730  */
732  tmp = vm->processing_rpc_requests;
733  vec_reset_length (tmp);
735  vm->pending_rpc_requests = tmp;
737 
738  /*
739  * RPCs are used to reflect function calls to thread 0
740  * when the underlying code is not thread-safe.
741  *
742  * Grabbing the thread barrier across a set of RPCs
743  * greatly increases efficiency, and avoids
744  * running afoul of the barrier sync holddown timer.
745  * The barrier sync code supports recursive locking.
746  *
747  * We really need to rewrite RPC-based code...
748  */
750  {
752  for (i = 0; i < vec_len (vm->processing_rpc_requests); i++)
753  {
754  mp = vm->processing_rpc_requests[i];
755  vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
756  }
758  }
759 
760  return 0;
761 }
762 
763 int
765  u32 reg_index)
766 {
767  api_main_t *am = &api_main;
768  vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
769  svm_region_t *vlib_rp, *save_vlib_rp = am->vlib_rp;
770  svm_queue_t *q;
771  int rv;
772 
773  vlib_rp = am->vlib_rp = am->vlib_private_rps[reg_index];
774 
775  am->shmem_hdr = (void *) vlib_rp->user_ctx;
776  q = am->shmem_hdr->vl_input_queue;
777 
778  rv = void_mem_api_handle_msg_i (am, vm, node, q);
779 
780  am->shmem_hdr = save_shmem_hdr;
781  am->vlib_rp = save_vlib_rp;
782 
783  return rv;
784 }
785 
788 {
789  vl_api_registration_t **regpp;
790  vl_api_registration_t *regp;
791  api_main_t *am = &api_main;
792  vl_shmem_hdr_t *shmem_hdr;
793  u32 index;
794 
795  index = vl_msg_api_handle_get_index (handle);
796  regpp = am->vl_clients + index;
797 
798  if (pool_is_free (am->vl_clients, regpp))
799  {
801  return 0;
802  }
803  regp = *regpp;
804 
805  shmem_hdr = (vl_shmem_hdr_t *) regp->shmem_hdr;
806  if (!vl_msg_api_handle_is_valid (handle, shmem_hdr->application_restarts))
807  {
809  return 0;
810  }
811 
812  return (regp);
813 }
814 
815 svm_queue_t *
817 {
818  vl_api_registration_t *regp;
819  api_main_t *am = &api_main;
820 
821  /* Special case: vlib trying to send itself a message */
822  if (index == (u32) ~ 0)
823  return (am->shmem_hdr->vl_input_queue);
824 
826  if (!regp)
827  return 0;
828  return (regp->vl_input_queue);
829 }
830 
831 static clib_error_t *
833 {
834  atexit (vl_unmap_shmem);
835  return 0;
836 }
837 
839 
840 u8 *
841 format_api_message_rings (u8 * s, va_list * args)
842 {
843  api_main_t *am = va_arg (*args, api_main_t *);
844  vl_shmem_hdr_t *shmem_hdr = va_arg (*args, vl_shmem_hdr_t *);
845  int main_segment = va_arg (*args, int);
846  ring_alloc_t *ap;
847  int i;
848 
849  if (shmem_hdr == 0)
850  return format (s, "%8s %8s %8s %8s %8s\n",
851  "Owner", "Size", "Nitems", "Hits", "Misses");
852 
853  ap = shmem_hdr->vl_rings;
854 
855  for (i = 0; i < vec_len (shmem_hdr->vl_rings); i++)
856  {
857  s = format (s, "%8s %8d %8d %8d %8d\n",
858  "vlib", ap->size, ap->nitems, ap->hits, ap->misses);
859  ap++;
860  }
861 
862  ap = shmem_hdr->client_rings;
863 
864  for (i = 0; i < vec_len (shmem_hdr->client_rings); i++)
865  {
866  s = format (s, "%8s %8d %8d %8d %8d\n",
867  "clnt", ap->size, ap->nitems, ap->hits, ap->misses);
868  ap++;
869  }
870 
871  if (main_segment)
872  {
873  s = format (s, "%d ring miss fallback allocations\n", am->ring_misses);
874  s = format
875  (s,
876  "%d application restarts, %d reclaimed msgs, %d garbage collects\n",
877  shmem_hdr->application_restarts, shmem_hdr->restart_reclaims,
878  shmem_hdr->garbage_collects);
879  }
880  return s;
881 }
882 
883 static clib_error_t *
885  unformat_input_t * input, vlib_cli_command_t * cli_cmd)
886 {
887  int i;
888  vl_shmem_hdr_t *shmem_hdr;
889  api_main_t *am = &api_main;
890 
891  /* First, dump the primary region rings.. */
892 
893  if (am->vlib_primary_rp == 0 || am->vlib_primary_rp->user_ctx == 0)
894  {
895  vlib_cli_output (vm, "Shared memory segment not initialized...\n");
896  return 0;
897  }
898 
899  shmem_hdr = (void *) am->vlib_primary_rp->user_ctx;
900 
901  vlib_cli_output (vm, "Main API segment rings:");
902 
904  0 /* print header */ , 0 /* notused */ );
905 
907  shmem_hdr, 1 /* main segment */ );
908 
909  for (i = 0; i < vec_len (am->vlib_private_rps); i++)
910  {
911  svm_region_t *vlib_rp = am->vlib_private_rps[i];
912  shmem_hdr = (void *) vlib_rp->user_ctx;
913  vl_api_registration_t **regpp;
914  vl_api_registration_t *regp = 0;
915 
916  /* For horizontal scaling, add a hash table... */
917  /* *INDENT-OFF* */
918  pool_foreach (regpp, am->vl_clients,
919  ({
920  regp = *regpp;
921  if (regp && regp->vlib_rp == vlib_rp)
922  {
923  vlib_cli_output (vm, "%s segment rings:", regp->name);
924  goto found;
925  }
926  }));
927  vlib_cli_output (vm, "regp %llx not found?", regp);
928  continue;
929  /* *INDENT-ON* */
930  found:
932  0 /* print header */ , 0 /* notused */ );
934  shmem_hdr, 0 /* main segment */ );
935  }
936 
937  return 0;
938 }
939 
940 /*?
941  * Display binary api message allocation ring statistics
942 ?*/
943 /* *INDENT-OFF* */
944 VLIB_CLI_COMMAND (cli_show_api_ring_command, static) =
945 {
946  .path = "show api ring-stats",
947  .short_help = "Message ring statistics",
948  .function = vl_api_ring_command,
949 };
950 /* *INDENT-ON* */
951 
952 clib_error_t *
954 {
955  api_main_t *am = &api_main;
956  svm_map_region_args_t _a, *a = &_a;
957  clib_error_t *error;
958  u8 *remove_path1, *remove_path2;
959 
960  /*
961  * By popular request / to avoid support fires, remove any old api segment
962  * files Right Here.
963  */
964  if (am->root_path == 0)
965  {
966  remove_path1 = format (0, "/dev/shm/global_vm%c", 0);
967  remove_path2 = format (0, "/dev/shm/vpe-api%c", 0);
968  }
969  else
970  {
971  remove_path1 = format (0, "/dev/shm/%s-global_vm%c", am->root_path, 0);
972  remove_path2 = format (0, "/dev/shm/%s-vpe-api%c", am->root_path, 0);
973  }
974 
975  (void) unlink ((char *) remove_path1);
976  (void) unlink ((char *) remove_path2);
977 
978  vec_free (remove_path1);
979  vec_free (remove_path2);
980 
981  clib_memset (a, 0, sizeof (*a));
982  a->root_path = am->root_path;
984  a->baseva = (am->global_baseva != 0) ?
986  a->size = (am->global_size != 0) ? am->global_size : SVM_GLOBAL_REGION_SIZE;
987  a->flags = SVM_FLAGS_NODATA;
988  a->uid = am->api_uid;
989  a->gid = am->api_gid;
990  a->pvt_heap_size =
991  (am->global_pvt_heap_size !=
993 
995 
997 
998  return error;
999 }
1000 
1001 void
1003 {
1004  api_main_t *am = &api_main;
1005  am->region_name = name;
1006 }
1007 
1008 /*
1009  * fd.io coding-style-patch-verification: ON
1010  *
1011  * Local Variables:
1012  * eval: (c-set-style "gnu")
1013  * End:
1014  */
int vl_mem_api_handle_msg_private(vlib_main_t *vm, vlib_node_runtime_t *node, u32 reg_index)
Definition: memory_api.c:764
int vl_mem_api_handle_msg_main(vlib_main_t *vm, vlib_node_runtime_t *node)
Definition: memory_api.c:713
uword * pending_rpc_requests
Definition: main.h:243
static u32 vl_msg_api_handle_get_index(u32 index)
Definition: memory_api.h:48
void vl_api_memclnt_create_t_handler(vl_api_memclnt_create_t *mp)
Definition: memory_api.c:158
u8 * name
Client name.
Definition: api_common.h:52
#define SVM_GLOBAL_REGION_NAME
Definition: svm_common.h:97
const char * root_path
Definition: svm_common.h:67
static void * vl_api_memclnt_create_t_print(vl_api_memclnt_create_t *a, void *handle)
Definition: memory_api.c:42
static void vl_api_memclnt_keepalive_t_handler(vl_api_memclnt_keepalive_t *mp)
We can send ourselves these messages if someone uses the builtin binary api test tool...
Definition: memory_api.c:407
static void svm_pop_heap(void *oldheap)
Definition: svm.h:94
clib_spinlock_t pending_rpc_lock
Definition: main.h:245
#define vl_print(handle,...)
Definition: memory_api.c:31
int svm_queue_add(svm_queue_t *q, u8 *elem, int nowait)
Definition: queue.c:239
u32 vl_api_memclnt_create_internal(char *name, svm_queue_t *q)
Definition: memory_api.c:120
a
Definition: bitmap.h:538
#define SVM_FLAGS_NODATA
Definition: svm_common.h:29
static void send_memclnt_keepalive(vl_api_registration_t *regp, f64 now)
Definition: memory_api.c:496
int vl_map_shmem(const char *region_name, int is_vlib)
uword * processing_rpc_requests
Definition: main.h:244
volatile int ** vl_api_queue_cursizes
Definition: memory_api.c:61
u32 application_restarts
Definition: memory_shared.h:95
#define PREDICT_TRUE(x)
Definition: clib.h:112
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:255
void vl_unmap_shmem(void)
int svm_queue_sub2(svm_queue_t *q, u8 *elem)
Definition: queue.c:413
u8 * message_bounce
Don&#39;t automatically free message buffer vetor.
Definition: api_common.h:222
static_always_inline void clib_spinlock_unlock_if_init(clib_spinlock_t *p)
Definition: lock.h:98
Message configuration definition.
Definition: api_common.h:119
svm_region_t * vlib_primary_rp
Primary api segment descriptor.
Definition: api_common.h:258
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:522
uword virtual_base
Definition: svm_common.h:42
#define SVM_PVT_MHEAP_SIZE
Definition: svm_common.h:32
int i
int api_uid
uid for the api shared memory region
Definition: api_common.h:283
ring_alloc_t * client_rings
Definition: memory_shared.h:92
clib_memset(h->entries, 0, sizeof(h->entries[0])*entries)
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
#define pool_is_free(P, E)
Use free bitmap to query whether given element is free.
Definition: pool.h:275
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:236
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
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
double f64
Definition: types.h:142
_vl_msg_api_function_list_elt_t * reaper_function_registrations
List of API client reaper functions.
Definition: api_common.h:340
u8 * format_api_message_rings(u8 *s, va_list *args)
Definition: memory_api.c:841
u32 clib_file_index
Socket only: file index.
Definition: api_common.h:65
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:493
void vl_msg_api_barrier_sync(void)
Definition: api_shared.c:383
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:163
u32 ring_misses
Number of times that the ring allocator failed.
Definition: api_common.h:231
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
vl_api_registration_t * vl_mem_api_client_index_to_registration(u32 handle)
Definition: memory_api.c:787
volatile void * user_ctx
Definition: svm_common.h:47
static clib_error_t * vl_api_ring_command(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
Definition: memory_api.c:884
static u32 vl_msg_api_handle_from_index_and_epoch(u32 index, u32 epoch)
Definition: memory_api.h:54
void vl_api_memclnt_keepalive_reply_t_handler(vl_api_memclnt_keepalive_reply_t *mp)
client answered a ping, stave off the grim reaper...
Definition: memory_api.c:387
void vl_mem_api_dead_client_scan(api_main_t *am, vl_shmem_hdr_t *shm, f64 now)
Definition: memory_api.c:592
vlib_node_registration_t vl_api_clnt_node
(constructor) VLIB_REGISTER_NODE (vl_api_clnt_node)
Definition: vlib_api.c:438
const char * root_path
Chroot path to the shared memory API files.
Definition: api_common.h:331
#define clib_error_return(e, args...)
Definition: error.h:99
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
#define vlib_call_init_function(vm, x)
Definition: init.h:260
void vl_msg_api_send_shmem(svm_queue_t *q, u8 *elem)
static void vlib_set_queue_signal_callback(vlib_main_t *vm, void(*fp)(vlib_main_t *))
Definition: main.h:385
vl_registration_type_t registration_type
type
Definition: api_common.h:47
char * name
Definition: main.h:117
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
#define foreach_vlib_api_msg
Definition: memory_api.c:423
static void vlib_process_signal_event(vlib_main_t *vm, uword node_index, uword type_opaque, uword data)
Definition: node_funcs.h:964
svm_queue_t * vl_input_queue
shared memory only: pointer to client input queue
Definition: api_common.h:60
struct _unformat_input_t unformat_input_t
svm_region_t ** vlib_private_rps
Vector of all mapped shared-VM segments.
Definition: api_common.h:261
#define PREDICT_FALSE(x)
Definition: clib.h:111
uword virtual_size
Definition: svm_common.h:43
void svm_region_init_args(svm_map_region_args_t *a)
Definition: svm.c:916
#define SVM_GLOBAL_REGION_SIZE
Definition: svm_common.h:96
void vl_msg_api_handler_with_vm_node(api_main_t *am, void *the_msg, vlib_main_t *vm, vlib_node_runtime_t *node)
Definition: api_shared.c:463
u8 name[64]
Definition: memclnt.api:152
clib_error_t * vlibmemory_init(vlib_main_t *vm)
Definition: memory_api.c:953
volatile u32 queue_signal_pending
Definition: main.h:210
int vl_mem_api_handle_rpc(vlib_main_t *vm, vlib_node_runtime_t *node)
Definition: memory_api.c:721
clib_error_t * map_api_segment_init(vlib_main_t *vm)
Definition: memory_api.c:482
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
An API client registration, only in vpp/vlib.
Definition: api_common.h:45
Shared memory connection.
Definition: api_common.h:37
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
vlib_main_t * vm
Definition: buffer.c:312
svm_queue_t * vl_api_client_index_to_input_queue(u32 index)
Definition: memory_api.c:816
u64 global_baseva
base virtual address for global VM region
Definition: api_common.h:289
static clib_error_t * setup_memclnt_exit(vlib_main_t *vm)
Definition: memory_api.c:832
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
#define clib_warning(format, args...)
Definition: error.h:59
static void * vl_api_memclnt_delete_t_print(vl_api_memclnt_delete_t *a, void *handle)
Definition: memory_api.c:53
u8 * vl_api_serialize_message_table(api_main_t *am, u8 *vector)
Definition: vlib_api.c:72
static int void_mem_api_handle_msg_i(api_main_t *am, vlib_main_t *vm, vlib_node_runtime_t *node, svm_queue_t *q)
Definition: memory_api.c:700
clib_error_t * vlibsocket_init(vlib_main_t *vm)
Definition: socket_api.c:794
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
svm_queue_t * vl_input_queue
Definition: memory_shared.h:84
void svm_queue_free(svm_queue_t *q)
Definition: queue.c:89
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:155
static u32 vl_msg_api_handle_get_epoch(u32 index)
Definition: memory_api.h:42
#define pool_put_index(p, i)
Free pool element with given index.
Definition: pool.h:311
#define ASSERT(truth)
int vl_mem_api_init(const char *region_name)
Definition: memory_api.c:433
#define vec_delete(V, N, M)
Delete N elements starting at element M.
Definition: vec.h:784
static u8 vl_msg_api_handle_is_valid(u32 handle, u32 restarts)
Definition: memory_api.h:64
static void vl_mem_send_client_keepalive_w_reg(api_main_t *am, f64 now, vl_api_registration_t **regpp, u32 **dead_indices, u32 **confused_indices)
Definition: memory_api.c:548
static void clib_mem_free(void *p)
Definition: mem.h:205
void vl_set_memory_region_name(const char *name)
Definition: memory_api.c:1002
u64 svm_get_global_region_base_va()
Definition: svm.c:62
u8 * serialized_message_table_in_shmem
vlib/vpp only: serialized (message, name, crc) table
Definition: api_common.h:271
#define clib_error_report(e)
Definition: error.h:113
u64 global_pvt_heap_size
size of the global VM private mheap
Definition: api_common.h:298
void vl_api_memclnt_delete_t_handler(vl_api_memclnt_delete_t *mp)
Definition: memory_api.c:263
static void * clib_mem_alloc(uword size)
Definition: mem.h:132
static uword pointer_to_uword(const void *p)
Definition: types.h:131
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
void vl_msg_api_free(void *)
#define MMAP_PAGESIZE
Definition: ssvm.h:42
#define VL_API_EPOCH_MASK
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
const char * name
Definition: svm_common.h:68
static void memclnt_queue_callback(vlib_main_t *vm)
Definition: memory_api.c:64
u64 uword
Definition: types.h:112
#define clib_unix_warning(format, args...)
Definition: error.h:68
u32 vl_api_registration_pool_index
Index in VLIB&#39;s brain (not shared memory).
Definition: api_common.h:50
void svm_client_scan_this_region_nolock(svm_region_t *rp)
Definition: svm.c:1262
volatile u32 api_queue_nonempty
Definition: main.h:211
struct _svm_queue svm_queue_t
u8 * is_mp_safe
Message is mp safe vector.
Definition: api_common.h:225
void vl_msg_api_increment_missing_client_counter(void)
Definition: api_shared.c:44
int vl_api_call_reaper_functions(u32 client_index)
Definition: memory_api.c:243
void * vl_msg_api_alloc_as_if_client(int nbytes)
const char * region_name
Shared VM binary API region name.
Definition: api_common.h:328
void vl_msg_api_barrier_release(void)
Definition: api_shared.c:388
api_main_t api_main
Definition: api_shared.c:35
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:725
static_always_inline void clib_spinlock_lock_if_init(clib_spinlock_t *p)
Definition: lock.h:82
svm_region_t * vlib_rp
Definition: api_common.h:61
pthread_mutex_t mutex
Definition: svm_common.h:37