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