blob: 1ec5a7a041d784f57dc363f1b5fb22cd898d273d [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;
Ole Troan148c7b72020-10-07 18:05:37 +0200119 vl_counter_t *error_counters;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700120
121 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400122 format_function_t *format_buffer;
123 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700124
125 /* Trace format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400126 format_function_t *format_trace;
127 unformat_function_t *unformat_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700128
129 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400130 u8 *(*validate_frame) (struct vlib_main_t * vm,
131 struct vlib_node_runtime_t *,
132 struct vlib_frame_t * f);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700133
134 /* Per-node runtime data. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400135 void *runtime_data;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700136
137 /* Process stack size. */
138 u16 process_log2_n_stack_bytes;
139
140 /* Number of bytes of per-node run time data. */
141 u8 runtime_data_bytes;
142
143 /* State for input nodes. */
144 u8 state;
145
146 /* Node flags. */
147 u16 flags;
148
Dave Barach7fff3d22018-11-27 16:52:59 -0500149 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
150 u8 protocol_hint;
151
Ed Warnickecb9cada2015-12-08 15:45:58 -0700152 /* Size of scalar and vector arguments in bytes. */
153 u16 scalar_size, vector_size;
154
155 /* Number of error codes used by this node. */
156 u16 n_errors;
157
158 /* Number of next node names that follow. */
159 u16 n_next_nodes;
160
161 /* Constructor link-list, don't ask... */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400162 struct _vlib_node_registration *next_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700163
164 /* Names of next nodes which this node feeds into. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400165 char *next_nodes[];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700166
167} vlib_node_registration_t;
168
Damjan Marion6e363512018-08-10 22:39:11 +0200169#ifndef CLIB_MARCH_VARIANT
Ed Warnickecb9cada2015-12-08 15:45:58 -0700170#define VLIB_REGISTER_NODE(x,...) \
171 __VA_ARGS__ vlib_node_registration_t x; \
172static void __vlib_add_node_registration_##x (void) \
173 __attribute__((__constructor__)) ; \
174static void __vlib_add_node_registration_##x (void) \
175{ \
176 vlib_main_t * vm = vlib_get_main(); \
177 x.next_registration = vm->node_main.node_registrations; \
178 vm->node_main.node_registrations = &x; \
179} \
Damjan Marion72d2c4f2018-04-05 21:32:29 +0200180static void __vlib_rm_node_registration_##x (void) \
181 __attribute__((__destructor__)) ; \
182static void __vlib_rm_node_registration_##x (void) \
183{ \
184 vlib_main_t * vm = vlib_get_main(); \
185 VLIB_REMOVE_FROM_LINKED_LIST (vm->node_main.node_registrations, \
186 &x, next_registration); \
187} \
Dave Barach9b8ffd92016-07-08 08:13:45 -0400188__VA_ARGS__ vlib_node_registration_t x
Damjan Marion6e363512018-08-10 22:39:11 +0200189#else
190#define VLIB_REGISTER_NODE(x,...) \
Damjan Mariond770cfc2019-09-02 19:00:33 +0200191STATIC_ASSERT (sizeof(# __VA_ARGS__) != 7,"node " #x " must not be declared as static"); \
Damjan Marion6e363512018-08-10 22:39:11 +0200192static __clib_unused vlib_node_registration_t __clib_unused_##x
193#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700194
Damjan Marion69abe442018-08-27 22:43:23 +0200195#ifndef CLIB_MARCH_VARIANT
196#define CLIB_MARCH_VARIANT_STR "default"
197#else
198#define _CLIB_MARCH_VARIANT_STR(s) __CLIB_MARCH_VARIANT_STR(s)
199#define __CLIB_MARCH_VARIANT_STR(s) #s
200#define CLIB_MARCH_VARIANT_STR _CLIB_MARCH_VARIANT_STR(CLIB_MARCH_VARIANT)
201#endif
202
Damjan Marion812b32d2018-05-28 21:26:47 +0200203#define VLIB_NODE_FN(node) \
204uword CLIB_MARCH_SFX (node##_fn)(); \
205static vlib_node_fn_registration_t \
206 CLIB_MARCH_SFX(node##_fn_registration) = \
207 { .function = &CLIB_MARCH_SFX (node##_fn), }; \
208 \
209static void __clib_constructor \
210CLIB_MARCH_SFX (node##_multiarch_register) (void) \
211{ \
212 extern vlib_node_registration_t node; \
213 vlib_node_fn_registration_t *r; \
214 r = & CLIB_MARCH_SFX (node##_fn_registration); \
215 r->priority = CLIB_MARCH_FN_PRIORITY(); \
Damjan Marion69abe442018-08-27 22:43:23 +0200216 r->name = CLIB_MARCH_VARIANT_STR; \
Damjan Marion812b32d2018-05-28 21:26:47 +0200217 r->next_registration = node.node_fn_registrations; \
218 node.node_fn_registrations = r; \
219} \
220uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (node##_fn)
221
Ray Kinsella4830e4f2020-03-10 14:35:32 +0000222unformat_function_t unformat_vlib_node_variant;
223
Ed Warnickecb9cada2015-12-08 15:45:58 -0700224always_inline vlib_node_registration_t *
225vlib_node_next_registered (vlib_node_registration_t * c)
226{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400227 c =
228 clib_elf_section_data_next (c,
229 c->n_next_nodes * sizeof (c->next_nodes[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700230 return c;
231}
232
Dave Barach9b8ffd92016-07-08 08:13:45 -0400233typedef struct
234{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700235 /* Total calls, clock ticks and vector elements processed for this node. */
236 u64 calls, vectors, clocks, suspends;
237 u64 max_clock;
238 u64 max_clock_n;
239} vlib_node_stats_t;
240
241#define foreach_vlib_node_state \
242 /* Input node is called each iteration of main loop. \
243 This is the default (zero). */ \
244 _ (POLLING) \
245 /* Input node is called when device signals an interrupt. */ \
246 _ (INTERRUPT) \
247 /* Input node is never called. */ \
248 _ (DISABLED)
249
Dave Barach9b8ffd92016-07-08 08:13:45 -0400250typedef enum
251{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700252#define _(f) VLIB_NODE_STATE_##f,
253 foreach_vlib_node_state
254#undef _
Dave Barach9b8ffd92016-07-08 08:13:45 -0400255 VLIB_N_NODE_STATE,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700256} vlib_node_state_t;
257
Dave Barach9b8ffd92016-07-08 08:13:45 -0400258typedef struct vlib_node_t
259{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700260 /* Vector processing function for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400261 vlib_node_function_t *function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700262
263 /* Node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400264 u8 *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700265
266 /* Node name index in elog string table. */
267 u32 name_elog_string;
268
269 /* Total statistics for this node. */
270 vlib_node_stats_t stats_total;
271
272 /* Saved values as of last clear (or zero if never cleared).
273 Current values are always stats_total - stats_last_clear. */
274 vlib_node_stats_t stats_last_clear;
275
276 /* Type of this node. */
277 vlib_node_type_t type;
278
279 /* Node index. */
280 u32 index;
281
282 /* Index of corresponding node runtime. */
283 u32 runtime_index;
284
285 /* Runtime data for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400286 void *runtime_data;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700287
288 /* Node flags. */
289 u16 flags;
290
291 /* Processing function keeps frame. Tells node dispatching code not
292 to free frame after dispatch is done. */
293#define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
294
295 /* Node counts as output/drop/punt node for stats purposes. */
296#define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
297#define VLIB_NODE_FLAG_IS_DROP (1 << 2)
298#define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
299#define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
300
301 /* Set if current node runtime has traced vectors. */
302#define VLIB_NODE_FLAG_TRACE (1 << 5)
303
304#define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
305#define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
Damjan Marion7ca5aaa2019-09-24 18:10:49 +0200306#define VLIB_NODE_FLAG_TRACE_SUPPORTED (1 << 8)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700307
308 /* State for input nodes. */
309 u8 state;
310
311 /* Number of bytes of run time data. */
312 u8 runtime_data_bytes;
313
Dave Barach7fff3d22018-11-27 16:52:59 -0500314 /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
315 u8 protocol_hint;
316
Ed Warnickecb9cada2015-12-08 15:45:58 -0700317 /* Number of error codes used by this node. */
318 u16 n_errors;
319
320 /* Size of scalar and vector arguments in bytes. */
321 u16 scalar_size, vector_size;
322
323 /* Handle/index in error heap for this node. */
324 u32 error_heap_handle;
325 u32 error_heap_index;
326
Ole Troan148c7b72020-10-07 18:05:37 +0200327 /* Counter structures indexed by counter code for this node. */
328 vl_counter_t *error_counters;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700329
330 /* Vector of next node names.
331 Only used before next_nodes array is initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400332 char **next_node_names;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700333
334 /* Next node indices for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400335 u32 *next_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700336
337 /* Name of node that we are sibling of. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400338 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700339
340 /* Bitmap of all of this node's siblings. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400341 uword *sibling_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700342
343 /* Total number of vectors sent to each next node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400344 u64 *n_vectors_by_next_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700345
346 /* Hash table mapping next node index into slot in
347 next_nodes vector. Quickly determines whether this node
348 is connected to given next node and, if so, with which slot. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400349 uword *next_slot_by_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700350
351 /* Bitmap of node indices which feed this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400352 uword *prev_node_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700353
354 /* Node/next-index which own enqueue rights with to this node. */
355 u32 owner_node_index, owner_next_index;
356
357 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400358 format_function_t *format_buffer;
359 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700360
361 /* Trace buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400362 format_function_t *format_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700363
364 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400365 u8 *(*validate_frame) (struct vlib_main_t * vm,
366 struct vlib_node_runtime_t *,
367 struct vlib_frame_t * f);
Dave Barach6931f592016-05-13 12:55:01 -0400368 /* for pretty-printing, not typically valid */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400369 u8 *state_string;
Damjan Marion69abe442018-08-27 22:43:23 +0200370
371 /* Node function candidate registration with priority */
372 vlib_node_fn_registration_t *node_fn_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700373} vlib_node_t;
374
375#define VLIB_INVALID_NODE_INDEX ((u32) ~0)
376
377/* Max number of vector elements to process at once per node. */
378#define VLIB_FRAME_SIZE 256
Dave Barachd84ba852017-08-22 17:56:46 -0400379#define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
Ed Warnickecb9cada2015-12-08 15:45:58 -0700380
381/* Calling frame (think stack frame) for a node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400382typedef struct vlib_frame_t
383{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700384 /* Frame flags. */
Damjan Marion633b6fd2018-09-14 14:38:53 +0200385 u16 frame_flags;
386
387 /* User flags. Used for sending hints to the next node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700388 u16 flags;
389
390 /* Number of scalar bytes in arguments. */
391 u8 scalar_size;
392
393 /* Number of bytes per vector argument. */
394 u8 vector_size;
395
396 /* Number of vector elements currently in frame. */
397 u16 n_vectors;
398
Ed Warnickecb9cada2015-12-08 15:45:58 -0700399 /* Scalar and vector arguments to next node. */
400 u8 arguments[0];
401} vlib_frame_t;
402
Dave Barach9b8ffd92016-07-08 08:13:45 -0400403typedef struct
404{
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200405 /* Frame pointer. */
406 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700407
408 /* Node runtime for this next. */
409 u32 node_runtime_index;
410
411 /* Next frame flags. */
412 u32 flags;
413
414 /* Reflects node frame-used flag for this next. */
415#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
416 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
417
Damjan Marion296988d2019-02-21 20:24:54 +0100418 /* Don't append this frame */
419#define VLIB_FRAME_NO_APPEND (1 << 14)
420
Ed Warnickecb9cada2015-12-08 15:45:58 -0700421 /* This next frame owns enqueue to node
422 corresponding to node_runtime_index. */
423#define VLIB_FRAME_OWNER (1 << 15)
424
425 /* Set when frame has been allocated for this next. */
426#define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
427
428 /* Set when frame has been added to pending vector. */
429#define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
430
431 /* Set when frame is to be freed after dispatch. */
432#define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
433
434 /* Set when frame has traced packets. */
435#define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
436
437 /* Number of vectors enqueue to this next since last overflow. */
438 u32 vectors_since_last_overflow;
439} vlib_next_frame_t;
440
441always_inline void
442vlib_next_frame_init (vlib_next_frame_t * nf)
443{
Dave Barachb7b92992018-10-17 10:38:51 -0400444 clib_memset (nf, 0, sizeof (nf[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700445 nf->node_runtime_index = ~0;
446}
447
448/* A frame pending dispatch by main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400449typedef struct
450{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700451 /* Node and runtime for this frame. */
452 u32 node_runtime_index;
453
454 /* Frame index (in the heap). */
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200455 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700456
457 /* Start of next frames for this node. */
458 u32 next_frame_index;
459
460 /* Special value for next_frame_index when there is no next frame. */
461#define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
462} vlib_pending_frame_t;
463
Dave Barach9b8ffd92016-07-08 08:13:45 -0400464typedef struct vlib_node_runtime_t
465{
Damjan Marione9f929b2017-03-16 11:32:09 +0100466 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700467
Damjan Marione9f929b2017-03-16 11:32:09 +0100468 vlib_node_function_t *function; /**< Node function to call. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700469
Damjan Marione9f929b2017-03-16 11:32:09 +0100470 vlib_error_t *errors; /**< Vector of errors for this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700471
Damjan Marione9f929b2017-03-16 11:32:09 +0100472 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700473
Damjan Marione9f929b2017-03-16 11:32:09 +0100474 u32 max_clock; /**< Maximum clock cycle for an
475 invocation. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700476
Damjan Marione9f929b2017-03-16 11:32:09 +0100477 u32 max_clock_n; /**< Number of vectors in the recorded
478 max_clock. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700479
Damjan Marione9f929b2017-03-16 11:32:09 +0100480 u32 calls_since_last_overflow; /**< Number of calls. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700481
Damjan Marione9f929b2017-03-16 11:32:09 +0100482 u32 vectors_since_last_overflow; /**< Number of vector elements
483 processed by this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700484
Damjan Marione9f929b2017-03-16 11:32:09 +0100485 u32 next_frame_index; /**< Start of next frames for this
486 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700487
Damjan Marione9f929b2017-03-16 11:32:09 +0100488 u32 node_index; /**< Node index. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700489
Damjan Marione9f929b2017-03-16 11:32:09 +0100490 u32 input_main_loops_per_call; /**< For input nodes: decremented
491 on each main loop interation until
492 it reaches zero and function is
493 called. Allows some input nodes to
494 be called more than others. */
495
496 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
497 dispatch of this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700498
499 u32 main_loop_vector_stats[2];
500
Damjan Marione9f929b2017-03-16 11:32:09 +0100501 u16 flags; /**< Copy of main node flags. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700502
Damjan Marione9f929b2017-03-16 11:32:09 +0100503 u16 state; /**< Input node state. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700504
505 u16 n_next_nodes;
506
Damjan Marione9f929b2017-03-16 11:32:09 +0100507 u16 cached_next_index; /**< Next frame index that vector
508 arguments were last enqueued to
509 last time this node ran. Set to
510 zero before first run of this
511 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700512
Damjan Marion586afd72017-04-05 19:18:20 +0200513 u16 thread_index; /**< thread this node runs on */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700514
Damjan Marione9f929b2017-03-16 11:32:09 +0100515 u8 runtime_data[0]; /**< Function dependent
516 node-runtime data. This data is
517 thread local, and it is not
518 cloned from main thread. It needs
519 to be initialized for each thread
520 before it is used unless
521 runtime_data template exists in
522 vlib_node_t. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400523}
524vlib_node_runtime_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700525
Damjan Marione9f929b2017-03-16 11:32:09 +0100526#define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
527
Dave Barach9b8ffd92016-07-08 08:13:45 -0400528typedef struct
529{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700530 /* Number of allocated frames for this scalar/vector size. */
531 u32 n_alloc_frames;
532
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200533 /* Vector of free frames for this scalar/vector size. */
534 vlib_frame_t **free_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700535} vlib_frame_size_t;
536
Dave Barach9b8ffd92016-07-08 08:13:45 -0400537typedef struct
538{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700539 /* Users opaque value for event type. */
540 uword opaque;
541} vlib_process_event_type_t;
542
Dave Barach9b8ffd92016-07-08 08:13:45 -0400543typedef struct
544{
Damjan Marionef587582020-05-20 22:01:44 +0200545 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700546 /* Node runtime for this process. */
547 vlib_node_runtime_t node_runtime;
548
549 /* Where to longjmp when process is done. */
550 clib_longjmp_t return_longjmp;
551
552#define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
553#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
554
555 /* Where to longjmp to resume node after suspend. */
556 clib_longjmp_t resume_longjmp;
557#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
558#define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
559
560 u16 flags;
561#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
562#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
563 /* Set to indicate that this process has been added to resume vector. */
564#define VLIB_PROCESS_RESUME_PENDING (1 << 2)
565
566 /* Process function is currently running. */
567#define VLIB_PROCESS_IS_RUNNING (1 << 3)
568
569 /* Size of process stack. */
570 u16 log2_n_stack_bytes;
571
572 u32 suspended_process_frame_index;
573
574 /* Number of times this process was suspended. */
575 u32 n_suspends;
576
577 /* Vectors of pending event data indexed by event type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400578 void **pending_event_data_by_type_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700579
580 /* Bitmap of event type-indices with non-empty vectors. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400581 uword *non_empty_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700582
583 /* Bitmap of event type-indices which are one time events. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400584 uword *one_time_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700585
586 /* Type is opaque pointer -- typically a pointer to an event handler
587 function. Hash table to map opaque to a type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400588 uword *event_type_index_by_type_opaque;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700589
590 /* Pool of currently valid event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400591 vlib_process_event_type_t *event_type_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700592
Dave Barach5c20a012017-06-13 08:48:31 -0400593 /*
594 * When suspending saves clock time (10us ticks) when process
595 * is to be resumed.
596 */
597 u64 resume_clock_interval;
598
599 /* Handle from timer code, to cancel an unexpired timer */
600 u32 stop_timer_handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700601
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000602 /* Default output function and its argument for any CLI outputs
603 within the process. */
604 vlib_cli_output_function_t *output_function;
605 uword output_function_arg;
606
Damjan Marionef587582020-05-20 22:01:44 +0200607 /* Process stack */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700608#define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
Damjan Marionef587582020-05-20 22:01:44 +0200609 u32 *stack;
610} vlib_process_t;
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000611
Dave Barach9b8ffd92016-07-08 08:13:45 -0400612typedef struct
613{
614 u32 node_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700615
Dave Barach9b8ffd92016-07-08 08:13:45 -0400616 u32 one_time_event;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700617} vlib_one_time_waiting_process_t;
618
Dave Barach9b8ffd92016-07-08 08:13:45 -0400619typedef struct
620{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700621 u16 n_data_elts;
622
623 u16 n_data_elt_bytes;
624
625 /* n_data_elts * n_data_elt_bytes */
626 u32 n_data_bytes;
627
628 /* Process node & event type to be used to signal event. */
629 u32 process_node_index;
630
631 u32 event_type_index;
632
Dave Barach9b8ffd92016-07-08 08:13:45 -0400633 union
634 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700635 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
636
637 /* Vector of event data used only when data does not fit inline. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400638 u8 *event_data_as_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700639 };
Dave Barach9b8ffd92016-07-08 08:13:45 -0400640}
641vlib_signal_timed_event_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700642
643always_inline uword
644vlib_timing_wheel_data_is_timed_event (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400645{
646 return d & 1;
647}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700648
649always_inline u32
650vlib_timing_wheel_data_set_suspended_process (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400651{
652 return 0 + 2 * i;
653}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700654
655always_inline u32
656vlib_timing_wheel_data_set_timed_event (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400657{
658 return 1 + 2 * i;
659}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700660
661always_inline uword
662vlib_timing_wheel_data_get_index (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400663{
664 return d / 2;
665}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700666
Dave Barach9b8ffd92016-07-08 08:13:45 -0400667typedef struct
668{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700669 /* Public nodes. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400670 vlib_node_t **nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700671
672 /* Node index hashed by node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400673 uword *node_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700674
675 u32 flags;
676#define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
677
678 /* Nodes segregated by type for cache locality.
679 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400680 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700681
682 /* Node runtime indices for input nodes with pending interrupts. */
Damjan Marion94100532020-11-06 23:25:57 +0100683 void *interrupts;
684 volatile u32 *pending_interrupts;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700685
686 /* Input nodes are switched from/to interrupt to/from polling mode
687 when average vector length goes above/below polling/interrupt
688 thresholds. */
689 u32 polling_threshold_vector_length;
690 u32 interrupt_threshold_vector_length;
691
692 /* Vector of next frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400693 vlib_next_frame_t *next_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700694
695 /* Vector of internal node's frames waiting to be called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400696 vlib_pending_frame_t *pending_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700697
698 /* Timing wheel for scheduling time-based node dispatch. */
Dave Barach5c20a012017-06-13 08:48:31 -0400699 void *timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700700
Dave Barach9b8ffd92016-07-08 08:13:45 -0400701 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700702
703 /* Opaque data vector added via timing_wheel_advance. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400704 u32 *data_from_advancing_timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700705
706 /* CPU time of next process to be ready on timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -0400707 f64 time_next_process_ready;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700708
709 /* Vector of process nodes.
710 One for each node of type VLIB_NODE_TYPE_PROCESS. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400711 vlib_process_t **processes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700712
713 /* Current running process or ~0 if no process running. */
714 u32 current_process_index;
715
716 /* Pool of pending process frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400717 vlib_pending_frame_t *suspended_process_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700718
719 /* Vector of event data vectors pending recycle. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400720 void **recycled_event_data_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700721
722 /* Current counts of nodes in each state. */
723 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
724
725 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400726 uword *frame_size_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700727
728 /* Per-size frame allocation information. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400729 vlib_frame_size_t *frame_sizes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700730
731 /* Time of last node runtime stats clear. */
732 f64 time_last_runtime_stats_clear;
733
734 /* Node registrations added by constructors */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400735 vlib_node_registration_t *node_registrations;
Dave Barach687c9022019-07-23 10:22:31 -0400736
737 /* Node index from error code */
738 u32 *node_by_error;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700739} vlib_node_main_t;
740
Dave Barach687c9022019-07-23 10:22:31 -0400741typedef u16 vlib_error_t;
742
743always_inline u32
744vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
745{
746 return nm->node_by_error[e];
747}
748
749always_inline u32
750vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
751{
752 u32 node_index = nm->node_by_error[e];
753 vlib_node_t *n = nm->nodes[node_index];
754 u32 error_code = e - n->error_heap_index;
755 return error_code;
756}
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200757
dongjuan88752482019-06-04 10:59:02 +0800758#define FRAME_QUEUE_MAX_NELTS 64
Dave Barach9b8ffd92016-07-08 08:13:45 -0400759typedef struct
760{
761 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200762 u64 head;
763 u64 head_hint;
764 u64 tail;
765 u32 n_in_use;
766 u32 nelts;
767 u32 written;
768 u32 threshold;
769 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
770} frame_queue_trace_t;
771
Dave Barach9b8ffd92016-07-08 08:13:45 -0400772typedef struct
773{
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200774 u64 count[FRAME_QUEUE_MAX_NELTS];
775} frame_queue_nelt_counter_t;
776
Ed Warnickecb9cada2015-12-08 15:45:58 -0700777#endif /* included_vlib_node_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400778
779/*
780 * fd.io coding-style-patch-verification: ON
781 *
782 * Local Variables:
783 * eval: (c-set-style "gnu")
784 * End:
785 */