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 /* An internal node on the call graph (could be output). */
61 VLIB_NODE_TYPE_INTERNAL,
63 /* Nodes which input data into the processing graph.
64 Input nodes are called for each iteration of main loop. */
67 /* Nodes to be called before all input nodes.
68 Used, for example, to clean out driver TX rings before
70 VLIB_NODE_TYPE_PRE_INPUT,
72 /* "Process" nodes which can be suspended and later resumed. */
73 VLIB_NODE_TYPE_PROCESS,
78 typedef struct _vlib_node_fn_registration
80 vlib_node_function_t *function;
82 struct _vlib_node_fn_registration *next_registration;
83 } vlib_node_fn_registration_t;
85 typedef struct _vlib_node_registration
87 /* Vector processing function for this node. */
88 vlib_node_function_t *function;
90 /* Node function candidate registration with priority */
91 vlib_node_fn_registration_t *node_fn_registrations;
96 /* Name of sibling (if applicable). */
99 /* Node index filled in by registration. */
102 /* Type of this node. */
103 vlib_node_type_t type;
105 /* Error strings indexed by error code for this node. */
106 char **error_strings;
108 /* Buffer format/unformat for this node. */
109 format_function_t *format_buffer;
110 unformat_function_t *unformat_buffer;
112 /* Trace format/unformat for this node. */
113 format_function_t *format_trace;
114 unformat_function_t *unformat_trace;
116 /* Function to validate incoming frames. */
117 u8 *(*validate_frame) (struct vlib_main_t * vm,
118 struct vlib_node_runtime_t *,
119 struct vlib_frame_t * f);
121 /* Per-node runtime data. */
124 /* Process stack size. */
125 u16 process_log2_n_stack_bytes;
127 /* Number of bytes of per-node run time data. */
128 u8 runtime_data_bytes;
130 /* State for input nodes. */
136 /* Size of scalar and vector arguments in bytes. */
137 u16 scalar_size, vector_size;
139 /* Number of error codes used by this node. */
142 /* Number of next node names that follow. */
145 /* Constructor link-list, don't ask... */
146 struct _vlib_node_registration *next_registration;
148 /* Names of next nodes which this node feeds into. */
151 } vlib_node_registration_t;
153 #ifndef CLIB_MARCH_VARIANT
154 #define VLIB_REGISTER_NODE(x,...) \
155 __VA_ARGS__ vlib_node_registration_t x; \
156 static void __vlib_add_node_registration_##x (void) \
157 __attribute__((__constructor__)) ; \
158 static void __vlib_add_node_registration_##x (void) \
160 vlib_main_t * vm = vlib_get_main(); \
161 x.next_registration = vm->node_main.node_registrations; \
162 vm->node_main.node_registrations = &x; \
164 static void __vlib_rm_node_registration_##x (void) \
165 __attribute__((__destructor__)) ; \
166 static void __vlib_rm_node_registration_##x (void) \
168 vlib_main_t * vm = vlib_get_main(); \
169 VLIB_REMOVE_FROM_LINKED_LIST (vm->node_main.node_registrations, \
170 &x, next_registration); \
172 __VA_ARGS__ vlib_node_registration_t x
174 #define VLIB_REGISTER_NODE(x,...) \
175 static __clib_unused vlib_node_registration_t __clib_unused_##x
178 #define VLIB_NODE_FN(node) \
179 uword CLIB_MARCH_SFX (node##_fn)(); \
180 static vlib_node_fn_registration_t \
181 CLIB_MARCH_SFX(node##_fn_registration) = \
182 { .function = &CLIB_MARCH_SFX (node##_fn), }; \
184 static void __clib_constructor \
185 CLIB_MARCH_SFX (node##_multiarch_register) (void) \
187 extern vlib_node_registration_t node; \
188 vlib_node_fn_registration_t *r; \
189 r = & CLIB_MARCH_SFX (node##_fn_registration); \
190 r->priority = CLIB_MARCH_FN_PRIORITY(); \
191 r->next_registration = node.node_fn_registrations; \
192 node.node_fn_registrations = r; \
194 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (node##_fn)
197 #define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn)
198 #define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn)
199 #define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
201 #define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
203 __attribute__ ((flatten)) \
204 __attribute__ ((target (tgt))) \
206 fn ## _ ## arch ( struct vlib_main_t * vm, \
207 struct vlib_node_runtime_t * node, \
208 struct vlib_frame_t * frame) \
209 { return fn (vm, node, frame); }
211 #define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn) \
212 foreach_march_variant(VLIB_NODE_FUNCTION_CLONE_TEMPLATE, fn)
214 #define VLIB_NODE_FUNCTION_MULTIARCH(node, fn) \
215 VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn) \
216 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
217 static void __attribute__((__constructor__)) \
218 __vlib_node_function_multiarch_select_##node (void) \
219 { node.function = fn ## _multiarch_select(); }
222 always_inline vlib_node_registration_t *
223 vlib_node_next_registered (vlib_node_registration_t * c)
226 clib_elf_section_data_next (c,
227 c->n_next_nodes * sizeof (c->next_nodes[0]));
233 /* Total calls, clock ticks and vector elements processed for this node. */
234 u64 calls, vectors, clocks, suspends;
239 #define foreach_vlib_node_state \
240 /* Input node is called each iteration of main loop. \
241 This is the default (zero). */ \
243 /* Input node is called when device signals an interrupt. */ \
245 /* Input node is never called. */ \
250 #define _(f) VLIB_NODE_STATE_##f,
251 foreach_vlib_node_state
256 typedef struct vlib_node_t
258 /* Vector processing function for this node. */
259 vlib_node_function_t *function;
264 /* Node name index in elog string table. */
265 u32 name_elog_string;
267 /* Total statistics for this node. */
268 vlib_node_stats_t stats_total;
270 /* Saved values as of last clear (or zero if never cleared).
271 Current values are always stats_total - stats_last_clear. */
272 vlib_node_stats_t stats_last_clear;
274 /* Type of this node. */
275 vlib_node_type_t type;
280 /* Index of corresponding node runtime. */
283 /* Runtime data for this node. */
289 /* Processing function keeps frame. Tells node dispatching code not
290 to free frame after dispatch is done. */
291 #define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
293 /* Node counts as output/drop/punt node for stats purposes. */
294 #define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
295 #define VLIB_NODE_FLAG_IS_DROP (1 << 2)
296 #define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
297 #define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
299 /* Set if current node runtime has traced vectors. */
300 #define VLIB_NODE_FLAG_TRACE (1 << 5)
302 #define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
303 #define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
305 /* State for input nodes. */
308 /* Number of bytes of run time data. */
309 u8 runtime_data_bytes;
311 /* Number of error codes used by this node. */
314 /* Size of scalar and vector arguments in bytes. */
315 u16 scalar_size, vector_size;
317 /* Handle/index in error heap for this node. */
318 u32 error_heap_handle;
319 u32 error_heap_index;
321 /* Error strings indexed by error code for this node. */
322 char **error_strings;
324 /* Vector of next node names.
325 Only used before next_nodes array is initialized. */
326 char **next_node_names;
328 /* Next node indices for this node. */
331 /* Name of node that we are sibling of. */
334 /* Bitmap of all of this node's siblings. */
335 uword *sibling_bitmap;
337 /* Total number of vectors sent to each next node. */
338 u64 *n_vectors_by_next_node;
340 /* Hash table mapping next node index into slot in
341 next_nodes vector. Quickly determines whether this node
342 is connected to given next node and, if so, with which slot. */
343 uword *next_slot_by_node;
345 /* Bitmap of node indices which feed this node. */
346 uword *prev_node_bitmap;
348 /* Node/next-index which own enqueue rights with to this node. */
349 u32 owner_node_index, owner_next_index;
351 /* Buffer format/unformat for this node. */
352 format_function_t *format_buffer;
353 unformat_function_t *unformat_buffer;
355 /* Trace buffer format/unformat for this node. */
356 format_function_t *format_trace;
358 /* Function to validate incoming frames. */
359 u8 *(*validate_frame) (struct vlib_main_t * vm,
360 struct vlib_node_runtime_t *,
361 struct vlib_frame_t * f);
362 /* for pretty-printing, not typically valid */
366 #define VLIB_INVALID_NODE_INDEX ((u32) ~0)
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
372 /* Calling frame (think stack frame) for a node. */
373 typedef struct vlib_frame_t
378 /* Number of scalar bytes in arguments. */
381 /* Number of bytes per vector argument. */
384 /* Number of vector elements currently in frame. */
387 /* Scalar and vector arguments to next node. */
396 /* Node runtime for this next. */
397 u32 node_runtime_index;
399 /* Next frame flags. */
402 /* Reflects node frame-used flag for this next. */
403 #define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
404 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
406 /* This next frame owns enqueue to node
407 corresponding to node_runtime_index. */
408 #define VLIB_FRAME_OWNER (1 << 15)
410 /* Set when frame has been allocated for this next. */
411 #define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
413 /* Set when frame has been added to pending vector. */
414 #define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
416 /* Set when frame is to be freed after dispatch. */
417 #define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
419 /* Set when frame has traced packets. */
420 #define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
422 /* Number of vectors enqueue to this next since last overflow. */
423 u32 vectors_since_last_overflow;
427 vlib_next_frame_init (vlib_next_frame_t * nf)
429 memset (nf, 0, sizeof (nf[0]));
430 nf->frame_index = ~0;
431 nf->node_runtime_index = ~0;
434 /* A frame pending dispatch by main loop. */
437 /* Node and runtime for this frame. */
438 u32 node_runtime_index;
440 /* Frame index (in the heap). */
443 /* Start of next frames for this node. */
444 u32 next_frame_index;
446 /* Special value for next_frame_index when there is no next frame. */
447 #define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
448 } vlib_pending_frame_t;
450 typedef struct vlib_node_runtime_t
452 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
454 vlib_node_function_t *function; /**< Node function to call. */
456 vlib_error_t *errors; /**< Vector of errors for this node. */
458 #if __SIZEOF_POINTER__ == 4
462 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
464 u32 max_clock; /**< Maximum clock cycle for an
467 u32 max_clock_n; /**< Number of vectors in the recorded
470 u32 calls_since_last_overflow; /**< Number of calls. */
472 u32 vectors_since_last_overflow; /**< Number of vector elements
473 processed by this node. */
475 u32 next_frame_index; /**< Start of next frames for this
478 u32 node_index; /**< Node index. */
480 u32 input_main_loops_per_call; /**< For input nodes: decremented
481 on each main loop interation until
482 it reaches zero and function is
483 called. Allows some input nodes to
484 be called more than others. */
486 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
487 dispatch of this node. */
489 u32 main_loop_vector_stats[2];
491 u16 flags; /**< Copy of main node flags. */
493 u16 state; /**< Input node state. */
497 u16 cached_next_index; /**< Next frame index that vector
498 arguments were last enqueued to
499 last time this node ran. Set to
500 zero before first run of this
503 u16 thread_index; /**< thread this node runs on */
505 u8 runtime_data[0]; /**< Function dependent
506 node-runtime data. This data is
507 thread local, and it is not
508 cloned from main thread. It needs
509 to be initialized for each thread
510 before it is used unless
511 runtime_data template exists in
516 #define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
520 /* Number of allocated frames for this scalar/vector size. */
523 /* Vector of free frame indices for this scalar/vector size. */
524 u32 *free_frame_indices;
529 /* Users opaque value for event type. */
531 } vlib_process_event_type_t;
535 /* Node runtime for this process. */
536 vlib_node_runtime_t node_runtime;
538 /* Where to longjmp when process is done. */
539 clib_longjmp_t return_longjmp;
541 #define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
542 #define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
544 /* Where to longjmp to resume node after suspend. */
545 clib_longjmp_t resume_longjmp;
546 #define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
547 #define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
550 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
551 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
552 /* Set to indicate that this process has been added to resume vector. */
553 #define VLIB_PROCESS_RESUME_PENDING (1 << 2)
555 /* Process function is currently running. */
556 #define VLIB_PROCESS_IS_RUNNING (1 << 3)
558 /* Size of process stack. */
559 u16 log2_n_stack_bytes;
561 u32 suspended_process_frame_index;
563 /* Number of times this process was suspended. */
566 /* Vectors of pending event data indexed by event type index. */
567 void **pending_event_data_by_type_index;
569 /* Bitmap of event type-indices with non-empty vectors. */
570 uword *non_empty_event_type_bitmap;
572 /* Bitmap of event type-indices which are one time events. */
573 uword *one_time_event_type_bitmap;
575 /* Type is opaque pointer -- typically a pointer to an event handler
576 function. Hash table to map opaque to a type index. */
577 uword *event_type_index_by_type_opaque;
579 /* Pool of currently valid event types. */
580 vlib_process_event_type_t *event_type_pool;
583 * When suspending saves clock time (10us ticks) when process
586 u64 resume_clock_interval;
588 /* Handle from timer code, to cancel an unexpired timer */
589 u32 stop_timer_handle;
591 /* Default output function and its argument for any CLI outputs
592 within the process. */
593 vlib_cli_output_function_t *output_function;
594 uword output_function_arg;
597 /* Pad to a multiple of the page size so we can mprotect process stacks */
598 #define PAGE_SIZE_MULTIPLE 0x1000
599 #define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT __attribute__ ((aligned (PAGE_SIZE_MULTIPLE)))
601 #define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT
604 /* Process stack. Starts here and extends 2^log2_n_stack_bytes
607 #define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
608 u32 stack[0] ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT;
609 } vlib_process_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
612 /* Ensure that the stack is aligned on the multiple of the page size */
614 assert_process_stack_must_be_aligned_exactly_to_page_size_multiple[(sizeof
628 } vlib_one_time_waiting_process_t;
634 u16 n_data_elt_bytes;
636 /* n_data_elts * n_data_elt_bytes */
639 /* Process node & event type to be used to signal event. */
640 u32 process_node_index;
642 u32 event_type_index;
646 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
648 /* Vector of event data used only when data does not fit inline. */
649 u8 *event_data_as_vector;
652 vlib_signal_timed_event_data_t;
655 vlib_timing_wheel_data_is_timed_event (u32 d)
661 vlib_timing_wheel_data_set_suspended_process (u32 i)
667 vlib_timing_wheel_data_set_timed_event (u32 i)
673 vlib_timing_wheel_data_get_index (u32 d)
683 /* Node index hashed by node name. */
687 #define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
689 /* Nodes segregated by type for cache locality.
690 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
691 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
693 /* Node runtime indices for input nodes with pending interrupts. */
694 u32 *pending_interrupt_node_runtime_indices;
695 clib_spinlock_t pending_interrupt_lock;
697 /* Input nodes are switched from/to interrupt to/from polling mode
698 when average vector length goes above/below polling/interrupt
700 u32 polling_threshold_vector_length;
701 u32 interrupt_threshold_vector_length;
703 /* Vector of next frames. */
704 vlib_next_frame_t *next_frames;
706 /* Vector of internal node's frames waiting to be called. */
707 vlib_pending_frame_t *pending_frames;
709 /* Timing wheel for scheduling time-based node dispatch. */
712 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
714 /* Opaque data vector added via timing_wheel_advance. */
715 u32 *data_from_advancing_timing_wheel;
717 /* CPU time of next process to be ready on timing wheel. */
718 f64 time_next_process_ready;
720 /* Vector of process nodes.
721 One for each node of type VLIB_NODE_TYPE_PROCESS. */
722 vlib_process_t **processes;
724 /* Current running process or ~0 if no process running. */
725 u32 current_process_index;
727 /* Pool of pending process frames. */
728 vlib_pending_frame_t *suspended_process_frames;
730 /* Vector of event data vectors pending recycle. */
731 void **recycled_event_data_vectors;
733 /* Current counts of nodes in each state. */
734 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
736 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
737 uword *frame_size_hash;
739 /* Per-size frame allocation information. */
740 vlib_frame_size_t *frame_sizes;
742 /* Time of last node runtime stats clear. */
743 f64 time_last_runtime_stats_clear;
745 /* Node registrations added by constructors */
746 vlib_node_registration_t *node_registrations;
750 #define FRAME_QUEUE_MAX_NELTS 32
753 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
761 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
762 } frame_queue_trace_t;
766 u64 count[FRAME_QUEUE_MAX_NELTS];
767 } frame_queue_nelt_counter_t;
769 #endif /* included_vlib_node_h */
772 * fd.io coding-style-patch-verification: ON
775 * eval: (c-set-style "gnu")