FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
node.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  * node.c: VLIB processing nodes
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39 
40 #include <vlib/vlib.h>
41 #include <vlib/threads.h>
42 
43 /* Query node given name. */
46 {
48  uword *p;
49  u8 *key = name;
50  key = format (0, "%s", key);
51  p = hash_get (nm->node_by_name, key);
52  if (key != name)
53  vec_free (key);
54  return p ? vec_elt (nm->nodes, p[0]) : 0;
55 }
56 
57 static void
59 {
62 
64  vec_free (t->format);
65  t->format = (char *) format (0, "%v-call: %%d%c", n->name, 0);
66 
68  vec_free (t->format);
69  t->format = (char *) format (0, "%v-return: %%d%c", n->name, 0);
70 
71  n->name_elog_string =
72  elog_string (&vlib_global_main.elog_main, "%v%c", n->name, 0);
73 }
74 
75 void
77 {
78  va_list va;
81 
82  va_start (va, fmt);
83  hash_unset (nm->node_by_name, n->name);
84  vec_free (n->name);
85  n->name = va_format (0, fmt, &va);
86  va_end (va);
87  hash_set (nm->node_by_name, n->name, n->index);
88 
90 
91  /* Propagate the change to all worker threads */
93 }
94 
95 static void
97 {
100  vlib_node_t *node, *next_node;
101  vlib_next_frame_t *nf;
103  i32 i, j, n_insert;
104 
105  node = vec_elt (nm->nodes, node_index);
107 
108  n_insert = vec_len (node->next_nodes) - r->n_next_nodes;
109  if (n_insert > 0)
110  {
111  i = r->next_frame_index + r->n_next_nodes;
112  vec_insert (nm->next_frames, n_insert, i);
113 
114  /* Initialize newly inserted next frames. */
115  for (j = 0; j < n_insert; j++)
116  vlib_next_frame_init (nm->next_frames + i + j);
117 
118  /* Relocate other next frames at higher indices. */
119  for (j = 0; j < vec_len (nm->nodes); j++)
120  {
121  s = vlib_node_get_runtime (vm, j);
122  if (j != node_index && s->next_frame_index >= i)
123  s->next_frame_index += n_insert;
124  }
125 
126  /* Pending frames may need to be relocated also. */
127  vec_foreach (pf, nm->pending_frames)
128  {
130  && pf->next_frame_index >= i)
131  pf->next_frame_index += n_insert;
132  }
133  /* *INDENT-OFF* */
134  pool_foreach (pf, nm->suspended_process_frames) {
135  if (pf->next_frame_index != ~0 && pf->next_frame_index >= i)
136  pf->next_frame_index += n_insert;
137  }
138  /* *INDENT-ON* */
139 
140  r->n_next_nodes = vec_len (node->next_nodes);
141  }
142 
143  /* Set frame's node runtime index. */
144  next_node = vlib_get_node (vm, node->next_nodes[next_index]);
145  nf = nm->next_frames + r->next_frame_index + next_index;
146  nf->node_runtime_index = next_node->runtime_index;
147 
149 }
150 
151 uword
153 {
155  vlib_node_t *node;
156  uword *p;
157 
158  node = vec_elt (nm->nodes, node_index);
159 
160  /* Runtime has to be initialized. */
162 
163  if ((p = hash_get (node->next_slot_by_node, next_node_index)))
164  {
165  return p[0];
166  }
167 
168  return (~0);
169 }
170 
171 /* Add next node to given node in given slot. */
172 uword
175  uword next_node_index, uword slot)
176 {
178  vlib_node_t *node, *next, *old_next;
179  u32 old_next_index;
180  uword *p;
181 
182  ASSERT (vlib_get_thread_index () == 0);
183 
184  node = vec_elt (nm->nodes, node_index);
185  next = vec_elt (nm->nodes, next_node_index);
186 
187  /* Runtime has to be initialized. */
189 
190  if ((p = hash_get (node->next_slot_by_node, next_node_index)))
191  {
192  /* Next already exists: slot must match. */
193  if (slot != ~0)
194  ASSERT (slot == p[0]);
195  return p[0];
196  }
197 
199 
200  if (slot == ~0)
201  slot = vec_len (node->next_nodes);
202 
203  vec_validate_init_empty (node->next_nodes, slot, ~0);
204  vec_validate (node->n_vectors_by_next_node, slot);
205 
206  if ((old_next_index = node->next_nodes[slot]) != ~0u)
207  {
208  hash_unset (node->next_slot_by_node, old_next_index);
209  old_next = vlib_get_node (vm, old_next_index);
210  old_next->prev_node_bitmap =
211  clib_bitmap_andnoti (old_next->prev_node_bitmap, node_index);
212  }
213 
214  node->next_nodes[slot] = next_node_index;
215  hash_set (node->next_slot_by_node, next_node_index, slot);
216 
218 
219  next->prev_node_bitmap = clib_bitmap_ori (next->prev_node_bitmap,
220  node_index);
221 
222  /* Siblings all get same node structure. */
223  {
224  uword sib_node_index, sib_slot;
225  vlib_node_t *sib_node;
226  /* *INDENT-OFF* */
227  clib_bitmap_foreach (sib_node_index, node->sibling_bitmap) {
228  sib_node = vec_elt (nm->nodes, sib_node_index);
229  if (sib_node != node)
230  {
231  sib_slot = vlib_node_add_next_with_slot (vm, sib_node_index, next_node_index, slot);
232  ASSERT (sib_slot == slot);
233  }
234  }
235  /* *INDENT-ON* */
236  }
237 
239  return slot;
240 }
241 
242 /* Add named next node to given node in given slot. */
243 uword
245  uword node, char *name, uword slot)
246 {
248  vlib_node_t *n, *n_next;
249 
250  nm = &vm->node_main;
251  n = vlib_get_node (vm, node);
252 
253  n_next = vlib_get_node_by_name (vm, (u8 *) name);
254  if (!n_next)
255  {
256  if (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED)
257  return ~0;
258 
259  if (slot == ~0)
261  vec_len (n->next_nodes));
263  n->next_node_names[slot] = name;
264  return slot;
265  }
266 
267  return vlib_node_add_next_with_slot (vm, node, n_next->index, slot);
268 }
269 
270 static void
272 {
274 
275  clib_memset (&t, 0, sizeof (t));
276 
277  /* 2 event types for this node: one when node function is called.
278  One when it returns. */
281 
284 
285  node_set_elog_name (vm, ni);
286 }
287 
288 #ifdef CLIB_UNIX
289 #define STACK_ALIGN (clib_mem_get_page_size())
290 #else
291 #define STACK_ALIGN CLIB_CACHE_LINE_BYTES
292 #endif
293 
297 {
301  vlib_node_function_t *fn = 0;
302  int priority = -1;
303 
304  if (nm->node_fn_default_march_variant != ~0)
305  {
306  r = regs;
307  while (r)
308  {
309  if (r->march_variant == nm->node_fn_default_march_variant)
310  return r->function;
311  r = r->next_registration;
312  }
313  }
314 
315  r = regs;
316  while (r)
317  {
318  v = vec_elt_at_index (nm->variants, r->march_variant);
319  if (v->priority > priority)
320  {
321  priority = v->priority;
322  fn = r->function;
323  }
324  r = r->next_registration;
325  }
326 
327  ASSERT (fn);
328  return fn;
329 }
330 
331 static void
333 {
335  vlib_node_t *n;
336  int i;
337 
338  if (CLIB_DEBUG > 0)
339  {
340  /* Default (0) type should match INTERNAL. */
341  vlib_node_t zero = { 0 };
343  }
344 
345  if (r->node_fn_registrations)
346  {
347  /* to avoid confusion, please remove ".function " statiement from
348  CLIB_NODE_REGISTRATION() if using function function candidates */
349  ASSERT (r->function == 0);
350 
351  r->function =
352  vlib_node_get_preferred_node_fn_variant (vm, r->node_fn_registrations);
353  }
354 
355  ASSERT (r->function != 0);
356 
357  n = clib_mem_alloc_no_fail (sizeof (n[0]));
358  clib_memset (n, 0, sizeof (n[0]));
359  n->index = vec_len (nm->nodes);
360  n->node_fn_registrations = r->node_fn_registrations;
361  n->protocol_hint = r->protocol_hint;
362 
363  vec_add1 (nm->nodes, n);
364 
365  /* Name is always a vector so it can be formatted with %v. */
366  if (clib_mem_is_heap_object (vec_header (r->name, 0)))
367  n->name = vec_dup ((u8 *) r->name);
368  else
369  n->name = format (0, "%s", r->name);
370 
371  if (!nm->node_by_name)
372  nm->node_by_name = hash_create_vec ( /* size */ 32,
373  sizeof (n->name[0]), sizeof (uword));
374 
375  /* Node names must be unique. */
376  {
377  /* vlib_get_node_by_name() expects NULL-terminated strings */
378  u8 *name = format (0, "%v%c", n->name, 0);
380  vec_free (name);
381  if (o)
382  clib_error ("more than one node named `%v'", n->name);
383  }
384 
385  hash_set (nm->node_by_name, n->name, n->index);
386 
387  r->index = n->index; /* save index in registration */
388  n->function = r->function;
389 
390  /* Node index of next sibling will be filled in by vlib_node_main_init. */
391  n->sibling_of = r->sibling_of;
392  if (r->sibling_of && r->n_next_nodes > 0)
393  clib_error ("sibling node should not have any next nodes `%v'", n->name);
394 
395  if (r->type == VLIB_NODE_TYPE_INTERNAL)
396  ASSERT (r->vector_size > 0);
397 
398 #define _(f) n->f = r->f
399 
400  _(type);
401  _(flags);
402  _(state);
403  _(scalar_size);
404  _(vector_size);
405  _(format_buffer);
406  _(unformat_buffer);
407  _(format_trace);
408  _(validate_frame);
409 
410  /* Register error counters. */
411  vlib_register_errors (vm, n->index, r->n_errors, r->error_strings,
412  r->error_counters);
413  node_elog_init (vm, n->index);
414 
415  _(runtime_data_bytes);
416  if (r->runtime_data_bytes > 0)
417  {
418  vec_resize (n->runtime_data, r->runtime_data_bytes);
419  if (r->runtime_data)
420  clib_memcpy (n->runtime_data, r->runtime_data, r->runtime_data_bytes);
421  }
422 
423  vec_resize (n->next_node_names, r->n_next_nodes);
424  for (i = 0; i < r->n_next_nodes; i++)
425  n->next_node_names[i] = r->next_nodes[i];
426 
427  vec_validate_init_empty (n->next_nodes, r->n_next_nodes - 1, ~0);
428  vec_validate (n->n_vectors_by_next_node, r->n_next_nodes - 1);
429 
430  n->owner_node_index = n->owner_next_index = ~0;
431 
432  /* Initialize node runtime. */
433  {
435  u32 i;
436 
437  if (n->type == VLIB_NODE_TYPE_PROCESS)
438  {
439  vlib_process_t *p;
440  uword log2_n_stack_bytes;
441 
442  log2_n_stack_bytes = clib_max (r->process_log2_n_stack_bytes,
443  VLIB_PROCESS_LOG2_STACK_SIZE);
444  log2_n_stack_bytes = clib_max (log2_n_stack_bytes,
446 
447  p = clib_mem_alloc_aligned (sizeof (p[0]), CLIB_CACHE_LINE_BYTES);
448  clib_memset (p, 0, sizeof (p[0]));
449  p->log2_n_stack_bytes = log2_n_stack_bytes;
450 
451  p->stack = clib_mem_vm_map_stack (1ULL << log2_n_stack_bytes,
453  "process stack: %U",
455  n->index);
456 
457  if (p->stack == CLIB_MEM_VM_MAP_FAILED)
458  clib_panic ("failed to allocate process stack (%d bytes)",
459  1ULL << log2_n_stack_bytes);
460 
461  /* Process node's runtime index is really index into process
462  pointer vector. */
463  n->runtime_index = vec_len (nm->processes);
464 
465  vec_add1 (nm->processes, p);
466 
467  /* Paint first stack word with magic number so we can at least
468  detect process stack overruns. */
470 
471  /* Node runtime is stored inside of process. */
472  rt = &p->node_runtime;
473  }
474  else
475  {
476  vec_add2_aligned (nm->nodes_by_type[n->type], rt, 1,
477  /* align */ CLIB_CACHE_LINE_BYTES);
478  if (n->type == VLIB_NODE_TYPE_INPUT)
479  clib_interrupt_resize (&nm->interrupts,
480  vec_len (nm->nodes_by_type[n->type]));
481  n->runtime_index = rt - nm->nodes_by_type[n->type];
482  }
483 
484  if (n->type == VLIB_NODE_TYPE_INPUT)
485  nm->input_node_counts_by_state[n->state] += 1;
486 
487  rt->function = n->function;
488  rt->flags = n->flags;
489  rt->state = n->state;
490  rt->node_index = n->index;
491 
492  rt->n_next_nodes = r->n_next_nodes;
493  rt->next_frame_index = vec_len (nm->next_frames);
494 
495  vec_resize (nm->next_frames, rt->n_next_nodes);
496  for (i = 0; i < rt->n_next_nodes; i++)
497  vlib_next_frame_init (nm->next_frames + rt->next_frame_index + i);
498 
499  vec_resize (rt->errors, r->n_errors);
500  for (i = 0; i < vec_len (rt->errors); i++)
501  rt->errors[i] = n->error_heap_index + i;
502 
505 
506  if (vec_len (n->runtime_data) > 0)
507  clib_memcpy (rt->runtime_data, n->runtime_data,
508  vec_len (n->runtime_data));
509  else
510  clib_memset (rt->runtime_data, 0, VLIB_NODE_RUNTIME_DATA_SIZE);
511 
512  vec_free (n->runtime_data);
513  }
514 #undef _
515 }
516 
517 /* Register new packet processing node. */
518 u32
520 {
521  register_node (vm, r);
522  return r->index;
523 }
524 
525 static uword
528 {
529  u16 n_vectors = frame->n_vectors;
530 
531  vlib_node_increment_counter (vm, node->node_index, 0, n_vectors);
534 
535  return n_vectors;
536 }
537 
538 void
540 {
543  int prio = -1;
544 
545  nm->node_fn_default_march_variant = ~0;
546  ASSERT (nm->variants == 0);
547  vec_add2 (nm->variants, v, 1);
548  v->desc = v->suffix = "default";
550 
551 #define _(s, n) \
552  vec_add2 (nm->variants, v, 1); \
553  v->suffix = #s; \
554  v->index = CLIB_MARCH_VARIANT_TYPE_##s; \
555  v->priority = clib_cpu_march_priority_##s (); \
556  v->desc = n;
557 
559 #undef _
560 
561  nm->node_fn_march_variant_by_suffix = hash_create_string (0, sizeof (u32));
562 
563  vec_foreach (v, nm->variants)
564  {
565  ASSERT (v->index == v - nm->variants);
566  hash_set (nm->node_fn_march_variant_by_suffix, v->suffix, v->index);
567  if (v->priority > prio)
568  prio = v->priority;
569  }
570 }
571 
572 void
574 {
577 
578  static char *null_node_error_strings[] = {
579  "blackholed packets",
580  };
581 
582  static vlib_node_registration_t null_node_reg = {
583  .function = null_node_fn,
584  .vector_size = sizeof (u32),
585  .name = "null-node",
586  .n_errors = 1,
587  .error_strings = null_node_error_strings,
588  };
589 
590  /* make sure that node index 0 is not used by
591  real node */
592  register_node (vm, &null_node_reg);
593 
594  r = vgm->node_registrations;
595  while (r)
596  {
597  register_node (vm, r);
598  r = r->next_registration;
599  }
600 }
601 
602 void
603 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
604  int barrier_sync, vlib_node_t **** node_dupsp,
605  vlib_main_t *** stat_vmsp)
606 {
608  vlib_node_t *n;
609  vlib_node_t ***node_dups = *node_dupsp;
610  vlib_node_t **nodes;
611  vlib_main_t **stat_vms = *stat_vmsp;
612  vlib_main_t *stat_vm;
613  uword i, j;
614  u32 threads_to_serialize;
615 
616  if (vec_len (stat_vms) == 0)
617  {
618  for (i = 0; i < vlib_get_n_threads (); i++)
619  {
620  stat_vm = vlib_get_main_by_index (i);
621  if (stat_vm)
622  vec_add1 (stat_vms, stat_vm);
623  }
624  }
625 
626  threads_to_serialize = clib_min (max_threads, vec_len (stat_vms));
627 
628  vec_validate (node_dups, threads_to_serialize - 1);
629 
630  /*
631  * Barrier sync across stats scraping.
632  * Otherwise, the counts will be grossly inaccurate.
633  */
634  if (barrier_sync)
636 
637  for (j = 0; j < threads_to_serialize; j++)
638  {
639  stat_vm = stat_vms[j];
640  nm = &stat_vm->node_main;
641 
642  if (include_stats)
643  {
644  for (i = 0; i < vec_len (nm->nodes); i++)
645  {
646  n = nm->nodes[i];
647  vlib_node_sync_stats (stat_vm, n);
648  }
649  }
650 
651  nodes = node_dups[j];
652  vec_validate (nodes, vec_len (nm->nodes) - 1);
653  clib_memcpy (nodes, nm->nodes, vec_len (nm->nodes) * sizeof (nodes[0]));
654  node_dups[j] = nodes;
655  }
656 
657  if (barrier_sync)
659 
660  *node_dupsp = node_dups;
661  *stat_vmsp = stat_vms;
662 }
663 
664 clib_error_t *
666 {
668  clib_error_t *error = 0;
669  vlib_node_t *n;
670  uword ni;
671 
672  nm->frame_sizes = vec_new (vlib_frame_size_t, 1);
673 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
674  nm->frame_size_hash = hash_create (0, sizeof (uword));
675 #endif
677 
678  /* Generate sibling relationships */
679  {
680  vlib_node_t *n, *sib;
681  uword si;
682 
683  for (ni = 0; ni < vec_len (nm->nodes); ni++)
684  {
685  n = vec_elt (nm->nodes, ni);
686 
687  if (!n->sibling_of)
688  continue;
689 
690  sib = vlib_get_node_by_name (vm, (u8 *) n->sibling_of);
691  if (!sib)
692  {
693  error = clib_error_create ("sibling `%s' not found for node `%v'",
694  n->sibling_of, n->name);
695  goto done;
696  }
697 
698  /* *INDENT-OFF* */
700  vlib_node_t * m = vec_elt (nm->nodes, si);
701 
702  /* Connect all of sibling's siblings to us. */
703  m->sibling_bitmap = clib_bitmap_ori (m->sibling_bitmap, n->index);
704 
705  /* Connect us to all of sibling's siblings. */
706  n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, si);
707  }
708  /* *INDENT-ON* */
709 
710  /* Connect sibling to us. */
711  sib->sibling_bitmap = clib_bitmap_ori (sib->sibling_bitmap, n->index);
712 
713  /* Connect us to sibling. */
714  n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, sib->index);
715  }
716  }
717 
718  /* Resolve next names into next indices. */
719  for (ni = 0; ni < vec_len (nm->nodes); ni++)
720  {
721  uword i;
722 
723  n = vec_elt (nm->nodes, ni);
724 
725  for (i = 0; i < vec_len (n->next_node_names); i++)
726  {
727  char *a = n->next_node_names[i];
728 
729  if (!a)
730  continue;
731 
732  if (~0 == vlib_node_add_named_next_with_slot (vm, n->index, a, i))
733  {
735  ("node `%v' refers to unknown node `%s'", n->name, a);
736  goto done;
737  }
738  }
739 
741  }
742 
743  /* Set previous node pointers. */
744  for (ni = 0; ni < vec_len (nm->nodes); ni++)
745  {
746  vlib_node_t *n_next;
747  uword i;
748 
749  n = vec_elt (nm->nodes, ni);
750 
751  for (i = 0; i < vec_len (n->next_nodes); i++)
752  {
753  if (n->next_nodes[i] >= vec_len (nm->nodes))
754  continue;
755 
756  n_next = vec_elt (nm->nodes, n->next_nodes[i]);
757  n_next->prev_node_bitmap =
758  clib_bitmap_ori (n_next->prev_node_bitmap, n->index);
759  }
760  }
761 
762  {
763  vlib_next_frame_t *nf;
765  vlib_node_t *next;
766  uword i;
767 
768  vec_foreach (r, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
769  {
770  if (r->n_next_nodes == 0)
771  continue;
772 
773  n = vlib_get_node (vm, r->node_index);
774  nf = vec_elt_at_index (nm->next_frames, r->next_frame_index);
775 
776  for (i = 0; i < vec_len (n->next_nodes); i++)
777  {
778  next = vlib_get_node (vm, n->next_nodes[i]);
779 
780  /* Validate node runtime indices are correctly initialized. */
781  ASSERT (nf[i].node_runtime_index == next->runtime_index);
782 
783  nf[i].flags = 0;
786  }
787  }
788  }
789 
790 done:
791  return error;
792 }
793 
794 u32
796  vlib_node_function_t * f, u32 log2_n_stack_bytes)
797 {
799  vlib_node_t *n;
800 
801  memset (&r, 0, sizeof (r));
802 
803  r.name = (char *) format (0, "%s", name, 0);
804  r.function = f;
805  r.process_log2_n_stack_bytes = log2_n_stack_bytes;
806  r.type = VLIB_NODE_TYPE_PROCESS;
807 
809 
810  vlib_register_node (vm, &r);
811  vec_free (r.name);
812 
815 
816  n = vlib_get_node (vm, r.index);
818 
819  return (r.index);
820 }
821 
822 int
824  clib_march_variant_type_t march_variant)
825 {
829 
830  if (n->node_fn_registrations == 0)
831  return -1;
832 
833  fnr = n->node_fn_registrations;
834  v = vec_elt_at_index (vm->node_main.variants, march_variant);
835 
836  while (fnr)
837  {
838  if (fnr->march_variant == v->index)
839  {
840  n->function = fnr->function;
841 
842  for (int i = 0; i < vlib_get_n_threads (); i++)
843  {
844  vlib_node_runtime_t *nrt;
845  nrt =
847  nrt->function = fnr->function;
848  }
849  return 0;
850  }
851  fnr = fnr->next_registration;
852  }
853  return -1;
854 }
855 /*
856  * fd.io coding-style-patch-verification: ON
857  *
858  * Local Variables:
859  * eval: (c-set-style "gnu")
860  * End:
861  */
vlib.h
vlib_node_get_nodes
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:603
vlib_node_fn_variant_t
Definition: node.h:657
vlib_node_sync_stats
void vlib_node_sync_stats(vlib_main_t *vm, vlib_node_t *n)
Definition: main.c:610
vlib_node_fn_variant_t::desc
char * desc
Definition: node.h:662
vlib_buffer_free
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:982
vlib_node_fn_registration_t
struct _vlib_node_fn_registration vlib_node_fn_registration_t
vlib_worker_thread_barrier_release
void vlib_worker_thread_barrier_release(vlib_main_t *vm)
Definition: threads.c:1386
vlib_register_errors
void vlib_register_errors(vlib_main_t *vm, u32 node_index, u32 n_errors, char *error_strings[], vlib_error_desc_t counters[])
Definition: error.c:117
elog_event_type_t::format
char * format
Format string.
Definition: elog.h:92
vlib_global_main_t
Definition: main.h:274
frame
vlib_main_t vlib_node_runtime_t vlib_frame_t * frame
Definition: nat44_ei.c:3048
VLIB_FRAME_NO_FREE_AFTER_DISPATCH
#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH
Definition: node.h:405
vec_new
#define vec_new(T, N)
Create new vector of given type and length (unspecified alignment, no header).
Definition: vec.h:365
clib_memcpy
#define clib_memcpy(d, s, n)
Definition: string.h:197
next_index
nat44_ei_hairpin_src_next_t next_index
Definition: nat44_ei_hairpinning.c:412
vlib_node_t::owner_next_index
u32 owner_next_index
Definition: node.h:345
clib_max
#define clib_max(x, y)
Definition: clib.h:335
f
vlib_frame_t * f
Definition: interface_output.c:1080
vlib_node_t::sibling_bitmap
uword * sibling_bitmap
Definition: node.h:331
VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
#define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
Definition: node.h:282
name
string name[64]
Definition: fib.api:25
vlib_frame_size_t
Definition: node.h:518
next
u16 * next
Definition: nat44_ei_out2in.c:718
vlib_node_set_march_variant
int vlib_node_set_march_variant(vlib_main_t *vm, u32 node_index, clib_march_variant_type_t march_variant)
Definition: node.c:823
VLIB_NODE_TYPE_INTERNAL
@ VLIB_NODE_TYPE_INTERNAL
Definition: node.h:72
node
vlib_main_t vlib_node_runtime_t * node
Definition: nat44_ei.c:3047
threads.h
hash_create_vec
#define hash_create_vec(elts, key_bytes, value_bytes)
Definition: hash.h:667
VLIB_NODE_TYPE_INPUT
@ VLIB_NODE_TYPE_INPUT
Definition: node.h:76
vlib_node_t::flags
u16 flags
Definition: node.h:278
vlib_main_t::node_call_elog_event_types
elog_event_type_t * node_call_elog_event_types
Definition: main.h:201
vlib_register_all_node_march_variants
void vlib_register_all_node_march_variants(vlib_main_t *vm)
Definition: node.c:539
u16
unsigned short u16
Definition: types.h:57
vlib_main_t::node_main
vlib_node_main_t node_main
Definition: main.h:171
vlib_node_t::node_fn_registrations
vlib_node_fn_registration_t * node_fn_registrations
Definition: node.h:362
vlib_node_runtime_t::next_frame_index
u32 next_frame_index
Start of next frames for this node.
Definition: node.h:475
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
vlib_node_t::state
u8 state
Definition: node.h:299
hash_create_string
#define hash_create_string(elts, value_bytes)
Definition: hash.h:689
node_index
node node_index
Definition: interface_output.c:420
state
vl_api_dhcp_client_state_t state
Definition: dhcp.api:201
vlib_process_t::node_runtime
vlib_node_runtime_t node_runtime
Definition: node.h:537
elog_string
__clib_export u32 elog_string(elog_main_t *em, char *fmt,...)
add a string to the event-log string table
Definition: elog.c:582
va_format
__clib_export u8 * va_format(u8 *s, const char *fmt, va_list *va)
Definition: format.c:391
CLIB_MARCH_VARIANT_TYPE
@ CLIB_MARCH_VARIANT_TYPE
Definition: cpu.h:41
vlib_pending_frame_t
Definition: node.h:439
VLIB_NODE_RUNTIME_DATA_SIZE
#define VLIB_NODE_RUNTIME_DATA_SIZE
Definition: node.h:516
vlib_node_t::next_node_names
char ** next_node_names
Definition: node.h:322
CLIB_MEM_VM_MAP_FAILED
#define CLIB_MEM_VM_MAP_FAILED
Definition: mem.h:54
vlib_node_function_t
uword() vlib_node_function_t(struct vlib_main_t *vm, struct vlib_node_runtime_t *node, struct vlib_frame_t *frame)
Definition: node.h:54
r
vnet_hw_if_output_node_runtime_t * r
Definition: interface_output.c:1071
vlib_frame_t
Definition: node.h:372
hash_create
#define hash_create(elts, value_bytes)
Definition: hash.h:695
vlib_main_t::node_return_elog_event_types
elog_event_type_t * node_return_elog_event_types
Definition: main.h:202
vlib_start_process
void vlib_start_process(vlib_main_t *vm, uword process_index)
Definition: main.c:1416
vlib_get_global_main
static vlib_global_main_t * vlib_get_global_main(void)
Definition: global_funcs.h:50
error
Definition: cJSON.c:88
key
typedef key
Definition: ipsec_types.api:88
i32
signed int i32
Definition: types.h:77
vlib_register_all_static_nodes
void vlib_register_all_static_nodes(vlib_main_t *vm)
Definition: node.c:573
vlib_node_add_next_with_slot
uword vlib_node_add_next_with_slot(vlib_main_t *vm, uword node_index, uword next_node_index, uword slot)
Definition: node.c:173
clib_mem_alloc_no_fail
#define clib_mem_alloc_no_fail(size)
Definition: mem.h:297
vec_elt
#define vec_elt(v, i)
Get vector value at index i.
Definition: vec_bootstrap.h:210
hash_set
#define hash_set(h, key, value)
Definition: hash.h:255
regs
static vnet_feature_upd_registration_t * regs
Definition: feature.c:26
pool_foreach
#define pool_foreach(VAR, POOL)
Iterate through pool.
Definition: pool.h:534
clib_error_create
#define clib_error_create(args...)
Definition: error.h:96
vec_len
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
Definition: vec_bootstrap.h:142
vlib_worker_thread_node_runtime_update
void vlib_worker_thread_node_runtime_update(void)
Definition: threads.c:1088
vlib_node_t::index
u32 index
Definition: node.h:269
vlib_node_runtime_update
static void vlib_node_runtime_update(vlib_main_t *vm, u32 node_index, u32 next_index)
Definition: node.c:96
slot
u8 slot
Definition: pci_types.api:22
VLIB_NODE_MAIN_RUNTIME_STARTED
#define VLIB_NODE_MAIN_RUNTIME_STARTED
Definition: node.h:674
vec_add2
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:644
vec_add1
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:606
vec_dup
#define vec_dup(V)
Return copy of vector (no header, no alignment)
Definition: vec.h:444
vec_elt_at_index
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
Definition: vec_bootstrap.h:203
clib_interrupt_resize
__clib_export void clib_interrupt_resize(void **data, uword n_int)
Definition: interrupt.c:38
priority
i32 priority
Definition: ipsec.api:95
vlib_process_create
u32 vlib_process_create(vlib_main_t *vm, char *name, vlib_node_function_t *f, u32 log2_n_stack_bytes)
Create a vlib process.
Definition: node.c:795
vlib_next_frame_t::flags
u32 flags
Definition: node.h:402
vlib_worker_thread_barrier_sync
#define vlib_worker_thread_barrier_sync(X)
Definition: threads.h:194
vlib_get_thread_index
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:208
vlib_node_fn_variant_t::index
clib_march_variant_type_t index
Definition: node.h:659
vlib_frame_vector_args
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:301
vlib_node_main_init
clib_error_t * vlib_node_main_init(vlib_main_t *vm)
Definition: node.c:665
vlib_global_main
vlib_global_main_t vlib_global_main
Definition: main.c:1786
uword
u64 uword
Definition: types.h:112
hash_get
#define hash_get(h, key)
Definition: hash.h:249
vlib_node_runtime_t::function
vlib_node_function_t * function
Node function to call.
Definition: node.h:458
STATIC_ASSERT_SIZEOF
#define STATIC_ASSERT_SIZEOF(d, s)
Definition: error_bootstrap.h:113
vlib_node_increment_counter
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1244
VLIB_PROCESS_STACK_MAGIC
#define VLIB_PROCESS_STACK_MAGIC
Definition: node.h:598
vlib_process_t::log2_n_stack_bytes
u16 log2_n_stack_bytes
Definition: node.h:560
vlib_get_node
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:86
vec_header
static void * vec_header(void *v, uword header_bytes)
Find a user vector header.
Definition: vec_bootstrap.h:92
i
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:261
vlib_global_main_t::node_registrations
vlib_node_registration_t * node_registrations
Definition: main.h:297
vec_validate
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment)
Definition: vec.h:523
vlib_node_t::type
vlib_node_type_t type
Definition: node.h:266
node_set_elog_name
static void node_set_elog_name(vlib_main_t *vm, uword node_index)
Definition: node.c:58
vlib_node_rename
void vlib_node_rename(vlib_main_t *vm, u32 node_index, char *fmt,...)
Definition: node.c:76
vlib_node_t::runtime_data
void * runtime_data
Definition: node.h:275
clib_min
#define clib_min(x, y)
Definition: clib.h:342
CLIB_CACHE_LINE_BYTES
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
fmt
int cJSON_bool fmt
Definition: cJSON.h:160
vlib_node_registration_t
struct _vlib_node_registration vlib_node_registration_t
vlib_global_main_t::elog_main
elog_main_t elog_main
Definition: main.h:300
vlib_node_add_named_next_with_slot
uword vlib_node_add_named_next_with_slot(vlib_main_t *vm, uword node, char *name, uword slot)
Definition: node.c:244
vlib_frame_free
void vlib_frame_free(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_frame_t *f)
Definition: main.c:242
vec_add2_aligned
#define vec_add2_aligned(V, P, N, A)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:656
vec_free
#define vec_free(V)
Free vector's memory (no header).
Definition: vec.h:395
vlib_get_node_by_name
vlib_node_t * vlib_get_node_by_name(vlib_main_t *vm, u8 *name)
Definition: node.c:45
node_elog_init
static void node_elog_init(vlib_main_t *vm, uword ni)
Definition: node.c:271
format_vlib_node_name
format_function_t format_vlib_node_name
Definition: node_funcs.h:1235
clib_march_variant_type_t
clib_march_variant_type_t
Definition: cpu.h:39
null_node_fn
static uword null_node_fn(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: node.c:526
format
description fragment has unexpected format
Definition: map.api:433
ASSERT
#define ASSERT(truth)
Definition: error_bootstrap.h:69
vlib_node_t::name_elog_string
u32 name_elog_string
Definition: node.h:256
vlib_node_t::prev_node_bitmap
uword * prev_node_bitmap
Definition: node.h:342
vec_validate_init_empty
#define vec_validate_init_empty(V, I, INIT)
Make sure vector is long enough for given index and initialize empty space (no header,...
Definition: vec.h:570
foreach_march_variant
#define foreach_march_variant
Definition: cpu.h:23
u32
unsigned int u32
Definition: types.h:88
vlib_node_t::function
vlib_node_function_t * function
Definition: node.h:250
vlib_next_frame_t::node_runtime_index
u32 node_runtime_index
Definition: node.h:399
CLIB_MEM_PAGE_SZ_DEFAULT
@ CLIB_MEM_PAGE_SZ_DEFAULT
Definition: mem.h:60
vlib_node_t::protocol_hint
u8 protocol_hint
Definition: node.h:305
si
vnet_sw_interface_t * si
Definition: interface_output.c:398
vlib_node_get_next
uword vlib_node_get_next(vlib_main_t *vm, uword node_index, uword next_node_index)
Definition: node.c:152
vec_foreach
#define vec_foreach(var, vec)
Vector iterator.
Definition: vec_bootstrap.h:213
vlib_node_fn_variant_t::priority
int priority
Definition: node.h:660
VLIB_NODE_TYPE_PROCESS
@ VLIB_NODE_TYPE_PROCESS
Definition: node.h:84
vlib_get_main_by_index
static vlib_main_t * vlib_get_main_by_index(u32 thread_index)
Definition: global_funcs.h:29
n_vectors
return frame n_vectors
Definition: nat44_ei_hairpinning.c:485
nm
nat44_ei_main_t * nm
Definition: nat44_ei_hairpinning.c:413
vlib_node_get_runtime
static vlib_node_runtime_t * vlib_node_get_runtime(vlib_main_t *vm, u32 node_index)
Get node runtime by node index.
Definition: node_funcs.h:116
vlib_node_fn_variant_t::suffix
char * suffix
Definition: node.h:661
vec_resize
#define vec_resize(V, N)
Resize a vector (no header, unspecified alignment) Add N elements to end of given vector V,...
Definition: vec.h:296
clib_mem_get_log2_page_size
static_always_inline clib_mem_page_sz_t clib_mem_get_log2_page_size(void)
Definition: mem.h:462
vlib_node_t::sibling_of
char * sibling_of
Definition: node.h:328
hash_unset
#define hash_unset(h, key)
Definition: hash.h:261
clib_memset
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
vlib_main_t
Definition: main.h:102
vlib_get_n_threads
static u32 vlib_get_n_threads()
Definition: global_funcs.h:23
vlib_node_t
Definition: node.h:247
vlib_node_t::n_vectors_by_next_node
u64 * n_vectors_by_next_node
Definition: node.h:334
u8
unsigned char u8
Definition: types.h:56
clib_error_t
Definition: clib_error.h:21
a
a
Definition: bitmap.h:544
rt
vnet_interface_output_runtime_t * rt
Definition: interface_output.c:399
register_node
static void register_node(vlib_main_t *vm, vlib_node_registration_t *r)
Definition: node.c:332
vlib_process_t
Definition: node.h:533
clib_error
#define clib_error(format, args...)
Definition: error.h:62
vlib_node_t::error_heap_index
u32 error_heap_index
Definition: node.h:315
vlib_node_main_t::variants
vlib_node_fn_variant_t * variants
Definition: node.h:736
clib_mem_vm_map_stack
__clib_export void * clib_mem_vm_map_stack(uword size, clib_mem_page_sz_t log2_page_sz, char *fmt,...)
Definition: mem.c:42
clib_mem_alloc_aligned
static void * clib_mem_alloc_aligned(uword size, uword align)
Definition: mem.h:261
vlib_node_t::next_nodes
u32 * next_nodes
Definition: node.h:325
vlib_register_node
u32 vlib_register_node(vlib_main_t *vm, vlib_node_registration_t *r)
Definition: node.c:519
vlib_node_main_t
Definition: node.h:665
vlib_pending_frame_t::next_frame_index
u32 next_frame_index
Definition: node.h:448
clib_bitmap_foreach
#define clib_bitmap_foreach(i, ai)
Macro to iterate across set bits in a bitmap.
Definition: bitmap.h:361
vlib_node_runtime_t
Definition: node.h:454
vlib_next_frame_t
Definition: node.h:393
clib_panic
#define clib_panic(format, args...)
Definition: error.h:72
vlib_node_t::runtime_index
u32 runtime_index
Definition: node.h:272
elog_event_type_t
Definition: elog.h:82
vlib_node_t::owner_node_index
u32 owner_node_index
Definition: node.h:345
vlib_next_frame_init
static void vlib_next_frame_init(vlib_next_frame_t *nf)
Definition: node.h:432
vlib_process_t::stack
u32 * stack
Definition: node.h:599
vec_insert
#define vec_insert(V, N, M)
Insert N vector elements starting at element M, initialize new elements to zero (no header,...
Definition: vec.h:775
VLIB_PENDING_FRAME_NO_NEXT_FRAME
#define VLIB_PENDING_FRAME_NO_NEXT_FRAME
Definition: node.h:451
type
vl_api_fib_path_type_t type
Definition: fib_types.api:123
vlib_node_get_preferred_node_fn_variant
vlib_node_function_t * vlib_node_get_preferred_node_fn_variant(vlib_main_t *vm, vlib_node_fn_registration_t *regs)
Definition: node.c:295
vlib_node_t::name
u8 * name
Definition: node.h:253
clib_mem_is_heap_object
static uword clib_mem_is_heap_object(void *p)
Definition: mem.h:303
flags
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:105