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