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