FD.io VPP  v21.01.1
Vector Packet Processing
vlib_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * vlib_api.c VLIB API implementation
4  *
5  * Copyright (c) 2009 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 <fcntl.h>
21 #include <pthread.h>
22 #include <vppinfra/vec.h>
23 #include <vppinfra/hash.h>
24 #include <vppinfra/pool.h>
25 #include <vppinfra/format.h>
26 #include <vppinfra/byte_order.h>
27 #include <vppinfra/elog.h>
28 #include <vlib/vlib.h>
29 #include <vlib/unix/unix.h>
30 #include <vlibapi/api.h>
31 #include <vlibmemory/api.h>
32 
33 /**
34  * @file
35  * @brief Binary API messaging via shared memory
36  * Low-level, primary provisioning interface
37  */
38 /*? %%clicmd:group_label Binary API CLI %% ?*/
39 /*? %%syscfg:group_label Binary API configuration %% ?*/
40 
41 #define TRACE_VLIB_MEMORY_QUEUE 0
42 
43 #include <vlibmemory/vl_memory_msg_enum.h> /* enumerate all vlib messages */
44 
45 #define vl_typedefs /* define message structures */
47 #undef vl_typedefs
48 
49 /* instantiate all the print functions we know about */
50 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
51 #define vl_printfun
53 #undef vl_printfun
54 
55 static inline void *
57  void *handle)
58 {
59  vl_print (handle, "vl_api_trace_plugin_msg_ids: %s first %u last %u\n",
60  a->plugin_name,
61  clib_host_to_net_u16 (a->first_msg_id),
62  clib_host_to_net_u16 (a->last_msg_id));
63  return handle;
64 }
65 
66 /* instantiate all the endian swap functions we know about */
67 #define vl_endianfun
69 #undef vl_endianfun
70 
71 static void
73 {
76  uword *p;
79  u8 name[64];
80  u16 first_msg_id = ~0;
81  int rv = -7; /* VNET_API_ERROR_INVALID_VALUE */
82 
84  if (!regp)
85  return;
86 
87  if (am->msg_range_by_name == 0)
88  goto out;
89  strncpy ((char *) name, (char *) mp->name, ARRAY_LEN (name));
90  name[ARRAY_LEN (name) - 1] = '\0';
91  p = hash_get_mem (am->msg_range_by_name, name);
92  if (p == 0)
93  goto out;
94 
95  rp = vec_elt_at_index (am->msg_ranges, p[0]);
96  first_msg_id = rp->first_msg_id;
97  rv = 0;
98 
99 out:
100  rmp = vl_msg_api_alloc (sizeof (*rmp));
101  rmp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID_REPLY);
102  rmp->context = mp->context;
103  rmp->retval = ntohl (rv);
104  rmp->first_msg_id = ntohs (first_msg_id);
105  vl_api_send_msg (regp, (u8 *) rmp);
106 }
107 
108 void
110 {
111  api_main_t *am = vlibapi_get_main ();
114  u32 nmsg = vec_len (am->api_version_list);
115  int msg_size = sizeof (*rmp) + sizeof (rmp->api_versions[0]) * nmsg;
116  int i;
117 
119  if (!reg)
120  return;
121 
122  rmp = vl_msg_api_alloc (msg_size);
123  clib_memset (rmp, 0, msg_size);
124  rmp->_vl_msg_id = ntohs (VL_API_API_VERSIONS_REPLY);
125 
126  /* fill in the message */
127  rmp->context = mp->context;
128  rmp->count = htonl (nmsg);
129 
130  for (i = 0; i < nmsg; ++i)
131  {
133  rmp->api_versions[i].major = htonl (vl->major);
134  rmp->api_versions[i].minor = htonl (vl->minor);
135  rmp->api_versions[i].patch = htonl (vl->patch);
136  strncpy ((char *) rmp->api_versions[i].name, vl->name,
137  ARRAY_LEN (rmp->api_versions[i].name));
138  rmp->api_versions[i].name[ARRAY_LEN (rmp->api_versions[i].name) - 1] =
139  '\0';
140  }
141 
142  vl_api_send_msg (reg, (u8 *) rmp);
143 }
144 
145 #define foreach_vlib_api_msg \
146 _(GET_FIRST_MSG_ID, get_first_msg_id) \
147 _(API_VERSIONS, api_versions)
148 
149 /*
150  * vl_api_init
151  */
152 static int
154 {
156  vl_msg_api_msg_config_t *c = &cfg;
157 
158  clib_memset (c, 0, sizeof (*c));
159 
160 #define _(N,n) do { \
161  c->id = VL_API_##N; \
162  c->name = #n; \
163  c->handler = vl_api_##n##_t_handler; \
164  c->cleanup = vl_noop_handler; \
165  c->endian = vl_api_##n##_t_endian; \
166  c->print = vl_api_##n##_t_print; \
167  c->size = sizeof(vl_api_##n##_t); \
168  c->traced = 1; /* trace, so these msgs print */ \
169  c->replay = 0; /* don't replay client create/delete msgs */ \
170  c->message_bounce = 0; /* don't bounce this message */ \
171  vl_msg_api_config(c);} while (0);
172 
174 #undef _
175 
176  return 0;
177 }
178 
180 
181 /*
182  * Callback to send ourselves a plugin numbering-space trace msg
183  */
184 static void
185 send_one_plugin_msg_ids_msg (u8 * name, u16 first_msg_id, u16 last_msg_id)
186 {
188  api_main_t *am = vlibapi_get_main ();
189  vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
190  svm_queue_t *q;
191 
192  mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
193  clib_memset (mp, 0, sizeof (*mp));
194 
195  mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_TRACE_PLUGIN_MSG_IDS);
196  strncpy ((char *) mp->plugin_name, (char *) name,
197  sizeof (mp->plugin_name) - 1);
198  mp->first_msg_id = clib_host_to_net_u16 (first_msg_id);
199  mp->last_msg_id = clib_host_to_net_u16 (last_msg_id);
200 
201  q = shmem_hdr->vl_input_queue;
202 
203  vl_msg_api_send_shmem (q, (u8 *) & mp);
204 }
205 
206 void
208 {
209  u8 *serialized_message_table;
210  api_main_t *am = vlibapi_get_main ();
211  u8 *chroot_file;
212  int fd, rv;
213 
214  /*
215  * Snapshoot the api message table.
216  */
217  if (strstr ((char *) am->save_msg_table_filename, "..")
218  || index ((char *) am->save_msg_table_filename, '/'))
219  {
220  clib_warning ("illegal save-message-table filename '%s'",
222  return;
223  }
224 
225  chroot_file = format (0, "/tmp/%s%c", am->save_msg_table_filename, 0);
226 
227  fd = creat ((char *) chroot_file, 0644);
228 
229  if (fd < 0)
230  {
231  clib_unix_warning ("creat");
232  return;
233  }
234 
235  serialized_message_table = vl_api_serialize_message_table (am, 0);
236 
237  rv = write (fd, serialized_message_table,
238  vec_len (serialized_message_table));
239 
240  if (rv != vec_len (serialized_message_table))
241  clib_unix_warning ("write");
242 
243  rv = close (fd);
244  if (rv < 0)
245  clib_unix_warning ("close");
246 
247  vec_free (chroot_file);
248  vec_free (serialized_message_table);
249 }
250 
251 clib_error_t *vat_builtin_main_init (vlib_main_t * vm) __attribute__ ((weak));
252 clib_error_t *
254 {
255  return 0;
256 }
257 
258 static uword
260  vlib_frame_t * f)
261 {
262  int private_segment_rotor = 0, i, rv;
264  vl_shmem_hdr_t *shm;
265  svm_queue_t *q;
266  clib_error_t *e;
267  api_main_t *am = vlibapi_get_main ();
268  f64 dead_client_scan_time;
269  f64 sleep_time, start_time;
270  f64 vector_rate;
272  uword event_type;
273  uword *event_data = 0;
274  f64 now;
275 
276  if ((error = vl_sock_api_init (vm)))
277  {
278  clib_error_report (error);
279  clib_warning ("socksvr_api_init failed, quitting...");
280  return 0;
281  }
282 
283  if ((rv = vlib_api_init ()) < 0)
284  {
285  clib_warning ("vlib_api_init returned %d, quitting...", rv);
286  return 0;
287  }
288 
289  shm = am->shmem_hdr;
290  q = shm->vl_input_queue;
291 
293  (vm, &vm->api_init_function_registrations, 1 /* call_once */ );
294  if (e)
295  clib_error_report (e);
296 
297  e = vat_builtin_main_init (vm);
298  if (e)
299  clib_error_report (e);
300 
301  sleep_time = 10.0;
302  dead_client_scan_time = vlib_time_now (vm) + 10.0;
303 
304  /*
305  * Send plugin message range messages for each plugin we loaded
306  */
307  for (i = 0; i < vec_len (am->msg_ranges); i++)
308  {
309  vl_api_msg_range_t *rp = am->msg_ranges + i;
311  rp->last_msg_id);
312  }
313 
314  /*
315  * Save the api message table snapshot, if configured
316  */
317  if (am->save_msg_table_filename)
319 
320  /* $$$ pay attention to frame size, control CPU usage */
321  while (1)
322  {
323  /*
324  * There's a reason for checking the queue before
325  * sleeping. If the vlib application crashes, it's entirely
326  * possible for a client to enqueue a connect request
327  * during the process restart interval.
328  *
329  * Unless some force of physics causes the new incarnation
330  * of the application to process the request, the client will
331  * sit and wait for Godot...
332  */
333  vector_rate = (f64) vlib_last_vectors_per_main_loop (vm);
334  start_time = vlib_time_now (vm);
335  while (1)
336  {
337  if (vl_mem_api_handle_rpc (vm, node)
338  || vl_mem_api_handle_msg_main (vm, node))
339  {
340  vm->api_queue_nonempty = 0;
341  VL_MEM_API_LOG_Q_LEN ("q-underflow: len %d", 0);
342  sleep_time = 20.0;
343  break;
344  }
345 
346  /* Allow no more than 10us without a pause */
347  if (vlib_time_now (vm) > start_time + 10e-6)
348  {
349  int index = SLEEP_400_US;
350  if (vector_rate > 40.0)
351  sleep_time = 400e-6;
352  else if (vector_rate > 20.0)
353  {
354  index = SLEEP_200_US;
355  sleep_time = 200e-6;
356  }
357  else if (vector_rate >= 1.0)
358  {
359  index = SLEEP_100_US;
360  sleep_time = 100e-6;
361  }
362  else
363  {
364  index = SLEEP_10_US;
365  sleep_time = 10e-6;
366  }
368  break;
369  }
370  }
371 
372  /*
373  * see if we have any private api shared-memory segments
374  * If so, push required context variables, and process
375  * a message.
376  */
377  if (PREDICT_FALSE (vec_len (am->vlib_private_rps)))
378  {
379  if (private_segment_rotor >= vec_len (am->vlib_private_rps))
380  private_segment_rotor = 0;
381  vl_mem_api_handle_msg_private (vm, node, private_segment_rotor++);
382  }
383 
384  vlib_process_wait_for_event_or_clock (vm, sleep_time);
385  vec_reset_length (event_data);
386  event_type = vlib_process_get_events (vm, &event_data);
387  now = vlib_time_now (vm);
388 
389  switch (event_type)
390  {
391  case QUEUE_SIGNAL_EVENT:
392  vm->queue_signal_pending = 0;
393  VL_MEM_API_LOG_Q_LEN ("q-awake: len %d", q->cursize);
394 
395  break;
396  case SOCKET_READ_EVENT:
397  for (i = 0; i < vec_len (event_data); i++)
398  {
399  vl_api_registration_t *regp;
400 
401  a = pool_elt_at_index (socket_main.process_args, event_data[i]);
403  if (regp)
404  {
405  vl_socket_process_api_msg (regp, (i8 *) a->data);
407  event_data[i]);
408  }
409  vec_free (a->data);
411  }
412  break;
413 
414  /* Timeout... */
415  case -1:
416  break;
417 
418  default:
419  clib_warning ("unknown event type %d", event_type);
420  break;
421  }
422 
423  if (now > dead_client_scan_time)
424  {
425  vl_mem_api_dead_client_scan (am, shm, now);
426  dead_client_scan_time = vlib_time_now (vm) + 10.0;
427  }
428  }
429 
430  return 0;
431 }
432 /* *INDENT-OFF* */
434 {
435  .function = vl_api_clnt_process,
436  .type = VLIB_NODE_TYPE_PROCESS,
437  .name = "api-rx-from-ring",
438  .state = VLIB_NODE_STATE_DISABLED,
439  .process_log2_n_stack_bytes = 18,
440 };
441 /* *INDENT-ON* */
442 
443 void
445 {
447  (enable
448  ? VLIB_NODE_STATE_POLLING
449  : VLIB_NODE_STATE_DISABLED));
450 }
451 
452 static uword
455 {
456  uword n_packets = frame->n_vectors;
457  uword n_left_from;
458  u32 *from;
459  static u8 *long_msg;
460 
461  vec_validate (long_msg, 4095);
462  n_left_from = frame->n_vectors;
463  from = vlib_frame_vector_args (frame);
464 
465  while (n_left_from > 0)
466  {
467  u32 bi0;
468  vlib_buffer_t *b0;
469  void *msg;
470  uword msg_len;
471 
472  bi0 = from[0];
473  b0 = vlib_get_buffer (vm, bi0);
474  from += 1;
475  n_left_from -= 1;
476 
477  msg = b0->data + b0->current_data;
478  msg_len = b0->current_length;
479  if (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
480  {
481  ASSERT (long_msg != 0);
482  _vec_len (long_msg) = 0;
483  vec_add (long_msg, msg, msg_len);
484  while (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
485  {
486  b0 = vlib_get_buffer (vm, b0->next_buffer);
487  msg = b0->data + b0->current_data;
488  msg_len = b0->current_length;
489  vec_add (long_msg, msg, msg_len);
490  }
491  msg = long_msg;
492  }
494  }
495 
496  /* Free what we've been given. */
497  vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_packets);
498 
499  return n_packets;
500 }
501 
502 /* *INDENT-OFF* */
504  .function = api_rx_from_node,
505  .type = VLIB_NODE_TYPE_INTERNAL,
506  .vector_size = 4,
507  .name = "api-rx-from-node",
508 };
509 /* *INDENT-ON* */
510 
511 static void
513 {
514  vl_api_rpc_call_reply_t *rmp;
515  int (*fp) (void *);
516  i32 rv = 0;
517  vlib_main_t *vm = vlib_get_main ();
518 
519  if (mp->function == 0)
520  {
521  rv = -1;
522  clib_warning ("rpc NULL function pointer");
523  }
524 
525  else
526  {
527  if (mp->need_barrier_sync)
529 
530  fp = uword_to_pointer (mp->function, int (*)(void *));
531  rv = fp (mp->data);
532 
533  if (mp->need_barrier_sync)
535  }
536 
537  if (mp->send_reply)
538  {
540  if (q)
541  {
542  rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
543  rmp->_vl_msg_id = ntohs (VL_API_RPC_CALL_REPLY);
544  rmp->context = mp->context;
545  rmp->retval = rv;
546  vl_msg_api_send_shmem (q, (u8 *) & rmp);
547  }
548  }
549  if (mp->multicast)
550  {
551  clib_warning ("multicast not yet implemented...");
552  }
553 }
554 
555 static void
556 vl_api_rpc_call_reply_t_handler (vl_api_rpc_call_reply_t * mp)
557 {
558  clib_warning ("unimplemented");
559 }
560 
561 void
563 {
564  vlib_main_t *vm_global = &vlib_global_main;
565 
566  ASSERT (vm != vm_global);
567 
572 }
573 
574 always_inline void
575 vl_api_rpc_call_main_thread_inline (void *fp, u8 * data, u32 data_length,
576  u8 force_rpc)
577 {
578  vl_api_rpc_call_t *mp;
579  vlib_main_t *vm_global = &vlib_global_main;
580  vlib_main_t *vm = vlib_get_main ();
581 
582  /* Main thread and not a forced RPC: call the function directly */
583  if ((force_rpc == 0) && (vlib_get_thread_index () == 0))
584  {
585  void (*call_fp) (void *);
586 
588 
589  call_fp = fp;
590  call_fp (data);
591 
593  return;
594  }
595 
596  /* Otherwise, actually do an RPC */
597  mp = vl_msg_api_alloc_as_if_client (sizeof (*mp) + data_length);
598 
599  clib_memset (mp, 0, sizeof (*mp));
600  clib_memcpy_fast (mp->data, data, data_length);
601  mp->_vl_msg_id = ntohs (VL_API_RPC_CALL);
602  mp->function = pointer_to_uword (fp);
603  mp->need_barrier_sync = 1;
604 
605  /* Add to the pending vector. Thread 0 requires locking. */
606  if (vm == vm_global)
608  vec_add1 (vm->pending_rpc_requests, (uword) mp);
609  if (vm == vm_global)
611 }
612 
613 /*
614  * Check if called from worker threads.
615  * If so, make rpc call of fp through shmem.
616  * Otherwise, call fp directly
617  */
618 void
619 vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length)
620 {
621  vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
622  0);
623 }
624 
625 /*
626  * Always make rpc call of fp through shmem, useful for calling from threads
627  * not setup as worker threads, such as DPDK callback thread
628  */
629 void
630 vl_api_force_rpc_call_main_thread (void *fp, u8 * data, u32 data_length)
631 {
632  vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
633  1);
634 }
635 
636 static void
638 {
639  api_main_t *am = vlibapi_get_main ();
640  vl_api_msg_range_t *rp;
641  uword *p;
642 
643  /* Noop (except for tracing) during normal operation */
644  if (am->replay_in_progress == 0)
645  return;
646 
648  if (p == 0)
649  {
650  clib_warning ("WARNING: traced plugin '%s' not in current image",
651  mp->plugin_name);
652  return;
653  }
654 
655  rp = vec_elt_at_index (am->msg_ranges, p[0]);
656  if (rp->first_msg_id != clib_net_to_host_u16 (mp->first_msg_id))
657  {
658  clib_warning ("WARNING: traced plugin '%s' first message id %d not %d",
659  mp->plugin_name, clib_net_to_host_u16 (mp->first_msg_id),
660  rp->first_msg_id);
661  }
662 
663  if (rp->last_msg_id != clib_net_to_host_u16 (mp->last_msg_id))
664  {
665  clib_warning ("WARNING: traced plugin '%s' last message id %d not %d",
666  mp->plugin_name, clib_net_to_host_u16 (mp->last_msg_id),
667  rp->last_msg_id);
668  }
669 }
670 
671 #define foreach_rpc_api_msg \
672 _(RPC_CALL,rpc_call) \
673 _(RPC_CALL_REPLY,rpc_call_reply)
674 
675 #define foreach_plugin_trace_msg \
676 _(TRACE_PLUGIN_MSG_IDS,trace_plugin_msg_ids)
677 
678 /*
679  * Set the rpc callback at our earliest possible convenience.
680  * This avoids ordering issues between thread_init() -> start_workers and
681  * an init function which we could define here. If we ever intend to use
682  * vlib all by itself, we can't create a link-time dependency on
683  * an init function here and a typical "call foo_init first"
684  * guitar lick.
685  */
686 
687 extern void *rpc_call_main_thread_cb_fn;
688 
689 static clib_error_t *
691 {
692  api_main_t *am = vlibapi_get_main ();
693 #define _(N,n) \
694  vl_msg_api_set_handlers(VL_API_##N, #n, \
695  vl_api_##n##_t_handler, \
696  vl_noop_handler, \
697  vl_noop_handler, \
698  vl_api_##n##_t_print, \
699  sizeof(vl_api_##n##_t), 0 /* do not trace */);
701 #undef _
702 
703 #define _(N,n) \
704  vl_msg_api_set_handlers(VL_API_##N, #n, \
705  vl_api_##n##_t_handler, \
706  vl_noop_handler, \
707  vl_noop_handler, \
708  vl_api_##n##_t_print, \
709  sizeof(vl_api_##n##_t), 1 /* do trace */);
711 #undef _
712 
713  /* No reason to halt the parade to create a trace record... */
714  am->is_mp_safe[VL_API_TRACE_PLUGIN_MSG_IDS] = 1;
716  return 0;
717 }
718 
720 
721 /*
722  * fd.io coding-style-patch-verification: ON
723  *
724  * Local Variables:
725  * eval: (c-set-style "gnu")
726  * End:
727  */
#define foreach_vlib_api_msg
Definition: vlib_api.c:145
int vl_mem_api_handle_msg_private(vlib_main_t *vm, vlib_node_runtime_t *node, u32 reg_index)
Definition: memory_api.c:756
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:509
Message range (belonging to a plugin)
Definition: api_common.h:113
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:124
int vl_mem_api_handle_msg_main(vlib_main_t *vm, vlib_node_runtime_t *node)
Definition: memory_api.c:704
uword * pending_rpc_requests
Definition: main.h:314
vlib_main_t vlib_global_main
Definition: main.c:2041
static void send_one_plugin_msg_ids_msg(u8 *name, u16 first_msg_id, u16 last_msg_id)
Definition: vlib_api.c:185
VLIB_API_INIT_FUNCTION(rpc_api_hookup)
clib_error_t * vl_sock_api_init(vlib_main_t *vm)
Definition: socket_api.c:731
void vl_msg_api_handler_no_trace_no_free(void *the_msg)
Definition: api_shared.c:711
static void vl_api_rpc_call_main_thread_inline(void *fp, u8 *data, u32 data_length, u8 force_rpc)
Definition: vlib_api.c:575
void vl_api_save_msg_table(void)
Definition: vlib_api.c:207
u8 * name
name of the plugin
Definition: api_common.h:115
clib_spinlock_t pending_rpc_lock
Definition: main.h:316
static f64 vlib_process_wait_for_event_or_clock(vlib_main_t *vm, f64 dt)
Suspend a cooperative multi-tasking thread Waits for an event, or for the indicated number of seconds...
Definition: node_funcs.h:751
static void vl_api_get_first_msg_id_t_handler(vl_api_get_first_msg_id_t *mp)
Definition: vlib_api.c:72
a
Definition: bitmap.h:544
static void vlib_buffer_free(vlib_main_t *vm, u32 *buffers, u32 n_buffers)
Free buffers Frees the entire buffer chain for each buffer.
Definition: buffer_funcs.h:937
#define ntohs(x)
Definition: af_xdp.bpf.c:29
static void * vl_api_trace_plugin_msg_ids_t_print(vl_api_trace_plugin_msg_ids_t *a, void *handle)
Definition: vlib_api.c:56
i16 current_data
signed offset in data[], pre_data[] that we are currently processing.
Definition: buffer.h:110
unsigned long u64
Definition: types.h:89
Fixed length block allocator.
#define clib_memcpy_fast(a, b, c)
Definition: string.h:81
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:334
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:35
static_always_inline void clib_spinlock_unlock_if_init(clib_spinlock_t *p)
Definition: lock.h:129
vl_socket_args_for_process_t * process_args
Definition: socket_api.h:59
Message configuration definition.
Definition: api_common.h:121
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:113
socket_main_t socket_main
Definition: socket_api.c:48
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:592
api_version_t * api_version_list
api version list
Definition: api_common.h:353
void * vl_msg_api_alloc(int nbytes)
static u32 vlib_last_vectors_per_main_loop(vlib_main_t *vm)
Definition: main.h:436
unsigned char u8
Definition: types.h:56
#define VL_MEM_API_LOG_Q_LEN(fmt, qlen)
Definition: memory_api.h:70
vlib_node_registration_t vl_api_clnt_node
(constructor) VLIB_REGISTER_NODE (vl_api_clnt_node)
Definition: vlib_api.c:433
u8 data[128]
Definition: ipsec_types.api:90
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
double f64
Definition: types.h:142
#define vlib_worker_thread_barrier_sync(X)
Definition: threads.h:205
clib_error_t * vlib_call_init_exit_functions(vlib_main_t *vm, _vlib_init_function_list_elt_t **headp, int call_once)
Definition: init.c:360
#define vec_add(V, E, N)
Add N elements to end of vector V (no header, unspecified alignment)
Definition: vec.h:668
static vl_api_registration_t * vl_socket_get_registration(u32 reg_index)
Definition: socket_api.h:68
_vlib_init_function_list_elt_t * api_init_function_registrations
Definition: main.h:259
static uword vlib_process_get_events(vlib_main_t *vm, uword **data_vector)
Return the first event type which has occurred and a vector of per-event data of that type...
Definition: node_funcs.h:579
static clib_error_t * rpc_api_hookup(vlib_main_t *vm)
Definition: vlib_api.c:690
description fragment has unexpected format
Definition: map.api:433
void vl_mem_api_dead_client_scan(api_main_t *am, vl_shmem_hdr_t *shm, f64 now)
Definition: memory_api.c:576
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
int replay_in_progress
Replay in progress?
Definition: api_common.h:362
void vl_api_send_pending_rpc_requests(vlib_main_t *vm)
Definition: vlib_api.c:562
struct vl_shmem_hdr_ * shmem_hdr
Binary API shared-memory segment header pointer.
Definition: api_common.h:293
unsigned int u32
Definition: types.h:88
char name[64]
Definition: api_common.h:223
void vl_msg_api_send_shmem(svm_queue_t *q, u8 *elem)
static uword vl_api_clnt_process(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *f)
Definition: vlib_api.c:259
u16 last_msg_id
last assigned message ID
Definition: api_common.h:117
Definition: cJSON.c:84
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:546
u8 data[data_len]
Definition: memclnt.api:96
void * rpc_call_main_thread_cb_fn
Definition: threads.c:1942
unsigned short u16
Definition: types.h:57
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:301
svm_region_t ** vlib_private_rps
Vector of all mapped shared-VM segments.
Definition: api_common.h:289
#define PREDICT_FALSE(x)
Definition: clib.h:121
#define always_inline
Definition: ipsec.h:28
clib_error_t * vat_builtin_main_init(vlib_main_t *vm)
Definition: vlib_api.c:253
signed char i8
Definition: types.h:45
volatile u32 queue_signal_pending
Definition: main.h:263
int vl_mem_api_handle_rpc(vlib_main_t *vm, vlib_node_runtime_t *node)
Definition: memory_api.c:712
vl_api_module_version_t api_versions[count]
Definition: memclnt.api:131
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:227
static void vl_api_rpc_call_reply_t_handler(vl_api_rpc_call_reply_t *mp)
Definition: vlib_api.c:556
An API client registration, only in vpp/vlib.
Definition: api_common.h:47
The fine-grained event logger allows lightweight, thread-safe event logging at minimum cost...
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:170
svmdb_client_t * c
u16 n_vectors
Definition: node.h:397
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:219
static vlib_node_registration_t api_rx_from_node_node
(constructor) VLIB_REGISTER_NODE (api_rx_from_node_node)
Definition: vlib_api.c:503
svm_queue_t * vl_api_client_index_to_input_queue(u32 index)
Definition: memory_api.c:794
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
vl_api_msg_range_t * msg_ranges
vector of message ranges
Definition: api_common.h:308
#define clib_warning(format, args...)
Definition: error.h:59
u8 data[]
Packet data.
Definition: buffer.h:181
#define vl_print(handle,...)
Definition: vlib_api.c:50
u64 vector_rate_histogram[SLEEP_N_BUCKETS]
Definition: vlib_api.c:179
static void vl_api_rpc_call_t_handler(vl_api_rpc_call_t *mp)
Definition: vlib_api.c:512
#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
svm_queue_t * vl_input_queue
Definition: memory_shared.h:84
string name[64]
Definition: ip.api:44
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1580
u8 * save_msg_table_filename
Dump (msg-name, crc) snapshot here at startup.
Definition: api_common.h:365
signed int i32
Definition: types.h:77
#define uword_to_pointer(u, type)
Definition: types.h:136
#define foreach_rpc_api_msg
Definition: vlib_api.c:671
#define ASSERT(truth)
u8 * vl_api_serialize_message_table(api_main_t *am, u8 *vector)
Definition: api_shared.c:204
#define clib_error_report(e)
Definition: error.h:113
#define vec_append(v1, v2)
Append v2 after v1.
Definition: vec.h:890
void vl_api_api_versions_t_handler(vl_api_api_versions_t *mp)
Definition: vlib_api.c:109
static void vlib_node_set_state(vlib_main_t *vm, u32 node_index, vlib_node_state_t new_state)
Set node dispatch state.
Definition: node_funcs.h:174
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
#define foreach_plugin_trace_msg
Definition: vlib_api.c:675
u32 vl(void *p)
GDB callable function: vl - Return vector length of vector.
Definition: gdb_funcs.c:35
u16 first_msg_id
first assigned message ID
Definition: api_common.h:116
void vl_api_rpc_call_main_thread(void *fp, u8 *data, u32 data_length)
Definition: vlib_api.c:619
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u32 next_buffer
Next buffer for this linked-list of buffers.
Definition: buffer.h:140
vlib_main_t vlib_node_runtime_t vlib_frame_t * frame
Definition: in2out_ed.c:1581
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:297
#define clib_unix_warning(format, args...)
Definition: error.h:68
u32 index
Definition: flow_types.api:221
volatile u32 api_queue_nonempty
Definition: main.h:264
struct _svm_queue svm_queue_t
static int vlib_api_init(void)
Definition: vlib_api.c:153
#define hash_get_mem(h, key)
Definition: hash.h:269
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:389
void vlib_worker_thread_barrier_release(vlib_main_t *vm)
Definition: threads.c:1561
u8 * is_mp_safe
Message is mp safe vector.
Definition: api_common.h:250
void vl_api_force_rpc_call_main_thread(void *fp, u8 *data, u32 data_length)
Definition: vlib_api.c:630
static void vl_api_trace_plugin_msg_ids_t_handler(vl_api_trace_plugin_msg_ids_t *mp)
Definition: vlib_api.c:637
static uword api_rx_from_node(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: vlib_api.c:453
void * vl_msg_api_alloc_as_if_client(int nbytes)
uword * msg_range_by_name
Message range by name hash.
Definition: api_common.h:305
void vl_mem_api_enable_disable(vlib_main_t *vm, int enable)
Definition: vlib_api.c:444
static_always_inline void clib_spinlock_lock_if_init(clib_spinlock_t *p)
Definition: lock.h:106
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
void vl_socket_process_api_msg(vl_api_registration_t *rp, i8 *input_v)
Definition: socket_api.c:197
CLIB vectors are ubiquitous dynamically resized arrays with by user defined "headers".