blob: 277cee89cafe21029b288808457e82288e0efcf5 [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;
83} vlib_node_fn_registration_t;
84
Dave Barach9b8ffd92016-07-08 08:13:45 -040085typedef struct _vlib_node_registration
86{
Ed Warnickecb9cada2015-12-08 15:45:58 -070087 /* Vector processing function for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -040088 vlib_node_function_t *function;
Ed Warnickecb9cada2015-12-08 15:45:58 -070089
Damjan Marion812b32d2018-05-28 21:26:47 +020090 /* Node function candidate registration with priority */
91 vlib_node_fn_registration_t *node_fn_registrations;
92
Ed Warnickecb9cada2015-12-08 15:45:58 -070093 /* Node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -040094 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -070095
96 /* Name of sibling (if applicable). */
Dave Barach9b8ffd92016-07-08 08:13:45 -040097 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -070098
99 /* Node index filled in by registration. */
100 u32 index;
101
102 /* Type of this node. */
103 vlib_node_type_t type;
104
105 /* Error strings indexed by error code for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400106 char **error_strings;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700107
108 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400109 format_function_t *format_buffer;
110 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700111
112 /* Trace format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400113 format_function_t *format_trace;
114 unformat_function_t *unformat_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700115
116 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400117 u8 *(*validate_frame) (struct vlib_main_t * vm,
118 struct vlib_node_runtime_t *,
119 struct vlib_frame_t * f);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700120
121 /* Per-node runtime data. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400122 void *runtime_data;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700123
124 /* Process stack size. */
125 u16 process_log2_n_stack_bytes;
126
127 /* Number of bytes of per-node run time data. */
128 u8 runtime_data_bytes;
129
130 /* State for input nodes. */
131 u8 state;
132
133 /* Node flags. */
134 u16 flags;
135
136 /* Size of scalar and vector arguments in bytes. */
137 u16 scalar_size, vector_size;
138
139 /* Number of error codes used by this node. */
140 u16 n_errors;
141
142 /* Number of next node names that follow. */
143 u16 n_next_nodes;
144
145 /* Constructor link-list, don't ask... */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400146 struct _vlib_node_registration *next_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700147
148 /* Names of next nodes which this node feeds into. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400149 char *next_nodes[];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700150
151} vlib_node_registration_t;
152
Damjan Marion6e363512018-08-10 22:39:11 +0200153#ifndef CLIB_MARCH_VARIANT
Ed Warnickecb9cada2015-12-08 15:45:58 -0700154#define VLIB_REGISTER_NODE(x,...) \
155 __VA_ARGS__ vlib_node_registration_t x; \
156static void __vlib_add_node_registration_##x (void) \
157 __attribute__((__constructor__)) ; \
158static void __vlib_add_node_registration_##x (void) \
159{ \
160 vlib_main_t * vm = vlib_get_main(); \
161 x.next_registration = vm->node_main.node_registrations; \
162 vm->node_main.node_registrations = &x; \
163} \
Damjan Marion72d2c4f2018-04-05 21:32:29 +0200164static void __vlib_rm_node_registration_##x (void) \
165 __attribute__((__destructor__)) ; \
166static void __vlib_rm_node_registration_##x (void) \
167{ \
168 vlib_main_t * vm = vlib_get_main(); \
169 VLIB_REMOVE_FROM_LINKED_LIST (vm->node_main.node_registrations, \
170 &x, next_registration); \
171} \
Dave Barach9b8ffd92016-07-08 08:13:45 -0400172__VA_ARGS__ vlib_node_registration_t x
Damjan Marion6e363512018-08-10 22:39:11 +0200173#else
174#define VLIB_REGISTER_NODE(x,...) \
175static __clib_unused vlib_node_registration_t __clib_unused_##x
176#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700177
Damjan Marion812b32d2018-05-28 21:26:47 +0200178#define VLIB_NODE_FN(node) \
179uword CLIB_MARCH_SFX (node##_fn)(); \
180static vlib_node_fn_registration_t \
181 CLIB_MARCH_SFX(node##_fn_registration) = \
182 { .function = &CLIB_MARCH_SFX (node##_fn), }; \
183 \
184static void __clib_constructor \
185CLIB_MARCH_SFX (node##_multiarch_register) (void) \
186{ \
187 extern vlib_node_registration_t node; \
188 vlib_node_fn_registration_t *r; \
189 r = & CLIB_MARCH_SFX (node##_fn_registration); \
190 r->priority = CLIB_MARCH_FN_PRIORITY(); \
191 r->next_registration = node.node_fn_registrations; \
192 node.node_fn_registrations = r; \
193} \
194uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (node##_fn)
195
Damjan Marion1c80e832016-05-11 23:07:18 +0200196#if CLIB_DEBUG > 0
197#define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn)
198#define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn)
199#define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
200#else
201#define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
202 uword \
203 __attribute__ ((flatten)) \
204 __attribute__ ((target (tgt))) \
205 CLIB_CPU_OPTIMIZED \
206 fn ## _ ## arch ( struct vlib_main_t * vm, \
207 struct vlib_node_runtime_t * node, \
208 struct vlib_frame_t * frame) \
209 { return fn (vm, node, frame); }
210
211#define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn) \
212 foreach_march_variant(VLIB_NODE_FUNCTION_CLONE_TEMPLATE, fn)
213
214#define VLIB_NODE_FUNCTION_MULTIARCH(node, fn) \
215 VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn) \
216 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
217 static void __attribute__((__constructor__)) \
218 __vlib_node_function_multiarch_select_##node (void) \
219 { node.function = fn ## _multiarch_select(); }
220#endif
221
Ed Warnickecb9cada2015-12-08 15:45:58 -0700222always_inline vlib_node_registration_t *
223vlib_node_next_registered (vlib_node_registration_t * c)
224{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400225 c =
226 clib_elf_section_data_next (c,
227 c->n_next_nodes * sizeof (c->next_nodes[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700228 return c;
229}
230
Dave Barach9b8ffd92016-07-08 08:13:45 -0400231typedef struct
232{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700233 /* Total calls, clock ticks and vector elements processed for this node. */
234 u64 calls, vectors, clocks, suspends;
235 u64 max_clock;
236 u64 max_clock_n;
237} vlib_node_stats_t;
238
239#define foreach_vlib_node_state \
240 /* Input node is called each iteration of main loop. \
241 This is the default (zero). */ \
242 _ (POLLING) \
243 /* Input node is called when device signals an interrupt. */ \
244 _ (INTERRUPT) \
245 /* Input node is never called. */ \
246 _ (DISABLED)
247
Dave Barach9b8ffd92016-07-08 08:13:45 -0400248typedef enum
249{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700250#define _(f) VLIB_NODE_STATE_##f,
251 foreach_vlib_node_state
252#undef _
Dave Barach9b8ffd92016-07-08 08:13:45 -0400253 VLIB_N_NODE_STATE,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700254} vlib_node_state_t;
255
Dave Barach9b8ffd92016-07-08 08:13:45 -0400256typedef struct vlib_node_t
257{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700258 /* Vector processing function for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400259 vlib_node_function_t *function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700260
261 /* Node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400262 u8 *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700263
264 /* Node name index in elog string table. */
265 u32 name_elog_string;
266
267 /* Total statistics for this node. */
268 vlib_node_stats_t stats_total;
269
270 /* Saved values as of last clear (or zero if never cleared).
271 Current values are always stats_total - stats_last_clear. */
272 vlib_node_stats_t stats_last_clear;
273
274 /* Type of this node. */
275 vlib_node_type_t type;
276
277 /* Node index. */
278 u32 index;
279
280 /* Index of corresponding node runtime. */
281 u32 runtime_index;
282
283 /* Runtime data for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400284 void *runtime_data;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700285
286 /* Node flags. */
287 u16 flags;
288
289 /* Processing function keeps frame. Tells node dispatching code not
290 to free frame after dispatch is done. */
291#define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
292
293 /* Node counts as output/drop/punt node for stats purposes. */
294#define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
295#define VLIB_NODE_FLAG_IS_DROP (1 << 2)
296#define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
297#define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
298
299 /* Set if current node runtime has traced vectors. */
300#define VLIB_NODE_FLAG_TRACE (1 << 5)
301
302#define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
303#define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
304
305 /* State for input nodes. */
306 u8 state;
307
308 /* Number of bytes of run time data. */
309 u8 runtime_data_bytes;
310
311 /* Number of error codes used by this node. */
312 u16 n_errors;
313
314 /* Size of scalar and vector arguments in bytes. */
315 u16 scalar_size, vector_size;
316
317 /* Handle/index in error heap for this node. */
318 u32 error_heap_handle;
319 u32 error_heap_index;
320
321 /* Error strings indexed by error code for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400322 char **error_strings;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700323
324 /* Vector of next node names.
325 Only used before next_nodes array is initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400326 char **next_node_names;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700327
328 /* Next node indices for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400329 u32 *next_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700330
331 /* Name of node that we are sibling of. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400332 char *sibling_of;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700333
334 /* Bitmap of all of this node's siblings. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400335 uword *sibling_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700336
337 /* Total number of vectors sent to each next node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400338 u64 *n_vectors_by_next_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700339
340 /* Hash table mapping next node index into slot in
341 next_nodes vector. Quickly determines whether this node
342 is connected to given next node and, if so, with which slot. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400343 uword *next_slot_by_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700344
345 /* Bitmap of node indices which feed this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400346 uword *prev_node_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700347
348 /* Node/next-index which own enqueue rights with to this node. */
349 u32 owner_node_index, owner_next_index;
350
351 /* Buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400352 format_function_t *format_buffer;
353 unformat_function_t *unformat_buffer;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700354
355 /* Trace buffer format/unformat for this node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400356 format_function_t *format_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700357
358 /* Function to validate incoming frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400359 u8 *(*validate_frame) (struct vlib_main_t * vm,
360 struct vlib_node_runtime_t *,
361 struct vlib_frame_t * f);
Dave Barach6931f592016-05-13 12:55:01 -0400362 /* for pretty-printing, not typically valid */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400363 u8 *state_string;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700364} vlib_node_t;
365
366#define VLIB_INVALID_NODE_INDEX ((u32) ~0)
367
368/* Max number of vector elements to process at once per node. */
369#define VLIB_FRAME_SIZE 256
Dave Barachd84ba852017-08-22 17:56:46 -0400370#define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
Ed Warnickecb9cada2015-12-08 15:45:58 -0700371
372/* Calling frame (think stack frame) for a node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400373typedef struct vlib_frame_t
374{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700375 /* Frame flags. */
376 u16 flags;
377
378 /* Number of scalar bytes in arguments. */
379 u8 scalar_size;
380
381 /* Number of bytes per vector argument. */
382 u8 vector_size;
383
384 /* Number of vector elements currently in frame. */
385 u16 n_vectors;
386
Ed Warnickecb9cada2015-12-08 15:45:58 -0700387 /* Scalar and vector arguments to next node. */
388 u8 arguments[0];
389} vlib_frame_t;
390
Dave Barach9b8ffd92016-07-08 08:13:45 -0400391typedef struct
392{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700393 /* Frame index. */
394 u32 frame_index;
395
396 /* Node runtime for this next. */
397 u32 node_runtime_index;
398
399 /* Next frame flags. */
400 u32 flags;
401
402 /* Reflects node frame-used flag for this next. */
403#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
404 VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
405
406 /* This next frame owns enqueue to node
407 corresponding to node_runtime_index. */
408#define VLIB_FRAME_OWNER (1 << 15)
409
410 /* Set when frame has been allocated for this next. */
411#define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
412
413 /* Set when frame has been added to pending vector. */
414#define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
415
416 /* Set when frame is to be freed after dispatch. */
417#define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
418
419 /* Set when frame has traced packets. */
420#define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
421
422 /* Number of vectors enqueue to this next since last overflow. */
423 u32 vectors_since_last_overflow;
424} vlib_next_frame_t;
425
426always_inline void
427vlib_next_frame_init (vlib_next_frame_t * nf)
428{
429 memset (nf, 0, sizeof (nf[0]));
430 nf->frame_index = ~0;
431 nf->node_runtime_index = ~0;
432}
433
434/* A frame pending dispatch by main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400435typedef struct
436{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700437 /* Node and runtime for this frame. */
438 u32 node_runtime_index;
439
440 /* Frame index (in the heap). */
441 u32 frame_index;
442
443 /* Start of next frames for this node. */
444 u32 next_frame_index;
445
446 /* Special value for next_frame_index when there is no next frame. */
447#define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
448} vlib_pending_frame_t;
449
Dave Barach9b8ffd92016-07-08 08:13:45 -0400450typedef struct vlib_node_runtime_t
451{
Damjan Marione9f929b2017-03-16 11:32:09 +0100452 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700453
Damjan Marione9f929b2017-03-16 11:32:09 +0100454 vlib_node_function_t *function; /**< Node function to call. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700455
Damjan Marione9f929b2017-03-16 11:32:09 +0100456 vlib_error_t *errors; /**< Vector of errors for this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700457
Damjan Marion36c13082017-04-24 20:58:29 +0200458#if __SIZEOF_POINTER__ == 4
459 u8 pad[8];
460#endif
461
Damjan Marione9f929b2017-03-16 11:32:09 +0100462 u32 clocks_since_last_overflow; /**< Number of clock cycles. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700463
Damjan Marione9f929b2017-03-16 11:32:09 +0100464 u32 max_clock; /**< Maximum clock cycle for an
465 invocation. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700466
Damjan Marione9f929b2017-03-16 11:32:09 +0100467 u32 max_clock_n; /**< Number of vectors in the recorded
468 max_clock. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700469
Damjan Marione9f929b2017-03-16 11:32:09 +0100470 u32 calls_since_last_overflow; /**< Number of calls. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700471
Damjan Marione9f929b2017-03-16 11:32:09 +0100472 u32 vectors_since_last_overflow; /**< Number of vector elements
473 processed by this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700474
Damjan Marione9f929b2017-03-16 11:32:09 +0100475 u32 next_frame_index; /**< Start of next frames for this
476 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700477
Damjan Marione9f929b2017-03-16 11:32:09 +0100478 u32 node_index; /**< Node index. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700479
Damjan Marione9f929b2017-03-16 11:32:09 +0100480 u32 input_main_loops_per_call; /**< For input nodes: decremented
481 on each main loop interation until
482 it reaches zero and function is
483 called. Allows some input nodes to
484 be called more than others. */
485
486 u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last
487 dispatch of this node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700488
489 u32 main_loop_vector_stats[2];
490
Damjan Marione9f929b2017-03-16 11:32:09 +0100491 u16 flags; /**< Copy of main node flags. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700492
Damjan Marione9f929b2017-03-16 11:32:09 +0100493 u16 state; /**< Input node state. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700494
495 u16 n_next_nodes;
496
Damjan Marione9f929b2017-03-16 11:32:09 +0100497 u16 cached_next_index; /**< Next frame index that vector
498 arguments were last enqueued to
499 last time this node ran. Set to
500 zero before first run of this
501 node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700502
Damjan Marion586afd72017-04-05 19:18:20 +0200503 u16 thread_index; /**< thread this node runs on */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700504
Damjan Marione9f929b2017-03-16 11:32:09 +0100505 u8 runtime_data[0]; /**< Function dependent
506 node-runtime data. This data is
507 thread local, and it is not
508 cloned from main thread. It needs
509 to be initialized for each thread
510 before it is used unless
511 runtime_data template exists in
512 vlib_node_t. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400513}
514vlib_node_runtime_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700515
Damjan Marione9f929b2017-03-16 11:32:09 +0100516#define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
517
Dave Barach9b8ffd92016-07-08 08:13:45 -0400518typedef struct
519{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700520 /* Number of allocated frames for this scalar/vector size. */
521 u32 n_alloc_frames;
522
523 /* Vector of free frame indices for this scalar/vector size. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400524 u32 *free_frame_indices;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700525} vlib_frame_size_t;
526
Dave Barach9b8ffd92016-07-08 08:13:45 -0400527typedef struct
528{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700529 /* Users opaque value for event type. */
530 uword opaque;
531} vlib_process_event_type_t;
532
Dave Barach9b8ffd92016-07-08 08:13:45 -0400533typedef struct
534{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700535 /* Node runtime for this process. */
536 vlib_node_runtime_t node_runtime;
537
538 /* Where to longjmp when process is done. */
539 clib_longjmp_t return_longjmp;
540
541#define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
542#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
543
544 /* Where to longjmp to resume node after suspend. */
545 clib_longjmp_t resume_longjmp;
546#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
547#define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1
548
549 u16 flags;
550#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
551#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
552 /* Set to indicate that this process has been added to resume vector. */
553#define VLIB_PROCESS_RESUME_PENDING (1 << 2)
554
555 /* Process function is currently running. */
556#define VLIB_PROCESS_IS_RUNNING (1 << 3)
557
558 /* Size of process stack. */
559 u16 log2_n_stack_bytes;
560
561 u32 suspended_process_frame_index;
562
563 /* Number of times this process was suspended. */
564 u32 n_suspends;
565
566 /* Vectors of pending event data indexed by event type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400567 void **pending_event_data_by_type_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700568
569 /* Bitmap of event type-indices with non-empty vectors. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400570 uword *non_empty_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700571
572 /* Bitmap of event type-indices which are one time events. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400573 uword *one_time_event_type_bitmap;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700574
575 /* Type is opaque pointer -- typically a pointer to an event handler
576 function. Hash table to map opaque to a type index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400577 uword *event_type_index_by_type_opaque;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700578
579 /* Pool of currently valid event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400580 vlib_process_event_type_t *event_type_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700581
Dave Barach5c20a012017-06-13 08:48:31 -0400582 /*
583 * When suspending saves clock time (10us ticks) when process
584 * is to be resumed.
585 */
586 u64 resume_clock_interval;
587
588 /* Handle from timer code, to cancel an unexpired timer */
589 u32 stop_timer_handle;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700590
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000591 /* Default output function and its argument for any CLI outputs
592 within the process. */
593 vlib_cli_output_function_t *output_function;
594 uword output_function_arg;
595
Ed Warnickecb9cada2015-12-08 15:45:58 -0700596#ifdef CLIB_UNIX
597 /* Pad to a multiple of the page size so we can mprotect process stacks */
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000598#define PAGE_SIZE_MULTIPLE 0x1000
599#define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT __attribute__ ((aligned (PAGE_SIZE_MULTIPLE)))
600#else
601#define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT
Ed Warnickecb9cada2015-12-08 15:45:58 -0700602#endif
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000603
Ed Warnickecb9cada2015-12-08 15:45:58 -0700604 /* Process stack. Starts here and extends 2^log2_n_stack_bytes
605 bytes. */
606
607#define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000608 u32 stack[0] ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700609} vlib_process_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
610
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000611#ifdef CLIB_UNIX
612 /* Ensure that the stack is aligned on the multiple of the page size */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400613typedef char
614 assert_process_stack_must_be_aligned_exactly_to_page_size_multiple[(sizeof
615 (vlib_process_t)
616 -
617 PAGE_SIZE_MULTIPLE)
618 ==
619 0 ? 0 :
620 -1];
Andrew Yourtchenko716d9592016-05-10 10:51:34 +0000621#endif
622
Dave Barach9b8ffd92016-07-08 08:13:45 -0400623typedef struct
624{
625 u32 node_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700626
Dave Barach9b8ffd92016-07-08 08:13:45 -0400627 u32 one_time_event;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700628} vlib_one_time_waiting_process_t;
629
Dave Barach9b8ffd92016-07-08 08:13:45 -0400630typedef struct
631{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700632 u16 n_data_elts;
633
634 u16 n_data_elt_bytes;
635
636 /* n_data_elts * n_data_elt_bytes */
637 u32 n_data_bytes;
638
639 /* Process node & event type to be used to signal event. */
640 u32 process_node_index;
641
642 u32 event_type_index;
643
Dave Barach9b8ffd92016-07-08 08:13:45 -0400644 union
645 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700646 u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
647
648 /* Vector of event data used only when data does not fit inline. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400649 u8 *event_data_as_vector;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700650 };
Dave Barach9b8ffd92016-07-08 08:13:45 -0400651}
652vlib_signal_timed_event_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700653
654always_inline uword
655vlib_timing_wheel_data_is_timed_event (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400656{
657 return d & 1;
658}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700659
660always_inline u32
661vlib_timing_wheel_data_set_suspended_process (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400662{
663 return 0 + 2 * i;
664}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700665
666always_inline u32
667vlib_timing_wheel_data_set_timed_event (u32 i)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400668{
669 return 1 + 2 * i;
670}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700671
672always_inline uword
673vlib_timing_wheel_data_get_index (u32 d)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400674{
675 return d / 2;
676}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700677
Dave Barach9b8ffd92016-07-08 08:13:45 -0400678typedef struct
679{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700680 /* Public nodes. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400681 vlib_node_t **nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700682
683 /* Node index hashed by node name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400684 uword *node_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700685
686 u32 flags;
687#define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
688
689 /* Nodes segregated by type for cache locality.
690 Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400691 vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700692
693 /* Node runtime indices for input nodes with pending interrupts. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400694 u32 *pending_interrupt_node_runtime_indices;
Damjan Marion2c2b6402017-03-28 14:16:15 +0200695 clib_spinlock_t pending_interrupt_lock;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700696
697 /* Input nodes are switched from/to interrupt to/from polling mode
698 when average vector length goes above/below polling/interrupt
699 thresholds. */
700 u32 polling_threshold_vector_length;
701 u32 interrupt_threshold_vector_length;
702
703 /* Vector of next frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400704 vlib_next_frame_t *next_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700705
706 /* Vector of internal node's frames waiting to be called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400707 vlib_pending_frame_t *pending_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700708
709 /* Timing wheel for scheduling time-based node dispatch. */
Dave Barach5c20a012017-06-13 08:48:31 -0400710 void *timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700711
Dave Barach9b8ffd92016-07-08 08:13:45 -0400712 vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700713
714 /* Opaque data vector added via timing_wheel_advance. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400715 u32 *data_from_advancing_timing_wheel;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700716
717 /* CPU time of next process to be ready on timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -0400718 f64 time_next_process_ready;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700719
720 /* Vector of process nodes.
721 One for each node of type VLIB_NODE_TYPE_PROCESS. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400722 vlib_process_t **processes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700723
724 /* Current running process or ~0 if no process running. */
725 u32 current_process_index;
726
727 /* Pool of pending process frames. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400728 vlib_pending_frame_t *suspended_process_frames;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700729
730 /* Vector of event data vectors pending recycle. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400731 void **recycled_event_data_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700732
733 /* Current counts of nodes in each state. */
734 u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
735
736 /* Hash of (scalar_size,vector_size) to frame_sizes index. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400737 uword *frame_size_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700738
739 /* Per-size frame allocation information. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400740 vlib_frame_size_t *frame_sizes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700741
742 /* Time of last node runtime stats clear. */
743 f64 time_last_runtime_stats_clear;
744
745 /* Node registrations added by constructors */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400746 vlib_node_registration_t *node_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700747} vlib_node_main_t;
748
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200749
750#define FRAME_QUEUE_MAX_NELTS 32
Dave Barach9b8ffd92016-07-08 08:13:45 -0400751typedef struct
752{
753 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200754 u64 head;
755 u64 head_hint;
756 u64 tail;
757 u32 n_in_use;
758 u32 nelts;
759 u32 written;
760 u32 threshold;
761 i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
762} frame_queue_trace_t;
763
Dave Barach9b8ffd92016-07-08 08:13:45 -0400764typedef struct
765{
Damjan Marion0f8ecf02016-06-27 08:30:30 +0200766 u64 count[FRAME_QUEUE_MAX_NELTS];
767} frame_queue_nelt_counter_t;
768
Ed Warnickecb9cada2015-12-08 15:45:58 -0700769#endif /* included_vlib_node_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400770
771/*
772 * fd.io coding-style-patch-verification: ON
773 *
774 * Local Variables:
775 * eval: (c-set-style "gnu")
776 * End:
777 */