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