FD.io VPP  v20.01-rc1
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  int priority;
93  struct _vlib_node_fn_registration *next_registration;
94  char *name;
96 
97 typedef struct _vlib_node_registration
98 {
99  /* Vector processing function for this node. */
100  vlib_node_function_t *function;
101 
102  /* Node function candidate registration with priority */
103  vlib_node_fn_registration_t *node_fn_registrations;
104 
105  /* Node name. */
106  char *name;
107 
108  /* Name of sibling (if applicable). */
109  char *sibling_of;
110 
111  /* Node index filled in by registration. */
112  u32 index;
113 
114  /* Type of this node. */
115  vlib_node_type_t type;
116 
117  /* Error strings indexed by error code for this node. */
118  char **error_strings;
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_main_t * vm = vlib_get_main(); \
176  x.next_registration = vm->node_main.node_registrations; \
177  vm->node_main.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_main_t * vm = vlib_get_main(); \
184  VLIB_REMOVE_FROM_LINKED_LIST (vm->node_main.node_registrations, \
185  &x, 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 \
205  CLIB_MARCH_SFX(node##_fn_registration) = \
206  { .function = &CLIB_MARCH_SFX (node##_fn), }; \
207  \
208 static void __clib_constructor \
209 CLIB_MARCH_SFX (node##_multiarch_register) (void) \
210 { \
211  extern vlib_node_registration_t node; \
212  vlib_node_fn_registration_t *r; \
213  r = & CLIB_MARCH_SFX (node##_fn_registration); \
214  r->priority = CLIB_MARCH_FN_PRIORITY(); \
215  r->name = CLIB_MARCH_VARIANT_STR; \
216  r->next_registration = node.node_fn_registrations; \
217  node.node_fn_registrations = r; \
218 } \
219 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (node##_fn)
220 
223 {
224  c =
226  c->n_next_nodes * sizeof (c->next_nodes[0]));
227  return c;
228 }
229 
230 typedef struct
231 {
232  /* Total calls, clock ticks and vector elements processed for this node. */
233  u64 calls, vectors, clocks, suspends;
240 
241 #define foreach_vlib_node_state \
242  /* Input node is called each iteration of main loop. \
243  This is the default (zero). */ \
244  _ (POLLING) \
245  /* Input node is called when device signals an interrupt. */ \
246  _ (INTERRUPT) \
247  /* Input node is never called. */ \
248  _ (DISABLED)
249 
250 typedef enum
251 {
252 #define _(f) VLIB_NODE_STATE_##f,
254 #undef _
257 
258 typedef struct vlib_node_t
259 {
260  /* Vector processing function for this node. */
262 
263  /* Node name. */
265 
266  /* Node name index in elog string table. */
268 
269  /* Total statistics for this node. */
271 
272  /* Saved values as of last clear (or zero if never cleared).
273  Current values are always stats_total - stats_last_clear. */
275 
276  /* Type of this node. */
277  vlib_node_type_t type;
278 
279  /* Node index. */
281 
282  /* Index of corresponding node runtime. */
284 
285  /* Runtime data for this node. */
287 
288  /* Node flags. */
290 
291  /* Processing function keeps frame. Tells node dispatching code not
292  to free frame after dispatch is done. */
293 #define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
294 
295  /* Node counts as output/drop/punt node for stats purposes. */
296 #define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
297 #define VLIB_NODE_FLAG_IS_DROP (1 << 2)
298 #define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
299 #define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
300 
301  /* Set if current node runtime has traced vectors. */
302 #define VLIB_NODE_FLAG_TRACE (1 << 5)
303 
304 #define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
305 #define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
306 #define VLIB_NODE_FLAG_TRACE_SUPPORTED (1 << 8)
307 
308  /* State for input nodes. */
310 
311  /* Number of bytes of run time data. */
313 
314  /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
316 
317  /* Number of error codes used by this node. */
319 
320  /* Size of scalar and vector arguments in bytes. */
321  u16 scalar_size, vector_size;
322 
323  /* Handle/index in error heap for this node. */
326 
327  /* Error strings indexed by error code for this node. */
329 
330  /* Vector of next node names.
331  Only used before next_nodes array is initialized. */
333 
334  /* Next node indices for this node. */
336 
337  /* Name of node that we are sibling of. */
338  char *sibling_of;
339 
340  /* Bitmap of all of this node's siblings. */
342 
343  /* Total number of vectors sent to each next node. */
345 
346  /* Hash table mapping next node index into slot in
347  next_nodes vector. Quickly determines whether this node
348  is connected to given next node and, if so, with which slot. */
350 
351  /* Bitmap of node indices which feed this node. */
353 
354  /* Node/next-index which own enqueue rights with to this node. */
355  u32 owner_node_index, owner_next_index;
356 
357  /* Buffer format/unformat for this node. */
360 
361  /* Trace buffer format/unformat for this node. */
363 
364  /* Function to validate incoming frames. */
365  u8 *(*validate_frame) (struct vlib_main_t * vm,
366  struct vlib_node_runtime_t *,
367  struct vlib_frame_t * f);
368  /* for pretty-printing, not typically valid */
370 
371  /* Node function candidate registration with priority */
373 } vlib_node_t;
374 
375 #define VLIB_INVALID_NODE_INDEX ((u32) ~0)
376 
377 /* Max number of vector elements to process at once per node. */
378 #define VLIB_FRAME_SIZE 256
379 #define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
380 
381 /* Calling frame (think stack frame) for a node. */
382 typedef struct vlib_frame_t
383 {
384  /* Frame flags. */
386 
387  /* User flags. Used for sending hints to the next node. */
389 
390  /* Number of scalar bytes in arguments. */
392 
393  /* Number of bytes per vector argument. */
395 
396  /* Number of vector elements currently in frame. */
398 
399  /* Scalar and vector arguments to next node. */
400  u8 arguments[0];
401 } vlib_frame_t;
402 
403 typedef struct
404 {
405  /* Frame pointer. */
407 
408  /* Node runtime for this next. */
410 
411  /* Next frame flags. */
413 
414  /* Reflects node frame-used flag for this next. */
415 #define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
416  VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
417 
418  /* Don't append this frame */
419 #define VLIB_FRAME_NO_APPEND (1 << 14)
420 
421  /* This next frame owns enqueue to node
422  corresponding to node_runtime_index. */
423 #define VLIB_FRAME_OWNER (1 << 15)
424 
425  /* Set when frame has been allocated for this next. */
426 #define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
427 
428  /* Set when frame has been added to pending vector. */
429 #define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
430 
431  /* Set when frame is to be freed after dispatch. */
432 #define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
433 
434  /* Set when frame has traced packets. */
435 #define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
436 
437  /* Number of vectors enqueue to this next since last overflow. */
440 
441 always_inline void
443 {
444  clib_memset (nf, 0, sizeof (nf[0]));
445  nf->node_runtime_index = ~0;
446 }
447 
448 /* A frame pending dispatch by main loop. */
449 typedef struct
450 {
451  /* Node and runtime for this frame. */
453 
454  /* Frame index (in the heap). */
456 
457  /* Start of next frames for this node. */
459 
460  /* Special value for next_frame_index when there is no next frame. */
461 #define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
463 
464 typedef struct vlib_node_runtime_t
465 {
466  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
467 
468  vlib_node_function_t *function; /**< Node function to call. */
469 
470  vlib_error_t *errors; /**< Vector of errors for this node. */
471 
472 #if __SIZEOF_POINTER__ == 4
473  u8 pad[8];
474 #endif
475 
476  u32 clocks_since_last_overflow; /**< Number of clock cycles. */
477 
478  u32 max_clock; /**< Maximum clock cycle for an
479  invocation. */
480 
481  u32 max_clock_n; /**< Number of vectors in the recorded
482  max_clock. */
483 
484  u32 calls_since_last_overflow; /**< Number of calls. */
485 
486  u32 vectors_since_last_overflow; /**< Number of vector elements
487  processed by this node. */
488 
489  u32 perf_counter0_ticks_since_last_overflow; /**< Perf counter 0 ticks */
490  u32 perf_counter1_ticks_since_last_overflow; /**< Perf counter 1 ticks */
491  u32 perf_counter_vectors_since_last_overflow; /**< Perf counter vectors */
492 
493  u32 next_frame_index; /**< Start of next frames for this
494  node. */
495 
496  u32 node_index; /**< Node index. */
497 
498  u32 input_main_loops_per_call; /**< For input nodes: decremented
499  on each main loop interation until
500  it reaches zero and function is
501  called. Allows some input nodes to
502  be called more than others. */
503 
504  u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
505  dispatch of this node. */
506 
507  u32 main_loop_vector_stats[2];
508 
509  u16 flags; /**< Copy of main node flags. */
510 
511  u16 state; /**< Input node state. */
512 
514 
515  u16 cached_next_index; /**< Next frame index that vector
516  arguments were last enqueued to
517  last time this node ran. Set to
518  zero before first run of this
519  node. */
520 
521  u16 thread_index; /**< thread this node runs on */
522 
523  u8 runtime_data[0]; /**< Function dependent
524  node-runtime data. This data is
525  thread local, and it is not
526  cloned from main thread. It needs
527  to be initialized for each thread
528  before it is used unless
529  runtime_data template exists in
530  vlib_node_t. */
531 }
533 
534 #define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
535 
536 typedef struct
537 {
538  /* Number of allocated frames for this scalar/vector size. */
540 
541  /* Vector of free frames for this scalar/vector size. */
544 
545 typedef struct
546 {
547  /* Users opaque value for event type. */
550 
551 typedef struct
552 {
553  /* Node runtime for this process. */
555 
556  /* Where to longjmp when process is done. */
558 
559 #define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
560 #define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
561 
562  /* Where to longjmp to resume node after suspend. */
564 #define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
565 #define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
566 
568 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
569 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
570  /* Set to indicate that this process has been added to resume vector. */
571 #define VLIB_PROCESS_RESUME_PENDING (1 << 2)
572 
573  /* Process function is currently running. */
574 #define VLIB_PROCESS_IS_RUNNING (1 << 3)
575 
576  /* Size of process stack. */
578 
580 
581  /* Number of times this process was suspended. */
583 
584  /* Vectors of pending event data indexed by event type index. */
586 
587  /* Bitmap of event type-indices with non-empty vectors. */
589 
590  /* Bitmap of event type-indices which are one time events. */
592 
593  /* Type is opaque pointer -- typically a pointer to an event handler
594  function. Hash table to map opaque to a type index. */
596 
597  /* Pool of currently valid event types. */
599 
600  /*
601  * When suspending saves clock time (10us ticks) when process
602  * is to be resumed.
603  */
605 
606  /* Handle from timer code, to cancel an unexpired timer */
608 
609  /* Default output function and its argument for any CLI outputs
610  within the process. */
613 
614 #ifdef CLIB_UNIX
615  /* Pad to a multiple of the page size so we can mprotect process stacks */
616 #define PAGE_SIZE_MULTIPLE 0x1000
617 #define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT __attribute__ ((aligned (PAGE_SIZE_MULTIPLE)))
618 #else
619 #define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT
620 #endif
621 
622  /* Process stack. Starts here and extends 2^log2_n_stack_bytes
623  bytes. */
624 
625 #define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
627 } vlib_process_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
628 
629 #ifdef CLIB_UNIX
630  /* Ensure that the stack is aligned on the multiple of the page size */
631 typedef char
634  -
636  ==
637  0 ? 0 :
638  -1];
639 #endif
640 
641 typedef struct
642 {
644 
647 
648 typedef struct
649 {
651 
653 
654  /* n_data_elts * n_data_elt_bytes */
656 
657  /* Process node & event type to be used to signal event. */
659 
661 
662  union
663  {
664  u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
665 
666  /* Vector of event data used only when data does not fit inline. */
668  };
669 }
671 
674 {
675  return d & 1;
676 }
677 
680 {
681  return 0 + 2 * i;
682 }
683 
686 {
687  return 1 + 2 * i;
688 }
689 
692 {
693  return d / 2;
694 }
695 
696 typedef struct
697 {
698  /* Public nodes. */
700 
701  /* Node index hashed by node name. */
703 
705 #define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
706 
707  /* Nodes segregated by type for cache locality.
708  Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
710 
711  /* Node runtime indices for input nodes with pending interrupts. */
714 
715  /* Input nodes are switched from/to interrupt to/from polling mode
716  when average vector length goes above/below polling/interrupt
717  thresholds. */
720 
721  /* Vector of next frames. */
723 
724  /* Vector of internal node's frames waiting to be called. */
726 
727  /* Timing wheel for scheduling time-based node dispatch. */
729 
731 
732  /* Opaque data vector added via timing_wheel_advance. */
734 
735  /* CPU time of next process to be ready on timing wheel. */
737 
738  /* Vector of process nodes.
739  One for each node of type VLIB_NODE_TYPE_PROCESS. */
741 
742  /* Current running process or ~0 if no process running. */
744 
745  /* Pool of pending process frames. */
747 
748  /* Vector of event data vectors pending recycle. */
750 
751  /* Current counts of nodes in each state. */
752  u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
753 
754  /* Hash of (scalar_size,vector_size) to frame_sizes index. */
756 
757  /* Per-size frame allocation information. */
759 
760  /* Time of last node runtime stats clear. */
762 
763  /* Node registrations added by constructors */
765 
766  /* Node index from error code */
769 
771 
773 vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
774 {
775  return nm->node_by_error[e];
776 }
777 
779 vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
780 {
781  u32 node_index = nm->node_by_error[e];
782  vlib_node_t *n = nm->nodes[node_index];
783  u32 error_code = e - n->error_heap_index;
784  return error_code;
785 }
786 
787 #define FRAME_QUEUE_MAX_NELTS 64
788 typedef struct
789 {
790  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
800 
801 typedef struct
802 {
805 
806 #endif /* included_vlib_node_h */
807 
808 /*
809  * fd.io coding-style-patch-verification: ON
810  *
811  * Local Variables:
812  * eval: (c-set-style "gnu")
813  * End:
814  */
uword * sibling_bitmap
Definition: node.h:341
u32 * next_nodes
Definition: node.h:335
u8 count
Definition: dhcp.api:208
uword output_function_arg
Definition: node.h:612
u8 * state_string
Definition: node.h:369
u16 vector_size
Definition: node.h:321
u32 error_heap_index
Definition: node.h:325
u32 max_clock
Maximum clock cycle for an invocation.
Definition: node.h:478
u32 next_frame_index
Start of next frames for this node.
Definition: node.h:493
u8 pad[3]
log2 (size of the packing page block)
Definition: bihash_doc.h:61
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
vlib_node_type_t
Definition: node.h:69
u32 interrupt_threshold_vector_length
Definition: node.h:719
vlib_process_t ** processes
Definition: node.h:740
vlib_node_runtime_t node_runtime
Definition: node.h:554
u32 n_suspends
Definition: node.h:582
unsigned long u64
Definition: types.h:89
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
u32 index
Definition: node.h:280
format_function_t * format_trace
Definition: node.h:362
void ** pending_event_data_by_type_index
Definition: node.h:585
u32 current_process_index
Definition: node.h:743
u16 flags
Definition: node.h:289
char ** error_strings
Definition: node.h:328
u32 clocks_since_last_overflow
Number of clock cycles.
Definition: node.h:476
int i
#define PAGE_SIZE_MULTIPLE
Definition: node.h:616
clib_spinlock_t pending_interrupt_lock
Definition: node.h:713
void * runtime_data
Definition: node.h:286
vlib_error_t * errors
Vector of errors for this node.
Definition: node.h:470
struct vlib_frame_t vlib_frame_t
static vlib_node_registration_t * vlib_node_next_registered(vlib_node_registration_t *c)
Definition: node.h:222
unsigned char u8
Definition: types.h:56
u64 perf_counter0_ticks
Definition: node.h:236
double f64
Definition: types.h:142
u16 thread_index
thread this node runs on
Definition: node.h:521
u8 state
Definition: node.h:309
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
u32 * pending_interrupt_node_runtime_indices
Definition: node.h:712
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:498
vlib_node_stats_t stats_last_clear
Definition: node.h:274
u32 main_loop_count_last_dispatch
Saved main loop counter of last dispatch of this node.
Definition: node.h:504
void ** recycled_event_data_vectors
Definition: node.h:749
u16 log2_n_stack_bytes
Definition: node.h:577
vlib_node_t ** nodes
Definition: node.h:699
u32 vectors_since_last_overflow
Number of vector elements processed by this node.
Definition: node.h:486
char ** next_node_names
Definition: node.h:332
char * sibling_of
Definition: node.h:338
u64 perf_counter_vectors
Definition: node.h:238
u16 vlib_error_t
Definition: node.h:770
static uword vlib_timing_wheel_data_is_timed_event(u32 d)
Definition: node.h:673
struct _vlib_node_fn_registration vlib_node_fn_registration_t
unsigned int u32
Definition: types.h:88
u32 perf_counter0_ticks_since_last_overflow
Perf counter 0 ticks.
Definition: node.h:489
i32 priority
Definition: ipsec.api:92
u64 max_clock_n
Definition: node.h:235
char assert_process_stack_must_be_aligned_exactly_to_page_size_multiple[(sizeof(vlib_process_t) - PAGE_SIZE_MULTIPLE)==0 ? 0 :-1]
Definition: node.h:638
vl_api_fib_path_type_t type
Definition: fib_types.api:123
u32 calls_since_last_overflow
Number of calls.
Definition: node.h:484
u32 next_frame_index
Definition: node.h:458
u32 error_heap_handle
Definition: node.h:324
vlib_node_stats_t stats_total
Definition: node.h:270
vlib_node_proto_hint_t
Definition: node.h:58
u16 state
Input node state.
Definition: node.h:511
vlib_signal_timed_event_data_t * signal_timed_event_data_pool
Definition: node.h:730
static void vlib_next_frame_init(vlib_next_frame_t *nf)
Definition: node.h:442
u16 frame_flags
Definition: node.h:385
f64 time_last_runtime_stats_clear
Definition: node.h:761
unsigned short u16
Definition: types.h:57
vlib_node_registration_t * node_registrations
Definition: node.h:764
u32 n_alloc_frames
Definition: node.h:539
static uword vlib_timing_wheel_data_get_index(u32 d)
Definition: node.h:691
u32 * node_by_error
Definition: node.h:767
u32 polling_threshold_vector_length
Definition: node.h:718
u64 * n_vectors_by_next_node
Definition: node.h:344
#define always_inline
Definition: ipsec.h:28
format_function_t * format_buffer
Definition: node.h:358
u8 protocol_hint
Definition: node.h:315
vlib_frame_t * frame
Definition: node.h:455
u32 node_index
Node index.
Definition: node.h:496
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:233
uword * frame_size_hash
Definition: node.h:755
vlib_main_t * vm
Definition: in2out_ed.c:1810
static u32 vlib_error_get_code(vlib_node_main_t *nm, vlib_error_t e)
Definition: node.h:779
u8 * name
Definition: node.h:264
u32 owner_node_index
Definition: node.h:355
u32 flags
Definition: vhost_user.h:141
svmdb_client_t * c
u16 n_vectors
Definition: node.h:397
u32 runtime_index
Definition: node.h:283
vlib_pending_frame_t * pending_frames
Definition: node.h:725
u32 node_runtime_index
Definition: node.h:452
unformat_function_t * unformat_buffer
Definition: node.h:359
u32 perf_counter_vectors_since_last_overflow
Perf counter vectors.
Definition: node.h:491
uword * node_by_name
Definition: node.h:702
u32 stack [0] ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT
Definition: node.h:626
vlib_frame_t ** free_frames
Definition: node.h:542
vlib_node_fn_registration_t * node_fn_registrations
Definition: node.h:372
string name[64]
Definition: ip.api:44
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1810
uword * one_time_event_type_bitmap
Definition: node.h:591
signed int i32
Definition: types.h:77
#define clib_elf_section_data_next(a, extra)
Definition: elf_clib.h:57
u16 cached_next_index
Next frame index that vector arguments were last enqueued to last time this node ran.
Definition: node.h:515
u64 perf_counter1_ticks
Definition: node.h:237
struct vlib_node_runtime_t vlib_node_runtime_t
vlib_frame_t * frame
Definition: node.h:406
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
u16 flags
Definition: node.h:388
uword * next_slot_by_node
Definition: node.h:349
uword * prev_node_bitmap
Definition: node.h:352
#define foreach_vlib_node_state
Definition: node.h:241
static u32 vlib_error_get_node(vlib_node_main_t *nm, vlib_error_t e)
Definition: node.h:773
struct _vlib_node_registration vlib_node_registration_t
vlib_process_event_type_t * event_type_pool
Definition: node.h:598
u32 * data_from_advancing_timing_wheel
Definition: node.h:733
u32 perf_counter1_ticks_since_last_overflow
Perf counter 1 ticks.
Definition: node.h:490
vlib_pending_frame_t * suspended_process_frames
Definition: node.h:746
u64 uword
Definition: types.h:112
u8 vector_size
Definition: node.h:394
vlib_next_frame_t * next_frames
Definition: node.h:722
static u32 vlib_timing_wheel_data_set_timed_event(u32 i)
Definition: node.h:685
u32 stop_timer_handle
Definition: node.h:607
uword * event_type_index_by_type_opaque
Definition: node.h:595
vlib_frame_size_t * frame_sizes
Definition: node.h:758
u64 resume_clock_interval
Definition: node.h:604
u16 flags
Definition: node.h:567
vlib_node_type_t type
Definition: node.h:277
u32 name_elog_string
Definition: node.h:267
vlib_node_state_t
Definition: node.h:250
u16 n_errors
Definition: node.h:318
u32 suspended_process_frame_index
Definition: node.h:579
vl_api_dhcp_client_state_t state
Definition: dhcp.api:201
vlib_main_t vlib_node_runtime_t vlib_frame_t * frame
Definition: in2out_ed.c:1811
clib_longjmp_t return_longjmp
Definition: node.h:557
u16 flags
Copy of main node flags.
Definition: node.h:509
u32 node_runtime_index
Definition: node.h:409
u8 scalar_size
Definition: node.h:391
void() vlib_cli_output_function_t(uword arg, u8 *buffer, uword buffer_bytes)
Definition: cli.h:133
vlib_cli_output_function_t * output_function
Definition: node.h:611
clib_longjmp_t resume_longjmp
Definition: node.h:563
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
static u32 vlib_timing_wheel_data_set_suspended_process(u32 i)
Definition: node.h:679
void * timing_wheel
Definition: node.h:728
u8 runtime_data_bytes
Definition: node.h:312
#define FRAME_QUEUE_MAX_NELTS
Definition: node.h:787
f64 time_next_process_ready
Definition: node.h:736
struct vlib_node_t vlib_node_t
u32 vectors_since_last_overflow
Definition: node.h:438
u32 max_clock_n
Number of vectors in the recorded max_clock.
Definition: node.h:481
uword * non_empty_event_type_bitmap
Definition: node.h:588