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