blob: f7155aeda866af209c2aa21e72654ba1d3cf9e52 [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;
92 int priority;
93 struct _vlib_node_fn_registration *next_registration;
Damjan Marion69abe442018-08-27 22:43:23 +020094 char *name;
Damjan Marion812b32d2018-05-28 21:26:47 +020095} vlib_node_fn_registration_t;
96
Dave Barach9b8ffd92016-07-08 08:13:45 -040097typedef struct _vlib_node_registration
98{
Ed Warnickecb9cada2015-12-08 15:45:58 -070099 /* Vector processing function for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400100 vlib_node_function_t *function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700101
Damjan Marion812b32d2018-05-28 21:26:47 +0200102 /* Node function candidate registration with priority */
103 vlib_node_fn_registration_t *node_fn_registrations;
104
Ed Warnickecb9cada2015-12-08 15:45:58 -0700105 /* Node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400106 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700107
108 /* Name of sibling (if applicable). */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400109 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700110
111 /* Node index filled in by registration. */
112 u32 index;
113
114 /* Type of this node. */
115 vlib_node_type_t type;
116
117 /* Error strings indexed by error code for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400118 char **error_strings;
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 Marion812b32d2018-05-28 21:26:47 +0200202#define VLIB_NODE_FN(node) \
203uword CLIB_MARCH_SFX (node##_fn)(); \
204static vlib_node_fn_registration_t \
205 CLIB_MARCH_SFX(node##_fn_registration) = \
206 { .function = &CLIB_MARCH_SFX (node##_fn), }; \
207 \
208static void __clib_constructor \
209CLIB_MARCH_SFX (node##_multiarch_register) (void) \
210{ \
211 extern vlib_node_registration_t node; \
212 vlib_node_fn_registration_t *r; \
213 r = & CLIB_MARCH_SFX (node##_fn_registration); \
214 r->priority = CLIB_MARCH_FN_PRIORITY(); \
Damjan Marion69abe442018-08-27 22:43:23 +0200215 r->name = CLIB_MARCH_VARIANT_STR; \
Damjan Marion812b32d2018-05-28 21:26:47 +0200216 r->next_registration = node.node_fn_registrations; \
217 node.node_fn_registrations = r; \
218} \
219uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (node##_fn)
220
Ray Kinsella4830e4f2020-03-10 14:35:32 +0000221unformat_function_t unformat_vlib_node_variant;
222
Ed Warnickecb9cada2015-12-08 15:45:58 -0700223always_inline vlib_node_registration_t *
224vlib_node_next_registered (vlib_node_registration_t * c)
225{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400226 c =
227 clib_elf_section_data_next (c,
228 c->n_next_nodes * sizeof (c->next_nodes[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700229 return c;
230}
231
Dave Barach9b8ffd92016-07-08 08:13:45 -0400232typedef struct
233{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700234 /* Total calls, clock ticks and vector elements processed for this node. */
235 u64 calls, vectors, clocks, suspends;
236 u64 max_clock;
237 u64 max_clock_n;
238} vlib_node_stats_t;
239
240#define foreach_vlib_node_state \
241 /* Input node is called each iteration of main loop. \
242 This is the default (zero). */ \
243 _ (POLLING) \
244 /* Input node is called when device signals an interrupt. */ \
245 _ (INTERRUPT) \
246 /* Input node is never called. */ \
247 _ (DISABLED)
248
Dave Barach9b8ffd92016-07-08 08:13:45 -0400249typedef enum
250{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700251#define _(f) VLIB_NODE_STATE_##f,
252 foreach_vlib_node_state
253#undef _
Dave Barach9b8ffd92016-07-08 08:13:45 -0400254 VLIB_N_NODE_STATE,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700255} vlib_node_state_t;
256
Dave Barach9b8ffd92016-07-08 08:13:45 -0400257typedef struct vlib_node_t
258{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700259 /* Vector processing function for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400260 vlib_node_function_t *function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700261
262 /* Node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400263 u8 *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700264
265 /* Node name index in elog string table. */
266 u32 name_elog_string;
267
268 /* Total statistics for this node. */
269 vlib_node_stats_t stats_total;
270
271 /* Saved values as of last clear (or zero if never cleared).
272 Current values are always stats_total - stats_last_clear. */
273 vlib_node_stats_t stats_last_clear;
274
275 /* Type of this node. */
276 vlib_node_type_t type;
277
278 /* Node index. */
279 u32 index;
280
281 /* Index of corresponding node runtime. */
282 u32 runtime_index;
283
284 /* Runtime data for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400285 void *runtime_data;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700286
287 /* Node flags. */
288 u16 flags;
289
290 /* Processing function keeps frame. Tells node dispatching code not
291 to free frame after dispatch is done. */
292#define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
293
294 /* Node counts as output/drop/punt node for stats purposes. */
295#define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
296#define VLIB_NODE_FLAG_IS_DROP (1 << 2)
297#define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
298#define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
299
300 /* Set if current node runtime has traced vectors. */
301#define VLIB_NODE_FLAG_TRACE (1 << 5)
302
303#define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
304#define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
Damjan Marion7ca5aaa2019-09-24 18:10:49 +0200305#define VLIB_NODE_FLAG_TRACE_SUPPORTED (1 << 8)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700306
307 /* State for input nodes. */
308 u8 state;
309
310 /* Number of bytes of run time data. */
311 u8 runtime_data_bytes;
312
Dave Barach7fff3d22018-11-27 16:52:59 -0500313 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
314 u8 protocol_hint;
315
Ed Warnickecb9cada2015-12-08 15:45:58 -0700316 /* Number of error codes used by this node. */
317 u16 n_errors;
318
319 /* Size of scalar and vector arguments in bytes. */
320 u16 scalar_size, vector_size;
321
322 /* Handle/index in error heap for this node. */
323 u32 error_heap_handle;
324 u32 error_heap_index;
325
326 /* Error strings indexed by error code for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400327 char **error_strings;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700328
329 /* Vector of next node names.
330 Only used before next_nodes array is initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400331 char **next_node_names;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700332
333 /* Next node indices for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400334 u32 *next_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700335
336 /* Name of node that we are sibling of. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400337 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700338
339 /* Bitmap of all of this node's siblings. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400340 uword *sibling_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700341
342 /* Total number of vectors sent to each next node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400343 u64 *n_vectors_by_next_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700344
345 /* Hash table mapping next node index into slot in
346 next_nodes vector. Quickly determines whether this node
347 is connected to given next node and, if so, with which slot. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400348 uword *next_slot_by_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700349
350 /* Bitmap of node indices which feed this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400351 uword *prev_node_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700352
353 /* Node/next-index which own enqueue rights with to this node. */
354 u32 owner_node_index, owner_next_index;
355
356 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400357 format_function_t *format_buffer;
358 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700359
360 /* Trace buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400361 format_function_t *format_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700362
363 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400364 u8 *(*validate_frame) (struct vlib_main_t * vm,
365 struct vlib_node_runtime_t *,
366 struct vlib_frame_t * f);
Dave Barach6931f592016-05-13 12:55:01 -0400367 /* for pretty-printing, not typically valid */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400368 u8 *state_string;
Damjan Marion69abe442018-08-27 22:43:23 +0200369
370 /* Node function candidate registration with priority */
371 vlib_node_fn_registration_t *node_fn_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700372} vlib_node_t;
373
374#define VLIB_INVALID_NODE_INDEX ((u32) ~0)
375
376/* Max number of vector elements to process at once per node. */
377#define VLIB_FRAME_SIZE 256
Dave Barachd84ba852017-08-22 17:56:46 -0400378#define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
Ed Warnickecb9cada2015-12-08 15:45:58 -0700379
380/* Calling frame (think stack frame) for a node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400381typedef struct vlib_frame_t
382{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700383 /* Frame flags. */
Damjan Marion633b6fd2018-09-14 14:38:53 +0200384 u16 frame_flags;
385
386 /* User flags. Used for sending hints to the next node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700387 u16 flags;
388
389 /* Number of scalar bytes in arguments. */
390 u8 scalar_size;
391
392 /* Number of bytes per vector argument. */
393 u8 vector_size;
394
395 /* Number of vector elements currently in frame. */
396 u16 n_vectors;
397
Ed Warnickecb9cada2015-12-08 15:45:58 -0700398 /* Scalar and vector arguments to next node. */
399 u8 arguments[0];
400} vlib_frame_t;
401
Dave Barach9b8ffd92016-07-08 08:13:45 -0400402typedef struct
403{
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200404 /* Frame pointer. */
405 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700406
407 /* Node runtime for this next. */
408 u32 node_runtime_index;
409
410 /* Next frame flags. */
411 u32 flags;
412
413 /* Reflects node frame-used flag for this next. */
414#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
415 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
416
Damjan Marion296988d2019-02-21 20:24:54 +0100417 /* Don't append this frame */
418#define VLIB_FRAME_NO_APPEND (1 << 14)
419
Ed Warnickecb9cada2015-12-08 15:45:58 -0700420 /* This next frame owns enqueue to node
421 corresponding to node_runtime_index. */
422#define VLIB_FRAME_OWNER (1 << 15)
423
424 /* Set when frame has been allocated for this next. */
425#define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
426
427 /* Set when frame has been added to pending vector. */
428#define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
429
430 /* Set when frame is to be freed after dispatch. */
431#define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
432
433 /* Set when frame has traced packets. */
434#define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
435
436 /* Number of vectors enqueue to this next since last overflow. */
437 u32 vectors_since_last_overflow;
438} vlib_next_frame_t;
439
440always_inline void
441vlib_next_frame_init (vlib_next_frame_t * nf)
442{
Dave Barachb7b92992018-10-17 10:38:51 -0400443 clib_memset (nf, 0, sizeof (nf[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700444 nf->node_runtime_index = ~0;
445}
446
447/* A frame pending dispatch by main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400448typedef struct
449{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700450 /* Node and runtime for this frame. */
451 u32 node_runtime_index;
452
453 /* Frame index (in the heap). */
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200454 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700455
456 /* Start of next frames for this node. */
457 u32 next_frame_index;
458
459 /* Special value for next_frame_index when there is no next frame. */
460#define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
461} vlib_pending_frame_t;
462
Dave Barach9b8ffd92016-07-08 08:13:45 -0400463typedef struct vlib_node_runtime_t
464{
Damjan Marione9f929b2017-03-16 11:32:09 +0100465 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700466
Damjan Marione9f929b2017-03-16 11:32:09 +0100467 vlib_node_function_t *function; /**< Node function to call. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700468
Damjan Marione9f929b2017-03-16 11:32:09 +0100469 vlib_error_t *errors; /**< Vector of errors for this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700470
Damjan Marione9f929b2017-03-16 11:32:09 +0100471 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700472
Damjan Marione9f929b2017-03-16 11:32:09 +0100473 u32 max_clock; /**< Maximum clock cycle for an
474 invocation. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700475
Damjan Marione9f929b2017-03-16 11:32:09 +0100476 u32 max_clock_n; /**< Number of vectors in the recorded
477 max_clock. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700478
Damjan Marione9f929b2017-03-16 11:32:09 +0100479 u32 calls_since_last_overflow; /**< Number of calls. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700480
Damjan Marione9f929b2017-03-16 11:32:09 +0100481 u32 vectors_since_last_overflow; /**< Number of vector elements
482 processed by this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700483
Damjan Marione9f929b2017-03-16 11:32:09 +0100484 u32 next_frame_index; /**< Start of next frames for this
485 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700486
Damjan Marione9f929b2017-03-16 11:32:09 +0100487 u32 node_index; /**< Node index. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700488
Damjan Marione9f929b2017-03-16 11:32:09 +0100489 u32 input_main_loops_per_call; /**< For input nodes: decremented
490 on each main loop interation until
491 it reaches zero and function is
492 called. Allows some input nodes to
493 be called more than others. */
494
495 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
496 dispatch of this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700497
498 u32 main_loop_vector_stats[2];
499
Damjan Marione9f929b2017-03-16 11:32:09 +0100500 u16 flags; /**< Copy of main node flags. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700501
Damjan Marione9f929b2017-03-16 11:32:09 +0100502 u16 state; /**< Input node state. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700503
Damjan Marion1033b492020-06-03 12:20:41 +0200504 u32 interrupt_data; /**< Data passed together with interrupt.
505 Valid only when state is
506 VLIB_NODE_STATE_INTERRUPT */
507
Ed Warnickecb9cada2015-12-08 15:45:58 -0700508 u16 n_next_nodes;
509
Damjan Marione9f929b2017-03-16 11:32:09 +0100510 u16 cached_next_index; /**< Next frame index that vector
511 arguments were last enqueued to
512 last time this node ran. Set to
513 zero before first run of this
514 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700515
Damjan Marion586afd72017-04-05 19:18:20 +0200516 u16 thread_index; /**< thread this node runs on */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700517
Damjan Marione9f929b2017-03-16 11:32:09 +0100518 u8 runtime_data[0]; /**< Function dependent
519 node-runtime data. This data is
520 thread local, and it is not
521 cloned from main thread. It needs
522 to be initialized for each thread
523 before it is used unless
524 runtime_data template exists in
525 vlib_node_t. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400526}
527vlib_node_runtime_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700528
Damjan Marione9f929b2017-03-16 11:32:09 +0100529#define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
530
Dave Barach9b8ffd92016-07-08 08:13:45 -0400531typedef struct
532{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700533 /* Number of allocated frames for this scalar/vector size. */
534 u32 n_alloc_frames;
535
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200536 /* Vector of free frames for this scalar/vector size. */
537 vlib_frame_t **free_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700538} vlib_frame_size_t;
539
Dave Barach9b8ffd92016-07-08 08:13:45 -0400540typedef struct
541{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700542 /* Users opaque value for event type. */
543 uword opaque;
544} vlib_process_event_type_t;
545
Dave Barach9b8ffd92016-07-08 08:13:45 -0400546typedef struct
547{
Damjan Marionef587582020-05-20 22:01:44 +0200548 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700549 /* Node runtime for this process. */
550 vlib_node_runtime_t node_runtime;
551
552 /* Where to longjmp when process is done. */
553 clib_longjmp_t return_longjmp;
554
555#define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
556#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
557
558 /* Where to longjmp to resume node after suspend. */
559 clib_longjmp_t resume_longjmp;
560#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
561#define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
562
563 u16 flags;
564#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
565#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
566 /* Set to indicate that this process has been added to resume vector. */
567#define VLIB_PROCESS_RESUME_PENDING (1 << 2)
568
569 /* Process function is currently running. */
570#define VLIB_PROCESS_IS_RUNNING (1 << 3)
571
572 /* Size of process stack. */
573 u16 log2_n_stack_bytes;
574
575 u32 suspended_process_frame_index;
576
577 /* Number of times this process was suspended. */
578 u32 n_suspends;
579
580 /* Vectors of pending event data indexed by event type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400581 void **pending_event_data_by_type_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700582
583 /* Bitmap of event type-indices with non-empty vectors. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400584 uword *non_empty_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700585
586 /* Bitmap of event type-indices which are one time events. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400587 uword *one_time_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700588
589 /* Type is opaque pointer -- typically a pointer to an event handler
590 function. Hash table to map opaque to a type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400591 uword *event_type_index_by_type_opaque;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700592
593 /* Pool of currently valid event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400594 vlib_process_event_type_t *event_type_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700595
Dave Barach5c20a012017-06-13 08:48:31 -0400596 /*
597 * When suspending saves clock time (10us ticks) when process
598 * is to be resumed.
599 */
600 u64 resume_clock_interval;
601
602 /* Handle from timer code, to cancel an unexpired timer */
603 u32 stop_timer_handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700604
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000605 /* Default output function and its argument for any CLI outputs
606 within the process. */
607 vlib_cli_output_function_t *output_function;
608 uword output_function_arg;
609
Damjan Marionef587582020-05-20 22:01:44 +0200610 /* Process stack */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700611#define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
Damjan Marionef587582020-05-20 22:01:44 +0200612 u32 *stack;
613} vlib_process_t;
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000614
Dave Barach9b8ffd92016-07-08 08:13:45 -0400615typedef struct
616{
617 u32 node_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700618
Dave Barach9b8ffd92016-07-08 08:13:45 -0400619 u32 one_time_event;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700620} vlib_one_time_waiting_process_t;
621
Dave Barach9b8ffd92016-07-08 08:13:45 -0400622typedef struct
623{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700624 u16 n_data_elts;
625
626 u16 n_data_elt_bytes;
627
628 /* n_data_elts * n_data_elt_bytes */
629 u32 n_data_bytes;
630
631 /* Process node & event type to be used to signal event. */
632 u32 process_node_index;
633
634 u32 event_type_index;
635
Dave Barach9b8ffd92016-07-08 08:13:45 -0400636 union
637 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700638 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
639
640 /* Vector of event data used only when data does not fit inline. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400641 u8 *event_data_as_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700642 };
Dave Barach9b8ffd92016-07-08 08:13:45 -0400643}
644vlib_signal_timed_event_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700645
646always_inline uword
647vlib_timing_wheel_data_is_timed_event (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400648{
649 return d & 1;
650}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700651
652always_inline u32
653vlib_timing_wheel_data_set_suspended_process (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400654{
655 return 0 + 2 * i;
656}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700657
658always_inline u32
659vlib_timing_wheel_data_set_timed_event (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400660{
661 return 1 + 2 * i;
662}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700663
664always_inline uword
665vlib_timing_wheel_data_get_index (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400666{
667 return d / 2;
668}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700669
Dave Barach9b8ffd92016-07-08 08:13:45 -0400670typedef struct
671{
Damjan Marion1033b492020-06-03 12:20:41 +0200672 u32 node_runtime_index;
673 u32 data;
674} vlib_node_interrupt_t;
675
676typedef struct
677{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700678 /* Public nodes. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400679 vlib_node_t **nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700680
681 /* Node index hashed by node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400682 uword *node_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700683
684 u32 flags;
685#define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
686
687 /* Nodes segregated by type for cache locality.
688 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400689 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700690
691 /* Node runtime indices for input nodes with pending interrupts. */
Damjan Marion1033b492020-06-03 12:20:41 +0200692 vlib_node_interrupt_t *pending_local_interrupts;
693 vlib_node_interrupt_t *pending_remote_interrupts;
BenoƮt Ganned25147d2020-06-30 18:17:06 +0200694 volatile u32 *pending_remote_interrupts_notify;
Damjan Marion2c2b6402017-03-28 14:16:15 +0200695 clib_spinlock_t pending_interrupt_lock;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700696
697 /* Input nodes are switched from/to interrupt to/from polling mode
698 when average vector length goes above/below polling/interrupt
699 thresholds. */
700 u32 polling_threshold_vector_length;
701 u32 interrupt_threshold_vector_length;
702
703 /* Vector of next frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400704 vlib_next_frame_t *next_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700705
706 /* Vector of internal node's frames waiting to be called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400707 vlib_pending_frame_t *pending_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700708
709 /* Timing wheel for scheduling time-based node dispatch. */
Dave Barach5c20a012017-06-13 08:48:31 -0400710 void *timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700711
Dave Barach9b8ffd92016-07-08 08:13:45 -0400712 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700713
714 /* Opaque data vector added via timing_wheel_advance. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400715 u32 *data_from_advancing_timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700716
717 /* CPU time of next process to be ready on timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -0400718 f64 time_next_process_ready;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700719
720 /* Vector of process nodes.
721 One for each node of type VLIB_NODE_TYPE_PROCESS. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400722 vlib_process_t **processes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700723
724 /* Current running process or ~0 if no process running. */
725 u32 current_process_index;
726
727 /* Pool of pending process frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400728 vlib_pending_frame_t *suspended_process_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700729
730 /* Vector of event data vectors pending recycle. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400731 void **recycled_event_data_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700732
733 /* Current counts of nodes in each state. */
734 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
735
736 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400737 uword *frame_size_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700738
739 /* Per-size frame allocation information. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400740 vlib_frame_size_t *frame_sizes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700741
742 /* Time of last node runtime stats clear. */
743 f64 time_last_runtime_stats_clear;
744
745 /* Node registrations added by constructors */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400746 vlib_node_registration_t *node_registrations;
Dave Barach687c9022019-07-23 10:22:31 -0400747
748 /* Node index from error code */
749 u32 *node_by_error;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700750} vlib_node_main_t;
751
Dave Barach687c9022019-07-23 10:22:31 -0400752typedef u16 vlib_error_t;
753
754always_inline u32
755vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
756{
757 return nm->node_by_error[e];
758}
759
760always_inline u32
761vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
762{
763 u32 node_index = nm->node_by_error[e];
764 vlib_node_t *n = nm->nodes[node_index];
765 u32 error_code = e - n->error_heap_index;
766 return error_code;
767}
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200768
dongjuan88752482019-06-04 10:59:02 +0800769#define FRAME_QUEUE_MAX_NELTS 64
Dave Barach9b8ffd92016-07-08 08:13:45 -0400770typedef struct
771{
772 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200773 u64 head;
774 u64 head_hint;
775 u64 tail;
776 u32 n_in_use;
777 u32 nelts;
778 u32 written;
779 u32 threshold;
780 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
781} frame_queue_trace_t;
782
Dave Barach9b8ffd92016-07-08 08:13:45 -0400783typedef struct
784{
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200785 u64 count[FRAME_QUEUE_MAX_NELTS];
786} frame_queue_nelt_counter_t;
787
Ed Warnickecb9cada2015-12-08 15:45:58 -0700788#endif /* included_vlib_node_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400789
790/*
791 * fd.io coding-style-patch-verification: ON
792 *
793 * Local Variables:
794 * eval: (c-set-style "gnu")
795 * End:
796 */