src/vlib/node_funcs.h

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