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   /* An internal node on the call graph (could be output). */
  61   VLIB_NODE_TYPE_INTERNAL,
  62
  63   /* Nodes which input data into the processing graph.
  64      Input nodes are called for each iteration of main loop. */
  65   VLIB_NODE_TYPE_INPUT,
  66
  67   /* Nodes to be called before all input nodes.
  68      Used, for example, to clean out driver TX rings before
  69      processing input. */
  70   VLIB_NODE_TYPE_PRE_INPUT,
  71
  72   /* "Process" nodes which can be suspended and later resumed. */
  73   VLIB_NODE_TYPE_PROCESS,
  74
  75   VLIB_N_NODE_TYPE,
  76 } vlib_node_type_t;
  77
  78 typedef struct _vlib_node_registration
  79 {
  80   /* Vector processing function for this node. */
  81   vlib_node_function_t *function;
  82
  83   /* Node name. */
  84   char *name;
  85
  86   /* Name of sibling (if applicable). */
  87   char *sibling_of;
  88
  89   /* Node index filled in by registration. */
  90   u32 index;
  91
  92   /* Type of this node. */
  93   vlib_node_type_t type;
  94
  95   /* Error strings indexed by error code for this node. */
  96   char **error_strings;
  97
  98   /* Buffer format/unformat for this node. */
  99   format_function_t *format_buffer;
 100   unformat_function_t *unformat_buffer;
 101
 102   /* Trace format/unformat for this node. */
 103   format_function_t *format_trace;
 104   unformat_function_t *unformat_trace;
 105
 106   /* Function to validate incoming frames. */
 107   u8 *(*validate_frame) (struct vlib_main_t * vm,
 108                          struct vlib_node_runtime_t *,
 109                          struct vlib_frame_t * f);
 110
 111   /* Per-node runtime data. */
 112   void *runtime_data;
 113
 114   /* Process stack size. */
 115   u16 process_log2_n_stack_bytes;
 116
 117   /* Number of bytes of per-node run time data. */
 118   u8 runtime_data_bytes;
 119
 120   /* State for input nodes. */
 121   u8 state;
 122
 123   /* Node flags. */
 124   u16 flags;
 125
 126   /* Size of scalar and vector arguments in bytes. */
 127   u16 scalar_size, vector_size;
 128
 129   /* Number of error codes used by this node. */
 130   u16 n_errors;
 131
 132   /* Number of next node names that follow. */
 133   u16 n_next_nodes;
 134
 135   /* Constructor link-list, don't ask... */
 136   struct _vlib_node_registration *next_registration;
 137
 138   /* Names of next nodes which this node feeds into. */
 139   char *next_nodes[];
 140
 141 } vlib_node_registration_t;
 142
 143 #define VLIB_REGISTER_NODE(x,...)                                       \
 144     __VA_ARGS__ vlib_node_registration_t x;                             \
 145 static void __vlib_add_node_registration_##x (void)                     \
 146     __attribute__((__constructor__)) ;                                  \
 147 static void __vlib_add_node_registration_##x (void)                     \
 148 {                                                                       \
 149     vlib_main_t * vm = vlib_get_main();                                 \
 150     x.next_registration = vm->node_main.node_registrations;             \
 151     vm->node_main.node_registrations = &x;                              \
 152 }                                                                       \
 153 __VA_ARGS__ vlib_node_registration_t x
 154
 155 #if CLIB_DEBUG > 0
 156 #define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn)
 157 #define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn)
 158 #define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
 159 #else
 160 #define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt)                \
 161   uword                                                                 \
 162   __attribute__ ((flatten))                                             \
 163   __attribute__ ((target (tgt)))                                        \
 164   CLIB_CPU_OPTIMIZED                                                    \
 165   fn ## _ ## arch ( struct vlib_main_t * vm,                            \
 166                    struct vlib_node_runtime_t * node,                   \
 167                    struct vlib_frame_t * frame)                         \
 168   { return fn (vm, node, frame); }
 169
 170 #define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn)                          \
 171   foreach_march_variant(VLIB_NODE_FUNCTION_CLONE_TEMPLATE, fn)
 172
 173 #define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)                          \
 174   VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn)                                \
 175   CLIB_MULTIARCH_SELECT_FN(fn, static inline)                           \
 176   static void __attribute__((__constructor__))                          \
 177   __vlib_node_function_multiarch_select_##node (void)                   \
 178   { node.function = fn ## _multiarch_select(); }
 179 #endif
 180
 181 always_inline vlib_node_registration_t *
 182 vlib_node_next_registered (vlib_node_registration_t * c)
 183 {
 184   c =
 185     clib_elf_section_data_next (c,
 186                                 c->n_next_nodes * sizeof (c->next_nodes[0]));
 187   return c;
 188 }
 189
 190 typedef struct
 191 {
 192   /* Total calls, clock ticks and vector elements processed for this node. */
 193   u64 calls, vectors, clocks, suspends;
 194   u64 max_clock;
 195   u64 max_clock_n;
 196 } vlib_node_stats_t;
 197
 198 #define foreach_vlib_node_state                                 \
 199   /* Input node is called each iteration of main loop.          \
 200      This is the default (zero). */                             \
 201   _ (POLLING)                                                   \
 202   /* Input node is called when device signals an interrupt. */  \
 203   _ (INTERRUPT)                                                 \
 204   /* Input node is never called. */                             \
 205   _ (DISABLED)
 206
 207 typedef enum
 208 {
 209 #define _(f) VLIB_NODE_STATE_##f,
 210   foreach_vlib_node_state
 211 #undef _
 212     VLIB_N_NODE_STATE,
 213 } vlib_node_state_t;
 214
 215 typedef struct vlib_node_t
 216 {
 217   /* Vector processing function for this node. */
 218   vlib_node_function_t *function;
 219
 220   /* Node name. */
 221   u8 *name;
 222
 223   /* Node name index in elog string table. */
 224   u32 name_elog_string;
 225
 226   /* Total statistics for this node. */
 227   vlib_node_stats_t stats_total;
 228
 229   /* Saved values as of last clear (or zero if never cleared).
 230      Current values are always stats_total - stats_last_clear. */
 231   vlib_node_stats_t stats_last_clear;
 232
 233   /* Type of this node. */
 234   vlib_node_type_t type;
 235
 236   /* Node index. */
 237   u32 index;
 238
 239   /* Index of corresponding node runtime. */
 240   u32 runtime_index;
 241
 242   /* Runtime data for this node. */
 243   void *runtime_data;
 244
 245   /* Node flags. */
 246   u16 flags;
 247
 248   /* Processing function keeps frame.  Tells node dispatching code not
 249      to free frame after dispatch is done.  */
 250 #define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH (1 << 0)
 251
 252   /* Node counts as output/drop/punt node for stats purposes. */
 253 #define VLIB_NODE_FLAG_IS_OUTPUT (1 << 1)
 254 #define VLIB_NODE_FLAG_IS_DROP (1 << 2)
 255 #define VLIB_NODE_FLAG_IS_PUNT (1 << 3)
 256 #define VLIB_NODE_FLAG_IS_HANDOFF (1 << 4)
 257
 258   /* Set if current node runtime has traced vectors. */
 259 #define VLIB_NODE_FLAG_TRACE (1 << 5)
 260
 261 #define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE (1 << 6)
 262 #define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE (1 << 7)
 263
 264   /* State for input nodes. */
 265   u8 state;
 266
 267   /* Number of bytes of run time data. */
 268   u8 runtime_data_bytes;
 269
 270   /* Number of error codes used by this node. */
 271   u16 n_errors;
 272
 273   /* Size of scalar and vector arguments in bytes. */
 274   u16 scalar_size, vector_size;
 275
 276   /* Handle/index in error heap for this node. */
 277   u32 error_heap_handle;
 278   u32 error_heap_index;
 279
 280   /* Error strings indexed by error code for this node. */
 281   char **error_strings;
 282
 283   /* Vector of next node names.
 284      Only used before next_nodes array is initialized. */
 285   char **next_node_names;
 286
 287   /* Next node indices for this node. */
 288   u32 *next_nodes;
 289
 290   /* Name of node that we are sibling of. */
 291   char *sibling_of;
 292
 293   /* Bitmap of all of this node's siblings. */
 294   uword *sibling_bitmap;
 295
 296   /* Total number of vectors sent to each next node. */
 297   u64 *n_vectors_by_next_node;
 298
 299   /* Hash table mapping next node index into slot in
 300      next_nodes vector.  Quickly determines whether this node
 301      is connected to given next node and, if so, with which slot. */
 302   uword *next_slot_by_node;
 303
 304   /* Bitmap of node indices which feed this node. */
 305   uword *prev_node_bitmap;
 306
 307   /* Node/next-index which own enqueue rights with to this node. */
 308   u32 owner_node_index, owner_next_index;
 309
 310   /* Buffer format/unformat for this node. */
 311   format_function_t *format_buffer;
 312   unformat_function_t *unformat_buffer;
 313
 314   /* Trace buffer format/unformat for this node. */
 315   format_function_t *format_trace;
 316
 317   /* Function to validate incoming frames. */
 318   u8 *(*validate_frame) (struct vlib_main_t * vm,
 319                          struct vlib_node_runtime_t *,
 320                          struct vlib_frame_t * f);
 321   /* for pretty-printing, not typically valid */
 322   u8 *state_string;
 323 } vlib_node_t;
 324
 325 #define VLIB_INVALID_NODE_INDEX ((u32) ~0)
 326
 327 /* Max number of vector elements to process at once per node. */
 328 #define VLIB_FRAME_SIZE 256
 329 #define VLIB_FRAME_ALIGN VLIB_MAX_CPUS
 330
 331 /* Calling frame (think stack frame) for a node. */
 332 typedef struct vlib_frame_t
 333 {
 334   /* Frame flags. */
 335   u16 flags;
 336
 337   /* Number of scalar bytes in arguments. */
 338   u8 scalar_size;
 339
 340   /* Number of bytes per vector argument. */
 341   u8 vector_size;
 342
 343   /* Number of vector elements currently in frame. */
 344   u16 n_vectors;
 345
 346   /* Owner thread / heap id */
 347   u16 thread_index;
 348
 349   /* Scalar and vector arguments to next node. */
 350   u8 arguments[0];
 351 } vlib_frame_t;
 352
 353 typedef struct
 354 {
 355   /* Frame index. */
 356   u32 frame_index;
 357
 358   /* Node runtime for this next. */
 359   u32 node_runtime_index;
 360
 361   /* Next frame flags. */
 362   u32 flags;
 363
 364   /* Reflects node frame-used flag for this next. */
 365 #define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
 366   VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
 367
 368   /* This next frame owns enqueue to node
 369      corresponding to node_runtime_index. */
 370 #define VLIB_FRAME_OWNER (1 << 15)
 371
 372   /* Set when frame has been allocated for this next. */
 373 #define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
 374
 375   /* Set when frame has been added to pending vector. */
 376 #define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
 377
 378   /* Set when frame is to be freed after dispatch. */
 379 #define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
 380
 381   /* Set when frame has traced packets. */
 382 #define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
 383
 384   /* Number of vectors enqueue to this next since last overflow. */
 385   u32 vectors_since_last_overflow;
 386 } vlib_next_frame_t;
 387
 388 always_inline void
 389 vlib_next_frame_init (vlib_next_frame_t * nf)
 390 {
 391   memset (nf, 0, sizeof (nf[0]));
 392   nf->frame_index = ~0;
 393   nf->node_runtime_index = ~0;
 394 }
 395
 396 /* A frame pending dispatch by main loop. */
 397 typedef struct
 398 {
 399   /* Node and runtime for this frame. */
 400   u32 node_runtime_index;
 401
 402   /* Frame index (in the heap). */
 403   u32 frame_index;
 404
 405   /* Start of next frames for this node. */
 406   u32 next_frame_index;
 407
 408   /* Special value for next_frame_index when there is no next frame. */
 409 #define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
 410 } vlib_pending_frame_t;
 411
 412 typedef struct vlib_node_runtime_t
 413 {
 414   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);      /**< cacheline mark */
 415
 416   vlib_node_function_t *function;       /**< Node function to call. */
 417
 418   vlib_error_t *errors;                 /**< Vector of errors for this node. */
 419
 420 #if __SIZEOF_POINTER__ == 4
 421   u8 pad[8];
 422 #endif
 423
 424   u32 clocks_since_last_overflow;       /**< Number of clock cycles. */
 425
 426   u32 max_clock;                        /**< Maximum clock cycle for an
 427                                           invocation. */
 428
 429   u32 max_clock_n;                      /**< Number of vectors in the recorded
 430                                           max_clock. */
 431
 432   u32 calls_since_last_overflow;        /**< Number of calls. */
 433
 434   u32 vectors_since_last_overflow;      /**< Number of vector elements
 435                                           processed by this node. */
 436
 437   u32 next_frame_index;                 /**< Start of next frames for this
 438                                           node. */
 439
 440   u32 node_index;                       /**< Node index. */
 441
 442   u32 input_main_loops_per_call;        /**< For input nodes: decremented
 443                                           on each main loop interation until
 444                                           it reaches zero and function is
 445                                           called.  Allows some input nodes to
 446                                           be called more than others. */
 447
 448   u32 main_loop_count_last_dispatch;    /**< Saved main loop counter of last
 449                                           dispatch of this node. */
 450
 451   u32 main_loop_vector_stats[2];
 452
 453   u16 flags;                            /**< Copy of main node flags. */
 454
 455   u16 state;                            /**< Input node state. */
 456
 457   u16 n_next_nodes;
 458
 459   u16 cached_next_index;                /**< Next frame index that vector
 460                                           arguments were last enqueued to
 461                                           last time this node ran. Set to
 462                                           zero before first run of this
 463                                           node. */
 464
 465   u16 thread_index;                     /**< thread this node runs on */
 466
 467   u8 runtime_data[0];                   /**< Function dependent
 468                                           node-runtime data. This data is
 469                                           thread local, and it is not
 470                                           cloned from main thread. It needs
 471                                           to be initialized for each thread
 472                                           before it is used unless
 473                                           runtime_data template exists in
 474                                           vlib_node_t. */
 475 }
 476 vlib_node_runtime_t;
 477
 478 #define VLIB_NODE_RUNTIME_DATA_SIZE     (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
 479
 480 typedef struct
 481 {
 482   /* Number of allocated frames for this scalar/vector size. */
 483   u32 n_alloc_frames;
 484
 485   /* Vector of free frame indices for this scalar/vector size. */
 486   u32 *free_frame_indices;
 487 } vlib_frame_size_t;
 488
 489 typedef struct
 490 {
 491   /* Users opaque value for event type. */
 492   uword opaque;
 493 } vlib_process_event_type_t;
 494
 495 typedef struct
 496 {
 497   /* Node runtime for this process. */
 498   vlib_node_runtime_t node_runtime;
 499
 500   /* Where to longjmp when process is done. */
 501   clib_longjmp_t return_longjmp;
 502
 503 #define VLIB_PROCESS_RETURN_LONGJMP_RETURN ((uword) ~0 - 0)
 504 #define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND ((uword) ~0 - 1)
 505
 506   /* Where to longjmp to resume node after suspend. */
 507   clib_longjmp_t resume_longjmp;
 508 #define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND 0
 509 #define VLIB_PROCESS_RESUME_LONGJMP_RESUME  1
 510
 511   u16 flags;
 512 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK (1 << 0)
 513 #define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT (1 << 1)
 514   /* Set to indicate that this process has been added to resume vector. */
 515 #define VLIB_PROCESS_RESUME_PENDING (1 << 2)
 516
 517   /* Process function is currently running. */
 518 #define VLIB_PROCESS_IS_RUNNING (1 << 3)
 519
 520   /* Size of process stack. */
 521   u16 log2_n_stack_bytes;
 522
 523   u32 suspended_process_frame_index;
 524
 525   /* Number of times this process was suspended. */
 526   u32 n_suspends;
 527
 528   /* Vectors of pending event data indexed by event type index. */
 529   void **pending_event_data_by_type_index;
 530
 531   /* Bitmap of event type-indices with non-empty vectors. */
 532   uword *non_empty_event_type_bitmap;
 533
 534   /* Bitmap of event type-indices which are one time events. */
 535   uword *one_time_event_type_bitmap;
 536
 537   /* Type is opaque pointer -- typically a pointer to an event handler
 538      function.  Hash table to map opaque to a type index. */
 539   uword *event_type_index_by_type_opaque;
 540
 541   /* Pool of currently valid event types. */
 542   vlib_process_event_type_t *event_type_pool;
 543
 544   /*
 545    * When suspending saves clock time (10us ticks) when process
 546    * is to be resumed.
 547    */
 548   u64 resume_clock_interval;
 549
 550   /* Handle from timer code, to cancel an unexpired timer */
 551   u32 stop_timer_handle;
 552
 553   /* Default output function and its argument for any CLI outputs
 554      within the process. */
 555   vlib_cli_output_function_t *output_function;
 556   uword output_function_arg;
 557
 558 #ifdef CLIB_UNIX
 559   /* Pad to a multiple of the page size so we can mprotect process stacks */
 560 #define PAGE_SIZE_MULTIPLE 0x1000
 561 #define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT  __attribute__ ((aligned (PAGE_SIZE_MULTIPLE)))
 562 #else
 563 #define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT
 564 #endif
 565
 566   /* Process stack.  Starts here and extends 2^log2_n_stack_bytes
 567      bytes. */
 568
 569 #define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
 570   u32 stack[0] ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT;
 571 } vlib_process_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
 572
 573 #ifdef CLIB_UNIX
 574   /* Ensure that the stack is aligned on the multiple of the page size */
 575 typedef char
 576   assert_process_stack_must_be_aligned_exactly_to_page_size_multiple[(sizeof
 577                                                                       (vlib_process_t)
 578                                                                       -
 579                                                                       PAGE_SIZE_MULTIPLE)
 580                                                                      ==
 581                                                                      0 ? 0 :
 582                                                                      -1];
 583 #endif
 584
 585 typedef struct
 586 {
 587   u32 node_index;
 588
 589   u32 one_time_event;
 590 } vlib_one_time_waiting_process_t;
 591
 592 typedef struct
 593 {
 594   u16 n_data_elts;
 595
 596   u16 n_data_elt_bytes;
 597
 598   /* n_data_elts * n_data_elt_bytes */
 599   u32 n_data_bytes;
 600
 601   /* Process node & event type to be used to signal event. */
 602   u32 process_node_index;
 603
 604   u32 event_type_index;
 605
 606   union
 607   {
 608     u8 inline_event_data[64 - 3 * sizeof (u32) - 2 * sizeof (u16)];
 609
 610     /* Vector of event data used only when data does not fit inline. */
 611     u8 *event_data_as_vector;
 612   };
 613 }
 614 vlib_signal_timed_event_data_t;
 615
 616 always_inline uword
 617 vlib_timing_wheel_data_is_timed_event (u32 d)
 618 {
 619   return d & 1;
 620 }
 621
 622 always_inline u32
 623 vlib_timing_wheel_data_set_suspended_process (u32 i)
 624 {
 625   return 0 + 2 * i;
 626 }
 627
 628 always_inline u32
 629 vlib_timing_wheel_data_set_timed_event (u32 i)
 630 {
 631   return 1 + 2 * i;
 632 }
 633
 634 always_inline uword
 635 vlib_timing_wheel_data_get_index (u32 d)
 636 {
 637   return d / 2;
 638 }
 639
 640 typedef struct
 641 {
 642   /* Public nodes. */
 643   vlib_node_t **nodes;
 644
 645   /* Node index hashed by node name. */
 646   uword *node_by_name;
 647
 648   u32 flags;
 649 #define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
 650
 651   /* Nodes segregated by type for cache locality.
 652      Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
 653   vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
 654
 655   /* Node runtime indices for input nodes with pending interrupts. */
 656   u32 *pending_interrupt_node_runtime_indices;
 657   clib_spinlock_t pending_interrupt_lock;
 658
 659   /* Input nodes are switched from/to interrupt to/from polling mode
 660      when average vector length goes above/below polling/interrupt
 661      thresholds. */
 662   u32 polling_threshold_vector_length;
 663   u32 interrupt_threshold_vector_length;
 664
 665   /* Vector of next frames. */
 666   vlib_next_frame_t *next_frames;
 667
 668   /* Vector of internal node's frames waiting to be called. */
 669   vlib_pending_frame_t *pending_frames;
 670
 671   /* Timing wheel for scheduling time-based node dispatch. */
 672   void *timing_wheel;
 673
 674   vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
 675
 676   /* Opaque data vector added via timing_wheel_advance. */
 677   u32 *data_from_advancing_timing_wheel;
 678
 679   /* CPU time of next process to be ready on timing wheel. */
 680   f64 time_next_process_ready;
 681
 682   /* Vector of process nodes.
 683      One for each node of type VLIB_NODE_TYPE_PROCESS. */
 684   vlib_process_t **processes;
 685
 686   /* Current running process or ~0 if no process running. */
 687   u32 current_process_index;
 688
 689   /* Pool of pending process frames. */
 690   vlib_pending_frame_t *suspended_process_frames;
 691
 692   /* Vector of event data vectors pending recycle. */
 693   void **recycled_event_data_vectors;
 694
 695   /* Current counts of nodes in each state. */
 696   u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
 697
 698   /* Hash of (scalar_size,vector_size) to frame_sizes index. */
 699   uword *frame_size_hash;
 700
 701   /* Per-size frame allocation information. */
 702   vlib_frame_size_t *frame_sizes;
 703
 704   /* Time of last node runtime stats clear. */
 705   f64 time_last_runtime_stats_clear;
 706
 707   /* Node registrations added by constructors */
 708   vlib_node_registration_t *node_registrations;
 709 } vlib_node_main_t;
 710
 711
 712 #define FRAME_QUEUE_MAX_NELTS 32
 713 typedef struct
 714 {
 715   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 716   u64 head;
 717   u64 head_hint;
 718   u64 tail;
 719   u32 n_in_use;
 720   u32 nelts;
 721   u32 written;
 722   u32 threshold;
 723   i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
 724 } frame_queue_trace_t;
 725
 726 typedef struct
 727 {
 728   u64 count[FRAME_QUEUE_MAX_NELTS];
 729 } frame_queue_nelt_counter_t;
 730
 731 #endif /* included_vlib_node_h */
 732
 733 /*
 734  * fd.io coding-style-patch-verification: ON
 735  *
 736  * Local Variables:
 737  * eval: (c-set-style "gnu")
 738  * End:
 739  */