blob: fb2a83bc400c26a76cc3ffd750cbba69867aa302 [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{
Ed Warnickecb9cada2015-12-08 15:45:58 -070060 /* An internal node on the call graph (could be output). */
61 VLIB_NODE_TYPE_INTERNAL,
62
63 /* Nodes which input data into the processing graph.
64 Input nodes are called for each iteration of main loop. */
65 VLIB_NODE_TYPE_INPUT,
66
67 /* Nodes to be called before all input nodes.
68 Used, for example, to clean out driver TX rings before
69 processing input. */
70 VLIB_NODE_TYPE_PRE_INPUT,
71
72 /* "Process" nodes which can be suspended and later resumed. */
73 VLIB_NODE_TYPE_PROCESS,
74
75 VLIB_N_NODE_TYPE,
76} vlib_node_type_t;
77
Damjan Marion812b32d2018-05-28 21:26:47 +020078typedef struct _vlib_node_fn_registration
79{
80 vlib_node_function_t *function;
81 int priority;
82 struct _vlib_node_fn_registration *next_registration;
Damjan Marion69abe442018-08-27 22:43:23 +020083 char *name;
Damjan Marion812b32d2018-05-28 21:26:47 +020084} vlib_node_fn_registration_t;
85
Dave Barach9b8ffd92016-07-08 08:13:45 -040086typedef struct _vlib_node_registration
87{
Ed Warnickecb9cada2015-12-08 15:45:58 -070088 /* Vector processing function for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -040089 vlib_node_function_t *function;
Ed Warnickecb9cada2015-12-08 15:45:58 -070090
Damjan Marion812b32d2018-05-28 21:26:47 +020091 /* Node function candidate registration with priority */
92 vlib_node_fn_registration_t *node_fn_registrations;
93
Ed Warnickecb9cada2015-12-08 15:45:58 -070094 /* Node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -040095 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -070096
97 /* Name of sibling (if applicable). */
Dave Barach9b8ffd92016-07-08 08:13:45 -040098 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -070099
100 /* Node index filled in by registration. */
101 u32 index;
102
103 /* Type of this node. */
104 vlib_node_type_t type;
105
106 /* Error strings indexed by error code for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400107 char **error_strings;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700108
109 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400110 format_function_t *format_buffer;
111 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700112
113 /* Trace format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400114 format_function_t *format_trace;
115 unformat_function_t *unformat_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700116
117 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400118 u8 *(*validate_frame) (struct vlib_main_t * vm,
119 struct vlib_node_runtime_t *,
120 struct vlib_frame_t * f);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700121
122 /* Per-node runtime data. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400123 void *runtime_data;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700124
125 /* Process stack size. */
126 u16 process_log2_n_stack_bytes;
127
128 /* Number of bytes of per-node run time data. */
129 u8 runtime_data_bytes;
130
131 /* State for input nodes. */
132 u8 state;
133
134 /* Node flags. */
135 u16 flags;
136
137 /* Size of scalar and vector arguments in bytes. */
138 u16 scalar_size, vector_size;
139
140 /* Number of error codes used by this node. */
141 u16 n_errors;
142
143 /* Number of next node names that follow. */
144 u16 n_next_nodes;
145
146 /* Constructor link-list, don't ask... */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400147 struct _vlib_node_registration *next_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700148
149 /* Names of next nodes which this node feeds into. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400150 char *next_nodes[];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700151
152} vlib_node_registration_t;
153
Damjan Marion6e363512018-08-10 22:39:11 +0200154#ifndef CLIB_MARCH_VARIANT
Ed Warnickecb9cada2015-12-08 15:45:58 -0700155#define VLIB_REGISTER_NODE(x,...) \
156 __VA_ARGS__ vlib_node_registration_t x; \
157static void __vlib_add_node_registration_##x (void) \
158 __attribute__((__constructor__)) ; \
159static void __vlib_add_node_registration_##x (void) \
160{ \
161 vlib_main_t * vm = vlib_get_main(); \
162 x.next_registration = vm->node_main.node_registrations; \
163 vm->node_main.node_registrations = &x; \
164} \
Damjan Marion72d2c4f2018-04-05 21:32:29 +0200165static void __vlib_rm_node_registration_##x (void) \
166 __attribute__((__destructor__)) ; \
167static void __vlib_rm_node_registration_##x (void) \
168{ \
169 vlib_main_t * vm = vlib_get_main(); \
170 VLIB_REMOVE_FROM_LINKED_LIST (vm->node_main.node_registrations, \
171 &x, next_registration); \
172} \
Dave Barach9b8ffd92016-07-08 08:13:45 -0400173__VA_ARGS__ vlib_node_registration_t x
Damjan Marion6e363512018-08-10 22:39:11 +0200174#else
175#define VLIB_REGISTER_NODE(x,...) \
176static __clib_unused vlib_node_registration_t __clib_unused_##x
177#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700178
Damjan Marion69abe442018-08-27 22:43:23 +0200179#ifndef CLIB_MARCH_VARIANT
180#define CLIB_MARCH_VARIANT_STR "default"
181#else
182#define _CLIB_MARCH_VARIANT_STR(s) __CLIB_MARCH_VARIANT_STR(s)
183#define __CLIB_MARCH_VARIANT_STR(s) #s
184#define CLIB_MARCH_VARIANT_STR _CLIB_MARCH_VARIANT_STR(CLIB_MARCH_VARIANT)
185#endif
186
Damjan Marion812b32d2018-05-28 21:26:47 +0200187#define VLIB_NODE_FN(node) \
188uword CLIB_MARCH_SFX (node##_fn)(); \
189static vlib_node_fn_registration_t \
190 CLIB_MARCH_SFX(node##_fn_registration) = \
191 { .function = &CLIB_MARCH_SFX (node##_fn), }; \
192 \
193static void __clib_constructor \
194CLIB_MARCH_SFX (node##_multiarch_register) (void) \
195{ \
196 extern vlib_node_registration_t node; \
197 vlib_node_fn_registration_t *r; \
198 r = & CLIB_MARCH_SFX (node##_fn_registration); \
199 r->priority = CLIB_MARCH_FN_PRIORITY(); \
Damjan Marion69abe442018-08-27 22:43:23 +0200200 r->name = CLIB_MARCH_VARIANT_STR; \
Damjan Marion812b32d2018-05-28 21:26:47 +0200201 r->next_registration = node.node_fn_registrations; \
202 node.node_fn_registrations = r; \
203} \
204uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (node##_fn)
205
Damjan Marion1c80e832016-05-11 23:07:18 +0200206#if CLIB_DEBUG > 0
207#define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn)
208#define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn)
209#define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
210#else
211#define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
212 uword \
213 __attribute__ ((flatten)) \
214 __attribute__ ((target (tgt))) \
215 CLIB_CPU_OPTIMIZED \
216 fn ## _ ## arch ( struct vlib_main_t * vm, \
217 struct vlib_node_runtime_t * node, \
218 struct vlib_frame_t * frame) \
219 { return fn (vm, node, frame); }
220
221#define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn) \
222 foreach_march_variant(VLIB_NODE_FUNCTION_CLONE_TEMPLATE, fn)
223
224#define VLIB_NODE_FUNCTION_MULTIARCH(node, fn) \
225 VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn) \
226 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
227 static void __attribute__((__constructor__)) \
228 __vlib_node_function_multiarch_select_##node (void) \
229 { node.function = fn ## _multiarch_select(); }
230#endif
231
Ed Warnickecb9cada2015-12-08 15:45:58 -0700232always_inline vlib_node_registration_t *
233vlib_node_next_registered (vlib_node_registration_t * c)
234{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400235 c =
236 clib_elf_section_data_next (c,
237 c->n_next_nodes * sizeof (c->next_nodes[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700238 return c;
239}
240
Dave Barach9b8ffd92016-07-08 08:13:45 -0400241typedef struct
242{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700243 /* Total calls, clock ticks and vector elements processed for this node. */
244 u64 calls, vectors, clocks, suspends;
245 u64 max_clock;
246 u64 max_clock_n;
Dave Barach4d1a8662018-09-10 12:31:15 -0400247 u64 perf_counter_ticks;
248 u64 perf_counter_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700249} vlib_node_stats_t;
250
251#define foreach_vlib_node_state \
252 /* Input node is called each iteration of main loop. \
253 This is the default (zero). */ \
254 _ (POLLING) \
255 /* Input node is called when device signals an interrupt. */ \
256 _ (INTERRUPT) \
257 /* Input node is never called. */ \
258 _ (DISABLED)
259
Dave Barach9b8ffd92016-07-08 08:13:45 -0400260typedef enum
261{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700262#define _(f) VLIB_NODE_STATE_##f,
263 foreach_vlib_node_state
264#undef _
Dave Barach9b8ffd92016-07-08 08:13:45 -0400265 VLIB_N_NODE_STATE,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700266} vlib_node_state_t;
267
Dave Barach9b8ffd92016-07-08 08:13:45 -0400268typedef struct vlib_node_t
269{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700270 /* Vector processing function for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400271 vlib_node_function_t *function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700272
273 /* Node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400274 u8 *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700275
276 /* Node name index in elog string table. */
277 u32 name_elog_string;
278
279 /* Total statistics for this node. */
280 vlib_node_stats_t stats_total;
281
282 /* Saved values as of last clear (or zero if never cleared).
283 Current values are always stats_total - stats_last_clear. */
284 vlib_node_stats_t stats_last_clear;
285
286 /* Type of this node. */
287 vlib_node_type_t type;
288
289 /* Node index. */
290 u32 index;
291
292 /* Index of corresponding node runtime. */
293 u32 runtime_index;
294
295 /* Runtime data for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400296 void *runtime_data;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700297
298 /* Node flags. */
299 u16 flags;
300
301 /* Processing function keeps frame. Tells node dispatching code not
302 to free frame after dispatch is done. */
303#define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
304
305 /* Node counts as output/drop/punt node for stats purposes. */
306#define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
307#define VLIB_NODE_FLAG_IS_DROP (1 << 2)
308#define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
309#define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
310
311 /* Set if current node runtime has traced vectors. */
312#define VLIB_NODE_FLAG_TRACE (1 << 5)
313
314#define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
315#define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
316
317 /* State for input nodes. */
318 u8 state;
319
320 /* Number of bytes of run time data. */
321 u8 runtime_data_bytes;
322
323 /* Number of error codes used by this node. */
324 u16 n_errors;
325
326 /* Size of scalar and vector arguments in bytes. */
327 u16 scalar_size, vector_size;
328
329 /* Handle/index in error heap for this node. */
330 u32 error_heap_handle;
331 u32 error_heap_index;
332
333 /* Error strings indexed by error code for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400334 char **error_strings;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700335
336 /* Vector of next node names.
337 Only used before next_nodes array is initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400338 char **next_node_names;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700339
340 /* Next node indices for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400341 u32 *next_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700342
343 /* Name of node that we are sibling of. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400344 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700345
346 /* Bitmap of all of this node's siblings. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400347 uword *sibling_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700348
349 /* Total number of vectors sent to each next node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400350 u64 *n_vectors_by_next_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700351
352 /* Hash table mapping next node index into slot in
353 next_nodes vector. Quickly determines whether this node
354 is connected to given next node and, if so, with which slot. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400355 uword *next_slot_by_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700356
357 /* Bitmap of node indices which feed this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400358 uword *prev_node_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700359
360 /* Node/next-index which own enqueue rights with to this node. */
361 u32 owner_node_index, owner_next_index;
362
363 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400364 format_function_t *format_buffer;
365 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700366
367 /* Trace buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400368 format_function_t *format_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700369
370 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400371 u8 *(*validate_frame) (struct vlib_main_t * vm,
372 struct vlib_node_runtime_t *,
373 struct vlib_frame_t * f);
Dave Barach6931f592016-05-13 12:55:01 -0400374 /* for pretty-printing, not typically valid */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400375 u8 *state_string;
Damjan Marion69abe442018-08-27 22:43:23 +0200376
377 /* Node function candidate registration with priority */
378 vlib_node_fn_registration_t *node_fn_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700379} vlib_node_t;
380
381#define VLIB_INVALID_NODE_INDEX ((u32) ~0)
382
383/* Max number of vector elements to process at once per node. */
384#define VLIB_FRAME_SIZE 256
Dave Barachd84ba852017-08-22 17:56:46 -0400385#define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
Ed Warnickecb9cada2015-12-08 15:45:58 -0700386
387/* Calling frame (think stack frame) for a node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400388typedef struct vlib_frame_t
389{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700390 /* Frame flags. */
Damjan Marion633b6fd2018-09-14 14:38:53 +0200391 u16 frame_flags;
392
393 /* User flags. Used for sending hints to the next node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700394 u16 flags;
395
396 /* Number of scalar bytes in arguments. */
397 u8 scalar_size;
398
399 /* Number of bytes per vector argument. */
400 u8 vector_size;
401
402 /* Number of vector elements currently in frame. */
403 u16 n_vectors;
404
Ed Warnickecb9cada2015-12-08 15:45:58 -0700405 /* Scalar and vector arguments to next node. */
406 u8 arguments[0];
407} vlib_frame_t;
408
Dave Barach9b8ffd92016-07-08 08:13:45 -0400409typedef struct
410{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700411 /* Frame index. */
412 u32 frame_index;
413
414 /* Node runtime for this next. */
415 u32 node_runtime_index;
416
417 /* Next frame flags. */
418 u32 flags;
419
420 /* Reflects node frame-used flag for this next. */
421#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
422 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
423
424 /* This next frame owns enqueue to node
425 corresponding to node_runtime_index. */
426#define VLIB_FRAME_OWNER (1 << 15)
427
428 /* Set when frame has been allocated for this next. */
429#define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
430
431 /* Set when frame has been added to pending vector. */
432#define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
433
434 /* Set when frame is to be freed after dispatch. */
435#define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
436
437 /* Set when frame has traced packets. */
438#define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
439
440 /* Number of vectors enqueue to this next since last overflow. */
441 u32 vectors_since_last_overflow;
442} vlib_next_frame_t;
443
444always_inline void
445vlib_next_frame_init (vlib_next_frame_t * nf)
446{
Dave Barachb7b92992018-10-17 10:38:51 -0400447 clib_memset (nf, 0, sizeof (nf[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700448 nf->frame_index = ~0;
449 nf->node_runtime_index = ~0;
450}
451
452/* A frame pending dispatch by main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400453typedef struct
454{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700455 /* Node and runtime for this frame. */
456 u32 node_runtime_index;
457
458 /* Frame index (in the heap). */
459 u32 frame_index;
460
461 /* Start of next frames for this node. */
462 u32 next_frame_index;
463
464 /* Special value for next_frame_index when there is no next frame. */
465#define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
466} vlib_pending_frame_t;
467
Dave Barach9b8ffd92016-07-08 08:13:45 -0400468typedef struct vlib_node_runtime_t
469{
Damjan Marione9f929b2017-03-16 11:32:09 +0100470 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700471
Damjan Marione9f929b2017-03-16 11:32:09 +0100472 vlib_node_function_t *function; /**< Node function to call. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700473
Damjan Marione9f929b2017-03-16 11:32:09 +0100474 vlib_error_t *errors; /**< Vector of errors for this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700475
Damjan Marion36c13082017-04-24 20:58:29 +0200476#if __SIZEOF_POINTER__ == 4
477 u8 pad[8];
478#endif
479
Damjan Marione9f929b2017-03-16 11:32:09 +0100480 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700481
Damjan Marione9f929b2017-03-16 11:32:09 +0100482 u32 max_clock; /**< Maximum clock cycle for an
483 invocation. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700484
Damjan Marione9f929b2017-03-16 11:32:09 +0100485 u32 max_clock_n; /**< Number of vectors in the recorded
486 max_clock. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700487
Damjan Marione9f929b2017-03-16 11:32:09 +0100488 u32 calls_since_last_overflow; /**< Number of calls. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700489
Damjan Marione9f929b2017-03-16 11:32:09 +0100490 u32 vectors_since_last_overflow; /**< Number of vector elements
491 processed by this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700492
Dave Barach4d1a8662018-09-10 12:31:15 -0400493 u32 perf_counter_ticks_since_last_overflow; /**< Perf counter ticks */
494 u32 perf_counter_vectors_since_last_overflow; /**< Perf counter vectors */
495
Damjan Marione9f929b2017-03-16 11:32:09 +0100496 u32 next_frame_index; /**< Start of next frames for this
497 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700498
Damjan Marione9f929b2017-03-16 11:32:09 +0100499 u32 node_index; /**< Node index. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700500
Damjan Marione9f929b2017-03-16 11:32:09 +0100501 u32 input_main_loops_per_call; /**< For input nodes: decremented
502 on each main loop interation until
503 it reaches zero and function is
504 called. Allows some input nodes to
505 be called more than others. */
506
507 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
508 dispatch of this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700509
510 u32 main_loop_vector_stats[2];
511
Damjan Marione9f929b2017-03-16 11:32:09 +0100512 u16 flags; /**< Copy of main node flags. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700513
Damjan Marione9f929b2017-03-16 11:32:09 +0100514 u16 state; /**< Input node state. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700515
516 u16 n_next_nodes;
517
Damjan Marione9f929b2017-03-16 11:32:09 +0100518 u16 cached_next_index; /**< Next frame index that vector
519 arguments were last enqueued to
520 last time this node ran. Set to
521 zero before first run of this
522 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700523
Damjan Marion586afd72017-04-05 19:18:20 +0200524 u16 thread_index; /**< thread this node runs on */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700525
Damjan Marione9f929b2017-03-16 11:32:09 +0100526 u8 runtime_data[0]; /**< Function dependent
527 node-runtime data. This data is
528 thread local, and it is not
529 cloned from main thread. It needs
530 to be initialized for each thread
531 before it is used unless
532 runtime_data template exists in
533 vlib_node_t. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400534}
535vlib_node_runtime_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700536
Damjan Marione9f929b2017-03-16 11:32:09 +0100537#define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
538
Dave Barach9b8ffd92016-07-08 08:13:45 -0400539typedef struct
540{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700541 /* Number of allocated frames for this scalar/vector size. */
542 u32 n_alloc_frames;
543
544 /* Vector of free frame indices for this scalar/vector size. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400545 u32 *free_frame_indices;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700546} vlib_frame_size_t;
547
Dave Barach9b8ffd92016-07-08 08:13:45 -0400548typedef struct
549{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700550 /* Users opaque value for event type. */
551 uword opaque;
552} vlib_process_event_type_t;
553
Dave Barach9b8ffd92016-07-08 08:13:45 -0400554typedef struct
555{
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
Ed Warnickecb9cada2015-12-08 15:45:58 -0700617#ifdef CLIB_UNIX
618 /* Pad to a multiple of the page size so we can mprotect process stacks */
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000619#define PAGE_SIZE_MULTIPLE 0x1000
620#define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT __attribute__ ((aligned (PAGE_SIZE_MULTIPLE)))
621#else
622#define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT
Ed Warnickecb9cada2015-12-08 15:45:58 -0700623#endif
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000624
Ed Warnickecb9cada2015-12-08 15:45:58 -0700625 /* Process stack. Starts here and extends 2^log2_n_stack_bytes
626 bytes. */
627
628#define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000629 u32 stack[0] ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700630} vlib_process_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
631
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000632#ifdef CLIB_UNIX
633 /* Ensure that the stack is aligned on the multiple of the page size */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400634typedef char
635 assert_process_stack_must_be_aligned_exactly_to_page_size_multiple[(sizeof
636 (vlib_process_t)
637 -
638 PAGE_SIZE_MULTIPLE)
639 ==
640 0 ? 0 :
641 -1];
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000642#endif
643
Dave Barach9b8ffd92016-07-08 08:13:45 -0400644typedef struct
645{
646 u32 node_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700647
Dave Barach9b8ffd92016-07-08 08:13:45 -0400648 u32 one_time_event;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700649} vlib_one_time_waiting_process_t;
650
Dave Barach9b8ffd92016-07-08 08:13:45 -0400651typedef struct
652{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700653 u16 n_data_elts;
654
655 u16 n_data_elt_bytes;
656
657 /* n_data_elts * n_data_elt_bytes */
658 u32 n_data_bytes;
659
660 /* Process node & event type to be used to signal event. */
661 u32 process_node_index;
662
663 u32 event_type_index;
664
Dave Barach9b8ffd92016-07-08 08:13:45 -0400665 union
666 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700667 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
668
669 /* Vector of event data used only when data does not fit inline. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400670 u8 *event_data_as_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700671 };
Dave Barach9b8ffd92016-07-08 08:13:45 -0400672}
673vlib_signal_timed_event_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700674
675always_inline uword
676vlib_timing_wheel_data_is_timed_event (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400677{
678 return d & 1;
679}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700680
681always_inline u32
682vlib_timing_wheel_data_set_suspended_process (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400683{
684 return 0 + 2 * i;
685}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700686
687always_inline u32
688vlib_timing_wheel_data_set_timed_event (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400689{
690 return 1 + 2 * i;
691}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700692
693always_inline uword
694vlib_timing_wheel_data_get_index (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400695{
696 return d / 2;
697}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700698
Dave Barach9b8ffd92016-07-08 08:13:45 -0400699typedef struct
700{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700701 /* Public nodes. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400702 vlib_node_t **nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700703
704 /* Node index hashed by node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400705 uword *node_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700706
707 u32 flags;
708#define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
709
710 /* Nodes segregated by type for cache locality.
711 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400712 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700713
714 /* Node runtime indices for input nodes with pending interrupts. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400715 u32 *pending_interrupt_node_runtime_indices;
Damjan Marion2c2b6402017-03-28 14:16:15 +0200716 clib_spinlock_t pending_interrupt_lock;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700717
718 /* Input nodes are switched from/to interrupt to/from polling mode
719 when average vector length goes above/below polling/interrupt
720 thresholds. */
721 u32 polling_threshold_vector_length;
722 u32 interrupt_threshold_vector_length;
723
724 /* Vector of next frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400725 vlib_next_frame_t *next_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700726
727 /* Vector of internal node's frames waiting to be called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400728 vlib_pending_frame_t *pending_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700729
730 /* Timing wheel for scheduling time-based node dispatch. */
Dave Barach5c20a012017-06-13 08:48:31 -0400731 void *timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700732
Dave Barach9b8ffd92016-07-08 08:13:45 -0400733 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700734
735 /* Opaque data vector added via timing_wheel_advance. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400736 u32 *data_from_advancing_timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700737
738 /* CPU time of next process to be ready on timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -0400739 f64 time_next_process_ready;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700740
741 /* Vector of process nodes.
742 One for each node of type VLIB_NODE_TYPE_PROCESS. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400743 vlib_process_t **processes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700744
745 /* Current running process or ~0 if no process running. */
746 u32 current_process_index;
747
748 /* Pool of pending process frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400749 vlib_pending_frame_t *suspended_process_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700750
751 /* Vector of event data vectors pending recycle. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400752 void **recycled_event_data_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700753
754 /* Current counts of nodes in each state. */
755 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
756
757 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400758 uword *frame_size_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700759
760 /* Per-size frame allocation information. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400761 vlib_frame_size_t *frame_sizes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700762
763 /* Time of last node runtime stats clear. */
764 f64 time_last_runtime_stats_clear;
765
766 /* Node registrations added by constructors */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400767 vlib_node_registration_t *node_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700768} vlib_node_main_t;
769
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200770
771#define FRAME_QUEUE_MAX_NELTS 32
Dave Barach9b8ffd92016-07-08 08:13:45 -0400772typedef struct
773{
774 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200775 u64 head;
776 u64 head_hint;
777 u64 tail;
778 u32 n_in_use;
779 u32 nelts;
780 u32 written;
781 u32 threshold;
782 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
783} frame_queue_trace_t;
784
Dave Barach9b8ffd92016-07-08 08:13:45 -0400785typedef struct
786{
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200787 u64 count[FRAME_QUEUE_MAX_NELTS];
788} frame_queue_nelt_counter_t;
789
Ed Warnickecb9cada2015-12-08 15:45:58 -0700790#endif /* included_vlib_node_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400791
792/*
793 * fd.io coding-style-patch-verification: ON
794 *
795 * Local Variables:
796 * eval: (c-set-style "gnu")
797 * End:
798 */