src/vlib/node.h

   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
  43 #include <vppinfra/cpu.h>
  44 #include <vppinfra/longjmp.h>
  45 #include <vppinfra/lock.h>
  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
  58 typedef enum
  59 {
  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 {
  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
  89 typedef struct _vlib_node_fn_registration
  90 {
  91   vlib_node_function_t *function;
  92   clib_march_variant_type_t march_variant;
  93   struct _vlib_node_fn_registration *next_registration;
  94 } vlib_node_fn_registration_t;
  95
  96 typedef struct _vlib_node_registration
  97 {
  98   /* Vector processing function for this node. */
  99   vlib_node_function_t *function;
 100
 101   /* Node function candidate registration with priority */
 102   vlib_node_fn_registration_t *node_fn_registrations;
 103
 104   /* Node name. */
 105   char *name;
 106
 107   /* Name of sibling (if applicable). */
 108   char *sibling_of;
 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. */
 117   char **error_strings;
 118   vlib_error_desc_t *error_counters;
 119
 120   /* Buffer format/unformat for this node. */
 121   format_function_t *format_buffer;
 122   unformat_function_t *unformat_buffer;
 123
 124   /* Trace format/unformat for this node. */
 125   format_function_t *format_trace;
 126   unformat_function_t *unformat_trace;
 127
 128   /* Function to validate incoming frames. */
 129   u8 *(*validate_frame) (struct vlib_main_t * vm,
 130                          struct vlib_node_runtime_t *,
 131                          struct vlib_frame_t * f);
 132
 133   /* Per-node runtime data. */
 134   void *runtime_data;
 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
 148   /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
 149   u8 protocol_hint;
 150
 151   /* Size of scalar and vector arguments in bytes. */
 152   u8 scalar_size, vector_size, aux_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... */
 161   struct _vlib_node_registration *next_registration;
 162
 163   /* Names of next nodes which this node feeds into. */
 164   char *next_nodes[];
 165
 166 } vlib_node_registration_t;
 167
 168 #ifndef CLIB_MARCH_VARIANT
 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
 188 #else
 189 #define VLIB_REGISTER_NODE(x,...)                                       \
 190 STATIC_ASSERT (sizeof(# __VA_ARGS__) != 7,"node " #x " must not be declared as static"); \
 191 static __clib_unused vlib_node_registration_t __clib_unused_##x
 192 #endif
 193
 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
 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   }                                                                           \
 219   uword CLIB_MARCH_SFX (node##_fn)
 220
 221 unformat_function_t unformat_vlib_node_variant;
 222
 223 typedef struct
 224 {
 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
 240 typedef enum
 241 {
 242 #define _(f) VLIB_NODE_STATE_##f,
 243   foreach_vlib_node_state
 244 #undef _
 245     VLIB_N_NODE_STATE,
 246 } vlib_node_state_t;
 247
 248 typedef struct vlib_node_t
 249 {
 250   /* Vector processing function for this node. */
 251   vlib_node_function_t *function;
 252
 253   /* Node name. */
 254   u8 *name;
 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. */
 276   void *runtime_data;
 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)
 296 #define VLIB_NODE_FLAG_TRACE_SUPPORTED (1 << 8)
 297 #define VLIB_NODE_FLAG_ADAPTIVE_MODE                         (1 << 9)
 298
 299   /* State for input nodes. */
 300   u8 state;
 301
 302   /* Number of bytes of run time data. */
 303   u8 runtime_data_bytes;
 304
 305   /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
 306   u8 protocol_hint;
 307
 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 frame_size, scalar_offset, vector_offset, magic_offset, aux_offset;
 313   u16 frame_size_index;
 314
 315   /* Handle/index in error heap for this node. */
 316   u32 error_heap_handle;
 317   u32 error_heap_index;
 318
 319   /* Counter structures indexed by counter code for this node. */
 320   vlib_error_desc_t *error_counters;
 321
 322   /* Vector of next node names.
 323      Only used before next_nodes array is initialized. */
 324   char **next_node_names;
 325
 326   /* Next node indices for this node. */
 327   u32 *next_nodes;
 328
 329   /* Name of node that we are sibling of. */
 330   char *sibling_of;
 331
 332   /* Bitmap of all of this node's siblings. */
 333   uword *sibling_bitmap;
 334
 335   /* Total number of vectors sent to each next node. */
 336   u64 *n_vectors_by_next_node;
 337
 338   /* Hash table mapping next node index into slot in
 339      next_nodes vector.  Quickly determines whether this node
 340      is connected to given next node and, if so, with which slot. */
 341   uword *next_slot_by_node;
 342
 343   /* Bitmap of node indices which feed this node. */
 344   uword *prev_node_bitmap;
 345
 346   /* Node/next-index which own enqueue rights with to this node. */
 347   u32 owner_node_index, owner_next_index;
 348
 349   /* Buffer format/unformat for this node. */
 350   format_function_t *format_buffer;
 351   unformat_function_t *unformat_buffer;
 352
 353   /* Trace buffer format/unformat for this node. */
 354   format_function_t *format_trace;
 355
 356   /* Function to validate incoming frames. */
 357   u8 *(*validate_frame) (struct vlib_main_t * vm,
 358                          struct vlib_node_runtime_t *,
 359                          struct vlib_frame_t * f);
 360   /* for pretty-printing, not typically valid */
 361   u8 *state_string;
 362
 363   /* Node function candidate registration with priority */
 364   vlib_node_fn_registration_t *node_fn_registrations;
 365 } vlib_node_t;
 366
 367 #define VLIB_INVALID_NODE_INDEX ((u32) ~0)
 368
 369 /* Max number of vector elements to process at once per node. */
 370 #define VLIB_FRAME_SIZE 256
 371 /* Number of extra elements allocated at the end of vecttor. */
 372 #define VLIB_FRAME_SIZE_EXTRA 4
 373 /* Frame data alignment */
 374 #define VLIB_FRAME_DATA_ALIGN 16
 375
 376 /* Calling frame (think stack frame) for a node. */
 377 typedef struct vlib_frame_t
 378 {
 379   /* Frame flags. */
 380   u16 frame_flags;
 381
 382   /* User flags. Used for sending hints to the next node. */
 383   u16 flags;
 384
 385   /* Scalar, vector and aux offsets in this frame. */
 386   u16 scalar_offset, vector_offset, aux_offset;
 387
 388   /* Number of vector elements currently in frame. */
 389   u16 n_vectors;
 390
 391   /* Scalar and vector arguments to next node. */
 392   u8 arguments[0];
 393 } vlib_frame_t;
 394
 395 typedef struct
 396 {
 397   /* Frame pointer. */
 398   vlib_frame_t *frame;
 399
 400   /* Node runtime for this next. */
 401   u32 node_runtime_index;
 402
 403   /* Next frame flags. */
 404   u32 flags;
 405
 406   /* Reflects node frame-used flag for this next. */
 407 #define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
 408   VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
 409
 410   /* Don't append this frame */
 411 #define VLIB_FRAME_NO_APPEND (1 << 14)
 412
 413   /* This next frame owns enqueue to node
 414      corresponding to node_runtime_index. */
 415 #define VLIB_FRAME_OWNER (1 << 15)
 416
 417   /* Set when frame has been allocated for this next. */
 418 #define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
 419
 420   /* Set when frame has been added to pending vector. */
 421 #define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
 422
 423   /* Set when frame is to be freed after dispatch. */
 424 #define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
 425
 426   /* Set when frame has traced packets. */
 427 #define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
 428
 429   /* Number of vectors enqueue to this next since last overflow. */
 430   u32 vectors_since_last_overflow;
 431 } vlib_next_frame_t;
 432
 433 always_inline void
 434 vlib_next_frame_init (vlib_next_frame_t * nf)
 435 {
 436   clib_memset (nf, 0, sizeof (nf[0]));
 437   nf->node_runtime_index = ~0;
 438 }
 439
 440 /* A frame pending dispatch by main loop. */
 441 typedef struct
 442 {
 443   /* Frame index (in the heap). */
 444   vlib_frame_t *frame;
 445
 446   /* Node and runtime for this frame. */
 447   u32 node_runtime_index;
 448
 449   /* Start of next frames for this node. */
 450   u32 next_frame_index;
 451
 452   /* Special value for next_frame_index when there is no next frame. */
 453 #define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
 454 } vlib_pending_frame_t;
 455
 456 typedef struct vlib_node_runtime_t
 457 {
 458   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);      /**< cacheline mark */
 459
 460   vlib_node_function_t *function;       /**< Node function to call. */
 461
 462   vlib_error_t *errors;                 /**< Vector of errors for this node. */
 463
 464   u32 clocks_since_last_overflow;       /**< Number of clock cycles. */
 465
 466   u32 max_clock;                        /**< Maximum clock cycle for an
 467                                           invocation. */
 468
 469   u32 max_clock_n;                      /**< Number of vectors in the recorded
 470                                           max_clock. */
 471
 472   u32 calls_since_last_overflow;        /**< Number of calls. */
 473
 474   u32 vectors_since_last_overflow;      /**< Number of vector elements
 475                                           processed by this node. */
 476
 477   u32 next_frame_index;                 /**< Start of next frames for this
 478                                           node. */
 479
 480   u32 node_index;                       /**< Node index. */
 481
 482   u32 input_main_loops_per_call;        /**< For input nodes: decremented
 483                                           on each main loop interation until
 484                                           it reaches zero and function is
 485                                           called.  Allows some input nodes to
 486                                           be called more than others. */
 487
 488   u32 main_loop_count_last_dispatch;    /**< Saved main loop counter of last
 489                                           dispatch of this node. */
 490
 491   u32 main_loop_vector_stats[2];
 492
 493   u16 flags;                            /**< Copy of main node flags. */
 494
 495   u16 state;                            /**< Input node state. */
 496
 497   u16 n_next_nodes;
 498
 499   u16 cached_next_index;                /**< Next frame index that vector
 500                                           arguments were last enqueued to
 501                                           last time this node ran. Set to
 502                                           zero before first run of this
 503                                           node. */
 504
 505   u16 thread_index;                     /**< thread this node runs on */
 506
 507   u8 runtime_data[0];                   /**< Function dependent
 508                                           node-runtime data. This data is
 509                                           thread local, and it is not
 510                                           cloned from main thread. It needs
 511                                           to be initialized for each thread
 512                                           before it is used unless
 513                                           runtime_data template exists in
 514                                           vlib_node_t. */
 515 }
 516 vlib_node_runtime_t;
 517
 518 #define VLIB_NODE_RUNTIME_DATA_SIZE     (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
 519
 520 typedef struct
 521 {
 522   /* Number of allocated frames for this scalar/vector size. */
 523   u32 n_alloc_frames;
 524
 525   /* Frame size */
 526   u16 frame_size;
 527
 528   /* Vector of free frames for this scalar/vector size. */
 529   vlib_frame_t **free_frames;
 530 } vlib_frame_size_t;
 531
 532 STATIC_ASSERT_SIZEOF (vlib_frame_size_t, 16);
 533
 534 typedef struct
 535 {
 536   /* Users opaque value for event type. */
 537   uword opaque;
 538 } vlib_process_event_type_t;
 539
 540 typedef struct
 541 {
 542   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 543   /* Node runtime for this process. */
 544   vlib_node_runtime_t node_runtime;
 545
 546   /* Where to longjmp when process is done. */
 547   clib_longjmp_t return_longjmp;
 548
 549 #define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
 550 #define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
 551
 552   /* Where to longjmp to resume node after suspend. */
 553   clib_longjmp_t resume_longjmp;
 554 #define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
 555 #define VLIB_PROCESS_RESUME_LONGJMP_RESUME  1
 556
 557   u16 flags;
 558 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
 559 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
 560   /* Set to indicate that this process has been added to resume vector. */
 561 #define VLIB_PROCESS_RESUME_PENDING (1 << 2)
 562
 563   /* Process function is currently running. */
 564 #define VLIB_PROCESS_IS_RUNNING (1 << 3)
 565
 566   /* Size of process stack. */
 567   u16 log2_n_stack_bytes;
 568
 569   u32 suspended_process_frame_index;
 570
 571   /* Number of times this process was suspended. */
 572   u32 n_suspends;
 573
 574   /* Vectors of pending event data indexed by event type index. */
 575   void **pending_event_data_by_type_index;
 576
 577   /* Bitmap of event type-indices with non-empty vectors. */
 578   uword *non_empty_event_type_bitmap;
 579
 580   /* Bitmap of event type-indices which are one time events. */
 581   uword *one_time_event_type_bitmap;
 582
 583   /* Type is opaque pointer -- typically a pointer to an event handler
 584      function.  Hash table to map opaque to a type index. */
 585   uword *event_type_index_by_type_opaque;
 586
 587   /* Pool of currently valid event types. */
 588   vlib_process_event_type_t *event_type_pool;
 589
 590   /*
 591    * When suspending saves clock time (10us ticks) when process
 592    * is to be resumed.
 593    */
 594   u64 resume_clock_interval;
 595
 596   /* Handle from timer code, to cancel an unexpired timer */
 597   u32 stop_timer_handle;
 598
 599   /* Default output function and its argument for any CLI outputs
 600      within the process. */
 601   vlib_cli_output_function_t *output_function;
 602   uword output_function_arg;
 603
 604   /* Process stack */
 605 #define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
 606   u32 *stack;
 607 } vlib_process_t;
 608
 609 typedef struct
 610 {
 611   u32 node_index;
 612
 613   u32 one_time_event;
 614 } vlib_one_time_waiting_process_t;
 615
 616 typedef struct
 617 {
 618   u16 n_data_elts;
 619
 620   u16 n_data_elt_bytes;
 621
 622   /* n_data_elts * n_data_elt_bytes */
 623   u32 n_data_bytes;
 624
 625   /* Process node & event type to be used to signal event. */
 626   u32 process_node_index;
 627
 628   u32 event_type_index;
 629
 630   union
 631   {
 632     u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
 633
 634     /* Vector of event data used only when data does not fit inline. */
 635     u8 *event_data_as_vector;
 636   };
 637 }
 638 vlib_signal_timed_event_data_t;
 639
 640 always_inline uword
 641 vlib_timing_wheel_data_is_timed_event (u32 d)
 642 {
 643   return d & 1;
 644 }
 645
 646 always_inline u32
 647 vlib_timing_wheel_data_set_suspended_process (u32 i)
 648 {
 649   return 0 + 2 * i;
 650 }
 651
 652 always_inline u32
 653 vlib_timing_wheel_data_set_timed_event (u32 i)
 654 {
 655   return 1 + 2 * i;
 656 }
 657
 658 always_inline uword
 659 vlib_timing_wheel_data_get_index (u32 d)
 660 {
 661   return d / 2;
 662 }
 663
 664 typedef struct
 665 {
 666   clib_march_variant_type_t index;
 667   int priority;
 668   char *suffix;
 669   char *desc;
 670 } vlib_node_fn_variant_t;
 671
 672 typedef struct
 673 {
 674   /* Public nodes. */
 675   vlib_node_t **nodes;
 676
 677   /* Node index hashed by node name. */
 678   uword *node_by_name;
 679
 680   u32 flags;
 681 #define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
 682
 683   /* Nodes segregated by type for cache locality.
 684      Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
 685   vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
 686
 687   /* Node runtime indices for input nodes with pending interrupts. */
 688   void *interrupts;
 689   volatile u32 *pending_interrupts;
 690
 691   /* Input nodes are switched from/to interrupt to/from polling mode
 692      when average vector length goes above/below polling/interrupt
 693      thresholds. */
 694   u32 polling_threshold_vector_length;
 695   u32 interrupt_threshold_vector_length;
 696
 697   /* Vector of next frames. */
 698   vlib_next_frame_t *next_frames;
 699
 700   /* Vector of internal node's frames waiting to be called. */
 701   vlib_pending_frame_t *pending_frames;
 702
 703   /* Timing wheel for scheduling time-based node dispatch. */
 704   void *timing_wheel;
 705
 706   vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
 707
 708   /* Opaque data vector added via timing_wheel_advance. */
 709   u32 *data_from_advancing_timing_wheel;
 710
 711   /* CPU time of next process to be ready on timing wheel. */
 712   f64 time_next_process_ready;
 713
 714   /* Vector of process nodes.
 715      One for each node of type VLIB_NODE_TYPE_PROCESS. */
 716   vlib_process_t **processes;
 717
 718   /* Current running process or ~0 if no process running. */
 719   u32 current_process_index;
 720
 721   /* Pool of pending process frames. */
 722   vlib_pending_frame_t *suspended_process_frames;
 723
 724   /* Vector of event data vectors pending recycle. */
 725   void **recycled_event_data_vectors;
 726
 727   /* Current counts of nodes in each state. */
 728   u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
 729
 730   /* Per-size frame allocation information. */
 731   vlib_frame_size_t *frame_sizes;
 732
 733   /* Time of last node runtime stats clear. */
 734   f64 time_last_runtime_stats_clear;
 735
 736   /* Node index from error code */
 737   u32 *node_by_error;
 738
 739   /* Node Function Variants */
 740   vlib_node_fn_variant_t *variants;
 741
 742   /* Node Function Default Variant Index */
 743   u32 node_fn_default_march_variant;
 744
 745   /* Node Function march Variant by Suffix Hash */
 746   uword *node_fn_march_variant_by_suffix;
 747 } vlib_node_main_t;
 748
 749 typedef u16 vlib_error_t;
 750
 751 always_inline u32
 752 vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
 753 {
 754   return nm->node_by_error[e];
 755 }
 756
 757 always_inline u32
 758 vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
 759 {
 760   u32 node_index = nm->node_by_error[e];
 761   vlib_node_t *n = nm->nodes[node_index];
 762   u32 error_code = e - n->error_heap_index;
 763   return error_code;
 764 }
 765
 766 #define FRAME_QUEUE_MAX_NELTS 64
 767 typedef struct
 768 {
 769   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 770   u64 head;
 771   u64 tail;
 772   u32 n_in_use;
 773   u32 nelts;
 774   u32 written;
 775   u32 threshold;
 776   i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
 777 } frame_queue_trace_t;
 778
 779 typedef struct
 780 {
 781   u64 count[FRAME_QUEUE_MAX_NELTS];
 782 } frame_queue_nelt_counter_t;
 783
 784 #endif /* included_vlib_node_h */
 785
 786 /*
 787  * fd.io coding-style-patch-verification: ON
 788  *
 789  * Local Variables:
 790  * eval: (c-set-style "gnu")
 791  * End:
 792  */