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