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   int priority;
  93   struct _vlib_node_fn_registration *next_registration;
  94   char *name;
  95 } vlib_node_fn_registration_t;
  96
  97 typedef struct _vlib_node_registration
  98 {
  99   /* Vector processing function for this node. */
 100   vlib_node_function_t *function;
 101
 102   /* Node function candidate registration with priority */
 103   vlib_node_fn_registration_t *node_fn_registrations;
 104
 105   /* Node name. */
 106   char *name;
 107
 108   /* Name of sibling (if applicable). */
 109   char *sibling_of;
 110
 111   /* Node index filled in by registration. */
 112   u32 index;
 113
 114   /* Type of this node. */
 115   vlib_node_type_t type;
 116
 117   /* Error strings indexed by error code for this node. */
 118   char **error_strings;
 119   vl_counter_t *error_counters;
 120
 121   /* Buffer format/unformat for this node. */
 122   format_function_t *format_buffer;
 123   unformat_function_t *unformat_buffer;
 124
 125   /* Trace format/unformat for this node. */
 126   format_function_t *format_trace;
 127   unformat_function_t *unformat_trace;
 128
 129   /* Function to validate incoming frames. */
 130   u8 *(*validate_frame) (struct vlib_main_t * vm,
 131                          struct vlib_node_runtime_t *,
 132                          struct vlib_frame_t * f);
 133
 134   /* Per-node runtime data. */
 135   void *runtime_data;
 136
 137   /* Process stack size. */
 138   u16 process_log2_n_stack_bytes;
 139
 140   /* Number of bytes of per-node run time data. */
 141   u8 runtime_data_bytes;
 142
 143   /* State for input nodes. */
 144   u8 state;
 145
 146   /* Node flags. */
 147   u16 flags;
 148
 149   /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
 150   u8 protocol_hint;
 151
 152   /* Size of scalar and vector arguments in bytes. */
 153   u16 scalar_size, vector_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_main_t * vm = vlib_get_main();                                 \
 177     x.next_registration = vm->node_main.node_registrations;             \
 178     vm->node_main.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_main_t * vm = vlib_get_main();                                 \
 185     VLIB_REMOVE_FROM_LINKED_LIST (vm->node_main.node_registrations,     \
 186                                   &x, 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                                      \
 206   CLIB_MARCH_SFX(node##_fn_registration) =                              \
 207   { .function = &CLIB_MARCH_SFX (node##_fn), };                         \
 208                                                                         \
 209 static void __clib_constructor                                          \
 210 CLIB_MARCH_SFX (node##_multiarch_register) (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->priority = CLIB_MARCH_FN_PRIORITY();                               \
 216   r->name = CLIB_MARCH_VARIANT_STR;                                     \
 217   r->next_registration = node.node_fn_registrations;                    \
 218   node.node_fn_registrations = r;                                       \
 219 }                                                                       \
 220 uword CLIB_CPU_OPTIMIZED 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
 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 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
 318   /* Counter structures indexed by counter code for this node. */
 319   vl_counter_t *error_counters;
 320
 321   /* Vector of next node names.
 322      Only used before next_nodes array is initialized. */
 323   char **next_node_names;
 324
 325   /* Next node indices for this node. */
 326   u32 *next_nodes;
 327
 328   /* Name of node that we are sibling of. */
 329   char *sibling_of;
 330
 331   /* Bitmap of all of this node's siblings. */
 332   uword *sibling_bitmap;
 333
 334   /* Total number of vectors sent to each next node. */
 335   u64 *n_vectors_by_next_node;
 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. */
 340   uword *next_slot_by_node;
 341
 342   /* Bitmap of node indices which feed this node. */
 343   uword *prev_node_bitmap;
 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. */
 349   format_function_t *format_buffer;
 350   unformat_function_t *unformat_buffer;
 351
 352   /* Trace buffer format/unformat for this node. */
 353   format_function_t *format_trace;
 354
 355   /* Function to validate incoming frames. */
 356   u8 *(*validate_frame) (struct vlib_main_t * vm,
 357                          struct vlib_node_runtime_t *,
 358                          struct vlib_frame_t * f);
 359   /* for pretty-printing, not typically valid */
 360   u8 *state_string;
 361
 362   /* Node function candidate registration with priority */
 363   vlib_node_fn_registration_t *node_fn_registrations;
 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
 370 #define VLIB_FRAME_ALIGN CLIB_CACHE_LINE_BYTES
 371
 372 /* Calling frame (think stack frame) for a node. */
 373 typedef struct vlib_frame_t
 374 {
 375   /* Frame flags. */
 376   u16 frame_flags;
 377
 378   /* User flags. Used for sending hints to the next node. */
 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
 390   /* Scalar and vector arguments to next node. */
 391   u8 arguments[0];
 392 } vlib_frame_t;
 393
 394 typedef struct
 395 {
 396   /* Frame pointer. */
 397   vlib_frame_t *frame;
 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
 409   /* Don't append this frame */
 410 #define VLIB_FRAME_NO_APPEND (1 << 14)
 411
 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 {
 435   clib_memset (nf, 0, sizeof (nf[0]));
 436   nf->node_runtime_index = ~0;
 437 }
 438
 439 /* A frame pending dispatch by main loop. */
 440 typedef struct
 441 {
 442   /* Node and runtime for this frame. */
 443   u32 node_runtime_index;
 444
 445   /* Frame index (in the heap). */
 446   vlib_frame_t *frame;
 447
 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
 455 typedef struct vlib_node_runtime_t
 456 {
 457   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);      /**< cacheline mark */
 458
 459   vlib_node_function_t *function;       /**< Node function to call. */
 460
 461   vlib_error_t *errors;                 /**< Vector of errors for this node. */
 462
 463   u32 clocks_since_last_overflow;       /**< Number of clock cycles. */
 464
 465   u32 max_clock;                        /**< Maximum clock cycle for an
 466                                           invocation. */
 467
 468   u32 max_clock_n;                      /**< Number of vectors in the recorded
 469                                           max_clock. */
 470
 471   u32 calls_since_last_overflow;        /**< Number of calls. */
 472
 473   u32 vectors_since_last_overflow;      /**< Number of vector elements
 474                                           processed by this node. */
 475
 476   u32 next_frame_index;                 /**< Start of next frames for this
 477                                           node. */
 478
 479   u32 node_index;                       /**< Node index. */
 480
 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. */
 489
 490   u32 main_loop_vector_stats[2];
 491
 492   u16 flags;                            /**< Copy of main node flags. */
 493
 494   u16 state;                            /**< Input node state. */
 495
 496   u16 n_next_nodes;
 497
 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. */
 503
 504   u16 thread_index;                     /**< thread this node runs on */
 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   /* Vector of free frames for this scalar/vector size. */
 525   vlib_frame_t **free_frames;
 526 } vlib_frame_size_t;
 527
 528 typedef struct
 529 {
 530   /* Users opaque value for event type. */
 531   uword opaque;
 532 } vlib_process_event_type_t;
 533
 534 typedef struct
 535 {
 536   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 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. */
 569   void **pending_event_data_by_type_index;
 570
 571   /* Bitmap of event type-indices with non-empty vectors. */
 572   uword *non_empty_event_type_bitmap;
 573
 574   /* Bitmap of event type-indices which are one time events. */
 575   uword *one_time_event_type_bitmap;
 576
 577   /* Type is opaque pointer -- typically a pointer to an event handler
 578      function.  Hash table to map opaque to a type index. */
 579   uword *event_type_index_by_type_opaque;
 580
 581   /* Pool of currently valid event types. */
 582   vlib_process_event_type_t *event_type_pool;
 583
 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;
 592
 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
 598   /* Process stack */
 599 #define VLIB_PROCESS_STACK_MAGIC (0xdead7ead)
 600   u32 *stack;
 601 } vlib_process_t;
 602
 603 typedef struct
 604 {
 605   u32 node_index;
 606
 607   u32 one_time_event;
 608 } vlib_one_time_waiting_process_t;
 609
 610 typedef struct
 611 {
 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
 624   union
 625   {
 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. */
 629     u8 *event_data_as_vector;
 630   };
 631 }
 632 vlib_signal_timed_event_data_t;
 633
 634 always_inline uword
 635 vlib_timing_wheel_data_is_timed_event (u32 d)
 636 {
 637   return d & 1;
 638 }
 639
 640 always_inline u32
 641 vlib_timing_wheel_data_set_suspended_process (u32 i)
 642 {
 643   return 0 + 2 * i;
 644 }
 645
 646 always_inline u32
 647 vlib_timing_wheel_data_set_timed_event (u32 i)
 648 {
 649   return 1 + 2 * i;
 650 }
 651
 652 always_inline uword
 653 vlib_timing_wheel_data_get_index (u32 d)
 654 {
 655   return d / 2;
 656 }
 657
 658 typedef struct
 659 {
 660   /* Public nodes. */
 661   vlib_node_t **nodes;
 662
 663   /* Node index hashed by node name. */
 664   uword *node_by_name;
 665
 666   u32 flags;
 667 #define VLIB_NODE_MAIN_RUNTIME_STARTED (1 << 0)
 668
 669   /* Nodes segregated by type for cache locality.
 670      Does not apply to nodes of type VLIB_NODE_TYPE_INTERNAL. */
 671   vlib_node_runtime_t *nodes_by_type[VLIB_N_NODE_TYPE];
 672
 673   /* Node runtime indices for input nodes with pending interrupts. */
 674   void *interrupts;
 675   volatile u32 *pending_interrupts;
 676
 677   /* Input nodes are switched from/to interrupt to/from polling mode
 678      when average vector length goes above/below polling/interrupt
 679      thresholds. */
 680   u32 polling_threshold_vector_length;
 681   u32 interrupt_threshold_vector_length;
 682
 683   /* Vector of next frames. */
 684   vlib_next_frame_t *next_frames;
 685
 686   /* Vector of internal node's frames waiting to be called. */
 687   vlib_pending_frame_t *pending_frames;
 688
 689   /* Timing wheel for scheduling time-based node dispatch. */
 690   void *timing_wheel;
 691
 692   vlib_signal_timed_event_data_t *signal_timed_event_data_pool;
 693
 694   /* Opaque data vector added via timing_wheel_advance. */
 695   u32 *data_from_advancing_timing_wheel;
 696
 697   /* CPU time of next process to be ready on timing wheel. */
 698   f64 time_next_process_ready;
 699
 700   /* Vector of process nodes.
 701      One for each node of type VLIB_NODE_TYPE_PROCESS. */
 702   vlib_process_t **processes;
 703
 704   /* Current running process or ~0 if no process running. */
 705   u32 current_process_index;
 706
 707   /* Pool of pending process frames. */
 708   vlib_pending_frame_t *suspended_process_frames;
 709
 710   /* Vector of event data vectors pending recycle. */
 711   void **recycled_event_data_vectors;
 712
 713   /* Current counts of nodes in each state. */
 714   u32 input_node_counts_by_state[VLIB_N_NODE_STATE];
 715
 716   /* Hash of (scalar_size,vector_size) to frame_sizes index. */
 717   uword *frame_size_hash;
 718
 719   /* Per-size frame allocation information. */
 720   vlib_frame_size_t *frame_sizes;
 721
 722   /* Time of last node runtime stats clear. */
 723   f64 time_last_runtime_stats_clear;
 724
 725   /* Node registrations added by constructors */
 726   vlib_node_registration_t *node_registrations;
 727
 728   /* Node index from error code */
 729   u32 *node_by_error;
 730 } vlib_node_main_t;
 731
 732 typedef u16 vlib_error_t;
 733
 734 always_inline u32
 735 vlib_error_get_node (vlib_node_main_t * nm, vlib_error_t e)
 736 {
 737   return nm->node_by_error[e];
 738 }
 739
 740 always_inline u32
 741 vlib_error_get_code (vlib_node_main_t * nm, vlib_error_t e)
 742 {
 743   u32 node_index = nm->node_by_error[e];
 744   vlib_node_t *n = nm->nodes[node_index];
 745   u32 error_code = e - n->error_heap_index;
 746   return error_code;
 747 }
 748
 749 #define FRAME_QUEUE_MAX_NELTS 64
 750 typedef struct
 751 {
 752   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 753   u64 head;
 754   u64 head_hint;
 755   u64 tail;
 756   u32 n_in_use;
 757   u32 nelts;
 758   u32 written;
 759   u32 threshold;
 760   i32 n_vectors[FRAME_QUEUE_MAX_NELTS];
 761 } frame_queue_trace_t;
 762
 763 typedef struct
 764 {
 765   u64 count[FRAME_QUEUE_MAX_NELTS];
 766 } frame_queue_nelt_counter_t;
 767
 768 #endif /* included_vlib_node_h */
 769
 770 /*
 771  * fd.io coding-style-patch-verification: ON
 772  *
 773  * Local Variables:
 774  * eval: (c-set-style "gnu")
 775  * End:
 776  */