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