FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
node.h
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.h: 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 #ifndef included_vlib_node_h
41 #define included_vlib_node_h
42 
43 #include <vppinfra/cpu.h>
44 #include <vppinfra/longjmp.h>
45 #include <vppinfra/lock.h>
46 #include <vlib/trace.h> /* for vlib_trace_filter_t */
47 
48 /* Forward declaration. */
49 struct vlib_node_runtime_t;
50 struct vlib_frame_t;
51 
52 /* Internal nodes (including output nodes) move data from node to
53  node (or out of the graph for output nodes). */
55  struct vlib_node_runtime_t * node,
56  struct vlib_frame_t * frame);
57 
58 typedef enum
59 {
68 
69 typedef enum
70 {
71  /* An internal node on the call graph (could be output). */
73 
74  /* Nodes which input data into the processing graph.
75  Input nodes are called for each iteration of main loop. */
77 
78  /* Nodes to be called before all input nodes.
79  Used, for example, to clean out driver TX rings before
80  processing input. */
82 
83  /* "Process" nodes which can be suspended and later resumed. */
85 
88 
89 typedef struct _vlib_node_fn_registration
90 {
91  vlib_node_function_t *function;
92  clib_march_variant_type_t march_variant;
93  struct _vlib_node_fn_registration *next_registration;
95 
96 typedef struct _vlib_node_registration
97 {
98  /* Vector processing function for this node. */
99  vlib_node_function_t *function;
100 
101  /* Node function candidate registration with priority */
102  vlib_node_fn_registration_t *node_fn_registrations;
103 
104  /* Node name. */
105  char *name;
106 
107  /* Name of sibling (if applicable). */
108  char *sibling_of;
109 
110  /* Node index filled in by registration. */
111  u32 index;
112 
113  /* Type of this node. */
115 
116  /* Error strings indexed by error code for this node. */
117  char **error_strings;
118  vlib_error_desc_t *error_counters;
119 
120  /* Buffer format/unformat for this node. */
121  format_function_t *format_buffer;
122  unformat_function_t *unformat_buffer;
123 
124  /* Trace format/unformat for this node. */
125  format_function_t *format_trace;
126  unformat_function_t *unformat_trace;
127 
128  /* Function to validate incoming frames. */
129  u8 *(*validate_frame) (struct vlib_main_t * vm,
130  struct vlib_node_runtime_t *,
131  struct vlib_frame_t * f);
132 
133  /* Per-node runtime data. */
134  void *runtime_data;
135 
136  /* Process stack size. */
137  u16 process_log2_n_stack_bytes;
138 
139  /* Number of bytes of per-node run time data. */
140  u8 runtime_data_bytes;
141 
142  /* State for input nodes. */
143  u8 state;
144 
145  /* Node flags. */
146  u16 flags;
147 
148  /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
149  u8 protocol_hint;
150 
151  /* Size of scalar and vector arguments in bytes. */
153 
154  /* Number of error codes used by this node. */
155  u16 n_errors;
156 
157  /* Number of next node names that follow. */
158  u16 n_next_nodes;
159 
160  /* Constructor link-list, don't ask... */
161  struct _vlib_node_registration *next_registration;
162 
163  /* Names of next nodes which this node feeds into. */
164  char *next_nodes[];
165 
167 
168 #ifndef CLIB_MARCH_VARIANT
169 #define VLIB_REGISTER_NODE(x, ...) \
170  __VA_ARGS__ vlib_node_registration_t x; \
171  static void __vlib_add_node_registration_##x (void) \
172  __attribute__ ((__constructor__)); \
173  static void __vlib_add_node_registration_##x (void) \
174  { \
175  vlib_global_main_t *vgm = vlib_get_global_main (); \
176  x.next_registration = vgm->node_registrations; \
177  vgm->node_registrations = &x; \
178  } \
179  static void __vlib_rm_node_registration_##x (void) \
180  __attribute__ ((__destructor__)); \
181  static void __vlib_rm_node_registration_##x (void) \
182  { \
183  vlib_global_main_t *vgm = vlib_get_global_main (); \
184  VLIB_REMOVE_FROM_LINKED_LIST (vgm->node_registrations, &x, \
185  next_registration); \
186  } \
187  __VA_ARGS__ vlib_node_registration_t x
188 #else
189 #define VLIB_REGISTER_NODE(x,...) \
190 STATIC_ASSERT (sizeof(# __VA_ARGS__) != 7,"node " #x " must not be declared as static"); \
191 static __clib_unused vlib_node_registration_t __clib_unused_##x
192 #endif
193 
194 #ifndef CLIB_MARCH_VARIANT
195 #define CLIB_MARCH_VARIANT_STR "default"
196 #else
197 #define _CLIB_MARCH_VARIANT_STR(s) __CLIB_MARCH_VARIANT_STR(s)
198 #define __CLIB_MARCH_VARIANT_STR(s) #s
199 #define CLIB_MARCH_VARIANT_STR _CLIB_MARCH_VARIANT_STR(CLIB_MARCH_VARIANT)
200 #endif
201 
202 #define VLIB_NODE_FN(node) \
203  uword CLIB_MARCH_SFX (node##_fn) (); \
204  static vlib_node_fn_registration_t CLIB_MARCH_SFX ( \
205  node##_fn_registration) = { \
206  .function = &CLIB_MARCH_SFX (node##_fn), \
207  }; \
208  \
209  static void __clib_constructor CLIB_MARCH_SFX (node##_multiarch_register) ( \
210  void) \
211  { \
212  extern vlib_node_registration_t node; \
213  vlib_node_fn_registration_t *r; \
214  r = &CLIB_MARCH_SFX (node##_fn_registration); \
215  r->march_variant = CLIB_MARCH_SFX (CLIB_MARCH_VARIANT_TYPE); \
216  r->next_registration = node.node_fn_registrations; \
217  node.node_fn_registrations = r; \
218  } \
219  uword CLIB_MARCH_SFX (node##_fn)
220 
222 
223 typedef struct
224 {
225  /* Total calls, clock ticks and vector elements processed for this node. */
226  u64 calls, vectors, clocks, suspends;
230 
231 #define foreach_vlib_node_state \
232  /* Input node is called each iteration of main loop. \
233  This is the default (zero). */ \
234  _ (POLLING) \
235  /* Input node is called when device signals an interrupt. */ \
236  _ (INTERRUPT) \
237  /* Input node is never called. */ \
238  _ (DISABLED)
239 
240 typedef enum
241 {
242 #define _(f) VLIB_NODE_STATE_##f,
244 #undef _
247 
248 typedef struct vlib_node_t
249 {
250  /* Vector processing function for this node. */
251  vlib_node_function_t *function;
252 
253  /* Node name. */
254  u8 *name;
255 
256  /* Node name index in elog string table. */
258 
259  /* Total statistics for this node. */
261 
262  /* Saved values as of last clear (or zero if never cleared).
263  Current values are always stats_total - stats_last_clear. */
265 
266  /* Type of this node. */
268 
269  /* Node index. */
270  u32 index;
271 
272  /* Index of corresponding node runtime. */
274 
275  /* Runtime data for this node. */
276  void *runtime_data;
277 
278  /* Node flags. */
279  u16 flags;
280 
281  /* Processing function keeps frame. Tells node dispatching code not
282  to free frame after dispatch is done. */
283 #define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
284 
285  /* Node counts as output/drop/punt node for stats purposes. */
286 #define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
287 #define VLIB_NODE_FLAG_IS_DROP (1 << 2)
288 #define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
289 #define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
290 
291  /* Set if current node runtime has traced vectors. */
292 #define VLIB_NODE_FLAG_TRACE (1 << 5)
293 
294 #define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
295 #define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
296 #define VLIB_NODE_FLAG_TRACE_SUPPORTED (1 << 8)
297 #define VLIB_NODE_FLAG_ADAPTIVE_MODE (1 << 9)
298 
299  /* State for input nodes. */
300  u8 state;
301 
302  /* Number of bytes of run time data. */
304 
305  /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
307 
308  /* Number of error codes used by this node. */
309  u16 n_errors;
310 
311  /* Size of scalar and vector arguments in bytes. */
313 
314  /* Handle/index in error heap for this node. */
317 
318  /* Counter structures indexed by counter code for this node. */
320 
321  /* Vector of next node names.
322  Only used before next_nodes array is initialized. */
323  char **next_node_names;
324 
325  /* Next node indices for this node. */
326  u32 *next_nodes;
327 
328  /* Name of node that we are sibling of. */
329  char *sibling_of;
330 
331  /* Bitmap of all of this node's siblings. */
333 
334  /* Total number of vectors sent to each next node. */
336 
337  /* Hash table mapping next node index into slot in
338  next_nodes vector. Quickly determines whether this node
339  is connected to given next node and, if so, with which slot. */
341 
342  /* Bitmap of node indices which feed this node. */
344 
345  /* Node/next-index which own enqueue rights with to this node. */
347 
348  /* Buffer format/unformat for this node. */
351 
352  /* Trace buffer format/unformat for this node. */
354 
355  /* Function to validate incoming frames. */
356  u8 *(*validate_frame) (struct vlib_main_t * vm,
357  struct vlib_node_runtime_t *,
358  struct vlib_frame_t * f);
359  /* for pretty-printing, not typically valid */
360  u8 *state_string;
361 
362  /* Node function candidate registration with priority */
364 } vlib_node_t;
365 
366 #define VLIB_INVALID_NODE_INDEX ((u32) ~0)
367 
368 /* Max number of vector elements to process at once per node. */
369 #define VLIB_FRAME_SIZE 256
370 #define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
371 
372 /* Calling frame (think stack frame) for a node. */
373 typedef struct vlib_frame_t
374 {
375  /* Frame flags. */
377 
378  /* User flags. Used for sending hints to the next node. */
379  u16 flags;
380 
381  /* Number of scalar bytes in arguments. */
382  u8 scalar_size;
383 
384  /* Number of bytes per vector argument. */
385  u8 vector_size;
386 
387  /* Number of vector elements currently in frame. */
388  u16 n_vectors;
389 
390  /* Scalar and vector arguments to next node. */
391  u8 arguments[0];
392 } vlib_frame_t;
393 
394 typedef struct
395 {
396  /* Frame pointer. */
398 
399  /* Node runtime for this next. */
400  u32 node_runtime_index;
401 
402  /* Next frame flags. */
403  u32 flags;
404 
405  /* Reflects node frame-used flag for this next. */
406 #define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
407  VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
408 
409  /* Don't append this frame */
410 #define VLIB_FRAME_NO_APPEND (1 << 14)
411 
412  /* This next frame owns enqueue to node
413  corresponding to node_runtime_index. */
414 #define VLIB_FRAME_OWNER (1 << 15)
415 
416  /* Set when frame has been allocated for this next. */
417 #define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
418 
419  /* Set when frame has been added to pending vector. */
420 #define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
421 
422  /* Set when frame is to be freed after dispatch. */
423 #define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
424 
425  /* Set when frame has traced packets. */
426 #define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
427 
428  /* Number of vectors enqueue to this next since last overflow. */
429  u32 vectors_since_last_overflow;
431 
434 {
435  clib_memset (nf, 0, sizeof (nf[0]));
436  nf->node_runtime_index = ~0;
437 }
438 
439 /* A frame pending dispatch by main loop. */
440 typedef struct
441 {
442  /* Frame index (in the heap). */
444 
445  /* Node and runtime for this frame. */
446  u32 node_runtime_index;
447 
448  /* Start of next frames for this node. */
449  u32 next_frame_index;
450 
451  /* Special value for next_frame_index when there is no next frame. */
452 #define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
454 
455 typedef struct vlib_node_runtime_t
456 {
457  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
458 
459  vlib_node_function_t *function; /**< Node function to call. */
460 
461  vlib_error_t *errors; /**< Vector of errors for this node. */
462 
463  u32 clocks_since_last_overflow; /**< Number of clock cycles. */
464 
465  u32 max_clock; /**< Maximum clock cycle for an
466  invocation. */
467 
468  u32 max_clock_n; /**< Number of vectors in the recorded
469  max_clock. */
470 
471  u32 calls_since_last_overflow; /**< Number of calls. */
472 
473  u32 vectors_since_last_overflow; /**< Number of vector elements
474  processed by this node. */
475 
476  u32 next_frame_index; /**< Start of next frames for this
477  node. */
478 
479  u32 node_index; /**< Node index. */
480 
481  u32 input_main_loops_per_call; /**< For input nodes: decremented
482  on each main loop interation until
483  it reaches zero and function is
484  called. Allows some input nodes to
485  be called more than others. */
486 
487  u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
488  dispatch of this node. */
489 
491 
492  u16 flags; /**< Copy of main node flags. */
493 
494  u16 state; /**< Input node state. */
495 
497 
498  u16 cached_next_index; /**< Next frame index that vector
499  arguments were last enqueued to
500  last time this node ran. Set to
501  zero before first run of this
502  node. */
503 
504  u16 thread_index; /**< thread this node runs on */
505 
506  u8 runtime_data[0]; /**< Function dependent
507  node-runtime data. This data is
508  thread local, and it is not
509  cloned from main thread. It needs
510  to be initialized for each thread
511  before it is used unless
512  runtime_data template exists in
513  vlib_node_t. */
514 }
516 
517 #define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
518 
519 typedef struct
520 {
521  /* Number of allocated frames for this scalar/vector size. */
522  u32 n_alloc_frames;
523 
524  /* Vector of free frames for this scalar/vector size. */
525  vlib_frame_t **free_frames;
527 
528 typedef struct
529 {
530  /* Users opaque value for event type. */
531  uword opaque;
533 
534 typedef struct
535 {
536  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
537  /* Node runtime for this process. */
538  vlib_node_runtime_t node_runtime;
539 
540  /* Where to longjmp when process is done. */
541  clib_longjmp_t return_longjmp;
542 
543 #define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
544 #define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
545 
546  /* Where to longjmp to resume node after suspend. */
547  clib_longjmp_t resume_longjmp;
548 #define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
549 #define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
550 
552 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
553 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
554  /* Set to indicate that this process has been added to resume vector. */
555 #define VLIB_PROCESS_RESUME_PENDING (1 << 2)
556 
557  /* Process function is currently running. */
558 #define VLIB_PROCESS_IS_RUNNING (1 << 3)
559 
560  /* Size of process stack. */
561  u16 log2_n_stack_bytes;
562 
563  u32 suspended_process_frame_index;
564 
565  /* Number of times this process was suspended. */
566  u32 n_suspends;
567 
568  /* Vectors of pending event data indexed by event type index. */
569  void **pending_event_data_by_type_index;
570 
571  /* Bitmap of event type-indices with non-empty vectors. */
572  uword *non_empty_event_type_bitmap;
573 
574  /* Bitmap of event type-indices which are one time events. */
575  uword *one_time_event_type_bitmap;
576 
577  /* Type is opaque pointer -- typically a pointer to an event handler
578  function. Hash table to map opaque to a type index. */
579  uword *event_type_index_by_type_opaque;
580 
581  /* Pool of currently valid event types. */
582  vlib_process_event_type_t *event_type_pool;
583 
584  /*
585  * When suspending saves clock time (10us ticks) when process
586  * is to be resumed.
587  */
588  u64 resume_clock_interval;
589 
590  /* Handle from timer code, to cancel an unexpired timer */
591  u32 stop_timer_handle;
592 
593  /* Default output function and its argument for any CLI outputs
594  within the process. */
595  vlib_cli_output_function_t *output_function;
596  uword output_function_arg;
597 
598  /* Process stack */
599 #define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
600  u32 *stack;
602 
603 typedef struct
604 {
605  u32 node_index;
606 
607  u32 one_time_event;
609 
610 typedef struct
611 {
612  u16 n_data_elts;
613 
614  u16 n_data_elt_bytes;
615 
616  /* n_data_elts * n_data_elt_bytes */
617  u32 n_data_bytes;
618 
619  /* Process node & event type to be used to signal event. */
620  u32 process_node_index;
621 
622  u32 event_type_index;
623 
624  union
625  {
626  u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
627 
628  /* Vector of event data used only when data does not fit inline. */
629  u8 *event_data_as_vector;
630  };
631 }
633 
636 {
637  return d & 1;
638 }
639 
642 {
643  return 0 + 2 * i;
644 }
645 
648 {
649  return 1 + 2 * i;
650 }
651 
654 {
655  return d / 2;
656 }
657 
658 typedef struct
659 {
661  int priority;
662  char *suffix;
663  char *desc;
665 
666 typedef struct
667 {
668  /* Public nodes. */
669  vlib_node_t **nodes;
670 
671  /* Node index hashed by node name. */
672  uword *node_by_name;
673 
675 #define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
676 
677  /* Nodes segregated by type for cache locality.
678  Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
679  vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
680 
681  /* Node runtime indices for input nodes with pending interrupts. */
682  void *interrupts;
683  volatile u32 *pending_interrupts;
684 
685  /* Input nodes are switched from/to interrupt to/from polling mode
686  when average vector length goes above/below polling/interrupt
687  thresholds. */
688  u32 polling_threshold_vector_length;
689  u32 interrupt_threshold_vector_length;
690 
691  /* Vector of next frames. */
692  vlib_next_frame_t *next_frames;
693 
694  /* Vector of internal node's frames waiting to be called. */
695  vlib_pending_frame_t *pending_frames;
696 
697  /* Timing wheel for scheduling time-based node dispatch. */
698  void *timing_wheel;
699 
700  vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
701 
702  /* Opaque data vector added via timing_wheel_advance. */
703  u32 *data_from_advancing_timing_wheel;
704 
705  /* CPU time of next process to be ready on timing wheel. */
706  f64 time_next_process_ready;
707 
708  /* Vector of process nodes.
709  One for each node of type VLIB_NODE_TYPE_PROCESS. */
710  vlib_process_t **processes;
711 
712  /* Current running process or ~0 if no process running. */
713  u32 current_process_index;
714 
715  /* Pool of pending process frames. */
716  vlib_pending_frame_t *suspended_process_frames;
717 
718  /* Vector of event data vectors pending recycle. */
719  void **recycled_event_data_vectors;
720 
721  /* Current counts of nodes in each state. */
722  u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
723 
724  /* Hash of (scalar_size,vector_size) to frame_sizes index. */
725  uword *frame_size_hash;
726 
727  /* Per-size frame allocation information. */
728  vlib_frame_size_t *frame_sizes;
729 
730  /* Time of last node runtime stats clear. */
731  f64 time_last_runtime_stats_clear;
732 
733  /* Node index from error code */
734  u32 *node_by_error;
735 
736  /* Node Function Variants */
737  vlib_node_fn_variant_t *variants;
738 
739  /* Node Function Default Variant Index */
740  u32 node_fn_default_march_variant;
741 
742  /* Node Function march Variant by Suffix Hash */
743  uword *node_fn_march_variant_by_suffix;
745 
746 typedef u16 vlib_error_t;
747 
750 {
751  return nm->node_by_error[e];
752 }
753 
756 {
757  u32 node_index = nm->node_by_error[e];
758  vlib_node_t *n = nm->nodes[node_index];
759  u32 error_code = e - n->error_heap_index;
760  return error_code;
761 }
762 
763 #define FRAME_QUEUE_MAX_NELTS 64
764 typedef struct
765 {
767  u64 head;
768  u64 tail;
769  u32 n_in_use;
770  u32 nelts;
771  u32 written;
772  u32 threshold;
775 
776 typedef struct
777 {
780 
781 #endif /* included_vlib_node_h */
782 
783 /*
784  * fd.io coding-style-patch-verification: ON
785  *
786  * Local Variables:
787  * eval: (c-set-style "gnu")
788  * End:
789  */
vlib_node_fn_variant_t
Definition: node.h:657
vlib_node_runtime_t::clocks_since_last_overflow
u32 clocks_since_last_overflow
Number of clock cycles.
Definition: node.h:462
vlib_frame_t::n_vectors
u16 n_vectors
Definition: node.h:387
vlib_node_fn_registration_t
struct _vlib_node_fn_registration vlib_node_fn_registration_t
vlib_node_runtime_t::flags
u16 flags
Copy of main node flags.
Definition: node.h:491
vlib_node_runtime_t::CLIB_CACHE_LINE_ALIGN_MARK
CLIB_CACHE_LINE_ALIGN_MARK(cacheline0)
cacheline mark
frame
vlib_main_t vlib_node_runtime_t vlib_frame_t * frame
Definition: nat44_ei.c:3048
vlib_timing_wheel_data_is_timed_event
static uword vlib_timing_wheel_data_is_timed_event(u32 d)
Definition: node.h:634
vlib_error_get_node
static u32 vlib_error_get_node(vlib_node_main_t *nm, vlib_error_t e)
Definition: node.h:748
VLIB_NODE_TYPE_PRE_INPUT
@ VLIB_NODE_TYPE_PRE_INPUT
Definition: node.h:81
vlib_node_t::owner_next_index
u32 owner_next_index
Definition: node.h:345
f
vlib_frame_t * f
Definition: interface_output.c:1098
vlib_node_t::sibling_bitmap
uword * sibling_bitmap
Definition: node.h:331
CLIB_CACHE_LINE_ALIGN_MARK
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
name
string name[64]
Definition: fib.api:25
vlib_node_t::format_trace
format_function_t * format_trace
Definition: node.h:352
vlib_frame_size_t
Definition: node.h:518
vlib_node_runtime_t::max_clock_n
u32 max_clock_n
Number of vectors in the recorded max_clock.
Definition: node.h:467
VLIB_NODE_PROTO_HINT_ETHERNET
@ VLIB_NODE_PROTO_HINT_ETHERNET
Definition: node.h:61
VLIB_NODE_TYPE_INTERNAL
@ VLIB_NODE_TYPE_INTERNAL
Definition: node.h:72
vlib_frame_t::vector_size
u8 vector_size
Definition: node.h:384
node
vlib_main_t vlib_node_runtime_t * node
Definition: nat44_ei.c:3047
vlib_node_runtime_t
struct vlib_node_runtime_t vlib_node_runtime_t
vlib_node_runtime_t::max_clock
u32 max_clock
Maximum clock cycle for an invocation.
Definition: node.h:464
VLIB_NODE_TYPE_INPUT
@ VLIB_NODE_TYPE_INPUT
Definition: node.h:76
VLIB_NODE_PROTO_HINT_NONE
@ VLIB_NODE_PROTO_HINT_NONE
Definition: node.h:60
vlib_node_t::flags
u16 flags
Definition: node.h:278
u16
unsigned short u16
Definition: types.h:57
vlib_node_t::node_fn_registrations
vlib_node_fn_registration_t * node_fn_registrations
Definition: node.h:362
VLIB_NODE_PROTO_HINT_IP4
@ VLIB_NODE_PROTO_HINT_IP4
Definition: node.h:62
vlib_node_runtime_t::next_frame_index
u32 next_frame_index
Start of next frames for this node.
Definition: node.h:475
vlib_error_get_code
static u32 vlib_error_get_code(vlib_node_main_t *nm, vlib_error_t e)
Definition: node.h:754
trace.h
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
vlib_error_desc_t
Definition: error.h:54
vlib_node_runtime_t::calls_since_last_overflow
u32 calls_since_last_overflow
Number of calls.
Definition: node.h:470
node_index
node node_index
Definition: interface_output.c:440
state
vl_api_dhcp_client_state_t state
Definition: dhcp.api:201
vlib_node_runtime_t::input_main_loops_per_call
u32 input_main_loops_per_call
For input nodes: decremented on each main loop interation until it reaches zero and function is calle...
Definition: node.h:480
vlib_node_proto_hint_t
vlib_node_proto_hint_t
Definition: node.h:58
vlib_pending_frame_t
Definition: node.h:439
vlib_node_t::next_node_names
char ** next_node_names
Definition: node.h:322
VLIB_NODE_N_PROTO_HINTS
@ VLIB_NODE_N_PROTO_HINTS
Definition: node.h:66
vlib_node_t::next_slot_by_node
uword * next_slot_by_node
Definition: node.h:339
vlib_frame_t::frame_flags
u16 frame_flags
Definition: node.h:375
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
vlib_node_t::unformat_buffer
unformat_function_t * unformat_buffer
Definition: node.h:349
vlib_frame_t
Definition: node.h:372
vlib_node_runtime_t::vectors_since_last_overflow
u32 vectors_since_last_overflow
Number of vector elements processed by this node.
Definition: node.h:472
i32
signed int i32
Definition: types.h:77
longjmp.h
vlib_node_runtime_t::main_loop_vector_stats
u32 main_loop_vector_stats[2]
Definition: node.h:489
vlib_node_runtime_t::thread_index
u16 thread_index
thread this node runs on
Definition: node.h:503
vlib_node_runtime_t::n_next_nodes
u16 n_next_nodes
Definition: node.h:495
vlib_node_runtime_t::errors
vlib_error_t * errors
Vector of errors for this node.
Definition: node.h:460
count
u8 count
Definition: dhcp.api:208
vlib_node_t::format_buffer
format_function_t * format_buffer
Definition: node.h:348
vlib_node_t::index
u32 index
Definition: node.h:269
vlib_process_event_type_t
Definition: node.h:527
lock.h
priority
i32 priority
Definition: ipsec.api:95
vlib_node_runtime_t::main_loop_count_last_dispatch
u32 main_loop_count_last_dispatch
Saved main loop counter of last dispatch of this node.
Definition: node.h:486
vlib_timing_wheel_data_set_timed_event
static u32 vlib_timing_wheel_data_set_timed_event(u32 i)
Definition: node.h:646
vlib_node_runtime_t::state
u16 state
Input node state.
Definition: node.h:493
vlib_node_t::error_heap_handle
u32 error_heap_handle
Definition: node.h:314
vlib_timing_wheel_data_set_suspended_process
static u32 vlib_timing_wheel_data_set_suspended_process(u32 i)
Definition: node.h:640
uword
u64 uword
Definition: types.h:112
VLIB_N_NODE_STATE
@ VLIB_N_NODE_STATE
Definition: node.h:244
vlib_node_state_t
vlib_node_state_t
Definition: node.h:239
f64
double f64
Definition: types.h:142
vlib_node_stats_t::vectors
u64 vectors
Definition: node.h:226
vlib_node_t
struct vlib_node_t vlib_node_t
vlib_node_t::type
vlib_node_type_t type
Definition: node.h:266
vlib_node_t::n_errors
u16 n_errors
Definition: node.h:308
vlib_cli_output_function_t
void() vlib_cli_output_function_t(uword arg, u8 *buffer, uword buffer_bytes)
Definition: cli.h:134
vlib_timing_wheel_data_get_index
static uword vlib_timing_wheel_data_get_index(u32 d)
Definition: node.h:652
vlib_node_t::runtime_data
void * runtime_data
Definition: node.h:275
vlib_node_registration_t
struct _vlib_node_registration vlib_node_registration_t
cpu.h
VLIB_NODE_PROTO_HINT_IP6
@ VLIB_NODE_PROTO_HINT_IP6
Definition: node.h:63
vlib_node_t::error_counters
vlib_error_desc_t * error_counters
Definition: node.h:318
VLIB_NODE_PROTO_HINT_UDP
@ VLIB_NODE_PROTO_HINT_UDP
Definition: node.h:65
FRAME_QUEUE_MAX_NELTS
#define FRAME_QUEUE_MAX_NELTS
Definition: node.h:762
vlib_node_type_t
vlib_node_type_t
Definition: node.h:69
format_function_t
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
vlib_node_stats_t::max_clock
u64 max_clock
Definition: node.h:227
index
u32 index
Definition: flow_types.api:221
vlib_node_runtime_t::node_index
u32 node_index
Node index.
Definition: node.h:478
always_inline
#define always_inline
Definition: rdma_mlx5dv.h:23
vlib_frame_t::scalar_size
u8 scalar_size
Definition: node.h:381
u64
unsigned long u64
Definition: types.h:89
vlib_frame_t::arguments
u8 arguments[0]
Definition: node.h:390
VLIB_NODE_PROTO_HINT_TCP
@ VLIB_NODE_PROTO_HINT_TCP
Definition: node.h:64
clib_march_variant_type_t
clib_march_variant_type_t
Definition: cpu.h:39
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
vlib_frame_t::flags
u16 flags
Definition: node.h:378
u32
unsigned int u32
Definition: types.h:88
vlib_next_frame_t::node_runtime_index
u32 node_runtime_index
Definition: node.h:399
vlib_node_t::protocol_hint
u8 protocol_hint
Definition: node.h:305
vlib_node_t::state_string
u8 * state_string
Definition: node.h:359
vlib_node_t::stats_total
vlib_node_stats_t stats_total
Definition: node.h:259
vlib_node_stats_t::max_clock_n
u64 max_clock_n
Definition: node.h:228
vlib_node_t::runtime_data_bytes
u8 runtime_data_bytes
Definition: node.h:302
VLIB_NODE_TYPE_PROCESS
@ VLIB_NODE_TYPE_PROCESS
Definition: node.h:84
unformat_function_t
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:225
n_vectors
return frame n_vectors
Definition: nat44_ei_hairpinning.c:488
nm
nat44_ei_main_t * nm
Definition: nat44_ei_hairpinning.c:413
vlib_node_stats_t
Definition: node.h:223
vlib_node_t::sibling_of
char * sibling_of
Definition: node.h:328
VLIB_N_NODE_TYPE
@ VLIB_N_NODE_TYPE
Definition: node.h:86
clib_memset
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
vlib_main_t
Definition: main.h:102
vlib_node_t::scalar_size
u16 scalar_size
Definition: node.h:311
vlib_node_t::stats_last_clear
vlib_node_stats_t stats_last_clear
Definition: node.h:263
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
frame_queue_trace_t
Definition: node.h:763
foreach_vlib_node_state
#define foreach_vlib_node_state
Definition: node.h:231
vlib_process_t
Definition: node.h:533
i
int i
Definition: flowhash_template.h:376
vlib_node_t::error_heap_index
u32 error_heap_index
Definition: node.h:315
vlib_node_runtime_t::cached_next_index
u16 cached_next_index
Next frame index that vector arguments were last enqueued to last time this node ran.
Definition: node.h:497
vlib_one_time_waiting_process_t
Definition: node.h:602
vlib_node_t::next_nodes
u32 * next_nodes
Definition: node.h:325
vlib_node_main_t
Definition: node.h:665
vlib_error_t
u16 vlib_error_t
Definition: error.h:45
vlib_node_runtime_t
Definition: node.h:454
vlib_next_frame_t
Definition: node.h:393
vlib_node_t::runtime_index
u32 runtime_index
Definition: node.h:272
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_node_runtime_t::runtime_data
u8 runtime_data[0]
Function dependent node-runtime data.
Definition: node.h:505
vlib_frame_t
struct vlib_frame_t vlib_frame_t
type
vl_api_fib_path_type_t type
Definition: fib_types.api:123
unformat_vlib_node_variant
unformat_function_t unformat_vlib_node_variant
Definition: node.h:221
vlib_node_t::name
u8 * name
Definition: node.h:253
vlib_error_t
u16 vlib_error_t
Definition: node.h:745
clib_longjmp_t
Definition: longjmp.h:102
vlib_signal_timed_event_data_t
Definition: node.h:609
frame_queue_nelt_counter_t
Definition: node.h:775
vlib_node_t::vector_size
u16 vector_size
Definition: node.h:311
flags
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:105