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