src/vlib/node.h

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