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