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 __clib_unused vlib_node_registration_t __clib_unused_##x
193 #ifndef CLIB_MARCH_VARIANT
194 #define CLIB_MARCH_VARIANT_STR "default"
196 #define _CLIB_MARCH_VARIANT_STR(s) __CLIB_MARCH_VARIANT_STR(s)
197 #define __CLIB_MARCH_VARIANT_STR(s) #s
198 #define CLIB_MARCH_VARIANT_STR _CLIB_MARCH_VARIANT_STR(CLIB_MARCH_VARIANT)
201 #define VLIB_NODE_FN(node) \
202 uword CLIB_MARCH_SFX (node##_fn)(); \
203 static vlib_node_fn_registration_t \
204 CLIB_MARCH_SFX(node##_fn_registration) = \
205 { .function = &CLIB_MARCH_SFX (node##_fn), }; \
207 static void __clib_constructor \
208 CLIB_MARCH_SFX (node##_multiarch_register) (void) \
210 extern vlib_node_registration_t node; \
211 vlib_node_fn_registration_t *r; \
212 r = & CLIB_MARCH_SFX (node##_fn_registration); \
213 r->priority = CLIB_MARCH_FN_PRIORITY(); \
214 r->name = CLIB_MARCH_VARIANT_STR; \
215 r->next_registration = node.node_fn_registrations; \
216 node.node_fn_registrations = r; \
218 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (node##_fn)
221 #define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn)
222 #define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn)
223 #define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
225 #define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
227 __attribute__ ((flatten)) \
228 __attribute__ ((target (tgt))) \
230 fn ## _ ## arch ( struct vlib_main_t * vm, \
231 struct vlib_node_runtime_t * node, \
232 struct vlib_frame_t * frame) \
233 { return fn (vm, node, frame); }
235 #define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn) \
236 foreach_march_variant(VLIB_NODE_FUNCTION_CLONE_TEMPLATE, fn)
238 #define VLIB_NODE_FUNCTION_MULTIARCH(node, fn) \
239 VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn) \
240 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
241 static void __attribute__((__constructor__)) \
242 __vlib_node_function_multiarch_select_##node (void) \
243 { node.function = fn ## _multiarch_select(); }
246 always_inline vlib_node_registration_t *
247 vlib_node_next_registered (vlib_node_registration_t * c)
250 clib_elf_section_data_next (c,
251 c->n_next_nodes * sizeof (c->next_nodes[0]));
257 /* Total calls, clock ticks and vector elements processed for this node. */
258 u64 calls, vectors, clocks, suspends;
261 u64 perf_counter_ticks;
262 u64 perf_counter_vectors;
265 #define foreach_vlib_node_state \
266 /* Input node is called each iteration of main loop. \
267 This is the default (zero). */ \
269 /* Input node is called when device signals an interrupt. */ \
271 /* Input node is never called. */ \
276 #define _(f) VLIB_NODE_STATE_##f,
277 foreach_vlib_node_state
282 typedef struct vlib_node_t
284 /* Vector processing function for this node. */
285 vlib_node_function_t *function;
290 /* Node name index in elog string table. */
291 u32 name_elog_string;
293 /* Total statistics for this node. */
294 vlib_node_stats_t stats_total;
296 /* Saved values as of last clear (or zero if never cleared).
297 Current values are always stats_total - stats_last_clear. */
298 vlib_node_stats_t stats_last_clear;
300 /* Type of this node. */
301 vlib_node_type_t type;
306 /* Index of corresponding node runtime. */
309 /* Runtime data for this node. */
315 /* Processing function keeps frame. Tells node dispatching code not
316 to free frame after dispatch is done. */
317 #define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
319 /* Node counts as output/drop/punt node for stats purposes. */
320 #define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
321 #define VLIB_NODE_FLAG_IS_DROP (1 << 2)
322 #define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
323 #define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
325 /* Set if current node runtime has traced vectors. */
326 #define VLIB_NODE_FLAG_TRACE (1 << 5)
328 #define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
329 #define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
331 /* State for input nodes. */
334 /* Number of bytes of run time data. */
335 u8 runtime_data_bytes;
337 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
340 /* Number of error codes used by this node. */
343 /* Size of scalar and vector arguments in bytes. */
344 u16 scalar_size, vector_size;
346 /* Handle/index in error heap for this node. */
347 u32 error_heap_handle;
348 u32 error_heap_index;
350 /* Error strings indexed by error code for this node. */
351 char **error_strings;
353 /* Vector of next node names.
354 Only used before next_nodes array is initialized. */
355 char **next_node_names;
357 /* Next node indices for this node. */
360 /* Name of node that we are sibling of. */
363 /* Bitmap of all of this node's siblings. */
364 uword *sibling_bitmap;
366 /* Total number of vectors sent to each next node. */
367 u64 *n_vectors_by_next_node;
369 /* Hash table mapping next node index into slot in
370 next_nodes vector. Quickly determines whether this node
371 is connected to given next node and, if so, with which slot. */
372 uword *next_slot_by_node;
374 /* Bitmap of node indices which feed this node. */
375 uword *prev_node_bitmap;
377 /* Node/next-index which own enqueue rights with to this node. */
378 u32 owner_node_index, owner_next_index;
380 /* Buffer format/unformat for this node. */
381 format_function_t *format_buffer;
382 unformat_function_t *unformat_buffer;
384 /* Trace buffer format/unformat for this node. */
385 format_function_t *format_trace;
387 /* Function to validate incoming frames. */
388 u8 *(*validate_frame) (struct vlib_main_t * vm,
389 struct vlib_node_runtime_t *,
390 struct vlib_frame_t * f);
391 /* for pretty-printing, not typically valid */
394 /* Node function candidate registration with priority */
395 vlib_node_fn_registration_t *node_fn_registrations;
398 #define VLIB_INVALID_NODE_INDEX ((u32) ~0)
400 /* Max number of vector elements to process at once per node. */
401 #define VLIB_FRAME_SIZE 256
402 #define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
404 /* Calling frame (think stack frame) for a node. */
405 typedef struct vlib_frame_t
410 /* User flags. Used for sending hints to the next node. */
413 /* Number of scalar bytes in arguments. */
416 /* Number of bytes per vector argument. */
419 /* Number of vector elements currently in frame. */
422 /* Scalar and vector arguments to next node. */
431 /* Node runtime for this next. */
432 u32 node_runtime_index;
434 /* Next frame flags. */
437 /* Reflects node frame-used flag for this next. */
438 #define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
439 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
441 /* This next frame owns enqueue to node
442 corresponding to node_runtime_index. */
443 #define VLIB_FRAME_OWNER (1 << 15)
445 /* Set when frame has been allocated for this next. */
446 #define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
448 /* Set when frame has been added to pending vector. */
449 #define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
451 /* Set when frame is to be freed after dispatch. */
452 #define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
454 /* Set when frame has traced packets. */
455 #define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
457 /* Number of vectors enqueue to this next since last overflow. */
458 u32 vectors_since_last_overflow;
462 vlib_next_frame_init (vlib_next_frame_t * nf)
464 clib_memset (nf, 0, sizeof (nf[0]));
465 nf->frame_index = ~0;
466 nf->node_runtime_index = ~0;
469 /* A frame pending dispatch by main loop. */
472 /* Node and runtime for this frame. */
473 u32 node_runtime_index;
475 /* Frame index (in the heap). */
478 /* Start of next frames for this node. */
479 u32 next_frame_index;
481 /* Special value for next_frame_index when there is no next frame. */
482 #define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
483 } vlib_pending_frame_t;
485 typedef struct vlib_node_runtime_t
487 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
489 vlib_node_function_t *function; /**< Node function to call. */
491 vlib_error_t *errors; /**< Vector of errors for this node. */
493 #if __SIZEOF_POINTER__ == 4
497 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
499 u32 max_clock; /**< Maximum clock cycle for an
502 u32 max_clock_n; /**< Number of vectors in the recorded
505 u32 calls_since_last_overflow; /**< Number of calls. */
507 u32 vectors_since_last_overflow; /**< Number of vector elements
508 processed by this node. */
510 u32 perf_counter_ticks_since_last_overflow; /**< Perf counter ticks */
511 u32 perf_counter_vectors_since_last_overflow; /**< Perf counter vectors */
513 u32 next_frame_index; /**< Start of next frames for this
516 u32 node_index; /**< Node index. */
518 u32 input_main_loops_per_call; /**< For input nodes: decremented
519 on each main loop interation until
520 it reaches zero and function is
521 called. Allows some input nodes to
522 be called more than others. */
524 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
525 dispatch of this node. */
527 u32 main_loop_vector_stats[2];
529 u16 flags; /**< Copy of main node flags. */
531 u16 state; /**< Input node state. */
535 u16 cached_next_index; /**< Next frame index that vector
536 arguments were last enqueued to
537 last time this node ran. Set to
538 zero before first run of this
541 u16 thread_index; /**< thread this node runs on */
543 u8 runtime_data[0]; /**< Function dependent
544 node-runtime data. This data is
545 thread local, and it is not
546 cloned from main thread. It needs
547 to be initialized for each thread
548 before it is used unless
549 runtime_data template exists in
554 #define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
558 /* Number of allocated frames for this scalar/vector size. */
561 /* Vector of free frame indices for this scalar/vector size. */
562 u32 *free_frame_indices;
567 /* Users opaque value for event type. */
569 } vlib_process_event_type_t;
573 /* Node runtime for this process. */
574 vlib_node_runtime_t node_runtime;
576 /* Where to longjmp when process is done. */
577 clib_longjmp_t return_longjmp;
579 #define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
580 #define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
582 /* Where to longjmp to resume node after suspend. */
583 clib_longjmp_t resume_longjmp;
584 #define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
585 #define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
588 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
589 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
590 /* Set to indicate that this process has been added to resume vector. */
591 #define VLIB_PROCESS_RESUME_PENDING (1 << 2)
593 /* Process function is currently running. */
594 #define VLIB_PROCESS_IS_RUNNING (1 << 3)
596 /* Size of process stack. */
597 u16 log2_n_stack_bytes;
599 u32 suspended_process_frame_index;
601 /* Number of times this process was suspended. */
604 /* Vectors of pending event data indexed by event type index. */
605 void **pending_event_data_by_type_index;
607 /* Bitmap of event type-indices with non-empty vectors. */
608 uword *non_empty_event_type_bitmap;
610 /* Bitmap of event type-indices which are one time events. */
611 uword *one_time_event_type_bitmap;
613 /* Type is opaque pointer -- typically a pointer to an event handler
614 function. Hash table to map opaque to a type index. */
615 uword *event_type_index_by_type_opaque;
617 /* Pool of currently valid event types. */
618 vlib_process_event_type_t *event_type_pool;
621 * When suspending saves clock time (10us ticks) when process
624 u64 resume_clock_interval;
626 /* Handle from timer code, to cancel an unexpired timer */
627 u32 stop_timer_handle;
629 /* Default output function and its argument for any CLI outputs
630 within the process. */
631 vlib_cli_output_function_t *output_function;
632 uword output_function_arg;
635 /* Pad to a multiple of the page size so we can mprotect process stacks */
636 #define PAGE_SIZE_MULTIPLE 0x1000
637 #define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT __attribute__ ((aligned (PAGE_SIZE_MULTIPLE)))
639 #define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT
642 /* Process stack. Starts here and extends 2^log2_n_stack_bytes
645 #define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
646 u32 stack[0] ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT;
647 } vlib_process_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
650 /* Ensure that the stack is aligned on the multiple of the page size */
652 assert_process_stack_must_be_aligned_exactly_to_page_size_multiple[(sizeof
666 } vlib_one_time_waiting_process_t;
672 u16 n_data_elt_bytes;
674 /* n_data_elts * n_data_elt_bytes */
677 /* Process node & event type to be used to signal event. */
678 u32 process_node_index;
680 u32 event_type_index;
684 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
686 /* Vector of event data used only when data does not fit inline. */
687 u8 *event_data_as_vector;
690 vlib_signal_timed_event_data_t;
693 vlib_timing_wheel_data_is_timed_event (u32 d)
699 vlib_timing_wheel_data_set_suspended_process (u32 i)
705 vlib_timing_wheel_data_set_timed_event (u32 i)
711 vlib_timing_wheel_data_get_index (u32 d)
721 /* Node index hashed by node name. */
725 #define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
727 /* Nodes segregated by type for cache locality.
728 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
729 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
731 /* Node runtime indices for input nodes with pending interrupts. */
732 u32 *pending_interrupt_node_runtime_indices;
733 clib_spinlock_t pending_interrupt_lock;
735 /* Input nodes are switched from/to interrupt to/from polling mode
736 when average vector length goes above/below polling/interrupt
738 u32 polling_threshold_vector_length;
739 u32 interrupt_threshold_vector_length;
741 /* Vector of next frames. */
742 vlib_next_frame_t *next_frames;
744 /* Vector of internal node's frames waiting to be called. */
745 vlib_pending_frame_t *pending_frames;
747 /* Timing wheel for scheduling time-based node dispatch. */
750 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
752 /* Opaque data vector added via timing_wheel_advance. */
753 u32 *data_from_advancing_timing_wheel;
755 /* CPU time of next process to be ready on timing wheel. */
756 f64 time_next_process_ready;
758 /* Vector of process nodes.
759 One for each node of type VLIB_NODE_TYPE_PROCESS. */
760 vlib_process_t **processes;
762 /* Current running process or ~0 if no process running. */
763 u32 current_process_index;
765 /* Pool of pending process frames. */
766 vlib_pending_frame_t *suspended_process_frames;
768 /* Vector of event data vectors pending recycle. */
769 void **recycled_event_data_vectors;
771 /* Current counts of nodes in each state. */
772 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
774 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
775 uword *frame_size_hash;
777 /* Per-size frame allocation information. */
778 vlib_frame_size_t *frame_sizes;
780 /* Time of last node runtime stats clear. */
781 f64 time_last_runtime_stats_clear;
783 /* Node registrations added by constructors */
784 vlib_node_registration_t *node_registrations;
788 #define FRAME_QUEUE_MAX_NELTS 32
791 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
799 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
800 } frame_queue_trace_t;
804 u64 count[FRAME_QUEUE_MAX_NELTS];
805 } frame_queue_nelt_counter_t;
807 #endif /* included_vlib_node_h */
810 * fd.io coding-style-patch-verification: ON
813 * eval: (c-set-style "gnu")