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