src/vlib/node_funcs.h

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