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;
93 struct _vlib_node_fn_registration *next_registration;
95 } vlib_node_fn_registration_t;
97 typedef struct _vlib_node_registration
99 /* Vector processing function for this node. */
100 vlib_node_function_t *function;
102 /* Node function candidate registration with priority */
103 vlib_node_fn_registration_t *node_fn_registrations;
108 /* Name of sibling (if applicable). */
111 /* Node index filled in by registration. */
114 /* Type of this node. */
115 vlib_node_type_t type;
117 /* Error strings indexed by error code for this node. */
118 char **error_strings;
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 u16 scalar_size, vector_size;
154 /* Number of error codes used by this node. */
157 /* Number of next node names that follow. */
160 /* Constructor link-list, don't ask... */
161 struct _vlib_node_registration *next_registration;
163 /* Names of next nodes which this node feeds into. */
166 } vlib_node_registration_t;
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) \
175 vlib_main_t * vm = vlib_get_main(); \
176 x.next_registration = vm->node_main.node_registrations; \
177 vm->node_main.node_registrations = &x; \
179 static void __vlib_rm_node_registration_##x (void) \
180 __attribute__((__destructor__)) ; \
181 static void __vlib_rm_node_registration_##x (void) \
183 vlib_main_t * vm = vlib_get_main(); \
184 VLIB_REMOVE_FROM_LINKED_LIST (vm->node_main.node_registrations, \
185 &x, next_registration); \
187 __VA_ARGS__ vlib_node_registration_t x
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
194 #ifndef CLIB_MARCH_VARIANT
195 #define CLIB_MARCH_VARIANT_STR "default"
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)
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), }; \
208 static void __clib_constructor \
209 CLIB_MARCH_SFX (node##_multiarch_register) (void) \
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; \
219 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (node##_fn)
221 always_inline vlib_node_registration_t *
222 vlib_node_next_registered (vlib_node_registration_t * c)
225 clib_elf_section_data_next (c,
226 c->n_next_nodes * sizeof (c->next_nodes[0]));
232 /* Total calls, clock ticks and vector elements processed for this node. */
233 u64 calls, vectors, clocks, suspends;
236 u64 perf_counter0_ticks;
237 u64 perf_counter1_ticks;
238 u64 perf_counter_vectors;
241 #define foreach_vlib_node_state \
242 /* Input node is called each iteration of main loop. \
243 This is the default (zero). */ \
245 /* Input node is called when device signals an interrupt. */ \
247 /* Input node is never called. */ \
252 #define _(f) VLIB_NODE_STATE_##f,
253 foreach_vlib_node_state
258 typedef struct vlib_node_t
260 /* Vector processing function for this node. */
261 vlib_node_function_t *function;
266 /* Node name index in elog string table. */
267 u32 name_elog_string;
269 /* Total statistics for this node. */
270 vlib_node_stats_t stats_total;
272 /* Saved values as of last clear (or zero if never cleared).
273 Current values are always stats_total - stats_last_clear. */
274 vlib_node_stats_t stats_last_clear;
276 /* Type of this node. */
277 vlib_node_type_t type;
282 /* Index of corresponding node runtime. */
285 /* Runtime data for this node. */
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)
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)
301 /* Set if current node runtime has traced vectors. */
302 #define VLIB_NODE_FLAG_TRACE (1 << 5)
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)
308 /* State for input nodes. */
311 /* Number of bytes of run time data. */
312 u8 runtime_data_bytes;
314 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
317 /* Number of error codes used by this node. */
320 /* Size of scalar and vector arguments in bytes. */
321 u16 scalar_size, vector_size;
323 /* Handle/index in error heap for this node. */
324 u32 error_heap_handle;
325 u32 error_heap_index;
327 /* Error strings indexed by error code for this node. */
328 char **error_strings;
330 /* Vector of next node names.
331 Only used before next_nodes array is initialized. */
332 char **next_node_names;
334 /* Next node indices for this node. */
337 /* Name of node that we are sibling of. */
340 /* Bitmap of all of this node's siblings. */
341 uword *sibling_bitmap;
343 /* Total number of vectors sent to each next node. */
344 u64 *n_vectors_by_next_node;
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. */
349 uword *next_slot_by_node;
351 /* Bitmap of node indices which feed this node. */
352 uword *prev_node_bitmap;
354 /* Node/next-index which own enqueue rights with to this node. */
355 u32 owner_node_index, owner_next_index;
357 /* Buffer format/unformat for this node. */
358 format_function_t *format_buffer;
359 unformat_function_t *unformat_buffer;
361 /* Trace buffer format/unformat for this node. */
362 format_function_t *format_trace;
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 */
371 /* Node function candidate registration with priority */
372 vlib_node_fn_registration_t *node_fn_registrations;
375 #define VLIB_INVALID_NODE_INDEX ((u32) ~0)
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
381 /* Calling frame (think stack frame) for a node. */
382 typedef struct vlib_frame_t
387 /* User flags. Used for sending hints to the next node. */
390 /* Number of scalar bytes in arguments. */
393 /* Number of bytes per vector argument. */
396 /* Number of vector elements currently in frame. */
399 /* Scalar and vector arguments to next node. */
408 /* Node runtime for this next. */
409 u32 node_runtime_index;
411 /* Next frame flags. */
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
418 /* Don't append this frame */
419 #define VLIB_FRAME_NO_APPEND (1 << 14)
421 /* This next frame owns enqueue to node
422 corresponding to node_runtime_index. */
423 #define VLIB_FRAME_OWNER (1 << 15)
425 /* Set when frame has been allocated for this next. */
426 #define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
428 /* Set when frame has been added to pending vector. */
429 #define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
431 /* Set when frame is to be freed after dispatch. */
432 #define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
434 /* Set when frame has traced packets. */
435 #define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
437 /* Number of vectors enqueue to this next since last overflow. */
438 u32 vectors_since_last_overflow;
442 vlib_next_frame_init (vlib_next_frame_t * nf)
444 clib_memset (nf, 0, sizeof (nf[0]));
445 nf->node_runtime_index = ~0;
448 /* A frame pending dispatch by main loop. */
451 /* Node and runtime for this frame. */
452 u32 node_runtime_index;
454 /* Frame index (in the heap). */
457 /* Start of next frames for this node. */
458 u32 next_frame_index;
460 /* Special value for next_frame_index when there is no next frame. */
461 #define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
462 } vlib_pending_frame_t;
464 typedef struct vlib_node_runtime_t
466 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
468 vlib_node_function_t *function; /**< Node function to call. */
470 vlib_error_t *errors; /**< Vector of errors for this node. */
472 #if __SIZEOF_POINTER__ == 4
476 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
478 u32 max_clock; /**< Maximum clock cycle for an
481 u32 max_clock_n; /**< Number of vectors in the recorded
484 u32 calls_since_last_overflow; /**< Number of calls. */
486 u32 vectors_since_last_overflow; /**< Number of vector elements
487 processed by this node. */
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 */
493 u32 next_frame_index; /**< Start of next frames for this
496 u32 node_index; /**< Node index. */
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. */
504 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
505 dispatch of this node. */
507 u32 main_loop_vector_stats[2];
509 u16 flags; /**< Copy of main node flags. */
511 u16 state; /**< Input node state. */
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
521 u16 thread_index; /**< thread this node runs on */
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
534 #define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
538 /* Number of allocated frames for this scalar/vector size. */
541 /* Vector of free frames for this scalar/vector size. */
542 vlib_frame_t **free_frames;
547 /* Users opaque value for event type. */
549 } vlib_process_event_type_t;
553 /* Node runtime for this process. */
554 vlib_node_runtime_t node_runtime;
556 /* Where to longjmp when process is done. */
557 clib_longjmp_t return_longjmp;
559 #define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
560 #define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
562 /* Where to longjmp to resume node after suspend. */
563 clib_longjmp_t resume_longjmp;
564 #define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
565 #define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
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)
573 /* Process function is currently running. */
574 #define VLIB_PROCESS_IS_RUNNING (1 << 3)
576 /* Size of process stack. */
577 u16 log2_n_stack_bytes;
579 u32 suspended_process_frame_index;
581 /* Number of times this process was suspended. */
584 /* Vectors of pending event data indexed by event type index. */
585 void **pending_event_data_by_type_index;
587 /* Bitmap of event type-indices with non-empty vectors. */
588 uword *non_empty_event_type_bitmap;
590 /* Bitmap of event type-indices which are one time events. */
591 uword *one_time_event_type_bitmap;
593 /* Type is opaque pointer -- typically a pointer to an event handler
594 function. Hash table to map opaque to a type index. */
595 uword *event_type_index_by_type_opaque;
597 /* Pool of currently valid event types. */
598 vlib_process_event_type_t *event_type_pool;
601 * When suspending saves clock time (10us ticks) when process
604 u64 resume_clock_interval;
606 /* Handle from timer code, to cancel an unexpired timer */
607 u32 stop_timer_handle;
609 /* Default output function and its argument for any CLI outputs
610 within the process. */
611 vlib_cli_output_function_t *output_function;
612 uword output_function_arg;
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)))
619 #define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT
622 /* Process stack. Starts here and extends 2^log2_n_stack_bytes
625 #define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
626 u32 stack[0] ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT;
627 } vlib_process_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
630 /* Ensure that the stack is aligned on the multiple of the page size */
632 assert_process_stack_must_be_aligned_exactly_to_page_size_multiple[(sizeof
646 } vlib_one_time_waiting_process_t;
652 u16 n_data_elt_bytes;
654 /* n_data_elts * n_data_elt_bytes */
657 /* Process node & event type to be used to signal event. */
658 u32 process_node_index;
660 u32 event_type_index;
664 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
666 /* Vector of event data used only when data does not fit inline. */
667 u8 *event_data_as_vector;
670 vlib_signal_timed_event_data_t;
673 vlib_timing_wheel_data_is_timed_event (u32 d)
679 vlib_timing_wheel_data_set_suspended_process (u32 i)
685 vlib_timing_wheel_data_set_timed_event (u32 i)
691 vlib_timing_wheel_data_get_index (u32 d)
701 /* Node index hashed by node name. */
705 #define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
707 /* Nodes segregated by type for cache locality.
708 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
709 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
711 /* Node runtime indices for input nodes with pending interrupts. */
712 u32 *pending_interrupt_node_runtime_indices;
713 clib_spinlock_t pending_interrupt_lock;
715 /* Input nodes are switched from/to interrupt to/from polling mode
716 when average vector length goes above/below polling/interrupt
718 u32 polling_threshold_vector_length;
719 u32 interrupt_threshold_vector_length;
721 /* Vector of next frames. */
722 vlib_next_frame_t *next_frames;
724 /* Vector of internal node's frames waiting to be called. */
725 vlib_pending_frame_t *pending_frames;
727 /* Timing wheel for scheduling time-based node dispatch. */
730 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
732 /* Opaque data vector added via timing_wheel_advance. */
733 u32 *data_from_advancing_timing_wheel;
735 /* CPU time of next process to be ready on timing wheel. */
736 f64 time_next_process_ready;
738 /* Vector of process nodes.
739 One for each node of type VLIB_NODE_TYPE_PROCESS. */
740 vlib_process_t **processes;
742 /* Current running process or ~0 if no process running. */
743 u32 current_process_index;
745 /* Pool of pending process frames. */
746 vlib_pending_frame_t *suspended_process_frames;
748 /* Vector of event data vectors pending recycle. */
749 void **recycled_event_data_vectors;
751 /* Current counts of nodes in each state. */
752 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
754 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
755 uword *frame_size_hash;
757 /* Per-size frame allocation information. */
758 vlib_frame_size_t *frame_sizes;
760 /* Time of last node runtime stats clear. */
761 f64 time_last_runtime_stats_clear;
763 /* Node registrations added by constructors */
764 vlib_node_registration_t *node_registrations;
766 /* Node index from error code */
770 typedef u16 vlib_error_t;
773 vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
775 return nm->node_by_error[e];
779 vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
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;
787 #define FRAME_QUEUE_MAX_NELTS 64
790 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
798 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
799 } frame_queue_trace_t;
803 u64 count[FRAME_QUEUE_MAX_NELTS];
804 } frame_queue_nelt_counter_t;
806 #endif /* included_vlib_node_h */
809 * fd.io coding-style-patch-verification: ON
812 * eval: (c-set-style "gnu")