blob: 9c4cadd56f76acdaf46ab63d86aad6f251ae0ae5 [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;
Dave Barachec595ef2019-01-24 10:34:24 -0500238 u64 perf_counter0_ticks;
239 u64 perf_counter1_ticks;
Dave Barach4d1a8662018-09-10 12:31:15 -0400240 u64 perf_counter_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700241} vlib_node_stats_t;
242
243#define foreach_vlib_node_state \
244 /* Input node is called each iteration of main loop. \
245 This is the default (zero). */ \
246 _ (POLLING) \
247 /* Input node is called when device signals an interrupt. */ \
248 _ (INTERRUPT) \
249 /* Input node is never called. */ \
250 _ (DISABLED)
251
Dave Barach9b8ffd92016-07-08 08:13:45 -0400252typedef enum
253{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700254#define _(f) VLIB_NODE_STATE_##f,
255 foreach_vlib_node_state
256#undef _
Dave Barach9b8ffd92016-07-08 08:13:45 -0400257 VLIB_N_NODE_STATE,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700258} vlib_node_state_t;
259
Dave Barach9b8ffd92016-07-08 08:13:45 -0400260typedef struct vlib_node_t
261{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700262 /* Vector processing function for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400263 vlib_node_function_t *function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700264
265 /* Node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400266 u8 *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700267
268 /* Node name index in elog string table. */
269 u32 name_elog_string;
270
271 /* Total statistics for this node. */
272 vlib_node_stats_t stats_total;
273
274 /* Saved values as of last clear (or zero if never cleared).
275 Current values are always stats_total - stats_last_clear. */
276 vlib_node_stats_t stats_last_clear;
277
278 /* Type of this node. */
279 vlib_node_type_t type;
280
281 /* Node index. */
282 u32 index;
283
284 /* Index of corresponding node runtime. */
285 u32 runtime_index;
286
287 /* Runtime data for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400288 void *runtime_data;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700289
290 /* Node flags. */
291 u16 flags;
292
293 /* Processing function keeps frame. Tells node dispatching code not
294 to free frame after dispatch is done. */
295#define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
296
297 /* Node counts as output/drop/punt node for stats purposes. */
298#define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
299#define VLIB_NODE_FLAG_IS_DROP (1 << 2)
300#define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
301#define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
302
303 /* Set if current node runtime has traced vectors. */
304#define VLIB_NODE_FLAG_TRACE (1 << 5)
305
306#define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
307#define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
Damjan Marion7ca5aaa2019-09-24 18:10:49 +0200308#define VLIB_NODE_FLAG_TRACE_SUPPORTED (1 << 8)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700309
310 /* State for input nodes. */
311 u8 state;
312
313 /* Number of bytes of run time data. */
314 u8 runtime_data_bytes;
315
Dave Barach7fff3d22018-11-27 16:52:59 -0500316 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
317 u8 protocol_hint;
318
Ed Warnickecb9cada2015-12-08 15:45:58 -0700319 /* Number of error codes used by this node. */
320 u16 n_errors;
321
322 /* Size of scalar and vector arguments in bytes. */
323 u16 scalar_size, vector_size;
324
325 /* Handle/index in error heap for this node. */
326 u32 error_heap_handle;
327 u32 error_heap_index;
328
329 /* Error strings indexed by error code for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400330 char **error_strings;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700331
332 /* Vector of next node names.
333 Only used before next_nodes array is initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400334 char **next_node_names;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700335
336 /* Next node indices for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400337 u32 *next_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700338
339 /* Name of node that we are sibling of. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400340 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700341
342 /* Bitmap of all of this node's siblings. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400343 uword *sibling_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700344
345 /* Total number of vectors sent to each next node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400346 u64 *n_vectors_by_next_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700347
348 /* Hash table mapping next node index into slot in
349 next_nodes vector. Quickly determines whether this node
350 is connected to given next node and, if so, with which slot. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400351 uword *next_slot_by_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700352
353 /* Bitmap of node indices which feed this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400354 uword *prev_node_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700355
356 /* Node/next-index which own enqueue rights with to this node. */
357 u32 owner_node_index, owner_next_index;
358
359 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400360 format_function_t *format_buffer;
361 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700362
363 /* Trace buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400364 format_function_t *format_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700365
366 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400367 u8 *(*validate_frame) (struct vlib_main_t * vm,
368 struct vlib_node_runtime_t *,
369 struct vlib_frame_t * f);
Dave Barach6931f592016-05-13 12:55:01 -0400370 /* for pretty-printing, not typically valid */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400371 u8 *state_string;
Damjan Marion69abe442018-08-27 22:43:23 +0200372
373 /* Node function candidate registration with priority */
374 vlib_node_fn_registration_t *node_fn_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700375} vlib_node_t;
376
377#define VLIB_INVALID_NODE_INDEX ((u32) ~0)
378
379/* Max number of vector elements to process at once per node. */
380#define VLIB_FRAME_SIZE 256
Dave Barachd84ba852017-08-22 17:56:46 -0400381#define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
Ed Warnickecb9cada2015-12-08 15:45:58 -0700382
383/* Calling frame (think stack frame) for a node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400384typedef struct vlib_frame_t
385{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700386 /* Frame flags. */
Damjan Marion633b6fd2018-09-14 14:38:53 +0200387 u16 frame_flags;
388
389 /* User flags. Used for sending hints to the next node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700390 u16 flags;
391
392 /* Number of scalar bytes in arguments. */
393 u8 scalar_size;
394
395 /* Number of bytes per vector argument. */
396 u8 vector_size;
397
398 /* Number of vector elements currently in frame. */
399 u16 n_vectors;
400
Ed Warnickecb9cada2015-12-08 15:45:58 -0700401 /* Scalar and vector arguments to next node. */
402 u8 arguments[0];
403} vlib_frame_t;
404
Dave Barach9b8ffd92016-07-08 08:13:45 -0400405typedef struct
406{
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200407 /* Frame pointer. */
408 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700409
410 /* Node runtime for this next. */
411 u32 node_runtime_index;
412
413 /* Next frame flags. */
414 u32 flags;
415
416 /* Reflects node frame-used flag for this next. */
417#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
418 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
419
Damjan Marion296988d2019-02-21 20:24:54 +0100420 /* Don't append this frame */
421#define VLIB_FRAME_NO_APPEND (1 << 14)
422
Ed Warnickecb9cada2015-12-08 15:45:58 -0700423 /* This next frame owns enqueue to node
424 corresponding to node_runtime_index. */
425#define VLIB_FRAME_OWNER (1 << 15)
426
427 /* Set when frame has been allocated for this next. */
428#define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
429
430 /* Set when frame has been added to pending vector. */
431#define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
432
433 /* Set when frame is to be freed after dispatch. */
434#define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
435
436 /* Set when frame has traced packets. */
437#define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
438
439 /* Number of vectors enqueue to this next since last overflow. */
440 u32 vectors_since_last_overflow;
441} vlib_next_frame_t;
442
443always_inline void
444vlib_next_frame_init (vlib_next_frame_t * nf)
445{
Dave Barachb7b92992018-10-17 10:38:51 -0400446 clib_memset (nf, 0, sizeof (nf[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700447 nf->node_runtime_index = ~0;
448}
449
450/* A frame pending dispatch by main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400451typedef struct
452{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700453 /* Node and runtime for this frame. */
454 u32 node_runtime_index;
455
456 /* Frame index (in the heap). */
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200457 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700458
459 /* Start of next frames for this node. */
460 u32 next_frame_index;
461
462 /* Special value for next_frame_index when there is no next frame. */
463#define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
464} vlib_pending_frame_t;
465
Dave Barach9b8ffd92016-07-08 08:13:45 -0400466typedef struct vlib_node_runtime_t
467{
Damjan Marione9f929b2017-03-16 11:32:09 +0100468 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700469
Damjan Marione9f929b2017-03-16 11:32:09 +0100470 vlib_node_function_t *function; /**< Node function to call. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700471
Damjan Marione9f929b2017-03-16 11:32:09 +0100472 vlib_error_t *errors; /**< Vector of errors for this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700473
Damjan Marione9f929b2017-03-16 11:32:09 +0100474 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700475
Damjan Marione9f929b2017-03-16 11:32:09 +0100476 u32 max_clock; /**< Maximum clock cycle for an
477 invocation. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700478
Damjan Marione9f929b2017-03-16 11:32:09 +0100479 u32 max_clock_n; /**< Number of vectors in the recorded
480 max_clock. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700481
Damjan Marione9f929b2017-03-16 11:32:09 +0100482 u32 calls_since_last_overflow; /**< Number of calls. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700483
Damjan Marione9f929b2017-03-16 11:32:09 +0100484 u32 vectors_since_last_overflow; /**< Number of vector elements
485 processed by this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700486
Dave Barachec595ef2019-01-24 10:34:24 -0500487 u32 perf_counter0_ticks_since_last_overflow; /**< Perf counter 0 ticks */
488 u32 perf_counter1_ticks_since_last_overflow; /**< Perf counter 1 ticks */
Dave Barach4d1a8662018-09-10 12:31:15 -0400489 u32 perf_counter_vectors_since_last_overflow; /**< Perf counter vectors */
490
Damjan Marione9f929b2017-03-16 11:32:09 +0100491 u32 next_frame_index; /**< Start of next frames for this
492 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700493
Damjan Marione9f929b2017-03-16 11:32:09 +0100494 u32 node_index; /**< Node index. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700495
Damjan Marione9f929b2017-03-16 11:32:09 +0100496 u32 input_main_loops_per_call; /**< For input nodes: decremented
497 on each main loop interation until
498 it reaches zero and function is
499 called. Allows some input nodes to
500 be called more than others. */
501
502 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
503 dispatch of this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700504
505 u32 main_loop_vector_stats[2];
506
Damjan Marione9f929b2017-03-16 11:32:09 +0100507 u16 flags; /**< Copy of main node flags. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700508
Damjan Marione9f929b2017-03-16 11:32:09 +0100509 u16 state; /**< Input node state. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700510
Damjan Marion1033b492020-06-03 12:20:41 +0200511 u32 interrupt_data; /**< Data passed together with interrupt.
512 Valid only when state is
513 VLIB_NODE_STATE_INTERRUPT */
514
Ed Warnickecb9cada2015-12-08 15:45:58 -0700515 u16 n_next_nodes;
516
Damjan Marione9f929b2017-03-16 11:32:09 +0100517 u16 cached_next_index; /**< Next frame index that vector
518 arguments were last enqueued to
519 last time this node ran. Set to
520 zero before first run of this
521 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700522
Damjan Marion586afd72017-04-05 19:18:20 +0200523 u16 thread_index; /**< thread this node runs on */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700524
Damjan Marione9f929b2017-03-16 11:32:09 +0100525 u8 runtime_data[0]; /**< Function dependent
526 node-runtime data. This data is
527 thread local, and it is not
528 cloned from main thread. It needs
529 to be initialized for each thread
530 before it is used unless
531 runtime_data template exists in
532 vlib_node_t. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400533}
534vlib_node_runtime_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700535
Damjan Marione9f929b2017-03-16 11:32:09 +0100536#define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
537
Dave Barach9b8ffd92016-07-08 08:13:45 -0400538typedef struct
539{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700540 /* Number of allocated frames for this scalar/vector size. */
541 u32 n_alloc_frames;
542
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200543 /* Vector of free frames for this scalar/vector size. */
544 vlib_frame_t **free_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700545} vlib_frame_size_t;
546
Dave Barach9b8ffd92016-07-08 08:13:45 -0400547typedef struct
548{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700549 /* Users opaque value for event type. */
550 uword opaque;
551} vlib_process_event_type_t;
552
Dave Barach9b8ffd92016-07-08 08:13:45 -0400553typedef struct
554{
Damjan Marionef587582020-05-20 22:01:44 +0200555 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700556 /* Node runtime for this process. */
557 vlib_node_runtime_t node_runtime;
558
559 /* Where to longjmp when process is done. */
560 clib_longjmp_t return_longjmp;
561
562#define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
563#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
564
565 /* Where to longjmp to resume node after suspend. */
566 clib_longjmp_t resume_longjmp;
567#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
568#define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
569
570 u16 flags;
571#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
572#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
573 /* Set to indicate that this process has been added to resume vector. */
574#define VLIB_PROCESS_RESUME_PENDING (1 << 2)
575
576 /* Process function is currently running. */
577#define VLIB_PROCESS_IS_RUNNING (1 << 3)
578
579 /* Size of process stack. */
580 u16 log2_n_stack_bytes;
581
582 u32 suspended_process_frame_index;
583
584 /* Number of times this process was suspended. */
585 u32 n_suspends;
586
587 /* Vectors of pending event data indexed by event type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400588 void **pending_event_data_by_type_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700589
590 /* Bitmap of event type-indices with non-empty vectors. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400591 uword *non_empty_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700592
593 /* Bitmap of event type-indices which are one time events. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400594 uword *one_time_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700595
596 /* Type is opaque pointer -- typically a pointer to an event handler
597 function. Hash table to map opaque to a type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400598 uword *event_type_index_by_type_opaque;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700599
600 /* Pool of currently valid event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400601 vlib_process_event_type_t *event_type_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700602
Dave Barach5c20a012017-06-13 08:48:31 -0400603 /*
604 * When suspending saves clock time (10us ticks) when process
605 * is to be resumed.
606 */
607 u64 resume_clock_interval;
608
609 /* Handle from timer code, to cancel an unexpired timer */
610 u32 stop_timer_handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700611
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000612 /* Default output function and its argument for any CLI outputs
613 within the process. */
614 vlib_cli_output_function_t *output_function;
615 uword output_function_arg;
616
Damjan Marionef587582020-05-20 22:01:44 +0200617 /* Process stack */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700618#define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
Damjan Marionef587582020-05-20 22:01:44 +0200619 u32 *stack;
620} vlib_process_t;
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000621
Dave Barach9b8ffd92016-07-08 08:13:45 -0400622typedef struct
623{
624 u32 node_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700625
Dave Barach9b8ffd92016-07-08 08:13:45 -0400626 u32 one_time_event;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700627} vlib_one_time_waiting_process_t;
628
Dave Barach9b8ffd92016-07-08 08:13:45 -0400629typedef struct
630{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700631 u16 n_data_elts;
632
633 u16 n_data_elt_bytes;
634
635 /* n_data_elts * n_data_elt_bytes */
636 u32 n_data_bytes;
637
638 /* Process node & event type to be used to signal event. */
639 u32 process_node_index;
640
641 u32 event_type_index;
642
Dave Barach9b8ffd92016-07-08 08:13:45 -0400643 union
644 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700645 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
646
647 /* Vector of event data used only when data does not fit inline. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400648 u8 *event_data_as_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700649 };
Dave Barach9b8ffd92016-07-08 08:13:45 -0400650}
651vlib_signal_timed_event_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700652
653always_inline uword
654vlib_timing_wheel_data_is_timed_event (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400655{
656 return d & 1;
657}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700658
659always_inline u32
660vlib_timing_wheel_data_set_suspended_process (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400661{
662 return 0 + 2 * i;
663}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700664
665always_inline u32
666vlib_timing_wheel_data_set_timed_event (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400667{
668 return 1 + 2 * i;
669}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700670
671always_inline uword
672vlib_timing_wheel_data_get_index (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400673{
674 return d / 2;
675}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700676
Dave Barach9b8ffd92016-07-08 08:13:45 -0400677typedef struct
678{
Damjan Marion1033b492020-06-03 12:20:41 +0200679 u32 node_runtime_index;
680 u32 data;
681} vlib_node_interrupt_t;
682
683typedef struct
684{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700685 /* Public nodes. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400686 vlib_node_t **nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700687
688 /* Node index hashed by node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400689 uword *node_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700690
691 u32 flags;
692#define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
693
694 /* Nodes segregated by type for cache locality.
695 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400696 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700697
698 /* Node runtime indices for input nodes with pending interrupts. */
Damjan Marion1033b492020-06-03 12:20:41 +0200699 vlib_node_interrupt_t *pending_local_interrupts;
700 vlib_node_interrupt_t *pending_remote_interrupts;
BenoƮt Ganned25147d2020-06-30 18:17:06 +0200701 volatile u32 *pending_remote_interrupts_notify;
Damjan Marion2c2b6402017-03-28 14:16:15 +0200702 clib_spinlock_t pending_interrupt_lock;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700703
704 /* Input nodes are switched from/to interrupt to/from polling mode
705 when average vector length goes above/below polling/interrupt
706 thresholds. */
707 u32 polling_threshold_vector_length;
708 u32 interrupt_threshold_vector_length;
709
710 /* Vector of next frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400711 vlib_next_frame_t *next_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700712
713 /* Vector of internal node's frames waiting to be called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400714 vlib_pending_frame_t *pending_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700715
716 /* Timing wheel for scheduling time-based node dispatch. */
Dave Barach5c20a012017-06-13 08:48:31 -0400717 void *timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700718
Dave Barach9b8ffd92016-07-08 08:13:45 -0400719 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700720
721 /* Opaque data vector added via timing_wheel_advance. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400722 u32 *data_from_advancing_timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700723
724 /* CPU time of next process to be ready on timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -0400725 f64 time_next_process_ready;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700726
727 /* Vector of process nodes.
728 One for each node of type VLIB_NODE_TYPE_PROCESS. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400729 vlib_process_t **processes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700730
731 /* Current running process or ~0 if no process running. */
732 u32 current_process_index;
733
734 /* Pool of pending process frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400735 vlib_pending_frame_t *suspended_process_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700736
737 /* Vector of event data vectors pending recycle. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400738 void **recycled_event_data_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700739
740 /* Current counts of nodes in each state. */
741 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
742
743 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400744 uword *frame_size_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700745
746 /* Per-size frame allocation information. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400747 vlib_frame_size_t *frame_sizes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700748
749 /* Time of last node runtime stats clear. */
750 f64 time_last_runtime_stats_clear;
751
752 /* Node registrations added by constructors */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400753 vlib_node_registration_t *node_registrations;
Dave Barach687c9022019-07-23 10:22:31 -0400754
755 /* Node index from error code */
756 u32 *node_by_error;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700757} vlib_node_main_t;
758
Dave Barach687c9022019-07-23 10:22:31 -0400759typedef u16 vlib_error_t;
760
761always_inline u32
762vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
763{
764 return nm->node_by_error[e];
765}
766
767always_inline u32
768vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
769{
770 u32 node_index = nm->node_by_error[e];
771 vlib_node_t *n = nm->nodes[node_index];
772 u32 error_code = e - n->error_heap_index;
773 return error_code;
774}
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200775
dongjuan88752482019-06-04 10:59:02 +0800776#define FRAME_QUEUE_MAX_NELTS 64
Dave Barach9b8ffd92016-07-08 08:13:45 -0400777typedef struct
778{
779 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200780 u64 head;
781 u64 head_hint;
782 u64 tail;
783 u32 n_in_use;
784 u32 nelts;
785 u32 written;
786 u32 threshold;
787 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
788} frame_queue_trace_t;
789
Dave Barach9b8ffd92016-07-08 08:13:45 -0400790typedef struct
791{
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200792 u64 count[FRAME_QUEUE_MAX_NELTS];
793} frame_queue_nelt_counter_t;
794
Ed Warnickecb9cada2015-12-08 15:45:58 -0700795#endif /* included_vlib_node_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400796
797/*
798 * fd.io coding-style-patch-verification: ON
799 *
800 * Local Variables:
801 * eval: (c-set-style "gnu")
802 * End:
803 */