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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * node.h: VLIB processing nodes
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_vlib_node_h
41 #define included_vlib_node_h
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 */
48 /* Forward declaration. */
49 struct vlib_node_runtime_t;
52 /* Internal nodes (including output nodes) move data from node to
53 node (or out of the graph for output nodes). */
54 typedef uword (vlib_node_function_t) (struct vlib_main_t * vm,
55 struct vlib_node_runtime_t * node,
56 struct vlib_frame_t * frame);
60 VLIB_NODE_PROTO_HINT_NONE = 0,
61 VLIB_NODE_PROTO_HINT_ETHERNET,
62 VLIB_NODE_PROTO_HINT_IP4,
63 VLIB_NODE_PROTO_HINT_IP6,
64 VLIB_NODE_PROTO_HINT_TCP,
65 VLIB_NODE_PROTO_HINT_UDP,
66 VLIB_NODE_N_PROTO_HINTS,
67 } vlib_node_proto_hint_t;
71 /* An internal node on the call graph (could be output). */
72 VLIB_NODE_TYPE_INTERNAL,
74 /* Nodes which input data into the processing graph.
75 Input nodes are called for each iteration of main loop. */
78 /* Nodes to be called before all input nodes.
79 Used, for example, to clean out driver TX rings before
81 VLIB_NODE_TYPE_PRE_INPUT,
83 /* "Process" nodes which can be suspended and later resumed. */
84 VLIB_NODE_TYPE_PROCESS,
89 typedef struct _vlib_node_fn_registration
91 vlib_node_function_t *function;
92 clib_march_variant_type_t march_variant;
93 struct _vlib_node_fn_registration *next_registration;
94 } vlib_node_fn_registration_t;
96 typedef struct _vlib_node_registration
98 /* Vector processing function for this node. */
99 vlib_node_function_t *function;
101 /* Node function candidate registration with priority */
102 vlib_node_fn_registration_t *node_fn_registrations;
107 /* Name of sibling (if applicable). */
110 /* Node index filled in by registration. */
113 /* Type of this node. */
114 vlib_node_type_t type;
116 /* Error strings indexed by error code for this node. */
117 char **error_strings;
118 vlib_error_desc_t *error_counters;
120 /* Buffer format/unformat for this node. */
121 format_function_t *format_buffer;
122 unformat_function_t *unformat_buffer;
124 /* Trace format/unformat for this node. */
125 format_function_t *format_trace;
126 unformat_function_t *unformat_trace;
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);
133 /* Per-node runtime data. */
136 /* Process stack size. */
137 u16 process_log2_n_stack_bytes;
139 /* Number of bytes of per-node run time data. */
140 u8 runtime_data_bytes;
142 /* State for input nodes. */
148 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
151 /* Size of scalar and vector arguments in bytes. */
152 u8 vector_size, aux_size;
155 /* Number of error codes used by this node. */
158 /* Number of next node names that follow. */
161 /* Constructor link-list, don't ask... */
162 struct _vlib_node_registration *next_registration;
164 /* Names of next nodes which this node feeds into. */
167 } vlib_node_registration_t;
169 #ifndef CLIB_MARCH_VARIANT
170 #define VLIB_REGISTER_NODE(x, ...) \
171 __VA_ARGS__ vlib_node_registration_t x; \
172 static void __vlib_add_node_registration_##x (void) \
173 __attribute__ ((__constructor__)); \
174 static void __vlib_add_node_registration_##x (void) \
176 vlib_global_main_t *vgm = vlib_get_global_main (); \
177 x.next_registration = vgm->node_registrations; \
178 vgm->node_registrations = &x; \
180 static void __vlib_rm_node_registration_##x (void) \
181 __attribute__ ((__destructor__)); \
182 static void __vlib_rm_node_registration_##x (void) \
184 vlib_global_main_t *vgm = vlib_get_global_main (); \
185 VLIB_REMOVE_FROM_LINKED_LIST (vgm->node_registrations, &x, \
186 next_registration); \
188 __VA_ARGS__ vlib_node_registration_t x
190 #define VLIB_REGISTER_NODE(x,...) \
191 STATIC_ASSERT (sizeof(# __VA_ARGS__) != 7,"node " #x " must not be declared as static"); \
192 static __clib_unused vlib_node_registration_t __clib_unused_##x
195 #ifndef CLIB_MARCH_VARIANT
196 #define CLIB_MARCH_VARIANT_STR "default"
198 #define _CLIB_MARCH_VARIANT_STR(s) __CLIB_MARCH_VARIANT_STR(s)
199 #define __CLIB_MARCH_VARIANT_STR(s) #s
200 #define CLIB_MARCH_VARIANT_STR _CLIB_MARCH_VARIANT_STR(CLIB_MARCH_VARIANT)
203 #define VLIB_NODE_FN(node) \
204 uword CLIB_MARCH_SFX (node##_fn) (); \
205 static vlib_node_fn_registration_t CLIB_MARCH_SFX ( \
206 node##_fn_registration) = { \
207 .function = &CLIB_MARCH_SFX (node##_fn), \
210 static void __clib_constructor CLIB_MARCH_SFX (node##_multiarch_register) ( \
213 extern vlib_node_registration_t node; \
214 vlib_node_fn_registration_t *r; \
215 r = &CLIB_MARCH_SFX (node##_fn_registration); \
216 r->march_variant = CLIB_MARCH_SFX (CLIB_MARCH_VARIANT_TYPE); \
217 r->next_registration = node.node_fn_registrations; \
218 node.node_fn_registrations = r; \
220 uword CLIB_MARCH_SFX (node##_fn)
222 unformat_function_t unformat_vlib_node_variant;
226 /* Total calls, clock ticks and vector elements processed for this node. */
227 u64 calls, vectors, clocks, suspends;
232 #define foreach_vlib_node_state \
233 /* Input node is called each iteration of main loop. \
234 This is the default (zero). */ \
236 /* Input node is called when device signals an interrupt. */ \
238 /* Input node is never called. */ \
243 #define _(f) VLIB_NODE_STATE_##f,
244 foreach_vlib_node_state
249 typedef struct vlib_node_t
251 /* Vector processing function for this node. */
252 vlib_node_function_t *function;
257 /* Node name index in elog string table. */
258 u32 name_elog_string;
260 /* Total statistics for this node. */
261 vlib_node_stats_t stats_total;
263 /* Saved values as of last clear (or zero if never cleared).
264 Current values are always stats_total - stats_last_clear. */
265 vlib_node_stats_t stats_last_clear;
267 /* Type of this node. */
268 vlib_node_type_t type;
273 /* Index of corresponding node runtime. */
276 /* Runtime data for this node. */
282 /* Processing function keeps frame. Tells node dispatching code not
283 to free frame after dispatch is done. */
284 #define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
286 /* Node counts as output/drop/punt node for stats purposes. */
287 #define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
288 #define VLIB_NODE_FLAG_IS_DROP (1 << 2)
289 #define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
290 #define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
292 /* Set if current node runtime has traced vectors. */
293 #define VLIB_NODE_FLAG_TRACE (1 << 5)
295 #define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
296 #define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
297 #define VLIB_NODE_FLAG_TRACE_SUPPORTED (1 << 8)
298 #define VLIB_NODE_FLAG_ADAPTIVE_MODE (1 << 9)
300 /* State for input nodes. */
303 /* Number of bytes of run time data. */
304 u8 runtime_data_bytes;
306 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
309 /* Number of error codes used by this node. */
312 /* Size of scalar and vector arguments in bytes. */
313 u16 frame_size, scalar_offset, vector_offset, magic_offset, aux_offset;
314 u16 frame_size_index;
316 /* Handle/index in error heap for this node. */
317 u32 error_heap_handle;
318 u32 error_heap_index;
320 /* Counter structures indexed by counter code for this node. */
321 vlib_error_desc_t *error_counters;
323 /* Vector of next node names.
324 Only used before next_nodes array is initialized. */
325 char **next_node_names;
327 /* Next node indices for this node. */
330 /* Name of node that we are sibling of. */
333 /* Bitmap of all of this node's siblings. */
334 uword *sibling_bitmap;
336 /* Total number of vectors sent to each next node. */
337 u64 *n_vectors_by_next_node;
339 /* Hash table mapping next node index into slot in
340 next_nodes vector. Quickly determines whether this node
341 is connected to given next node and, if so, with which slot. */
342 uword *next_slot_by_node;
344 /* Bitmap of node indices which feed this node. */
345 uword *prev_node_bitmap;
347 /* Node/next-index which own enqueue rights with to this node. */
348 u32 owner_node_index, owner_next_index;
350 /* Buffer format/unformat for this node. */
351 format_function_t *format_buffer;
352 unformat_function_t *unformat_buffer;
354 /* Trace buffer format/unformat for this node. */
355 format_function_t *format_trace;
357 /* Function to validate incoming frames. */
358 u8 *(*validate_frame) (struct vlib_main_t * vm,
359 struct vlib_node_runtime_t *,
360 struct vlib_frame_t * f);
361 /* for pretty-printing, not typically valid */
364 /* Node function candidate registration with priority */
365 vlib_node_fn_registration_t *node_fn_registrations;
368 #define VLIB_INVALID_NODE_INDEX ((u32) ~0)
370 /* Max number of vector elements to process at once per node. */
371 #define VLIB_FRAME_SIZE 256
372 /* Number of extra elements allocated at the end of vecttor. */
373 #define VLIB_FRAME_SIZE_EXTRA 4
374 /* Frame data alignment */
375 #define VLIB_FRAME_DATA_ALIGN 16
377 /* Calling frame (think stack frame) for a node. */
378 typedef struct vlib_frame_t
383 /* User flags. Used for sending hints to the next node. */
386 /* Scalar, vector and aux offsets in this frame. */
387 u16 scalar_offset, vector_offset, aux_offset;
389 /* Number of vector elements currently in frame. */
392 /* Index of frame size corresponding to allocated node. */
393 u16 frame_size_index;
395 /* Scalar and vector arguments to next node. */
404 /* Node runtime for this next. */
405 u32 node_runtime_index;
407 /* Next frame flags. */
410 /* Reflects node frame-used flag for this next. */
411 #define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
412 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
414 /* Don't append this frame */
415 #define VLIB_FRAME_NO_APPEND (1 << 14)
417 /* This next frame owns enqueue to node
418 corresponding to node_runtime_index. */
419 #define VLIB_FRAME_OWNER (1 << 15)
421 /* Set when frame has been allocated for this next. */
422 #define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
424 /* Set when frame has been added to pending vector. */
425 #define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
427 /* Set when frame is to be freed after dispatch. */
428 #define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
430 /* Set when frame has traced packets. */
431 #define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
433 /* Number of vectors enqueue to this next since last overflow. */
434 u32 vectors_since_last_overflow;
438 vlib_next_frame_init (vlib_next_frame_t * nf)
440 clib_memset (nf, 0, sizeof (nf[0]));
441 nf->node_runtime_index = ~0;
444 /* A frame pending dispatch by main loop. */
447 /* Frame index (in the heap). */
450 /* Node and runtime for this frame. */
451 u32 node_runtime_index;
453 /* Start of next frames for this node. */
454 u32 next_frame_index;
456 /* Special value for next_frame_index when there is no next frame. */
457 #define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
458 } vlib_pending_frame_t;
460 typedef struct vlib_node_runtime_t
462 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
464 vlib_node_function_t *function; /**< Node function to call. */
466 vlib_error_t *errors; /**< Vector of errors for this node. */
468 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
470 u32 max_clock; /**< Maximum clock cycle for an
473 u32 max_clock_n; /**< Number of vectors in the recorded
476 u32 calls_since_last_overflow; /**< Number of calls. */
478 u32 vectors_since_last_overflow; /**< Number of vector elements
479 processed by this node. */
481 u32 next_frame_index; /**< Start of next frames for this
484 u32 node_index; /**< Node index. */
486 u32 input_main_loops_per_call; /**< For input nodes: decremented
487 on each main loop interation until
488 it reaches zero and function is
489 called. Allows some input nodes to
490 be called more than others. */
492 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
493 dispatch of this node. */
495 u32 main_loop_vector_stats[2];
497 u16 flags; /**< Copy of main node flags. */
499 u16 state; /**< Input node state. */
503 u16 cached_next_index; /**< Next frame index that vector
504 arguments were last enqueued to
505 last time this node ran. Set to
506 zero before first run of this
509 CLIB_ALIGN_MARK (runtime_data_pad, 8);
511 u8 runtime_data[0]; /**< Function dependent
512 node-runtime data. This data is
513 thread local, and it is not
514 cloned from main thread. It needs
515 to be initialized for each thread
516 before it is used unless
517 runtime_data template exists in
522 #define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
526 /* Number of allocated frames for this scalar/vector size. */
532 /* Vector of free frames for this scalar/vector size. */
533 vlib_frame_t **free_frames;
536 STATIC_ASSERT_SIZEOF (vlib_frame_size_t, 16);
540 /* Users opaque value for event type. */
542 } vlib_process_event_type_t;
546 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
547 /* Node runtime for this process. */
548 vlib_node_runtime_t node_runtime;
550 /* Where to longjmp when process is done. */
551 clib_longjmp_t return_longjmp;
553 #define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
554 #define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
556 /* Where to longjmp to resume node after suspend. */
557 clib_longjmp_t resume_longjmp;
558 #define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
559 #define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
562 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
563 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
564 /* Set to indicate that this process has been added to resume vector. */
565 #define VLIB_PROCESS_RESUME_PENDING (1 << 2)
567 /* Process function is currently running. */
568 #define VLIB_PROCESS_IS_RUNNING (1 << 3)
570 /* Size of process stack. */
571 u16 log2_n_stack_bytes;
573 u32 suspended_process_frame_index;
575 /* Number of times this process was suspended. */
578 /* Vectors of pending event data indexed by event type index. */
579 u8 **pending_event_data_by_type_index;
581 /* Bitmap of event type-indices with non-empty vectors. */
582 uword *non_empty_event_type_bitmap;
584 /* Bitmap of event type-indices which are one time events. */
585 uword *one_time_event_type_bitmap;
587 /* Type is opaque pointer -- typically a pointer to an event handler
588 function. Hash table to map opaque to a type index. */
589 uword *event_type_index_by_type_opaque;
591 /* Pool of currently valid event types. */
592 vlib_process_event_type_t *event_type_pool;
595 * When suspending saves clock time (10us ticks) when process
598 u64 resume_clock_interval;
600 /* Handle from timer code, to cancel an unexpired timer */
601 u32 stop_timer_handle;
603 /* Default output function and its argument for any CLI outputs
604 within the process. */
605 vlib_cli_output_function_t *output_function;
606 uword output_function_arg;
609 #define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
618 } vlib_one_time_waiting_process_t;
624 u16 n_data_elt_bytes;
626 /* n_data_elts * n_data_elt_bytes */
629 /* Process node & event type to be used to signal event. */
630 u32 process_node_index;
632 u32 event_type_index;
636 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
638 /* Vector of event data used only when data does not fit inline. */
639 u8 *event_data_as_vector;
642 vlib_signal_timed_event_data_t;
645 vlib_timing_wheel_data_is_timed_event (u32 d)
651 vlib_timing_wheel_data_set_suspended_process (u32 i)
657 vlib_timing_wheel_data_set_timed_event (u32 i)
663 vlib_timing_wheel_data_get_index (u32 d)
670 clib_march_variant_type_t index;
674 } vlib_node_fn_variant_t;
681 /* Node index hashed by node name. */
685 #define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
687 /* Nodes segregated by type for cache locality.
688 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
689 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
691 /* Node runtime indices for input nodes with pending interrupts. */
693 volatile u32 *pending_interrupts;
695 /* Input nodes are switched from/to interrupt to/from polling mode
696 when average vector length goes above/below polling/interrupt
698 u32 polling_threshold_vector_length;
699 u32 interrupt_threshold_vector_length;
701 /* Vector of next frames. */
702 vlib_next_frame_t *next_frames;
704 /* Vector of internal node's frames waiting to be called. */
705 vlib_pending_frame_t *pending_frames;
707 /* Timing wheel for scheduling time-based node dispatch. */
710 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
712 /* Opaque data vector added via timing_wheel_advance. */
713 u32 *data_from_advancing_timing_wheel;
715 /* CPU time of next process to be ready on timing wheel. */
716 f64 time_next_process_ready;
718 /* Vector of process nodes.
719 One for each node of type VLIB_NODE_TYPE_PROCESS. */
720 vlib_process_t **processes;
722 /* Current running process or ~0 if no process running. */
723 u32 current_process_index;
725 /* Pool of pending process frames. */
726 vlib_pending_frame_t *suspended_process_frames;
728 /* Vector of event data vectors pending recycle. */
729 void **recycled_event_data_vectors;
731 /* Current counts of nodes in each state. */
732 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
734 /* Per-size frame allocation information. */
735 vlib_frame_size_t *frame_sizes;
737 /* Time of last node runtime stats clear. */
738 f64 time_last_runtime_stats_clear;
740 /* Node index from error code */
743 /* Node Function Variants */
744 vlib_node_fn_variant_t *variants;
746 /* Node Function Default Variant Index */
747 u32 node_fn_default_march_variant;
749 /* Node Function march Variant by Suffix Hash */
750 uword *node_fn_march_variant_by_suffix;
753 typedef u16 vlib_error_t;
756 vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
758 return nm->node_by_error[e];
762 vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
764 u32 node_index = nm->node_by_error[e];
765 vlib_node_t *n = nm->nodes[node_index];
766 u32 error_code = e - n->error_heap_index;
770 #define FRAME_QUEUE_MAX_NELTS 64
773 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
780 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
781 } frame_queue_trace_t;
785 u64 count[FRAME_QUEUE_MAX_NELTS];
786 } frame_queue_nelt_counter_t;
788 #endif /* included_vlib_node_h */
791 * fd.io coding-style-patch-verification: ON
794 * eval: (c-set-style "gnu")