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