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     clib_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->frame_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   f->flags = 0;
 161
 162   fs->n_alloc_frames += 1;
 163
 164   return fi;
 165 }
 166
 167 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
 168    Returns frame index. */
 169 static u32
 170 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
 171                   u32 to_next_index)
 172 {
 173   vlib_node_t *from_node;
 174
 175   from_node = vlib_get_node (vm, from_node_runtime->node_index);
 176   ASSERT (to_next_index < vec_len (from_node->next_nodes));
 177
 178   return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
 179                                    /* frame_flags */ 0);
 180 }
 181
 182 vlib_frame_t *
 183 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
 184 {
 185   u32 fi = vlib_frame_alloc_to_node (vm, to_node_index,
 186                                      /* frame_flags */
 187                                      VLIB_FRAME_FREE_AFTER_DISPATCH);
 188   return vlib_get_frame (vm, fi);
 189 }
 190
 191 void
 192 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
 193 {
 194   vlib_pending_frame_t *p;
 195   vlib_node_t *to_node;
 196
 197   if (f->n_vectors == 0)
 198     return;
 199
 200   to_node = vlib_get_node (vm, to_node_index);
 201
 202   vec_add2 (vm->node_main.pending_frames, p, 1);
 203
 204   f->frame_flags |= VLIB_FRAME_PENDING;
 205   p->frame_index = vlib_frame_index (vm, f);
 206   p->node_runtime_index = to_node->runtime_index;
 207   p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
 208 }
 209
 210 /* Free given frame. */
 211 void
 212 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
 213 {
 214   vlib_node_main_t *nm = &vm->node_main;
 215   vlib_node_t *node;
 216   vlib_frame_size_t *fs;
 217   u32 frame_index;
 218
 219   ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
 220
 221   node = vlib_get_node (vm, r->node_index);
 222   fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
 223
 224   frame_index = vlib_frame_index (vm, f);
 225
 226   ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
 227
 228   /* No next frames may point to freed frame. */
 229   if (CLIB_DEBUG > 0)
 230     {
 231       vlib_next_frame_t *nf;
 232       vec_foreach (nf, vm->node_main.next_frames)
 233         ASSERT (nf->frame_index != frame_index);
 234     }
 235
 236   f->frame_flags &= ~VLIB_FRAME_IS_ALLOCATED;
 237
 238   vec_add1 (fs->free_frame_indices, frame_index);
 239   ASSERT (fs->n_alloc_frames > 0);
 240   fs->n_alloc_frames -= 1;
 241 }
 242
 243 static clib_error_t *
 244 show_frame_stats (vlib_main_t * vm,
 245                   unformat_input_t * input, vlib_cli_command_t * cmd)
 246 {
 247   vlib_node_main_t *nm = &vm->node_main;
 248   vlib_frame_size_t *fs;
 249
 250   vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
 251   vec_foreach (fs, nm->frame_sizes)
 252   {
 253     u32 n_alloc = fs->n_alloc_frames;
 254     u32 n_free = vec_len (fs->free_frame_indices);
 255
 256     if (n_alloc + n_free > 0)
 257       vlib_cli_output (vm, "%=6d%=12d%=12d",
 258                        fs - nm->frame_sizes, n_alloc, n_free);
 259   }
 260
 261   return 0;
 262 }
 263
 264 /* *INDENT-OFF* */
 265 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
 266   .path = "show vlib frame-allocation",
 267   .short_help = "Show node dispatch frame statistics",
 268   .function = show_frame_stats,
 269 };
 270 /* *INDENT-ON* */
 271
 272 /* Change ownership of enqueue rights to given next node. */
 273 static void
 274 vlib_next_frame_change_ownership (vlib_main_t * vm,
 275                                   vlib_node_runtime_t * node_runtime,
 276                                   u32 next_index)
 277 {
 278   vlib_node_main_t *nm = &vm->node_main;
 279   vlib_next_frame_t *next_frame;
 280   vlib_node_t *node, *next_node;
 281
 282   node = vec_elt (nm->nodes, node_runtime->node_index);
 283
 284   /* Only internal & input nodes are allowed to call other nodes. */
 285   ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
 286           || node->type == VLIB_NODE_TYPE_INPUT
 287           || node->type == VLIB_NODE_TYPE_PROCESS);
 288
 289   ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
 290
 291   next_frame =
 292     vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
 293   next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
 294
 295   if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
 296     {
 297       /* Get frame from previous owner. */
 298       vlib_next_frame_t *owner_next_frame;
 299       vlib_next_frame_t tmp;
 300
 301       owner_next_frame =
 302         vlib_node_get_next_frame (vm,
 303                                   next_node->owner_node_index,
 304                                   next_node->owner_next_index);
 305
 306       /* Swap target next frame with owner's. */
 307       tmp = owner_next_frame[0];
 308       owner_next_frame[0] = next_frame[0];
 309       next_frame[0] = tmp;
 310
 311       /*
 312        * If next_frame is already pending, we have to track down
 313        * all pending frames and fix their next_frame_index fields.
 314        */
 315       if (next_frame->flags & VLIB_FRAME_PENDING)
 316         {
 317           vlib_pending_frame_t *p;
 318           if (next_frame->frame_index != ~0)
 319             {
 320               vec_foreach (p, nm->pending_frames)
 321               {
 322                 if (p->frame_index == next_frame->frame_index)
 323                   {
 324                     p->next_frame_index =
 325                       next_frame - vm->node_main.next_frames;
 326                   }
 327               }
 328             }
 329         }
 330     }
 331   else
 332     {
 333       /* No previous owner. Take ownership. */
 334       next_frame->flags |= VLIB_FRAME_OWNER;
 335     }
 336
 337   /* Record new owner. */
 338   next_node->owner_node_index = node->index;
 339   next_node->owner_next_index = next_index;
 340
 341   /* Now we should be owner. */
 342   ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
 343 }
 344
 345 /* Make sure that magic number is still there.
 346    Otherwise, it is likely that caller has overrun frame arguments. */
 347 always_inline void
 348 validate_frame_magic (vlib_main_t * vm,
 349                       vlib_frame_t * f, vlib_node_t * n, uword next_index)
 350 {
 351   vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
 352   u32 *magic = vlib_frame_find_magic (f, next_node);
 353   ASSERT (VLIB_FRAME_MAGIC == magic[0]);
 354 }
 355
 356 vlib_frame_t *
 357 vlib_get_next_frame_internal (vlib_main_t * vm,
 358                               vlib_node_runtime_t * node,
 359                               u32 next_index, u32 allocate_new_next_frame)
 360 {
 361   vlib_frame_t *f;
 362   vlib_next_frame_t *nf;
 363   u32 n_used;
 364
 365   nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
 366
 367   /* Make sure this next frame owns right to enqueue to destination frame. */
 368   if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
 369     vlib_next_frame_change_ownership (vm, node, next_index);
 370
 371   /* ??? Don't need valid flag: can use frame_index == ~0 */
 372   if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
 373     {
 374       nf->frame_index = vlib_frame_alloc (vm, node, next_index);
 375       nf->flags |= VLIB_FRAME_IS_ALLOCATED;
 376     }
 377
 378   f = vlib_get_frame (vm, nf->frame_index);
 379
 380   /* Has frame been removed from pending vector (e.g. finished dispatching)?
 381      If so we can reuse frame. */
 382   if ((nf->flags & VLIB_FRAME_PENDING)
 383       && !(f->frame_flags & VLIB_FRAME_PENDING))
 384     {
 385       nf->flags &= ~VLIB_FRAME_PENDING;
 386       f->n_vectors = 0;
 387       f->flags = 0;
 388     }
 389
 390   /* Allocate new frame if current one is already full. */
 391   n_used = f->n_vectors;
 392   if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0))
 393     {
 394       /* Old frame may need to be freed after dispatch, since we'll have
 395          two redundant frames from node -> next node. */
 396       if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
 397         {
 398           vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame_index);
 399           f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
 400         }
 401
 402       /* Allocate new frame to replace full one. */
 403       nf->frame_index = vlib_frame_alloc (vm, node, next_index);
 404       f = vlib_get_frame (vm, nf->frame_index);
 405       n_used = f->n_vectors;
 406     }
 407
 408   /* Should have free vectors in frame now. */
 409   ASSERT (n_used < VLIB_FRAME_SIZE);
 410
 411   if (CLIB_DEBUG > 0)
 412     {
 413       validate_frame_magic (vm, f,
 414                             vlib_get_node (vm, node->node_index), next_index);
 415     }
 416
 417   return f;
 418 }
 419
 420 static void
 421 vlib_put_next_frame_validate (vlib_main_t * vm,
 422                               vlib_node_runtime_t * rt,
 423                               u32 next_index, u32 n_vectors_left)
 424 {
 425   vlib_node_main_t *nm = &vm->node_main;
 426   vlib_next_frame_t *nf;
 427   vlib_frame_t *f;
 428   vlib_node_runtime_t *next_rt;
 429   vlib_node_t *next_node;
 430   u32 n_before, n_after;
 431
 432   nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
 433   f = vlib_get_frame (vm, nf->frame_index);
 434
 435   ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
 436   n_after = VLIB_FRAME_SIZE - n_vectors_left;
 437   n_before = f->n_vectors;
 438
 439   ASSERT (n_after >= n_before);
 440
 441   next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
 442                               nf->node_runtime_index);
 443   next_node = vlib_get_node (vm, next_rt->node_index);
 444   if (n_after > 0 && next_node->validate_frame)
 445     {
 446       u8 *msg = next_node->validate_frame (vm, rt, f);
 447       if (msg)
 448         {
 449           clib_warning ("%v", msg);
 450           ASSERT (0);
 451         }
 452       vec_free (msg);
 453     }
 454 }
 455
 456 void
 457 vlib_put_next_frame (vlib_main_t * vm,
 458                      vlib_node_runtime_t * r,
 459                      u32 next_index, u32 n_vectors_left)
 460 {
 461   vlib_node_main_t *nm = &vm->node_main;
 462   vlib_next_frame_t *nf;
 463   vlib_frame_t *f;
 464   u32 n_vectors_in_frame;
 465
 466   if (CLIB_DEBUG > 0)
 467     vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
 468
 469   nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
 470   f = vlib_get_frame (vm, nf->frame_index);
 471
 472   /* Make sure that magic number is still there.  Otherwise, caller
 473      has overrun frame meta data. */
 474   if (CLIB_DEBUG > 0)
 475     {
 476       vlib_node_t *node = vlib_get_node (vm, r->node_index);
 477       validate_frame_magic (vm, f, node, next_index);
 478     }
 479
 480   /* Convert # of vectors left -> number of vectors there. */
 481   ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
 482   n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
 483
 484   f->n_vectors = n_vectors_in_frame;
 485
 486   /* If vectors were added to frame, add to pending vector. */
 487   if (PREDICT_TRUE (n_vectors_in_frame > 0))
 488     {
 489       vlib_pending_frame_t *p;
 490       u32 v0, v1;
 491
 492       r->cached_next_index = next_index;
 493
 494       if (!(f->frame_flags & VLIB_FRAME_PENDING))
 495         {
 496           __attribute__ ((unused)) vlib_node_t *node;
 497           vlib_node_t *next_node;
 498           vlib_node_runtime_t *next_runtime;
 499
 500           node = vlib_get_node (vm, r->node_index);
 501           next_node = vlib_get_next_node (vm, r->node_index, next_index);
 502           next_runtime = vlib_node_get_runtime (vm, next_node->index);
 503
 504           vec_add2 (nm->pending_frames, p, 1);
 505
 506           p->frame_index = nf->frame_index;
 507           p->node_runtime_index = nf->node_runtime_index;
 508           p->next_frame_index = nf - nm->next_frames;
 509           nf->flags |= VLIB_FRAME_PENDING;
 510           f->frame_flags |= VLIB_FRAME_PENDING;
 511
 512           /*
 513            * If we're going to dispatch this frame on another thread,
 514            * force allocation of a new frame. Otherwise, we create
 515            * a dangling frame reference. Each thread has its own copy of
 516            * the next_frames vector.
 517            */
 518           if (0 && r->thread_index != next_runtime->thread_index)
 519             {
 520               nf->frame_index = ~0;
 521               nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
 522             }
 523         }
 524
 525       /* Copy trace flag from next_frame and from runtime. */
 526       nf->flags |=
 527         (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
 528                                               flags & VLIB_NODE_FLAG_TRACE);
 529
 530       v0 = nf->vectors_since_last_overflow;
 531       v1 = v0 + n_vectors_in_frame;
 532       nf->vectors_since_last_overflow = v1;
 533       if (PREDICT_FALSE (v1 < v0))
 534         {
 535           vlib_node_t *node = vlib_get_node (vm, r->node_index);
 536           vec_elt (node->n_vectors_by_next_node, next_index) += v0;
 537         }
 538     }
 539 }
 540
 541 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
 542 never_inline void
 543 vlib_node_runtime_sync_stats (vlib_main_t * vm,
 544                               vlib_node_runtime_t * r,
 545                               uword n_calls, uword n_vectors, uword n_clocks,
 546                               uword n_ticks0, uword n_ticks1)
 547 {
 548   vlib_node_t *n = vlib_get_node (vm, r->node_index);
 549
 550   n->stats_total.calls += n_calls + r->calls_since_last_overflow;
 551   n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
 552   n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
 553   n->stats_total.perf_counter0_ticks += n_ticks0 +
 554     r->perf_counter0_ticks_since_last_overflow;
 555   n->stats_total.perf_counter1_ticks += n_ticks1 +
 556     r->perf_counter1_ticks_since_last_overflow;
 557   n->stats_total.perf_counter_vectors += n_vectors +
 558     r->perf_counter_vectors_since_last_overflow;
 559   n->stats_total.max_clock = r->max_clock;
 560   n->stats_total.max_clock_n = r->max_clock_n;
 561
 562   r->calls_since_last_overflow = 0;
 563   r->vectors_since_last_overflow = 0;
 564   r->clocks_since_last_overflow = 0;
 565   r->perf_counter0_ticks_since_last_overflow = 0ULL;
 566   r->perf_counter1_ticks_since_last_overflow = 0ULL;
 567   r->perf_counter_vectors_since_last_overflow = 0ULL;
 568 }
 569
 570 always_inline void __attribute__ ((unused))
 571 vlib_process_sync_stats (vlib_main_t * vm,
 572                          vlib_process_t * p,
 573                          uword n_calls, uword n_vectors, uword n_clocks,
 574                          uword n_ticks0, uword n_ticks1)
 575 {
 576   vlib_node_runtime_t *rt = &p->node_runtime;
 577   vlib_node_t *n = vlib_get_node (vm, rt->node_index);
 578   vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks,
 579                                 n_ticks0, n_ticks1);
 580   n->stats_total.suspends += p->n_suspends;
 581   p->n_suspends = 0;
 582 }
 583
 584 void
 585 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
 586 {
 587   vlib_node_runtime_t *rt;
 588
 589   if (n->type == VLIB_NODE_TYPE_PROCESS)
 590     {
 591       /* Nothing to do for PROCESS nodes except in main thread */
 592       if (vm != &vlib_global_main)
 593         return;
 594
 595       vlib_process_t *p = vlib_get_process_from_node (vm, n);
 596       n->stats_total.suspends += p->n_suspends;
 597       p->n_suspends = 0;
 598       rt = &p->node_runtime;
 599     }
 600   else
 601     rt =
 602       vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
 603                         n->runtime_index);
 604
 605   vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0, 0, 0);
 606
 607   /* Sync up runtime next frame vector counters with main node structure. */
 608   {
 609     vlib_next_frame_t *nf;
 610     uword i;
 611     for (i = 0; i < rt->n_next_nodes; i++)
 612       {
 613         nf = vlib_node_runtime_get_next_frame (vm, rt, i);
 614         vec_elt (n->n_vectors_by_next_node, i) +=
 615           nf->vectors_since_last_overflow;
 616         nf->vectors_since_last_overflow = 0;
 617       }
 618   }
 619 }
 620
 621 always_inline u32
 622 vlib_node_runtime_update_stats (vlib_main_t * vm,
 623                                 vlib_node_runtime_t * node,
 624                                 uword n_calls,
 625                                 uword n_vectors, uword n_clocks,
 626                                 uword n_ticks0, uword n_ticks1)
 627 {
 628   u32 ca0, ca1, v0, v1, cl0, cl1, r;
 629   u32 ptick00, ptick01, ptick10, ptick11, pvec0, pvec1;
 630
 631   cl0 = cl1 = node->clocks_since_last_overflow;
 632   ca0 = ca1 = node->calls_since_last_overflow;
 633   v0 = v1 = node->vectors_since_last_overflow;
 634   ptick00 = ptick01 = node->perf_counter0_ticks_since_last_overflow;
 635   ptick10 = ptick11 = node->perf_counter1_ticks_since_last_overflow;
 636   pvec0 = pvec1 = node->perf_counter_vectors_since_last_overflow;
 637
 638   ca1 = ca0 + n_calls;
 639   v1 = v0 + n_vectors;
 640   cl1 = cl0 + n_clocks;
 641   ptick01 = ptick00 + n_ticks0;
 642   ptick11 = ptick10 + n_ticks1;
 643   pvec1 = pvec0 + n_vectors;
 644
 645   node->calls_since_last_overflow = ca1;
 646   node->clocks_since_last_overflow = cl1;
 647   node->vectors_since_last_overflow = v1;
 648   node->perf_counter0_ticks_since_last_overflow = ptick01;
 649   node->perf_counter1_ticks_since_last_overflow = ptick11;
 650   node->perf_counter_vectors_since_last_overflow = pvec1;
 651
 652   node->max_clock_n = node->max_clock > n_clocks ?
 653     node->max_clock_n : n_vectors;
 654   node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
 655
 656   r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
 657
 658   if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0) || (ptick01 < ptick00)
 659       || (ptick11 < ptick10) || (pvec1 < pvec0))
 660     {
 661       node->calls_since_last_overflow = ca0;
 662       node->clocks_since_last_overflow = cl0;
 663       node->vectors_since_last_overflow = v0;
 664       node->perf_counter0_ticks_since_last_overflow = ptick00;
 665       node->perf_counter1_ticks_since_last_overflow = ptick10;
 666       node->perf_counter_vectors_since_last_overflow = pvec0;
 667
 668       vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks,
 669                                     n_ticks0, n_ticks1);
 670     }
 671
 672   return r;
 673 }
 674
 675 static inline void
 676 vlib_node_runtime_perf_counter (vlib_main_t * vm, u64 * pmc0, u64 * pmc1)
 677 {
 678   *pmc0 = 0;
 679   *pmc1 = 0;
 680   if (PREDICT_FALSE (vm->vlib_node_runtime_perf_counter_cb != 0))
 681     (*vm->vlib_node_runtime_perf_counter_cb) (vm, pmc0, pmc1);
 682 }
 683
 684 always_inline void
 685 vlib_process_update_stats (vlib_main_t * vm,
 686                            vlib_process_t * p,
 687                            uword n_calls, uword n_vectors, uword n_clocks)
 688 {
 689   vlib_node_runtime_update_stats (vm, &p->node_runtime,
 690                                   n_calls, n_vectors, n_clocks, 0ULL, 0ULL);
 691 }
 692
 693 static clib_error_t *
 694 vlib_cli_elog_clear (vlib_main_t * vm,
 695                      unformat_input_t * input, vlib_cli_command_t * cmd)
 696 {
 697   elog_reset_buffer (&vm->elog_main);
 698   return 0;
 699 }
 700
 701 /* *INDENT-OFF* */
 702 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
 703   .path = "event-logger clear",
 704   .short_help = "Clear the event log",
 705   .function = vlib_cli_elog_clear,
 706 };
 707 /* *INDENT-ON* */
 708
 709 #ifdef CLIB_UNIX
 710 static clib_error_t *
 711 elog_save_buffer (vlib_main_t * vm,
 712                   unformat_input_t * input, vlib_cli_command_t * cmd)
 713 {
 714   elog_main_t *em = &vm->elog_main;
 715   char *file, *chroot_file;
 716   clib_error_t *error = 0;
 717
 718   if (!unformat (input, "%s", &file))
 719     {
 720       vlib_cli_output (vm, "expected file name, got `%U'",
 721                        format_unformat_error, input);
 722       return 0;
 723     }
 724
 725   /* It's fairly hard to get "../oopsie" through unformat; just in case */
 726   if (strstr (file, "..") || index (file, '/'))
 727     {
 728       vlib_cli_output (vm, "illegal characters in filename '%s'", file);
 729       return 0;
 730     }
 731
 732   chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
 733
 734   vec_free (file);
 735
 736   vlib_cli_output (vm, "Saving %wd of %wd events to %s",
 737                    elog_n_events_in_buffer (em),
 738                    elog_buffer_capacity (em), chroot_file);
 739
 740   vlib_worker_thread_barrier_sync (vm);
 741   error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
 742   vlib_worker_thread_barrier_release (vm);
 743   vec_free (chroot_file);
 744   return error;
 745 }
 746
 747 void
 748 elog_post_mortem_dump (void)
 749 {
 750   vlib_main_t *vm = &vlib_global_main;
 751   elog_main_t *em = &vm->elog_main;
 752   u8 *filename;
 753   clib_error_t *error;
 754
 755   if (!vm->elog_post_mortem_dump)
 756     return;
 757
 758   filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
 759   error = elog_write_file (em, (char *) filename, 1 /* flush ring */ );
 760   if (error)
 761     clib_error_report (error);
 762   vec_free (filename);
 763 }
 764
 765 /* *INDENT-OFF* */
 766 VLIB_CLI_COMMAND (elog_save_cli, static) = {
 767   .path = "event-logger save",
 768   .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
 769   .function = elog_save_buffer,
 770 };
 771 /* *INDENT-ON* */
 772
 773 static clib_error_t *
 774 elog_stop (vlib_main_t * vm,
 775            unformat_input_t * input, vlib_cli_command_t * cmd)
 776 {
 777   elog_main_t *em = &vm->elog_main;
 778
 779   em->n_total_events_disable_limit = em->n_total_events;
 780
 781   vlib_cli_output (vm, "Stopped the event logger...");
 782   return 0;
 783 }
 784
 785 /* *INDENT-OFF* */
 786 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
 787   .path = "event-logger stop",
 788   .short_help = "Stop the event-logger",
 789   .function = elog_stop,
 790 };
 791 /* *INDENT-ON* */
 792
 793 static clib_error_t *
 794 elog_restart (vlib_main_t * vm,
 795               unformat_input_t * input, vlib_cli_command_t * cmd)
 796 {
 797   elog_main_t *em = &vm->elog_main;
 798
 799   em->n_total_events_disable_limit = ~0;
 800
 801   vlib_cli_output (vm, "Restarted the event logger...");
 802   return 0;
 803 }
 804
 805 /* *INDENT-OFF* */
 806 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
 807   .path = "event-logger restart",
 808   .short_help = "Restart the event-logger",
 809   .function = elog_restart,
 810 };
 811 /* *INDENT-ON* */
 812
 813 static clib_error_t *
 814 elog_resize (vlib_main_t * vm,
 815              unformat_input_t * input, vlib_cli_command_t * cmd)
 816 {
 817   elog_main_t *em = &vm->elog_main;
 818   u32 tmp;
 819
 820   /* Stop the parade */
 821   elog_reset_buffer (&vm->elog_main);
 822
 823   if (unformat (input, "%d", &tmp))
 824     {
 825       elog_alloc (em, tmp);
 826       em->n_total_events_disable_limit = ~0;
 827     }
 828   else
 829     return clib_error_return (0, "Must specify how many events in the ring");
 830
 831   vlib_cli_output (vm, "Resized ring and restarted the event logger...");
 832   return 0;
 833 }
 834
 835 /* *INDENT-OFF* */
 836 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
 837   .path = "event-logger resize",
 838   .short_help = "event-logger resize <nnn>",
 839   .function = elog_resize,
 840 };
 841 /* *INDENT-ON* */
 842
 843 #endif /* CLIB_UNIX */
 844
 845 static void
 846 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
 847 {
 848   elog_main_t *em = &vm->elog_main;
 849   elog_event_t *e, *es;
 850   f64 dt;
 851
 852   /* Show events in VLIB time since log clock starts after VLIB clock. */
 853   dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
 854     * vm->clib_time.seconds_per_clock;
 855
 856   es = elog_peek_events (em);
 857   vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
 858                    em->event_ring_size,
 859                    em->n_total_events < em->n_total_events_disable_limit ?
 860                    "running" : "stopped");
 861   vec_foreach (e, es)
 862   {
 863     vlib_cli_output (vm, "%18.9f: %U",
 864                      e->time + dt, format_elog_event, em, e);
 865     n_events_to_show--;
 866     if (n_events_to_show == 0)
 867       break;
 868   }
 869   vec_free (es);
 870
 871 }
 872
 873 static clib_error_t *
 874 elog_show_buffer (vlib_main_t * vm,
 875                   unformat_input_t * input, vlib_cli_command_t * cmd)
 876 {
 877   u32 n_events_to_show;
 878   clib_error_t *error = 0;
 879
 880   n_events_to_show = 250;
 881   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 882     {
 883       if (unformat (input, "%d", &n_events_to_show))
 884         ;
 885       else if (unformat (input, "all"))
 886         n_events_to_show = ~0;
 887       else
 888         return unformat_parse_error (input);
 889     }
 890   elog_show_buffer_internal (vm, n_events_to_show);
 891   return error;
 892 }
 893
 894 /* *INDENT-OFF* */
 895 VLIB_CLI_COMMAND (elog_show_cli, static) = {
 896   .path = "show event-logger",
 897   .short_help = "Show event logger info",
 898   .function = elog_show_buffer,
 899 };
 900 /* *INDENT-ON* */
 901
 902 void
 903 vlib_gdb_show_event_log (void)
 904 {
 905   elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
 906 }
 907
 908 static inline void
 909 vlib_elog_main_loop_event (vlib_main_t * vm,
 910                            u32 node_index,
 911                            u64 time, u32 n_vectors, u32 is_return)
 912 {
 913   vlib_main_t *evm = &vlib_global_main;
 914   elog_main_t *em = &evm->elog_main;
 915   int enabled = evm->elog_trace_graph_dispatch |
 916     evm->elog_trace_graph_circuit;
 917
 918   if (PREDICT_FALSE (enabled && n_vectors))
 919     {
 920       if (PREDICT_FALSE (!elog_is_enabled (em)))
 921         {
 922           evm->elog_trace_graph_dispatch = 0;
 923           evm->elog_trace_graph_circuit = 0;
 924           return;
 925         }
 926       if (PREDICT_TRUE
 927           (evm->elog_trace_graph_dispatch ||
 928            (evm->elog_trace_graph_circuit &&
 929             node_index == evm->elog_trace_graph_circuit_node_index)))
 930         {
 931           elog_track (em,
 932                       /* event type */
 933                       vec_elt_at_index (is_return
 934                                         ? evm->node_return_elog_event_types
 935                                         : evm->node_call_elog_event_types,
 936                                         node_index),
 937                       /* track */
 938                       (vm->thread_index ?
 939                        &vlib_worker_threads[vm->thread_index].elog_track
 940                        : &em->default_track),
 941                       /* data to log */ n_vectors);
 942         }
 943     }
 944 }
 945
 946 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
 947 void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 node_index);
 948 void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
 949
 950 void
 951 vlib_buffer_trace_trajectory_init (vlib_buffer_t * b)
 952 {
 953   if (PREDICT_TRUE (vlib_buffer_trace_trajectory_init_cb != 0))
 954     {
 955       (*vlib_buffer_trace_trajectory_init_cb) (b);
 956     }
 957 }
 958
 959 #endif
 960
 961 static inline void
 962 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
 963 {
 964 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
 965   if (PREDICT_TRUE (vlib_buffer_trace_trajectory_cb != 0))
 966     {
 967       (*vlib_buffer_trace_trajectory_cb) (b, node_index);
 968     }
 969 #endif
 970 }
 971
 972 u8 *format_vnet_buffer_flags (u8 * s, va_list * args) __attribute__ ((weak));
 973 u8 *
 974 format_vnet_buffer_flags (u8 * s, va_list * args)
 975 {
 976   s = format (s, "BUG STUB %s", __FUNCTION__);
 977   return s;
 978 }
 979
 980 u8 *format_vnet_buffer_opaque (u8 * s, va_list * args) __attribute__ ((weak));
 981 u8 *
 982 format_vnet_buffer_opaque (u8 * s, va_list * args)
 983 {
 984   s = format (s, "BUG STUB %s", __FUNCTION__);
 985   return s;
 986 }
 987
 988 u8 *format_vnet_buffer_opaque2 (u8 * s, va_list * args)
 989   __attribute__ ((weak));
 990 u8 *
 991 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
 992 {
 993   s = format (s, "BUG STUB %s", __FUNCTION__);
 994   return s;
 995 }
 996
 997 static u8 *
 998 format_buffer_metadata (u8 * s, va_list * args)
 999 {
1000   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
1001
1002   s = format (s, "flags: %U\n", format_vnet_buffer_flags, b);
1003   s = format (s, "current_data: %d, current_length: %d\n",
1004               (i32) (b->current_data), (i32) (b->current_length));
1005   s = format (s, "current_config_index: %d, flow_id: %x, next_buffer: %x\n",
1006               b->current_config_index, b->flow_id, b->next_buffer);
1007   s = format (s, "error: %d, ref_count: %d, buffer_pool_index: %d\n",
1008               (u32) (b->error), (u32) (b->ref_count),
1009               (u32) (b->buffer_pool_index));
1010   s = format (s,
1011               "trace_index: %d, len_not_first_buf: %d\n",
1012               b->trace_index, b->total_length_not_including_first_buffer);
1013   return s;
1014 }
1015
1016 #define A(x) vec_add1(vm->pcap_buffer, (x))
1017
1018 static void
1019 dispatch_pcap_trace (vlib_main_t * vm,
1020                      vlib_node_runtime_t * node, vlib_frame_t * frame)
1021 {
1022   int i;
1023   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **bufp, *b;
1024   pcap_main_t *pm = &vm->dispatch_pcap_main;
1025   vlib_trace_main_t *tm = &vm->trace_main;
1026   u32 capture_size;
1027   vlib_node_t *n;
1028   i32 n_left;
1029   f64 time_now = vlib_time_now (vm);
1030   u32 *from;
1031   u8 *d;
1032   u8 string_count;
1033
1034   /* Input nodes don't have frames yet */
1035   if (frame == 0 || frame->n_vectors == 0)
1036     return;
1037
1038   from = vlib_frame_vector_args (frame);
1039   vlib_get_buffers (vm, from, bufs, frame->n_vectors);
1040   bufp = bufs;
1041
1042   n = vlib_get_node (vm, node->node_index);
1043
1044   for (i = 0; i < frame->n_vectors; i++)
1045     {
1046       if (PREDICT_TRUE (pm->n_packets_captured < pm->n_packets_to_capture))
1047         {
1048           b = bufp[i];
1049
1050           vec_reset_length (vm->pcap_buffer);
1051           string_count = 0;
1052
1053           /* Version, flags */
1054           A ((u8) VLIB_PCAP_MAJOR_VERSION);
1055           A ((u8) VLIB_PCAP_MINOR_VERSION);
1056           A (0 /* string_count */ );
1057           A (n->protocol_hint);
1058
1059           /* Buffer index (big endian) */
1060           A ((from[i] >> 24) & 0xff);
1061           A ((from[i] >> 16) & 0xff);
1062           A ((from[i] >> 8) & 0xff);
1063           A ((from[i] >> 0) & 0xff);
1064
1065           /* Node name, NULL-terminated ASCII */
1066           vm->pcap_buffer = format (vm->pcap_buffer, "%v%c", n->name, 0);
1067           string_count++;
1068
1069           vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1070                                     format_buffer_metadata, b, 0);
1071           string_count++;
1072           vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1073                                     format_vnet_buffer_opaque, b, 0);
1074           string_count++;
1075           vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1076                                     format_vnet_buffer_opaque2, b, 0);
1077           string_count++;
1078
1079           /* Is this packet traced? */
1080           if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1081             {
1082               vlib_trace_header_t **h
1083                 = pool_elt_at_index (tm->trace_buffer_pool, b->trace_index);
1084
1085               vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1086                                         format_vlib_trace, vm, h[0], 0);
1087               string_count++;
1088             }
1089
1090           /* Save the string count */
1091           vm->pcap_buffer[2] = string_count;
1092
1093           /* Figure out how many bytes in the pcap trace */
1094           capture_size = vec_len (vm->pcap_buffer) +
1095             +vlib_buffer_length_in_chain (vm, b);
1096
1097           clib_spinlock_lock_if_init (&pm->lock);
1098           n_left = clib_min (capture_size, 16384);
1099           d = pcap_add_packet (pm, time_now, n_left, capture_size);
1100
1101           /* Copy the header */
1102           clib_memcpy_fast (d, vm->pcap_buffer, vec_len (vm->pcap_buffer));
1103           d += vec_len (vm->pcap_buffer);
1104
1105           n_left = clib_min
1106             (vlib_buffer_length_in_chain (vm, b),
1107              (16384 - vec_len (vm->pcap_buffer)));
1108           /* Copy the packet data */
1109           while (1)
1110             {
1111               u32 copy_length = clib_min ((u32) n_left, b->current_length);
1112               clib_memcpy_fast (d, b->data + b->current_data, copy_length);
1113               n_left -= b->current_length;
1114               if (n_left <= 0)
1115                 break;
1116               d += b->current_length;
1117               ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
1118               b = vlib_get_buffer (vm, b->next_buffer);
1119             }
1120           clib_spinlock_unlock_if_init (&pm->lock);
1121         }
1122     }
1123 }
1124
1125 static_always_inline u64
1126 dispatch_node (vlib_main_t * vm,
1127                vlib_node_runtime_t * node,
1128                vlib_node_type_t type,
1129                vlib_node_state_t dispatch_state,
1130                vlib_frame_t * frame, u64 last_time_stamp)
1131 {
1132   uword n, v;
1133   u64 t;
1134   vlib_node_main_t *nm = &vm->node_main;
1135   vlib_next_frame_t *nf;
1136   u64 pmc_before[2], pmc_after[2], pmc_delta[2];
1137
1138   if (CLIB_DEBUG > 0)
1139     {
1140       vlib_node_t *n = vlib_get_node (vm, node->node_index);
1141       ASSERT (n->type == type);
1142     }
1143
1144   /* Only non-internal nodes may be disabled. */
1145   if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
1146     {
1147       ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
1148       return last_time_stamp;
1149     }
1150
1151   if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
1152       && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
1153     {
1154       u32 c = node->input_main_loops_per_call;
1155       /* Only call node when count reaches zero. */
1156       if (c)
1157         {
1158           node->input_main_loops_per_call = c - 1;
1159           return last_time_stamp;
1160         }
1161     }
1162
1163   /* Speculatively prefetch next frames. */
1164   if (node->n_next_nodes > 0)
1165     {
1166       nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
1167       CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
1168     }
1169
1170   vm->cpu_time_last_node_dispatch = last_time_stamp;
1171
1172   vlib_elog_main_loop_event (vm, node->node_index,
1173                              last_time_stamp, frame ? frame->n_vectors : 0,
1174                              /* is_after */ 0);
1175
1176   vlib_node_runtime_perf_counter (vm, &pmc_before[0], &pmc_before[1]);
1177
1178   /*
1179    * Turn this on if you run into
1180    * "bad monkey" contexts, and you want to know exactly
1181    * which nodes they've visited... See ixge.c...
1182    */
1183   if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
1184     {
1185       int i;
1186       u32 *from;
1187       from = vlib_frame_vector_args (frame);
1188       for (i = 0; i < frame->n_vectors; i++)
1189         {
1190           vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1191           add_trajectory_trace (b, node->node_index);
1192         }
1193       if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1194         dispatch_pcap_trace (vm, node, frame);
1195       n = node->function (vm, node, frame);
1196     }
1197   else
1198     {
1199       if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1200         dispatch_pcap_trace (vm, node, frame);
1201       n = node->function (vm, node, frame);
1202     }
1203
1204   t = clib_cpu_time_now ();
1205
1206   /*
1207    * To validate accounting: pmc_delta = t - pmc_before;
1208    * perf ticks should equal clocks/pkt...
1209    */
1210   vlib_node_runtime_perf_counter (vm, &pmc_after[0], &pmc_after[1]);
1211
1212   pmc_delta[0] = pmc_after[0] - pmc_before[0];
1213   pmc_delta[1] = pmc_after[1] - pmc_before[1];
1214
1215   vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
1216
1217   vm->main_loop_vectors_processed += n;
1218   vm->main_loop_nodes_processed += n > 0;
1219
1220   v = vlib_node_runtime_update_stats (vm, node,
1221                                       /* n_calls */ 1,
1222                                       /* n_vectors */ n,
1223                                       /* n_clocks */ t - last_time_stamp,
1224                                       pmc_delta[0] /* PMC0 */ ,
1225                                       pmc_delta[1] /* PMC1 */ );
1226
1227   /* When in interrupt mode and vector rate crosses threshold switch to
1228      polling mode. */
1229   if (PREDICT_FALSE ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1230                      || (dispatch_state == VLIB_NODE_STATE_POLLING
1231                          && (node->flags
1232                              &
1233                              VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))))
1234     {
1235       /* *INDENT-OFF* */
1236       ELOG_TYPE_DECLARE (e) =
1237         {
1238           .function = (char *) __FUNCTION__,
1239           .format = "%s vector length %d, switching to %s",
1240           .format_args = "T4i4t4",
1241           .n_enum_strings = 2,
1242           .enum_strings = {
1243             "interrupt", "polling",
1244           },
1245         };
1246       /* *INDENT-ON* */
1247       struct
1248       {
1249         u32 node_name, vector_length, is_polling;
1250       } *ed;
1251
1252       if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1253            && v >= nm->polling_threshold_vector_length) &&
1254           !(node->flags &
1255             VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1256         {
1257           vlib_node_t *n = vlib_get_node (vm, node->node_index);
1258           n->state = VLIB_NODE_STATE_POLLING;
1259           node->state = VLIB_NODE_STATE_POLLING;
1260           node->flags &=
1261             ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1262           node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1263           nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1264           nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1265
1266           if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1267             {
1268               vlib_worker_thread_t *w = vlib_worker_threads
1269                 + vm->thread_index;
1270
1271               ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1272                                     w->elog_track);
1273               ed->node_name = n->name_elog_string;
1274               ed->vector_length = v;
1275               ed->is_polling = 1;
1276             }
1277         }
1278       else if (dispatch_state == VLIB_NODE_STATE_POLLING
1279                && v <= nm->interrupt_threshold_vector_length)
1280         {
1281           vlib_node_t *n = vlib_get_node (vm, node->node_index);
1282           if (node->flags &
1283               VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1284             {
1285               /* Switch to interrupt mode after dispatch in polling one more time.
1286                  This allows driver to re-enable interrupts. */
1287               n->state = VLIB_NODE_STATE_INTERRUPT;
1288               node->state = VLIB_NODE_STATE_INTERRUPT;
1289               node->flags &=
1290                 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1291               nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1292               nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
1293
1294             }
1295           else
1296             {
1297               vlib_worker_thread_t *w = vlib_worker_threads
1298                 + vm->thread_index;
1299               node->flags |=
1300                 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1301               if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1302                 {
1303                   ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1304                                         w->elog_track);
1305                   ed->node_name = n->name_elog_string;
1306                   ed->vector_length = v;
1307                   ed->is_polling = 0;
1308                 }
1309             }
1310         }
1311     }
1312
1313   return t;
1314 }
1315
1316 static u64
1317 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1318                        u64 last_time_stamp)
1319 {
1320   vlib_node_main_t *nm = &vm->node_main;
1321   vlib_frame_t *f;
1322   vlib_next_frame_t *nf, nf_dummy;
1323   vlib_node_runtime_t *n;
1324   u32 restore_frame_index;
1325   vlib_pending_frame_t *p;
1326
1327   /* See comment below about dangling references to nm->pending_frames */
1328   p = nm->pending_frames + pending_frame_index;
1329
1330   n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1331                         p->node_runtime_index);
1332
1333   f = vlib_get_frame (vm, p->frame_index);
1334   if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1335     {
1336       /* No next frame: so use dummy on stack. */
1337       nf = &nf_dummy;
1338       nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1339       nf->frame_index = ~p->frame_index;
1340     }
1341   else
1342     nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1343
1344   ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1345
1346   /* Force allocation of new frame while current frame is being
1347      dispatched. */
1348   restore_frame_index = ~0;
1349   if (nf->frame_index == p->frame_index)
1350     {
1351       nf->frame_index = ~0;
1352       nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1353       if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1354         restore_frame_index = p->frame_index;
1355     }
1356
1357   /* Frame must be pending. */
1358   ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1359   ASSERT (f->n_vectors > 0);
1360
1361   /* Copy trace flag from next frame to node.
1362      Trace flag indicates that at least one vector in the dispatched
1363      frame is traced. */
1364   n->flags &= ~VLIB_NODE_FLAG_TRACE;
1365   n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1366   nf->flags &= ~VLIB_FRAME_TRACE;
1367
1368   last_time_stamp = dispatch_node (vm, n,
1369                                    VLIB_NODE_TYPE_INTERNAL,
1370                                    VLIB_NODE_STATE_POLLING,
1371                                    f, last_time_stamp);
1372
1373   f->frame_flags &= ~VLIB_FRAME_PENDING;
1374
1375   /* Frame is ready to be used again, so restore it. */
1376   if (restore_frame_index != ~0)
1377     {
1378       /*
1379        * We musn't restore a frame that is flagged to be freed. This
1380        * shouldn't happen since frames to be freed post dispatch are
1381        * those used when the to-node frame becomes full i.e. they form a
1382        * sort of queue of frames to a single node. If we get here then
1383        * the to-node frame and the pending frame *were* the same, and so
1384        * we removed the to-node frame.  Therefore this frame is no
1385        * longer part of the queue for that node and hence it cannot be
1386        * it's overspill.
1387        */
1388       ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1389
1390       /*
1391        * NB: dispatching node n can result in the creation and scheduling
1392        * of new frames, and hence in the reallocation of nm->pending_frames.
1393        * Recompute p, or no supper. This was broken for more than 10 years.
1394        */
1395       p = nm->pending_frames + pending_frame_index;
1396
1397       /*
1398        * p->next_frame_index can change during node dispatch if node
1399        * function decides to change graph hook up.
1400        */
1401       nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1402       nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1403
1404       if (~0 == nf->frame_index)
1405         {
1406           /* no new frame has been assigned to this node, use the saved one */
1407           nf->frame_index = restore_frame_index;
1408           f->n_vectors = 0;
1409         }
1410       else
1411         {
1412           /* The node has gained a frame, implying packets from the current frame
1413              were re-queued to this same node. we don't need the saved one
1414              anymore */
1415           vlib_frame_free (vm, n, f);
1416         }
1417     }
1418   else
1419     {
1420       if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1421         {
1422           ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1423           vlib_frame_free (vm, n, f);
1424         }
1425     }
1426
1427   return last_time_stamp;
1428 }
1429
1430 always_inline uword
1431 vlib_process_stack_is_valid (vlib_process_t * p)
1432 {
1433   return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1434 }
1435
1436 typedef struct
1437 {
1438   vlib_main_t *vm;
1439   vlib_process_t *process;
1440   vlib_frame_t *frame;
1441 } vlib_process_bootstrap_args_t;
1442
1443 /* Called in process stack. */
1444 static uword
1445 vlib_process_bootstrap (uword _a)
1446 {
1447   vlib_process_bootstrap_args_t *a;
1448   vlib_main_t *vm;
1449   vlib_node_runtime_t *node;
1450   vlib_frame_t *f;
1451   vlib_process_t *p;
1452   uword n;
1453
1454   a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1455
1456   vm = a->vm;
1457   p = a->process;
1458   f = a->frame;
1459   node = &p->node_runtime;
1460
1461   n = node->function (vm, node, f);
1462
1463   ASSERT (vlib_process_stack_is_valid (p));
1464
1465   clib_longjmp (&p->return_longjmp, n);
1466
1467   return n;
1468 }
1469
1470 /* Called in main stack. */
1471 static_always_inline uword
1472 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1473 {
1474   vlib_process_bootstrap_args_t a;
1475   uword r;
1476
1477   a.vm = vm;
1478   a.process = p;
1479   a.frame = f;
1480
1481   r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1482   if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1483     r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1484                       (void *) p->stack + (1 << p->log2_n_stack_bytes));
1485
1486   return r;
1487 }
1488
1489 static_always_inline uword
1490 vlib_process_resume (vlib_process_t * p)
1491 {
1492   uword r;
1493   p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1494                 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1495                 | VLIB_PROCESS_RESUME_PENDING);
1496   r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1497   if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1498     clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1499   return r;
1500 }
1501
1502 static u64
1503 dispatch_process (vlib_main_t * vm,
1504                   vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1505 {
1506   vlib_node_main_t *nm = &vm->node_main;
1507   vlib_node_runtime_t *node_runtime = &p->node_runtime;
1508   vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1509   u32 old_process_index;
1510   u64 t;
1511   uword n_vectors, is_suspend;
1512
1513   if (node->state != VLIB_NODE_STATE_POLLING
1514       || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1515                       | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1516     return last_time_stamp;
1517
1518   p->flags |= VLIB_PROCESS_IS_RUNNING;
1519
1520   t = last_time_stamp;
1521   vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1522                              f ? f->n_vectors : 0, /* is_after */ 0);
1523
1524   /* Save away current process for suspend. */
1525   old_process_index = nm->current_process_index;
1526   nm->current_process_index = node->runtime_index;
1527
1528   n_vectors = vlib_process_startup (vm, p, f);
1529
1530   nm->current_process_index = old_process_index;
1531
1532   ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1533   is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1534   if (is_suspend)
1535     {
1536       vlib_pending_frame_t *pf;
1537
1538       n_vectors = 0;
1539       pool_get (nm->suspended_process_frames, pf);
1540       pf->node_runtime_index = node->runtime_index;
1541       pf->frame_index = f ? vlib_frame_index (vm, f) : ~0;
1542       pf->next_frame_index = ~0;
1543
1544       p->n_suspends += 1;
1545       p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1546
1547       if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1548         {
1549           TWT (tw_timer_wheel) * tw =
1550             (TWT (tw_timer_wheel) *) nm->timing_wheel;
1551           p->stop_timer_handle =
1552             TW (tw_timer_start) (tw,
1553                                  vlib_timing_wheel_data_set_suspended_process
1554                                  (node->runtime_index) /* [sic] pool idex */ ,
1555                                  0 /* timer_id */ ,
1556                                  p->resume_clock_interval);
1557         }
1558     }
1559   else
1560     p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1561
1562   t = clib_cpu_time_now ();
1563
1564   vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1565                              /* is_after */ 1);
1566
1567   vlib_process_update_stats (vm, p,
1568                              /* n_calls */ !is_suspend,
1569                              /* n_vectors */ n_vectors,
1570                              /* n_clocks */ t - last_time_stamp);
1571
1572   return t;
1573 }
1574
1575 void
1576 vlib_start_process (vlib_main_t * vm, uword process_index)
1577 {
1578   vlib_node_main_t *nm = &vm->node_main;
1579   vlib_process_t *p = vec_elt (nm->processes, process_index);
1580   dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1581 }
1582
1583 static u64
1584 dispatch_suspended_process (vlib_main_t * vm,
1585                             uword process_index, u64 last_time_stamp)
1586 {
1587   vlib_node_main_t *nm = &vm->node_main;
1588   vlib_node_runtime_t *node_runtime;
1589   vlib_node_t *node;
1590   vlib_frame_t *f;
1591   vlib_process_t *p;
1592   vlib_pending_frame_t *pf;
1593   u64 t, n_vectors, is_suspend;
1594
1595   t = last_time_stamp;
1596
1597   p = vec_elt (nm->processes, process_index);
1598   if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1599     return last_time_stamp;
1600
1601   ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1602                       | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1603
1604   pf = pool_elt_at_index (nm->suspended_process_frames,
1605                           p->suspended_process_frame_index);
1606
1607   node_runtime = &p->node_runtime;
1608   node = vlib_get_node (vm, node_runtime->node_index);
1609   f = pf->frame_index != ~0 ? vlib_get_frame (vm, pf->frame_index) : 0;
1610
1611   vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1612                              f ? f->n_vectors : 0, /* is_after */ 0);
1613
1614   /* Save away current process for suspend. */
1615   nm->current_process_index = node->runtime_index;
1616
1617   n_vectors = vlib_process_resume (p);
1618   t = clib_cpu_time_now ();
1619
1620   nm->current_process_index = ~0;
1621
1622   is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1623   if (is_suspend)
1624     {
1625       /* Suspend it again. */
1626       n_vectors = 0;
1627       p->n_suspends += 1;
1628       if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1629         {
1630           p->stop_timer_handle =
1631             TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1632                                  vlib_timing_wheel_data_set_suspended_process
1633                                  (node->runtime_index) /* [sic] pool idex */ ,
1634                                  0 /* timer_id */ ,
1635                                  p->resume_clock_interval);
1636         }
1637     }
1638   else
1639     {
1640       p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1641       pool_put_index (nm->suspended_process_frames,
1642                       p->suspended_process_frame_index);
1643       p->suspended_process_frame_index = ~0;
1644     }
1645
1646   t = clib_cpu_time_now ();
1647   vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1648                              /* is_after */ 1);
1649
1650   vlib_process_update_stats (vm, p,
1651                              /* n_calls */ !is_suspend,
1652                              /* n_vectors */ n_vectors,
1653                              /* n_clocks */ t - last_time_stamp);
1654
1655   return t;
1656 }
1657
1658 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1659 void
1660 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1661 {
1662 }
1663
1664
1665 static_always_inline void
1666 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1667 {
1668   vlib_node_main_t *nm = &vm->node_main;
1669   vlib_thread_main_t *tm = vlib_get_thread_main ();
1670   uword i;
1671   u64 cpu_time_now;
1672   vlib_frame_queue_main_t *fqm;
1673   u32 *last_node_runtime_indices = 0;
1674
1675   /* Initialize pending node vector. */
1676   if (is_main)
1677     {
1678       vec_resize (nm->pending_frames, 32);
1679       _vec_len (nm->pending_frames) = 0;
1680     }
1681
1682   /* Mark time of main loop start. */
1683   if (is_main)
1684     {
1685       cpu_time_now = vm->clib_time.last_cpu_time;
1686       vm->cpu_time_main_loop_start = cpu_time_now;
1687     }
1688   else
1689     cpu_time_now = clib_cpu_time_now ();
1690
1691   /* Pre-allocate interupt runtime indices and lock. */
1692   vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1693   vec_alloc (last_node_runtime_indices, 32);
1694   if (!is_main)
1695     clib_spinlock_init (&nm->pending_interrupt_lock);
1696
1697   /* Pre-allocate expired nodes. */
1698   if (!nm->polling_threshold_vector_length)
1699     nm->polling_threshold_vector_length = 10;
1700   if (!nm->interrupt_threshold_vector_length)
1701     nm->interrupt_threshold_vector_length = 5;
1702
1703   vm->cpu_id = clib_get_current_cpu_id ();
1704   vm->numa_node = clib_get_current_numa_node ();
1705
1706   /* Start all processes. */
1707   if (is_main)
1708     {
1709       uword i;
1710       nm->current_process_index = ~0;
1711       for (i = 0; i < vec_len (nm->processes); i++)
1712         cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1713                                          cpu_time_now);
1714     }
1715
1716   while (1)
1717     {
1718       vlib_node_runtime_t *n;
1719
1720       if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1721         {
1722           if (!is_main)
1723             vl_api_send_pending_rpc_requests (vm);
1724         }
1725
1726       if (!is_main)
1727         {
1728           vlib_worker_thread_barrier_check ();
1729           vec_foreach (fqm, tm->frame_queue_mains)
1730             vlib_frame_queue_dequeue (vm, fqm);
1731           if (PREDICT_FALSE (vm->worker_thread_main_loop_callback != 0))
1732             ((void (*)(vlib_main_t *)) vm->worker_thread_main_loop_callback)
1733               (vm);
1734         }
1735
1736       /* Process pre-input nodes. */
1737       vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1738         cpu_time_now = dispatch_node (vm, n,
1739                                       VLIB_NODE_TYPE_PRE_INPUT,
1740                                       VLIB_NODE_STATE_POLLING,
1741                                       /* frame */ 0,
1742                                       cpu_time_now);
1743
1744       /* Next process input nodes. */
1745       vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1746         cpu_time_now = dispatch_node (vm, n,
1747                                       VLIB_NODE_TYPE_INPUT,
1748                                       VLIB_NODE_STATE_POLLING,
1749                                       /* frame */ 0,
1750                                       cpu_time_now);
1751
1752       if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1753         vm->queue_signal_callback (vm);
1754
1755       /* Next handle interrupts. */
1756       {
1757         /* unlocked read, for performance */
1758         uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1759         uword i;
1760         if (PREDICT_FALSE (l > 0))
1761           {
1762             u32 *tmp;
1763             if (!is_main)
1764               {
1765                 clib_spinlock_lock (&nm->pending_interrupt_lock);
1766                 /* Re-read w/ lock held, in case another thread added an item */
1767                 l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1768               }
1769
1770             tmp = nm->pending_interrupt_node_runtime_indices;
1771             nm->pending_interrupt_node_runtime_indices =
1772               last_node_runtime_indices;
1773             last_node_runtime_indices = tmp;
1774             _vec_len (last_node_runtime_indices) = 0;
1775             if (!is_main)
1776               clib_spinlock_unlock (&nm->pending_interrupt_lock);
1777             for (i = 0; i < l; i++)
1778               {
1779                 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1780                                       last_node_runtime_indices[i]);
1781                 cpu_time_now =
1782                   dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1783                                  VLIB_NODE_STATE_INTERRUPT,
1784                                  /* frame */ 0,
1785                                  cpu_time_now);
1786               }
1787           }
1788       }
1789       /* Input nodes may have added work to the pending vector.
1790          Process pending vector until there is nothing left.
1791          All pending vectors will be processed from input -> output. */
1792       for (i = 0; i < _vec_len (nm->pending_frames); i++)
1793         cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1794       /* Reset pending vector for next iteration. */
1795       _vec_len (nm->pending_frames) = 0;
1796
1797       if (is_main)
1798         {
1799           /* *INDENT-OFF* */
1800           ELOG_TYPE_DECLARE (es) =
1801             {
1802               .format = "process tw start",
1803               .format_args = "",
1804             };
1805           ELOG_TYPE_DECLARE (ee) =
1806             {
1807               .format = "process tw end: %d",
1808               .format_args = "i4",
1809             };
1810           /* *INDENT-ON* */
1811
1812           struct
1813           {
1814             int nready_procs;
1815           } *ed;
1816
1817           /* Check if process nodes have expired from timing wheel. */
1818           ASSERT (nm->data_from_advancing_timing_wheel != 0);
1819
1820           if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1821             ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1822
1823           nm->data_from_advancing_timing_wheel =
1824             TW (tw_timer_expire_timers_vec)
1825             ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1826              nm->data_from_advancing_timing_wheel);
1827
1828           ASSERT (nm->data_from_advancing_timing_wheel != 0);
1829
1830           if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1831             {
1832               ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1833               ed->nready_procs =
1834                 _vec_len (nm->data_from_advancing_timing_wheel);
1835             }
1836
1837           if (PREDICT_FALSE
1838               (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1839             {
1840               uword i;
1841
1842               for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1843                    i++)
1844                 {
1845                   u32 d = nm->data_from_advancing_timing_wheel[i];
1846                   u32 di = vlib_timing_wheel_data_get_index (d);
1847
1848                   if (vlib_timing_wheel_data_is_timed_event (d))
1849                     {
1850                       vlib_signal_timed_event_data_t *te =
1851                         pool_elt_at_index (nm->signal_timed_event_data_pool,
1852                                            di);
1853                       vlib_node_t *n =
1854                         vlib_get_node (vm, te->process_node_index);
1855                       vlib_process_t *p =
1856                         vec_elt (nm->processes, n->runtime_index);
1857                       void *data;
1858                       data =
1859                         vlib_process_signal_event_helper (nm, n, p,
1860                                                           te->event_type_index,
1861                                                           te->n_data_elts,
1862                                                           te->n_data_elt_bytes);
1863                       if (te->n_data_bytes < sizeof (te->inline_event_data))
1864                         clib_memcpy_fast (data, te->inline_event_data,
1865                                           te->n_data_bytes);
1866                       else
1867                         {
1868                           clib_memcpy_fast (data, te->event_data_as_vector,
1869                                             te->n_data_bytes);
1870                           vec_free (te->event_data_as_vector);
1871                         }
1872                       pool_put (nm->signal_timed_event_data_pool, te);
1873                     }
1874                   else
1875                     {
1876                       cpu_time_now = clib_cpu_time_now ();
1877                       cpu_time_now =
1878                         dispatch_suspended_process (vm, di, cpu_time_now);
1879                     }
1880                 }
1881               _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1882             }
1883         }
1884       vlib_increment_main_loop_counter (vm);
1885
1886       /* Record time stamp in case there are no enabled nodes and above
1887          calls do not update time stamp. */
1888       cpu_time_now = clib_cpu_time_now ();
1889     }
1890 }
1891
1892 static void
1893 vlib_main_loop (vlib_main_t * vm)
1894 {
1895   vlib_main_or_worker_loop (vm, /* is_main */ 1);
1896 }
1897
1898 void
1899 vlib_worker_loop (vlib_main_t * vm)
1900 {
1901   vlib_main_or_worker_loop (vm, /* is_main */ 0);
1902 }
1903
1904 vlib_main_t vlib_global_main;
1905
1906 static clib_error_t *
1907 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1908 {
1909   int turn_on_mem_trace = 0;
1910
1911   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1912     {
1913       if (unformat (input, "memory-trace"))
1914         turn_on_mem_trace = 1;
1915
1916       else if (unformat (input, "elog-events %d",
1917                          &vm->elog_main.event_ring_size))
1918         ;
1919       else if (unformat (input, "elog-post-mortem-dump"))
1920         vm->elog_post_mortem_dump = 1;
1921       else
1922         return unformat_parse_error (input);
1923     }
1924
1925   unformat_free (input);
1926
1927   /* Enable memory trace as early as possible. */
1928   if (turn_on_mem_trace)
1929     clib_mem_trace (1);
1930
1931   return 0;
1932 }
1933
1934 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1935
1936 static void
1937 dummy_queue_signal_callback (vlib_main_t * vm)
1938 {
1939 }
1940
1941 #define foreach_weak_reference_stub             \
1942 _(vlib_map_stat_segment_init)                   \
1943 _(vpe_api_init)                                 \
1944 _(vlibmemory_init)                              \
1945 _(map_api_segment_init)
1946
1947 #define _(name)                                                 \
1948 clib_error_t *name (vlib_main_t *vm) __attribute__((weak));     \
1949 clib_error_t *name (vlib_main_t *vm) { return 0; }
1950 foreach_weak_reference_stub;
1951 #undef _
1952
1953 /* Main function. */
1954 int
1955 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
1956 {
1957   clib_error_t *volatile error;
1958   vlib_node_main_t *nm = &vm->node_main;
1959
1960   vm->queue_signal_callback = dummy_queue_signal_callback;
1961
1962   clib_time_init (&vm->clib_time);
1963
1964   /* Turn on event log. */
1965   if (!vm->elog_main.event_ring_size)
1966     vm->elog_main.event_ring_size = 128 << 10;
1967   elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
1968   elog_enable_disable (&vm->elog_main, 1);
1969
1970   /* Default name. */
1971   if (!vm->name)
1972     vm->name = "VLIB";
1973
1974   if ((error = vlib_physmem_init (vm)))
1975     {
1976       clib_error_report (error);
1977       goto done;
1978     }
1979
1980   if ((error = vlib_buffer_main_init (vm)))
1981     {
1982       clib_error_report (error);
1983       goto done;
1984     }
1985
1986   if ((error = vlib_thread_init (vm)))
1987     {
1988       clib_error_report (error);
1989       goto done;
1990     }
1991
1992   if ((error = vlib_map_stat_segment_init (vm)))
1993     {
1994       clib_error_report (error);
1995       goto done;
1996     }
1997
1998   /* Register static nodes so that init functions may use them. */
1999   vlib_register_all_static_nodes (vm);
2000
2001   /* Set seed for random number generator.
2002      Allow user to specify seed to make random sequence deterministic. */
2003   if (!unformat (input, "seed %wd", &vm->random_seed))
2004     vm->random_seed = clib_cpu_time_now ();
2005   clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
2006
2007   /* Initialize node graph. */
2008   if ((error = vlib_node_main_init (vm)))
2009     {
2010       /* Arrange for graph hook up error to not be fatal when debugging. */
2011       if (CLIB_DEBUG > 0)
2012         clib_error_report (error);
2013       else
2014         goto done;
2015     }
2016
2017   /* Direct call / weak reference, for vlib standalone use-cases */
2018   if ((error = vpe_api_init (vm)))
2019     {
2020       clib_error_report (error);
2021       goto done;
2022     }
2023
2024   if ((error = vlibmemory_init (vm)))
2025     {
2026       clib_error_report (error);
2027       goto done;
2028     }
2029
2030   if ((error = map_api_segment_init (vm)))
2031     {
2032       clib_error_report (error);
2033       goto done;
2034     }
2035
2036   /* See unix/main.c; most likely already set up */
2037   if (vm->init_functions_called == 0)
2038     vm->init_functions_called = hash_create (0, /* value bytes */ 0);
2039   if ((error = vlib_call_all_init_functions (vm)))
2040     goto done;
2041
2042   nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
2043                                              CLIB_CACHE_LINE_BYTES);
2044
2045   vec_validate (nm->data_from_advancing_timing_wheel, 10);
2046   _vec_len (nm->data_from_advancing_timing_wheel) = 0;
2047
2048   /* Create the process timing wheel */
2049   TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
2050                             0 /* no callback */ ,
2051                             10e-6 /* timer period 10us */ ,
2052                             ~0 /* max expirations per call */ );
2053
2054   vec_validate (vm->pending_rpc_requests, 0);
2055   _vec_len (vm->pending_rpc_requests) = 0;
2056   vec_validate (vm->processing_rpc_requests, 0);
2057   _vec_len (vm->processing_rpc_requests) = 0;
2058
2059   switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2060     {
2061     case VLIB_MAIN_LOOP_EXIT_NONE:
2062       vm->main_loop_exit_set = 1;
2063       break;
2064
2065     case VLIB_MAIN_LOOP_EXIT_CLI:
2066       goto done;
2067
2068     default:
2069       error = vm->main_loop_error;
2070       goto done;
2071     }
2072
2073   if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
2074     goto done;
2075
2076   /* Call all main loop enter functions. */
2077   {
2078     clib_error_t *sub_error;
2079     sub_error = vlib_call_all_main_loop_enter_functions (vm);
2080     if (sub_error)
2081       clib_error_report (sub_error);
2082   }
2083
2084   vlib_main_loop (vm);
2085
2086 done:
2087   /* Call all exit functions. */
2088   {
2089     clib_error_t *sub_error;
2090     sub_error = vlib_call_all_main_loop_exit_functions (vm);
2091     if (sub_error)
2092       clib_error_report (sub_error);
2093   }
2094
2095   if (error)
2096     clib_error_report (error);
2097
2098   return 0;
2099 }
2100
2101 static inline clib_error_t *
2102 pcap_dispatch_trace_command_internal (vlib_main_t * vm,
2103                                       unformat_input_t * input,
2104                                       vlib_cli_command_t * cmd, int rx_tx)
2105 {
2106 #define PCAP_DEF_PKT_TO_CAPTURE (100)
2107
2108   unformat_input_t _line_input, *line_input = &_line_input;
2109   pcap_main_t *pm = &vm->dispatch_pcap_main;
2110   u8 *filename;
2111   u8 *chroot_filename = 0;
2112   u32 max = 0;
2113   int enabled = 0;
2114   int errorFlag = 0;
2115   clib_error_t *error = 0;
2116   u32 node_index, add;
2117   vlib_trace_main_t *tm;
2118   vlib_trace_node_t *tn;
2119
2120   /* Get a line of input. */
2121   if (!unformat_user (input, unformat_line_input, line_input))
2122     return 0;
2123
2124   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2125     {
2126       if (unformat (line_input, "on"))
2127         {
2128           if (vm->dispatch_pcap_enable == 0)
2129             {
2130               enabled = 1;
2131             }
2132           else
2133             {
2134               vlib_cli_output (vm, "pcap dispatch capture already on...");
2135               errorFlag = 1;
2136               break;
2137             }
2138         }
2139       else if (unformat (line_input, "off"))
2140         {
2141           if (vm->dispatch_pcap_enable)
2142             {
2143               vlib_cli_output
2144                 (vm, "captured %d pkts...", pm->n_packets_captured);
2145               if (pm->n_packets_captured)
2146                 {
2147                   pm->n_packets_to_capture = pm->n_packets_captured;
2148                   error = pcap_write (pm);
2149                   if (error)
2150                     clib_error_report (error);
2151                   else
2152                     vlib_cli_output (vm, "saved to %s...", pm->file_name);
2153                 }
2154               vm->dispatch_pcap_enable = 0;
2155             }
2156           else
2157             {
2158               vlib_cli_output (vm, "pcap tx capture already off...");
2159               errorFlag = 1;
2160               break;
2161             }
2162         }
2163       else if (unformat (line_input, "max %d", &max))
2164         {
2165           if (vm->dispatch_pcap_enable)
2166             {
2167               vlib_cli_output
2168                 (vm,
2169                  "can't change max value while pcap tx capture active...");
2170               errorFlag = 1;
2171               break;
2172             }
2173           pm->n_packets_to_capture = max;
2174         }
2175       else
2176         if (unformat
2177             (line_input, "file %U", unformat_vlib_tmpfile, &filename))
2178         {
2179           if (vm->dispatch_pcap_enable)
2180             {
2181               vlib_cli_output
2182                 (vm, "can't change file while pcap tx capture active...");
2183               errorFlag = 1;
2184               break;
2185             }
2186         }
2187       else if (unformat (line_input, "status"))
2188         {
2189           if (vm->dispatch_pcap_enable)
2190             {
2191               vlib_cli_output
2192                 (vm, "pcap dispatch capture is on: %d of %d pkts...",
2193                  pm->n_packets_captured, pm->n_packets_to_capture);
2194               vlib_cli_output (vm, "Capture to file %s", pm->file_name);
2195             }
2196           else
2197             {
2198               vlib_cli_output (vm, "pcap dispatch capture is off...");
2199             }
2200           break;
2201         }
2202       else if (unformat (line_input, "buffer-trace %U %d",
2203                          unformat_vlib_node, vm, &node_index, &add))
2204         {
2205           if (vnet_trace_dummy == 0)
2206             vec_validate_aligned (vnet_trace_dummy, 2048,
2207                                   CLIB_CACHE_LINE_BYTES);
2208           vlib_cli_output (vm, "Buffer tracing of %d pkts from %U enabled...",
2209                            add, format_vlib_node_name, vm, node_index);
2210
2211           /* *INDENT-OFF* */
2212           foreach_vlib_main ((
2213             {
2214               tm = &this_vlib_main->trace_main;
2215               tm->verbose = 0;  /* not sure this ever did anything... */
2216               vec_validate (tm->nodes, node_index);
2217               tn = tm->nodes + node_index;
2218               tn->limit += add;
2219               tm->trace_enable = 1;
2220             }));
2221           /* *INDENT-ON* */
2222         }
2223
2224       else
2225         {
2226           error = clib_error_return (0, "unknown input `%U'",
2227                                      format_unformat_error, line_input);
2228           errorFlag = 1;
2229           break;
2230         }
2231     }
2232   unformat_free (line_input);
2233
2234
2235   if (errorFlag == 0)
2236     {
2237       /* Since no error, save configured values. */
2238       if (chroot_filename)
2239         {
2240           if (pm->file_name)
2241             vec_free (pm->file_name);
2242           vec_add1 (chroot_filename, 0);
2243           pm->file_name = (char *) chroot_filename;
2244         }
2245
2246       if (max)
2247         pm->n_packets_to_capture = max;
2248
2249       if (enabled)
2250         {
2251           if (pm->file_name == 0)
2252             pm->file_name = (char *) format (0, "/tmp/dispatch.pcap%c", 0);
2253
2254           pm->n_packets_captured = 0;
2255           pm->packet_type = PCAP_PACKET_TYPE_vpp;
2256           if (pm->lock == 0)
2257             clib_spinlock_init (&(pm->lock));
2258           vm->dispatch_pcap_enable = 1;
2259           vlib_cli_output (vm, "pcap dispatch capture on...");
2260         }
2261     }
2262   else if (chroot_filename)
2263     vec_free (chroot_filename);
2264
2265   return error;
2266 }
2267
2268 static clib_error_t *
2269 pcap_dispatch_trace_command_fn (vlib_main_t * vm,
2270                                 unformat_input_t * input,
2271                                 vlib_cli_command_t * cmd)
2272 {
2273   return pcap_dispatch_trace_command_internal (vm, input, cmd, VLIB_RX);
2274 }
2275
2276 /*?
2277  * This command is used to start or stop pcap dispatch trace capture, or show
2278  * the capture status.
2279  *
2280  * This command has the following optional parameters:
2281  *
2282  * - <b>on|off</b> - Used to start or stop capture.
2283  *
2284  * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2285  *   of packets have been received, buffer is flushed to file. Once another
2286  *   '<em>nn</em>' number of packets have been received, buffer is flushed
2287  *   to file, overwriting previous write. If not entered, value defaults
2288  *   to 100. Can only be updated if packet capture is off.
2289  *
2290  * - <b>file <name></b> - Used to specify the output filename. The file will
2291  *   be placed in the '<em>/tmp</em>' directory, so only the filename is
2292  *   supported. Directory should not be entered. If file already exists, file
2293  *   will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
2294  *   will be used. Can only be updated if packet capture is off.
2295  *
2296  * - <b>status</b> - Displays the current status and configured attributes
2297  *   associated with a packet capture. If packet capture is in progress,
2298  *   '<em>status</em>' also will return the number of packets currently in
2299  *   the local buffer. All additional attributes entered on command line
2300  *   with '<em>status</em>' will be ignored and not applied.
2301  *
2302  * @cliexpar
2303  * Example of how to display the status of capture when off:
2304  * @cliexstart{pcap dispatch trace status}
2305  * max is 100, for any interface to file /tmp/vpe.pcap
2306  * pcap dispatch capture is off...
2307  * @cliexend
2308  * Example of how to start a dispatch trace capture:
2309  * @cliexstart{pcap dispatch trace on max 35 file dispatchTrace.pcap}
2310  * pcap dispatch capture on...
2311  * @cliexend
2312  * Example of how to start a dispatch trace capture with buffer tracing
2313  * @cliexstart{pcap dispatch trace on max 10000 file dispatchTrace.pcap buffer-trace dpdk-input 1000}
2314  * pcap dispatch capture on...
2315  * @cliexend
2316  * Example of how to display the status of a tx packet capture in progress:
2317  * @cliexstart{pcap tx trace status}
2318  * max is 35, dispatch trace to file /tmp/vppTest.pcap
2319  * pcap tx capture is on: 20 of 35 pkts...
2320  * @cliexend
2321  * Example of how to stop a tx packet capture:
2322  * @cliexstart{vppctl pcap dispatch trace off}
2323  * captured 21 pkts...
2324  * saved to /tmp/dispatchTrace.pcap...
2325  * @cliexend
2326 ?*/
2327 /* *INDENT-OFF* */
2328 VLIB_CLI_COMMAND (pcap_dispatch_trace_command, static) = {
2329     .path = "pcap dispatch trace",
2330     .short_help =
2331     "pcap dispatch trace [on|off] [max <nn>] [file <name>] [status]\n"
2332     "              [buffer-trace <input-node-name> <nn>]",
2333     .function = pcap_dispatch_trace_command_fn,
2334 };
2335 /* *INDENT-ON* */
2336
2337 /*
2338  * fd.io coding-style-patch-verification: ON
2339  *
2340  * Local Variables:
2341  * eval: (c-set-style "gnu")
2342  * End:
2343  */