blob: 9a3bb8370afff29ff4f4701bc884559151a319bf [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 Troan148c7b72020-10-07 18:05:37 +0200118 vl_counter_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. */
152 u16 scalar_size, vector_size;
153
154 /* Number of error codes used by this node. */
155 u16 n_errors;
156
157 /* Number of next node names that follow. */
158 u16 n_next_nodes;
159
160 /* Constructor link-list, don't ask... */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400161 struct _vlib_node_registration *next_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700162
163 /* Names of next nodes which this node feeds into. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400164 char *next_nodes[];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700165
166} vlib_node_registration_t;
167
Damjan Marion6e363512018-08-10 22:39:11 +0200168#ifndef CLIB_MARCH_VARIANT
Ed Warnickecb9cada2015-12-08 15:45:58 -0700169#define VLIB_REGISTER_NODE(x,...) \
170 __VA_ARGS__ vlib_node_registration_t x; \
171static void __vlib_add_node_registration_##x (void) \
172 __attribute__((__constructor__)) ; \
173static void __vlib_add_node_registration_##x (void) \
174{ \
175 vlib_main_t * vm = vlib_get_main(); \
176 x.next_registration = vm->node_main.node_registrations; \
177 vm->node_main.node_registrations = &x; \
178} \
Damjan Marion72d2c4f2018-04-05 21:32:29 +0200179static void __vlib_rm_node_registration_##x (void) \
180 __attribute__((__destructor__)) ; \
181static void __vlib_rm_node_registration_##x (void) \
182{ \
183 vlib_main_t * vm = vlib_get_main(); \
184 VLIB_REMOVE_FROM_LINKED_LIST (vm->node_main.node_registrations, \
185 &x, next_registration); \
186} \
Dave Barach9b8ffd92016-07-08 08:13:45 -0400187__VA_ARGS__ vlib_node_registration_t x
Damjan Marion6e363512018-08-10 22:39:11 +0200188#else
189#define VLIB_REGISTER_NODE(x,...) \
Damjan Mariond770cfc2019-09-02 19:00:33 +0200190STATIC_ASSERT (sizeof(# __VA_ARGS__) != 7,"node " #x " must not be declared as static"); \
Damjan Marion6e363512018-08-10 22:39:11 +0200191static __clib_unused vlib_node_registration_t __clib_unused_##x
192#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700193
Damjan Marion69abe442018-08-27 22:43:23 +0200194#ifndef CLIB_MARCH_VARIANT
195#define CLIB_MARCH_VARIANT_STR "default"
196#else
197#define _CLIB_MARCH_VARIANT_STR(s) __CLIB_MARCH_VARIANT_STR(s)
198#define __CLIB_MARCH_VARIANT_STR(s) #s
199#define CLIB_MARCH_VARIANT_STR _CLIB_MARCH_VARIANT_STR(CLIB_MARCH_VARIANT)
200#endif
201
Damjan Mariona31698b2021-03-10 14:35:28 +0100202#define VLIB_NODE_FN(node) \
203 uword CLIB_MARCH_SFX (node##_fn) (); \
204 static vlib_node_fn_registration_t CLIB_MARCH_SFX ( \
205 node##_fn_registration) = { \
206 .function = &CLIB_MARCH_SFX (node##_fn), \
207 }; \
208 \
209 static void __clib_constructor CLIB_MARCH_SFX (node##_multiarch_register) ( \
210 void) \
211 { \
212 extern vlib_node_registration_t node; \
213 vlib_node_fn_registration_t *r; \
214 r = &CLIB_MARCH_SFX (node##_fn_registration); \
215 r->march_variant = CLIB_MARCH_SFX (CLIB_MARCH_VARIANT_TYPE); \
216 r->next_registration = node.node_fn_registrations; \
217 node.node_fn_registrations = r; \
218 } \
219 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (node##_fn)
Damjan Marion812b32d2018-05-28 21:26:47 +0200220
Ray Kinsella4830e4f2020-03-10 14:35:32 +0000221unformat_function_t unformat_vlib_node_variant;
222
Dave Barach9b8ffd92016-07-08 08:13:45 -0400223typedef struct
224{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700225 /* Total calls, clock ticks and vector elements processed for this node. */
226 u64 calls, vectors, clocks, suspends;
227 u64 max_clock;
228 u64 max_clock_n;
229} vlib_node_stats_t;
230
231#define foreach_vlib_node_state \
232 /* Input node is called each iteration of main loop. \
233 This is the default (zero). */ \
234 _ (POLLING) \
235 /* Input node is called when device signals an interrupt. */ \
236 _ (INTERRUPT) \
237 /* Input node is never called. */ \
238 _ (DISABLED)
239
Dave Barach9b8ffd92016-07-08 08:13:45 -0400240typedef enum
241{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700242#define _(f) VLIB_NODE_STATE_##f,
243 foreach_vlib_node_state
244#undef _
Dave Barach9b8ffd92016-07-08 08:13:45 -0400245 VLIB_N_NODE_STATE,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700246} vlib_node_state_t;
247
Dave Barach9b8ffd92016-07-08 08:13:45 -0400248typedef struct vlib_node_t
249{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700250 /* Vector processing function for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400251 vlib_node_function_t *function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700252
253 /* Node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400254 u8 *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700255
256 /* Node name index in elog string table. */
257 u32 name_elog_string;
258
259 /* Total statistics for this node. */
260 vlib_node_stats_t stats_total;
261
262 /* Saved values as of last clear (or zero if never cleared).
263 Current values are always stats_total - stats_last_clear. */
264 vlib_node_stats_t stats_last_clear;
265
266 /* Type of this node. */
267 vlib_node_type_t type;
268
269 /* Node index. */
270 u32 index;
271
272 /* Index of corresponding node runtime. */
273 u32 runtime_index;
274
275 /* Runtime data for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400276 void *runtime_data;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700277
278 /* Node flags. */
279 u16 flags;
280
281 /* Processing function keeps frame. Tells node dispatching code not
282 to free frame after dispatch is done. */
283#define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
284
285 /* Node counts as output/drop/punt node for stats purposes. */
286#define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
287#define VLIB_NODE_FLAG_IS_DROP (1 << 2)
288#define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
289#define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
290
291 /* Set if current node runtime has traced vectors. */
292#define VLIB_NODE_FLAG_TRACE (1 << 5)
293
294#define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
295#define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
Damjan Marion7ca5aaa2019-09-24 18:10:49 +0200296#define VLIB_NODE_FLAG_TRACE_SUPPORTED (1 << 8)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700297
298 /* State for input nodes. */
299 u8 state;
300
301 /* Number of bytes of run time data. */
302 u8 runtime_data_bytes;
303
Dave Barach7fff3d22018-11-27 16:52:59 -0500304 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
305 u8 protocol_hint;
306
Ed Warnickecb9cada2015-12-08 15:45:58 -0700307 /* Number of error codes used by this node. */
308 u16 n_errors;
309
310 /* Size of scalar and vector arguments in bytes. */
311 u16 scalar_size, vector_size;
312
313 /* Handle/index in error heap for this node. */
314 u32 error_heap_handle;
315 u32 error_heap_index;
316
Ole Troan148c7b72020-10-07 18:05:37 +0200317 /* Counter structures indexed by counter code for this node. */
318 vl_counter_t *error_counters;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700319
320 /* Vector of next node names.
321 Only used before next_nodes array is initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400322 char **next_node_names;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700323
324 /* Next node indices for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400325 u32 *next_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700326
327 /* Name of node that we are sibling of. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400328 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700329
330 /* Bitmap of all of this node's siblings. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400331 uword *sibling_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700332
333 /* Total number of vectors sent to each next node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400334 u64 *n_vectors_by_next_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700335
336 /* Hash table mapping next node index into slot in
337 next_nodes vector. Quickly determines whether this node
338 is connected to given next node and, if so, with which slot. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400339 uword *next_slot_by_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700340
341 /* Bitmap of node indices which feed this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400342 uword *prev_node_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700343
344 /* Node/next-index which own enqueue rights with to this node. */
345 u32 owner_node_index, owner_next_index;
346
347 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400348 format_function_t *format_buffer;
349 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700350
351 /* Trace buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400352 format_function_t *format_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700353
354 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400355 u8 *(*validate_frame) (struct vlib_main_t * vm,
356 struct vlib_node_runtime_t *,
357 struct vlib_frame_t * f);
Dave Barach6931f592016-05-13 12:55:01 -0400358 /* for pretty-printing, not typically valid */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400359 u8 *state_string;
Damjan Marion69abe442018-08-27 22:43:23 +0200360
361 /* Node function candidate registration with priority */
362 vlib_node_fn_registration_t *node_fn_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700363} vlib_node_t;
364
365#define VLIB_INVALID_NODE_INDEX ((u32) ~0)
366
367/* Max number of vector elements to process at once per node. */
368#define VLIB_FRAME_SIZE 256
Dave Barachd84ba852017-08-22 17:56:46 -0400369#define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
Ed Warnickecb9cada2015-12-08 15:45:58 -0700370
371/* Calling frame (think stack frame) for a node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400372typedef struct vlib_frame_t
373{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700374 /* Frame flags. */
Damjan Marion633b6fd2018-09-14 14:38:53 +0200375 u16 frame_flags;
376
377 /* User flags. Used for sending hints to the next node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700378 u16 flags;
379
380 /* Number of scalar bytes in arguments. */
381 u8 scalar_size;
382
383 /* Number of bytes per vector argument. */
384 u8 vector_size;
385
386 /* Number of vector elements currently in frame. */
387 u16 n_vectors;
388
Ed Warnickecb9cada2015-12-08 15:45:58 -0700389 /* Scalar and vector arguments to next node. */
390 u8 arguments[0];
391} vlib_frame_t;
392
Dave Barach9b8ffd92016-07-08 08:13:45 -0400393typedef struct
394{
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200395 /* Frame pointer. */
396 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700397
398 /* Node runtime for this next. */
399 u32 node_runtime_index;
400
401 /* Next frame flags. */
402 u32 flags;
403
404 /* Reflects node frame-used flag for this next. */
405#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
406 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
407
Damjan Marion296988d2019-02-21 20:24:54 +0100408 /* Don't append this frame */
409#define VLIB_FRAME_NO_APPEND (1 << 14)
410
Ed Warnickecb9cada2015-12-08 15:45:58 -0700411 /* This next frame owns enqueue to node
412 corresponding to node_runtime_index. */
413#define VLIB_FRAME_OWNER (1 << 15)
414
415 /* Set when frame has been allocated for this next. */
416#define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
417
418 /* Set when frame has been added to pending vector. */
419#define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
420
421 /* Set when frame is to be freed after dispatch. */
422#define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
423
424 /* Set when frame has traced packets. */
425#define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
426
427 /* Number of vectors enqueue to this next since last overflow. */
428 u32 vectors_since_last_overflow;
429} vlib_next_frame_t;
430
431always_inline void
432vlib_next_frame_init (vlib_next_frame_t * nf)
433{
Dave Barachb7b92992018-10-17 10:38:51 -0400434 clib_memset (nf, 0, sizeof (nf[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700435 nf->node_runtime_index = ~0;
436}
437
438/* A frame pending dispatch by main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400439typedef struct
440{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700441 /* Node and runtime for this frame. */
442 u32 node_runtime_index;
443
444 /* 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
447 /* Start of next frames for this node. */
448 u32 next_frame_index;
449
450 /* Special value for next_frame_index when there is no next frame. */
451#define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
452} vlib_pending_frame_t;
453
Dave Barach9b8ffd92016-07-08 08:13:45 -0400454typedef struct vlib_node_runtime_t
455{
Damjan Marione9f929b2017-03-16 11:32:09 +0100456 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700457
Damjan Marione9f929b2017-03-16 11:32:09 +0100458 vlib_node_function_t *function; /**< Node function to call. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700459
Damjan Marione9f929b2017-03-16 11:32:09 +0100460 vlib_error_t *errors; /**< Vector of errors for this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700461
Damjan Marione9f929b2017-03-16 11:32:09 +0100462 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700463
Damjan Marione9f929b2017-03-16 11:32:09 +0100464 u32 max_clock; /**< Maximum clock cycle for an
465 invocation. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700466
Damjan Marione9f929b2017-03-16 11:32:09 +0100467 u32 max_clock_n; /**< Number of vectors in the recorded
468 max_clock. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700469
Damjan Marione9f929b2017-03-16 11:32:09 +0100470 u32 calls_since_last_overflow; /**< Number of calls. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700471
Damjan Marione9f929b2017-03-16 11:32:09 +0100472 u32 vectors_since_last_overflow; /**< Number of vector elements
473 processed by this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700474
Damjan Marione9f929b2017-03-16 11:32:09 +0100475 u32 next_frame_index; /**< Start of next frames for this
476 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700477
Damjan Marione9f929b2017-03-16 11:32:09 +0100478 u32 node_index; /**< Node index. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700479
Damjan Marione9f929b2017-03-16 11:32:09 +0100480 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. */
485
486 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
487 dispatch of this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700488
489 u32 main_loop_vector_stats[2];
490
Damjan Marione9f929b2017-03-16 11:32:09 +0100491 u16 flags; /**< Copy of main node flags. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700492
Damjan Marione9f929b2017-03-16 11:32:09 +0100493 u16 state; /**< Input node state. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700494
495 u16 n_next_nodes;
496
Damjan Marione9f929b2017-03-16 11:32:09 +0100497 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
501 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700502
Damjan Marion586afd72017-04-05 19:18:20 +0200503 u16 thread_index; /**< thread this node runs on */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700504
Damjan Marione9f929b2017-03-16 11:32:09 +0100505 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
512 vlib_node_t. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400513}
514vlib_node_runtime_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700515
Damjan Marione9f929b2017-03-16 11:32:09 +0100516#define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
517
Dave Barach9b8ffd92016-07-08 08:13:45 -0400518typedef struct
519{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700520 /* Number of allocated frames for this scalar/vector size. */
521 u32 n_alloc_frames;
522
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200523 /* Vector of free frames for this scalar/vector size. */
524 vlib_frame_t **free_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700525} vlib_frame_size_t;
526
Dave Barach9b8ffd92016-07-08 08:13:45 -0400527typedef struct
528{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700529 /* Users opaque value for event type. */
530 uword opaque;
531} vlib_process_event_type_t;
532
Dave Barach9b8ffd92016-07-08 08:13:45 -0400533typedef struct
534{
Damjan Marionef587582020-05-20 22:01:44 +0200535 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700536 /* Node runtime for this process. */
537 vlib_node_runtime_t node_runtime;
538
539 /* Where to longjmp when process is done. */
540 clib_longjmp_t return_longjmp;
541
542#define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
543#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
544
545 /* Where to longjmp to resume node after suspend. */
546 clib_longjmp_t resume_longjmp;
547#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
548#define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
549
550 u16 flags;
551#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
552#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
553 /* Set to indicate that this process has been added to resume vector. */
554#define VLIB_PROCESS_RESUME_PENDING (1 << 2)
555
556 /* Process function is currently running. */
557#define VLIB_PROCESS_IS_RUNNING (1 << 3)
558
559 /* Size of process stack. */
560 u16 log2_n_stack_bytes;
561
562 u32 suspended_process_frame_index;
563
564 /* Number of times this process was suspended. */
565 u32 n_suspends;
566
567 /* Vectors of pending event data indexed by event type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400568 void **pending_event_data_by_type_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700569
570 /* Bitmap of event type-indices with non-empty vectors. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400571 uword *non_empty_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700572
573 /* Bitmap of event type-indices which are one time events. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400574 uword *one_time_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700575
576 /* Type is opaque pointer -- typically a pointer to an event handler
577 function. Hash table to map opaque to a type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400578 uword *event_type_index_by_type_opaque;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700579
580 /* Pool of currently valid event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400581 vlib_process_event_type_t *event_type_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700582
Dave Barach5c20a012017-06-13 08:48:31 -0400583 /*
584 * When suspending saves clock time (10us ticks) when process
585 * is to be resumed.
586 */
587 u64 resume_clock_interval;
588
589 /* Handle from timer code, to cancel an unexpired timer */
590 u32 stop_timer_handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700591
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000592 /* Default output function and its argument for any CLI outputs
593 within the process. */
594 vlib_cli_output_function_t *output_function;
595 uword output_function_arg;
596
Damjan Marionef587582020-05-20 22:01:44 +0200597 /* Process stack */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700598#define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
Damjan Marionef587582020-05-20 22:01:44 +0200599 u32 *stack;
600} vlib_process_t;
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000601
Dave Barach9b8ffd92016-07-08 08:13:45 -0400602typedef struct
603{
604 u32 node_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700605
Dave Barach9b8ffd92016-07-08 08:13:45 -0400606 u32 one_time_event;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700607} vlib_one_time_waiting_process_t;
608
Dave Barach9b8ffd92016-07-08 08:13:45 -0400609typedef struct
610{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700611 u16 n_data_elts;
612
613 u16 n_data_elt_bytes;
614
615 /* n_data_elts * n_data_elt_bytes */
616 u32 n_data_bytes;
617
618 /* Process node & event type to be used to signal event. */
619 u32 process_node_index;
620
621 u32 event_type_index;
622
Dave Barach9b8ffd92016-07-08 08:13:45 -0400623 union
624 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700625 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
626
627 /* Vector of event data used only when data does not fit inline. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400628 u8 *event_data_as_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700629 };
Dave Barach9b8ffd92016-07-08 08:13:45 -0400630}
631vlib_signal_timed_event_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700632
633always_inline uword
634vlib_timing_wheel_data_is_timed_event (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400635{
636 return d & 1;
637}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700638
639always_inline u32
640vlib_timing_wheel_data_set_suspended_process (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400641{
642 return 0 + 2 * i;
643}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700644
645always_inline u32
646vlib_timing_wheel_data_set_timed_event (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400647{
648 return 1 + 2 * i;
649}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700650
651always_inline uword
652vlib_timing_wheel_data_get_index (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400653{
654 return d / 2;
655}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700656
Dave Barach9b8ffd92016-07-08 08:13:45 -0400657typedef struct
658{
Damjan Mariona31698b2021-03-10 14:35:28 +0100659 clib_march_variant_type_t index;
660 int priority;
661 char *suffix;
662 char *desc;
663} vlib_node_fn_variant_t;
664
665typedef struct
666{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700667 /* Public nodes. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400668 vlib_node_t **nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700669
670 /* Node index hashed by node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400671 uword *node_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700672
673 u32 flags;
674#define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
675
676 /* Nodes segregated by type for cache locality.
677 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400678 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700679
680 /* Node runtime indices for input nodes with pending interrupts. */
Damjan Marion94100532020-11-06 23:25:57 +0100681 void *interrupts;
682 volatile u32 *pending_interrupts;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700683
684 /* Input nodes are switched from/to interrupt to/from polling mode
685 when average vector length goes above/below polling/interrupt
686 thresholds. */
687 u32 polling_threshold_vector_length;
688 u32 interrupt_threshold_vector_length;
689
690 /* Vector of next frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400691 vlib_next_frame_t *next_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700692
693 /* Vector of internal node's frames waiting to be called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400694 vlib_pending_frame_t *pending_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700695
696 /* Timing wheel for scheduling time-based node dispatch. */
Dave Barach5c20a012017-06-13 08:48:31 -0400697 void *timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700698
Dave Barach9b8ffd92016-07-08 08:13:45 -0400699 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700700
701 /* Opaque data vector added via timing_wheel_advance. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400702 u32 *data_from_advancing_timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700703
704 /* CPU time of next process to be ready on timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -0400705 f64 time_next_process_ready;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700706
707 /* Vector of process nodes.
708 One for each node of type VLIB_NODE_TYPE_PROCESS. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400709 vlib_process_t **processes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700710
711 /* Current running process or ~0 if no process running. */
712 u32 current_process_index;
713
714 /* Pool of pending process frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400715 vlib_pending_frame_t *suspended_process_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700716
717 /* Vector of event data vectors pending recycle. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400718 void **recycled_event_data_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700719
720 /* Current counts of nodes in each state. */
721 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
722
723 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400724 uword *frame_size_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700725
726 /* Per-size frame allocation information. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400727 vlib_frame_size_t *frame_sizes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700728
729 /* Time of last node runtime stats clear. */
730 f64 time_last_runtime_stats_clear;
731
732 /* Node registrations added by constructors */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400733 vlib_node_registration_t *node_registrations;
Dave Barach687c9022019-07-23 10:22:31 -0400734
735 /* Node index from error code */
736 u32 *node_by_error;
Damjan Mariona31698b2021-03-10 14:35:28 +0100737
738 /* Node Function Variants */
739 vlib_node_fn_variant_t *variants;
740
741 /* Node Function Default Variant Index */
742 u32 node_fn_default_march_variant;
743
744 /* Node Function march Variant by Suffix Hash */
745 uword *node_fn_march_variant_by_suffix;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700746} vlib_node_main_t;
747
Dave Barach687c9022019-07-23 10:22:31 -0400748typedef u16 vlib_error_t;
749
750always_inline u32
751vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
752{
753 return nm->node_by_error[e];
754}
755
756always_inline u32
757vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
758{
759 u32 node_index = nm->node_by_error[e];
760 vlib_node_t *n = nm->nodes[node_index];
761 u32 error_code = e - n->error_heap_index;
762 return error_code;
763}
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200764
dongjuan88752482019-06-04 10:59:02 +0800765#define FRAME_QUEUE_MAX_NELTS 64
Dave Barach9b8ffd92016-07-08 08:13:45 -0400766typedef struct
767{
768 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200769 u64 head;
770 u64 head_hint;
771 u64 tail;
772 u32 n_in_use;
773 u32 nelts;
774 u32 written;
775 u32 threshold;
776 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
777} frame_queue_trace_t;
778
Dave Barach9b8ffd92016-07-08 08:13:45 -0400779typedef struct
780{
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200781 u64 count[FRAME_QUEUE_MAX_NELTS];
782} frame_queue_nelt_counter_t;
783
Ed Warnickecb9cada2015-12-08 15:45:58 -0700784#endif /* included_vlib_node_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400785
786/*
787 * fd.io coding-style-patch-verification: ON
788 *
789 * Local Variables:
790 * eval: (c-set-style "gnu")
791 * End:
792 */