Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 1 | /* |
| 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 Marion | 1c80e83 | 2016-05-11 23:07:18 +0200 | [diff] [blame] | 43 | #include <vppinfra/cpu.h> |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 44 | #include <vppinfra/longjmp.h> |
Damjan Marion | 2c2b640 | 2017-03-28 14:16:15 +0200 | [diff] [blame] | 45 | #include <vppinfra/lock.h> |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 46 | #include <vlib/trace.h> /* for vlib_trace_filter_t */ |
| 47 | |
| 48 | /* Forward declaration. */ |
| 49 | struct vlib_node_runtime_t; |
| 50 | struct 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). */ |
| 54 | typedef 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 Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 58 | typedef enum |
| 59 | { |
Dave Barach | 7fff3d2 | 2018-11-27 16:52:59 -0500 | [diff] [blame] | 60 | 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 | |
| 69 | typedef enum |
| 70 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 71 | /* 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 Marion | 812b32d | 2018-05-28 21:26:47 +0200 | [diff] [blame] | 89 | typedef struct _vlib_node_fn_registration |
| 90 | { |
| 91 | vlib_node_function_t *function; |
Damjan Marion | a31698b | 2021-03-10 14:35:28 +0100 | [diff] [blame] | 92 | clib_march_variant_type_t march_variant; |
Damjan Marion | 812b32d | 2018-05-28 21:26:47 +0200 | [diff] [blame] | 93 | struct _vlib_node_fn_registration *next_registration; |
| 94 | } vlib_node_fn_registration_t; |
| 95 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 96 | typedef struct _vlib_node_registration |
| 97 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 98 | /* Vector processing function for this node. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 99 | vlib_node_function_t *function; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 100 | |
Damjan Marion | 812b32d | 2018-05-28 21:26:47 +0200 | [diff] [blame] | 101 | /* Node function candidate registration with priority */ |
| 102 | vlib_node_fn_registration_t *node_fn_registrations; |
| 103 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 104 | /* Node name. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 105 | char *name; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 106 | |
| 107 | /* Name of sibling (if applicable). */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 108 | char *sibling_of; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 109 | |
| 110 | /* Node index filled in by registration. */ |
| 111 | u32 index; |
| 112 | |
| 113 | /* Type of this node. */ |
| 114 | vlib_node_type_t type; |
| 115 | |
| 116 | /* Error strings indexed by error code for this node. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 117 | char **error_strings; |
Ole Troan | 2c4acdd | 2021-05-06 14:09:50 +0200 | [diff] [blame] | 118 | vlib_error_desc_t *error_counters; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 119 | |
| 120 | /* Buffer format/unformat for this node. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 121 | format_function_t *format_buffer; |
| 122 | unformat_function_t *unformat_buffer; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 123 | |
| 124 | /* Trace format/unformat for this node. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 125 | format_function_t *format_trace; |
| 126 | unformat_function_t *unformat_trace; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 127 | |
| 128 | /* Function to validate incoming frames. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 129 | u8 *(*validate_frame) (struct vlib_main_t * vm, |
| 130 | struct vlib_node_runtime_t *, |
| 131 | struct vlib_frame_t * f); |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 132 | |
| 133 | /* Per-node runtime data. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 134 | void *runtime_data; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 135 | |
| 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 Barach | 7fff3d2 | 2018-11-27 16:52:59 -0500 | [diff] [blame] | 148 | /* protocol at b->data[b->current_data] upon entry to the dispatch fn */ |
| 149 | u8 protocol_hint; |
| 150 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 151 | /* 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 Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 161 | struct _vlib_node_registration *next_registration; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 162 | |
| 163 | /* Names of next nodes which this node feeds into. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 164 | char *next_nodes[]; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 165 | |
| 166 | } vlib_node_registration_t; |
| 167 | |
Damjan Marion | 6e36351 | 2018-08-10 22:39:11 +0200 | [diff] [blame] | 168 | #ifndef CLIB_MARCH_VARIANT |
Damjan Marion | fd8deb4 | 2021-03-06 12:26:28 +0100 | [diff] [blame] | 169 | #define VLIB_REGISTER_NODE(x, ...) \ |
| 170 | __VA_ARGS__ vlib_node_registration_t x; \ |
| 171 | static void __vlib_add_node_registration_##x (void) \ |
| 172 | __attribute__ ((__constructor__)); \ |
| 173 | static void __vlib_add_node_registration_##x (void) \ |
| 174 | { \ |
| 175 | vlib_global_main_t *vgm = vlib_get_global_main (); \ |
| 176 | x.next_registration = vgm->node_registrations; \ |
| 177 | vgm->node_registrations = &x; \ |
| 178 | } \ |
| 179 | static void __vlib_rm_node_registration_##x (void) \ |
| 180 | __attribute__ ((__destructor__)); \ |
| 181 | static void __vlib_rm_node_registration_##x (void) \ |
| 182 | { \ |
| 183 | vlib_global_main_t *vgm = vlib_get_global_main (); \ |
| 184 | VLIB_REMOVE_FROM_LINKED_LIST (vgm->node_registrations, &x, \ |
| 185 | next_registration); \ |
| 186 | } \ |
| 187 | __VA_ARGS__ vlib_node_registration_t x |
Damjan Marion | 6e36351 | 2018-08-10 22:39:11 +0200 | [diff] [blame] | 188 | #else |
| 189 | #define VLIB_REGISTER_NODE(x,...) \ |
Damjan Marion | d770cfc | 2019-09-02 19:00:33 +0200 | [diff] [blame] | 190 | STATIC_ASSERT (sizeof(# __VA_ARGS__) != 7,"node " #x " must not be declared as static"); \ |
Damjan Marion | 6e36351 | 2018-08-10 22:39:11 +0200 | [diff] [blame] | 191 | static __clib_unused vlib_node_registration_t __clib_unused_##x |
| 192 | #endif |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 193 | |
Damjan Marion | 69abe44 | 2018-08-27 22:43:23 +0200 | [diff] [blame] | 194 | #ifndef CLIB_MARCH_VARIANT |
| 195 | #define CLIB_MARCH_VARIANT_STR "default" |
| 196 | #else |
| 197 | #define _CLIB_MARCH_VARIANT_STR(s) __CLIB_MARCH_VARIANT_STR(s) |
| 198 | #define __CLIB_MARCH_VARIANT_STR(s) #s |
| 199 | #define CLIB_MARCH_VARIANT_STR _CLIB_MARCH_VARIANT_STR(CLIB_MARCH_VARIANT) |
| 200 | #endif |
| 201 | |
Damjan Marion | a31698b | 2021-03-10 14:35:28 +0100 | [diff] [blame] | 202 | #define VLIB_NODE_FN(node) \ |
| 203 | uword CLIB_MARCH_SFX (node##_fn) (); \ |
| 204 | static vlib_node_fn_registration_t CLIB_MARCH_SFX ( \ |
| 205 | node##_fn_registration) = { \ |
| 206 | .function = &CLIB_MARCH_SFX (node##_fn), \ |
| 207 | }; \ |
| 208 | \ |
| 209 | static void __clib_constructor CLIB_MARCH_SFX (node##_multiarch_register) ( \ |
| 210 | void) \ |
| 211 | { \ |
| 212 | extern vlib_node_registration_t node; \ |
| 213 | vlib_node_fn_registration_t *r; \ |
| 214 | r = &CLIB_MARCH_SFX (node##_fn_registration); \ |
| 215 | r->march_variant = CLIB_MARCH_SFX (CLIB_MARCH_VARIANT_TYPE); \ |
| 216 | r->next_registration = node.node_fn_registrations; \ |
| 217 | node.node_fn_registrations = r; \ |
| 218 | } \ |
Damjan Marion | 1bb67ab | 2021-04-30 11:11:08 +0200 | [diff] [blame] | 219 | uword CLIB_MARCH_SFX (node##_fn) |
Damjan Marion | 812b32d | 2018-05-28 21:26:47 +0200 | [diff] [blame] | 220 | |
Ray Kinsella | 4830e4f | 2020-03-10 14:35:32 +0000 | [diff] [blame] | 221 | unformat_function_t unformat_vlib_node_variant; |
| 222 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 223 | typedef struct |
| 224 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 225 | /* Total calls, clock ticks and vector elements processed for this node. */ |
| 226 | u64 calls, vectors, clocks, suspends; |
| 227 | u64 max_clock; |
| 228 | u64 max_clock_n; |
| 229 | } vlib_node_stats_t; |
| 230 | |
| 231 | #define foreach_vlib_node_state \ |
| 232 | /* Input node is called each iteration of main loop. \ |
| 233 | This is the default (zero). */ \ |
| 234 | _ (POLLING) \ |
| 235 | /* Input node is called when device signals an interrupt. */ \ |
| 236 | _ (INTERRUPT) \ |
| 237 | /* Input node is never called. */ \ |
| 238 | _ (DISABLED) |
| 239 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 240 | typedef enum |
| 241 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 242 | #define _(f) VLIB_NODE_STATE_##f, |
| 243 | foreach_vlib_node_state |
| 244 | #undef _ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 245 | VLIB_N_NODE_STATE, |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 246 | } vlib_node_state_t; |
| 247 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 248 | typedef struct vlib_node_t |
| 249 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 250 | /* Vector processing function for this node. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 251 | vlib_node_function_t *function; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 252 | |
| 253 | /* Node name. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 254 | u8 *name; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 255 | |
| 256 | /* Node name index in elog string table. */ |
| 257 | u32 name_elog_string; |
| 258 | |
| 259 | /* Total statistics for this node. */ |
| 260 | vlib_node_stats_t stats_total; |
| 261 | |
| 262 | /* Saved values as of last clear (or zero if never cleared). |
| 263 | Current values are always stats_total - stats_last_clear. */ |
| 264 | vlib_node_stats_t stats_last_clear; |
| 265 | |
| 266 | /* Type of this node. */ |
| 267 | vlib_node_type_t type; |
| 268 | |
| 269 | /* Node index. */ |
| 270 | u32 index; |
| 271 | |
| 272 | /* Index of corresponding node runtime. */ |
| 273 | u32 runtime_index; |
| 274 | |
| 275 | /* Runtime data for this node. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 276 | void *runtime_data; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 277 | |
| 278 | /* Node flags. */ |
| 279 | u16 flags; |
| 280 | |
| 281 | /* Processing function keeps frame. Tells node dispatching code not |
| 282 | to free frame after dispatch is done. */ |
| 283 | #define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0) |
| 284 | |
| 285 | /* Node counts as output/drop/punt node for stats purposes. */ |
| 286 | #define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1) |
| 287 | #define VLIB_NODE_FLAG_IS_DROP (1 << 2) |
| 288 | #define VLIB_NODE_FLAG_IS_PUNT (1 << 3) |
| 289 | #define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4) |
| 290 | |
| 291 | /* Set if current node runtime has traced vectors. */ |
| 292 | #define VLIB_NODE_FLAG_TRACE (1 << 5) |
| 293 | |
| 294 | #define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6) |
| 295 | #define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7) |
Damjan Marion | 7ca5aaa | 2019-09-24 18:10:49 +0200 | [diff] [blame] | 296 | #define VLIB_NODE_FLAG_TRACE_SUPPORTED (1 << 8) |
Florin Coras | 982e44f | 2021-03-19 13:12:41 -0700 | [diff] [blame] | 297 | #define VLIB_NODE_FLAG_ADAPTIVE_MODE (1 << 9) |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 298 | |
| 299 | /* State for input nodes. */ |
| 300 | u8 state; |
| 301 | |
| 302 | /* Number of bytes of run time data. */ |
| 303 | u8 runtime_data_bytes; |
| 304 | |
Dave Barach | 7fff3d2 | 2018-11-27 16:52:59 -0500 | [diff] [blame] | 305 | /* protocol at b->data[b->current_data] upon entry to the dispatch fn */ |
| 306 | u8 protocol_hint; |
| 307 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 308 | /* Number of error codes used by this node. */ |
| 309 | u16 n_errors; |
| 310 | |
| 311 | /* Size of scalar and vector arguments in bytes. */ |
| 312 | u16 scalar_size, vector_size; |
| 313 | |
| 314 | /* Handle/index in error heap for this node. */ |
| 315 | u32 error_heap_handle; |
| 316 | u32 error_heap_index; |
| 317 | |
Ole Troan | 148c7b7 | 2020-10-07 18:05:37 +0200 | [diff] [blame] | 318 | /* Counter structures indexed by counter code for this node. */ |
Ole Troan | 2c4acdd | 2021-05-06 14:09:50 +0200 | [diff] [blame] | 319 | vlib_error_desc_t *error_counters; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 320 | |
| 321 | /* Vector of next node names. |
| 322 | Only used before next_nodes array is initialized. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 323 | char **next_node_names; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 324 | |
| 325 | /* Next node indices for this node. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 326 | u32 *next_nodes; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 327 | |
| 328 | /* Name of node that we are sibling of. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 329 | char *sibling_of; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 330 | |
| 331 | /* Bitmap of all of this node's siblings. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 332 | uword *sibling_bitmap; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 333 | |
| 334 | /* Total number of vectors sent to each next node. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 335 | u64 *n_vectors_by_next_node; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 336 | |
| 337 | /* Hash table mapping next node index into slot in |
| 338 | next_nodes vector. Quickly determines whether this node |
| 339 | is connected to given next node and, if so, with which slot. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 340 | uword *next_slot_by_node; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 341 | |
| 342 | /* Bitmap of node indices which feed this node. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 343 | uword *prev_node_bitmap; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 344 | |
| 345 | /* Node/next-index which own enqueue rights with to this node. */ |
| 346 | u32 owner_node_index, owner_next_index; |
| 347 | |
| 348 | /* Buffer format/unformat for this node. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 349 | format_function_t *format_buffer; |
| 350 | unformat_function_t *unformat_buffer; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 351 | |
| 352 | /* Trace buffer format/unformat for this node. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 353 | format_function_t *format_trace; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 354 | |
| 355 | /* Function to validate incoming frames. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 356 | u8 *(*validate_frame) (struct vlib_main_t * vm, |
| 357 | struct vlib_node_runtime_t *, |
| 358 | struct vlib_frame_t * f); |
Dave Barach | 6931f59 | 2016-05-13 12:55:01 -0400 | [diff] [blame] | 359 | /* for pretty-printing, not typically valid */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 360 | u8 *state_string; |
Damjan Marion | 69abe44 | 2018-08-27 22:43:23 +0200 | [diff] [blame] | 361 | |
| 362 | /* Node function candidate registration with priority */ |
| 363 | vlib_node_fn_registration_t *node_fn_registrations; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 364 | } 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 Barach | d84ba85 | 2017-08-22 17:56:46 -0400 | [diff] [blame] | 370 | #define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 371 | |
| 372 | /* Calling frame (think stack frame) for a node. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 373 | typedef struct vlib_frame_t |
| 374 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 375 | /* Frame flags. */ |
Damjan Marion | 633b6fd | 2018-09-14 14:38:53 +0200 | [diff] [blame] | 376 | u16 frame_flags; |
| 377 | |
| 378 | /* User flags. Used for sending hints to the next node. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 379 | u16 flags; |
| 380 | |
| 381 | /* Number of scalar bytes in arguments. */ |
| 382 | u8 scalar_size; |
| 383 | |
| 384 | /* Number of bytes per vector argument. */ |
| 385 | u8 vector_size; |
| 386 | |
| 387 | /* Number of vector elements currently in frame. */ |
| 388 | u16 n_vectors; |
| 389 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 390 | /* Scalar and vector arguments to next node. */ |
| 391 | u8 arguments[0]; |
| 392 | } vlib_frame_t; |
| 393 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 394 | typedef struct |
| 395 | { |
Andreas Schultz | 58b2eb1 | 2019-07-15 15:40:56 +0200 | [diff] [blame] | 396 | /* Frame pointer. */ |
| 397 | vlib_frame_t *frame; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 398 | |
| 399 | /* Node runtime for this next. */ |
| 400 | u32 node_runtime_index; |
| 401 | |
| 402 | /* Next frame flags. */ |
| 403 | u32 flags; |
| 404 | |
| 405 | /* Reflects node frame-used flag for this next. */ |
| 406 | #define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \ |
| 407 | VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH |
| 408 | |
Damjan Marion | 296988d | 2019-02-21 20:24:54 +0100 | [diff] [blame] | 409 | /* Don't append this frame */ |
| 410 | #define VLIB_FRAME_NO_APPEND (1 << 14) |
| 411 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 412 | /* This next frame owns enqueue to node |
| 413 | corresponding to node_runtime_index. */ |
| 414 | #define VLIB_FRAME_OWNER (1 << 15) |
| 415 | |
| 416 | /* Set when frame has been allocated for this next. */ |
| 417 | #define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT |
| 418 | |
| 419 | /* Set when frame has been added to pending vector. */ |
| 420 | #define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP |
| 421 | |
| 422 | /* Set when frame is to be freed after dispatch. */ |
| 423 | #define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT |
| 424 | |
| 425 | /* Set when frame has traced packets. */ |
| 426 | #define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE |
| 427 | |
| 428 | /* Number of vectors enqueue to this next since last overflow. */ |
| 429 | u32 vectors_since_last_overflow; |
| 430 | } vlib_next_frame_t; |
| 431 | |
| 432 | always_inline void |
| 433 | vlib_next_frame_init (vlib_next_frame_t * nf) |
| 434 | { |
Dave Barach | b7b9299 | 2018-10-17 10:38:51 -0400 | [diff] [blame] | 435 | clib_memset (nf, 0, sizeof (nf[0])); |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 436 | nf->node_runtime_index = ~0; |
| 437 | } |
| 438 | |
| 439 | /* A frame pending dispatch by main loop. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 440 | typedef struct |
| 441 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 442 | /* Frame index (in the heap). */ |
Andreas Schultz | 58b2eb1 | 2019-07-15 15:40:56 +0200 | [diff] [blame] | 443 | vlib_frame_t *frame; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 444 | |
Damjan Marion | f70cf23 | 2021-04-15 19:54:44 +0200 | [diff] [blame] | 445 | /* Node and runtime for this frame. */ |
| 446 | u32 node_runtime_index; |
| 447 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 448 | /* Start of next frames for this node. */ |
| 449 | u32 next_frame_index; |
| 450 | |
| 451 | /* Special value for next_frame_index when there is no next frame. */ |
| 452 | #define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0) |
| 453 | } vlib_pending_frame_t; |
| 454 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 455 | typedef struct vlib_node_runtime_t |
| 456 | { |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 457 | CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /**< cacheline mark */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 458 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 459 | vlib_node_function_t *function; /**< Node function to call. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 460 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 461 | vlib_error_t *errors; /**< Vector of errors for this node. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 462 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 463 | u32 clocks_since_last_overflow; /**< Number of clock cycles. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 464 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 465 | u32 max_clock; /**< Maximum clock cycle for an |
| 466 | invocation. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 467 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 468 | u32 max_clock_n; /**< Number of vectors in the recorded |
| 469 | max_clock. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 470 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 471 | u32 calls_since_last_overflow; /**< Number of calls. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 472 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 473 | u32 vectors_since_last_overflow; /**< Number of vector elements |
| 474 | processed by this node. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 475 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 476 | u32 next_frame_index; /**< Start of next frames for this |
| 477 | node. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 478 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 479 | u32 node_index; /**< Node index. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 480 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 481 | u32 input_main_loops_per_call; /**< For input nodes: decremented |
| 482 | on each main loop interation until |
| 483 | it reaches zero and function is |
| 484 | called. Allows some input nodes to |
| 485 | be called more than others. */ |
| 486 | |
| 487 | u32 main_loop_count_last_dispatch; /**< Saved main loop counter of last |
| 488 | dispatch of this node. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 489 | |
| 490 | u32 main_loop_vector_stats[2]; |
| 491 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 492 | u16 flags; /**< Copy of main node flags. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 493 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 494 | u16 state; /**< Input node state. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 495 | |
| 496 | u16 n_next_nodes; |
| 497 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 498 | u16 cached_next_index; /**< Next frame index that vector |
| 499 | arguments were last enqueued to |
| 500 | last time this node ran. Set to |
| 501 | zero before first run of this |
| 502 | node. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 503 | |
Damjan Marion | 586afd7 | 2017-04-05 19:18:20 +0200 | [diff] [blame] | 504 | u16 thread_index; /**< thread this node runs on */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 505 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 506 | u8 runtime_data[0]; /**< Function dependent |
| 507 | node-runtime data. This data is |
| 508 | thread local, and it is not |
| 509 | cloned from main thread. It needs |
| 510 | to be initialized for each thread |
| 511 | before it is used unless |
| 512 | runtime_data template exists in |
| 513 | vlib_node_t. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 514 | } |
| 515 | vlib_node_runtime_t; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 516 | |
Damjan Marion | e9f929b | 2017-03-16 11:32:09 +0100 | [diff] [blame] | 517 | #define VLIB_NODE_RUNTIME_DATA_SIZE (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data)) |
| 518 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 519 | typedef struct |
| 520 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 521 | /* Number of allocated frames for this scalar/vector size. */ |
| 522 | u32 n_alloc_frames; |
| 523 | |
Andreas Schultz | 58b2eb1 | 2019-07-15 15:40:56 +0200 | [diff] [blame] | 524 | /* Vector of free frames for this scalar/vector size. */ |
| 525 | vlib_frame_t **free_frames; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 526 | } vlib_frame_size_t; |
| 527 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 528 | typedef struct |
| 529 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 530 | /* Users opaque value for event type. */ |
| 531 | uword opaque; |
| 532 | } vlib_process_event_type_t; |
| 533 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 534 | typedef struct |
| 535 | { |
Damjan Marion | ef58758 | 2020-05-20 22:01:44 +0200 | [diff] [blame] | 536 | CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 537 | /* Node runtime for this process. */ |
| 538 | vlib_node_runtime_t node_runtime; |
| 539 | |
| 540 | /* Where to longjmp when process is done. */ |
| 541 | clib_longjmp_t return_longjmp; |
| 542 | |
| 543 | #define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0) |
| 544 | #define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1) |
| 545 | |
| 546 | /* Where to longjmp to resume node after suspend. */ |
| 547 | clib_longjmp_t resume_longjmp; |
| 548 | #define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0 |
| 549 | #define VLIB_PROCESS_RESUME_LONGJMP_RESUME 1 |
| 550 | |
| 551 | u16 flags; |
| 552 | #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0) |
| 553 | #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1) |
| 554 | /* Set to indicate that this process has been added to resume vector. */ |
| 555 | #define VLIB_PROCESS_RESUME_PENDING (1 << 2) |
| 556 | |
| 557 | /* Process function is currently running. */ |
| 558 | #define VLIB_PROCESS_IS_RUNNING (1 << 3) |
| 559 | |
| 560 | /* Size of process stack. */ |
| 561 | u16 log2_n_stack_bytes; |
| 562 | |
| 563 | u32 suspended_process_frame_index; |
| 564 | |
| 565 | /* Number of times this process was suspended. */ |
| 566 | u32 n_suspends; |
| 567 | |
| 568 | /* Vectors of pending event data indexed by event type index. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 569 | void **pending_event_data_by_type_index; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 570 | |
| 571 | /* Bitmap of event type-indices with non-empty vectors. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 572 | uword *non_empty_event_type_bitmap; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 573 | |
| 574 | /* Bitmap of event type-indices which are one time events. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 575 | uword *one_time_event_type_bitmap; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 576 | |
| 577 | /* Type is opaque pointer -- typically a pointer to an event handler |
| 578 | function. Hash table to map opaque to a type index. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 579 | uword *event_type_index_by_type_opaque; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 580 | |
| 581 | /* Pool of currently valid event types. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 582 | vlib_process_event_type_t *event_type_pool; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 583 | |
Dave Barach | 5c20a01 | 2017-06-13 08:48:31 -0400 | [diff] [blame] | 584 | /* |
| 585 | * When suspending saves clock time (10us ticks) when process |
| 586 | * is to be resumed. |
| 587 | */ |
| 588 | u64 resume_clock_interval; |
| 589 | |
| 590 | /* Handle from timer code, to cancel an unexpired timer */ |
| 591 | u32 stop_timer_handle; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 592 | |
Andrew Yourtchenko | 716d959 | 2016-05-10 10:51:34 +0000 | [diff] [blame] | 593 | /* Default output function and its argument for any CLI outputs |
| 594 | within the process. */ |
| 595 | vlib_cli_output_function_t *output_function; |
| 596 | uword output_function_arg; |
| 597 | |
Damjan Marion | ef58758 | 2020-05-20 22:01:44 +0200 | [diff] [blame] | 598 | /* Process stack */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 599 | #define VLIB_PROCESS_STACK_MAGIC (0xdead7ead) |
Damjan Marion | ef58758 | 2020-05-20 22:01:44 +0200 | [diff] [blame] | 600 | u32 *stack; |
| 601 | } vlib_process_t; |
Andrew Yourtchenko | 716d959 | 2016-05-10 10:51:34 +0000 | [diff] [blame] | 602 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 603 | typedef struct |
| 604 | { |
| 605 | u32 node_index; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 606 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 607 | u32 one_time_event; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 608 | } vlib_one_time_waiting_process_t; |
| 609 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 610 | typedef struct |
| 611 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 612 | u16 n_data_elts; |
| 613 | |
| 614 | u16 n_data_elt_bytes; |
| 615 | |
| 616 | /* n_data_elts * n_data_elt_bytes */ |
| 617 | u32 n_data_bytes; |
| 618 | |
| 619 | /* Process node & event type to be used to signal event. */ |
| 620 | u32 process_node_index; |
| 621 | |
| 622 | u32 event_type_index; |
| 623 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 624 | union |
| 625 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 626 | u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)]; |
| 627 | |
| 628 | /* Vector of event data used only when data does not fit inline. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 629 | u8 *event_data_as_vector; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 630 | }; |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 631 | } |
| 632 | vlib_signal_timed_event_data_t; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 633 | |
| 634 | always_inline uword |
| 635 | vlib_timing_wheel_data_is_timed_event (u32 d) |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 636 | { |
| 637 | return d & 1; |
| 638 | } |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 639 | |
| 640 | always_inline u32 |
| 641 | vlib_timing_wheel_data_set_suspended_process (u32 i) |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 642 | { |
| 643 | return 0 + 2 * i; |
| 644 | } |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 645 | |
| 646 | always_inline u32 |
| 647 | vlib_timing_wheel_data_set_timed_event (u32 i) |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 648 | { |
| 649 | return 1 + 2 * i; |
| 650 | } |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 651 | |
| 652 | always_inline uword |
| 653 | vlib_timing_wheel_data_get_index (u32 d) |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 654 | { |
| 655 | return d / 2; |
| 656 | } |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 657 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 658 | typedef struct |
| 659 | { |
Damjan Marion | a31698b | 2021-03-10 14:35:28 +0100 | [diff] [blame] | 660 | clib_march_variant_type_t index; |
| 661 | int priority; |
| 662 | char *suffix; |
| 663 | char *desc; |
| 664 | } vlib_node_fn_variant_t; |
| 665 | |
| 666 | typedef struct |
| 667 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 668 | /* Public nodes. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 669 | vlib_node_t **nodes; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 670 | |
| 671 | /* Node index hashed by node name. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 672 | uword *node_by_name; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 673 | |
| 674 | u32 flags; |
| 675 | #define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0) |
| 676 | |
| 677 | /* Nodes segregated by type for cache locality. |
| 678 | Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 679 | vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE]; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 680 | |
| 681 | /* Node runtime indices for input nodes with pending interrupts. */ |
Damjan Marion | 9410053 | 2020-11-06 23:25:57 +0100 | [diff] [blame] | 682 | void *interrupts; |
| 683 | volatile u32 *pending_interrupts; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 684 | |
| 685 | /* Input nodes are switched from/to interrupt to/from polling mode |
| 686 | when average vector length goes above/below polling/interrupt |
| 687 | thresholds. */ |
| 688 | u32 polling_threshold_vector_length; |
| 689 | u32 interrupt_threshold_vector_length; |
| 690 | |
| 691 | /* Vector of next frames. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 692 | vlib_next_frame_t *next_frames; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 693 | |
| 694 | /* Vector of internal node's frames waiting to be called. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 695 | vlib_pending_frame_t *pending_frames; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 696 | |
| 697 | /* Timing wheel for scheduling time-based node dispatch. */ |
Dave Barach | 5c20a01 | 2017-06-13 08:48:31 -0400 | [diff] [blame] | 698 | void *timing_wheel; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 699 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 700 | vlib_signal_timed_event_data_t *signal_timed_event_data_pool; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 701 | |
| 702 | /* Opaque data vector added via timing_wheel_advance. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 703 | u32 *data_from_advancing_timing_wheel; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 704 | |
| 705 | /* CPU time of next process to be ready on timing wheel. */ |
Dave Barach | 5c20a01 | 2017-06-13 08:48:31 -0400 | [diff] [blame] | 706 | f64 time_next_process_ready; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 707 | |
| 708 | /* Vector of process nodes. |
| 709 | One for each node of type VLIB_NODE_TYPE_PROCESS. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 710 | vlib_process_t **processes; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 711 | |
| 712 | /* Current running process or ~0 if no process running. */ |
| 713 | u32 current_process_index; |
| 714 | |
| 715 | /* Pool of pending process frames. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 716 | vlib_pending_frame_t *suspended_process_frames; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 717 | |
| 718 | /* Vector of event data vectors pending recycle. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 719 | void **recycled_event_data_vectors; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 720 | |
| 721 | /* Current counts of nodes in each state. */ |
| 722 | u32 input_node_counts_by_state[VLIB_N_NODE_STATE]; |
| 723 | |
| 724 | /* Hash of (scalar_size,vector_size) to frame_sizes index. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 725 | uword *frame_size_hash; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 726 | |
| 727 | /* Per-size frame allocation information. */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 728 | vlib_frame_size_t *frame_sizes; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 729 | |
| 730 | /* Time of last node runtime stats clear. */ |
| 731 | f64 time_last_runtime_stats_clear; |
| 732 | |
Dave Barach | 687c902 | 2019-07-23 10:22:31 -0400 | [diff] [blame] | 733 | /* Node index from error code */ |
| 734 | u32 *node_by_error; |
Damjan Marion | a31698b | 2021-03-10 14:35:28 +0100 | [diff] [blame] | 735 | |
| 736 | /* Node Function Variants */ |
| 737 | vlib_node_fn_variant_t *variants; |
| 738 | |
| 739 | /* Node Function Default Variant Index */ |
| 740 | u32 node_fn_default_march_variant; |
| 741 | |
| 742 | /* Node Function march Variant by Suffix Hash */ |
| 743 | uword *node_fn_march_variant_by_suffix; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 744 | } vlib_node_main_t; |
| 745 | |
Dave Barach | 687c902 | 2019-07-23 10:22:31 -0400 | [diff] [blame] | 746 | typedef u16 vlib_error_t; |
| 747 | |
| 748 | always_inline u32 |
| 749 | vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e) |
| 750 | { |
| 751 | return nm->node_by_error[e]; |
| 752 | } |
| 753 | |
| 754 | always_inline u32 |
| 755 | vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e) |
| 756 | { |
| 757 | u32 node_index = nm->node_by_error[e]; |
| 758 | vlib_node_t *n = nm->nodes[node_index]; |
| 759 | u32 error_code = e - n->error_heap_index; |
| 760 | return error_code; |
| 761 | } |
Damjan Marion | 0f8ecf0 | 2016-06-27 08:30:30 +0200 | [diff] [blame] | 762 | |
dongjuan | 8875248 | 2019-06-04 10:59:02 +0800 | [diff] [blame] | 763 | #define FRAME_QUEUE_MAX_NELTS 64 |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 764 | typedef struct |
| 765 | { |
| 766 | CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); |
Damjan Marion | 0f8ecf0 | 2016-06-27 08:30:30 +0200 | [diff] [blame] | 767 | u64 head; |
| 768 | u64 head_hint; |
| 769 | u64 tail; |
| 770 | u32 n_in_use; |
| 771 | u32 nelts; |
| 772 | u32 written; |
| 773 | u32 threshold; |
| 774 | i32 n_vectors[FRAME_QUEUE_MAX_NELTS]; |
| 775 | } frame_queue_trace_t; |
| 776 | |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 777 | typedef struct |
| 778 | { |
Damjan Marion | 0f8ecf0 | 2016-06-27 08:30:30 +0200 | [diff] [blame] | 779 | u64 count[FRAME_QUEUE_MAX_NELTS]; |
| 780 | } frame_queue_nelt_counter_t; |
| 781 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 782 | #endif /* included_vlib_node_h */ |
Dave Barach | 9b8ffd9 | 2016-07-08 08:13:45 -0400 | [diff] [blame] | 783 | |
| 784 | /* |
| 785 | * fd.io coding-style-patch-verification: ON |
| 786 | * |
| 787 | * Local Variables: |
| 788 | * eval: (c-set-style "gnu") |
| 789 | * End: |
| 790 | */ |