FD.io VPP  v21.01.1
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/heap.h>
43 #include <vppinfra/pool.h>
44 #include <vppinfra/format.h>
45 #include <vppinfra/error.h>
46 
47 #include <vnet/api_errno.h>
48 #include <vnet/vnet.h>
49 
50 #include <vlib/log.h>
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 #include <vpp/api/types.h>
63 
64 #define vl_typedefs /* define message structures */
65 #include <vpp/api/vpe_all_api_h.h>
66 #undef vl_typedefs
67 #define vl_endianfun /* define message structures */
68 #include <vpp/api/vpe_all_api_h.h>
69 #undef vl_endianfun
70 /* instantiate all the print functions we know about */
71 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
72 #define vl_printfun
73 #include <vpp/api/vpe_all_api_h.h>
74 #undef vl_printfun
76 
77 #define foreach_vpe_api_msg \
78 _(CONTROL_PING, control_ping) \
79 _(CLI, cli) \
80 _(CLI_INBAND, cli_inband) \
81 _(GET_NODE_INDEX, get_node_index) \
82 _(ADD_NODE_NEXT, add_node_next) \
83 _(SHOW_VERSION, show_version) \
84 _(SHOW_THREADS, show_threads) \
85 _(GET_NODE_GRAPH, get_node_graph) \
86 _(GET_NEXT_INDEX, get_next_index) \
87 _(LOG_DUMP, log_dump) \
88 _(SHOW_VPE_SYSTEM_TIME, show_vpe_system_time) \
89 _(GET_F64_ENDIAN_VALUE, get_f64_endian_value) \
90 _(GET_F64_INCREMENT_BY_ONE, get_f64_increment_by_one) \
91 
92 #define QUOTE_(x) #x
93 #define QUOTE(x) QUOTE_(x)
94 
95 typedef enum
96 {
99 } resolve_t;
100 
102 
103 /* Clean up all registrations belonging to the indicated client */
104 static clib_error_t *
106 {
109  uword *p;
110 
111 #define _(a) \
112  p = hash_get (vam->a##_registration_hash, client_index); \
113  if (p) { \
114  rp = pool_elt_at_index (vam->a##_registrations, p[0]); \
115  pool_put (vam->a##_registrations, rp); \
116  hash_unset (vam->a##_registration_hash, client_index); \
117  }
119 #undef _
120  return 0;
121 }
122 
124 
125 static void
127 {
129  int rv = 0;
130 
131  /* *INDENT-OFF* */
132  REPLY_MACRO2(VL_API_CONTROL_PING_REPLY,
133  ({
134  rmp->vpe_pid = ntohl (getpid());
135  }));
136  /* *INDENT-ON* */
137 }
138 
139 static void
140 shmem_cli_output (uword arg, u8 * buffer, uword buffer_bytes)
141 {
142  u8 **shmem_vecp = (u8 **) arg;
143  u8 *shmem_vec;
144  void *oldheap;
145  u32 offset;
146 
147  shmem_vec = *shmem_vecp;
148 
149  offset = vec_len (shmem_vec);
150 
151  oldheap = vl_msg_push_heap ();
152 
153  vec_validate (shmem_vec, offset + buffer_bytes - 1);
154 
155  clib_memcpy (shmem_vec + offset, buffer, buffer_bytes);
156 
157  vl_msg_pop_heap (oldheap);
158 
159  *shmem_vecp = shmem_vec;
160 }
161 
162 
163 static void
165 {
166  vl_api_cli_reply_t *rp;
169  unformat_input_t input;
170  u8 *shmem_vec = 0;
171  void *oldheap;
172 
174  if (!reg)
175  return;;
176 
177  rp = vl_msg_api_alloc (sizeof (*rp));
178  rp->_vl_msg_id = ntohs (VL_API_CLI_REPLY);
179  rp->context = mp->context;
180 
181  unformat_init_vector (&input, (u8 *) (uword) mp->cmd_in_shmem);
182 
183  vlib_cli_input (vm, &input, shmem_cli_output, (uword) & shmem_vec);
184 
185  oldheap = vl_msg_push_heap ();
186  vec_add1 (shmem_vec, 0);
187  vl_msg_pop_heap (oldheap);
188 
189  rp->reply_in_shmem = (uword) shmem_vec;
190 
191  vl_api_send_msg (reg, (u8 *) rp);
192 }
193 
194 static void
195 inband_cli_output (uword arg, u8 * buffer, uword buffer_bytes)
196 {
197  u8 **mem_vecp = (u8 **) arg;
198  u8 *mem_vec = *mem_vecp;
199  u32 offset = vec_len (mem_vec);
200 
201  vec_validate (mem_vec, offset + buffer_bytes - 1);
202  clib_memcpy (mem_vec + offset, buffer, buffer_bytes);
203  *mem_vecp = mem_vec;
204 }
205 
206 static void
208 {
210  int rv = 0;
212  unformat_input_t input;
213  u8 *out_vec = 0;
214  u8 *cmd_vec = 0;
215 
216  if (vl_msg_api_get_msg_length (mp) <
217  vl_api_string_len (&mp->cmd) + sizeof (*mp))
218  {
219  rv = -1;
220  goto error;
221  }
222 
223  cmd_vec = vl_api_from_api_to_new_vec (mp, &mp->cmd);
224 
225  unformat_init_string (&input, (char *) cmd_vec,
226  vl_api_string_len (&mp->cmd));
227  rv = vlib_cli_input (vm, &input, inband_cli_output, (uword) & out_vec);
228 
229 error:
230  /* *INDENT-OFF* */
231  REPLY_MACRO3(VL_API_CLI_INBAND_REPLY, vec_len (out_vec),
232  ({
233  vl_api_vec_to_api_string(out_vec, &rmp->reply);
234  }));
235  /* *INDENT-ON* */
236  vec_free (out_vec);
237  vec_free (cmd_vec);
238 }
239 
240 static void
242 {
244  int rv = 0;
245  char *vpe_api_get_build_directory (void);
246  char *vpe_api_get_version (void);
247  char *vpe_api_get_build_date (void);
248 
249  /* *INDENT-OFF* */
250  REPLY_MACRO2(VL_API_SHOW_VERSION_REPLY,
251  ({
252  strncpy ((char *) rmp->program, "vpe", ARRAY_LEN(rmp->program)-1);
253  strncpy ((char *) rmp->build_directory, vpe_api_get_build_directory(),
254  ARRAY_LEN(rmp->build_directory)-1);
255  strncpy ((char *) rmp->version, vpe_api_get_version(),
256  ARRAY_LEN(rmp->version)-1);
257  strncpy ((char *) rmp->build_date, vpe_api_get_build_date(),
258  ARRAY_LEN(rmp->build_date)-1);
259  }));
260  /* *INDENT-ON* */
261 }
262 
263 static void
264 get_thread_data (vl_api_thread_data_t * td, int index)
265 {
267  td->id = htonl (index);
268  if (w->name)
269  strncpy ((char *) td->name, (char *) w->name, ARRAY_LEN (td->name) - 1);
270  if (w->registration)
271  strncpy ((char *) td->type, (char *) w->registration->name,
272  ARRAY_LEN (td->type) - 1);
273  td->pid = htonl (w->lwp);
274  td->cpu_id = htonl (w->cpu_id);
275  td->core = htonl (w->core_id);
276  td->cpu_socket = htonl (w->numa_id);
277 }
278 
279 static void
281 {
282  int count = 0;
283 
284 #if !defined(__powerpc64__)
287  vl_api_thread_data_t *td;
288  int i, msg_size = 0;
289  count = vec_len (vlib_worker_threads);
290  if (!count)
291  return;
292 
293  msg_size = sizeof (*rmp) + sizeof (rmp->thread_data[0]) * count;
295  if (!reg)
296  return;
297 
298  rmp = vl_msg_api_alloc (msg_size);
299  clib_memset (rmp, 0, msg_size);
300  rmp->_vl_msg_id = htons (VL_API_SHOW_THREADS_REPLY);
301  rmp->context = mp->context;
302  rmp->count = htonl (count);
303  td = rmp->thread_data;
304 
305  for (i = 0; i < count; i++)
306  {
307  get_thread_data (&td[i], i);
308  }
309 
310  vl_api_send_msg (reg, (u8 *) rmp);
311 #else
312 
313  /* unimplemented support */
314  rv = -9;
315  clib_warning ("power pc does not support show threads api");
316  /* *INDENT-OFF* */
317  REPLY_MACRO2(VL_API_SHOW_THREADS_REPLY,
318  ({
319  rmp->count = htonl(count);
320  }));
321  /* *INDENT-ON* */
322 #endif
323 }
324 
325 static void
327 {
330  vlib_node_t *n;
331  int rv = 0;
332  u32 node_index = ~0;
333 
334  n = vlib_get_node_by_name (vm, mp->node_name);
335 
336  if (n == 0)
337  rv = VNET_API_ERROR_NO_SUCH_NODE;
338  else
339  node_index = n->index;
340 
341  /* *INDENT-OFF* */
342  REPLY_MACRO2(VL_API_GET_NODE_INDEX_REPLY,
343  ({
344  rmp->node_index = htonl(node_index);
345  }));
346  /* *INDENT-ON* */
347 }
348 
349 static void
351 {
354  vlib_node_t *node, *next_node;
355  int rv = 0;
356  u32 next_node_index = ~0, next_index = ~0;
357  uword *p;
358 
359  node = vlib_get_node_by_name (vm, mp->node_name);
360 
361  if (node == 0)
362  {
363  rv = VNET_API_ERROR_NO_SUCH_NODE;
364  goto out;
365  }
366 
367  next_node = vlib_get_node_by_name (vm, mp->next_name);
368 
369  if (next_node == 0)
370  {
371  rv = VNET_API_ERROR_NO_SUCH_NODE2;
372  goto out;
373  }
374  else
375  next_node_index = next_node->index;
376 
377  p = hash_get (node->next_slot_by_node, next_node_index);
378 
379  if (p == 0)
380  {
381  rv = VNET_API_ERROR_NO_SUCH_ENTRY;
382  goto out;
383  }
384  else
385  next_index = p[0];
386 
387 out:
388  /* *INDENT-OFF* */
389  REPLY_MACRO2(VL_API_GET_NEXT_INDEX_REPLY,
390  ({
391  rmp->next_index = htonl(next_index);
392  }));
393  /* *INDENT-ON* */
394 }
395 
396 static void
398 {
401  vlib_node_t *n, *next;
402  int rv = 0;
403  u32 next_index = ~0;
404 
405  n = vlib_get_node_by_name (vm, mp->node_name);
406 
407  if (n == 0)
408  {
409  rv = VNET_API_ERROR_NO_SUCH_NODE;
410  goto out;
411  }
412 
413  next = vlib_get_node_by_name (vm, mp->next_name);
414 
415  if (next == 0)
416  rv = VNET_API_ERROR_NO_SUCH_NODE2;
417  else
418  next_index = vlib_node_add_next (vm, n->index, next->index);
419 
420 out:
421  /* *INDENT-OFF* */
422  REPLY_MACRO2(VL_API_ADD_NODE_NEXT_REPLY,
423  ({
424  rmp->next_index = htonl(next_index);
425  }));
426  /* *INDENT-ON* */
427 }
428 
429 static void
431 {
432  int rv = 0;
433  u8 *vector = 0;
435  void *oldheap;
437  static vlib_node_t ***node_dups;
438  static vlib_main_t **stat_vms;
439 
440  oldheap = vl_msg_push_heap ();
441 
442  /*
443  * Keep the number of memcpy ops to a minimum (e.g. 1).
444  */
445  vec_validate (vector, 16384);
446  vec_reset_length (vector);
447 
448  vlib_node_get_nodes (vm, 0 /* main threads */ ,
449  0 /* include stats */ ,
450  1 /* barrier sync */ ,
451  &node_dups, &stat_vms);
452  vector = vlib_node_serialize (vm, node_dups, vector, 1 /* include nexts */ ,
453  1 /* include stats */ );
454 
455  vl_msg_pop_heap (oldheap);
456 
457  /* *INDENT-OFF* */
458  REPLY_MACRO2(VL_API_GET_NODE_GRAPH_REPLY,
459  ({
460  rmp->reply_in_shmem = (uword) vector;
461  }));
462  /* *INDENT-ON* */
463 }
464 
465 static void
467  f64 timestamp,
468  vl_api_log_level_t * level, u8 * msg_class, u8 * message)
469 {
470  u32 msg_size;
471 
473  int class_len =
474  clib_min (vec_len (msg_class) + 1, ARRAY_LEN (rmp->msg_class));
475  int message_len =
476  clib_min (vec_len (message) + 1, ARRAY_LEN (rmp->message));
477  msg_size = sizeof (*rmp) + class_len + message_len;
478 
479  rmp = vl_msg_api_alloc (msg_size);
480  clib_memset (rmp, 0, msg_size);
481  rmp->_vl_msg_id = ntohs (VL_API_LOG_DETAILS);
482 
483  rmp->context = context;
484  rmp->timestamp = clib_host_to_net_f64 (timestamp);
485  rmp->level = htonl (*level);
486 
487  memcpy (rmp->msg_class, msg_class, class_len - 1);
488  memcpy (rmp->message, message, message_len - 1);
489  /* enforced by memset() above */
490  ASSERT (0 == rmp->msg_class[class_len - 1]);
491  ASSERT (0 == rmp->message[message_len - 1]);
492 
493  vl_api_send_msg (reg, (u8 *) rmp);
494 }
495 
496 static void
498 {
499 
500  /* from log.c */
501  vlib_log_main_t *lm = &log_main;
502  vlib_log_entry_t *e;
503  int i = last_log_entry ();
504  int count = lm->count;
505  f64 time_offset, start_time;
507 
509  if (reg == 0)
510  return;
511 
512  start_time = clib_net_to_host_f64 (mp->start_timestamp);
513 
514  time_offset = (f64) lm->time_zero_timeval.tv_sec
515  + (((f64) lm->time_zero_timeval.tv_usec) * 1e-6) - lm->time_zero;
516 
517  while (count--)
518  {
519  e = vec_elt_at_index (lm->entries, i);
520  if (start_time <= e->timestamp + time_offset)
521  show_log_details (reg, mp->context, e->timestamp + time_offset,
522  (vl_api_log_level_t *) & e->level,
523  format (0, "%U", format_vlib_log_class, e->class),
524  e->string);
525  i = (i + 1) % lm->size;
526  }
527 
528 }
529 
530 static void
532 {
533  int rv = 0;
535  /* *INDENT-OFF* */
536  REPLY_MACRO2(VL_API_SHOW_VPE_SYSTEM_TIME_REPLY,
537  ({
539  }));
540  /* *INDENT-ON* */
541 }
542 
543 static void
545 {
546  int rv = 0;
547  f64 one = 1.0;
549  if (1.0 != clib_net_to_host_f64 (mp->f64_one))
550  rv = VNET_API_ERROR_API_ENDIAN_FAILED;
551 
552  /* *INDENT-OFF* */
553  REPLY_MACRO2(VL_API_GET_F64_ENDIAN_VALUE_REPLY,
554  ({
556  }));
557  /* *INDENT-ON* */
558 }
559 
560 static void
562  mp)
563 {
564  int rv = 0;
566 
567  /* *INDENT-OFF* */
568  REPLY_MACRO2(VL_API_GET_F64_INCREMENT_BY_ONE_REPLY,
569  ({
571  }));
572  /* *INDENT-ON* */
573 }
574 
575 #define BOUNCE_HANDLER(nn) \
576 static void vl_api_##nn##_t_handler ( \
577  vl_api_##nn##_t *mp) \
578 { \
579  vpe_client_registration_t *reg; \
580  vpe_api_main_t * vam = &vpe_api_main; \
581  svm_queue_t * q; \
582  \
583  /* One registration only... */ \
584  pool_foreach (reg, vam->nn##_registrations) \
585  ({ \
586  q = vl_api_client_index_to_input_queue (reg->client_index); \
587  if (q) { \
588  /* \
589  * If the queue is stuffed, turf the msg and complain \
590  * It's unlikely that the intended recipient is \
591  * alive; avoid deadlock at all costs. \
592  */ \
593  if (q->cursize == q->maxsize) { \
594  clib_warning ("ERROR: receiver queue full, drop msg"); \
595  vl_msg_api_free (mp); \
596  return; \
597  } \
598  vl_msg_api_send_shmem (q, (u8 *)&mp); \
599  return; \
600  } \
601  })); \
602  vl_msg_api_free (mp); \
603 }
604 
605 static void setup_message_id_table (api_main_t * am);
606 
607 /*
608  * vpe_api_hookup
609  * Add vpe's API message handlers to the table.
610  * vlib has already mapped shared memory and
611  * added the client registration handlers.
612  * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
613  */
614 static clib_error_t *
616 {
617  api_main_t *am = vlibapi_get_main ();
618 
619 #define _(N,n) \
620  vl_msg_api_set_handlers(VL_API_##N, #n, \
621  vl_api_##n##_t_handler, \
622  vl_noop_handler, \
623  vl_api_##n##_t_endian, \
624  vl_api_##n##_t_print, \
625  sizeof(vl_api_##n##_t), 1);
627 #undef _
628 
629  /*
630  * Trace space for classifier mask+match
631  */
632  am->api_trace_cfg[VL_API_CLASSIFY_ADD_DEL_TABLE].size += 5 * sizeof (u32x4);
633  am->api_trace_cfg[VL_API_CLASSIFY_ADD_DEL_SESSION].size +=
634  5 * sizeof (u32x4);
635 
636  /*
637  * Thread-safe API messages
638  */
639  am->is_mp_safe[VL_API_CONTROL_PING] = 1;
640  am->is_mp_safe[VL_API_CONTROL_PING_REPLY] = 1;
641  am->is_mp_safe[VL_API_IP_ROUTE_ADD_DEL] = 1;
642  am->is_mp_safe[VL_API_GET_NODE_GRAPH] = 1;
643 
644  /*
645  * Set up the (msg_name, crc, message-id) table
646  */
648 
649  return 0;
650 }
651 
653 
654 clib_error_t *
656 {
658 
659  am->vlib_main = vm;
660  am->vnet_main = vnet_get_main ();
661 #define _(a) \
662  am->a##_registration_hash = hash_create (0, sizeof (uword));
664 #undef _
665 
666  vl_set_memory_region_name ("/vpe-api");
667  vl_mem_api_enable_disable (vm, 1 /* enable it */ );
668 
669  return 0;
670 }
671 
672 static clib_error_t *
674 {
675  u8 *chroot_path;
676  u64 baseva, size, pvt_heap_size;
677  int uid, gid, rv;
678  const int max_buf_size = 4096;
679  char *s, *buf;
680  struct passwd _pw, *pw;
681  struct group _grp, *grp;
682  clib_error_t *e;
683  buf = vec_new (char, 128);
685  {
686  if (unformat (input, "prefix %s", &chroot_path))
687  {
688  vec_add1 (chroot_path, 0);
689  vl_set_memory_root_path ((char *) chroot_path);
690  }
691  else if (unformat (input, "uid %d", &uid))
692  vl_set_memory_uid (uid);
693  else if (unformat (input, "gid %d", &gid))
694  vl_set_memory_gid (gid);
695  else if (unformat (input, "baseva %llx", &baseva))
697  else if (unformat (input, "global-size %lldM", &size))
698  vl_set_global_memory_size (size * (1ULL << 20));
699  else if (unformat (input, "global-size %lldG", &size))
700  vl_set_global_memory_size (size * (1ULL << 30));
701  else if (unformat (input, "global-size %lld", &size))
703  else if (unformat (input, "global-pvt-heap-size %lldM", &pvt_heap_size))
704  vl_set_global_pvt_heap_size (pvt_heap_size * (1ULL << 20));
705  else if (unformat (input, "global-pvt-heap-size size %lld",
706  &pvt_heap_size))
707  vl_set_global_pvt_heap_size (pvt_heap_size);
708  else if (unformat (input, "api-pvt-heap-size %lldM", &pvt_heap_size))
709  vl_set_api_pvt_heap_size (pvt_heap_size * (1ULL << 20));
710  else if (unformat (input, "api-pvt-heap-size size %lld",
711  &pvt_heap_size))
712  vl_set_api_pvt_heap_size (pvt_heap_size);
713  else if (unformat (input, "api-size %lldM", &size))
714  vl_set_api_memory_size (size * (1ULL << 20));
715  else if (unformat (input, "api-size %lldG", &size))
716  vl_set_api_memory_size (size * (1ULL << 30));
717  else if (unformat (input, "api-size %lld", &size))
718  vl_set_api_memory_size (size);
719  else if (unformat (input, "uid %s", &s))
720  {
721  /* lookup the username */
722  pw = NULL;
723  while (((rv =
724  getpwnam_r (s, &_pw, buf, vec_len (buf), &pw)) == ERANGE)
725  && (vec_len (buf) <= max_buf_size))
726  {
727  vec_resize (buf, vec_len (buf) * 2);
728  }
729  if (rv < 0)
730  {
731  e = clib_error_return_code (0, rv,
734  "cannot fetch username %s", s);
735  vec_free (s);
736  vec_free (buf);
737  return e;
738  }
739  if (pw == NULL)
740  {
741  e =
742  clib_error_return_fatal (0, "username %s does not exist", s);
743  vec_free (s);
744  vec_free (buf);
745  return e;
746  }
747  vec_free (s);
748  vl_set_memory_uid (pw->pw_uid);
749  }
750  else if (unformat (input, "gid %s", &s))
751  {
752  /* lookup the group name */
753  grp = NULL;
754  while (((rv =
755  getgrnam_r (s, &_grp, buf, vec_len (buf),
756  &grp)) == ERANGE)
757  && (vec_len (buf) <= max_buf_size))
758  {
759  vec_resize (buf, vec_len (buf) * 2);
760  }
761  if (rv != 0)
762  {
763  e = clib_error_return_code (0, rv,
766  "cannot fetch group %s", s);
767  vec_free (s);
768  vec_free (buf);
769  return e;
770  }
771  if (grp == NULL)
772  {
773  e = clib_error_return_fatal (0, "group %s does not exist", s);
774  vec_free (s);
775  vec_free (buf);
776  return e;
777  }
778  vec_free (s);
779  vec_free (buf);
780  vl_set_memory_gid (grp->gr_gid);
781  }
782  else
783  return clib_error_return (0, "unknown input `%U'",
784  format_unformat_error, input);
785  }
786  return 0;
787 }
788 
790 
791 void *
793 {
794  return (void *) &unformat_vnet_sw_interface;
795 }
796 
797 #define vl_msg_name_crc_list
798 #include <vpp/api/vpe_all_api_h.h>
799 #undef vl_msg_name_crc_list
800 
801 static void
803 {
804 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
805  foreach_vl_msg_name_crc_memclnt;
806  foreach_vl_msg_name_crc_vpe;
807 #undef _
808 
809 #define vl_api_version_tuple(n,mj, mi, p) \
810  vl_msg_api_add_version (am, #n, mj, mi, p);
811 #include <vpp/api/vpe_all_api_h.h>
812 #undef vl_api_version_tuple
813 }
814 
815 
816 /*
817  * fd.io coding-style-patch-verification: ON
818  *
819  * Local Variables:
820  * eval: (c-set-style "gnu")
821  * End:
822  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:509
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:534
static clib_error_t * memclnt_delete_callback(u32 client_index)
Definition: api.c:105
#define clib_min(x, y)
Definition: clib.h:328
vnet_main_t * vnet_main
string node_name[64]
Definition: vpe.api:272
Reply for get next node index.
Definition: vpe.api:281
vpe parser cli string response
Definition: vpe.api:103
string cmd[]
Definition: vpe.api:95
#define foreach_vpe_api_msg
Definition: api.c:77
show_threads_reply
Definition: vpe.api:233
void vl_set_global_memory_baseva(u64 baseva)
u32 client_index
Definition: vpe.api:289
vlib_log_entry_t * entries
Definition: log.h:94
static void vl_api_cli_t_handler(vl_api_cli_t *mp)
Definition: api.c:164
#define ntohs(x)
Definition: af_xdp.bpf.c:29
string next_name[64]
Definition: vpe.api:151
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
string node_name[64]
Definition: vpe.api:150
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:83
void vl_set_memory_uid(int uid)
unsigned long u64
Definition: types.h:89
int last_log_entry()
Definition: log.c:62
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)
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
u32 index
Definition: node.h:280
f64 types are not standardized across the wire.
Definition: vpe.api:329
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:35
static clib_error_t * api_segment_config(vlib_main_t *vm, unformat_input_t *input)
Definition: api.c:673
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:592
Verify f64 wire format by sending a value and receiving the value + 1.0.
Definition: vpe.api:353
f64 timestamp
Definition: log.h:45
vlib_main_t * vlib_main
vlib_main_t * vm
Definition: in2out_ed.c:1580
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)
int vlib_cli_input(vlib_main_t *vm, unformat_input_t *input, vlib_cli_output_function_t *function, uword function_arg)
Definition: cli.c:656
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:1173
unsigned char u8
Definition: types.h:56
trace_cfg_t * api_trace_cfg
Current trace configuration.
Definition: api_common.h:277
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
Process a vpe parser cli string request.
Definition: vpe.api:85
double f64
Definition: types.h:142
void vl_set_global_memory_size(u64 size)
resolve_t
Definition: api.c:95
#define clib_memcpy(d, s, n)
Definition: string.h:180
static void vl_api_get_f64_increment_by_one_t_handler(vl_api_get_f64_increment_by_one_t *mp)
Definition: api.c:561
static void vl_api_get_next_index_t_handler(vl_api_get_next_index_t *mp)
Definition: api.c:350
Get node index using name request.
Definition: vpe.api:133
static void vl_api_get_node_graph_t_handler(vl_api_get_node_graph_t *mp)
Definition: api.c:430
u32 context
Definition: vpe.api:88
vl_api_timestamp_t timestamp
Definition: vpe.api:296
struct timeval time_zero_timeval
Definition: log.h:105
#define vec_new(T, N)
Create new vector of given type and length (unspecified alignment, no header).
Definition: vec.h:350
description fragment has unexpected format
Definition: map.api:433
#define clib_error_return_fatal(e, args...)
Definition: error.h:105
static f64 unix_time_now(void)
Definition: time.h:255
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
#define clib_error_return(e, args...)
Definition: error.h:99
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:281
unsigned int u32
Definition: types.h:88
void unformat_init_string(unformat_input_t *input, char *string, int string_len)
Definition: unformat.c:1029
get_f64_endian_value reply message
Definition: vpe.api:341
f64 f64_one[default=1.0]
Definition: vpe.api:333
u64 cmd_in_shmem
Definition: vpe.api:89
void vl_set_memory_root_path(const char *name)
Definition: cJSON.c:84
vlib_worker_thread_t * vlib_worker_threads
Definition: threads.c:34
#define hash_get(h, key)
Definition: hash.h:249
vl_api_log_level_t level
Definition: vpe.api:297
vlib_node_t * vlib_get_node_by_name(vlib_main_t *vm, u8 *name)
Definition: node.c:45
static void shmem_cli_output(uword arg, u8 *buffer, uword buffer_bytes)
Definition: api.c:140
void vl_msg_pop_heap(void *oldheap)
Definition: cli.c:732
static void vl_api_get_node_index_t_handler(vl_api_get_node_index_t *mp)
Definition: api.c:326
char * vpe_api_get_version(void)
Return the image version string.
Definition: version.c:154
vl_api_timestamp_t start_timestamp
Definition: vpe.api:291
struct _unformat_input_t unformat_input_t
u32 size
Definition: vhost_user.h:106
int size
Definition: log.h:96
vlib_log_main_t log_main
Definition: log.c:23
u32 vl_api_string_len(vl_api_string_t *astr)
Definition: api_shared.c:1170
void vl_set_api_pvt_heap_size(u64 size)
u32 client_index
Definition: vpe.api:87
#define REPLY_MACRO3(t, n, body)
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:227
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:1037
string build_directory[256]
Definition: vpe.api:190
static void vl_api_add_node_next_t_handler(vl_api_add_node_next_t *mp)
Definition: api.c:397
An API client registration, only in vpp/vlib.
Definition: api_common.h:47
void vl_mem_api_enable_disable(vlib_main_t *vm, int yesno)
Definition: vlib_api.c:444
#define VLIB_EARLY_CONFIG_FUNCTION(x, n,...)
Definition: init.h:226
#define UNFORMAT_END_OF_INPUT
Definition: format.h:144
string node_name[64]
Definition: vpe.api:125
static void vl_api_log_dump_t_handler(vl_api_log_dump_t *mp)
Definition: api.c:497
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:317
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:380
clib_error_t * vpe_api_init(vlib_main_t *vm)
Definition: api.c:655
char * buffer
Definition: cJSON.h:163
string msg_class[32]
Definition: vpe.api:298
#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:147
get_f64_increment_by_one reply
Definition: vpe.api:365
void vl_set_memory_gid(int gid)
static void inband_cli_output(uword arg, u8 *buffer, uword buffer_bytes)
Definition: api.c:195
static void vl_api_show_version_t_handler(vl_api_show_version_t *mp)
Definition: api.c:241
Reply for show vpe system time.
Definition: vpe.api:317
static void show_log_details(vl_api_registration_t *reg, u32 context, f64 timestamp, vl_api_log_level_t *level, u8 *msg_class, u8 *message)
Definition: api.c:466
#define ARRAY_LEN(x)
Definition: clib.h:67
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:79
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1580
vl_api_timestamp_t vpe_system_time
Definition: vpe.api:321
static void vl_api_get_f64_endian_value_t_handler(vl_api_get_f64_endian_value_t *mp)
Definition: api.c:544
Definition: log.h:41
#define ASSERT(truth)
vlib_log_class_t class
Definition: log.h:44
static void vl_api_cli_inband_t_handler(vl_api_cli_inband_t *mp)
Definition: api.c:207
static void setup_message_id_table(api_main_t *am)
Definition: api.c:802
static f64 clib_net_to_host_f64(f64 x)
Definition: byte_order.h:177
int count
Definition: log.h:96
Control ping from the client to the server response.
Definition: vpe.api:72
f64 f64_value[default=1.0]
Definition: vpe.api:357
void vl_set_memory_region_name(const char *name)
Definition: memory_api.c:980
static f64 clib_host_to_net_f64(f64 x)
Definition: byte_order.h:178
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:349
Query relative index via node names.
Definition: vpe.api:268
show version
Definition: vpe.api:170
static void vl_api_show_vpe_system_time_t_handler(vl_api_show_vpe_system_time_t *mp)
Definition: api.c:531
static void vl_api_show_threads_t_handler(vl_api_show_threads_t *mp)
Definition: api.c:280
Show the current system timestamp.
Definition: vpe.api:306
VL_MSG_API_REAPER_FUNCTION(memclnt_delete_callback)
vlib_log_level_t level
Definition: log.h:43
f64 time_zero
Definition: log.h:106
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
template key/value backing page structure
Definition: bihash_doc.h:44
string message[256]
Definition: vpe.api:299
u64 reply_in_shmem
Definition: vpe.api:107
u8 * format_vlib_log_class(u8 *s, va_list *args)
Definition: log.c:89
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
void * get_unformat_vnet_sw_interface(void)
Definition: api.c:792
u64 uword
Definition: types.h:112
string next_name[64]
Definition: vpe.api:273
static void get_thread_data(vl_api_thread_data_t *td, int index)
Definition: api.c:264
u32 index
Definition: flow_types.api:221
show version response
Definition: vpe.api:183
vpe_api_main_t vpe_api_main
Definition: interface_api.c:54
static void vl_api_control_ping_t_handler(vl_api_control_ping_t *mp)
Definition: api.c:126
struct clib_bihash_value offset
template key/value backing page structure
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:389
f64 timestamp
Definition: vpe_types.api:28
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:161
void vl_set_api_memory_size(u64 size)
u8 * is_mp_safe
Message is mp safe vector.
Definition: api_common.h:250
VLIB_API_INIT_FUNCTION(af_xdp_plugin_api_hookup)
#define clib_error_return_code(e, code, flags, args...)
Definition: error.h:93
void * vl_msg_push_heap(void)
Definition: cli.c:725
unsigned long long u32x4
Definition: ixge.c:28
u8 count
Definition: dhcp.api:208
u32 vl_msg_api_get_msg_length(void *msg_arg)
Definition: api_shared.c:777
u8 * string
Definition: log.h:46
vlib_thread_registration_t * registration
Definition: threads.h:103
static clib_error_t * vpe_api_hookup(vlib_main_t *vm)
Definition: api.c:615
u8 * vl_api_from_api_to_new_vec(void *mp, vl_api_string_t *astr)
Definition: api_shared.c:1188
int vl_api_vec_to_api_string(const u8 *vec, vl_api_string_t *str)
Definition: api_shared.c:1161
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
#define foreach_registration_hash
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