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