src/vlib/main.c

   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  * main.c: main vector processing loop
  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 #include <math.h>
  41 #include <vppinfra/format.h>
  42 #include <vlib/vlib.h>
  43 #include <vlib/threads.h>
  44 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
  45
  46 #include <vlib/unix/cj.h>
  47
  48 CJ_GLOBAL_LOG_PROTOTYPE;
  49
  50 /* Actually allocate a few extra slots of vector data to support
  51    speculative vector enqueues which overflow vector data in next frame. */
  52 #define VLIB_FRAME_SIZE_ALLOC (VLIB_FRAME_SIZE + 4)
  53
  54 u32 wraps;
  55
  56 always_inline u32
  57 vlib_frame_bytes (u32 n_scalar_bytes, u32 n_vector_bytes)
  58 {
  59   u32 n_bytes;
  60
  61   /* Make room for vlib_frame_t plus scalar arguments. */
  62   n_bytes = vlib_frame_vector_byte_offset (n_scalar_bytes);
  63
  64   /* Make room for vector arguments.
  65      Allocate a few extra slots of vector data to support
  66      speculative vector enqueues which overflow vector data in next frame. */
  67 #define VLIB_FRAME_SIZE_EXTRA 4
  68   n_bytes += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * n_vector_bytes;
  69
  70   /* Magic number is first 32bit number after vector data.
  71      Used to make sure that vector data is never overrun. */
  72 #define VLIB_FRAME_MAGIC (0xabadc0ed)
  73   n_bytes += sizeof (u32);
  74
  75   /* Pad to cache line. */
  76   n_bytes = round_pow2 (n_bytes, CLIB_CACHE_LINE_BYTES);
  77
  78   return n_bytes;
  79 }
  80
  81 always_inline u32 *
  82 vlib_frame_find_magic (vlib_frame_t * f, vlib_node_t * node)
  83 {
  84   void *p = f;
  85
  86   p += vlib_frame_vector_byte_offset (node->scalar_size);
  87
  88   p += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * node->vector_size;
  89
  90   return p;
  91 }
  92
  93 static vlib_frame_size_t *
  94 get_frame_size_info (vlib_node_main_t * nm,
  95                      u32 n_scalar_bytes, u32 n_vector_bytes)
  96 {
  97   uword key = (n_scalar_bytes << 16) | n_vector_bytes;
  98   uword *p, i;
  99
 100   p = hash_get (nm->frame_size_hash, key);
 101   if (p)
 102     i = p[0];
 103   else
 104     {
 105       i = vec_len (nm->frame_sizes);
 106       vec_validate (nm->frame_sizes, i);
 107       hash_set (nm->frame_size_hash, key, i);
 108     }
 109
 110   return vec_elt_at_index (nm->frame_sizes, i);
 111 }
 112
 113 static u32
 114 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
 115                           u32 frame_flags)
 116 {
 117   vlib_node_main_t *nm = &vm->node_main;
 118   vlib_frame_size_t *fs;
 119   vlib_node_t *to_node;
 120   vlib_frame_t *f;
 121   u32 fi, l, n, scalar_size, vector_size;
 122
 123   to_node = vlib_get_node (vm, to_node_index);
 124
 125   scalar_size = to_node->scalar_size;
 126   vector_size = to_node->vector_size;
 127
 128   fs = get_frame_size_info (nm, scalar_size, vector_size);
 129   n = vlib_frame_bytes (scalar_size, vector_size);
 130   if ((l = vec_len (fs->free_frame_indices)) > 0)
 131     {
 132       /* Allocate from end of free list. */
 133       fi = fs->free_frame_indices[l - 1];
 134       f = vlib_get_frame_no_check (vm, fi);
 135       _vec_len (fs->free_frame_indices) = l - 1;
 136     }
 137   else
 138     {
 139       f = clib_mem_alloc_aligned_no_fail (n, VLIB_FRAME_ALIGN);
 140       f->thread_index = vm->thread_index;
 141       fi = vlib_frame_index_no_check (vm, f);
 142     }
 143
 144   /* Poison frame when debugging. */
 145   if (CLIB_DEBUG > 0)
 146     {
 147       u32 save_thread_index = f->thread_index;
 148
 149       memset (f, 0xfe, n);
 150
 151       f->thread_index = save_thread_index;
 152     }
 153
 154   /* Insert magic number. */
 155   {
 156     u32 *magic;
 157
 158     magic = vlib_frame_find_magic (f, to_node);
 159     *magic = VLIB_FRAME_MAGIC;
 160   }
 161
 162   f->flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
 163   f->n_vectors = 0;
 164   f->scalar_size = scalar_size;
 165   f->vector_size = vector_size;
 166
 167   fs->n_alloc_frames += 1;
 168
 169   return fi;
 170 }
 171
 172 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
 173    Returns frame index. */
 174 static u32
 175 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
 176                   u32 to_next_index)
 177 {
 178   vlib_node_t *from_node;
 179
 180   from_node = vlib_get_node (vm, from_node_runtime->node_index);
 181   ASSERT (to_next_index < vec_len (from_node->next_nodes));
 182
 183   return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
 184                                    /* frame_flags */ 0);
 185 }
 186
 187 vlib_frame_t *
 188 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
 189 {
 190   u32 fi = vlib_frame_alloc_to_node (vm, to_node_index,
 191                                      /* frame_flags */
 192                                      VLIB_FRAME_FREE_AFTER_DISPATCH);
 193   return vlib_get_frame (vm, fi);
 194 }
 195
 196 void
 197 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
 198 {
 199   vlib_pending_frame_t *p;
 200   vlib_node_t *to_node;
 201
 202   if (f->n_vectors == 0)
 203     return;
 204
 205   to_node = vlib_get_node (vm, to_node_index);
 206
 207   vec_add2 (vm->node_main.pending_frames, p, 1);
 208
 209   f->flags |= VLIB_FRAME_PENDING;
 210   p->frame_index = vlib_frame_index (vm, f);
 211   p->node_runtime_index = to_node->runtime_index;
 212   p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
 213 }
 214
 215 /* Free given frame. */
 216 void
 217 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
 218 {
 219   vlib_node_main_t *nm = &vm->node_main;
 220   vlib_node_t *node;
 221   vlib_frame_size_t *fs;
 222   u32 frame_index;
 223
 224   ASSERT (f->flags & VLIB_FRAME_IS_ALLOCATED);
 225
 226   node = vlib_get_node (vm, r->node_index);
 227   fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
 228
 229   frame_index = vlib_frame_index (vm, f);
 230
 231   ASSERT (f->flags & VLIB_FRAME_IS_ALLOCATED);
 232
 233   /* No next frames may point to freed frame. */
 234   if (CLIB_DEBUG > 0)
 235     {
 236       vlib_next_frame_t *nf;
 237       vec_foreach (nf, vm->node_main.next_frames)
 238         ASSERT (nf->frame_index != frame_index);
 239     }
 240
 241   f->flags &= ~VLIB_FRAME_IS_ALLOCATED;
 242
 243   vec_add1 (fs->free_frame_indices, frame_index);
 244   ASSERT (fs->n_alloc_frames > 0);
 245   fs->n_alloc_frames -= 1;
 246 }
 247
 248 static clib_error_t *
 249 show_frame_stats (vlib_main_t * vm,
 250                   unformat_input_t * input, vlib_cli_command_t * cmd)
 251 {
 252   vlib_node_main_t *nm = &vm->node_main;
 253   vlib_frame_size_t *fs;
 254
 255   vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
 256   vec_foreach (fs, nm->frame_sizes)
 257   {
 258     u32 n_alloc = fs->n_alloc_frames;
 259     u32 n_free = vec_len (fs->free_frame_indices);
 260
 261     if (n_alloc + n_free > 0)
 262       vlib_cli_output (vm, "%=6d%=12d%=12d",
 263                        fs - nm->frame_sizes, n_alloc, n_free);
 264   }
 265
 266   return 0;
 267 }
 268
 269 /* *INDENT-OFF* */
 270 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
 271   .path = "show vlib frame-allocation",
 272   .short_help = "Show node dispatch frame statistics",
 273   .function = show_frame_stats,
 274 };
 275 /* *INDENT-ON* */
 276
 277 /* Change ownership of enqueue rights to given next node. */
 278 static void
 279 vlib_next_frame_change_ownership (vlib_main_t * vm,
 280                                   vlib_node_runtime_t * node_runtime,
 281                                   u32 next_index)
 282 {
 283   vlib_node_main_t *nm = &vm->node_main;
 284   vlib_next_frame_t *next_frame;
 285   vlib_node_t *node, *next_node;
 286
 287   node = vec_elt (nm->nodes, node_runtime->node_index);
 288
 289   /* Only internal & input nodes are allowed to call other nodes. */
 290   ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
 291           || node->type == VLIB_NODE_TYPE_INPUT
 292           || node->type == VLIB_NODE_TYPE_PROCESS);
 293
 294   ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
 295
 296   next_frame =
 297     vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
 298   next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
 299
 300   if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
 301     {
 302       /* Get frame from previous owner. */
 303       vlib_next_frame_t *owner_next_frame;
 304       vlib_next_frame_t tmp;
 305
 306       owner_next_frame =
 307         vlib_node_get_next_frame (vm,
 308                                   next_node->owner_node_index,
 309                                   next_node->owner_next_index);
 310
 311       /* Swap target next frame with owner's. */
 312       tmp = owner_next_frame[0];
 313       owner_next_frame[0] = next_frame[0];
 314       next_frame[0] = tmp;
 315
 316       /*
 317        * If next_frame is already pending, we have to track down
 318        * all pending frames and fix their next_frame_index fields.
 319        */
 320       if (next_frame->flags & VLIB_FRAME_PENDING)
 321         {
 322           vlib_pending_frame_t *p;
 323           if (next_frame->frame_index != ~0)
 324             {
 325               vec_foreach (p, nm->pending_frames)
 326               {
 327                 if (p->frame_index == next_frame->frame_index)
 328                   {
 329                     p->next_frame_index =
 330                       next_frame - vm->node_main.next_frames;
 331                   }
 332               }
 333             }
 334         }
 335     }
 336   else
 337     {
 338       /* No previous owner. Take ownership. */
 339       next_frame->flags |= VLIB_FRAME_OWNER;
 340     }
 341
 342   /* Record new owner. */
 343   next_node->owner_node_index = node->index;
 344   next_node->owner_next_index = next_index;
 345
 346   /* Now we should be owner. */
 347   ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
 348 }
 349
 350 /* Make sure that magic number is still there.
 351    Otherwise, it is likely that caller has overrun frame arguments. */
 352 always_inline void
 353 validate_frame_magic (vlib_main_t * vm,
 354                       vlib_frame_t * f, vlib_node_t * n, uword next_index)
 355 {
 356   vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
 357   u32 *magic = vlib_frame_find_magic (f, next_node);
 358   ASSERT (VLIB_FRAME_MAGIC == magic[0]);
 359 }
 360
 361 vlib_frame_t *
 362 vlib_get_next_frame_internal (vlib_main_t * vm,
 363                               vlib_node_runtime_t * node,
 364                               u32 next_index, u32 allocate_new_next_frame)
 365 {
 366   vlib_frame_t *f;
 367   vlib_next_frame_t *nf;
 368   u32 n_used;
 369
 370   nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
 371
 372   /* Make sure this next frame owns right to enqueue to destination frame. */
 373   if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
 374     vlib_next_frame_change_ownership (vm, node, next_index);
 375
 376   /* ??? Don't need valid flag: can use frame_index == ~0 */
 377   if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
 378     {
 379       nf->frame_index = vlib_frame_alloc (vm, node, next_index);
 380       nf->flags |= VLIB_FRAME_IS_ALLOCATED;
 381     }
 382
 383   f = vlib_get_frame (vm, nf->frame_index);
 384
 385   /* Has frame been removed from pending vector (e.g. finished dispatching)?
 386      If so we can reuse frame. */
 387   if ((nf->flags & VLIB_FRAME_PENDING) && !(f->flags & VLIB_FRAME_PENDING))
 388     {
 389       nf->flags &= ~VLIB_FRAME_PENDING;
 390       f->n_vectors = 0;
 391     }
 392
 393   /* Allocate new frame if current one is already full. */
 394   n_used = f->n_vectors;
 395   if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0))
 396     {
 397       /* Old frame may need to be freed after dispatch, since we'll have
 398          two redundant frames from node -> next node. */
 399       if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
 400         {
 401           vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame_index);
 402           f_old->flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
 403         }
 404
 405       /* Allocate new frame to replace full one. */
 406       nf->frame_index = vlib_frame_alloc (vm, node, next_index);
 407       f = vlib_get_frame (vm, nf->frame_index);
 408       n_used = f->n_vectors;
 409     }
 410
 411   /* Should have free vectors in frame now. */
 412   ASSERT (n_used < VLIB_FRAME_SIZE);
 413
 414   if (CLIB_DEBUG > 0)
 415     {
 416       validate_frame_magic (vm, f,
 417                             vlib_get_node (vm, node->node_index), next_index);
 418     }
 419
 420   return f;
 421 }
 422
 423 static void
 424 vlib_put_next_frame_validate (vlib_main_t * vm,
 425                               vlib_node_runtime_t * rt,
 426                               u32 next_index, u32 n_vectors_left)
 427 {
 428   vlib_node_main_t *nm = &vm->node_main;
 429   vlib_next_frame_t *nf;
 430   vlib_frame_t *f;
 431   vlib_node_runtime_t *next_rt;
 432   vlib_node_t *next_node;
 433   u32 n_before, n_after;
 434
 435   nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
 436   f = vlib_get_frame (vm, nf->frame_index);
 437
 438   ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
 439   n_after = VLIB_FRAME_SIZE - n_vectors_left;
 440   n_before = f->n_vectors;
 441
 442   ASSERT (n_after >= n_before);
 443
 444   next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
 445                               nf->node_runtime_index);
 446   next_node = vlib_get_node (vm, next_rt->node_index);
 447   if (n_after > 0 && next_node->validate_frame)
 448     {
 449       u8 *msg = next_node->validate_frame (vm, rt, f);
 450       if (msg)
 451         {
 452           clib_warning ("%v", msg);
 453           ASSERT (0);
 454         }
 455       vec_free (msg);
 456     }
 457 }
 458
 459 void
 460 vlib_put_next_frame (vlib_main_t * vm,
 461                      vlib_node_runtime_t * r,
 462                      u32 next_index, u32 n_vectors_left)
 463 {
 464   vlib_node_main_t *nm = &vm->node_main;
 465   vlib_next_frame_t *nf;
 466   vlib_frame_t *f;
 467   u32 n_vectors_in_frame;
 468
 469   if (vm->buffer_main->extern_buffer_mgmt == 0 && CLIB_DEBUG > 0)
 470     vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
 471
 472   nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
 473   f = vlib_get_frame (vm, nf->frame_index);
 474
 475   /* Make sure that magic number is still there.  Otherwise, caller
 476      has overrun frame meta data. */
 477   if (CLIB_DEBUG > 0)
 478     {
 479       vlib_node_t *node = vlib_get_node (vm, r->node_index);
 480       validate_frame_magic (vm, f, node, next_index);
 481     }
 482
 483   /* Convert # of vectors left -> number of vectors there. */
 484   ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
 485   n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
 486
 487   f->n_vectors = n_vectors_in_frame;
 488
 489   /* If vectors were added to frame, add to pending vector. */
 490   if (PREDICT_TRUE (n_vectors_in_frame > 0))
 491     {
 492       vlib_pending_frame_t *p;
 493       u32 v0, v1;
 494
 495       r->cached_next_index = next_index;
 496
 497       if (!(f->flags & VLIB_FRAME_PENDING))
 498         {
 499           __attribute__ ((unused)) vlib_node_t *node;
 500           vlib_node_t *next_node;
 501           vlib_node_runtime_t *next_runtime;
 502
 503           node = vlib_get_node (vm, r->node_index);
 504           next_node = vlib_get_next_node (vm, r->node_index, next_index);
 505           next_runtime = vlib_node_get_runtime (vm, next_node->index);
 506
 507           vec_add2 (nm->pending_frames, p, 1);
 508
 509           p->frame_index = nf->frame_index;
 510           p->node_runtime_index = nf->node_runtime_index;
 511           p->next_frame_index = nf - nm->next_frames;
 512           nf->flags |= VLIB_FRAME_PENDING;
 513           f->flags |= VLIB_FRAME_PENDING;
 514
 515           /*
 516            * If we're going to dispatch this frame on another thread,
 517            * force allocation of a new frame. Otherwise, we create
 518            * a dangling frame reference. Each thread has its own copy of
 519            * the next_frames vector.
 520            */
 521           if (0 && r->thread_index != next_runtime->thread_index)
 522             {
 523               nf->frame_index = ~0;
 524               nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
 525             }
 526         }
 527
 528       /* Copy trace flag from next_frame and from runtime. */
 529       nf->flags |=
 530         (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
 531                                               flags & VLIB_NODE_FLAG_TRACE);
 532
 533       v0 = nf->vectors_since_last_overflow;
 534       v1 = v0 + n_vectors_in_frame;
 535       nf->vectors_since_last_overflow = v1;
 536       if (PREDICT_FALSE (v1 < v0))
 537         {
 538           vlib_node_t *node = vlib_get_node (vm, r->node_index);
 539           vec_elt (node->n_vectors_by_next_node, next_index) += v0;
 540         }
 541     }
 542 }
 543
 544 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
 545 never_inline void
 546 vlib_node_runtime_sync_stats (vlib_main_t * vm,
 547                               vlib_node_runtime_t * r,
 548                               uword n_calls, uword n_vectors, uword n_clocks)
 549 {
 550   vlib_node_t *n = vlib_get_node (vm, r->node_index);
 551
 552   n->stats_total.calls += n_calls + r->calls_since_last_overflow;
 553   n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
 554   n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
 555   n->stats_total.max_clock = r->max_clock;
 556   n->stats_total.max_clock_n = r->max_clock_n;
 557
 558   r->calls_since_last_overflow = 0;
 559   r->vectors_since_last_overflow = 0;
 560   r->clocks_since_last_overflow = 0;
 561 }
 562
 563 always_inline void __attribute__ ((unused))
 564 vlib_process_sync_stats (vlib_main_t * vm,
 565                          vlib_process_t * p,
 566                          uword n_calls, uword n_vectors, uword n_clocks)
 567 {
 568   vlib_node_runtime_t *rt = &p->node_runtime;
 569   vlib_node_t *n = vlib_get_node (vm, rt->node_index);
 570   vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks);
 571   n->stats_total.suspends += p->n_suspends;
 572   p->n_suspends = 0;
 573 }
 574
 575 void
 576 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
 577 {
 578   vlib_node_runtime_t *rt;
 579
 580   if (n->type == VLIB_NODE_TYPE_PROCESS)
 581     {
 582       /* Nothing to do for PROCESS nodes except in main thread */
 583       if (vm != &vlib_global_main)
 584         return;
 585
 586       vlib_process_t *p = vlib_get_process_from_node (vm, n);
 587       n->stats_total.suspends += p->n_suspends;
 588       p->n_suspends = 0;
 589       rt = &p->node_runtime;
 590     }
 591   else
 592     rt =
 593       vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
 594                         n->runtime_index);
 595
 596   vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0);
 597
 598   /* Sync up runtime next frame vector counters with main node structure. */
 599   {
 600     vlib_next_frame_t *nf;
 601     uword i;
 602     for (i = 0; i < rt->n_next_nodes; i++)
 603       {
 604         nf = vlib_node_runtime_get_next_frame (vm, rt, i);
 605         vec_elt (n->n_vectors_by_next_node, i) +=
 606           nf->vectors_since_last_overflow;
 607         nf->vectors_since_last_overflow = 0;
 608       }
 609   }
 610 }
 611
 612 always_inline u32
 613 vlib_node_runtime_update_stats (vlib_main_t * vm,
 614                                 vlib_node_runtime_t * node,
 615                                 uword n_calls,
 616                                 uword n_vectors, uword n_clocks)
 617 {
 618   u32 ca0, ca1, v0, v1, cl0, cl1, r;
 619
 620   cl0 = cl1 = node->clocks_since_last_overflow;
 621   ca0 = ca1 = node->calls_since_last_overflow;
 622   v0 = v1 = node->vectors_since_last_overflow;
 623
 624   ca1 = ca0 + n_calls;
 625   v1 = v0 + n_vectors;
 626   cl1 = cl0 + n_clocks;
 627
 628   node->calls_since_last_overflow = ca1;
 629   node->clocks_since_last_overflow = cl1;
 630   node->vectors_since_last_overflow = v1;
 631   node->max_clock_n = node->max_clock > n_clocks ?
 632     node->max_clock_n : n_vectors;
 633   node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
 634
 635   r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
 636
 637   if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0))
 638     {
 639       node->calls_since_last_overflow = ca0;
 640       node->clocks_since_last_overflow = cl0;
 641       node->vectors_since_last_overflow = v0;
 642       vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks);
 643     }
 644
 645   return r;
 646 }
 647
 648 always_inline void
 649 vlib_process_update_stats (vlib_main_t * vm,
 650                            vlib_process_t * p,
 651                            uword n_calls, uword n_vectors, uword n_clocks)
 652 {
 653   vlib_node_runtime_update_stats (vm, &p->node_runtime,
 654                                   n_calls, n_vectors, n_clocks);
 655 }
 656
 657 static clib_error_t *
 658 vlib_cli_elog_clear (vlib_main_t * vm,
 659                      unformat_input_t * input, vlib_cli_command_t * cmd)
 660 {
 661   elog_reset_buffer (&vm->elog_main);
 662   return 0;
 663 }
 664
 665 /* *INDENT-OFF* */
 666 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
 667   .path = "event-logger clear",
 668   .short_help = "Clear the event log",
 669   .function = vlib_cli_elog_clear,
 670 };
 671 /* *INDENT-ON* */
 672
 673 #ifdef CLIB_UNIX
 674 static clib_error_t *
 675 elog_save_buffer (vlib_main_t * vm,
 676                   unformat_input_t * input, vlib_cli_command_t * cmd)
 677 {
 678   elog_main_t *em = &vm->elog_main;
 679   char *file, *chroot_file;
 680   clib_error_t *error = 0;
 681
 682   if (!unformat (input, "%s", &file))
 683     {
 684       vlib_cli_output (vm, "expected file name, got `%U'",
 685                        format_unformat_error, input);
 686       return 0;
 687     }
 688
 689   /* It's fairly hard to get "../oopsie" through unformat; just in case */
 690   if (strstr (file, "..") || index (file, '/'))
 691     {
 692       vlib_cli_output (vm, "illegal characters in filename '%s'", file);
 693       return 0;
 694     }
 695
 696   chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
 697
 698   vec_free (file);
 699
 700   vlib_cli_output (vm, "Saving %wd of %wd events to %s",
 701                    elog_n_events_in_buffer (em),
 702                    elog_buffer_capacity (em), chroot_file);
 703
 704   vlib_worker_thread_barrier_sync (vm);
 705   error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
 706   vlib_worker_thread_barrier_release (vm);
 707   vec_free (chroot_file);
 708   return error;
 709 }
 710
 711 void
 712 elog_post_mortem_dump (void)
 713 {
 714   vlib_main_t *vm = &vlib_global_main;
 715   elog_main_t *em = &vm->elog_main;
 716   u8 *filename;
 717   clib_error_t *error;
 718
 719   if (!vm->elog_post_mortem_dump)
 720     return;
 721
 722   filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
 723   error = elog_write_file (em, (char *) filename, 1 /* flush ring */ );
 724   if (error)
 725     clib_error_report (error);
 726   vec_free (filename);
 727 }
 728
 729 /* *INDENT-OFF* */
 730 VLIB_CLI_COMMAND (elog_save_cli, static) = {
 731   .path = "event-logger save",
 732   .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
 733   .function = elog_save_buffer,
 734 };
 735 /* *INDENT-ON* */
 736
 737 static clib_error_t *
 738 elog_stop (vlib_main_t * vm,
 739            unformat_input_t * input, vlib_cli_command_t * cmd)
 740 {
 741   elog_main_t *em = &vm->elog_main;
 742
 743   em->n_total_events_disable_limit = em->n_total_events;
 744
 745   vlib_cli_output (vm, "Stopped the event logger...");
 746   return 0;
 747 }
 748
 749 /* *INDENT-OFF* */
 750 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
 751   .path = "event-logger stop",
 752   .short_help = "Stop the event-logger",
 753   .function = elog_stop,
 754 };
 755 /* *INDENT-ON* */
 756
 757 static clib_error_t *
 758 elog_restart (vlib_main_t * vm,
 759               unformat_input_t * input, vlib_cli_command_t * cmd)
 760 {
 761   elog_main_t *em = &vm->elog_main;
 762
 763   em->n_total_events_disable_limit = ~0;
 764
 765   vlib_cli_output (vm, "Restarted the event logger...");
 766   return 0;
 767 }
 768
 769 /* *INDENT-OFF* */
 770 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
 771   .path = "event-logger restart",
 772   .short_help = "Restart the event-logger",
 773   .function = elog_restart,
 774 };
 775 /* *INDENT-ON* */
 776
 777 static clib_error_t *
 778 elog_resize (vlib_main_t * vm,
 779              unformat_input_t * input, vlib_cli_command_t * cmd)
 780 {
 781   elog_main_t *em = &vm->elog_main;
 782   u32 tmp;
 783
 784   /* Stop the parade */
 785   elog_reset_buffer (&vm->elog_main);
 786
 787   if (unformat (input, "%d", &tmp))
 788     {
 789       elog_alloc (em, tmp);
 790       em->n_total_events_disable_limit = ~0;
 791     }
 792   else
 793     return clib_error_return (0, "Must specify how many events in the ring");
 794
 795   vlib_cli_output (vm, "Resized ring and restarted the event logger...");
 796   return 0;
 797 }
 798
 799 /* *INDENT-OFF* */
 800 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
 801   .path = "event-logger resize",
 802   .short_help = "event-logger resize <nnn>",
 803   .function = elog_resize,
 804 };
 805 /* *INDENT-ON* */
 806
 807 #endif /* CLIB_UNIX */
 808
 809 static void
 810 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
 811 {
 812   elog_main_t *em = &vm->elog_main;
 813   elog_event_t *e, *es;
 814   f64 dt;
 815
 816   /* Show events in VLIB time since log clock starts after VLIB clock. */
 817   dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
 818     * vm->clib_time.seconds_per_clock;
 819
 820   es = elog_peek_events (em);
 821   vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
 822                    em->event_ring_size,
 823                    em->n_total_events < em->n_total_events_disable_limit ?
 824                    "running" : "stopped");
 825   vec_foreach (e, es)
 826   {
 827     vlib_cli_output (vm, "%18.9f: %U",
 828                      e->time + dt, format_elog_event, em, e);
 829     n_events_to_show--;
 830     if (n_events_to_show == 0)
 831       break;
 832   }
 833   vec_free (es);
 834
 835 }
 836
 837 static clib_error_t *
 838 elog_show_buffer (vlib_main_t * vm,
 839                   unformat_input_t * input, vlib_cli_command_t * cmd)
 840 {
 841   u32 n_events_to_show;
 842   clib_error_t *error = 0;
 843
 844   n_events_to_show = 250;
 845   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 846     {
 847       if (unformat (input, "%d", &n_events_to_show))
 848         ;
 849       else if (unformat (input, "all"))
 850         n_events_to_show = ~0;
 851       else
 852         return unformat_parse_error (input);
 853     }
 854   elog_show_buffer_internal (vm, n_events_to_show);
 855   return error;
 856 }
 857
 858 /* *INDENT-OFF* */
 859 VLIB_CLI_COMMAND (elog_show_cli, static) = {
 860   .path = "show event-logger",
 861   .short_help = "Show event logger info",
 862   .function = elog_show_buffer,
 863 };
 864 /* *INDENT-ON* */
 865
 866 void
 867 vlib_gdb_show_event_log (void)
 868 {
 869   elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
 870 }
 871
 872 static inline void
 873 vlib_elog_main_loop_event (vlib_main_t * vm,
 874                            u32 node_index,
 875                            u64 time, u32 n_vectors, u32 is_return)
 876 {
 877   vlib_main_t *evm = &vlib_global_main;
 878   elog_main_t *em = &evm->elog_main;
 879
 880   if (VLIB_ELOG_MAIN_LOOP && n_vectors)
 881     elog_track (em,
 882                 /* event type */
 883                 vec_elt_at_index (is_return
 884                                   ? evm->node_return_elog_event_types
 885                                   : evm->node_call_elog_event_types,
 886                                   node_index),
 887                 /* track */
 888                 (vm->thread_index ? &vlib_worker_threads[vm->thread_index].
 889                  elog_track : &em->default_track),
 890                 /* data to log */ n_vectors);
 891 }
 892
 893 void
 894 vlib_dump_context_trace (vlib_main_t * vm, u32 bi)
 895 {
 896   vlib_node_main_t *vnm = &vm->node_main;
 897   vlib_buffer_t *b;
 898   u8 i, n;
 899
 900   if (VLIB_BUFFER_TRACE_TRAJECTORY)
 901     {
 902       b = vlib_get_buffer (vm, bi);
 903       n = b->pre_data[0];
 904
 905       fformat (stderr, "Context trace for bi %d b 0x%llx, visited %d\n",
 906                bi, b, n);
 907
 908       if (n == 0 || n > 20)
 909         {
 910           fformat (stderr, "n is unreasonable\n");
 911           return;
 912         }
 913
 914
 915       for (i = 0; i < n; i++)
 916         {
 917           u32 node_index;
 918
 919           node_index = b->pre_data[i + 1];
 920
 921           if (node_index > vec_len (vnm->nodes))
 922             {
 923               fformat (stderr, "Skip bogus node index %d\n", node_index);
 924               continue;
 925             }
 926
 927           fformat (stderr, "%v (%d)\n", vnm->nodes[node_index]->name,
 928                    node_index);
 929         }
 930     }
 931   else
 932     {
 933       fformat (stderr,
 934                "in vlib/buffers.h, #define VLIB_BUFFER_TRACE_TRAJECTORY 1\n");
 935     }
 936 }
 937
 938
 939 static_always_inline u64
 940 dispatch_node (vlib_main_t * vm,
 941                vlib_node_runtime_t * node,
 942                vlib_node_type_t type,
 943                vlib_node_state_t dispatch_state,
 944                vlib_frame_t * frame, u64 last_time_stamp)
 945 {
 946   uword n, v;
 947   u64 t;
 948   vlib_node_main_t *nm = &vm->node_main;
 949   vlib_next_frame_t *nf;
 950
 951   if (CLIB_DEBUG > 0)
 952     {
 953       vlib_node_t *n = vlib_get_node (vm, node->node_index);
 954       ASSERT (n->type == type);
 955     }
 956
 957   /* Only non-internal nodes may be disabled. */
 958   if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
 959     {
 960       ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
 961       return last_time_stamp;
 962     }
 963
 964   if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
 965       && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
 966     {
 967       u32 c = node->input_main_loops_per_call;
 968       /* Only call node when count reaches zero. */
 969       if (c)
 970         {
 971           node->input_main_loops_per_call = c - 1;
 972           return last_time_stamp;
 973         }
 974     }
 975
 976   /* Speculatively prefetch next frames. */
 977   if (node->n_next_nodes > 0)
 978     {
 979       nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
 980       CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
 981     }
 982
 983   vm->cpu_time_last_node_dispatch = last_time_stamp;
 984
 985   if (1 /* || vm->thread_index == node->thread_index */ )
 986     {
 987       vlib_main_t *stat_vm;
 988
 989       stat_vm = /* vlib_mains ? vlib_mains[0] : */ vm;
 990
 991       vlib_elog_main_loop_event (vm, node->node_index,
 992                                  last_time_stamp,
 993                                  frame ? frame->n_vectors : 0,
 994                                  /* is_after */ 0);
 995
 996       /*
 997        * Turn this on if you run into
 998        * "bad monkey" contexts, and you want to know exactly
 999        * which nodes they've visited... See ixge.c...
1000        */
1001       if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
1002         {
1003           int i;
1004           int log_index;
1005           u32 *from;
1006           from = vlib_frame_vector_args (frame);
1007           for (i = 0; i < frame->n_vectors; i++)
1008             {
1009               vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1010               ASSERT (b->pre_data[0] < 32);
1011               log_index = b->pre_data[0]++ + 1;
1012               b->pre_data[log_index] = node->node_index;
1013             }
1014           n = node->function (vm, node, frame);
1015         }
1016       else
1017         n = node->function (vm, node, frame);
1018
1019       t = clib_cpu_time_now ();
1020
1021       vlib_elog_main_loop_event (vm, node->node_index, t, n,    /* is_after */
1022                                  1);
1023
1024       vm->main_loop_vectors_processed += n;
1025       vm->main_loop_nodes_processed += n > 0;
1026
1027       v = vlib_node_runtime_update_stats (stat_vm, node,
1028                                           /* n_calls */ 1,
1029                                           /* n_vectors */ n,
1030                                           /* n_clocks */ t - last_time_stamp);
1031
1032       /* When in interrupt mode and vector rate crosses threshold switch to
1033          polling mode. */
1034       if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1035           || (dispatch_state == VLIB_NODE_STATE_POLLING
1036               && (node->flags
1037                   & VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE)))
1038         {
1039 #ifdef DISPATCH_NODE_ELOG_REQUIRED
1040           ELOG_TYPE_DECLARE (e) =
1041           {
1042             .function = (char *) __FUNCTION__,.format =
1043               "%s vector length %d, switching to %s",.format_args =
1044               "T4i4t4",.n_enum_strings = 2,.enum_strings =
1045             {
1046           "interrupt", "polling",},};
1047           struct
1048           {
1049             u32 node_name, vector_length, is_polling;
1050           } *ed;
1051           vlib_worker_thread_t *w = vlib_worker_threads + vm->thread_index;
1052 #endif
1053
1054           if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1055                && v >= nm->polling_threshold_vector_length) &&
1056               !(node->flags &
1057                 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1058             {
1059               vlib_node_t *n = vlib_get_node (vm, node->node_index);
1060               n->state = VLIB_NODE_STATE_POLLING;
1061               node->state = VLIB_NODE_STATE_POLLING;
1062               node->flags &=
1063                 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1064               node->flags |=
1065                 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1066               nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1067               nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1068
1069 #ifdef DISPATCH_NODE_ELOG_REQUIRED
1070               ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1071                                     w->elog_track);
1072               ed->node_name = n->name_elog_string;
1073               ed->vector_length = v;
1074               ed->is_polling = 1;
1075 #endif
1076             }
1077           else if (dispatch_state == VLIB_NODE_STATE_POLLING
1078                    && v <= nm->interrupt_threshold_vector_length)
1079             {
1080               vlib_node_t *n = vlib_get_node (vm, node->node_index);
1081               if (node->flags &
1082                   VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1083                 {
1084                   /* Switch to interrupt mode after dispatch in polling one more time.
1085                      This allows driver to re-enable interrupts. */
1086                   n->state = VLIB_NODE_STATE_INTERRUPT;
1087                   node->state = VLIB_NODE_STATE_INTERRUPT;
1088                   node->flags &=
1089                     ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1090                   nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -=
1091                     1;
1092                   nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] +=
1093                     1;
1094
1095                 }
1096               else
1097                 {
1098                   node->flags |=
1099                     VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1100 #ifdef DISPATCH_NODE_ELOG_REQUIRED
1101                   ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1102                                         w->elog_track);
1103                   ed->node_name = n->name_elog_string;
1104                   ed->vector_length = v;
1105                   ed->is_polling = 0;
1106 #endif
1107                 }
1108             }
1109         }
1110     }
1111
1112   return t;
1113 }
1114
1115 static u64
1116 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1117                        u64 last_time_stamp)
1118 {
1119   vlib_node_main_t *nm = &vm->node_main;
1120   vlib_frame_t *f;
1121   vlib_next_frame_t *nf, nf_dummy;
1122   vlib_node_runtime_t *n;
1123   u32 restore_frame_index;
1124   vlib_pending_frame_t *p;
1125
1126   /* See comment below about dangling references to nm->pending_frames */
1127   p = nm->pending_frames + pending_frame_index;
1128
1129   n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1130                         p->node_runtime_index);
1131
1132   f = vlib_get_frame (vm, p->frame_index);
1133   if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1134     {
1135       /* No next frame: so use dummy on stack. */
1136       nf = &nf_dummy;
1137       nf->flags = f->flags & VLIB_NODE_FLAG_TRACE;
1138       nf->frame_index = ~p->frame_index;
1139     }
1140   else
1141     nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1142
1143   ASSERT (f->flags & VLIB_FRAME_IS_ALLOCATED);
1144
1145   /* Force allocation of new frame while current frame is being
1146      dispatched. */
1147   restore_frame_index = ~0;
1148   if (nf->frame_index == p->frame_index)
1149     {
1150       nf->frame_index = ~0;
1151       nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1152       if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1153         restore_frame_index = p->frame_index;
1154     }
1155
1156   /* Frame must be pending. */
1157   ASSERT (f->flags & VLIB_FRAME_PENDING);
1158   ASSERT (f->n_vectors > 0);
1159
1160   /* Copy trace flag from next frame to node.
1161      Trace flag indicates that at least one vector in the dispatched
1162      frame is traced. */
1163   n->flags &= ~VLIB_NODE_FLAG_TRACE;
1164   n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1165   nf->flags &= ~VLIB_FRAME_TRACE;
1166
1167   last_time_stamp = dispatch_node (vm, n,
1168                                    VLIB_NODE_TYPE_INTERNAL,
1169                                    VLIB_NODE_STATE_POLLING,
1170                                    f, last_time_stamp);
1171
1172   f->flags &= ~VLIB_FRAME_PENDING;
1173
1174   /* Frame is ready to be used again, so restore it. */
1175   if (restore_frame_index != ~0)
1176     {
1177       /*
1178        * We musn't restore a frame that is flagged to be freed. This
1179        * shouldn't happen since frames to be freed post dispatch are
1180        * those used when the to-node frame becomes full i.e. they form a
1181        * sort of queue of frames to a single node. If we get here then
1182        * the to-node frame and the pending frame *were* the same, and so
1183        * we removed the to-node frame.  Therefore this frame is no
1184        * longer part of the queue for that node and hence it cannot be
1185        * it's overspill.
1186        */
1187       ASSERT (!(f->flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1188
1189       /*
1190        * NB: dispatching node n can result in the creation and scheduling
1191        * of new frames, and hence in the reallocation of nm->pending_frames.
1192        * Recompute p, or no supper. This was broken for more than 10 years.
1193        */
1194       p = nm->pending_frames + pending_frame_index;
1195
1196       /*
1197        * p->next_frame_index can change during node dispatch if node
1198        * function decides to change graph hook up.
1199        */
1200       nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1201       nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1202
1203       if (~0 == nf->frame_index)
1204         {
1205           /* no new frame has been assigned to this node, use the saved one */
1206           nf->frame_index = restore_frame_index;
1207           f->n_vectors = 0;
1208         }
1209       else
1210         {
1211           /* The node has gained a frame, implying packets from the current frame
1212              were re-queued to this same node. we don't need the saved one
1213              anymore */
1214           vlib_frame_free (vm, n, f);
1215         }
1216     }
1217   else
1218     {
1219       if (f->flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1220         {
1221           ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1222           vlib_frame_free (vm, n, f);
1223         }
1224     }
1225
1226   return last_time_stamp;
1227 }
1228
1229 always_inline uword
1230 vlib_process_stack_is_valid (vlib_process_t * p)
1231 {
1232   return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1233 }
1234
1235 typedef struct
1236 {
1237   vlib_main_t *vm;
1238   vlib_process_t *process;
1239   vlib_frame_t *frame;
1240 } vlib_process_bootstrap_args_t;
1241
1242 /* Called in process stack. */
1243 static uword
1244 vlib_process_bootstrap (uword _a)
1245 {
1246   vlib_process_bootstrap_args_t *a;
1247   vlib_main_t *vm;
1248   vlib_node_runtime_t *node;
1249   vlib_frame_t *f;
1250   vlib_process_t *p;
1251   uword n;
1252
1253   a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1254
1255   vm = a->vm;
1256   p = a->process;
1257   f = a->frame;
1258   node = &p->node_runtime;
1259
1260   n = node->function (vm, node, f);
1261
1262   ASSERT (vlib_process_stack_is_valid (p));
1263
1264   clib_longjmp (&p->return_longjmp, n);
1265
1266   return n;
1267 }
1268
1269 /* Called in main stack. */
1270 static_always_inline uword
1271 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1272 {
1273   vlib_process_bootstrap_args_t a;
1274   uword r;
1275
1276   a.vm = vm;
1277   a.process = p;
1278   a.frame = f;
1279
1280   r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1281   if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1282     r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1283                       (void *) p->stack + (1 << p->log2_n_stack_bytes));
1284
1285   return r;
1286 }
1287
1288 static_always_inline uword
1289 vlib_process_resume (vlib_process_t * p)
1290 {
1291   uword r;
1292   p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1293                 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1294                 | VLIB_PROCESS_RESUME_PENDING);
1295   r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1296   if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1297     clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1298   return r;
1299 }
1300
1301 static u64
1302 dispatch_process (vlib_main_t * vm,
1303                   vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1304 {
1305   vlib_node_main_t *nm = &vm->node_main;
1306   vlib_node_runtime_t *node_runtime = &p->node_runtime;
1307   vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1308   u64 t;
1309   uword n_vectors, is_suspend;
1310
1311   if (node->state != VLIB_NODE_STATE_POLLING
1312       || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1313                       | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1314     return last_time_stamp;
1315
1316   p->flags |= VLIB_PROCESS_IS_RUNNING;
1317
1318   t = last_time_stamp;
1319   vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1320                              f ? f->n_vectors : 0, /* is_after */ 0);
1321
1322   /* Save away current process for suspend. */
1323   nm->current_process_index = node->runtime_index;
1324
1325   n_vectors = vlib_process_startup (vm, p, f);
1326
1327   nm->current_process_index = ~0;
1328
1329   ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1330   is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1331   if (is_suspend)
1332     {
1333       vlib_pending_frame_t *pf;
1334
1335       n_vectors = 0;
1336       pool_get (nm->suspended_process_frames, pf);
1337       pf->node_runtime_index = node->runtime_index;
1338       pf->frame_index = f ? vlib_frame_index (vm, f) : ~0;
1339       pf->next_frame_index = ~0;
1340
1341       p->n_suspends += 1;
1342       p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1343
1344       if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1345         {
1346           TWT (tw_timer_wheel) * tw =
1347             (TWT (tw_timer_wheel) *) nm->timing_wheel;
1348           p->stop_timer_handle =
1349             TW (tw_timer_start) (tw,
1350                                  vlib_timing_wheel_data_set_suspended_process
1351                                  (node->runtime_index) /* [sic] pool idex */ ,
1352                                  0 /* timer_id */ ,
1353                                  p->resume_clock_interval);
1354         }
1355     }
1356   else
1357     p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1358
1359   t = clib_cpu_time_now ();
1360
1361   vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1362                              /* is_after */ 1);
1363
1364   vlib_process_update_stats (vm, p,
1365                              /* n_calls */ !is_suspend,
1366                              /* n_vectors */ n_vectors,
1367                              /* n_clocks */ t - last_time_stamp);
1368
1369   return t;
1370 }
1371
1372 void
1373 vlib_start_process (vlib_main_t * vm, uword process_index)
1374 {
1375   vlib_node_main_t *nm = &vm->node_main;
1376   vlib_process_t *p = vec_elt (nm->processes, process_index);
1377   dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1378 }
1379
1380 static u64
1381 dispatch_suspended_process (vlib_main_t * vm,
1382                             uword process_index, u64 last_time_stamp)
1383 {
1384   vlib_node_main_t *nm = &vm->node_main;
1385   vlib_node_runtime_t *node_runtime;
1386   vlib_node_t *node;
1387   vlib_frame_t *f;
1388   vlib_process_t *p;
1389   vlib_pending_frame_t *pf;
1390   u64 t, n_vectors, is_suspend;
1391
1392   t = last_time_stamp;
1393
1394   p = vec_elt (nm->processes, process_index);
1395   if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1396     return last_time_stamp;
1397
1398   ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1399                       | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1400
1401   pf =
1402     pool_elt_at_index (nm->suspended_process_frames,
1403                        p->suspended_process_frame_index);
1404
1405   node_runtime = &p->node_runtime;
1406   node = vlib_get_node (vm, node_runtime->node_index);
1407   f = pf->frame_index != ~0 ? vlib_get_frame (vm, pf->frame_index) : 0;
1408
1409   vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1410                              f ? f->n_vectors : 0, /* is_after */ 0);
1411
1412   /* Save away current process for suspend. */
1413   nm->current_process_index = node->runtime_index;
1414
1415   n_vectors = vlib_process_resume (p);
1416   t = clib_cpu_time_now ();
1417
1418   nm->current_process_index = ~0;
1419
1420   is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1421   if (is_suspend)
1422     {
1423       /* Suspend it again. */
1424       n_vectors = 0;
1425       p->n_suspends += 1;
1426       if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1427         {
1428           p->stop_timer_handle =
1429             TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1430                                  vlib_timing_wheel_data_set_suspended_process
1431                                  (node->runtime_index) /* [sic] pool idex */ ,
1432                                  0 /* timer_id */ ,
1433                                  p->resume_clock_interval);
1434         }
1435     }
1436   else
1437     {
1438       p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1439       p->suspended_process_frame_index = ~0;
1440       pool_put (nm->suspended_process_frames, pf);
1441     }
1442
1443   t = clib_cpu_time_now ();
1444   vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1445                              /* is_after */ 1);
1446
1447   vlib_process_update_stats (vm, p,
1448                              /* n_calls */ !is_suspend,
1449                              /* n_vectors */ n_vectors,
1450                              /* n_clocks */ t - last_time_stamp);
1451
1452   return t;
1453 }
1454
1455 static_always_inline void
1456 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1457 {
1458   vlib_node_main_t *nm = &vm->node_main;
1459   vlib_thread_main_t *tm = vlib_get_thread_main ();
1460   uword i;
1461   u64 cpu_time_now;
1462   vlib_frame_queue_main_t *fqm;
1463   u32 *last_node_runtime_indices = 0;
1464
1465   /* Initialize pending node vector. */
1466   if (is_main)
1467     {
1468       vec_resize (nm->pending_frames, 32);
1469       _vec_len (nm->pending_frames) = 0;
1470     }
1471
1472   /* Mark time of main loop start. */
1473   if (is_main)
1474     {
1475       cpu_time_now = vm->clib_time.last_cpu_time;
1476       vm->cpu_time_main_loop_start = cpu_time_now;
1477     }
1478   else
1479     cpu_time_now = clib_cpu_time_now ();
1480
1481   /* Pre-allocate interupt runtime indices and lock. */
1482   vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1483   vec_alloc (last_node_runtime_indices, 32);
1484   if (!is_main)
1485     clib_spinlock_init (&nm->pending_interrupt_lock);
1486
1487   /* Pre-allocate expired nodes. */
1488   if (!nm->polling_threshold_vector_length)
1489     nm->polling_threshold_vector_length = 10;
1490   if (!nm->interrupt_threshold_vector_length)
1491     nm->interrupt_threshold_vector_length = 5;
1492
1493   /* Start all processes. */
1494   if (is_main)
1495     {
1496       uword i;
1497       nm->current_process_index = ~0;
1498       for (i = 0; i < vec_len (nm->processes); i++)
1499         cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1500                                          cpu_time_now);
1501     }
1502
1503   while (1)
1504     {
1505       vlib_node_runtime_t *n;
1506
1507       if (!is_main)
1508         {
1509           vlib_worker_thread_barrier_check ();
1510           vec_foreach (fqm, tm->frame_queue_mains)
1511             vlib_frame_queue_dequeue (vm, fqm);
1512         }
1513
1514       /* Process pre-input nodes. */
1515       if (is_main)
1516         vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1517           cpu_time_now = dispatch_node (vm, n,
1518                                         VLIB_NODE_TYPE_PRE_INPUT,
1519                                         VLIB_NODE_STATE_POLLING,
1520                                         /* frame */ 0,
1521                                         cpu_time_now);
1522
1523       /* Next process input nodes. */
1524       vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1525         cpu_time_now = dispatch_node (vm, n,
1526                                       VLIB_NODE_TYPE_INPUT,
1527                                       VLIB_NODE_STATE_POLLING,
1528                                       /* frame */ 0,
1529                                       cpu_time_now);
1530
1531       if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1532         vm->queue_signal_callback (vm);
1533
1534       /* Next handle interrupts. */
1535       {
1536         uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1537         uword i;
1538         if (l > 0)
1539           {
1540             u32 *tmp;
1541             if (!is_main)
1542               clib_spinlock_lock (&nm->pending_interrupt_lock);
1543             tmp = nm->pending_interrupt_node_runtime_indices;
1544             nm->pending_interrupt_node_runtime_indices =
1545               last_node_runtime_indices;
1546             last_node_runtime_indices = tmp;
1547             _vec_len (last_node_runtime_indices) = 0;
1548             if (!is_main)
1549               clib_spinlock_unlock (&nm->pending_interrupt_lock);
1550             for (i = 0; i < l; i++)
1551               {
1552                 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1553                                       last_node_runtime_indices[i]);
1554                 cpu_time_now =
1555                   dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1556                                  VLIB_NODE_STATE_INTERRUPT,
1557                                  /* frame */ 0,
1558                                  cpu_time_now);
1559               }
1560           }
1561       }
1562
1563       if (is_main)
1564         {
1565           /* Check if process nodes have expired from timing wheel. */
1566           ASSERT (nm->data_from_advancing_timing_wheel != 0);
1567
1568           nm->data_from_advancing_timing_wheel =
1569             TW (tw_timer_expire_timers_vec)
1570             ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1571              nm->data_from_advancing_timing_wheel);
1572
1573           ASSERT (nm->data_from_advancing_timing_wheel != 0);
1574
1575           if (PREDICT_FALSE
1576               (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1577             {
1578               uword i;
1579
1580             processes_timing_wheel_data:
1581               for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1582                    i++)
1583                 {
1584                   u32 d = nm->data_from_advancing_timing_wheel[i];
1585                   u32 di = vlib_timing_wheel_data_get_index (d);
1586
1587                   if (vlib_timing_wheel_data_is_timed_event (d))
1588                     {
1589                       vlib_signal_timed_event_data_t *te =
1590                         pool_elt_at_index (nm->signal_timed_event_data_pool,
1591                                            di);
1592                       vlib_node_t *n =
1593                         vlib_get_node (vm, te->process_node_index);
1594                       vlib_process_t *p =
1595                         vec_elt (nm->processes, n->runtime_index);
1596                       void *data;
1597                       data =
1598                         vlib_process_signal_event_helper (nm, n, p,
1599                                                           te->event_type_index,
1600                                                           te->n_data_elts,
1601                                                           te->n_data_elt_bytes);
1602                       if (te->n_data_bytes < sizeof (te->inline_event_data))
1603                         clib_memcpy (data, te->inline_event_data,
1604                                      te->n_data_bytes);
1605                       else
1606                         {
1607                           clib_memcpy (data, te->event_data_as_vector,
1608                                        te->n_data_bytes);
1609                           vec_free (te->event_data_as_vector);
1610                         }
1611                       pool_put (nm->signal_timed_event_data_pool, te);
1612                     }
1613                   else
1614                     {
1615                       cpu_time_now = clib_cpu_time_now ();
1616                       cpu_time_now =
1617                         dispatch_suspended_process (vm, di, cpu_time_now);
1618                     }
1619                 }
1620               _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1621             }
1622         }
1623
1624       /* Input nodes may have added work to the pending vector.
1625          Process pending vector until there is nothing left.
1626          All pending vectors will be processed from input -> output. */
1627       for (i = 0; i < _vec_len (nm->pending_frames); i++)
1628         cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1629       /* Reset pending vector for next iteration. */
1630       _vec_len (nm->pending_frames) = 0;
1631
1632       /* Pending internal nodes may resume processes. */
1633       if (is_main && _vec_len (nm->data_from_advancing_timing_wheel) > 0)
1634         goto processes_timing_wheel_data;
1635
1636       vlib_increment_main_loop_counter (vm);
1637
1638       /* Record time stamp in case there are no enabled nodes and above
1639          calls do not update time stamp. */
1640       cpu_time_now = clib_cpu_time_now ();
1641     }
1642 }
1643
1644 static void
1645 vlib_main_loop (vlib_main_t * vm)
1646 {
1647   vlib_main_or_worker_loop (vm, /* is_main */ 1);
1648 }
1649
1650 void
1651 vlib_worker_loop (vlib_main_t * vm)
1652 {
1653   vlib_main_or_worker_loop (vm, /* is_main */ 0);
1654 }
1655
1656 vlib_main_t vlib_global_main;
1657
1658 static clib_error_t *
1659 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1660 {
1661   int turn_on_mem_trace = 0;
1662
1663   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1664     {
1665       if (unformat (input, "memory-trace"))
1666         turn_on_mem_trace = 1;
1667
1668       else if (unformat (input, "elog-events %d",
1669                          &vm->elog_main.event_ring_size))
1670         ;
1671       else if (unformat (input, "elog-post-mortem-dump"))
1672         vm->elog_post_mortem_dump = 1;
1673       else
1674         return unformat_parse_error (input);
1675     }
1676
1677   unformat_free (input);
1678
1679   /* Enable memory trace as early as possible. */
1680   if (turn_on_mem_trace)
1681     clib_mem_trace (1);
1682
1683   return 0;
1684 }
1685
1686 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1687
1688 static void
1689 dummy_queue_signal_callback (vlib_main_t * vm)
1690 {
1691 }
1692
1693 /* Main function. */
1694 int
1695 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
1696 {
1697   clib_error_t *volatile error;
1698   vlib_node_main_t *nm = &vm->node_main;
1699
1700   vm->queue_signal_callback = dummy_queue_signal_callback;
1701
1702   clib_time_init (&vm->clib_time);
1703
1704   /* Turn on event log. */
1705   if (!vm->elog_main.event_ring_size)
1706     vm->elog_main.event_ring_size = 128 << 10;
1707   elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
1708   elog_enable_disable (&vm->elog_main, 1);
1709
1710   /* Default name. */
1711   if (!vm->name)
1712     vm->name = "VLIB";
1713
1714   vec_validate (vm->buffer_main, 0);
1715   vlib_buffer_cb_init (vm);
1716
1717   if ((error = vlib_thread_init (vm)))
1718     {
1719       clib_error_report (error);
1720       goto done;
1721     }
1722
1723   /* Register static nodes so that init functions may use them. */
1724   vlib_register_all_static_nodes (vm);
1725
1726   /* Set seed for random number generator.
1727      Allow user to specify seed to make random sequence deterministic. */
1728   if (!unformat (input, "seed %wd", &vm->random_seed))
1729     vm->random_seed = clib_cpu_time_now ();
1730   clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
1731
1732   /* Initialize node graph. */
1733   if ((error = vlib_node_main_init (vm)))
1734     {
1735       /* Arrange for graph hook up error to not be fatal when debugging. */
1736       if (CLIB_DEBUG > 0)
1737         clib_error_report (error);
1738       else
1739         goto done;
1740     }
1741
1742   /* See unix/main.c; most likely already set up */
1743   if (vm->init_functions_called == 0)
1744     vm->init_functions_called = hash_create (0, /* value bytes */ 0);
1745   if ((error = vlib_call_all_init_functions (vm)))
1746     goto done;
1747
1748   /* Create default buffer free list. */
1749   vlib_buffer_get_or_create_free_list (vm,
1750                                        VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
1751                                        "default");
1752
1753   nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
1754                                              CLIB_CACHE_LINE_BYTES);
1755
1756   vec_validate (nm->data_from_advancing_timing_wheel, 10);
1757   _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1758
1759   /* Create the process timing wheel */
1760   TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1761                             0 /* no callback */ ,
1762                             10e-6 /* timer period 10us */ ,
1763                             ~0 /* max expirations per call */ );
1764
1765   switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
1766     {
1767     case VLIB_MAIN_LOOP_EXIT_NONE:
1768       vm->main_loop_exit_set = 1;
1769       break;
1770
1771     case VLIB_MAIN_LOOP_EXIT_CLI:
1772       goto done;
1773
1774     default:
1775       error = vm->main_loop_error;
1776       goto done;
1777     }
1778
1779   if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
1780     goto done;
1781
1782   /* Call all main loop enter functions. */
1783   {
1784     clib_error_t *sub_error;
1785     sub_error = vlib_call_all_main_loop_enter_functions (vm);
1786     if (sub_error)
1787       clib_error_report (sub_error);
1788   }
1789
1790   vlib_main_loop (vm);
1791
1792 done:
1793   /* Call all exit functions. */
1794   {
1795     clib_error_t *sub_error;
1796     sub_error = vlib_call_all_main_loop_exit_functions (vm);
1797     if (sub_error)
1798       clib_error_report (sub_error);
1799   }
1800
1801   if (error)
1802     clib_error_report (error);
1803
1804   return 0;
1805 }
1806
1807 /*
1808  * fd.io coding-style-patch-verification: ON
1809  *
1810  * Local Variables:
1811  * eval: (c-set-style "gnu")
1812  * End:
1813  */