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