blob: bdc3c6b59ad456f8490baa019859e23dc99d7cde [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{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700403 /* Frame index. */
404 u32 frame_index;
405
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->frame_index = ~0;
444 nf->node_runtime_index = ~0;
445}
446
447/* A frame pending dispatch by main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400448typedef struct
449{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700450 /* Node and runtime for this frame. */
451 u32 node_runtime_index;
452
453 /* Frame index (in the heap). */
454 u32 frame_index;
455
456 /* Start of next frames for this node. */
457 u32 next_frame_index;
458
459 /* Special value for next_frame_index when there is no next frame. */
460#define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
461} vlib_pending_frame_t;
462
Dave Barach9b8ffd92016-07-08 08:13:45 -0400463typedef struct vlib_node_runtime_t
464{
Damjan Marione9f929b2017-03-16 11:32:09 +0100465 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700466
Damjan Marione9f929b2017-03-16 11:32:09 +0100467 vlib_node_function_t *function; /**< Node function to call. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700468
Damjan Marione9f929b2017-03-16 11:32:09 +0100469 vlib_error_t *errors; /**< Vector of errors for this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700470
Damjan Marion36c13082017-04-24 20:58:29 +0200471#if __SIZEOF_POINTER__ == 4
472 u8 pad[8];
473#endif
474
Damjan Marione9f929b2017-03-16 11:32:09 +0100475 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700476
Damjan Marione9f929b2017-03-16 11:32:09 +0100477 u32 max_clock; /**< Maximum clock cycle for an
478 invocation. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700479
Damjan Marione9f929b2017-03-16 11:32:09 +0100480 u32 max_clock_n; /**< Number of vectors in the recorded
481 max_clock. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700482
Damjan Marione9f929b2017-03-16 11:32:09 +0100483 u32 calls_since_last_overflow; /**< Number of calls. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700484
Damjan Marione9f929b2017-03-16 11:32:09 +0100485 u32 vectors_since_last_overflow; /**< Number of vector elements
486 processed by this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700487
Dave Barachec595ef2019-01-24 10:34:24 -0500488 u32 perf_counter0_ticks_since_last_overflow; /**< Perf counter 0 ticks */
489 u32 perf_counter1_ticks_since_last_overflow; /**< Perf counter 1 ticks */
Dave Barach4d1a8662018-09-10 12:31:15 -0400490 u32 perf_counter_vectors_since_last_overflow; /**< Perf counter vectors */
491
Damjan Marione9f929b2017-03-16 11:32:09 +0100492 u32 next_frame_index; /**< Start of next frames for this
493 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700494
Damjan Marione9f929b2017-03-16 11:32:09 +0100495 u32 node_index; /**< Node index. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700496
Damjan Marione9f929b2017-03-16 11:32:09 +0100497 u32 input_main_loops_per_call; /**< For input nodes: decremented
498 on each main loop interation until
499 it reaches zero and function is
500 called. Allows some input nodes to
501 be called more than others. */
502
503 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
504 dispatch of this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700505
506 u32 main_loop_vector_stats[2];
507
Damjan Marione9f929b2017-03-16 11:32:09 +0100508 u16 flags; /**< Copy of main node flags. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700509
Damjan Marione9f929b2017-03-16 11:32:09 +0100510 u16 state; /**< Input node state. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700511
512 u16 n_next_nodes;
513
Damjan Marione9f929b2017-03-16 11:32:09 +0100514 u16 cached_next_index; /**< Next frame index that vector
515 arguments were last enqueued to
516 last time this node ran. Set to
517 zero before first run of this
518 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700519
Damjan Marion586afd72017-04-05 19:18:20 +0200520 u16 thread_index; /**< thread this node runs on */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700521
Damjan Marione9f929b2017-03-16 11:32:09 +0100522 u8 runtime_data[0]; /**< Function dependent
523 node-runtime data. This data is
524 thread local, and it is not
525 cloned from main thread. It needs
526 to be initialized for each thread
527 before it is used unless
528 runtime_data template exists in
529 vlib_node_t. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400530}
531vlib_node_runtime_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700532
Damjan Marione9f929b2017-03-16 11:32:09 +0100533#define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
534
Dave Barach9b8ffd92016-07-08 08:13:45 -0400535typedef struct
536{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700537 /* Number of allocated frames for this scalar/vector size. */
538 u32 n_alloc_frames;
539
540 /* Vector of free frame indices for this scalar/vector size. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400541 u32 *free_frame_indices;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700542} vlib_frame_size_t;
543
Dave Barach9b8ffd92016-07-08 08:13:45 -0400544typedef struct
545{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700546 /* Users opaque value for event type. */
547 uword opaque;
548} vlib_process_event_type_t;
549
Dave Barach9b8ffd92016-07-08 08:13:45 -0400550typedef struct
551{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700552 /* Node runtime for this process. */
553 vlib_node_runtime_t node_runtime;
554
555 /* Where to longjmp when process is done. */
556 clib_longjmp_t return_longjmp;
557
558#define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
559#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
560
561 /* Where to longjmp to resume node after suspend. */
562 clib_longjmp_t resume_longjmp;
563#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
564#define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
565
566 u16 flags;
567#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
568#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
569 /* Set to indicate that this process has been added to resume vector. */
570#define VLIB_PROCESS_RESUME_PENDING (1 << 2)
571
572 /* Process function is currently running. */
573#define VLIB_PROCESS_IS_RUNNING (1 << 3)
574
575 /* Size of process stack. */
576 u16 log2_n_stack_bytes;
577
578 u32 suspended_process_frame_index;
579
580 /* Number of times this process was suspended. */
581 u32 n_suspends;
582
583 /* Vectors of pending event data indexed by event type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400584 void **pending_event_data_by_type_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700585
586 /* Bitmap of event type-indices with non-empty vectors. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400587 uword *non_empty_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700588
589 /* Bitmap of event type-indices which are one time events. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400590 uword *one_time_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700591
592 /* Type is opaque pointer -- typically a pointer to an event handler
593 function. Hash table to map opaque to a type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400594 uword *event_type_index_by_type_opaque;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700595
596 /* Pool of currently valid event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400597 vlib_process_event_type_t *event_type_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700598
Dave Barach5c20a012017-06-13 08:48:31 -0400599 /*
600 * When suspending saves clock time (10us ticks) when process
601 * is to be resumed.
602 */
603 u64 resume_clock_interval;
604
605 /* Handle from timer code, to cancel an unexpired timer */
606 u32 stop_timer_handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700607
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000608 /* Default output function and its argument for any CLI outputs
609 within the process. */
610 vlib_cli_output_function_t *output_function;
611 uword output_function_arg;
612
Ed Warnickecb9cada2015-12-08 15:45:58 -0700613#ifdef CLIB_UNIX
614 /* Pad to a multiple of the page size so we can mprotect process stacks */
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000615#define PAGE_SIZE_MULTIPLE 0x1000
616#define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT __attribute__ ((aligned (PAGE_SIZE_MULTIPLE)))
617#else
618#define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT
Ed Warnickecb9cada2015-12-08 15:45:58 -0700619#endif
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000620
Ed Warnickecb9cada2015-12-08 15:45:58 -0700621 /* Process stack. Starts here and extends 2^log2_n_stack_bytes
622 bytes. */
623
624#define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000625 u32 stack[0] ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700626} vlib_process_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
627
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000628#ifdef CLIB_UNIX
629 /* Ensure that the stack is aligned on the multiple of the page size */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400630typedef char
631 assert_process_stack_must_be_aligned_exactly_to_page_size_multiple[(sizeof
632 (vlib_process_t)
633 -
634 PAGE_SIZE_MULTIPLE)
635 ==
636 0 ? 0 :
637 -1];
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000638#endif
639
Dave Barach9b8ffd92016-07-08 08:13:45 -0400640typedef struct
641{
642 u32 node_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700643
Dave Barach9b8ffd92016-07-08 08:13:45 -0400644 u32 one_time_event;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700645} vlib_one_time_waiting_process_t;
646
Dave Barach9b8ffd92016-07-08 08:13:45 -0400647typedef struct
648{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700649 u16 n_data_elts;
650
651 u16 n_data_elt_bytes;
652
653 /* n_data_elts * n_data_elt_bytes */
654 u32 n_data_bytes;
655
656 /* Process node & event type to be used to signal event. */
657 u32 process_node_index;
658
659 u32 event_type_index;
660
Dave Barach9b8ffd92016-07-08 08:13:45 -0400661 union
662 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700663 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
664
665 /* Vector of event data used only when data does not fit inline. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400666 u8 *event_data_as_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700667 };
Dave Barach9b8ffd92016-07-08 08:13:45 -0400668}
669vlib_signal_timed_event_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700670
671always_inline uword
672vlib_timing_wheel_data_is_timed_event (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400673{
674 return d & 1;
675}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700676
677always_inline u32
678vlib_timing_wheel_data_set_suspended_process (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400679{
680 return 0 + 2 * i;
681}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700682
683always_inline u32
684vlib_timing_wheel_data_set_timed_event (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400685{
686 return 1 + 2 * i;
687}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700688
689always_inline uword
690vlib_timing_wheel_data_get_index (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400691{
692 return d / 2;
693}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700694
Dave Barach9b8ffd92016-07-08 08:13:45 -0400695typedef struct
696{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700697 /* Public nodes. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400698 vlib_node_t **nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700699
700 /* Node index hashed by node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400701 uword *node_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700702
703 u32 flags;
704#define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
705
706 /* Nodes segregated by type for cache locality.
707 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400708 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700709
710 /* Node runtime indices for input nodes with pending interrupts. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400711 u32 *pending_interrupt_node_runtime_indices;
Damjan Marion2c2b6402017-03-28 14:16:15 +0200712 clib_spinlock_t pending_interrupt_lock;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700713
714 /* Input nodes are switched from/to interrupt to/from polling mode
715 when average vector length goes above/below polling/interrupt
716 thresholds. */
717 u32 polling_threshold_vector_length;
718 u32 interrupt_threshold_vector_length;
719
720 /* Vector of next frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400721 vlib_next_frame_t *next_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700722
723 /* Vector of internal node's frames waiting to be called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400724 vlib_pending_frame_t *pending_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700725
726 /* Timing wheel for scheduling time-based node dispatch. */
Dave Barach5c20a012017-06-13 08:48:31 -0400727 void *timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700728
Dave Barach9b8ffd92016-07-08 08:13:45 -0400729 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700730
731 /* Opaque data vector added via timing_wheel_advance. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400732 u32 *data_from_advancing_timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700733
734 /* CPU time of next process to be ready on timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -0400735 f64 time_next_process_ready;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700736
737 /* Vector of process nodes.
738 One for each node of type VLIB_NODE_TYPE_PROCESS. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400739 vlib_process_t **processes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700740
741 /* Current running process or ~0 if no process running. */
742 u32 current_process_index;
743
744 /* Pool of pending process frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400745 vlib_pending_frame_t *suspended_process_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700746
747 /* Vector of event data vectors pending recycle. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400748 void **recycled_event_data_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700749
750 /* Current counts of nodes in each state. */
751 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
752
753 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400754 uword *frame_size_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700755
756 /* Per-size frame allocation information. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400757 vlib_frame_size_t *frame_sizes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700758
759 /* Time of last node runtime stats clear. */
760 f64 time_last_runtime_stats_clear;
761
762 /* Node registrations added by constructors */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400763 vlib_node_registration_t *node_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700764} vlib_node_main_t;
765
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200766
767#define FRAME_QUEUE_MAX_NELTS 32
Dave Barach9b8ffd92016-07-08 08:13:45 -0400768typedef struct
769{
770 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200771 u64 head;
772 u64 head_hint;
773 u64 tail;
774 u32 n_in_use;
775 u32 nelts;
776 u32 written;
777 u32 threshold;
778 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
779} frame_queue_trace_t;
780
Dave Barach9b8ffd92016-07-08 08:13:45 -0400781typedef struct
782{
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200783 u64 count[FRAME_QUEUE_MAX_NELTS];
784} frame_queue_nelt_counter_t;
785
Ed Warnickecb9cada2015-12-08 15:45:58 -0700786#endif /* included_vlib_node_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400787
788/*
789 * fd.io coding-style-patch-verification: ON
790 *
791 * Local Variables:
792 * eval: (c-set-style "gnu")
793 * End:
794 */