blob: 2d4aa77a61f02ebfccffbcca4c1f890091a3ea13 [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. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400277 void *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
Ed Warnickecb9cada2015-12-08 15:45:58 -0700392 /* Scalar and vector arguments to next node. */
393 u8 arguments[0];
394} vlib_frame_t;
395
Dave Barach9b8ffd92016-07-08 08:13:45 -0400396typedef struct
397{
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200398 /* Frame pointer. */
399 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700400
401 /* Node runtime for this next. */
402 u32 node_runtime_index;
403
404 /* Next frame flags. */
405 u32 flags;
406
407 /* Reflects node frame-used flag for this next. */
408#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
409 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
410
Damjan Marion296988d2019-02-21 20:24:54 +0100411 /* Don't append this frame */
412#define VLIB_FRAME_NO_APPEND (1 << 14)
413
Ed Warnickecb9cada2015-12-08 15:45:58 -0700414 /* This next frame owns enqueue to node
415 corresponding to node_runtime_index. */
416#define VLIB_FRAME_OWNER (1 << 15)
417
418 /* Set when frame has been allocated for this next. */
419#define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
420
421 /* Set when frame has been added to pending vector. */
422#define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
423
424 /* Set when frame is to be freed after dispatch. */
425#define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
426
427 /* Set when frame has traced packets. */
428#define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
429
430 /* Number of vectors enqueue to this next since last overflow. */
431 u32 vectors_since_last_overflow;
432} vlib_next_frame_t;
433
434always_inline void
435vlib_next_frame_init (vlib_next_frame_t * nf)
436{
Dave Barachb7b92992018-10-17 10:38:51 -0400437 clib_memset (nf, 0, sizeof (nf[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700438 nf->node_runtime_index = ~0;
439}
440
441/* A frame pending dispatch by main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400442typedef struct
443{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700444 /* Frame index (in the heap). */
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200445 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700446
Damjan Marionf70cf232021-04-15 19:54:44 +0200447 /* Node and runtime for this frame. */
448 u32 node_runtime_index;
449
Ed Warnickecb9cada2015-12-08 15:45:58 -0700450 /* Start of next frames for this node. */
451 u32 next_frame_index;
452
453 /* Special value for next_frame_index when there is no next frame. */
454#define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
455} vlib_pending_frame_t;
456
Dave Barach9b8ffd92016-07-08 08:13:45 -0400457typedef struct vlib_node_runtime_t
458{
Damjan Marione9f929b2017-03-16 11:32:09 +0100459 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700460
Damjan Marione9f929b2017-03-16 11:32:09 +0100461 vlib_node_function_t *function; /**< Node function to call. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700462
Damjan Marione9f929b2017-03-16 11:32:09 +0100463 vlib_error_t *errors; /**< Vector of errors for this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700464
Damjan Marione9f929b2017-03-16 11:32:09 +0100465 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700466
Damjan Marione9f929b2017-03-16 11:32:09 +0100467 u32 max_clock; /**< Maximum clock cycle for an
468 invocation. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700469
Damjan Marione9f929b2017-03-16 11:32:09 +0100470 u32 max_clock_n; /**< Number of vectors in the recorded
471 max_clock. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700472
Damjan Marione9f929b2017-03-16 11:32:09 +0100473 u32 calls_since_last_overflow; /**< Number of calls. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700474
Damjan Marione9f929b2017-03-16 11:32:09 +0100475 u32 vectors_since_last_overflow; /**< Number of vector elements
476 processed by this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700477
Damjan Marione9f929b2017-03-16 11:32:09 +0100478 u32 next_frame_index; /**< Start of next frames for this
479 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700480
Damjan Marione9f929b2017-03-16 11:32:09 +0100481 u32 node_index; /**< Node index. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700482
Damjan Marione9f929b2017-03-16 11:32:09 +0100483 u32 input_main_loops_per_call; /**< For input nodes: decremented
484 on each main loop interation until
485 it reaches zero and function is
486 called. Allows some input nodes to
487 be called more than others. */
488
489 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
490 dispatch of this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700491
492 u32 main_loop_vector_stats[2];
493
Damjan Marione9f929b2017-03-16 11:32:09 +0100494 u16 flags; /**< Copy of main node flags. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700495
Damjan Marione9f929b2017-03-16 11:32:09 +0100496 u16 state; /**< Input node state. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700497
498 u16 n_next_nodes;
499
Damjan Marione9f929b2017-03-16 11:32:09 +0100500 u16 cached_next_index; /**< Next frame index that vector
501 arguments were last enqueued to
502 last time this node ran. Set to
503 zero before first run of this
504 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700505
Damjan Marion586afd72017-04-05 19:18:20 +0200506 u16 thread_index; /**< thread this node runs on */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700507
Damjan Marione9f929b2017-03-16 11:32:09 +0100508 u8 runtime_data[0]; /**< Function dependent
509 node-runtime data. This data is
510 thread local, and it is not
511 cloned from main thread. It needs
512 to be initialized for each thread
513 before it is used unless
514 runtime_data template exists in
515 vlib_node_t. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400516}
517vlib_node_runtime_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700518
Damjan Marione9f929b2017-03-16 11:32:09 +0100519#define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
520
Dave Barach9b8ffd92016-07-08 08:13:45 -0400521typedef struct
522{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700523 /* Number of allocated frames for this scalar/vector size. */
524 u32 n_alloc_frames;
525
Damjan Marionb32bd702021-12-23 17:05:02 +0100526 /* Frame size */
527 u16 frame_size;
528
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200529 /* Vector of free frames for this scalar/vector size. */
530 vlib_frame_t **free_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700531} vlib_frame_size_t;
532
Damjan Marionb32bd702021-12-23 17:05:02 +0100533STATIC_ASSERT_SIZEOF (vlib_frame_size_t, 16);
534
Dave Barach9b8ffd92016-07-08 08:13:45 -0400535typedef struct
536{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700537 /* Users opaque value for event type. */
538 uword opaque;
539} vlib_process_event_type_t;
540
Dave Barach9b8ffd92016-07-08 08:13:45 -0400541typedef struct
542{
Damjan Marionef587582020-05-20 22:01:44 +0200543 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700544 /* Node runtime for this process. */
545 vlib_node_runtime_t node_runtime;
546
547 /* Where to longjmp when process is done. */
548 clib_longjmp_t return_longjmp;
549
550#define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
551#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
552
553 /* Where to longjmp to resume node after suspend. */
554 clib_longjmp_t resume_longjmp;
555#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
556#define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
557
558 u16 flags;
559#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
560#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
561 /* Set to indicate that this process has been added to resume vector. */
562#define VLIB_PROCESS_RESUME_PENDING (1 << 2)
563
564 /* Process function is currently running. */
565#define VLIB_PROCESS_IS_RUNNING (1 << 3)
566
567 /* Size of process stack. */
568 u16 log2_n_stack_bytes;
569
570 u32 suspended_process_frame_index;
571
572 /* Number of times this process was suspended. */
573 u32 n_suspends;
574
575 /* Vectors of pending event data indexed by event type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400576 void **pending_event_data_by_type_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700577
578 /* Bitmap of event type-indices with non-empty vectors. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400579 uword *non_empty_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700580
581 /* Bitmap of event type-indices which are one time events. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400582 uword *one_time_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700583
584 /* Type is opaque pointer -- typically a pointer to an event handler
585 function. Hash table to map opaque to a type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400586 uword *event_type_index_by_type_opaque;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700587
588 /* Pool of currently valid event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400589 vlib_process_event_type_t *event_type_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700590
Dave Barach5c20a012017-06-13 08:48:31 -0400591 /*
592 * When suspending saves clock time (10us ticks) when process
593 * is to be resumed.
594 */
595 u64 resume_clock_interval;
596
597 /* Handle from timer code, to cancel an unexpired timer */
598 u32 stop_timer_handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700599
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000600 /* Default output function and its argument for any CLI outputs
601 within the process. */
602 vlib_cli_output_function_t *output_function;
603 uword output_function_arg;
604
Damjan Marionef587582020-05-20 22:01:44 +0200605 /* Process stack */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700606#define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
Damjan Marionef587582020-05-20 22:01:44 +0200607 u32 *stack;
608} vlib_process_t;
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000609
Dave Barach9b8ffd92016-07-08 08:13:45 -0400610typedef struct
611{
612 u32 node_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700613
Dave Barach9b8ffd92016-07-08 08:13:45 -0400614 u32 one_time_event;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700615} vlib_one_time_waiting_process_t;
616
Dave Barach9b8ffd92016-07-08 08:13:45 -0400617typedef struct
618{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700619 u16 n_data_elts;
620
621 u16 n_data_elt_bytes;
622
623 /* n_data_elts * n_data_elt_bytes */
624 u32 n_data_bytes;
625
626 /* Process node & event type to be used to signal event. */
627 u32 process_node_index;
628
629 u32 event_type_index;
630
Dave Barach9b8ffd92016-07-08 08:13:45 -0400631 union
632 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700633 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
634
635 /* Vector of event data used only when data does not fit inline. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400636 u8 *event_data_as_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700637 };
Dave Barach9b8ffd92016-07-08 08:13:45 -0400638}
639vlib_signal_timed_event_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700640
641always_inline uword
642vlib_timing_wheel_data_is_timed_event (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400643{
644 return d & 1;
645}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700646
647always_inline u32
648vlib_timing_wheel_data_set_suspended_process (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400649{
650 return 0 + 2 * i;
651}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700652
653always_inline u32
654vlib_timing_wheel_data_set_timed_event (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400655{
656 return 1 + 2 * i;
657}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700658
659always_inline uword
660vlib_timing_wheel_data_get_index (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400661{
662 return d / 2;
663}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700664
Dave Barach9b8ffd92016-07-08 08:13:45 -0400665typedef struct
666{
Damjan Mariona31698b2021-03-10 14:35:28 +0100667 clib_march_variant_type_t index;
668 int priority;
669 char *suffix;
670 char *desc;
671} vlib_node_fn_variant_t;
672
673typedef struct
674{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700675 /* Public nodes. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400676 vlib_node_t **nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700677
678 /* Node index hashed by node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400679 uword *node_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700680
681 u32 flags;
682#define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
683
684 /* Nodes segregated by type for cache locality.
685 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400686 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700687
688 /* Node runtime indices for input nodes with pending interrupts. */
Damjan Marion94100532020-11-06 23:25:57 +0100689 void *interrupts;
690 volatile u32 *pending_interrupts;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700691
692 /* Input nodes are switched from/to interrupt to/from polling mode
693 when average vector length goes above/below polling/interrupt
694 thresholds. */
695 u32 polling_threshold_vector_length;
696 u32 interrupt_threshold_vector_length;
697
698 /* Vector of next frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400699 vlib_next_frame_t *next_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700700
701 /* Vector of internal node's frames waiting to be called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400702 vlib_pending_frame_t *pending_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700703
704 /* Timing wheel for scheduling time-based node dispatch. */
Dave Barach5c20a012017-06-13 08:48:31 -0400705 void *timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700706
Dave Barach9b8ffd92016-07-08 08:13:45 -0400707 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700708
709 /* Opaque data vector added via timing_wheel_advance. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400710 u32 *data_from_advancing_timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700711
712 /* CPU time of next process to be ready on timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -0400713 f64 time_next_process_ready;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700714
715 /* Vector of process nodes.
716 One for each node of type VLIB_NODE_TYPE_PROCESS. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400717 vlib_process_t **processes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700718
719 /* Current running process or ~0 if no process running. */
720 u32 current_process_index;
721
722 /* Pool of pending process frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400723 vlib_pending_frame_t *suspended_process_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700724
725 /* Vector of event data vectors pending recycle. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400726 void **recycled_event_data_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700727
728 /* Current counts of nodes in each state. */
729 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
730
Ed Warnickecb9cada2015-12-08 15:45:58 -0700731 /* Per-size frame allocation information. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400732 vlib_frame_size_t *frame_sizes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700733
734 /* Time of last node runtime stats clear. */
735 f64 time_last_runtime_stats_clear;
736
Dave Barach687c9022019-07-23 10:22:31 -0400737 /* Node index from error code */
738 u32 *node_by_error;
Damjan Mariona31698b2021-03-10 14:35:28 +0100739
740 /* Node Function Variants */
741 vlib_node_fn_variant_t *variants;
742
743 /* Node Function Default Variant Index */
744 u32 node_fn_default_march_variant;
745
746 /* Node Function march Variant by Suffix Hash */
747 uword *node_fn_march_variant_by_suffix;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700748} vlib_node_main_t;
749
Dave Barach687c9022019-07-23 10:22:31 -0400750typedef u16 vlib_error_t;
751
752always_inline u32
753vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
754{
755 return nm->node_by_error[e];
756}
757
758always_inline u32
759vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
760{
761 u32 node_index = nm->node_by_error[e];
762 vlib_node_t *n = nm->nodes[node_index];
763 u32 error_code = e - n->error_heap_index;
764 return error_code;
765}
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200766
dongjuan88752482019-06-04 10:59:02 +0800767#define FRAME_QUEUE_MAX_NELTS 64
Dave Barach9b8ffd92016-07-08 08:13:45 -0400768typedef struct
769{
770 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200771 u64 head;
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200772 u64 tail;
773 u32 n_in_use;
774 u32 nelts;
775 u32 written;
776 u32 threshold;
777 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
778} frame_queue_trace_t;
779
Dave Barach9b8ffd92016-07-08 08:13:45 -0400780typedef struct
781{
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200782 u64 count[FRAME_QUEUE_MAX_NELTS];
783} frame_queue_nelt_counter_t;
784
Ed Warnickecb9cada2015-12-08 15:45:58 -0700785#endif /* included_vlib_node_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400786
787/*
788 * fd.io coding-style-patch-verification: ON
789 *
790 * Local Variables:
791 * eval: (c-set-style "gnu")
792 * End:
793 */