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