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