blob: a06c20211d43b794442aba0638140b77759d56af [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. */
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
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. */
312 u16 scalar_size, vector_size;
313
314 /* Handle/index in error heap for this node. */
315 u32 error_heap_handle;
316 u32 error_heap_index;
317
Ole Troan148c7b72020-10-07 18:05:37 +0200318 /* Counter structures indexed by counter code for this node. */
Ole Troan2c4acdd2021-05-06 14:09:50 +0200319 vlib_error_desc_t *error_counters;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700320
321 /* Vector of next node names.
322 Only used before next_nodes array is initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400323 char **next_node_names;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700324
325 /* Next node indices for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400326 u32 *next_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700327
328 /* Name of node that we are sibling of. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400329 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700330
331 /* Bitmap of all of this node's siblings. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400332 uword *sibling_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700333
334 /* Total number of vectors sent to each next node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400335 u64 *n_vectors_by_next_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700336
337 /* Hash table mapping next node index into slot in
338 next_nodes vector. Quickly determines whether this node
339 is connected to given next node and, if so, with which slot. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400340 uword *next_slot_by_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700341
342 /* Bitmap of node indices which feed this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400343 uword *prev_node_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700344
345 /* Node/next-index which own enqueue rights with to this node. */
346 u32 owner_node_index, owner_next_index;
347
348 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400349 format_function_t *format_buffer;
350 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700351
352 /* Trace buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400353 format_function_t *format_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700354
355 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400356 u8 *(*validate_frame) (struct vlib_main_t * vm,
357 struct vlib_node_runtime_t *,
358 struct vlib_frame_t * f);
Dave Barach6931f592016-05-13 12:55:01 -0400359 /* for pretty-printing, not typically valid */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400360 u8 *state_string;
Damjan Marion69abe442018-08-27 22:43:23 +0200361
362 /* Node function candidate registration with priority */
363 vlib_node_fn_registration_t *node_fn_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700364} vlib_node_t;
365
366#define VLIB_INVALID_NODE_INDEX ((u32) ~0)
367
368/* Max number of vector elements to process at once per node. */
369#define VLIB_FRAME_SIZE 256
Dave Barachd84ba852017-08-22 17:56:46 -0400370#define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
Ed Warnickecb9cada2015-12-08 15:45:58 -0700371
372/* Calling frame (think stack frame) for a node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400373typedef struct vlib_frame_t
374{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700375 /* Frame flags. */
Damjan Marion633b6fd2018-09-14 14:38:53 +0200376 u16 frame_flags;
377
378 /* User flags. Used for sending hints to the next node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700379 u16 flags;
380
381 /* Number of scalar bytes in arguments. */
382 u8 scalar_size;
383
384 /* Number of bytes per vector argument. */
385 u8 vector_size;
386
387 /* Number of vector elements currently in frame. */
388 u16 n_vectors;
389
Ed Warnickecb9cada2015-12-08 15:45:58 -0700390 /* Scalar and vector arguments to next node. */
391 u8 arguments[0];
392} vlib_frame_t;
393
Dave Barach9b8ffd92016-07-08 08:13:45 -0400394typedef struct
395{
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200396 /* Frame pointer. */
397 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700398
399 /* Node runtime for this next. */
400 u32 node_runtime_index;
401
402 /* Next frame flags. */
403 u32 flags;
404
405 /* Reflects node frame-used flag for this next. */
406#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
407 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
408
Damjan Marion296988d2019-02-21 20:24:54 +0100409 /* Don't append this frame */
410#define VLIB_FRAME_NO_APPEND (1 << 14)
411
Ed Warnickecb9cada2015-12-08 15:45:58 -0700412 /* This next frame owns enqueue to node
413 corresponding to node_runtime_index. */
414#define VLIB_FRAME_OWNER (1 << 15)
415
416 /* Set when frame has been allocated for this next. */
417#define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
418
419 /* Set when frame has been added to pending vector. */
420#define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
421
422 /* Set when frame is to be freed after dispatch. */
423#define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
424
425 /* Set when frame has traced packets. */
426#define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
427
428 /* Number of vectors enqueue to this next since last overflow. */
429 u32 vectors_since_last_overflow;
430} vlib_next_frame_t;
431
432always_inline void
433vlib_next_frame_init (vlib_next_frame_t * nf)
434{
Dave Barachb7b92992018-10-17 10:38:51 -0400435 clib_memset (nf, 0, sizeof (nf[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700436 nf->node_runtime_index = ~0;
437}
438
439/* A frame pending dispatch by main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400440typedef struct
441{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700442 /* Frame index (in the heap). */
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200443 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700444
Damjan Marionf70cf232021-04-15 19:54:44 +0200445 /* Node and runtime for this frame. */
446 u32 node_runtime_index;
447
Ed Warnickecb9cada2015-12-08 15:45:58 -0700448 /* Start of next frames for this node. */
449 u32 next_frame_index;
450
451 /* Special value for next_frame_index when there is no next frame. */
452#define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
453} vlib_pending_frame_t;
454
Dave Barach9b8ffd92016-07-08 08:13:45 -0400455typedef struct vlib_node_runtime_t
456{
Damjan Marione9f929b2017-03-16 11:32:09 +0100457 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700458
Damjan Marione9f929b2017-03-16 11:32:09 +0100459 vlib_node_function_t *function; /**< Node function to call. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700460
Damjan Marione9f929b2017-03-16 11:32:09 +0100461 vlib_error_t *errors; /**< Vector of errors for this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700462
Damjan Marione9f929b2017-03-16 11:32:09 +0100463 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700464
Damjan Marione9f929b2017-03-16 11:32:09 +0100465 u32 max_clock; /**< Maximum clock cycle for an
466 invocation. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700467
Damjan Marione9f929b2017-03-16 11:32:09 +0100468 u32 max_clock_n; /**< Number of vectors in the recorded
469 max_clock. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700470
Damjan Marione9f929b2017-03-16 11:32:09 +0100471 u32 calls_since_last_overflow; /**< Number of calls. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700472
Damjan Marione9f929b2017-03-16 11:32:09 +0100473 u32 vectors_since_last_overflow; /**< Number of vector elements
474 processed by this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700475
Damjan Marione9f929b2017-03-16 11:32:09 +0100476 u32 next_frame_index; /**< Start of next frames for this
477 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700478
Damjan Marione9f929b2017-03-16 11:32:09 +0100479 u32 node_index; /**< Node index. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700480
Damjan Marione9f929b2017-03-16 11:32:09 +0100481 u32 input_main_loops_per_call; /**< For input nodes: decremented
482 on each main loop interation until
483 it reaches zero and function is
484 called. Allows some input nodes to
485 be called more than others. */
486
487 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
488 dispatch of this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700489
490 u32 main_loop_vector_stats[2];
491
Damjan Marione9f929b2017-03-16 11:32:09 +0100492 u16 flags; /**< Copy of main node flags. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700493
Damjan Marione9f929b2017-03-16 11:32:09 +0100494 u16 state; /**< Input node state. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700495
496 u16 n_next_nodes;
497
Damjan Marione9f929b2017-03-16 11:32:09 +0100498 u16 cached_next_index; /**< Next frame index that vector
499 arguments were last enqueued to
500 last time this node ran. Set to
501 zero before first run of this
502 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700503
Damjan Marion586afd72017-04-05 19:18:20 +0200504 u16 thread_index; /**< thread this node runs on */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700505
Damjan Marione9f929b2017-03-16 11:32:09 +0100506 u8 runtime_data[0]; /**< Function dependent
507 node-runtime data. This data is
508 thread local, and it is not
509 cloned from main thread. It needs
510 to be initialized for each thread
511 before it is used unless
512 runtime_data template exists in
513 vlib_node_t. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400514}
515vlib_node_runtime_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700516
Damjan Marione9f929b2017-03-16 11:32:09 +0100517#define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
518
Dave Barach9b8ffd92016-07-08 08:13:45 -0400519typedef struct
520{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700521 /* Number of allocated frames for this scalar/vector size. */
522 u32 n_alloc_frames;
523
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200524 /* Vector of free frames for this scalar/vector size. */
525 vlib_frame_t **free_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700526} vlib_frame_size_t;
527
Dave Barach9b8ffd92016-07-08 08:13:45 -0400528typedef struct
529{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700530 /* Users opaque value for event type. */
531 uword opaque;
532} vlib_process_event_type_t;
533
Dave Barach9b8ffd92016-07-08 08:13:45 -0400534typedef struct
535{
Damjan Marionef587582020-05-20 22:01:44 +0200536 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700537 /* Node runtime for this process. */
538 vlib_node_runtime_t node_runtime;
539
540 /* Where to longjmp when process is done. */
541 clib_longjmp_t return_longjmp;
542
543#define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
544#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
545
546 /* Where to longjmp to resume node after suspend. */
547 clib_longjmp_t resume_longjmp;
548#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
549#define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
550
551 u16 flags;
552#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
553#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
554 /* Set to indicate that this process has been added to resume vector. */
555#define VLIB_PROCESS_RESUME_PENDING (1 << 2)
556
557 /* Process function is currently running. */
558#define VLIB_PROCESS_IS_RUNNING (1 << 3)
559
560 /* Size of process stack. */
561 u16 log2_n_stack_bytes;
562
563 u32 suspended_process_frame_index;
564
565 /* Number of times this process was suspended. */
566 u32 n_suspends;
567
568 /* Vectors of pending event data indexed by event type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400569 void **pending_event_data_by_type_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700570
571 /* Bitmap of event type-indices with non-empty vectors. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400572 uword *non_empty_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700573
574 /* Bitmap of event type-indices which are one time events. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400575 uword *one_time_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700576
577 /* Type is opaque pointer -- typically a pointer to an event handler
578 function. Hash table to map opaque to a type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400579 uword *event_type_index_by_type_opaque;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700580
581 /* Pool of currently valid event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400582 vlib_process_event_type_t *event_type_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700583
Dave Barach5c20a012017-06-13 08:48:31 -0400584 /*
585 * When suspending saves clock time (10us ticks) when process
586 * is to be resumed.
587 */
588 u64 resume_clock_interval;
589
590 /* Handle from timer code, to cancel an unexpired timer */
591 u32 stop_timer_handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700592
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000593 /* Default output function and its argument for any CLI outputs
594 within the process. */
595 vlib_cli_output_function_t *output_function;
596 uword output_function_arg;
597
Damjan Marionef587582020-05-20 22:01:44 +0200598 /* Process stack */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700599#define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
Damjan Marionef587582020-05-20 22:01:44 +0200600 u32 *stack;
601} vlib_process_t;
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000602
Dave Barach9b8ffd92016-07-08 08:13:45 -0400603typedef struct
604{
605 u32 node_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700606
Dave Barach9b8ffd92016-07-08 08:13:45 -0400607 u32 one_time_event;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700608} vlib_one_time_waiting_process_t;
609
Dave Barach9b8ffd92016-07-08 08:13:45 -0400610typedef struct
611{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700612 u16 n_data_elts;
613
614 u16 n_data_elt_bytes;
615
616 /* n_data_elts * n_data_elt_bytes */
617 u32 n_data_bytes;
618
619 /* Process node & event type to be used to signal event. */
620 u32 process_node_index;
621
622 u32 event_type_index;
623
Dave Barach9b8ffd92016-07-08 08:13:45 -0400624 union
625 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700626 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
627
628 /* Vector of event data used only when data does not fit inline. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400629 u8 *event_data_as_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700630 };
Dave Barach9b8ffd92016-07-08 08:13:45 -0400631}
632vlib_signal_timed_event_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700633
634always_inline uword
635vlib_timing_wheel_data_is_timed_event (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400636{
637 return d & 1;
638}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700639
640always_inline u32
641vlib_timing_wheel_data_set_suspended_process (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400642{
643 return 0 + 2 * i;
644}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700645
646always_inline u32
647vlib_timing_wheel_data_set_timed_event (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400648{
649 return 1 + 2 * i;
650}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700651
652always_inline uword
653vlib_timing_wheel_data_get_index (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400654{
655 return d / 2;
656}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700657
Dave Barach9b8ffd92016-07-08 08:13:45 -0400658typedef struct
659{
Damjan Mariona31698b2021-03-10 14:35:28 +0100660 clib_march_variant_type_t index;
661 int priority;
662 char *suffix;
663 char *desc;
664} vlib_node_fn_variant_t;
665
666typedef struct
667{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700668 /* Public nodes. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400669 vlib_node_t **nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700670
671 /* Node index hashed by node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400672 uword *node_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700673
674 u32 flags;
675#define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
676
677 /* Nodes segregated by type for cache locality.
678 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400679 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700680
681 /* Node runtime indices for input nodes with pending interrupts. */
Damjan Marion94100532020-11-06 23:25:57 +0100682 void *interrupts;
683 volatile u32 *pending_interrupts;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700684
685 /* Input nodes are switched from/to interrupt to/from polling mode
686 when average vector length goes above/below polling/interrupt
687 thresholds. */
688 u32 polling_threshold_vector_length;
689 u32 interrupt_threshold_vector_length;
690
691 /* Vector of next frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400692 vlib_next_frame_t *next_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700693
694 /* Vector of internal node's frames waiting to be called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400695 vlib_pending_frame_t *pending_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700696
697 /* Timing wheel for scheduling time-based node dispatch. */
Dave Barach5c20a012017-06-13 08:48:31 -0400698 void *timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700699
Dave Barach9b8ffd92016-07-08 08:13:45 -0400700 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700701
702 /* Opaque data vector added via timing_wheel_advance. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400703 u32 *data_from_advancing_timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700704
705 /* CPU time of next process to be ready on timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -0400706 f64 time_next_process_ready;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700707
708 /* Vector of process nodes.
709 One for each node of type VLIB_NODE_TYPE_PROCESS. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400710 vlib_process_t **processes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700711
712 /* Current running process or ~0 if no process running. */
713 u32 current_process_index;
714
715 /* Pool of pending process frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400716 vlib_pending_frame_t *suspended_process_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700717
718 /* Vector of event data vectors pending recycle. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400719 void **recycled_event_data_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700720
721 /* Current counts of nodes in each state. */
722 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
723
724 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400725 uword *frame_size_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700726
727 /* Per-size frame allocation information. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400728 vlib_frame_size_t *frame_sizes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700729
730 /* Time of last node runtime stats clear. */
731 f64 time_last_runtime_stats_clear;
732
Dave Barach687c9022019-07-23 10:22:31 -0400733 /* Node index from error code */
734 u32 *node_by_error;
Damjan Mariona31698b2021-03-10 14:35:28 +0100735
736 /* Node Function Variants */
737 vlib_node_fn_variant_t *variants;
738
739 /* Node Function Default Variant Index */
740 u32 node_fn_default_march_variant;
741
742 /* Node Function march Variant by Suffix Hash */
743 uword *node_fn_march_variant_by_suffix;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700744} vlib_node_main_t;
745
Dave Barach687c9022019-07-23 10:22:31 -0400746typedef u16 vlib_error_t;
747
748always_inline u32
749vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
750{
751 return nm->node_by_error[e];
752}
753
754always_inline u32
755vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
756{
757 u32 node_index = nm->node_by_error[e];
758 vlib_node_t *n = nm->nodes[node_index];
759 u32 error_code = e - n->error_heap_index;
760 return error_code;
761}
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200762
dongjuan88752482019-06-04 10:59:02 +0800763#define FRAME_QUEUE_MAX_NELTS 64
Dave Barach9b8ffd92016-07-08 08:13:45 -0400764typedef struct
765{
766 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200767 u64 head;
768 u64 head_hint;
769 u64 tail;
770 u32 n_in_use;
771 u32 nelts;
772 u32 written;
773 u32 threshold;
774 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
775} frame_queue_trace_t;
776
Dave Barach9b8ffd92016-07-08 08:13:45 -0400777typedef struct
778{
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200779 u64 count[FRAME_QUEUE_MAX_NELTS];
780} frame_queue_nelt_counter_t;
781
Ed Warnickecb9cada2015-12-08 15:45:58 -0700782#endif /* included_vlib_node_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400783
784/*
785 * fd.io coding-style-patch-verification: ON
786 *
787 * Local Variables:
788 * eval: (c-set-style "gnu")
789 * End:
790 */