src/vlib/node_funcs.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_funcs.h: processing nodes global functions/inlines
  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 /** \file
  41     vlib node functions
  42 */
  43
  44
  45 #ifndef included_vlib_node_funcs_h
  46 #define included_vlib_node_funcs_h
  47
  48 #include <vppinfra/fifo.h>
  49 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
  50 #include <vppinfra/interrupt.h>
  51
  52 #ifdef CLIB_SANITIZE_ADDR
  53 #include <sanitizer/asan_interface.h>
  54 #endif
  55
  56 static_always_inline void
  57 vlib_process_start_switch_stack (vlib_main_t * vm, vlib_process_t * p)
  58 {
  59 #ifdef CLIB_SANITIZE_ADDR
  60   void *stack = p ? (void *) p->stack : vlib_thread_stacks[vm->thread_index];
  61   u32 stack_bytes = p ? p->log2_n_stack_bytes : VLIB_THREAD_STACK_SIZE;
  62   __sanitizer_start_switch_fiber (&vm->asan_stack_save, stack, stack_bytes);
  63 #endif
  64 }
  65
  66 static_always_inline void
  67 vlib_process_finish_switch_stack (vlib_main_t * vm)
  68 {
  69 #ifdef CLIB_SANITIZE_ADDR
  70   const void *bottom_old;
  71   size_t size_old;
  72
  73   __sanitizer_finish_switch_fiber (&vm->asan_stack_save, &bottom_old,
  74                                    &size_old);
  75 #endif
  76 }
  77
  78 /** \brief Get vlib node by index.
  79  @warning This function will ASSERT if @c i is out of range.
  80  @param vm vlib_main_t pointer, varies by thread
  81  @param i node index.
  82  @return pointer to the requested vlib_node_t.
  83 */
  84
  85 always_inline vlib_node_t *
  86 vlib_get_node (vlib_main_t * vm, u32 i)
  87 {
  88   return vec_elt (vm->node_main.nodes, i);
  89 }
  90
  91 /** \brief Get vlib node by graph arc (next) index.
  92  @param vm vlib_main_t pointer, varies by thread
  93  @param node_index index of original node
  94  @param next_index graph arc index
  95  @return pointer to the vlib_node_t at the end of the indicated arc
  96 */
  97
  98 always_inline vlib_node_t *
  99 vlib_get_next_node (vlib_main_t * vm, u32 node_index, u32 next_index)
 100 {
 101   vlib_node_main_t *nm = &vm->node_main;
 102   vlib_node_t *n;
 103
 104   n = vec_elt (nm->nodes, node_index);
 105   ASSERT (next_index < vec_len (n->next_nodes));
 106   return vlib_get_node (vm, n->next_nodes[next_index]);
 107 }
 108
 109 /** \brief Get node runtime by node index.
 110  @param vm vlib_main_t pointer, varies by thread
 111  @param node_index index of node
 112  @return pointer to the indicated vlib_node_runtime_t
 113 */
 114
 115 always_inline vlib_node_runtime_t *
 116 vlib_node_get_runtime (vlib_main_t * vm, u32 node_index)
 117 {
 118   vlib_node_main_t *nm = &vm->node_main;
 119   vlib_node_t *n = vec_elt (nm->nodes, node_index);
 120   vlib_process_t *p;
 121   if (n->type != VLIB_NODE_TYPE_PROCESS)
 122     return vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
 123   else
 124     {
 125       p = vec_elt (nm->processes, n->runtime_index);
 126       return &p->node_runtime;
 127     }
 128 }
 129
 130 /** \brief Get node runtime private data by node index.
 131  @param vm vlib_main_t pointer, varies by thread
 132  @param node_index index of the node
 133  @return pointer to the indicated vlib_node_runtime_t private data
 134 */
 135
 136 always_inline void *
 137 vlib_node_get_runtime_data (vlib_main_t * vm, u32 node_index)
 138 {
 139   vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
 140   return r->runtime_data;
 141 }
 142
 143 /** \brief Set node runtime private data.
 144  @param vm vlib_main_t pointer, varies by thread
 145  @param node_index index of the node
 146  @param runtime_data arbitrary runtime private data
 147  @param n_runtime_data_bytes size of runtime private data
 148 */
 149
 150 always_inline void
 151 vlib_node_set_runtime_data (vlib_main_t * vm, u32 node_index,
 152                             void *runtime_data, u32 n_runtime_data_bytes)
 153 {
 154   vlib_node_t *n = vlib_get_node (vm, node_index);
 155   vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
 156
 157   n->runtime_data_bytes = n_runtime_data_bytes;
 158   vec_free (n->runtime_data);
 159   vec_add (n->runtime_data, runtime_data, n_runtime_data_bytes);
 160
 161   ASSERT (vec_len (n->runtime_data) <= sizeof (vlib_node_runtime_t) -
 162           STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
 163
 164   if (vec_len (n->runtime_data) > 0)
 165     clib_memcpy_fast (r->runtime_data, n->runtime_data,
 166                       vec_len (n->runtime_data));
 167 }
 168
 169 /** \brief Set node dispatch state.
 170  @param vm vlib_main_t pointer, varies by thread
 171  @param node_index index of the node
 172  @param new_state new state for node, see vlib_node_state_t
 173 */
 174 always_inline void
 175 vlib_node_set_state (vlib_main_t * vm, u32 node_index,
 176                      vlib_node_state_t new_state)
 177 {
 178   vlib_node_main_t *nm = &vm->node_main;
 179   vlib_node_t *n;
 180   vlib_node_runtime_t *r;
 181
 182   n = vec_elt (nm->nodes, node_index);
 183   if (n->type == VLIB_NODE_TYPE_PROCESS)
 184     {
 185       vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
 186       r = &p->node_runtime;
 187
 188       /* When disabling make sure flags are cleared. */
 189       p->flags &= ~(VLIB_PROCESS_RESUME_PENDING
 190                     | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
 191                     | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT);
 192     }
 193   else
 194     r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
 195
 196   ASSERT (new_state < VLIB_N_NODE_STATE);
 197
 198   if (n->type == VLIB_NODE_TYPE_INPUT)
 199     {
 200       ASSERT (nm->input_node_counts_by_state[n->state] > 0);
 201       nm->input_node_counts_by_state[n->state] -= 1;
 202       nm->input_node_counts_by_state[new_state] += 1;
 203     }
 204
 205   if (PREDICT_FALSE (r->state == VLIB_NODE_STATE_DISABLED))
 206     vlib_node_runtime_perf_counter (vm, r, 0, 0, 0,
 207                                     VLIB_NODE_RUNTIME_PERF_RESET);
 208
 209   n->state = new_state;
 210   r->state = new_state;
 211 }
 212
 213 /** \brief Get node dispatch state.
 214  @param vm vlib_main_t pointer, varies by thread
 215  @param node_index index of the node
 216  @return state for node, see vlib_node_state_t
 217 */
 218 always_inline vlib_node_state_t
 219 vlib_node_get_state (vlib_main_t * vm, u32 node_index)
 220 {
 221   vlib_node_main_t *nm = &vm->node_main;
 222   vlib_node_t *n;
 223   n = vec_elt (nm->nodes, node_index);
 224   return n->state;
 225 }
 226
 227 always_inline void
 228 vlib_node_set_flag (vlib_main_t *vm, u32 node_index, u16 flag, u8 enable)
 229 {
 230   vlib_node_runtime_t *r;
 231   vlib_node_t *n;
 232
 233   n = vlib_get_node (vm, node_index);
 234   r = vlib_node_get_runtime (vm, node_index);
 235
 236   if (enable)
 237     {
 238       n->flags |= flag;
 239       r->flags |= flag;
 240     }
 241   else
 242     {
 243       n->flags &= ~flag;
 244       r->flags &= ~flag;
 245     }
 246 }
 247
 248 always_inline void
 249 vlib_node_set_interrupt_pending (vlib_main_t *vm, u32 node_index)
 250 {
 251   vlib_node_main_t *nm = &vm->node_main;
 252   vlib_node_t *n = vec_elt (nm->nodes, node_index);
 253
 254   ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
 255
 256   if (vm != vlib_get_main ())
 257     clib_interrupt_set_atomic (nm->interrupts, n->runtime_index);
 258   else
 259     clib_interrupt_set (nm->interrupts, n->runtime_index);
 260
 261   __atomic_store_n (nm->pending_interrupts, 1, __ATOMIC_RELEASE);
 262 }
 263
 264 always_inline vlib_process_t *
 265 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
 266 {
 267   vlib_node_main_t *nm = &vm->node_main;
 268   ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
 269   return vec_elt (nm->processes, node->runtime_index);
 270 }
 271
 272 always_inline vlib_frame_t *
 273 vlib_get_frame (vlib_main_t * vm, vlib_frame_t * f)
 274 {
 275   ASSERT (f != NULL);
 276   ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
 277   return f;
 278 }
 279
 280 always_inline void
 281 vlib_frame_no_append (vlib_frame_t * f)
 282 {
 283   f->frame_flags |= VLIB_FRAME_NO_APPEND;
 284 }
 285
 286 /* Byte alignment for vector arguments. */
 287 #define VLIB_FRAME_VECTOR_ALIGN (1 << 4)
 288
 289 always_inline u32
 290 vlib_frame_vector_byte_offset (u32 scalar_size)
 291 {
 292   return round_pow2 (sizeof (vlib_frame_t) + scalar_size,
 293                      VLIB_FRAME_VECTOR_ALIGN);
 294 }
 295
 296 /** \brief Get pointer to frame vector data.
 297  @param f vlib_frame_t pointer
 298  @return pointer to first vector element in frame
 299 */
 300 always_inline void *
 301 vlib_frame_vector_args (vlib_frame_t * f)
 302 {
 303   return (void *) f + vlib_frame_vector_byte_offset (f->scalar_size);
 304 }
 305
 306 /** \brief Get pointer to frame scalar data.
 307
 308  @param f vlib_frame_t pointer
 309
 310  @return arbitrary node scalar data
 311
 312  @sa vlib_frame_vector_args
 313 */
 314 always_inline void *
 315 vlib_frame_scalar_args (vlib_frame_t * f)
 316 {
 317   return vlib_frame_vector_args (f) - f->scalar_size;
 318 }
 319
 320 always_inline vlib_next_frame_t *
 321 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
 322                                   vlib_node_runtime_t * n, u32 next_index)
 323 {
 324   vlib_node_main_t *nm = &vm->node_main;
 325   vlib_next_frame_t *nf;
 326
 327   ASSERT (next_index < n->n_next_nodes);
 328   nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
 329
 330   if (CLIB_DEBUG > 0)
 331     {
 332       vlib_node_t *node, *next;
 333       node = vec_elt (nm->nodes, n->node_index);
 334       next = vec_elt (nm->nodes, node->next_nodes[next_index]);
 335       ASSERT (nf->node_runtime_index == next->runtime_index);
 336     }
 337
 338   return nf;
 339 }
 340
 341 /** \brief Get pointer to frame by (@c node_index, @c next_index).
 342
 343  @warning This is not a function that you should call directly.
 344  See @ref vlib_get_next_frame instead.
 345
 346  @param vm vlib_main_t pointer, varies by thread
 347  @param node_index index of the node
 348  @param next_index graph arc index
 349
 350  @return pointer to the requested vlib_next_frame_t
 351
 352  @sa vlib_get_next_frame
 353 */
 354
 355 always_inline vlib_next_frame_t *
 356 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
 357 {
 358   vlib_node_main_t *nm = &vm->node_main;
 359   vlib_node_t *n;
 360   vlib_node_runtime_t *r;
 361
 362   n = vec_elt (nm->nodes, node_index);
 363   r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
 364   return vlib_node_runtime_get_next_frame (vm, r, next_index);
 365 }
 366
 367 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
 368                                             vlib_node_runtime_t * node,
 369                                             u32 next_index,
 370                                             u32 alloc_new_frame);
 371
 372 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
 373 do {                                                                    \
 374   vlib_frame_t * _f                                                     \
 375     = vlib_get_next_frame_internal ((vm), (node), (next_index),         \
 376                                     (alloc_new_frame));                 \
 377   u32 _n = _f->n_vectors;                                               \
 378   (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
 379   (n_vectors_left) = VLIB_FRAME_SIZE - _n;                              \
 380 } while (0)
 381
 382
 383 /** \brief Get pointer to next frame vector data by
 384     (@c vlib_node_runtime_t, @c next_index).
 385  Standard single/dual loop boilerplate element.
 386  @attention This is a MACRO, with SIDE EFFECTS.
 387
 388  @param vm vlib_main_t pointer, varies by thread
 389  @param node current node vlib_node_runtime_t pointer
 390  @param next_index requested graph arc index
 391
 392  @return @c vectors -- pointer to next available vector slot
 393  @return @c n_vectors_left -- number of vector slots available
 394 */
 395 #define vlib_get_next_frame(vm,node,next_index,vectors,n_vectors_left)  \
 396   vlib_get_next_frame_macro (vm, node, next_index,                      \
 397                              vectors, n_vectors_left,                   \
 398                              /* alloc new frame */ 0)
 399
 400 #define vlib_get_new_next_frame(vm,node,next_index,vectors,n_vectors_left) \
 401   vlib_get_next_frame_macro (vm, node, next_index,                      \
 402                              vectors, n_vectors_left,                   \
 403                              /* alloc new frame */ 1)
 404
 405 /** \brief Release pointer to next frame vector data.
 406  Standard single/dual loop boilerplate element.
 407  @param vm vlib_main_t pointer, varies by thread
 408  @param r current node vlib_node_runtime_t pointer
 409  @param next_index graph arc index
 410  @param n_packets_left number of slots still available in vector
 411 */
 412 void
 413 vlib_put_next_frame (vlib_main_t * vm,
 414                      vlib_node_runtime_t * r,
 415                      u32 next_index, u32 n_packets_left);
 416
 417 /* Combination get plus put.  Returns vector argument just added. */
 418 #define vlib_set_next_frame(vm,node,next_index,v)                       \
 419 ({                                                                      \
 420   uword _n_left;                                                        \
 421   vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left);       \
 422   ASSERT (_n_left > 0);                                                 \
 423   vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1);        \
 424   (v);                                                                  \
 425 })
 426
 427 always_inline void
 428 vlib_set_next_frame_buffer (vlib_main_t * vm,
 429                             vlib_node_runtime_t * node,
 430                             u32 next_index, u32 buffer_index)
 431 {
 432   u32 *p;
 433   p = vlib_set_next_frame (vm, node, next_index, p);
 434   p[0] = buffer_index;
 435 }
 436
 437 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
 438 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
 439                              vlib_frame_t * f);
 440
 441 always_inline uword
 442 vlib_in_process_context (vlib_main_t * vm)
 443 {
 444   return vm->node_main.current_process_index != ~0;
 445 }
 446
 447 always_inline vlib_process_t *
 448 vlib_get_current_process (vlib_main_t * vm)
 449 {
 450   vlib_node_main_t *nm = &vm->node_main;
 451   if (vlib_in_process_context (vm))
 452     return vec_elt (nm->processes, nm->current_process_index);
 453   return 0;
 454 }
 455
 456 always_inline uword
 457 vlib_current_process (vlib_main_t * vm)
 458 {
 459   return vlib_get_current_process (vm)->node_runtime.node_index;
 460 }
 461
 462 always_inline u32
 463 vlib_get_current_process_node_index (vlib_main_t * vm)
 464 {
 465   vlib_process_t *process = vlib_get_current_process (vm);
 466   return process->node_runtime.node_index;
 467 }
 468
 469 /** Returns TRUE if a process suspend time is less than 10us
 470     @param dt - remaining poll time in seconds
 471     @returns 1 if dt < 10e-6, 0 otherwise
 472 */
 473 always_inline uword
 474 vlib_process_suspend_time_is_zero (f64 dt)
 475 {
 476   return dt < 10e-6;
 477 }
 478
 479 /** Suspend a vlib cooperative multi-tasking thread for a period of time
 480     @param vm - vlib_main_t *
 481     @param dt - suspend interval in seconds
 482     @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
 483 */
 484
 485 always_inline uword
 486 vlib_process_suspend (vlib_main_t * vm, f64 dt)
 487 {
 488   uword r;
 489   vlib_node_main_t *nm = &vm->node_main;
 490   vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
 491
 492   if (vlib_process_suspend_time_is_zero (dt))
 493     return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
 494
 495   p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
 496   r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
 497   if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
 498     {
 499       /* expiration time in 10us ticks */
 500       p->resume_clock_interval = dt * 1e5;
 501       vlib_process_start_switch_stack (vm, 0);
 502       clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
 503     }
 504   else
 505     vlib_process_finish_switch_stack (vm);
 506
 507   return r;
 508 }
 509
 510 always_inline void
 511 vlib_process_free_event_type (vlib_process_t * p, uword t,
 512                               uword is_one_time_event)
 513 {
 514   ASSERT (!pool_is_free_index (p->event_type_pool, t));
 515   pool_put_index (p->event_type_pool, t);
 516   if (is_one_time_event)
 517     p->one_time_event_type_bitmap =
 518       clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
 519 }
 520
 521 always_inline void
 522 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
 523 {
 524   ASSERT (!pool_is_free_index (p->event_type_pool, t));
 525   if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
 526     vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
 527 }
 528
 529 always_inline void *
 530 vlib_process_get_event_data (vlib_main_t * vm,
 531                              uword * return_event_type_opaque)
 532 {
 533   vlib_node_main_t *nm = &vm->node_main;
 534   vlib_process_t *p;
 535   vlib_process_event_type_t *et;
 536   uword t;
 537   void *event_data_vector;
 538
 539   p = vec_elt (nm->processes, nm->current_process_index);
 540
 541   /* Find first type with events ready.
 542      Return invalid type when there's nothing there. */
 543   t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
 544   if (t == ~0)
 545     return 0;
 546
 547   p->non_empty_event_type_bitmap =
 548     clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
 549
 550   ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
 551   event_data_vector = p->pending_event_data_by_type_index[t];
 552   p->pending_event_data_by_type_index[t] = 0;
 553
 554   et = pool_elt_at_index (p->event_type_pool, t);
 555
 556   /* Return user's opaque value and possibly index. */
 557   *return_event_type_opaque = et->opaque;
 558
 559   vlib_process_maybe_free_event_type (p, t);
 560
 561   return event_data_vector;
 562 }
 563
 564 /* Return event data vector for later reuse.  We reuse event data to avoid
 565    repeatedly allocating event vectors in cases where we care about speed. */
 566 always_inline void
 567 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
 568 {
 569   vlib_node_main_t *nm = &vm->node_main;
 570   vec_add1 (nm->recycled_event_data_vectors, event_data);
 571 }
 572
 573 /** Return the first event type which has occurred and a vector of per-event
 574     data of that type, or a timeout indication
 575
 576     @param vm - vlib_main_t pointer
 577     @param data_vector - pointer to a (uword *) vector to receive event data
 578     @returns either an event type and a vector of per-event instance data,
 579     or ~0 to indicate a timeout.
 580 */
 581
 582 always_inline uword
 583 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
 584 {
 585   vlib_node_main_t *nm = &vm->node_main;
 586   vlib_process_t *p;
 587   vlib_process_event_type_t *et;
 588   uword r, t, l;
 589
 590   p = vec_elt (nm->processes, nm->current_process_index);
 591
 592   /* Find first type with events ready.
 593      Return invalid type when there's nothing there. */
 594   t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
 595   if (t == ~0)
 596     return t;
 597
 598   p->non_empty_event_type_bitmap =
 599     clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
 600
 601   l = _vec_len (p->pending_event_data_by_type_index[t]);
 602   if (data_vector)
 603     vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
 604   _vec_len (p->pending_event_data_by_type_index[t]) = 0;
 605
 606   et = pool_elt_at_index (p->event_type_pool, t);
 607
 608   /* Return user's opaque value. */
 609   r = et->opaque;
 610
 611   vlib_process_maybe_free_event_type (p, t);
 612
 613   return r;
 614 }
 615
 616 always_inline uword
 617 vlib_process_get_events_helper (vlib_process_t * p, uword t,
 618                                 uword ** data_vector)
 619 {
 620   uword l;
 621
 622   p->non_empty_event_type_bitmap =
 623     clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
 624
 625   l = _vec_len (p->pending_event_data_by_type_index[t]);
 626   if (data_vector)
 627     vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
 628   _vec_len (p->pending_event_data_by_type_index[t]) = 0;
 629
 630   vlib_process_maybe_free_event_type (p, t);
 631
 632   return l;
 633 }
 634
 635 /* As above but query as specified type of event.  Returns number of
 636    events found. */
 637 always_inline uword
 638 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
 639                                    uword with_type_opaque)
 640 {
 641   vlib_node_main_t *nm = &vm->node_main;
 642   vlib_process_t *p;
 643   uword t, *h;
 644
 645   p = vec_elt (nm->processes, nm->current_process_index);
 646   h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
 647   if (!h)
 648     /* This can happen when an event has not yet been
 649        signaled with given opaque type. */
 650     return 0;
 651
 652   t = h[0];
 653   if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
 654     return 0;
 655
 656   return vlib_process_get_events_helper (p, t, data_vector);
 657 }
 658
 659 always_inline uword *
 660 vlib_process_wait_for_event (vlib_main_t * vm)
 661 {
 662   vlib_node_main_t *nm = &vm->node_main;
 663   vlib_process_t *p;
 664   uword r;
 665
 666   p = vec_elt (nm->processes, nm->current_process_index);
 667   if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
 668     {
 669       p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
 670       r =
 671         clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
 672       if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
 673         {
 674           vlib_process_start_switch_stack (vm, 0);
 675           clib_longjmp (&p->return_longjmp,
 676                         VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
 677         }
 678       else
 679         vlib_process_finish_switch_stack (vm);
 680     }
 681
 682   return p->non_empty_event_type_bitmap;
 683 }
 684
 685 always_inline uword
 686 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
 687                                       uword ** data_vector,
 688                                       uword with_type_index)
 689 {
 690   vlib_node_main_t *nm = &vm->node_main;
 691   vlib_process_t *p;
 692   uword r;
 693
 694   p = vec_elt (nm->processes, nm->current_process_index);
 695   ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
 696   while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
 697     {
 698       p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
 699       r =
 700         clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
 701       if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
 702         {
 703           vlib_process_start_switch_stack (vm, 0);
 704           clib_longjmp (&p->return_longjmp,
 705                         VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
 706         }
 707       else
 708         vlib_process_finish_switch_stack (vm);
 709     }
 710
 711   return vlib_process_get_events_helper (p, with_type_index, data_vector);
 712 }
 713
 714 always_inline uword
 715 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
 716                                        uword ** data_vector,
 717                                        uword with_type_opaque)
 718 {
 719   vlib_node_main_t *nm = &vm->node_main;
 720   vlib_process_t *p;
 721   uword r, *h;
 722
 723   p = vec_elt (nm->processes, nm->current_process_index);
 724   h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
 725   while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
 726     {
 727       p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
 728       r =
 729         clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
 730       if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
 731         {
 732           vlib_process_start_switch_stack (vm, 0);
 733           clib_longjmp (&p->return_longjmp,
 734                         VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
 735         }
 736       else
 737         vlib_process_finish_switch_stack (vm);
 738
 739       /* See if unknown event type has been signaled now. */
 740       if (!h)
 741         h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
 742     }
 743
 744   return vlib_process_get_events_helper (p, h[0], data_vector);
 745 }
 746
 747 /** Suspend a cooperative multi-tasking thread
 748     Waits for an event, or for the indicated number of seconds to elapse
 749     @param vm - vlib_main_t pointer
 750     @param dt - timeout, in seconds.
 751     @returns the remaining time interval
 752 */
 753
 754 always_inline f64
 755 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
 756 {
 757   vlib_node_main_t *nm = &vm->node_main;
 758   vlib_process_t *p;
 759   f64 wakeup_time;
 760   uword r;
 761
 762   p = vec_elt (nm->processes, nm->current_process_index);
 763
 764   if (vlib_process_suspend_time_is_zero (dt)
 765       || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
 766     return dt;
 767
 768   wakeup_time = vlib_time_now (vm) + dt;
 769
 770   /* Suspend waiting for both clock and event to occur. */
 771   p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
 772                | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
 773
 774   r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
 775   if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
 776     {
 777       p->resume_clock_interval = dt * 1e5;
 778       vlib_process_start_switch_stack (vm, 0);
 779       clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
 780     }
 781   else
 782     vlib_process_finish_switch_stack (vm);
 783
 784   /* Return amount of time still left to sleep.
 785      If <= 0 then we've been waken up by the clock (and not an event). */
 786   return wakeup_time - vlib_time_now (vm);
 787 }
 788
 789 always_inline vlib_process_event_type_t *
 790 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
 791 {
 792   vlib_process_event_type_t *et;
 793   pool_get (p->event_type_pool, et);
 794   et->opaque = with_type_opaque;
 795   return et;
 796 }
 797
 798 always_inline uword
 799 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
 800                                     uword with_type_opaque)
 801 {
 802   vlib_node_main_t *nm = &vm->node_main;
 803   vlib_node_t *n = vlib_get_node (vm, node_index);
 804   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
 805   vlib_process_event_type_t *et;
 806   uword t;
 807
 808   et = vlib_process_new_event_type (p, with_type_opaque);
 809   t = et - p->event_type_pool;
 810   p->one_time_event_type_bitmap =
 811     clib_bitmap_ori (p->one_time_event_type_bitmap, t);
 812   return t;
 813 }
 814
 815 always_inline void
 816 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
 817                                     uword t)
 818 {
 819   vlib_node_main_t *nm = &vm->node_main;
 820   vlib_node_t *n = vlib_get_node (vm, node_index);
 821   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
 822
 823   ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
 824   vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
 825 }
 826
 827 always_inline void *
 828 vlib_process_signal_event_helper (vlib_node_main_t * nm,
 829                                   vlib_node_t * n,
 830                                   vlib_process_t * p,
 831                                   uword t,
 832                                   uword n_data_elts, uword n_data_elt_bytes)
 833 {
 834   uword p_flags, add_to_pending, delete_from_wheel;
 835   void *data_to_be_written_by_caller;
 836
 837   ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
 838
 839   ASSERT (!pool_is_free_index (p->event_type_pool, t));
 840
 841   vec_validate (p->pending_event_data_by_type_index, t);
 842
 843   /* Resize data vector and return caller's data to be written. */
 844   {
 845     void *data_vec = p->pending_event_data_by_type_index[t];
 846     uword l;
 847
 848     if (!data_vec && vec_len (nm->recycled_event_data_vectors))
 849       {
 850         data_vec = vec_pop (nm->recycled_event_data_vectors);
 851         vec_reset_length (data_vec);
 852       }
 853
 854     l = vec_len (data_vec);
 855
 856     data_vec = _vec_resize (data_vec,
 857                             /* length_increment */ n_data_elts,
 858                             /* total size after increment */
 859                             (l + n_data_elts) * n_data_elt_bytes,
 860                             /* header_bytes */ 0, /* data_align */ 0);
 861
 862     p->pending_event_data_by_type_index[t] = data_vec;
 863     data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
 864   }
 865
 866   p->non_empty_event_type_bitmap =
 867     clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
 868
 869   p_flags = p->flags;
 870
 871   /* Event was already signalled? */
 872   add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
 873
 874   /* Process will resume when suspend time elapses? */
 875   delete_from_wheel = 0;
 876   if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
 877     {
 878       /* Waiting for both event and clock? */
 879       if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
 880         {
 881           if (!TW (tw_timer_handle_is_free)
 882               ((TWT (tw_timer_wheel) *) nm->timing_wheel,
 883                p->stop_timer_handle))
 884             delete_from_wheel = 1;
 885           else
 886             /* timer just popped so process should already be on the list */
 887             add_to_pending = 0;
 888         }
 889       else
 890         /* Waiting only for clock.  Event will be queue and may be
 891            handled when timer expires. */
 892         add_to_pending = 0;
 893     }
 894
 895   /* Never add current process to pending vector since current process is
 896      already running. */
 897   add_to_pending &= nm->current_process_index != n->runtime_index;
 898
 899   if (add_to_pending)
 900     {
 901       u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
 902       p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
 903       vec_add1 (nm->data_from_advancing_timing_wheel, x);
 904       if (delete_from_wheel)
 905         TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
 906                             p->stop_timer_handle);
 907     }
 908
 909   return data_to_be_written_by_caller;
 910 }
 911
 912 always_inline void *
 913 vlib_process_signal_event_data (vlib_main_t * vm,
 914                                 uword node_index,
 915                                 uword type_opaque,
 916                                 uword n_data_elts, uword n_data_elt_bytes)
 917 {
 918   vlib_node_main_t *nm = &vm->node_main;
 919   vlib_node_t *n = vlib_get_node (vm, node_index);
 920   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
 921   uword *h, t;
 922
 923   /* Must be in main thread */
 924   ASSERT (vlib_get_thread_index () == 0);
 925
 926   h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
 927   if (!h)
 928     {
 929       vlib_process_event_type_t *et =
 930         vlib_process_new_event_type (p, type_opaque);
 931       t = et - p->event_type_pool;
 932       hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
 933     }
 934   else
 935     t = h[0];
 936
 937   return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
 938                                            n_data_elt_bytes);
 939 }
 940
 941 always_inline void *
 942 vlib_process_signal_event_at_time (vlib_main_t * vm,
 943                                    f64 dt,
 944                                    uword node_index,
 945                                    uword type_opaque,
 946                                    uword n_data_elts, uword n_data_elt_bytes)
 947 {
 948   vlib_node_main_t *nm = &vm->node_main;
 949   vlib_node_t *n = vlib_get_node (vm, node_index);
 950   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
 951   uword *h, t;
 952
 953   h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
 954   if (!h)
 955     {
 956       vlib_process_event_type_t *et =
 957         vlib_process_new_event_type (p, type_opaque);
 958       t = et - p->event_type_pool;
 959       hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
 960     }
 961   else
 962     t = h[0];
 963
 964   if (vlib_process_suspend_time_is_zero (dt))
 965     return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
 966                                              n_data_elt_bytes);
 967   else
 968     {
 969       vlib_signal_timed_event_data_t *te;
 970
 971       pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
 972
 973       te->n_data_elts = n_data_elts;
 974       te->n_data_elt_bytes = n_data_elt_bytes;
 975       te->n_data_bytes = n_data_elts * n_data_elt_bytes;
 976
 977       /* Assert that structure fields are big enough. */
 978       ASSERT (te->n_data_elts == n_data_elts);
 979       ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
 980       ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
 981
 982       te->process_node_index = n->runtime_index;
 983       te->event_type_index = t;
 984
 985       p->stop_timer_handle =
 986         TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
 987                              vlib_timing_wheel_data_set_timed_event
 988                              (te - nm->signal_timed_event_data_pool),
 989                              0 /* timer_id */ ,
 990                              (vlib_time_now (vm) + dt) * 1e5);
 991
 992       /* Inline data big enough to hold event? */
 993       if (te->n_data_bytes < sizeof (te->inline_event_data))
 994         return te->inline_event_data;
 995       else
 996         {
 997           te->event_data_as_vector = 0;
 998           vec_resize (te->event_data_as_vector, te->n_data_bytes);
 999           return te->event_data_as_vector;
1000         }
1001     }
1002 }
1003
1004 always_inline void *
1005 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
1006                                          uword node_index,
1007                                          uword type_index,
1008                                          uword n_data_elts,
1009                                          uword n_data_elt_bytes)
1010 {
1011   vlib_node_main_t *nm = &vm->node_main;
1012   vlib_node_t *n = vlib_get_node (vm, node_index);
1013   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1014   return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
1015                                            n_data_elt_bytes);
1016 }
1017
1018 always_inline void
1019 vlib_process_signal_event (vlib_main_t * vm,
1020                            uword node_index, uword type_opaque, uword data)
1021 {
1022   uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1023                                              1 /* elts */ , sizeof (uword));
1024   d[0] = data;
1025 }
1026
1027 always_inline void
1028 vlib_process_signal_event_pointer (vlib_main_t * vm,
1029                                    uword node_index,
1030                                    uword type_opaque, void *data)
1031 {
1032   void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1033                                              1 /* elts */ , sizeof (data));
1034   d[0] = data;
1035 }
1036
1037 /**
1038  * Signal event to process from any thread.
1039  *
1040  * When in doubt, use this.
1041  */
1042 always_inline void
1043 vlib_process_signal_event_mt (vlib_main_t * vm,
1044                               uword node_index, uword type_opaque, uword data)
1045 {
1046   if (vlib_get_thread_index () != 0)
1047     {
1048       vlib_process_signal_event_mt_args_t args = {
1049         .node_index = node_index,
1050         .type_opaque = type_opaque,
1051         .data = data,
1052       };
1053       vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
1054                                  (u8 *) & args, sizeof (args));
1055     }
1056   else
1057     vlib_process_signal_event (vm, node_index, type_opaque, data);
1058 }
1059
1060 always_inline void
1061 vlib_process_signal_one_time_event (vlib_main_t * vm,
1062                                     uword node_index,
1063                                     uword type_index, uword data)
1064 {
1065   uword *d =
1066     vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1067                                              1 /* elts */ , sizeof (uword));
1068   d[0] = data;
1069 }
1070
1071 always_inline void
1072 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1073                                       vlib_one_time_waiting_process_t * p)
1074 {
1075   vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1076                                       /* data */ ~0);
1077   clib_memset (p, ~0, sizeof (p[0]));
1078 }
1079
1080 always_inline void
1081 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1082                                              vlib_one_time_waiting_process_t
1083                                              ** wps)
1084 {
1085   vlib_one_time_waiting_process_t *wp;
1086   vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1087   vec_free (*wps);
1088 }
1089
1090 always_inline void
1091 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1092                                               vlib_one_time_waiting_process_t
1093                                               * p)
1094 {
1095   p->node_index = vlib_current_process (vm);
1096   p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index,    /* type opaque */
1097                                                           ~0);
1098   vlib_process_wait_for_one_time_event (vm,
1099                                         /* don't care about data */ 0,
1100                                         p->one_time_event);
1101 }
1102
1103 always_inline void
1104 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1105                                                      vlib_one_time_waiting_process_t
1106                                                      ** wps)
1107 {
1108   vlib_one_time_waiting_process_t *wp;
1109   vec_add2 (*wps, wp, 1);
1110   vlib_current_process_wait_for_one_time_event (vm, wp);
1111 }
1112
1113 always_inline u32
1114 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1115                                                  vlib_node_runtime_t * node,
1116                                                  uword n_vectors)
1117 {
1118   u32 i, d, vi0, vi1;
1119   u32 i0, i1;
1120
1121   ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1122   i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1123        & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1124   i0 = i ^ 0;
1125   i1 = i ^ 1;
1126   d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1127        -
1128        (node->main_loop_count_last_dispatch >>
1129         VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1130   vi0 = node->main_loop_vector_stats[i0];
1131   vi1 = node->main_loop_vector_stats[i1];
1132   vi0 = d == 0 ? vi0 : 0;
1133   vi1 = d <= 1 ? vi1 : 0;
1134   vi0 += n_vectors;
1135   node->main_loop_vector_stats[i0] = vi0;
1136   node->main_loop_vector_stats[i1] = vi1;
1137   node->main_loop_count_last_dispatch = vm->main_loop_count;
1138   /* Return previous counter. */
1139   return node->main_loop_vector_stats[i1];
1140 }
1141
1142 always_inline f64
1143 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1144 {
1145   vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1146   u32 v;
1147
1148   v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt,  /* n_vectors */
1149                                                        0);
1150   return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1151 }
1152
1153 always_inline u32
1154 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1155 {
1156   vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1157   u32 v;
1158
1159   v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt,  /* n_vectors */
1160                                                        0);
1161   return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1162 }
1163
1164 void
1165 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1166
1167 /* Return the edge index if present, ~0 otherwise */
1168 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1169
1170 /* Add next node to given node in given slot. */
1171 uword
1172 vlib_node_add_next_with_slot (vlib_main_t * vm,
1173                               uword node, uword next_node, uword slot);
1174
1175 /* As above but adds to end of node's next vector. */
1176 always_inline uword
1177 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1178 {
1179   return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1180 }
1181
1182 /* Add next node to given node in given slot. */
1183 uword
1184 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1185                                     uword node, char *next_name, uword slot);
1186
1187 /* As above but adds to end of node's next vector. */
1188 always_inline uword
1189 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1190 {
1191   return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1192 }
1193
1194 /**
1195  * Get list of nodes
1196  */
1197 void
1198 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1199                      int barrier_sync, vlib_node_t **** node_dupsp,
1200                      vlib_main_t *** stat_vmsp);
1201
1202 /* Query node given name. */
1203 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1204
1205 /* Rename a node. */
1206 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1207
1208 /* Register new packet processing node.  Nodes can be registered
1209    dynamically via this call or statically via the VLIB_REGISTER_NODE
1210    macro. */
1211 u32 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r);
1212
1213 /* Register all node function variants */
1214 void vlib_register_all_node_march_variants (vlib_main_t *vm);
1215
1216 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1217 void vlib_register_all_static_nodes (vlib_main_t * vm);
1218
1219 /* Start a process. */
1220 void vlib_start_process (vlib_main_t * vm, uword process_index);
1221
1222 /* Sync up runtime and main node stats. */
1223 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1224 void vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
1225                                    uword n_calls, uword n_vectors,
1226                                    uword n_clocks);
1227 void vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
1228                                         uword n_calls, uword n_vectors,
1229                                         uword n_clocks);
1230
1231 /* Node graph initialization function. */
1232 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1233
1234 format_function_t format_vlib_node_graph;
1235 format_function_t format_vlib_node_name;
1236 format_function_t format_vlib_next_node_name;
1237 format_function_t format_vlib_node_and_next;
1238 format_function_t format_vlib_cpu_time;
1239 format_function_t format_vlib_time;
1240 /* Parse node name -> node index. */
1241 unformat_function_t unformat_vlib_node;
1242
1243 always_inline void
1244 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1245                              u32 counter_index, u64 increment)
1246 {
1247   vlib_node_t *n = vlib_get_node (vm, node_index);
1248   vlib_error_main_t *em = &vm->error_main;
1249   u32 node_counter_base_index = n->error_heap_index;
1250   em->counters[node_counter_base_index + counter_index] += increment;
1251 }
1252
1253 /** @brief Create a vlib process
1254  *  @param vm &vlib_global_main
1255  *  @param f the process node function
1256  *  @param log2_n_stack_bytes size of the process stack, defaults to 16K
1257  *  @return newly-create node index
1258  *  @warning call only on the main thread. Barrier sync required
1259  */
1260 u32 vlib_process_create (vlib_main_t * vm, char *name,
1261                          vlib_node_function_t * f, u32 log2_n_stack_bytes);
1262
1263 always_inline int
1264 vlib_node_set_dispatch_wrapper (vlib_main_t *vm, vlib_node_function_t *fn)
1265 {
1266   if (fn && vm->dispatch_wrapper_fn)
1267     return 1;
1268   vm->dispatch_wrapper_fn = fn;
1269   return 0;
1270 }
1271
1272 int vlib_node_set_march_variant (vlib_main_t *vm, u32 node_index,
1273                                  clib_march_variant_type_t march_variant);
1274
1275 vlib_node_function_t *
1276 vlib_node_get_preferred_node_fn_variant (vlib_main_t *vm,
1277                                          vlib_node_fn_registration_t *regs);
1278
1279 #endif /* included_vlib_node_funcs_h */
1280
1281 /*
1282  * fd.io coding-style-patch-verification: ON
1283  *
1284  * Local Variables:
1285  * eval: (c-set-style "gnu")
1286  * End:
1287  */