blob: 66a99925846a1f997b1fc52dac2b11154799acba [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 Marionb32bd702021-12-23 17:05:02 +0100152 u8 scalar_size, vector_size, aux_size;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700153
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
Damjan Marionfd8deb42021-03-06 12:26:28 +0100169#define VLIB_REGISTER_NODE(x, ...) \
170 __VA_ARGS__ vlib_node_registration_t x; \
171 static void __vlib_add_node_registration_##x (void) \
172 __attribute__ ((__constructor__)); \
173 static void __vlib_add_node_registration_##x (void) \
174 { \
175 vlib_global_main_t *vgm = vlib_get_global_main (); \
176 x.next_registration = vgm->node_registrations; \
177 vgm->node_registrations = &x; \
178 } \
179 static void __vlib_rm_node_registration_##x (void) \
180 __attribute__ ((__destructor__)); \
181 static void __vlib_rm_node_registration_##x (void) \
182 { \
183 vlib_global_main_t *vgm = vlib_get_global_main (); \
184 VLIB_REMOVE_FROM_LINKED_LIST (vgm->node_registrations, &x, \
185 next_registration); \
186 } \
187 __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 } \
Damjan Marion1bb67ab2021-04-30 11:11:08 +0200219 uword 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)
Florin Coras982e44f2021-03-19 13:12:41 -0700297#define VLIB_NODE_FLAG_ADAPTIVE_MODE (1 << 9)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700298
299 /* State for input nodes. */
300 u8 state;
301
302 /* Number of bytes of run time data. */
303 u8 runtime_data_bytes;
304
Dave Barach7fff3d22018-11-27 16:52:59 -0500305 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
306 u8 protocol_hint;
307
Ed Warnickecb9cada2015-12-08 15:45:58 -0700308 /* Number of error codes used by this node. */
309 u16 n_errors;
310
311 /* Size of scalar and vector arguments in bytes. */
Damjan Marionb32bd702021-12-23 17:05:02 +0100312 u16 frame_size, scalar_offset, vector_offset, magic_offset, aux_offset;
313 u16 frame_size_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700314
315 /* Handle/index in error heap for this node. */
316 u32 error_heap_handle;
317 u32 error_heap_index;
318
Ole Troan148c7b72020-10-07 18:05:37 +0200319 /* Counter structures indexed by counter code for this node. */
Ole Troan2c4acdd2021-05-06 14:09:50 +0200320 vlib_error_desc_t *error_counters;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700321
322 /* Vector of next node names.
323 Only used before next_nodes array is initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400324 char **next_node_names;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700325
326 /* Next node indices for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400327 u32 *next_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700328
329 /* Name of node that we are sibling of. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400330 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700331
332 /* Bitmap of all of this node's siblings. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400333 uword *sibling_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700334
335 /* Total number of vectors sent to each next node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400336 u64 *n_vectors_by_next_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700337
338 /* Hash table mapping next node index into slot in
339 next_nodes vector. Quickly determines whether this node
340 is connected to given next node and, if so, with which slot. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400341 uword *next_slot_by_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700342
343 /* Bitmap of node indices which feed this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400344 uword *prev_node_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700345
346 /* Node/next-index which own enqueue rights with to this node. */
347 u32 owner_node_index, owner_next_index;
348
349 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400350 format_function_t *format_buffer;
351 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700352
353 /* Trace buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400354 format_function_t *format_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700355
356 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400357 u8 *(*validate_frame) (struct vlib_main_t * vm,
358 struct vlib_node_runtime_t *,
359 struct vlib_frame_t * f);
Dave Barach6931f592016-05-13 12:55:01 -0400360 /* for pretty-printing, not typically valid */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400361 u8 *state_string;
Damjan Marion69abe442018-08-27 22:43:23 +0200362
363 /* Node function candidate registration with priority */
364 vlib_node_fn_registration_t *node_fn_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700365} vlib_node_t;
366
367#define VLIB_INVALID_NODE_INDEX ((u32) ~0)
368
369/* Max number of vector elements to process at once per node. */
370#define VLIB_FRAME_SIZE 256
Damjan Marionb32bd702021-12-23 17:05:02 +0100371/* Number of extra elements allocated at the end of vecttor. */
372#define VLIB_FRAME_SIZE_EXTRA 4
373/* Frame data alignment */
374#define VLIB_FRAME_DATA_ALIGN 16
Ed Warnickecb9cada2015-12-08 15:45:58 -0700375
376/* Calling frame (think stack frame) for a node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400377typedef struct vlib_frame_t
378{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700379 /* Frame flags. */
Damjan Marion633b6fd2018-09-14 14:38:53 +0200380 u16 frame_flags;
381
382 /* User flags. Used for sending hints to the next node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700383 u16 flags;
384
Damjan Marionb32bd702021-12-23 17:05:02 +0100385 /* Scalar, vector and aux offsets in this frame. */
386 u16 scalar_offset, vector_offset, aux_offset;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700387
388 /* Number of vector elements currently in frame. */
389 u16 n_vectors;
390
Ed Warnickecb9cada2015-12-08 15:45:58 -0700391 /* Scalar and vector arguments to next node. */
392 u8 arguments[0];
393} vlib_frame_t;
394
Dave Barach9b8ffd92016-07-08 08:13:45 -0400395typedef struct
396{
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200397 /* Frame pointer. */
398 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700399
400 /* Node runtime for this next. */
401 u32 node_runtime_index;
402
403 /* Next frame flags. */
404 u32 flags;
405
406 /* Reflects node frame-used flag for this next. */
407#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
408 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
409
Damjan Marion296988d2019-02-21 20:24:54 +0100410 /* Don't append this frame */
411#define VLIB_FRAME_NO_APPEND (1 << 14)
412
Ed Warnickecb9cada2015-12-08 15:45:58 -0700413 /* This next frame owns enqueue to node
414 corresponding to node_runtime_index. */
415#define VLIB_FRAME_OWNER (1 << 15)
416
417 /* Set when frame has been allocated for this next. */
418#define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
419
420 /* Set when frame has been added to pending vector. */
421#define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
422
423 /* Set when frame is to be freed after dispatch. */
424#define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
425
426 /* Set when frame has traced packets. */
427#define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
428
429 /* Number of vectors enqueue to this next since last overflow. */
430 u32 vectors_since_last_overflow;
431} vlib_next_frame_t;
432
433always_inline void
434vlib_next_frame_init (vlib_next_frame_t * nf)
435{
Dave Barachb7b92992018-10-17 10:38:51 -0400436 clib_memset (nf, 0, sizeof (nf[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700437 nf->node_runtime_index = ~0;
438}
439
440/* A frame pending dispatch by main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400441typedef struct
442{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700443 /* Frame index (in the heap). */
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200444 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700445
Damjan Marionf70cf232021-04-15 19:54:44 +0200446 /* Node and runtime for this frame. */
447 u32 node_runtime_index;
448
Ed Warnickecb9cada2015-12-08 15:45:58 -0700449 /* Start of next frames for this node. */
450 u32 next_frame_index;
451
452 /* Special value for next_frame_index when there is no next frame. */
453#define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
454} vlib_pending_frame_t;
455
Dave Barach9b8ffd92016-07-08 08:13:45 -0400456typedef struct vlib_node_runtime_t
457{
Damjan Marione9f929b2017-03-16 11:32:09 +0100458 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700459
Damjan Marione9f929b2017-03-16 11:32:09 +0100460 vlib_node_function_t *function; /**< Node function to call. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700461
Damjan Marione9f929b2017-03-16 11:32:09 +0100462 vlib_error_t *errors; /**< Vector of errors for this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700463
Damjan Marione9f929b2017-03-16 11:32:09 +0100464 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700465
Damjan Marione9f929b2017-03-16 11:32:09 +0100466 u32 max_clock; /**< Maximum clock cycle for an
467 invocation. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700468
Damjan Marione9f929b2017-03-16 11:32:09 +0100469 u32 max_clock_n; /**< Number of vectors in the recorded
470 max_clock. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700471
Damjan Marione9f929b2017-03-16 11:32:09 +0100472 u32 calls_since_last_overflow; /**< Number of calls. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700473
Damjan Marione9f929b2017-03-16 11:32:09 +0100474 u32 vectors_since_last_overflow; /**< Number of vector elements
475 processed by this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700476
Damjan Marione9f929b2017-03-16 11:32:09 +0100477 u32 next_frame_index; /**< Start of next frames for this
478 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700479
Damjan Marione9f929b2017-03-16 11:32:09 +0100480 u32 node_index; /**< Node index. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700481
Damjan Marione9f929b2017-03-16 11:32:09 +0100482 u32 input_main_loops_per_call; /**< For input nodes: decremented
483 on each main loop interation until
484 it reaches zero and function is
485 called. Allows some input nodes to
486 be called more than others. */
487
488 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
489 dispatch of this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700490
491 u32 main_loop_vector_stats[2];
492
Damjan Marione9f929b2017-03-16 11:32:09 +0100493 u16 flags; /**< Copy of main node flags. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700494
Damjan Marione9f929b2017-03-16 11:32:09 +0100495 u16 state; /**< Input node state. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700496
497 u16 n_next_nodes;
498
Damjan Marione9f929b2017-03-16 11:32:09 +0100499 u16 cached_next_index; /**< Next frame index that vector
500 arguments were last enqueued to
501 last time this node ran. Set to
502 zero before first run of this
503 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700504
Damjan Marion586afd72017-04-05 19:18:20 +0200505 u16 thread_index; /**< thread this node runs on */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700506
Damjan Marione9f929b2017-03-16 11:32:09 +0100507 u8 runtime_data[0]; /**< Function dependent
508 node-runtime data. This data is
509 thread local, and it is not
510 cloned from main thread. It needs
511 to be initialized for each thread
512 before it is used unless
513 runtime_data template exists in
514 vlib_node_t. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400515}
516vlib_node_runtime_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700517
Damjan Marione9f929b2017-03-16 11:32:09 +0100518#define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
519
Dave Barach9b8ffd92016-07-08 08:13:45 -0400520typedef struct
521{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700522 /* Number of allocated frames for this scalar/vector size. */
523 u32 n_alloc_frames;
524
Damjan Marionb32bd702021-12-23 17:05:02 +0100525 /* Frame size */
526 u16 frame_size;
527
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200528 /* Vector of free frames for this scalar/vector size. */
529 vlib_frame_t **free_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700530} vlib_frame_size_t;
531
Damjan Marionb32bd702021-12-23 17:05:02 +0100532STATIC_ASSERT_SIZEOF (vlib_frame_size_t, 16);
533
Dave Barach9b8ffd92016-07-08 08:13:45 -0400534typedef struct
535{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700536 /* Users opaque value for event type. */
537 uword opaque;
538} vlib_process_event_type_t;
539
Dave Barach9b8ffd92016-07-08 08:13:45 -0400540typedef struct
541{
Damjan Marionef587582020-05-20 22:01:44 +0200542 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700543 /* Node runtime for this process. */
544 vlib_node_runtime_t node_runtime;
545
546 /* Where to longjmp when process is done. */
547 clib_longjmp_t return_longjmp;
548
549#define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
550#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
551
552 /* Where to longjmp to resume node after suspend. */
553 clib_longjmp_t resume_longjmp;
554#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
555#define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
556
557 u16 flags;
558#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
559#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
560 /* Set to indicate that this process has been added to resume vector. */
561#define VLIB_PROCESS_RESUME_PENDING (1 << 2)
562
563 /* Process function is currently running. */
564#define VLIB_PROCESS_IS_RUNNING (1 << 3)
565
566 /* Size of process stack. */
567 u16 log2_n_stack_bytes;
568
569 u32 suspended_process_frame_index;
570
571 /* Number of times this process was suspended. */
572 u32 n_suspends;
573
574 /* Vectors of pending event data indexed by event type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400575 void **pending_event_data_by_type_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700576
577 /* Bitmap of event type-indices with non-empty vectors. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400578 uword *non_empty_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700579
580 /* Bitmap of event type-indices which are one time events. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400581 uword *one_time_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700582
583 /* Type is opaque pointer -- typically a pointer to an event handler
584 function. Hash table to map opaque to a type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400585 uword *event_type_index_by_type_opaque;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700586
587 /* Pool of currently valid event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400588 vlib_process_event_type_t *event_type_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700589
Dave Barach5c20a012017-06-13 08:48:31 -0400590 /*
591 * When suspending saves clock time (10us ticks) when process
592 * is to be resumed.
593 */
594 u64 resume_clock_interval;
595
596 /* Handle from timer code, to cancel an unexpired timer */
597 u32 stop_timer_handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700598
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000599 /* Default output function and its argument for any CLI outputs
600 within the process. */
601 vlib_cli_output_function_t *output_function;
602 uword output_function_arg;
603
Damjan Marionef587582020-05-20 22:01:44 +0200604 /* Process stack */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700605#define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
Damjan Marionef587582020-05-20 22:01:44 +0200606 u32 *stack;
607} vlib_process_t;
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000608
Dave Barach9b8ffd92016-07-08 08:13:45 -0400609typedef struct
610{
611 u32 node_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700612
Dave Barach9b8ffd92016-07-08 08:13:45 -0400613 u32 one_time_event;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700614} vlib_one_time_waiting_process_t;
615
Dave Barach9b8ffd92016-07-08 08:13:45 -0400616typedef struct
617{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700618 u16 n_data_elts;
619
620 u16 n_data_elt_bytes;
621
622 /* n_data_elts * n_data_elt_bytes */
623 u32 n_data_bytes;
624
625 /* Process node & event type to be used to signal event. */
626 u32 process_node_index;
627
628 u32 event_type_index;
629
Dave Barach9b8ffd92016-07-08 08:13:45 -0400630 union
631 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700632 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
633
634 /* Vector of event data used only when data does not fit inline. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400635 u8 *event_data_as_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700636 };
Dave Barach9b8ffd92016-07-08 08:13:45 -0400637}
638vlib_signal_timed_event_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700639
640always_inline uword
641vlib_timing_wheel_data_is_timed_event (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400642{
643 return d & 1;
644}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700645
646always_inline u32
647vlib_timing_wheel_data_set_suspended_process (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400648{
649 return 0 + 2 * i;
650}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700651
652always_inline u32
653vlib_timing_wheel_data_set_timed_event (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400654{
655 return 1 + 2 * i;
656}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700657
658always_inline uword
659vlib_timing_wheel_data_get_index (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400660{
661 return d / 2;
662}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700663
Dave Barach9b8ffd92016-07-08 08:13:45 -0400664typedef struct
665{
Damjan Mariona31698b2021-03-10 14:35:28 +0100666 clib_march_variant_type_t index;
667 int priority;
668 char *suffix;
669 char *desc;
670} vlib_node_fn_variant_t;
671
672typedef struct
673{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700674 /* Public nodes. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400675 vlib_node_t **nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700676
677 /* Node index hashed by node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400678 uword *node_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700679
680 u32 flags;
681#define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
682
683 /* Nodes segregated by type for cache locality.
684 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400685 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700686
687 /* Node runtime indices for input nodes with pending interrupts. */
Damjan Marion94100532020-11-06 23:25:57 +0100688 void *interrupts;
689 volatile u32 *pending_interrupts;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700690
691 /* Input nodes are switched from/to interrupt to/from polling mode
692 when average vector length goes above/below polling/interrupt
693 thresholds. */
694 u32 polling_threshold_vector_length;
695 u32 interrupt_threshold_vector_length;
696
697 /* Vector of next frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400698 vlib_next_frame_t *next_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700699
700 /* Vector of internal node's frames waiting to be called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400701 vlib_pending_frame_t *pending_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700702
703 /* Timing wheel for scheduling time-based node dispatch. */
Dave Barach5c20a012017-06-13 08:48:31 -0400704 void *timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700705
Dave Barach9b8ffd92016-07-08 08:13:45 -0400706 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700707
708 /* Opaque data vector added via timing_wheel_advance. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400709 u32 *data_from_advancing_timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700710
711 /* CPU time of next process to be ready on timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -0400712 f64 time_next_process_ready;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700713
714 /* Vector of process nodes.
715 One for each node of type VLIB_NODE_TYPE_PROCESS. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400716 vlib_process_t **processes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700717
718 /* Current running process or ~0 if no process running. */
719 u32 current_process_index;
720
721 /* Pool of pending process frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400722 vlib_pending_frame_t *suspended_process_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700723
724 /* Vector of event data vectors pending recycle. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400725 void **recycled_event_data_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700726
727 /* Current counts of nodes in each state. */
728 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
729
Ed Warnickecb9cada2015-12-08 15:45:58 -0700730 /* Per-size frame allocation information. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400731 vlib_frame_size_t *frame_sizes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700732
733 /* Time of last node runtime stats clear. */
734 f64 time_last_runtime_stats_clear;
735
Dave Barach687c9022019-07-23 10:22:31 -0400736 /* Node index from error code */
737 u32 *node_by_error;
Damjan Mariona31698b2021-03-10 14:35:28 +0100738
739 /* Node Function Variants */
740 vlib_node_fn_variant_t *variants;
741
742 /* Node Function Default Variant Index */
743 u32 node_fn_default_march_variant;
744
745 /* Node Function march Variant by Suffix Hash */
746 uword *node_fn_march_variant_by_suffix;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700747} vlib_node_main_t;
748
Dave Barach687c9022019-07-23 10:22:31 -0400749typedef u16 vlib_error_t;
750
751always_inline u32
752vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
753{
754 return nm->node_by_error[e];
755}
756
757always_inline u32
758vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
759{
760 u32 node_index = nm->node_by_error[e];
761 vlib_node_t *n = nm->nodes[node_index];
762 u32 error_code = e - n->error_heap_index;
763 return error_code;
764}
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200765
dongjuan88752482019-06-04 10:59:02 +0800766#define FRAME_QUEUE_MAX_NELTS 64
Dave Barach9b8ffd92016-07-08 08:13:45 -0400767typedef struct
768{
769 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200770 u64 head;
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200771 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 */