blob: bec0ed2d2c02f56b0421d573433965795cbb7dde [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,...) \
190static __clib_unused vlib_node_registration_t __clib_unused_##x
191#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700192
Damjan Marion69abe442018-08-27 22:43:23 +0200193#ifndef CLIB_MARCH_VARIANT
194#define CLIB_MARCH_VARIANT_STR "default"
195#else
196#define _CLIB_MARCH_VARIANT_STR(s) __CLIB_MARCH_VARIANT_STR(s)
197#define __CLIB_MARCH_VARIANT_STR(s) #s
198#define CLIB_MARCH_VARIANT_STR _CLIB_MARCH_VARIANT_STR(CLIB_MARCH_VARIANT)
199#endif
200
Damjan Marion812b32d2018-05-28 21:26:47 +0200201#define VLIB_NODE_FN(node) \
202uword CLIB_MARCH_SFX (node##_fn)(); \
203static vlib_node_fn_registration_t \
204 CLIB_MARCH_SFX(node##_fn_registration) = \
205 { .function = &CLIB_MARCH_SFX (node##_fn), }; \
206 \
207static void __clib_constructor \
208CLIB_MARCH_SFX (node##_multiarch_register) (void) \
209{ \
210 extern vlib_node_registration_t node; \
211 vlib_node_fn_registration_t *r; \
212 r = & CLIB_MARCH_SFX (node##_fn_registration); \
213 r->priority = CLIB_MARCH_FN_PRIORITY(); \
Damjan Marion69abe442018-08-27 22:43:23 +0200214 r->name = CLIB_MARCH_VARIANT_STR; \
Damjan Marion812b32d2018-05-28 21:26:47 +0200215 r->next_registration = node.node_fn_registrations; \
216 node.node_fn_registrations = r; \
217} \
218uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (node##_fn)
219
Ed Warnickecb9cada2015-12-08 15:45:58 -0700220always_inline vlib_node_registration_t *
221vlib_node_next_registered (vlib_node_registration_t * c)
222{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400223 c =
224 clib_elf_section_data_next (c,
225 c->n_next_nodes * sizeof (c->next_nodes[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700226 return c;
227}
228
Dave Barach9b8ffd92016-07-08 08:13:45 -0400229typedef struct
230{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700231 /* Total calls, clock ticks and vector elements processed for this node. */
232 u64 calls, vectors, clocks, suspends;
233 u64 max_clock;
234 u64 max_clock_n;
Dave Barachec595ef2019-01-24 10:34:24 -0500235 u64 perf_counter0_ticks;
236 u64 perf_counter1_ticks;
Dave Barach4d1a8662018-09-10 12:31:15 -0400237 u64 perf_counter_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700238} 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)
305
306 /* State for input nodes. */
307 u8 state;
308
309 /* Number of bytes of run time data. */
310 u8 runtime_data_bytes;
311
Dave Barach7fff3d22018-11-27 16:52:59 -0500312 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
313 u8 protocol_hint;
314
Ed Warnickecb9cada2015-12-08 15:45:58 -0700315 /* Number of error codes used by this node. */
316 u16 n_errors;
317
318 /* Size of scalar and vector arguments in bytes. */
319 u16 scalar_size, vector_size;
320
321 /* Handle/index in error heap for this node. */
322 u32 error_heap_handle;
323 u32 error_heap_index;
324
325 /* Error strings indexed by error code for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400326 char **error_strings;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700327
328 /* Vector of next node names.
329 Only used before next_nodes array is initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400330 char **next_node_names;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700331
332 /* Next node indices for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400333 u32 *next_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700334
335 /* Name of node that we are sibling of. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400336 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700337
338 /* Bitmap of all of this node's siblings. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400339 uword *sibling_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700340
341 /* Total number of vectors sent to each next node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400342 u64 *n_vectors_by_next_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700343
344 /* Hash table mapping next node index into slot in
345 next_nodes vector. Quickly determines whether this node
346 is connected to given next node and, if so, with which slot. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400347 uword *next_slot_by_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700348
349 /* Bitmap of node indices which feed this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400350 uword *prev_node_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700351
352 /* Node/next-index which own enqueue rights with to this node. */
353 u32 owner_node_index, owner_next_index;
354
355 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400356 format_function_t *format_buffer;
357 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700358
359 /* Trace buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400360 format_function_t *format_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700361
362 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400363 u8 *(*validate_frame) (struct vlib_main_t * vm,
364 struct vlib_node_runtime_t *,
365 struct vlib_frame_t * f);
Dave Barach6931f592016-05-13 12:55:01 -0400366 /* for pretty-printing, not typically valid */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400367 u8 *state_string;
Damjan Marion69abe442018-08-27 22:43:23 +0200368
369 /* Node function candidate registration with priority */
370 vlib_node_fn_registration_t *node_fn_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700371} vlib_node_t;
372
373#define VLIB_INVALID_NODE_INDEX ((u32) ~0)
374
375/* Max number of vector elements to process at once per node. */
376#define VLIB_FRAME_SIZE 256
Dave Barachd84ba852017-08-22 17:56:46 -0400377#define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
Ed Warnickecb9cada2015-12-08 15:45:58 -0700378
379/* Calling frame (think stack frame) for a node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400380typedef struct vlib_frame_t
381{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700382 /* Frame flags. */
Damjan Marion633b6fd2018-09-14 14:38:53 +0200383 u16 frame_flags;
384
385 /* User flags. Used for sending hints to the next node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700386 u16 flags;
387
388 /* Number of scalar bytes in arguments. */
389 u8 scalar_size;
390
391 /* Number of bytes per vector argument. */
392 u8 vector_size;
393
394 /* Number of vector elements currently in frame. */
395 u16 n_vectors;
396
Ed Warnickecb9cada2015-12-08 15:45:58 -0700397 /* Scalar and vector arguments to next node. */
398 u8 arguments[0];
399} vlib_frame_t;
400
Dave Barach9b8ffd92016-07-08 08:13:45 -0400401typedef struct
402{
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200403 /* Frame pointer. */
404 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700405
406 /* Node runtime for this next. */
407 u32 node_runtime_index;
408
409 /* Next frame flags. */
410 u32 flags;
411
412 /* Reflects node frame-used flag for this next. */
413#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
414 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
415
Damjan Marion296988d2019-02-21 20:24:54 +0100416 /* Don't append this frame */
417#define VLIB_FRAME_NO_APPEND (1 << 14)
418
Ed Warnickecb9cada2015-12-08 15:45:58 -0700419 /* This next frame owns enqueue to node
420 corresponding to node_runtime_index. */
421#define VLIB_FRAME_OWNER (1 << 15)
422
423 /* Set when frame has been allocated for this next. */
424#define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
425
426 /* Set when frame has been added to pending vector. */
427#define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
428
429 /* Set when frame is to be freed after dispatch. */
430#define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
431
432 /* Set when frame has traced packets. */
433#define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
434
435 /* Number of vectors enqueue to this next since last overflow. */
436 u32 vectors_since_last_overflow;
437} vlib_next_frame_t;
438
439always_inline void
440vlib_next_frame_init (vlib_next_frame_t * nf)
441{
Dave Barachb7b92992018-10-17 10:38:51 -0400442 clib_memset (nf, 0, sizeof (nf[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700443 nf->node_runtime_index = ~0;
444}
445
446/* A frame pending dispatch by main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400447typedef struct
448{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700449 /* Node and runtime for this frame. */
450 u32 node_runtime_index;
451
452 /* Frame index (in the heap). */
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200453 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700454
455 /* Start of next frames for this node. */
456 u32 next_frame_index;
457
458 /* Special value for next_frame_index when there is no next frame. */
459#define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
460} vlib_pending_frame_t;
461
Dave Barach9b8ffd92016-07-08 08:13:45 -0400462typedef struct vlib_node_runtime_t
463{
Damjan Marione9f929b2017-03-16 11:32:09 +0100464 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700465
Damjan Marione9f929b2017-03-16 11:32:09 +0100466 vlib_node_function_t *function; /**< Node function to call. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700467
Damjan Marione9f929b2017-03-16 11:32:09 +0100468 vlib_error_t *errors; /**< Vector of errors for this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700469
Damjan Marion36c13082017-04-24 20:58:29 +0200470#if __SIZEOF_POINTER__ == 4
471 u8 pad[8];
472#endif
473
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
511 u16 n_next_nodes;
512
Damjan Marione9f929b2017-03-16 11:32:09 +0100513 u16 cached_next_index; /**< Next frame index that vector
514 arguments were last enqueued to
515 last time this node ran. Set to
516 zero before first run of this
517 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700518
Damjan Marion586afd72017-04-05 19:18:20 +0200519 u16 thread_index; /**< thread this node runs on */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700520
Damjan Marione9f929b2017-03-16 11:32:09 +0100521 u8 runtime_data[0]; /**< Function dependent
522 node-runtime data. This data is
523 thread local, and it is not
524 cloned from main thread. It needs
525 to be initialized for each thread
526 before it is used unless
527 runtime_data template exists in
528 vlib_node_t. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400529}
530vlib_node_runtime_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700531
Damjan Marione9f929b2017-03-16 11:32:09 +0100532#define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
533
Dave Barach9b8ffd92016-07-08 08:13:45 -0400534typedef struct
535{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700536 /* Number of allocated frames for this scalar/vector size. */
537 u32 n_alloc_frames;
538
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200539 /* Vector of free frames for this scalar/vector size. */
540 vlib_frame_t **free_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700541} vlib_frame_size_t;
542
Dave Barach9b8ffd92016-07-08 08:13:45 -0400543typedef struct
544{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700545 /* Users opaque value for event type. */
546 uword opaque;
547} vlib_process_event_type_t;
548
Dave Barach9b8ffd92016-07-08 08:13:45 -0400549typedef struct
550{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700551 /* Node runtime for this process. */
552 vlib_node_runtime_t node_runtime;
553
554 /* Where to longjmp when process is done. */
555 clib_longjmp_t return_longjmp;
556
557#define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
558#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
559
560 /* Where to longjmp to resume node after suspend. */
561 clib_longjmp_t resume_longjmp;
562#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
563#define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
564
565 u16 flags;
566#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
567#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
568 /* Set to indicate that this process has been added to resume vector. */
569#define VLIB_PROCESS_RESUME_PENDING (1 << 2)
570
571 /* Process function is currently running. */
572#define VLIB_PROCESS_IS_RUNNING (1 << 3)
573
574 /* Size of process stack. */
575 u16 log2_n_stack_bytes;
576
577 u32 suspended_process_frame_index;
578
579 /* Number of times this process was suspended. */
580 u32 n_suspends;
581
582 /* Vectors of pending event data indexed by event type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400583 void **pending_event_data_by_type_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700584
585 /* Bitmap of event type-indices with non-empty vectors. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400586 uword *non_empty_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700587
588 /* Bitmap of event type-indices which are one time events. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400589 uword *one_time_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700590
591 /* Type is opaque pointer -- typically a pointer to an event handler
592 function. Hash table to map opaque to a type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400593 uword *event_type_index_by_type_opaque;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700594
595 /* Pool of currently valid event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400596 vlib_process_event_type_t *event_type_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700597
Dave Barach5c20a012017-06-13 08:48:31 -0400598 /*
599 * When suspending saves clock time (10us ticks) when process
600 * is to be resumed.
601 */
602 u64 resume_clock_interval;
603
604 /* Handle from timer code, to cancel an unexpired timer */
605 u32 stop_timer_handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700606
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000607 /* Default output function and its argument for any CLI outputs
608 within the process. */
609 vlib_cli_output_function_t *output_function;
610 uword output_function_arg;
611
Ed Warnickecb9cada2015-12-08 15:45:58 -0700612#ifdef CLIB_UNIX
613 /* Pad to a multiple of the page size so we can mprotect process stacks */
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000614#define PAGE_SIZE_MULTIPLE 0x1000
615#define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT __attribute__ ((aligned (PAGE_SIZE_MULTIPLE)))
616#else
617#define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT
Ed Warnickecb9cada2015-12-08 15:45:58 -0700618#endif
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000619
Ed Warnickecb9cada2015-12-08 15:45:58 -0700620 /* Process stack. Starts here and extends 2^log2_n_stack_bytes
621 bytes. */
622
623#define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000624 u32 stack[0] ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700625} vlib_process_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
626
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000627#ifdef CLIB_UNIX
628 /* Ensure that the stack is aligned on the multiple of the page size */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400629typedef char
630 assert_process_stack_must_be_aligned_exactly_to_page_size_multiple[(sizeof
631 (vlib_process_t)
632 -
633 PAGE_SIZE_MULTIPLE)
634 ==
635 0 ? 0 :
636 -1];
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000637#endif
638
Dave Barach9b8ffd92016-07-08 08:13:45 -0400639typedef struct
640{
641 u32 node_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700642
Dave Barach9b8ffd92016-07-08 08:13:45 -0400643 u32 one_time_event;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700644} vlib_one_time_waiting_process_t;
645
Dave Barach9b8ffd92016-07-08 08:13:45 -0400646typedef struct
647{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700648 u16 n_data_elts;
649
650 u16 n_data_elt_bytes;
651
652 /* n_data_elts * n_data_elt_bytes */
653 u32 n_data_bytes;
654
655 /* Process node & event type to be used to signal event. */
656 u32 process_node_index;
657
658 u32 event_type_index;
659
Dave Barach9b8ffd92016-07-08 08:13:45 -0400660 union
661 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700662 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
663
664 /* Vector of event data used only when data does not fit inline. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400665 u8 *event_data_as_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700666 };
Dave Barach9b8ffd92016-07-08 08:13:45 -0400667}
668vlib_signal_timed_event_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700669
670always_inline uword
671vlib_timing_wheel_data_is_timed_event (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400672{
673 return d & 1;
674}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700675
676always_inline u32
677vlib_timing_wheel_data_set_suspended_process (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400678{
679 return 0 + 2 * i;
680}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700681
682always_inline u32
683vlib_timing_wheel_data_set_timed_event (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400684{
685 return 1 + 2 * i;
686}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700687
688always_inline uword
689vlib_timing_wheel_data_get_index (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400690{
691 return d / 2;
692}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700693
Dave Barach9b8ffd92016-07-08 08:13:45 -0400694typedef struct
695{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700696 /* Public nodes. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400697 vlib_node_t **nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700698
699 /* Node index hashed by node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400700 uword *node_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700701
702 u32 flags;
703#define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
704
705 /* Nodes segregated by type for cache locality.
706 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400707 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700708
709 /* Node runtime indices for input nodes with pending interrupts. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400710 u32 *pending_interrupt_node_runtime_indices;
Damjan Marion2c2b6402017-03-28 14:16:15 +0200711 clib_spinlock_t pending_interrupt_lock;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700712
713 /* Input nodes are switched from/to interrupt to/from polling mode
714 when average vector length goes above/below polling/interrupt
715 thresholds. */
716 u32 polling_threshold_vector_length;
717 u32 interrupt_threshold_vector_length;
718
719 /* Vector of next frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400720 vlib_next_frame_t *next_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700721
722 /* Vector of internal node's frames waiting to be called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400723 vlib_pending_frame_t *pending_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700724
725 /* Timing wheel for scheduling time-based node dispatch. */
Dave Barach5c20a012017-06-13 08:48:31 -0400726 void *timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700727
Dave Barach9b8ffd92016-07-08 08:13:45 -0400728 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700729
730 /* Opaque data vector added via timing_wheel_advance. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400731 u32 *data_from_advancing_timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700732
733 /* CPU time of next process to be ready on timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -0400734 f64 time_next_process_ready;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700735
736 /* Vector of process nodes.
737 One for each node of type VLIB_NODE_TYPE_PROCESS. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400738 vlib_process_t **processes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700739
740 /* Current running process or ~0 if no process running. */
741 u32 current_process_index;
742
743 /* Pool of pending process frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400744 vlib_pending_frame_t *suspended_process_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700745
746 /* Vector of event data vectors pending recycle. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400747 void **recycled_event_data_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700748
749 /* Current counts of nodes in each state. */
750 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
751
752 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400753 uword *frame_size_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700754
755 /* Per-size frame allocation information. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400756 vlib_frame_size_t *frame_sizes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700757
758 /* Time of last node runtime stats clear. */
759 f64 time_last_runtime_stats_clear;
760
761 /* Node registrations added by constructors */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400762 vlib_node_registration_t *node_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700763} vlib_node_main_t;
764
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200765
dongjuan88752482019-06-04 10:59:02 +0800766#define FRAME_QUEUE_MAX_NELTS 64
Dave Barach9b8ffd92016-07-08 08:13:45 -0400767typedef struct
768{
769 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200770 u64 head;
771 u64 head_hint;
772 u64 tail;
773 u32 n_in_use;
774 u32 nelts;
775 u32 written;
776 u32 threshold;
777 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
778} frame_queue_trace_t;
779
Dave Barach9b8ffd92016-07-08 08:13:45 -0400780typedef struct
781{
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200782 u64 count[FRAME_QUEUE_MAX_NELTS];
783} frame_queue_nelt_counter_t;
784
Ed Warnickecb9cada2015-12-08 15:45:58 -0700785#endif /* included_vlib_node_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400786
787/*
788 * fd.io coding-style-patch-verification: ON
789 *
790 * Local Variables:
791 * eval: (c-set-style "gnu")
792 * End:
793 */