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 #define VLIB_REGISTER_NODE(x,...) \
154 __VA_ARGS__ vlib_node_registration_t x; \
155 static void __vlib_add_node_registration_##x (void) \
156 __attribute__((__constructor__)) ; \
157 static void __vlib_add_node_registration_##x (void) \
159 vlib_main_t * vm = vlib_get_main(); \
160 x.next_registration = vm->node_main.node_registrations; \
161 vm->node_main.node_registrations = &x; \
163 static void __vlib_rm_node_registration_##x (void) \
164 __attribute__((__destructor__)) ; \
165 static void __vlib_rm_node_registration_##x (void) \
167 vlib_main_t * vm = vlib_get_main(); \
168 VLIB_REMOVE_FROM_LINKED_LIST (vm->node_main.node_registrations, \
169 &x, next_registration); \
171 __VA_ARGS__ vlib_node_registration_t x
173 #define VLIB_NODE_FN(node) \
174 uword CLIB_MARCH_SFX (node##_fn)(); \
175 static vlib_node_fn_registration_t \
176 CLIB_MARCH_SFX(node##_fn_registration) = \
177 { .function = &CLIB_MARCH_SFX (node##_fn), }; \
179 static void __clib_constructor \
180 CLIB_MARCH_SFX (node##_multiarch_register) (void) \
182 extern vlib_node_registration_t node; \
183 vlib_node_fn_registration_t *r; \
184 r = & CLIB_MARCH_SFX (node##_fn_registration); \
185 r->priority = CLIB_MARCH_FN_PRIORITY(); \
186 r->next_registration = node.node_fn_registrations; \
187 node.node_fn_registrations = r; \
189 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (node##_fn)
192 #define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn)
193 #define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn)
194 #define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
196 #define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
198 __attribute__ ((flatten)) \
199 __attribute__ ((target (tgt))) \
201 fn ## _ ## arch ( struct vlib_main_t * vm, \
202 struct vlib_node_runtime_t * node, \
203 struct vlib_frame_t * frame) \
204 { return fn (vm, node, frame); }
206 #define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn) \
207 foreach_march_variant(VLIB_NODE_FUNCTION_CLONE_TEMPLATE, fn)
209 #define VLIB_NODE_FUNCTION_MULTIARCH(node, fn) \
210 VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn) \
211 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
212 static void __attribute__((__constructor__)) \
213 __vlib_node_function_multiarch_select_##node (void) \
214 { node.function = fn ## _multiarch_select(); }
217 always_inline vlib_node_registration_t *
218 vlib_node_next_registered (vlib_node_registration_t * c)
221 clib_elf_section_data_next (c,
222 c->n_next_nodes * sizeof (c->next_nodes[0]));
228 /* Total calls, clock ticks and vector elements processed for this node. */
229 u64 calls, vectors, clocks, suspends;
234 #define foreach_vlib_node_state \
235 /* Input node is called each iteration of main loop. \
236 This is the default (zero). */ \
238 /* Input node is called when device signals an interrupt. */ \
240 /* Input node is never called. */ \
245 #define _(f) VLIB_NODE_STATE_##f,
246 foreach_vlib_node_state
251 typedef struct vlib_node_t
253 /* Vector processing function for this node. */
254 vlib_node_function_t *function;
259 /* Node name index in elog string table. */
260 u32 name_elog_string;
262 /* Total statistics for this node. */
263 vlib_node_stats_t stats_total;
265 /* Saved values as of last clear (or zero if never cleared).
266 Current values are always stats_total - stats_last_clear. */
267 vlib_node_stats_t stats_last_clear;
269 /* Type of this node. */
270 vlib_node_type_t type;
275 /* Index of corresponding node runtime. */
278 /* Runtime data for this node. */
284 /* Processing function keeps frame. Tells node dispatching code not
285 to free frame after dispatch is done. */
286 #define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
288 /* Node counts as output/drop/punt node for stats purposes. */
289 #define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
290 #define VLIB_NODE_FLAG_IS_DROP (1 << 2)
291 #define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
292 #define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
294 /* Set if current node runtime has traced vectors. */
295 #define VLIB_NODE_FLAG_TRACE (1 << 5)
297 #define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
298 #define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
300 /* State for input nodes. */
303 /* Number of bytes of run time data. */
304 u8 runtime_data_bytes;
306 /* Number of error codes used by this node. */
309 /* Size of scalar and vector arguments in bytes. */
310 u16 scalar_size, vector_size;
312 /* Handle/index in error heap for this node. */
313 u32 error_heap_handle;
314 u32 error_heap_index;
316 /* Error strings indexed by error code for this node. */
317 char **error_strings;
319 /* Vector of next node names.
320 Only used before next_nodes array is initialized. */
321 char **next_node_names;
323 /* Next node indices for this node. */
326 /* Name of node that we are sibling of. */
329 /* Bitmap of all of this node's siblings. */
330 uword *sibling_bitmap;
332 /* Total number of vectors sent to each next node. */
333 u64 *n_vectors_by_next_node;
335 /* Hash table mapping next node index into slot in
336 next_nodes vector. Quickly determines whether this node
337 is connected to given next node and, if so, with which slot. */
338 uword *next_slot_by_node;
340 /* Bitmap of node indices which feed this node. */
341 uword *prev_node_bitmap;
343 /* Node/next-index which own enqueue rights with to this node. */
344 u32 owner_node_index, owner_next_index;
346 /* Buffer format/unformat for this node. */
347 format_function_t *format_buffer;
348 unformat_function_t *unformat_buffer;
350 /* Trace buffer format/unformat for this node. */
351 format_function_t *format_trace;
353 /* Function to validate incoming frames. */
354 u8 *(*validate_frame) (struct vlib_main_t * vm,
355 struct vlib_node_runtime_t *,
356 struct vlib_frame_t * f);
357 /* for pretty-printing, not typically valid */
361 #define VLIB_INVALID_NODE_INDEX ((u32) ~0)
363 /* Max number of vector elements to process at once per node. */
364 #define VLIB_FRAME_SIZE 256
365 #define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
367 /* Calling frame (think stack frame) for a node. */
368 typedef struct vlib_frame_t
373 /* Number of scalar bytes in arguments. */
376 /* Number of bytes per vector argument. */
379 /* Number of vector elements currently in frame. */
382 /* Scalar and vector arguments to next node. */
391 /* Node runtime for this next. */
392 u32 node_runtime_index;
394 /* Next frame flags. */
397 /* Reflects node frame-used flag for this next. */
398 #define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
399 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
401 /* This next frame owns enqueue to node
402 corresponding to node_runtime_index. */
403 #define VLIB_FRAME_OWNER (1 << 15)
405 /* Set when frame has been allocated for this next. */
406 #define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
408 /* Set when frame has been added to pending vector. */
409 #define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
411 /* Set when frame is to be freed after dispatch. */
412 #define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
414 /* Set when frame has traced packets. */
415 #define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
417 /* Number of vectors enqueue to this next since last overflow. */
418 u32 vectors_since_last_overflow;
422 vlib_next_frame_init (vlib_next_frame_t * nf)
424 memset (nf, 0, sizeof (nf[0]));
425 nf->frame_index = ~0;
426 nf->node_runtime_index = ~0;
429 /* A frame pending dispatch by main loop. */
432 /* Node and runtime for this frame. */
433 u32 node_runtime_index;
435 /* Frame index (in the heap). */
438 /* Start of next frames for this node. */
439 u32 next_frame_index;
441 /* Special value for next_frame_index when there is no next frame. */
442 #define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
443 } vlib_pending_frame_t;
445 typedef struct vlib_node_runtime_t
447 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
449 vlib_node_function_t *function; /**< Node function to call. */
451 vlib_error_t *errors; /**< Vector of errors for this node. */
453 #if __SIZEOF_POINTER__ == 4
457 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
459 u32 max_clock; /**< Maximum clock cycle for an
462 u32 max_clock_n; /**< Number of vectors in the recorded
465 u32 calls_since_last_overflow; /**< Number of calls. */
467 u32 vectors_since_last_overflow; /**< Number of vector elements
468 processed by this node. */
470 u32 next_frame_index; /**< Start of next frames for this
473 u32 node_index; /**< Node index. */
475 u32 input_main_loops_per_call; /**< For input nodes: decremented
476 on each main loop interation until
477 it reaches zero and function is
478 called. Allows some input nodes to
479 be called more than others. */
481 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
482 dispatch of this node. */
484 u32 main_loop_vector_stats[2];
486 u16 flags; /**< Copy of main node flags. */
488 u16 state; /**< Input node state. */
492 u16 cached_next_index; /**< Next frame index that vector
493 arguments were last enqueued to
494 last time this node ran. Set to
495 zero before first run of this
498 u16 thread_index; /**< thread this node runs on */
500 u8 runtime_data[0]; /**< Function dependent
501 node-runtime data. This data is
502 thread local, and it is not
503 cloned from main thread. It needs
504 to be initialized for each thread
505 before it is used unless
506 runtime_data template exists in
511 #define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
515 /* Number of allocated frames for this scalar/vector size. */
518 /* Vector of free frame indices for this scalar/vector size. */
519 u32 *free_frame_indices;
524 /* Users opaque value for event type. */
526 } vlib_process_event_type_t;
530 /* Node runtime for this process. */
531 vlib_node_runtime_t node_runtime;
533 /* Where to longjmp when process is done. */
534 clib_longjmp_t return_longjmp;
536 #define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
537 #define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
539 /* Where to longjmp to resume node after suspend. */
540 clib_longjmp_t resume_longjmp;
541 #define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
542 #define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
545 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
546 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
547 /* Set to indicate that this process has been added to resume vector. */
548 #define VLIB_PROCESS_RESUME_PENDING (1 << 2)
550 /* Process function is currently running. */
551 #define VLIB_PROCESS_IS_RUNNING (1 << 3)
553 /* Size of process stack. */
554 u16 log2_n_stack_bytes;
556 u32 suspended_process_frame_index;
558 /* Number of times this process was suspended. */
561 /* Vectors of pending event data indexed by event type index. */
562 void **pending_event_data_by_type_index;
564 /* Bitmap of event type-indices with non-empty vectors. */
565 uword *non_empty_event_type_bitmap;
567 /* Bitmap of event type-indices which are one time events. */
568 uword *one_time_event_type_bitmap;
570 /* Type is opaque pointer -- typically a pointer to an event handler
571 function. Hash table to map opaque to a type index. */
572 uword *event_type_index_by_type_opaque;
574 /* Pool of currently valid event types. */
575 vlib_process_event_type_t *event_type_pool;
578 * When suspending saves clock time (10us ticks) when process
581 u64 resume_clock_interval;
583 /* Handle from timer code, to cancel an unexpired timer */
584 u32 stop_timer_handle;
586 /* Default output function and its argument for any CLI outputs
587 within the process. */
588 vlib_cli_output_function_t *output_function;
589 uword output_function_arg;
592 /* Pad to a multiple of the page size so we can mprotect process stacks */
593 #define PAGE_SIZE_MULTIPLE 0x1000
594 #define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT __attribute__ ((aligned (PAGE_SIZE_MULTIPLE)))
596 #define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT
599 /* Process stack. Starts here and extends 2^log2_n_stack_bytes
602 #define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
603 u32 stack[0] ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT;
604 } vlib_process_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
607 /* Ensure that the stack is aligned on the multiple of the page size */
609 assert_process_stack_must_be_aligned_exactly_to_page_size_multiple[(sizeof
623 } vlib_one_time_waiting_process_t;
629 u16 n_data_elt_bytes;
631 /* n_data_elts * n_data_elt_bytes */
634 /* Process node & event type to be used to signal event. */
635 u32 process_node_index;
637 u32 event_type_index;
641 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
643 /* Vector of event data used only when data does not fit inline. */
644 u8 *event_data_as_vector;
647 vlib_signal_timed_event_data_t;
650 vlib_timing_wheel_data_is_timed_event (u32 d)
656 vlib_timing_wheel_data_set_suspended_process (u32 i)
662 vlib_timing_wheel_data_set_timed_event (u32 i)
668 vlib_timing_wheel_data_get_index (u32 d)
678 /* Node index hashed by node name. */
682 #define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
684 /* Nodes segregated by type for cache locality.
685 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
686 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
688 /* Node runtime indices for input nodes with pending interrupts. */
689 u32 *pending_interrupt_node_runtime_indices;
690 clib_spinlock_t pending_interrupt_lock;
692 /* Input nodes are switched from/to interrupt to/from polling mode
693 when average vector length goes above/below polling/interrupt
695 u32 polling_threshold_vector_length;
696 u32 interrupt_threshold_vector_length;
698 /* Vector of next frames. */
699 vlib_next_frame_t *next_frames;
701 /* Vector of internal node's frames waiting to be called. */
702 vlib_pending_frame_t *pending_frames;
704 /* Timing wheel for scheduling time-based node dispatch. */
707 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
709 /* Opaque data vector added via timing_wheel_advance. */
710 u32 *data_from_advancing_timing_wheel;
712 /* CPU time of next process to be ready on timing wheel. */
713 f64 time_next_process_ready;
715 /* Vector of process nodes.
716 One for each node of type VLIB_NODE_TYPE_PROCESS. */
717 vlib_process_t **processes;
719 /* Current running process or ~0 if no process running. */
720 u32 current_process_index;
722 /* Pool of pending process frames. */
723 vlib_pending_frame_t *suspended_process_frames;
725 /* Vector of event data vectors pending recycle. */
726 void **recycled_event_data_vectors;
728 /* Current counts of nodes in each state. */
729 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
731 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
732 uword *frame_size_hash;
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 registrations added by constructors */
741 vlib_node_registration_t *node_registrations;
745 #define FRAME_QUEUE_MAX_NELTS 32
748 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
756 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
757 } frame_queue_trace_t;
761 u64 count[FRAME_QUEUE_MAX_NELTS];
762 } frame_queue_nelt_counter_t;
764 #endif /* included_vlib_node_h */
767 * fd.io coding-style-patch-verification: ON
770 * eval: (c-set-style "gnu")