blob: dbff6c1e1e0c5d9ee0c7b96979618a27130057ef [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
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:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
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.
14 */
15/*
16 * node.h: VLIB processing nodes
17 *
18 * Copyright (c) 2008 Eliot Dresselhaus
19 *
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:
27 *
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
30 *
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.
38 */
39
40#ifndef included_vlib_node_h
41#define included_vlib_node_h
42
Damjan Marion1c80e832016-05-11 23:07:18 +020043#include <vppinfra/cpu.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070044#include <vppinfra/longjmp.h>
Damjan Marion2c2b6402017-03-28 14:16:15 +020045#include <vppinfra/lock.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070046#include <vlib/trace.h> /* for vlib_trace_filter_t */
47
48/* Forward declaration. */
49struct vlib_node_runtime_t;
50struct vlib_frame_t;
51
52/* Internal nodes (including output nodes) move data from node to
53 node (or out of the graph for output nodes). */
54typedef uword (vlib_node_function_t) (struct vlib_main_t * vm,
55 struct vlib_node_runtime_t * node,
56 struct vlib_frame_t * frame);
57
Dave Barach9b8ffd92016-07-08 08:13:45 -040058typedef enum
59{
Dave Barach7fff3d22018-11-27 16:52:59 -050060 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;
68
69typedef enum
70{
Ed Warnickecb9cada2015-12-08 15:45:58 -070071 /* An internal node on the call graph (could be output). */
72 VLIB_NODE_TYPE_INTERNAL,
73
74 /* Nodes which input data into the processing graph.
75 Input nodes are called for each iteration of main loop. */
76 VLIB_NODE_TYPE_INPUT,
77
78 /* Nodes to be called before all input nodes.
79 Used, for example, to clean out driver TX rings before
80 processing input. */
81 VLIB_NODE_TYPE_PRE_INPUT,
82
83 /* "Process" nodes which can be suspended and later resumed. */
84 VLIB_NODE_TYPE_PROCESS,
85
86 VLIB_N_NODE_TYPE,
87} vlib_node_type_t;
88
Damjan Marion812b32d2018-05-28 21:26:47 +020089typedef struct _vlib_node_fn_registration
90{
91 vlib_node_function_t *function;
Damjan Mariona31698b2021-03-10 14:35:28 +010092 clib_march_variant_type_t march_variant;
Damjan Marion812b32d2018-05-28 21:26:47 +020093 struct _vlib_node_fn_registration *next_registration;
94} vlib_node_fn_registration_t;
95
Dave Barach9b8ffd92016-07-08 08:13:45 -040096typedef struct _vlib_node_registration
97{
Ed Warnickecb9cada2015-12-08 15:45:58 -070098 /* Vector processing function for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -040099 vlib_node_function_t *function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700100
Damjan Marion812b32d2018-05-28 21:26:47 +0200101 /* Node function candidate registration with priority */
102 vlib_node_fn_registration_t *node_fn_registrations;
103
Ed Warnickecb9cada2015-12-08 15:45:58 -0700104 /* Node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400105 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700106
107 /* Name of sibling (if applicable). */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400108 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700109
110 /* Node index filled in by registration. */
111 u32 index;
112
113 /* Type of this node. */
114 vlib_node_type_t type;
115
116 /* Error strings indexed by error code for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400117 char **error_strings;
Ole Troan2c4acdd2021-05-06 14:09:50 +0200118 vlib_error_desc_t *error_counters;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700119
120 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400121 format_function_t *format_buffer;
122 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700123
124 /* Trace format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400125 format_function_t *format_trace;
126 unformat_function_t *unformat_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700127
128 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400129 u8 *(*validate_frame) (struct vlib_main_t * vm,
130 struct vlib_node_runtime_t *,
131 struct vlib_frame_t * f);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700132
133 /* Per-node runtime data. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400134 void *runtime_data;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700135
136 /* Process stack size. */
137 u16 process_log2_n_stack_bytes;
138
139 /* Number of bytes of per-node run time data. */
140 u8 runtime_data_bytes;
141
142 /* State for input nodes. */
143 u8 state;
144
145 /* Node flags. */
146 u16 flags;
147
Dave Barach7fff3d22018-11-27 16:52:59 -0500148 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
149 u8 protocol_hint;
150
Ed Warnickecb9cada2015-12-08 15:45:58 -0700151 /* Size of scalar and vector arguments in bytes. */
Damjan Marion198ddad2022-01-18 16:24:23 +0100152 u8 vector_size, aux_size;
153 u16 scalar_size;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700154
155 /* Number of error codes used by this node. */
156 u16 n_errors;
157
158 /* Number of next node names that follow. */
159 u16 n_next_nodes;
160
161 /* Constructor link-list, don't ask... */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400162 struct _vlib_node_registration *next_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700163
164 /* Names of next nodes which this node feeds into. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400165 char *next_nodes[];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700166
167} vlib_node_registration_t;
168
Damjan Marion6e363512018-08-10 22:39:11 +0200169#ifndef CLIB_MARCH_VARIANT
Damjan Marionfd8deb42021-03-06 12:26:28 +0100170#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) \
175 { \
176 vlib_global_main_t *vgm = vlib_get_global_main (); \
177 x.next_registration = vgm->node_registrations; \
178 vgm->node_registrations = &x; \
179 } \
180 static void __vlib_rm_node_registration_##x (void) \
181 __attribute__ ((__destructor__)); \
182 static void __vlib_rm_node_registration_##x (void) \
183 { \
184 vlib_global_main_t *vgm = vlib_get_global_main (); \
185 VLIB_REMOVE_FROM_LINKED_LIST (vgm->node_registrations, &x, \
186 next_registration); \
187 } \
188 __VA_ARGS__ vlib_node_registration_t x
Damjan Marion6e363512018-08-10 22:39:11 +0200189#else
190#define VLIB_REGISTER_NODE(x,...) \
Damjan Mariond770cfc2019-09-02 19:00:33 +0200191STATIC_ASSERT (sizeof(# __VA_ARGS__) != 7,"node " #x " must not be declared as static"); \
Damjan Marion6e363512018-08-10 22:39:11 +0200192static __clib_unused vlib_node_registration_t __clib_unused_##x
193#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700194
Damjan Marion69abe442018-08-27 22:43:23 +0200195#ifndef CLIB_MARCH_VARIANT
196#define CLIB_MARCH_VARIANT_STR "default"
197#else
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)
201#endif
202
Damjan Mariona31698b2021-03-10 14:35:28 +0100203#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), \
208 }; \
209 \
210 static void __clib_constructor CLIB_MARCH_SFX (node##_multiarch_register) ( \
211 void) \
212 { \
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; \
219 } \
Damjan Marion1bb67ab2021-04-30 11:11:08 +0200220 uword CLIB_MARCH_SFX (node##_fn)
Damjan Marion812b32d2018-05-28 21:26:47 +0200221
Ray Kinsella4830e4f2020-03-10 14:35:32 +0000222unformat_function_t unformat_vlib_node_variant;
223
Dave Barach9b8ffd92016-07-08 08:13:45 -0400224typedef struct
225{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700226 /* Total calls, clock ticks and vector elements processed for this node. */
227 u64 calls, vectors, clocks, suspends;
228 u64 max_clock;
229 u64 max_clock_n;
230} vlib_node_stats_t;
231
232#define foreach_vlib_node_state \
233 /* Input node is called each iteration of main loop. \
234 This is the default (zero). */ \
235 _ (POLLING) \
236 /* Input node is called when device signals an interrupt. */ \
237 _ (INTERRUPT) \
238 /* Input node is never called. */ \
239 _ (DISABLED)
240
Dave Barach9b8ffd92016-07-08 08:13:45 -0400241typedef enum
242{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700243#define _(f) VLIB_NODE_STATE_##f,
244 foreach_vlib_node_state
245#undef _
Dave Barach9b8ffd92016-07-08 08:13:45 -0400246 VLIB_N_NODE_STATE,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700247} vlib_node_state_t;
248
Dave Barach9b8ffd92016-07-08 08:13:45 -0400249typedef struct vlib_node_t
250{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700251 /* Vector processing function for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400252 vlib_node_function_t *function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700253
254 /* Node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400255 u8 *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700256
257 /* Node name index in elog string table. */
258 u32 name_elog_string;
259
260 /* Total statistics for this node. */
261 vlib_node_stats_t stats_total;
262
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;
266
267 /* Type of this node. */
268 vlib_node_type_t type;
269
270 /* Node index. */
271 u32 index;
272
273 /* Index of corresponding node runtime. */
274 u32 runtime_index;
275
276 /* Runtime data for this node. */
Damjan Marion299571a2022-03-19 00:07:52 +0100277 u8 *runtime_data;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700278
279 /* Node flags. */
280 u16 flags;
281
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)
285
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)
291
292 /* Set if current node runtime has traced vectors. */
293#define VLIB_NODE_FLAG_TRACE (1 << 5)
294
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)
Damjan Marion7ca5aaa2019-09-24 18:10:49 +0200297#define VLIB_NODE_FLAG_TRACE_SUPPORTED (1 << 8)
Florin Coras982e44f2021-03-19 13:12:41 -0700298#define VLIB_NODE_FLAG_ADAPTIVE_MODE (1 << 9)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700299
300 /* State for input nodes. */
301 u8 state;
302
303 /* Number of bytes of run time data. */
304 u8 runtime_data_bytes;
305
Dave Barach7fff3d22018-11-27 16:52:59 -0500306 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
307 u8 protocol_hint;
308
Ed Warnickecb9cada2015-12-08 15:45:58 -0700309 /* Number of error codes used by this node. */
310 u16 n_errors;
311
312 /* Size of scalar and vector arguments in bytes. */
Damjan Marionb32bd702021-12-23 17:05:02 +0100313 u16 frame_size, scalar_offset, vector_offset, magic_offset, aux_offset;
314 u16 frame_size_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700315
316 /* Handle/index in error heap for this node. */
317 u32 error_heap_handle;
318 u32 error_heap_index;
319
Ole Troan148c7b72020-10-07 18:05:37 +0200320 /* Counter structures indexed by counter code for this node. */
Ole Troan2c4acdd2021-05-06 14:09:50 +0200321 vlib_error_desc_t *error_counters;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700322
323 /* Vector of next node names.
324 Only used before next_nodes array is initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400325 char **next_node_names;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700326
327 /* Next node indices for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400328 u32 *next_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700329
330 /* Name of node that we are sibling of. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400331 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700332
333 /* Bitmap of all of this node's siblings. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400334 uword *sibling_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700335
336 /* Total number of vectors sent to each next node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400337 u64 *n_vectors_by_next_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700338
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. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400342 uword *next_slot_by_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700343
344 /* Bitmap of node indices which feed this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400345 uword *prev_node_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700346
347 /* Node/next-index which own enqueue rights with to this node. */
348 u32 owner_node_index, owner_next_index;
349
350 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400351 format_function_t *format_buffer;
352 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700353
354 /* Trace buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400355 format_function_t *format_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700356
357 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400358 u8 *(*validate_frame) (struct vlib_main_t * vm,
359 struct vlib_node_runtime_t *,
360 struct vlib_frame_t * f);
Dave Barach6931f592016-05-13 12:55:01 -0400361 /* for pretty-printing, not typically valid */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400362 u8 *state_string;
Damjan Marion69abe442018-08-27 22:43:23 +0200363
364 /* Node function candidate registration with priority */
365 vlib_node_fn_registration_t *node_fn_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700366} vlib_node_t;
367
368#define VLIB_INVALID_NODE_INDEX ((u32) ~0)
369
370/* Max number of vector elements to process at once per node. */
371#define VLIB_FRAME_SIZE 256
Damjan Marionb32bd702021-12-23 17:05:02 +0100372/* 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
Ed Warnickecb9cada2015-12-08 15:45:58 -0700376
377/* Calling frame (think stack frame) for a node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400378typedef struct vlib_frame_t
379{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700380 /* Frame flags. */
Damjan Marion633b6fd2018-09-14 14:38:53 +0200381 u16 frame_flags;
382
383 /* User flags. Used for sending hints to the next node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700384 u16 flags;
385
Damjan Marionb32bd702021-12-23 17:05:02 +0100386 /* Scalar, vector and aux offsets in this frame. */
387 u16 scalar_offset, vector_offset, aux_offset;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700388
389 /* Number of vector elements currently in frame. */
390 u16 n_vectors;
391
Dmitry Valter9f5b3692022-09-05 15:30:18 +0000392 /* Index of frame size corresponding to allocated node. */
393 u16 frame_size_index;
394
Ed Warnickecb9cada2015-12-08 15:45:58 -0700395 /* Scalar and vector arguments to next node. */
396 u8 arguments[0];
397} vlib_frame_t;
398
Dave Barach9b8ffd92016-07-08 08:13:45 -0400399typedef struct
400{
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200401 /* Frame pointer. */
402 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700403
404 /* Node runtime for this next. */
405 u32 node_runtime_index;
406
407 /* Next frame flags. */
408 u32 flags;
409
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
413
Damjan Marion296988d2019-02-21 20:24:54 +0100414 /* Don't append this frame */
415#define VLIB_FRAME_NO_APPEND (1 << 14)
416
Ed Warnickecb9cada2015-12-08 15:45:58 -0700417 /* This next frame owns enqueue to node
418 corresponding to node_runtime_index. */
419#define VLIB_FRAME_OWNER (1 << 15)
420
421 /* Set when frame has been allocated for this next. */
422#define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
423
424 /* Set when frame has been added to pending vector. */
425#define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
426
427 /* Set when frame is to be freed after dispatch. */
428#define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
429
430 /* Set when frame has traced packets. */
431#define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
432
433 /* Number of vectors enqueue to this next since last overflow. */
434 u32 vectors_since_last_overflow;
435} vlib_next_frame_t;
436
437always_inline void
438vlib_next_frame_init (vlib_next_frame_t * nf)
439{
Dave Barachb7b92992018-10-17 10:38:51 -0400440 clib_memset (nf, 0, sizeof (nf[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700441 nf->node_runtime_index = ~0;
442}
443
444/* A frame pending dispatch by main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400445typedef struct
446{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700447 /* Frame index (in the heap). */
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200448 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700449
Damjan Marionf70cf232021-04-15 19:54:44 +0200450 /* Node and runtime for this frame. */
451 u32 node_runtime_index;
452
Ed Warnickecb9cada2015-12-08 15:45:58 -0700453 /* Start of next frames for this node. */
454 u32 next_frame_index;
455
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;
459
Dave Barach9b8ffd92016-07-08 08:13:45 -0400460typedef struct vlib_node_runtime_t
461{
Damjan Marione9f929b2017-03-16 11:32:09 +0100462 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700463
Damjan Marione9f929b2017-03-16 11:32:09 +0100464 vlib_node_function_t *function; /**< Node function to call. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700465
Damjan Marione9f929b2017-03-16 11:32:09 +0100466 vlib_error_t *errors; /**< Vector of errors for this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700467
Damjan Marione9f929b2017-03-16 11:32:09 +0100468 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700469
Damjan Marione9f929b2017-03-16 11:32:09 +0100470 u32 max_clock; /**< Maximum clock cycle for an
471 invocation. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700472
Damjan Marione9f929b2017-03-16 11:32:09 +0100473 u32 max_clock_n; /**< Number of vectors in the recorded
474 max_clock. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700475
Damjan Marione9f929b2017-03-16 11:32:09 +0100476 u32 calls_since_last_overflow; /**< Number of calls. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700477
Damjan Marione9f929b2017-03-16 11:32:09 +0100478 u32 vectors_since_last_overflow; /**< Number of vector elements
479 processed by this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700480
Damjan Marione9f929b2017-03-16 11:32:09 +0100481 u32 next_frame_index; /**< Start of next frames for this
482 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700483
Damjan Marione9f929b2017-03-16 11:32:09 +0100484 u32 node_index; /**< Node index. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700485
Damjan Marione9f929b2017-03-16 11:32:09 +0100486 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. */
491
492 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
493 dispatch of this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700494
495 u32 main_loop_vector_stats[2];
496
Damjan Marione9f929b2017-03-16 11:32:09 +0100497 u16 flags; /**< Copy of main node flags. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700498
Damjan Marione9f929b2017-03-16 11:32:09 +0100499 u16 state; /**< Input node state. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700500
501 u16 n_next_nodes;
502
Damjan Marione9f929b2017-03-16 11:32:09 +0100503 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
507 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700508
Dmitry Valter5760fdf2022-03-29 15:13:26 +0000509 CLIB_ALIGN_MARK (runtime_data_pad, 8);
510
Damjan Marione9f929b2017-03-16 11:32:09 +0100511 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
518 vlib_node_t. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400519}
520vlib_node_runtime_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700521
Damjan Marione9f929b2017-03-16 11:32:09 +0100522#define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
523
Dave Barach9b8ffd92016-07-08 08:13:45 -0400524typedef struct
525{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700526 /* Number of allocated frames for this scalar/vector size. */
527 u32 n_alloc_frames;
528
Damjan Marionb32bd702021-12-23 17:05:02 +0100529 /* Frame size */
530 u16 frame_size;
531
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200532 /* Vector of free frames for this scalar/vector size. */
533 vlib_frame_t **free_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700534} vlib_frame_size_t;
535
Damjan Marionb32bd702021-12-23 17:05:02 +0100536STATIC_ASSERT_SIZEOF (vlib_frame_size_t, 16);
537
Dave Barach9b8ffd92016-07-08 08:13:45 -0400538typedef struct
539{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700540 /* Users opaque value for event type. */
541 uword opaque;
542} vlib_process_event_type_t;
543
Dave Barach9b8ffd92016-07-08 08:13:45 -0400544typedef struct
545{
Damjan Marionef587582020-05-20 22:01:44 +0200546 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700547 /* Node runtime for this process. */
548 vlib_node_runtime_t node_runtime;
549
550 /* Where to longjmp when process is done. */
551 clib_longjmp_t return_longjmp;
552
553#define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
554#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
555
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
560
561 u16 flags;
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)
566
567 /* Process function is currently running. */
568#define VLIB_PROCESS_IS_RUNNING (1 << 3)
569
570 /* Size of process stack. */
571 u16 log2_n_stack_bytes;
572
573 u32 suspended_process_frame_index;
574
575 /* Number of times this process was suspended. */
576 u32 n_suspends;
577
578 /* Vectors of pending event data indexed by event type index. */
Damjan Mariond24b86e2022-03-23 16:59:23 +0100579 u8 **pending_event_data_by_type_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700580
581 /* Bitmap of event type-indices with non-empty vectors. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400582 uword *non_empty_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700583
584 /* Bitmap of event type-indices which are one time events. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400585 uword *one_time_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700586
587 /* Type is opaque pointer -- typically a pointer to an event handler
588 function. Hash table to map opaque to a type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400589 uword *event_type_index_by_type_opaque;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700590
591 /* Pool of currently valid event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400592 vlib_process_event_type_t *event_type_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700593
Dave Barach5c20a012017-06-13 08:48:31 -0400594 /*
595 * When suspending saves clock time (10us ticks) when process
596 * is to be resumed.
597 */
598 u64 resume_clock_interval;
599
600 /* Handle from timer code, to cancel an unexpired timer */
601 u32 stop_timer_handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700602
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000603 /* 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;
607
Damjan Marionef587582020-05-20 22:01:44 +0200608 /* Process stack */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700609#define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
Damjan Marionef587582020-05-20 22:01:44 +0200610 u32 *stack;
611} vlib_process_t;
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000612
Dave Barach9b8ffd92016-07-08 08:13:45 -0400613typedef struct
614{
615 u32 node_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700616
Dave Barach9b8ffd92016-07-08 08:13:45 -0400617 u32 one_time_event;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700618} vlib_one_time_waiting_process_t;
619
Dave Barach9b8ffd92016-07-08 08:13:45 -0400620typedef struct
621{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700622 u16 n_data_elts;
623
624 u16 n_data_elt_bytes;
625
626 /* n_data_elts * n_data_elt_bytes */
627 u32 n_data_bytes;
628
629 /* Process node & event type to be used to signal event. */
630 u32 process_node_index;
631
632 u32 event_type_index;
633
Dave Barach9b8ffd92016-07-08 08:13:45 -0400634 union
635 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700636 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
637
638 /* Vector of event data used only when data does not fit inline. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400639 u8 *event_data_as_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700640 };
Dave Barach9b8ffd92016-07-08 08:13:45 -0400641}
642vlib_signal_timed_event_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700643
644always_inline uword
645vlib_timing_wheel_data_is_timed_event (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400646{
647 return d & 1;
648}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700649
650always_inline u32
651vlib_timing_wheel_data_set_suspended_process (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400652{
653 return 0 + 2 * i;
654}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700655
656always_inline u32
657vlib_timing_wheel_data_set_timed_event (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400658{
659 return 1 + 2 * i;
660}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700661
662always_inline uword
663vlib_timing_wheel_data_get_index (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400664{
665 return d / 2;
666}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700667
Dave Barach9b8ffd92016-07-08 08:13:45 -0400668typedef struct
669{
Damjan Mariona31698b2021-03-10 14:35:28 +0100670 clib_march_variant_type_t index;
671 int priority;
672 char *suffix;
673 char *desc;
674} vlib_node_fn_variant_t;
675
676typedef struct
677{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700678 /* Public nodes. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400679 vlib_node_t **nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700680
681 /* Node index hashed by node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400682 uword *node_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700683
684 u32 flags;
685#define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
686
687 /* Nodes segregated by type for cache locality.
688 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400689 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700690
691 /* Node runtime indices for input nodes with pending interrupts. */
Damjan Marion94100532020-11-06 23:25:57 +0100692 void *interrupts;
693 volatile u32 *pending_interrupts;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700694
695 /* Input nodes are switched from/to interrupt to/from polling mode
696 when average vector length goes above/below polling/interrupt
697 thresholds. */
698 u32 polling_threshold_vector_length;
699 u32 interrupt_threshold_vector_length;
700
701 /* Vector of next frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400702 vlib_next_frame_t *next_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700703
704 /* Vector of internal node's frames waiting to be called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400705 vlib_pending_frame_t *pending_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700706
707 /* Timing wheel for scheduling time-based node dispatch. */
Dave Barach5c20a012017-06-13 08:48:31 -0400708 void *timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700709
Dave Barach9b8ffd92016-07-08 08:13:45 -0400710 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700711
712 /* Opaque data vector added via timing_wheel_advance. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400713 u32 *data_from_advancing_timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700714
715 /* CPU time of next process to be ready on timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -0400716 f64 time_next_process_ready;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700717
718 /* Vector of process nodes.
719 One for each node of type VLIB_NODE_TYPE_PROCESS. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400720 vlib_process_t **processes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700721
722 /* Current running process or ~0 if no process running. */
723 u32 current_process_index;
724
725 /* Pool of pending process frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400726 vlib_pending_frame_t *suspended_process_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700727
728 /* Vector of event data vectors pending recycle. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400729 void **recycled_event_data_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700730
731 /* Current counts of nodes in each state. */
732 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
733
Ed Warnickecb9cada2015-12-08 15:45:58 -0700734 /* Per-size frame allocation information. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400735 vlib_frame_size_t *frame_sizes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700736
737 /* Time of last node runtime stats clear. */
738 f64 time_last_runtime_stats_clear;
739
Dave Barach687c9022019-07-23 10:22:31 -0400740 /* Node index from error code */
741 u32 *node_by_error;
Damjan Mariona31698b2021-03-10 14:35:28 +0100742
743 /* Node Function Variants */
744 vlib_node_fn_variant_t *variants;
745
746 /* Node Function Default Variant Index */
747 u32 node_fn_default_march_variant;
748
749 /* Node Function march Variant by Suffix Hash */
750 uword *node_fn_march_variant_by_suffix;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700751} vlib_node_main_t;
752
Dave Barach687c9022019-07-23 10:22:31 -0400753typedef u16 vlib_error_t;
754
755always_inline u32
756vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
757{
758 return nm->node_by_error[e];
759}
760
761always_inline u32
762vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
763{
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;
767 return error_code;
768}
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200769
dongjuan88752482019-06-04 10:59:02 +0800770#define FRAME_QUEUE_MAX_NELTS 64
Dave Barach9b8ffd92016-07-08 08:13:45 -0400771typedef struct
772{
773 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200774 u64 head;
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200775 u64 tail;
776 u32 n_in_use;
777 u32 nelts;
778 u32 written;
779 u32 threshold;
780 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
781} frame_queue_trace_t;
782
Dave Barach9b8ffd92016-07-08 08:13:45 -0400783typedef struct
784{
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200785 u64 count[FRAME_QUEUE_MAX_NELTS];
786} frame_queue_nelt_counter_t;
787
Ed Warnickecb9cada2015-12-08 15:45:58 -0700788#endif /* included_vlib_node_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400789
790/*
791 * fd.io coding-style-patch-verification: ON
792 *
793 * Local Variables:
794 * eval: (c-set-style "gnu")
795 * End:
796 */