FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * api.c - message handler registration
4  *
5  * Copyright (c) 2010-2018 Cisco and/or its affiliates.
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *------------------------------------------------------------------
18  */
19 
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <string.h>
23 #include <sys/types.h>
24 #include <sys/mman.h>
25 #include <sys/stat.h>
26 #include <netinet/in.h>
27 #include <signal.h>
28 #include <pthread.h>
29 #include <unistd.h>
30 #include <time.h>
31 #include <fcntl.h>
32 #include <string.h>
33 #include <pwd.h>
34 #include <grp.h>
35 
36 #include <vppinfra/clib.h>
37 #include <vppinfra/vec.h>
38 #include <vppinfra/hash.h>
39 #include <vppinfra/bitmap.h>
40 #include <vppinfra/fifo.h>
41 #include <vppinfra/time.h>
42 #include <vppinfra/mheap.h>
43 #include <vppinfra/heap.h>
44 #include <vppinfra/pool.h>
45 #include <vppinfra/format.h>
46 #include <vppinfra/error.h>
47 
48 #include <vnet/api_errno.h>
49 #include <vnet/vnet.h>
50 
51 #include <vlib/vlib.h>
52 #include <vlib/unix/unix.h>
53 #include <vlibapi/api.h>
54 #include <vlibmemory/api.h>
55 
56 #undef BIHASH_TYPE
57 #undef __included_bihash_template_h__
58 
59 #include <vnet/ip/format.h>
60 
61 #include <vpp/api/vpe_msg_enum.h>
62 
63 #define vl_typedefs /* define message structures */
64 #include <vpp/api/vpe_all_api_h.h>
65 #undef vl_typedefs
66 #define vl_endianfun /* define message structures */
67 #include <vpp/api/vpe_all_api_h.h>
68 #undef vl_endianfun
69 /* instantiate all the print functions we know about */
70 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
71 #define vl_printfun
72 #include <vpp/api/vpe_all_api_h.h>
73 #undef vl_printfun
75 
76 #define foreach_vpe_api_msg \
77 _(CONTROL_PING, control_ping) \
78 _(CLI, cli) \
79 _(CLI_INBAND, cli_inband) \
80 _(GET_NODE_INDEX, get_node_index) \
81 _(ADD_NODE_NEXT, add_node_next) \
82 _(SHOW_VERSION, show_version) \
83 _(SHOW_THREADS, show_threads) \
84 _(GET_NODE_GRAPH, get_node_graph) \
85 _(GET_NEXT_INDEX, get_next_index) \
86 
87 #define QUOTE_(x) #x
88 #define QUOTE(x) QUOTE_(x)
89 
90 typedef enum
91 {
94 } resolve_t;
95 
97 
98 /* Clean up all registrations belonging to the indicated client */
99 static clib_error_t *
101 {
104  uword *p;
105 
106 #define _(a) \
107  p = hash_get (vam->a##_registration_hash, client_index); \
108  if (p) { \
109  rp = pool_elt_at_index (vam->a##_registrations, p[0]); \
110  pool_put (vam->a##_registrations, rp); \
111  hash_unset (vam->a##_registration_hash, client_index); \
112  }
114 #undef _
115  return 0;
116 }
117 
119 
120 static void
122 {
124  int rv = 0;
125 
126  /* *INDENT-OFF* */
127  REPLY_MACRO2(VL_API_CONTROL_PING_REPLY,
128  ({
129  rmp->vpe_pid = ntohl (getpid());
130  }));
131  /* *INDENT-ON* */
132 }
133 
134 static void
135 shmem_cli_output (uword arg, u8 * buffer, uword buffer_bytes)
136 {
137  u8 **shmem_vecp = (u8 **) arg;
138  u8 *shmem_vec;
139  void *oldheap;
140  api_main_t *am = &api_main;
141  u32 offset;
142 
143  shmem_vec = *shmem_vecp;
144 
145  offset = vec_len (shmem_vec);
146 
147  pthread_mutex_lock (&am->vlib_rp->mutex);
148  oldheap = svm_push_data_heap (am->vlib_rp);
149 
150  vec_validate (shmem_vec, offset + buffer_bytes - 1);
151 
152  clib_memcpy (shmem_vec + offset, buffer, buffer_bytes);
153 
154  svm_pop_heap (oldheap);
155  pthread_mutex_unlock (&am->vlib_rp->mutex);
156 
157  *shmem_vecp = shmem_vec;
158 }
159 
160 
161 static void
163 {
164  vl_api_cli_reply_t *rp;
167  api_main_t *am = &api_main;
168  unformat_input_t input;
169  u8 *shmem_vec = 0;
170  void *oldheap;
171 
173  if (!reg)
174  return;;
175 
176  rp = vl_msg_api_alloc (sizeof (*rp));
177  rp->_vl_msg_id = ntohs (VL_API_CLI_REPLY);
178  rp->context = mp->context;
179 
180  unformat_init_vector (&input, (u8 *) (uword) mp->cmd_in_shmem);
181 
182  vlib_cli_input (vm, &input, shmem_cli_output, (uword) & shmem_vec);
183 
184  pthread_mutex_lock (&am->vlib_rp->mutex);
185  oldheap = svm_push_data_heap (am->vlib_rp);
186 
187  vec_add1 (shmem_vec, 0);
188 
189  svm_pop_heap (oldheap);
190  pthread_mutex_unlock (&am->vlib_rp->mutex);
191 
192  rp->reply_in_shmem = (uword) shmem_vec;
193 
194  vl_api_send_msg (reg, (u8 *) rp);
195 }
196 
197 static void
198 inband_cli_output (uword arg, u8 * buffer, uword buffer_bytes)
199 {
200  u8 **mem_vecp = (u8 **) arg;
201  u8 *mem_vec = *mem_vecp;
202  u32 offset = vec_len (mem_vec);
203 
204  vec_validate (mem_vec, offset + buffer_bytes - 1);
205  clib_memcpy (mem_vec + offset, buffer, buffer_bytes);
206  *mem_vecp = mem_vec;
207 }
208 
209 static void
211 {
213  int rv = 0;
215  unformat_input_t input;
216  u8 *out_vec = 0;
217  u32 len = 0;
218 
219  if (vl_msg_api_get_msg_length (mp) <
220  vl_api_string_len (&mp->cmd) + sizeof (*mp))
221  {
222  rv = -1;
223  goto error;
224  }
225 
226  unformat_init_string (&input, (char *) vl_api_from_api_string (&mp->cmd),
227  vl_api_string_len (&mp->cmd));
228  vlib_cli_input (vm, &input, inband_cli_output, (uword) & out_vec);
229 
230  len = vec_len (out_vec);
231 
232 error:
233  /* *INDENT-OFF* */
234  REPLY_MACRO3(VL_API_CLI_INBAND_REPLY, len,
235  ({
236  vl_api_to_api_string(len, (const char *)out_vec, &rmp->reply);
237  }));
238  /* *INDENT-ON* */
239  vec_free (out_vec);
240 }
241 
242 static void
244 {
246  int rv = 0;
247  char *vpe_api_get_build_directory (void);
248  char *vpe_api_get_version (void);
249  char *vpe_api_get_build_date (void);
250 
251  u32 program_len = strnlen_s ("vpe", 32);
252  u32 version_len = strnlen_s (vpe_api_get_version (), 32);
253  u32 build_date_len = strnlen_s (vpe_api_get_build_date (), 32);
254  u32 build_directory_len = strnlen_s (vpe_api_get_build_directory (), 256);
255 
256  u32 n = program_len + version_len + build_date_len + build_directory_len;
257 
258  /* *INDENT-OFF* */
259  REPLY_MACRO3(VL_API_SHOW_VERSION_REPLY, n,
260  ({
261  char *p = (char *)&rmp->program;
262  p += vl_api_to_api_string(program_len, "vpe", (vl_api_string_t *)p);
263  p += vl_api_to_api_string(version_len, vpe_api_get_version(), (vl_api_string_t *)p);
264  p += vl_api_to_api_string(build_date_len, vpe_api_get_build_date(), (vl_api_string_t *)p);
266  }));
267  /* *INDENT-ON* */
268 }
269 
270 static void
272 {
274  td->id = htonl (index);
275  if (w->name)
276  strncpy ((char *) td->name, (char *) w->name, ARRAY_LEN (td->name) - 1);
277  if (w->registration)
278  strncpy ((char *) td->type, (char *) w->registration->name,
279  ARRAY_LEN (td->type) - 1);
280  td->pid = htonl (w->lwp);
281  td->cpu_id = htonl (w->cpu_id);
282  td->core = htonl (w->core_id);
283  td->cpu_socket = htonl (w->socket_id);
284 }
285 
286 static void
288 {
290  int rv = 0, count = 0;
291 
292 #if !defined(__powerpc64__)
296  int i, msg_size = 0;
298  if (!count)
299  return;
300 
301  msg_size = sizeof (*rmp) + sizeof (rmp->thread_data[0]) * count;
303  if (!reg)
304  return;
305 
306  rmp = vl_msg_api_alloc (msg_size);
307  clib_memset (rmp, 0, msg_size);
308  rmp->_vl_msg_id = htons (VL_API_SHOW_THREADS_REPLY);
309  rmp->context = mp->context;
310  rmp->count = htonl (count);
311  td = rmp->thread_data;
312 
313  for (i = 0; i < count; i++)
314  {
315  get_thread_data (&td[i], i);
316  }
317 
318  vl_api_send_msg (reg, (u8 *) rmp);
319 #else
320 
321  /* unimplemented support */
322  rv = -9;
323  clib_warning ("power pc does not support show threads api");
324  /* *INDENT-OFF* */
325  REPLY_MACRO2(VL_API_SHOW_THREADS_REPLY,
326  ({
327  rmp->count = htonl(count);
328  }));
329  /* *INDENT-ON* */
330 #endif
331 }
332 
333 static void
335 {
338  vlib_node_t *n;
339  int rv = 0;
340  u32 node_index = ~0;
341 
342  n = vlib_get_node_by_name (vm, mp->node_name);
343 
344  if (n == 0)
345  rv = VNET_API_ERROR_NO_SUCH_NODE;
346  else
347  node_index = n->index;
348 
349  /* *INDENT-OFF* */
350  REPLY_MACRO2(VL_API_GET_NODE_INDEX_REPLY,
351  ({
352  rmp->node_index = ntohl(node_index);
353  }));
354  /* *INDENT-ON* */
355 }
356 
357 static void
359 {
362  vlib_node_t *node, *next_node;
363  int rv = 0;
364  u32 next_node_index = ~0, next_index = ~0;
365  uword *p;
366 
367  node = vlib_get_node_by_name (vm, mp->node_name);
368 
369  if (node == 0)
370  {
371  rv = VNET_API_ERROR_NO_SUCH_NODE;
372  goto out;
373  }
374 
375  next_node = vlib_get_node_by_name (vm, mp->next_name);
376 
377  if (next_node == 0)
378  {
379  rv = VNET_API_ERROR_NO_SUCH_NODE2;
380  goto out;
381  }
382  else
383  next_node_index = next_node->index;
384 
385  p = hash_get (node->next_slot_by_node, next_node_index);
386 
387  if (p == 0)
388  {
389  rv = VNET_API_ERROR_NO_SUCH_ENTRY;
390  goto out;
391  }
392  else
393  next_index = p[0];
394 
395 out:
396  /* *INDENT-OFF* */
397  REPLY_MACRO2(VL_API_GET_NEXT_INDEX_REPLY,
398  ({
399  rmp->next_index = ntohl(next_index);
400  }));
401  /* *INDENT-ON* */
402 }
403 
404 static void
406 {
409  vlib_node_t *n, *next;
410  int rv = 0;
411  u32 next_index = ~0;
412 
413  n = vlib_get_node_by_name (vm, mp->node_name);
414 
415  if (n == 0)
416  {
417  rv = VNET_API_ERROR_NO_SUCH_NODE;
418  goto out;
419  }
420 
421  next = vlib_get_node_by_name (vm, mp->next_name);
422 
423  if (next == 0)
424  rv = VNET_API_ERROR_NO_SUCH_NODE2;
425  else
426  next_index = vlib_node_add_next (vm, n->index, next->index);
427 
428 out:
429  /* *INDENT-OFF* */
430  REPLY_MACRO2(VL_API_GET_NODE_INDEX_REPLY,
431  ({
432  rmp->next_index = ntohl(next_index);
433  }));
434  /* *INDENT-ON* */
435 }
436 
437 static void
439 {
440  int rv = 0;
441  u8 *vector = 0;
442  api_main_t *am = &api_main;
444  void *oldheap;
446  static vlib_node_t ***node_dups;
447  static vlib_main_t **stat_vms;
448 
449  pthread_mutex_lock (&am->vlib_rp->mutex);
450  oldheap = svm_push_data_heap (am->vlib_rp);
451 
452  /*
453  * Keep the number of memcpy ops to a minimum (e.g. 1).
454  */
455  vec_validate (vector, 16384);
456  vec_reset_length (vector);
457 
458  vlib_node_get_nodes (vm, 0 /* main threads */ ,
459  0 /* include stats */ ,
460  1 /* barrier sync */ ,
461  &node_dups, &stat_vms);
462  vector = vlib_node_serialize (vm, node_dups, vector, 1 /* include nexts */ ,
463  1 /* include stats */ );
464 
465  svm_pop_heap (oldheap);
466  pthread_mutex_unlock (&am->vlib_rp->mutex);
467 
468  /* *INDENT-OFF* */
469  REPLY_MACRO2(VL_API_GET_NODE_GRAPH_REPLY,
470  ({
471  rmp->reply_in_shmem = (uword) vector;
472  }));
473  /* *INDENT-ON* */
474 }
475 
476 #define BOUNCE_HANDLER(nn) \
477 static void vl_api_##nn##_t_handler ( \
478  vl_api_##nn##_t *mp) \
479 { \
480  vpe_client_registration_t *reg; \
481  vpe_api_main_t * vam = &vpe_api_main; \
482  svm_queue_t * q; \
483  \
484  /* One registration only... */ \
485  pool_foreach(reg, vam->nn##_registrations, \
486  ({ \
487  q = vl_api_client_index_to_input_queue (reg->client_index); \
488  if (q) { \
489  /* \
490  * If the queue is stuffed, turf the msg and complain \
491  * It's unlikely that the intended recipient is \
492  * alive; avoid deadlock at all costs. \
493  */ \
494  if (q->cursize == q->maxsize) { \
495  clib_warning ("ERROR: receiver queue full, drop msg"); \
496  vl_msg_api_free (mp); \
497  return; \
498  } \
499  vl_msg_api_send_shmem (q, (u8 *)&mp); \
500  return; \
501  } \
502  })); \
503  vl_msg_api_free (mp); \
504 }
505 
506 static void setup_message_id_table (api_main_t * am);
507 
508 /*
509  * vpe_api_hookup
510  * Add vpe's API message handlers to the table.
511  * vlib has already mapped shared memory and
512  * added the client registration handlers.
513  * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
514  */
515 static clib_error_t *
517 {
518  api_main_t *am = &api_main;
519 
520 #define _(N,n) \
521  vl_msg_api_set_handlers(VL_API_##N, #n, \
522  vl_api_##n##_t_handler, \
523  vl_noop_handler, \
524  vl_api_##n##_t_endian, \
525  vl_api_##n##_t_print, \
526  sizeof(vl_api_##n##_t), 1);
528 #undef _
529 
530  /*
531  * Trace space for classifier mask+match
532  */
533  am->api_trace_cfg[VL_API_CLASSIFY_ADD_DEL_TABLE].size += 5 * sizeof (u32x4);
534  am->api_trace_cfg[VL_API_CLASSIFY_ADD_DEL_SESSION].size
535  += 5 * sizeof (u32x4);
536 
537  /*
538  * Thread-safe API messages
539  */
540  am->is_mp_safe[VL_API_CONTROL_PING] = 1;
541  am->is_mp_safe[VL_API_CONTROL_PING_REPLY] = 1;
542  am->is_mp_safe[VL_API_IP_ADD_DEL_ROUTE] = 1;
543  am->is_mp_safe[VL_API_GET_NODE_GRAPH] = 1;
544 
545  /*
546  * Set up the (msg_name, crc, message-id) table
547  */
549 
550  return 0;
551 }
552 
554 
555 clib_error_t *
557 {
559 
560  am->vlib_main = vm;
561  am->vnet_main = vnet_get_main ();
562 #define _(a) \
563  am->a##_registration_hash = hash_create (0, sizeof (uword));
565 #undef _
566 
567  vl_set_memory_region_name ("/vpe-api");
568  vl_mem_api_enable_disable (vm, 1 /* enable it */ );
569 
570  return 0;
571 }
572 
573 static clib_error_t *
575 {
576  u8 *chroot_path;
577  u64 baseva, size, pvt_heap_size;
578  int uid, gid, rv;
579  const int max_buf_size = 4096;
580  char *s, *buf;
581  struct passwd _pw, *pw;
582  struct group _grp, *grp;
583  clib_error_t *e;
584  buf = vec_new (char, 128);
586  {
587  if (unformat (input, "prefix %s", &chroot_path))
588  {
589  vec_add1 (chroot_path, 0);
590  vl_set_memory_root_path ((char *) chroot_path);
591  }
592  else if (unformat (input, "uid %d", &uid))
593  vl_set_memory_uid (uid);
594  else if (unformat (input, "gid %d", &gid))
595  vl_set_memory_gid (gid);
596  else if (unformat (input, "baseva %llx", &baseva))
598  else if (unformat (input, "global-size %lldM", &size))
599  vl_set_global_memory_size (size * (1ULL << 20));
600  else if (unformat (input, "global-size %lldG", &size))
601  vl_set_global_memory_size (size * (1ULL << 30));
602  else if (unformat (input, "global-size %lld", &size))
604  else if (unformat (input, "global-pvt-heap-size %lldM", &pvt_heap_size))
605  vl_set_global_pvt_heap_size (pvt_heap_size * (1ULL << 20));
606  else if (unformat (input, "global-pvt-heap-size size %lld",
607  &pvt_heap_size))
608  vl_set_global_pvt_heap_size (pvt_heap_size);
609  else if (unformat (input, "api-pvt-heap-size %lldM", &pvt_heap_size))
610  vl_set_api_pvt_heap_size (pvt_heap_size * (1ULL << 20));
611  else if (unformat (input, "api-pvt-heap-size size %lld",
612  &pvt_heap_size))
613  vl_set_api_pvt_heap_size (pvt_heap_size);
614  else if (unformat (input, "api-size %lldM", &size))
615  vl_set_api_memory_size (size * (1ULL << 20));
616  else if (unformat (input, "api-size %lldG", &size))
617  vl_set_api_memory_size (size * (1ULL << 30));
618  else if (unformat (input, "api-size %lld", &size))
619  vl_set_api_memory_size (size);
620  else if (unformat (input, "uid %s", &s))
621  {
622  /* lookup the username */
623  pw = NULL;
624  while (((rv =
625  getpwnam_r (s, &_pw, buf, vec_len (buf), &pw)) == ERANGE)
626  && (vec_len (buf) <= max_buf_size))
627  {
628  vec_resize (buf, vec_len (buf) * 2);
629  }
630  if (rv < 0)
631  {
632  e = clib_error_return_code (0, rv,
635  "cannot fetch username %s", s);
636  vec_free (s);
637  vec_free (buf);
638  return e;
639  }
640  if (pw == NULL)
641  {
642  e =
643  clib_error_return_fatal (0, "username %s does not exist", s);
644  vec_free (s);
645  vec_free (buf);
646  return e;
647  }
648  vec_free (s);
649  vl_set_memory_uid (pw->pw_uid);
650  }
651  else if (unformat (input, "gid %s", &s))
652  {
653  /* lookup the group name */
654  grp = NULL;
655  while (((rv =
656  getgrnam_r (s, &_grp, buf, vec_len (buf), &grp)) == ERANGE)
657  && (vec_len (buf) <= max_buf_size))
658  {
659  vec_resize (buf, vec_len (buf) * 2);
660  }
661  if (rv != 0)
662  {
663  e = clib_error_return_code (0, rv,
666  "cannot fetch group %s", s);
667  vec_free (s);
668  vec_free (buf);
669  return e;
670  }
671  if (grp == NULL)
672  {
673  e = clib_error_return_fatal (0, "group %s does not exist", s);
674  vec_free (s);
675  vec_free (buf);
676  return e;
677  }
678  vec_free (s);
679  vec_free (buf);
680  vl_set_memory_gid (grp->gr_gid);
681  }
682  else
683  return clib_error_return (0, "unknown input `%U'",
684  format_unformat_error, input);
685  }
686  return 0;
687 }
688 
690 
691 void *
693 {
694  return (void *) &unformat_vnet_sw_interface;
695 }
696 
697 static u8 *
698 format_arp_event (u8 * s, va_list * args)
699 {
700  vl_api_ip4_arp_event_t *event = va_arg (*args, vl_api_ip4_arp_event_t *);
701 
702  s = format (s, "pid %d: ", ntohl (event->pid));
703  s = format (s, "resolution for %U", format_ip4_address, &event->address);
704  return s;
705 }
706 
707 static u8 *
708 format_nd_event (u8 * s, va_list * args)
709 {
710  vl_api_ip6_nd_event_t *event = va_arg (*args, vl_api_ip6_nd_event_t *);
711 
712  s = format (s, "pid %d: ", ntohl (event->pid));
713  s = format (s, "resolution for %U", format_ip6_address, event->address);
714  return s;
715 }
716 
717 static clib_error_t *
719  unformat_input_t * input, vlib_cli_command_t * cmd)
720 {
722  vl_api_ip4_arp_event_t *arp_event;
723  vl_api_ip6_nd_event_t *nd_event;
724 
725  if (pool_elts (am->arp_events) == 0 && pool_elts (am->nd_events) == 0 &&
726  pool_elts (am->wc_ip4_arp_events_registrations) == 0 &&
727  pool_elts (am->wc_ip6_nd_events_registrations) == 0)
728  {
729  vlib_cli_output (vm, "No active arp or nd event registrations");
730  return 0;
731  }
732 
733  /* *INDENT-OFF* */
734  pool_foreach (arp_event, am->arp_events,
735  ({
736  vlib_cli_output (vm, "%U", format_arp_event, arp_event);
737  }));
738 
740  pool_foreach(reg, am->wc_ip4_arp_events_registrations,
741  ({
742  vlib_cli_output (vm, "pid %d: bd mac/ip4 binding events",
743  ntohl (reg->client_pid));
744  }));
745 
746  pool_foreach (nd_event, am->nd_events,
747  ({
748  vlib_cli_output (vm, "%U", format_nd_event, nd_event);
749  }));
750 
751  pool_foreach(reg, am->wc_ip6_nd_events_registrations,
752  ({
753  vlib_cli_output (vm, "pid %d: bd mac/ip6 binding events",
754  ntohl (reg->client_pid));
755  }));
756  /* *INDENT-ON* */
757 
758  return 0;
759 }
760 
761 /* *INDENT-OFF* */
762 VLIB_CLI_COMMAND (show_ip_arp_nd_events, static) = {
763  .path = "show arp-nd-event registrations",
764  .function = show_ip_arp_nd_events_fn,
765  .short_help = "Show ip4 arp and ip6 nd event registrations",
766 };
767 /* *INDENT-ON* */
768 
769 #define vl_msg_name_crc_list
770 #include <vpp/api/vpe_all_api_h.h>
771 #undef vl_msg_name_crc_list
772 
773 static void
775 {
776 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
777  foreach_vl_msg_name_crc_memclnt;
778  foreach_vl_msg_name_crc_vpe;
779 #undef _
780 
781 #define vl_api_version_tuple(n,mj, mi, p) \
782  vl_msg_api_add_version (am, #n, mj, mi, p);
783 #include <vpp/api/vpe_all_api_h.h>
784 #undef vl_api_version_tuple
785 }
786 
787 
788 /*
789  * fd.io coding-style-patch-verification: ON
790  *
791  * Local Variables:
792  * eval: (c-set-style "gnu")
793  * End:
794  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:439
static clib_error_t * memclnt_delete_callback(u32 client_index)
Definition: api.c:100
vnet_main_t * vnet_main
static void svm_pop_heap(void *oldheap)
Definition: svm.h:94
Reply for get next node index.
Definition: vpe.api:281
vpe parser cli string response
Definition: vpe.api:103
#define foreach_vpe_api_msg
Definition: api.c:76
show_threads_reply
Definition: vpe.api:233
void vl_set_global_memory_baseva(u64 baseva)
static void vl_api_cli_t_handler(vl_api_cli_t *mp)
Definition: api.c:162
void vlib_cli_input(vlib_main_t *vm, unformat_input_t *input, vlib_cli_output_function_t *function, uword function_arg)
Definition: cli.c:725
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
Optimized string handling code, including c11-compliant "safe C library" variants.
Control ping from client to api server request.
Definition: vpe.api:60
int size
for sanity checking
Definition: api_common.h:81
void vl_set_memory_uid(int uid)
unsigned long u64
Definition: types.h:89
Fixed length block allocator.
void vl_set_global_pvt_heap_size(u64 size)
vl_api_thread_data_t thread_data[count]
Definition: vpe.api:238
#define REPLY_MACRO2(t, body)
#define NULL
Definition: clib.h:58
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
u32 index
Definition: node.h:304
VLIB_API_INIT_FUNCTION(vpe_api_hookup)
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:34
static int vl_api_to_api_string(u32 len, const char *buf, vl_api_string_t *str)
Definition: api_types.h:35
static clib_error_t * api_segment_config(vlib_main_t *vm, unformat_input_t *input)
Definition: api.c:574
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:525
int i
vlib_main_t * vlib_main
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
unformat_function_t unformat_vnet_sw_interface
u8 * vlib_node_serialize(vlib_main_t *vm, vlib_node_t ***node_dups, u8 *vector, int include_nexts, int include_stats)
void * vl_msg_api_alloc(int nbytes)
static uword vlib_node_add_next(vlib_main_t *vm, uword node, uword next_node)
Definition: node_funcs.h:1092
unsigned char u8
Definition: types.h:56
trace_cfg_t * api_trace_cfg
Current trace configuration.
Definition: api_common.h:249
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
Process a vpe parser cli string request.
Definition: vpe.api:85
void vl_set_global_memory_size(u64 size)
resolve_t
Definition: api.c:90
#define clib_memcpy(d, s, n)
Definition: string.h:180
format_function_t format_ip4_address
Definition: format.h:75
static void vl_api_get_next_index_t_handler(vl_api_get_next_index_t *mp)
Definition: api.c:358
Get node index using name request.
Definition: vpe.api:133
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:490
static void vl_api_get_node_graph_t_handler(vl_api_get_node_graph_t *mp)
Definition: api.c:438
static void * svm_push_data_heap(svm_region_t *rp)
Definition: svm.h:86
u32 context
Definition: vpe.api:88
void vlib_node_get_nodes(vlib_main_t *vm, u32 max_threads, int include_stats, int barrier_sync, vlib_node_t ****node_dupsp, vlib_main_t ***stat_vmsp)
Get list of nodes.
Definition: node.c:569
#define vec_new(T, N)
Create new vector of given type and length (unspecified alignment, no header).
Definition: vec.h:311
struct _vl_api_ip4_arp_event * arp_events
#define clib_error_return_fatal(e, args...)
Definition: error.h:105
#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
get_node_graph_reply
Definition: vpe.api:255
#define vec_resize(V, N)
Resize a vector (no header, unspecified alignment) Add N elements to end of given vector V...
Definition: vec.h:242
unsigned int u32
Definition: types.h:88
void unformat_init_string(unformat_input_t *input, char *string, int string_len)
Definition: unformat.c:1023
size_t strnlen_s(const char *s, size_t maxsize)
compute the length in s, no more than maxsize
Definition: string.c:433
u64 cmd_in_shmem
Definition: vpe.api:89
void vl_set_memory_root_path(const char *name)
vlib_worker_thread_t * vlib_worker_threads
Definition: threads.c:36
#define hash_get(h, key)
Definition: hash.h:249
uword size
static void shmem_cli_output(uword arg, u8 *buffer, uword buffer_bytes)
Definition: api.c:135
static void vl_api_get_node_index_t_handler(vl_api_get_node_index_t *mp)
Definition: api.c:334
char * vpe_api_get_version(void)
Return the image version string.
Definition: version.c:153
struct _unformat_input_t unformat_input_t
static u8 * format_nd_event(u8 *s, va_list *args)
Definition: api.c:708
Tell client about an IP4 ARP resolution event or MAC/IP info from ARP requests in L2 BDs...
Definition: ip.api:836
void vl_set_api_pvt_heap_size(u64 size)
u32 client_index
Definition: vpe.api:87
#define REPLY_MACRO3(t, n, body)
struct _vl_api_ip6_nd_event * nd_events
u8 len
Definition: ip_types.api:49
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:202
IP Set the next node for a given node response.
Definition: vpe.api:159
Get node index using name request.
Definition: vpe.api:121
void unformat_init_vector(unformat_input_t *input, u8 *vector_string)
Definition: unformat.c:1031
static void vl_api_add_node_next_t_handler(vl_api_add_node_next_t *mp)
Definition: api.c:405
An API client registration, only in vpp/vlib.
Definition: api_common.h:45
void vl_mem_api_enable_disable(vlib_main_t *vm, int yesno)
Definition: vlib_api.c:448
#define VLIB_EARLY_CONFIG_FUNCTION(x, n,...)
Definition: init.h:216
#define UNFORMAT_END_OF_INPUT
Definition: format.h:144
static u32 vl_api_string_len(vl_api_string_t *astr)
Definition: api_types.h:50
format_function_t format_ip6_address
Definition: format.h:93
vlib_main_t * vm
Definition: buffer.c:301
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
clib_error_t * vpe_api_init(vlib_main_t *vm)
Definition: api.c:556
static u8 * vl_api_from_api_string(vl_api_string_t *astr)
Definition: api_types.h:44
#define clib_warning(format, args...)
Definition: error.h:59
char * vpe_api_get_build_directory(void)
Return the image build directory name.
Definition: version.c:146
void vl_set_memory_gid(int gid)
static void inband_cli_output(uword arg, u8 *buffer, uword buffer_bytes)
Definition: api.c:198
static void vl_api_show_version_t_handler(vl_api_show_version_t *mp)
Definition: api.c:243
thread data
Definition: vpe.api:216
#define ARRAY_LEN(x)
Definition: clib.h:62
vlib_node_t * vlib_get_node_by_name(vlib_main_t *vm, u8 *name)
Definition: node.c:45
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:155
static clib_error_t * show_ip_arp_nd_events_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: api.c:718
static void vl_api_cli_inband_t_handler(vl_api_cli_inband_t *mp)
Definition: api.c:210
static void setup_message_id_table(api_main_t *am)
Definition: api.c:774
Control ping from the client to the server response.
Definition: vpe.api:72
void vl_set_memory_region_name(const char *name)
Definition: memory_api.c:985
Bitmaps built as vectors of machine words.
Set the next node for a given node request.
Definition: vpe.api:146
uword * next_slot_by_node
Definition: node.h:372
Query relative index via node names.
Definition: vpe.api:268
show version
Definition: vpe.api:170
size_t count
Definition: vapi.c:47
static void vl_api_show_threads_t_handler(vl_api_show_threads_t *mp)
Definition: api.c:287
VL_MSG_API_REAPER_FUNCTION(memclnt_delete_callback)
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
template key/value backing page structure
Definition: bihash_doc.h:44
u64 reply_in_shmem
Definition: vpe.api:107
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
void * get_unformat_vnet_sw_interface(void)
Definition: api.c:692
u64 uword
Definition: types.h:112
static u8 * format_arp_event(u8 *s, va_list *args)
Definition: api.c:698
static void get_thread_data(vl_api_thread_data_t *td, int index)
Definition: api.c:271
show version response
Definition: vpe.api:183
vpe_api_main_t vpe_api_main
Definition: pipe_api.c:39
Tell client about an IP6 ND resolution or MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs...
Definition: ip.api:878
static void vl_api_control_ping_t_handler(vl_api_control_ping_t *mp)
Definition: api.c:121
struct clib_bihash_value offset
template key/value backing page structure
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
char * vpe_api_get_build_date(void)
return the build date
Definition: version.c:160
void vl_set_api_memory_size(u64 size)
u8 * is_mp_safe
Message is mp safe vector.
Definition: api_common.h:225
#define clib_error_return_code(e, code, flags, args...)
Definition: error.h:93
unsigned long long u32x4
Definition: ixge.c:28
u32 vl_msg_api_get_msg_length(void *msg_arg)
Definition: api_shared.c:627
vlib_thread_registration_t * registration
Definition: threads.h:102
api_main_t api_main
Definition: api_shared.c:35
static clib_error_t * vpe_api_hookup(vlib_main_t *vm)
Definition: api.c:516
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:762
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
#define foreach_registration_hash
pthread_mutex_t mutex
Definition: svm_common.h:37
CLIB vectors are ubiquitous dynamically resized arrays with by user defined "headers".
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:170
show_threads display the information about vpp threads running on system along with their process id...
Definition: vpe.api:198
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128