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