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