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 (vec_len (vm->vlib_node_runtime_perf_counter_cbs) != 0))
 691     clib_call_callbacks (vm->vlib_node_runtime_perf_counter_cbs, vm, pmc0,
 692                          pmc1, node, 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_handle: 0x%x, len_not_first_buf: %d\n",
1023               b->trace_handle, 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,
1095                                      vlib_buffer_get_trace_index (b));
1096
1097               vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1098                                         format_vlib_trace, vm, h[0], 0);
1099               string_count++;
1100             }
1101
1102           /* Save the string count */
1103           vm->pcap_buffer[2] = string_count;
1104
1105           /* Figure out how many bytes in the pcap trace */
1106           capture_size = vec_len (vm->pcap_buffer) +
1107             +vlib_buffer_length_in_chain (vm, b);
1108
1109           clib_spinlock_lock_if_init (&pm->lock);
1110           n_left = clib_min (capture_size, 16384);
1111           d = pcap_add_packet (pm, time_now, n_left, capture_size);
1112
1113           /* Copy the header */
1114           clib_memcpy_fast (d, vm->pcap_buffer, vec_len (vm->pcap_buffer));
1115           d += vec_len (vm->pcap_buffer);
1116
1117           n_left = clib_min
1118             (vlib_buffer_length_in_chain (vm, b),
1119              (16384 - vec_len (vm->pcap_buffer)));
1120           /* Copy the packet data */
1121           while (1)
1122             {
1123               u32 copy_length = clib_min ((u32) n_left, b->current_length);
1124               clib_memcpy_fast (d, b->data + b->current_data, copy_length);
1125               n_left -= b->current_length;
1126               if (n_left <= 0)
1127                 break;
1128               d += b->current_length;
1129               ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
1130               b = vlib_get_buffer (vm, b->next_buffer);
1131             }
1132           clib_spinlock_unlock_if_init (&pm->lock);
1133         }
1134     }
1135 }
1136
1137 static_always_inline u64
1138 dispatch_node (vlib_main_t * vm,
1139                vlib_node_runtime_t * node,
1140                vlib_node_type_t type,
1141                vlib_node_state_t dispatch_state,
1142                vlib_frame_t * frame, u64 last_time_stamp)
1143 {
1144   uword n, v;
1145   u64 t;
1146   vlib_node_main_t *nm = &vm->node_main;
1147   vlib_next_frame_t *nf;
1148   u64 pmc_before[2], pmc_after[2], pmc_delta[2];
1149
1150   if (CLIB_DEBUG > 0)
1151     {
1152       vlib_node_t *n = vlib_get_node (vm, node->node_index);
1153       ASSERT (n->type == type);
1154     }
1155
1156   /* Only non-internal nodes may be disabled. */
1157   if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
1158     {
1159       ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
1160       return last_time_stamp;
1161     }
1162
1163   if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
1164       && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
1165     {
1166       u32 c = node->input_main_loops_per_call;
1167       /* Only call node when count reaches zero. */
1168       if (c)
1169         {
1170           node->input_main_loops_per_call = c - 1;
1171           return last_time_stamp;
1172         }
1173     }
1174
1175   /* Speculatively prefetch next frames. */
1176   if (node->n_next_nodes > 0)
1177     {
1178       nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
1179       CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
1180     }
1181
1182   vm->cpu_time_last_node_dispatch = last_time_stamp;
1183
1184   vlib_elog_main_loop_event (vm, node->node_index,
1185                              last_time_stamp, frame ? frame->n_vectors : 0,
1186                              /* is_after */ 0);
1187
1188   vlib_node_runtime_perf_counter (vm, &pmc_before[0], &pmc_before[1],
1189                                   node, frame, 0 /* before */ );
1190
1191   /*
1192    * Turn this on if you run into
1193    * "bad monkey" contexts, and you want to know exactly
1194    * which nodes they've visited... See ixge.c...
1195    */
1196   if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
1197     {
1198       int i;
1199       u32 *from;
1200       from = vlib_frame_vector_args (frame);
1201       for (i = 0; i < frame->n_vectors; i++)
1202         {
1203           vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1204           add_trajectory_trace (b, node->node_index);
1205         }
1206       if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1207         dispatch_pcap_trace (vm, node, frame);
1208       n = node->function (vm, node, frame);
1209     }
1210   else
1211     {
1212       if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1213         dispatch_pcap_trace (vm, node, frame);
1214       n = node->function (vm, node, frame);
1215     }
1216
1217   t = clib_cpu_time_now ();
1218
1219   /*
1220    * To validate accounting: pmc_delta = t - pmc_before;
1221    * perf ticks should equal clocks/pkt...
1222    */
1223   vlib_node_runtime_perf_counter (vm, &pmc_after[0], &pmc_after[1], node,
1224                                   frame, 1 /* after */ );
1225
1226   pmc_delta[0] = pmc_after[0] - pmc_before[0];
1227   pmc_delta[1] = pmc_after[1] - pmc_before[1];
1228
1229   vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
1230
1231   vm->main_loop_vectors_processed += n;
1232   vm->main_loop_nodes_processed += n > 0;
1233
1234   v = vlib_node_runtime_update_stats (vm, node,
1235                                       /* n_calls */ 1,
1236                                       /* n_vectors */ n,
1237                                       /* n_clocks */ t - last_time_stamp,
1238                                       pmc_delta[0] /* PMC0 */ ,
1239                                       pmc_delta[1] /* PMC1 */ );
1240
1241   /* When in interrupt mode and vector rate crosses threshold switch to
1242      polling mode. */
1243   if (PREDICT_FALSE ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1244                      || (dispatch_state == VLIB_NODE_STATE_POLLING
1245                          && (node->flags
1246                              &
1247                              VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))))
1248     {
1249       /* *INDENT-OFF* */
1250       ELOG_TYPE_DECLARE (e) =
1251         {
1252           .function = (char *) __FUNCTION__,
1253           .format = "%s vector length %d, switching to %s",
1254           .format_args = "T4i4t4",
1255           .n_enum_strings = 2,
1256           .enum_strings = {
1257             "interrupt", "polling",
1258           },
1259         };
1260       /* *INDENT-ON* */
1261       struct
1262       {
1263         u32 node_name, vector_length, is_polling;
1264       } *ed;
1265
1266       if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1267            && v >= nm->polling_threshold_vector_length) &&
1268           !(node->flags &
1269             VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1270         {
1271           vlib_node_t *n = vlib_get_node (vm, node->node_index);
1272           n->state = VLIB_NODE_STATE_POLLING;
1273           node->state = VLIB_NODE_STATE_POLLING;
1274           node->flags &=
1275             ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1276           node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1277           nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1278           nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1279
1280           if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1281             {
1282               vlib_worker_thread_t *w = vlib_worker_threads
1283                 + vm->thread_index;
1284
1285               ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1286                                     w->elog_track);
1287               ed->node_name = n->name_elog_string;
1288               ed->vector_length = v;
1289               ed->is_polling = 1;
1290             }
1291         }
1292       else if (dispatch_state == VLIB_NODE_STATE_POLLING
1293                && v <= nm->interrupt_threshold_vector_length)
1294         {
1295           vlib_node_t *n = vlib_get_node (vm, node->node_index);
1296           if (node->flags &
1297               VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1298             {
1299               /* Switch to interrupt mode after dispatch in polling one more time.
1300                  This allows driver to re-enable interrupts. */
1301               n->state = VLIB_NODE_STATE_INTERRUPT;
1302               node->state = VLIB_NODE_STATE_INTERRUPT;
1303               node->flags &=
1304                 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1305               nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1306               nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
1307
1308             }
1309           else
1310             {
1311               vlib_worker_thread_t *w = vlib_worker_threads
1312                 + vm->thread_index;
1313               node->flags |=
1314                 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1315               if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1316                 {
1317                   ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1318                                         w->elog_track);
1319                   ed->node_name = n->name_elog_string;
1320                   ed->vector_length = v;
1321                   ed->is_polling = 0;
1322                 }
1323             }
1324         }
1325     }
1326
1327   return t;
1328 }
1329
1330 static u64
1331 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1332                        u64 last_time_stamp)
1333 {
1334   vlib_node_main_t *nm = &vm->node_main;
1335   vlib_frame_t *f;
1336   vlib_next_frame_t *nf, nf_dummy;
1337   vlib_node_runtime_t *n;
1338   u32 restore_frame_index;
1339   vlib_pending_frame_t *p;
1340
1341   /* See comment below about dangling references to nm->pending_frames */
1342   p = nm->pending_frames + pending_frame_index;
1343
1344   n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1345                         p->node_runtime_index);
1346
1347   f = vlib_get_frame (vm, p->frame_index);
1348   if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1349     {
1350       /* No next frame: so use dummy on stack. */
1351       nf = &nf_dummy;
1352       nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1353       nf->frame_index = ~p->frame_index;
1354     }
1355   else
1356     nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1357
1358   ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1359
1360   /* Force allocation of new frame while current frame is being
1361      dispatched. */
1362   restore_frame_index = ~0;
1363   if (nf->frame_index == p->frame_index)
1364     {
1365       nf->frame_index = ~0;
1366       nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1367       if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1368         restore_frame_index = p->frame_index;
1369     }
1370
1371   /* Frame must be pending. */
1372   ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1373   ASSERT (f->n_vectors > 0);
1374
1375   /* Copy trace flag from next frame to node.
1376      Trace flag indicates that at least one vector in the dispatched
1377      frame is traced. */
1378   n->flags &= ~VLIB_NODE_FLAG_TRACE;
1379   n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1380   nf->flags &= ~VLIB_FRAME_TRACE;
1381
1382   last_time_stamp = dispatch_node (vm, n,
1383                                    VLIB_NODE_TYPE_INTERNAL,
1384                                    VLIB_NODE_STATE_POLLING,
1385                                    f, last_time_stamp);
1386
1387   f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
1388
1389   /* Frame is ready to be used again, so restore it. */
1390   if (restore_frame_index != ~0)
1391     {
1392       /*
1393        * We musn't restore a frame that is flagged to be freed. This
1394        * shouldn't happen since frames to be freed post dispatch are
1395        * those used when the to-node frame becomes full i.e. they form a
1396        * sort of queue of frames to a single node. If we get here then
1397        * the to-node frame and the pending frame *were* the same, and so
1398        * we removed the to-node frame.  Therefore this frame is no
1399        * longer part of the queue for that node and hence it cannot be
1400        * it's overspill.
1401        */
1402       ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1403
1404       /*
1405        * NB: dispatching node n can result in the creation and scheduling
1406        * of new frames, and hence in the reallocation of nm->pending_frames.
1407        * Recompute p, or no supper. This was broken for more than 10 years.
1408        */
1409       p = nm->pending_frames + pending_frame_index;
1410
1411       /*
1412        * p->next_frame_index can change during node dispatch if node
1413        * function decides to change graph hook up.
1414        */
1415       nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1416       nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1417
1418       if (~0 == nf->frame_index)
1419         {
1420           /* no new frame has been assigned to this node, use the saved one */
1421           nf->frame_index = restore_frame_index;
1422           f->n_vectors = 0;
1423         }
1424       else
1425         {
1426           /* The node has gained a frame, implying packets from the current frame
1427              were re-queued to this same node. we don't need the saved one
1428              anymore */
1429           vlib_frame_free (vm, n, f);
1430         }
1431     }
1432   else
1433     {
1434       if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1435         {
1436           ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1437           vlib_frame_free (vm, n, f);
1438         }
1439     }
1440
1441   return last_time_stamp;
1442 }
1443
1444 always_inline uword
1445 vlib_process_stack_is_valid (vlib_process_t * p)
1446 {
1447   return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1448 }
1449
1450 typedef struct
1451 {
1452   vlib_main_t *vm;
1453   vlib_process_t *process;
1454   vlib_frame_t *frame;
1455 } vlib_process_bootstrap_args_t;
1456
1457 /* Called in process stack. */
1458 static uword
1459 vlib_process_bootstrap (uword _a)
1460 {
1461   vlib_process_bootstrap_args_t *a;
1462   vlib_main_t *vm;
1463   vlib_node_runtime_t *node;
1464   vlib_frame_t *f;
1465   vlib_process_t *p;
1466   uword n;
1467
1468   a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1469
1470   vm = a->vm;
1471   p = a->process;
1472   f = a->frame;
1473   node = &p->node_runtime;
1474
1475   n = node->function (vm, node, f);
1476
1477   ASSERT (vlib_process_stack_is_valid (p));
1478
1479   clib_longjmp (&p->return_longjmp, n);
1480
1481   return n;
1482 }
1483
1484 /* Called in main stack. */
1485 static_always_inline uword
1486 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1487 {
1488   vlib_process_bootstrap_args_t a;
1489   uword r;
1490
1491   a.vm = vm;
1492   a.process = p;
1493   a.frame = f;
1494
1495   r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1496   if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1497     r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1498                       (void *) p->stack + (1 << p->log2_n_stack_bytes));
1499
1500   return r;
1501 }
1502
1503 static_always_inline uword
1504 vlib_process_resume (vlib_process_t * p)
1505 {
1506   uword r;
1507   p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1508                 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1509                 | VLIB_PROCESS_RESUME_PENDING);
1510   r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1511   if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1512     clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1513   return r;
1514 }
1515
1516 static u64
1517 dispatch_process (vlib_main_t * vm,
1518                   vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1519 {
1520   vlib_node_main_t *nm = &vm->node_main;
1521   vlib_node_runtime_t *node_runtime = &p->node_runtime;
1522   vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1523   u32 old_process_index;
1524   u64 t;
1525   uword n_vectors, is_suspend;
1526
1527   if (node->state != VLIB_NODE_STATE_POLLING
1528       || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1529                       | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1530     return last_time_stamp;
1531
1532   p->flags |= VLIB_PROCESS_IS_RUNNING;
1533
1534   t = last_time_stamp;
1535   vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1536                              f ? f->n_vectors : 0, /* is_after */ 0);
1537
1538   /* Save away current process for suspend. */
1539   old_process_index = nm->current_process_index;
1540   nm->current_process_index = node->runtime_index;
1541
1542   n_vectors = vlib_process_startup (vm, p, f);
1543
1544   nm->current_process_index = old_process_index;
1545
1546   ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1547   is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1548   if (is_suspend)
1549     {
1550       vlib_pending_frame_t *pf;
1551
1552       n_vectors = 0;
1553       pool_get (nm->suspended_process_frames, pf);
1554       pf->node_runtime_index = node->runtime_index;
1555       pf->frame_index = f ? vlib_frame_index (vm, f) : ~0;
1556       pf->next_frame_index = ~0;
1557
1558       p->n_suspends += 1;
1559       p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1560
1561       if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1562         {
1563           TWT (tw_timer_wheel) * tw =
1564             (TWT (tw_timer_wheel) *) nm->timing_wheel;
1565           p->stop_timer_handle =
1566             TW (tw_timer_start) (tw,
1567                                  vlib_timing_wheel_data_set_suspended_process
1568                                  (node->runtime_index) /* [sic] pool idex */ ,
1569                                  0 /* timer_id */ ,
1570                                  p->resume_clock_interval);
1571         }
1572     }
1573   else
1574     p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1575
1576   t = clib_cpu_time_now ();
1577
1578   vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1579                              /* is_after */ 1);
1580
1581   vlib_process_update_stats (vm, p,
1582                              /* n_calls */ !is_suspend,
1583                              /* n_vectors */ n_vectors,
1584                              /* n_clocks */ t - last_time_stamp);
1585
1586   return t;
1587 }
1588
1589 void
1590 vlib_start_process (vlib_main_t * vm, uword process_index)
1591 {
1592   vlib_node_main_t *nm = &vm->node_main;
1593   vlib_process_t *p = vec_elt (nm->processes, process_index);
1594   dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1595 }
1596
1597 static u64
1598 dispatch_suspended_process (vlib_main_t * vm,
1599                             uword process_index, u64 last_time_stamp)
1600 {
1601   vlib_node_main_t *nm = &vm->node_main;
1602   vlib_node_runtime_t *node_runtime;
1603   vlib_node_t *node;
1604   vlib_frame_t *f;
1605   vlib_process_t *p;
1606   vlib_pending_frame_t *pf;
1607   u64 t, n_vectors, is_suspend;
1608
1609   t = last_time_stamp;
1610
1611   p = vec_elt (nm->processes, process_index);
1612   if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1613     return last_time_stamp;
1614
1615   ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1616                       | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1617
1618   pf = pool_elt_at_index (nm->suspended_process_frames,
1619                           p->suspended_process_frame_index);
1620
1621   node_runtime = &p->node_runtime;
1622   node = vlib_get_node (vm, node_runtime->node_index);
1623   f = pf->frame_index != ~0 ? vlib_get_frame (vm, pf->frame_index) : 0;
1624
1625   vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1626                              f ? f->n_vectors : 0, /* is_after */ 0);
1627
1628   /* Save away current process for suspend. */
1629   nm->current_process_index = node->runtime_index;
1630
1631   n_vectors = vlib_process_resume (p);
1632   t = clib_cpu_time_now ();
1633
1634   nm->current_process_index = ~0;
1635
1636   is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1637   if (is_suspend)
1638     {
1639       /* Suspend it again. */
1640       n_vectors = 0;
1641       p->n_suspends += 1;
1642       if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1643         {
1644           p->stop_timer_handle =
1645             TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1646                                  vlib_timing_wheel_data_set_suspended_process
1647                                  (node->runtime_index) /* [sic] pool idex */ ,
1648                                  0 /* timer_id */ ,
1649                                  p->resume_clock_interval);
1650         }
1651     }
1652   else
1653     {
1654       p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1655       pool_put_index (nm->suspended_process_frames,
1656                       p->suspended_process_frame_index);
1657       p->suspended_process_frame_index = ~0;
1658     }
1659
1660   t = clib_cpu_time_now ();
1661   vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1662                              /* is_after */ 1);
1663
1664   vlib_process_update_stats (vm, p,
1665                              /* n_calls */ !is_suspend,
1666                              /* n_vectors */ n_vectors,
1667                              /* n_clocks */ t - last_time_stamp);
1668
1669   return t;
1670 }
1671
1672 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1673 void
1674 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1675 {
1676 }
1677
1678
1679 static_always_inline void
1680 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1681 {
1682   vlib_node_main_t *nm = &vm->node_main;
1683   vlib_thread_main_t *tm = vlib_get_thread_main ();
1684   uword i;
1685   u64 cpu_time_now;
1686   vlib_frame_queue_main_t *fqm;
1687   u32 *last_node_runtime_indices = 0;
1688   u32 frame_queue_check_counter = 0;
1689
1690   /* Initialize pending node vector. */
1691   if (is_main)
1692     {
1693       vec_resize (nm->pending_frames, 32);
1694       _vec_len (nm->pending_frames) = 0;
1695     }
1696
1697   /* Mark time of main loop start. */
1698   if (is_main)
1699     {
1700       cpu_time_now = vm->clib_time.last_cpu_time;
1701       vm->cpu_time_main_loop_start = cpu_time_now;
1702     }
1703   else
1704     cpu_time_now = clib_cpu_time_now ();
1705
1706   /* Pre-allocate interupt runtime indices and lock. */
1707   vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1708   vec_alloc (last_node_runtime_indices, 32);
1709   if (!is_main)
1710     clib_spinlock_init (&nm->pending_interrupt_lock);
1711
1712   /* Pre-allocate expired nodes. */
1713   if (!nm->polling_threshold_vector_length)
1714     nm->polling_threshold_vector_length = 10;
1715   if (!nm->interrupt_threshold_vector_length)
1716     nm->interrupt_threshold_vector_length = 5;
1717
1718   vm->cpu_id = clib_get_current_cpu_id ();
1719   vm->numa_node = clib_get_current_numa_node ();
1720
1721   /* Start all processes. */
1722   if (is_main)
1723     {
1724       uword i;
1725
1726       /*
1727        * Perform an initial barrier sync. Pays no attention to
1728        * the barrier sync hold-down timer scheme, which won't work
1729        * at this point in time.
1730        */
1731       vlib_worker_thread_initial_barrier_sync_and_release (vm);
1732
1733       nm->current_process_index = ~0;
1734       for (i = 0; i < vec_len (nm->processes); i++)
1735         cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1736                                          cpu_time_now);
1737     }
1738
1739   while (1)
1740     {
1741       vlib_node_runtime_t *n;
1742
1743       if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1744         {
1745           if (!is_main)
1746             vl_api_send_pending_rpc_requests (vm);
1747         }
1748
1749       if (!is_main)
1750         {
1751           vlib_worker_thread_barrier_check ();
1752           if (PREDICT_FALSE (vm->check_frame_queues +
1753                              frame_queue_check_counter))
1754             {
1755               u32 processed = 0;
1756
1757               if (vm->check_frame_queues)
1758                 {
1759                   frame_queue_check_counter = 100;
1760                   vm->check_frame_queues = 0;
1761                 }
1762
1763               vec_foreach (fqm, tm->frame_queue_mains)
1764                 processed += vlib_frame_queue_dequeue (vm, fqm);
1765
1766               /* No handoff queue work found? */
1767               if (processed)
1768                 frame_queue_check_counter = 100;
1769               else
1770                 frame_queue_check_counter--;
1771             }
1772           if (PREDICT_FALSE (vec_len (vm->worker_thread_main_loop_callbacks)))
1773             clib_call_callbacks (vm->worker_thread_main_loop_callbacks, vm);
1774         }
1775
1776       /* Process pre-input nodes. */
1777       vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1778         cpu_time_now = dispatch_node (vm, n,
1779                                       VLIB_NODE_TYPE_PRE_INPUT,
1780                                       VLIB_NODE_STATE_POLLING,
1781                                       /* frame */ 0,
1782                                       cpu_time_now);
1783
1784       /* Next process input nodes. */
1785       vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1786         cpu_time_now = dispatch_node (vm, n,
1787                                       VLIB_NODE_TYPE_INPUT,
1788                                       VLIB_NODE_STATE_POLLING,
1789                                       /* frame */ 0,
1790                                       cpu_time_now);
1791
1792       if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1793         vm->queue_signal_callback (vm);
1794
1795       /* Next handle interrupts. */
1796       {
1797         /* unlocked read, for performance */
1798         uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1799         uword i;
1800         if (PREDICT_FALSE (l > 0))
1801           {
1802             u32 *tmp;
1803             if (!is_main)
1804               {
1805                 clib_spinlock_lock (&nm->pending_interrupt_lock);
1806                 /* Re-read w/ lock held, in case another thread added an item */
1807                 l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1808               }
1809
1810             tmp = nm->pending_interrupt_node_runtime_indices;
1811             nm->pending_interrupt_node_runtime_indices =
1812               last_node_runtime_indices;
1813             last_node_runtime_indices = tmp;
1814             _vec_len (last_node_runtime_indices) = 0;
1815             if (!is_main)
1816               clib_spinlock_unlock (&nm->pending_interrupt_lock);
1817             for (i = 0; i < l; i++)
1818               {
1819                 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1820                                       last_node_runtime_indices[i]);
1821                 cpu_time_now =
1822                   dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1823                                  VLIB_NODE_STATE_INTERRUPT,
1824                                  /* frame */ 0,
1825                                  cpu_time_now);
1826               }
1827           }
1828       }
1829       /* Input nodes may have added work to the pending vector.
1830          Process pending vector until there is nothing left.
1831          All pending vectors will be processed from input -> output. */
1832       for (i = 0; i < _vec_len (nm->pending_frames); i++)
1833         cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1834       /* Reset pending vector for next iteration. */
1835       _vec_len (nm->pending_frames) = 0;
1836
1837       if (is_main)
1838         {
1839           /* *INDENT-OFF* */
1840           ELOG_TYPE_DECLARE (es) =
1841             {
1842               .format = "process tw start",
1843               .format_args = "",
1844             };
1845           ELOG_TYPE_DECLARE (ee) =
1846             {
1847               .format = "process tw end: %d",
1848               .format_args = "i4",
1849             };
1850           /* *INDENT-ON* */
1851
1852           struct
1853           {
1854             int nready_procs;
1855           } *ed;
1856
1857           /* Check if process nodes have expired from timing wheel. */
1858           ASSERT (nm->data_from_advancing_timing_wheel != 0);
1859
1860           if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1861             ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1862
1863           nm->data_from_advancing_timing_wheel =
1864             TW (tw_timer_expire_timers_vec)
1865             ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1866              nm->data_from_advancing_timing_wheel);
1867
1868           ASSERT (nm->data_from_advancing_timing_wheel != 0);
1869
1870           if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1871             {
1872               ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1873               ed->nready_procs =
1874                 _vec_len (nm->data_from_advancing_timing_wheel);
1875             }
1876
1877           if (PREDICT_FALSE
1878               (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1879             {
1880               uword i;
1881
1882               for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1883                    i++)
1884                 {
1885                   u32 d = nm->data_from_advancing_timing_wheel[i];
1886                   u32 di = vlib_timing_wheel_data_get_index (d);
1887
1888                   if (vlib_timing_wheel_data_is_timed_event (d))
1889                     {
1890                       vlib_signal_timed_event_data_t *te =
1891                         pool_elt_at_index (nm->signal_timed_event_data_pool,
1892                                            di);
1893                       vlib_node_t *n =
1894                         vlib_get_node (vm, te->process_node_index);
1895                       vlib_process_t *p =
1896                         vec_elt (nm->processes, n->runtime_index);
1897                       void *data;
1898                       data =
1899                         vlib_process_signal_event_helper (nm, n, p,
1900                                                           te->event_type_index,
1901                                                           te->n_data_elts,
1902                                                           te->n_data_elt_bytes);
1903                       if (te->n_data_bytes < sizeof (te->inline_event_data))
1904                         clib_memcpy_fast (data, te->inline_event_data,
1905                                           te->n_data_bytes);
1906                       else
1907                         {
1908                           clib_memcpy_fast (data, te->event_data_as_vector,
1909                                             te->n_data_bytes);
1910                           vec_free (te->event_data_as_vector);
1911                         }
1912                       pool_put (nm->signal_timed_event_data_pool, te);
1913                     }
1914                   else
1915                     {
1916                       cpu_time_now = clib_cpu_time_now ();
1917                       cpu_time_now =
1918                         dispatch_suspended_process (vm, di, cpu_time_now);
1919                     }
1920                 }
1921               _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1922             }
1923         }
1924       vlib_increment_main_loop_counter (vm);
1925
1926       /* Record time stamp in case there are no enabled nodes and above
1927          calls do not update time stamp. */
1928       cpu_time_now = clib_cpu_time_now ();
1929     }
1930 }
1931
1932 static void
1933 vlib_main_loop (vlib_main_t * vm)
1934 {
1935   vlib_main_or_worker_loop (vm, /* is_main */ 1);
1936 }
1937
1938 void
1939 vlib_worker_loop (vlib_main_t * vm)
1940 {
1941   vlib_main_or_worker_loop (vm, /* is_main */ 0);
1942 }
1943
1944 vlib_main_t vlib_global_main;
1945
1946 static clib_error_t *
1947 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1948 {
1949   int turn_on_mem_trace = 0;
1950
1951   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1952     {
1953       if (unformat (input, "memory-trace"))
1954         turn_on_mem_trace = 1;
1955
1956       else if (unformat (input, "elog-events %d",
1957                          &vm->elog_main.event_ring_size))
1958         ;
1959       else if (unformat (input, "elog-post-mortem-dump"))
1960         vm->elog_post_mortem_dump = 1;
1961       else
1962         return unformat_parse_error (input);
1963     }
1964
1965   unformat_free (input);
1966
1967   /* Enable memory trace as early as possible. */
1968   if (turn_on_mem_trace)
1969     clib_mem_trace (1);
1970
1971   return 0;
1972 }
1973
1974 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1975
1976 static void
1977 dummy_queue_signal_callback (vlib_main_t * vm)
1978 {
1979 }
1980
1981 #define foreach_weak_reference_stub             \
1982 _(vlib_map_stat_segment_init)                   \
1983 _(vpe_api_init)                                 \
1984 _(vlibmemory_init)                              \
1985 _(map_api_segment_init)
1986
1987 #define _(name)                                                 \
1988 clib_error_t *name (vlib_main_t *vm) __attribute__((weak));     \
1989 clib_error_t *name (vlib_main_t *vm) { return 0; }
1990 foreach_weak_reference_stub;
1991 #undef _
1992
1993 void vl_api_set_elog_main (elog_main_t * m) __attribute__ ((weak));
1994 void
1995 vl_api_set_elog_main (elog_main_t * m)
1996 {
1997   clib_warning ("STUB");
1998 }
1999
2000 int vl_api_set_elog_trace_api_messages (int enable) __attribute__ ((weak));
2001 int
2002 vl_api_set_elog_trace_api_messages (int enable)
2003 {
2004   clib_warning ("STUB");
2005   return 0;
2006 }
2007
2008 int vl_api_get_elog_trace_api_messages (void) __attribute__ ((weak));
2009 int
2010 vl_api_get_elog_trace_api_messages (void)
2011 {
2012   clib_warning ("STUB");
2013   return 0;
2014 }
2015
2016 /* Main function. */
2017 int
2018 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
2019 {
2020   clib_error_t *volatile error;
2021   vlib_node_main_t *nm = &vm->node_main;
2022
2023   vm->queue_signal_callback = dummy_queue_signal_callback;
2024
2025   clib_time_init (&vm->clib_time);
2026
2027   /* Turn on event log. */
2028   if (!vm->elog_main.event_ring_size)
2029     vm->elog_main.event_ring_size = 128 << 10;
2030   elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
2031   elog_enable_disable (&vm->elog_main, 1);
2032   vl_api_set_elog_main (&vm->elog_main);
2033   (void) vl_api_set_elog_trace_api_messages (1);
2034
2035   /* Default name. */
2036   if (!vm->name)
2037     vm->name = "VLIB";
2038
2039   if ((error = vlib_physmem_init (vm)))
2040     {
2041       clib_error_report (error);
2042       goto done;
2043     }
2044
2045   if ((error = vlib_map_stat_segment_init (vm)))
2046     {
2047       clib_error_report (error);
2048       goto done;
2049     }
2050
2051   if ((error = vlib_buffer_main_init (vm)))
2052     {
2053       clib_error_report (error);
2054       goto done;
2055     }
2056
2057   if ((error = vlib_thread_init (vm)))
2058     {
2059       clib_error_report (error);
2060       goto done;
2061     }
2062
2063   /* Register static nodes so that init functions may use them. */
2064   vlib_register_all_static_nodes (vm);
2065
2066   /* Set seed for random number generator.
2067      Allow user to specify seed to make random sequence deterministic. */
2068   if (!unformat (input, "seed %wd", &vm->random_seed))
2069     vm->random_seed = clib_cpu_time_now ();
2070   clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
2071
2072   /* Initialize node graph. */
2073   if ((error = vlib_node_main_init (vm)))
2074     {
2075       /* Arrange for graph hook up error to not be fatal when debugging. */
2076       if (CLIB_DEBUG > 0)
2077         clib_error_report (error);
2078       else
2079         goto done;
2080     }
2081
2082   /* Direct call / weak reference, for vlib standalone use-cases */
2083   if ((error = vpe_api_init (vm)))
2084     {
2085       clib_error_report (error);
2086       goto done;
2087     }
2088
2089   if ((error = vlibmemory_init (vm)))
2090     {
2091       clib_error_report (error);
2092       goto done;
2093     }
2094
2095   if ((error = map_api_segment_init (vm)))
2096     {
2097       clib_error_report (error);
2098       goto done;
2099     }
2100
2101   /* See unix/main.c; most likely already set up */
2102   if (vm->init_functions_called == 0)
2103     vm->init_functions_called = hash_create (0, /* value bytes */ 0);
2104   if ((error = vlib_call_all_init_functions (vm)))
2105     goto done;
2106
2107   nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
2108                                              CLIB_CACHE_LINE_BYTES);
2109
2110   vec_validate (nm->data_from_advancing_timing_wheel, 10);
2111   _vec_len (nm->data_from_advancing_timing_wheel) = 0;
2112
2113   /* Create the process timing wheel */
2114   TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
2115                             0 /* no callback */ ,
2116                             10e-6 /* timer period 10us */ ,
2117                             ~0 /* max expirations per call */ );
2118
2119   vec_validate (vm->pending_rpc_requests, 0);
2120   _vec_len (vm->pending_rpc_requests) = 0;
2121   vec_validate (vm->processing_rpc_requests, 0);
2122   _vec_len (vm->processing_rpc_requests) = 0;
2123
2124   if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
2125     goto done;
2126
2127   /* Sort per-thread init functions before we start threads */
2128   vlib_sort_init_exit_functions (&vm->worker_init_function_registrations);
2129
2130   /* Call all main loop enter functions. */
2131   {
2132     clib_error_t *sub_error;
2133     sub_error = vlib_call_all_main_loop_enter_functions (vm);
2134     if (sub_error)
2135       clib_error_report (sub_error);
2136   }
2137
2138   switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2139     {
2140     case VLIB_MAIN_LOOP_EXIT_NONE:
2141       vm->main_loop_exit_set = 1;
2142       break;
2143
2144     case VLIB_MAIN_LOOP_EXIT_CLI:
2145       goto done;
2146
2147     default:
2148       error = vm->main_loop_error;
2149       goto done;
2150     }
2151
2152   vlib_main_loop (vm);
2153
2154 done:
2155   /* Call all exit functions. */
2156   {
2157     clib_error_t *sub_error;
2158     sub_error = vlib_call_all_main_loop_exit_functions (vm);
2159     if (sub_error)
2160       clib_error_report (sub_error);
2161   }
2162
2163   if (error)
2164     clib_error_report (error);
2165
2166   return 0;
2167 }
2168
2169 static inline clib_error_t *
2170 pcap_dispatch_trace_command_internal (vlib_main_t * vm,
2171                                       unformat_input_t * input,
2172                                       vlib_cli_command_t * cmd, int rx_tx)
2173 {
2174   unformat_input_t _line_input, *line_input = &_line_input;
2175   pcap_main_t *pm = &vm->dispatch_pcap_main;
2176   u8 *filename = 0;
2177   u32 max = 1000;
2178   int enabled = 0;
2179   int is_error = 0;
2180   clib_error_t *error = 0;
2181   u32 node_index, add;
2182   vlib_trace_main_t *tm;
2183   vlib_trace_node_t *tn;
2184
2185   /* Get a line of input. */
2186   if (!unformat_user (input, unformat_line_input, line_input))
2187     return 0;
2188
2189   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2190     {
2191       if (unformat (line_input, "on"))
2192         {
2193           if (vm->dispatch_pcap_enable == 0)
2194             {
2195               enabled = 1;
2196             }
2197           else
2198             {
2199               vlib_cli_output (vm, "pcap dispatch capture already on...");
2200               is_error = 1;
2201               break;
2202             }
2203         }
2204       else if (unformat (line_input, "off"))
2205         {
2206           if (vm->dispatch_pcap_enable)
2207             {
2208               vlib_cli_output
2209                 (vm, "captured %d pkts...", pm->n_packets_captured);
2210               if (pm->n_packets_captured)
2211                 {
2212                   pm->n_packets_to_capture = pm->n_packets_captured;
2213                   error = pcap_write (pm);
2214                   if (error)
2215                     clib_error_report (error);
2216                   else
2217                     vlib_cli_output (vm, "saved to %s...", pm->file_name);
2218                 }
2219               vm->dispatch_pcap_enable = 0;
2220             }
2221           else
2222             {
2223               vlib_cli_output (vm, "pcap tx capture already off...");
2224               is_error = 1;
2225               break;
2226             }
2227         }
2228       else if (unformat (line_input, "max %d", &max))
2229         {
2230           if (vm->dispatch_pcap_enable)
2231             {
2232               vlib_cli_output
2233                 (vm,
2234                  "can't change max value while pcap tx capture active...");
2235               is_error = 1;
2236               break;
2237             }
2238           pm->n_packets_to_capture = max;
2239         }
2240       else
2241         if (unformat
2242             (line_input, "file %U", unformat_vlib_tmpfile, &filename))
2243         {
2244           if (vm->dispatch_pcap_enable)
2245             {
2246               vlib_cli_output
2247                 (vm, "can't change file while pcap tx capture active...");
2248               is_error = 1;
2249               break;
2250             }
2251         }
2252       else if (unformat (line_input, "status"))
2253         {
2254           if (vm->dispatch_pcap_enable)
2255             {
2256               vlib_cli_output
2257                 (vm, "pcap dispatch capture is on: %d of %d pkts...",
2258                  pm->n_packets_captured, pm->n_packets_to_capture);
2259               vlib_cli_output (vm, "Capture to file %s", pm->file_name);
2260             }
2261           else
2262             {
2263               vlib_cli_output (vm, "pcap dispatch capture is off...");
2264             }
2265           break;
2266         }
2267       else if (unformat (line_input, "buffer-trace %U %d",
2268                          unformat_vlib_node, vm, &node_index, &add))
2269         {
2270           if (vnet_trace_dummy == 0)
2271             vec_validate_aligned (vnet_trace_dummy, 2048,
2272                                   CLIB_CACHE_LINE_BYTES);
2273           vlib_cli_output (vm, "Buffer tracing of %d pkts from %U enabled...",
2274                            add, format_vlib_node_name, vm, node_index);
2275
2276           /* *INDENT-OFF* */
2277           foreach_vlib_main ((
2278             {
2279               tm = &this_vlib_main->trace_main;
2280               tm->verbose = 0;  /* not sure this ever did anything... */
2281               vec_validate (tm->nodes, node_index);
2282               tn = tm->nodes + node_index;
2283               tn->limit += add;
2284               tm->trace_enable = 1;
2285             }));
2286           /* *INDENT-ON* */
2287         }
2288
2289       else
2290         {
2291           error = clib_error_return (0, "unknown input `%U'",
2292                                      format_unformat_error, line_input);
2293           is_error = 1;
2294           break;
2295         }
2296     }
2297   unformat_free (line_input);
2298
2299   if (is_error == 0)
2300     {
2301       /* Clean up from previous run */
2302       vec_free (pm->file_name);
2303       vec_free (pm->pcap_data);
2304
2305       memset (pm, 0, sizeof (*pm));
2306       pm->n_packets_to_capture = max;
2307
2308       if (enabled)
2309         {
2310           if (filename == 0)
2311             filename = format (0, "/tmp/dispatch.pcap%c", 0);
2312
2313           pm->file_name = (char *) filename;
2314           pm->n_packets_captured = 0;
2315           pm->packet_type = PCAP_PACKET_TYPE_vpp;
2316           if (pm->lock == 0)
2317             clib_spinlock_init (&(pm->lock));
2318           vm->dispatch_pcap_enable = 1;
2319           vlib_cli_output (vm, "pcap dispatch capture on...");
2320         }
2321     }
2322
2323   return error;
2324 }
2325
2326 static clib_error_t *
2327 pcap_dispatch_trace_command_fn (vlib_main_t * vm,
2328                                 unformat_input_t * input,
2329                                 vlib_cli_command_t * cmd)
2330 {
2331   return pcap_dispatch_trace_command_internal (vm, input, cmd, VLIB_RX);
2332 }
2333
2334 /*?
2335  * This command is used to start or stop pcap dispatch trace capture, or show
2336  * the capture status.
2337  *
2338  * This command has the following optional parameters:
2339  *
2340  * - <b>on|off</b> - Used to start or stop capture.
2341  *
2342  * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2343  *   of packets have been received, buffer is flushed to file. Once another
2344  *   '<em>nn</em>' number of packets have been received, buffer is flushed
2345  *   to file, overwriting previous write. If not entered, value defaults
2346  *   to 100. Can only be updated if packet capture is off.
2347  *
2348  * - <b>file <name></b> - Used to specify the output filename. The file will
2349  *   be placed in the '<em>/tmp</em>' directory, so only the filename is
2350  *   supported. Directory should not be entered. If file already exists, file
2351  *   will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
2352  *   will be used. Can only be updated if packet capture is off.
2353  *
2354  * - <b>status</b> - Displays the current status and configured attributes
2355  *   associated with a packet capture. If packet capture is in progress,
2356  *   '<em>status</em>' also will return the number of packets currently in
2357  *   the local buffer. All additional attributes entered on command line
2358  *   with '<em>status</em>' will be ignored and not applied.
2359  *
2360  * @cliexpar
2361  * Example of how to display the status of capture when off:
2362  * @cliexstart{pcap dispatch trace status}
2363  * max is 100, for any interface to file /tmp/vpe.pcap
2364  * pcap dispatch capture is off...
2365  * @cliexend
2366  * Example of how to start a dispatch trace capture:
2367  * @cliexstart{pcap dispatch trace on max 35 file dispatchTrace.pcap}
2368  * pcap dispatch capture on...
2369  * @cliexend
2370  * Example of how to start a dispatch trace capture with buffer tracing
2371  * @cliexstart{pcap dispatch trace on max 10000 file dispatchTrace.pcap buffer-trace dpdk-input 1000}
2372  * pcap dispatch capture on...
2373  * @cliexend
2374  * Example of how to display the status of a tx packet capture in progress:
2375  * @cliexstart{pcap tx trace status}
2376  * max is 35, dispatch trace to file /tmp/vppTest.pcap
2377  * pcap tx capture is on: 20 of 35 pkts...
2378  * @cliexend
2379  * Example of how to stop a tx packet capture:
2380  * @cliexstart{vppctl pcap dispatch trace off}
2381  * captured 21 pkts...
2382  * saved to /tmp/dispatchTrace.pcap...
2383  * @cliexend
2384 ?*/
2385 /* *INDENT-OFF* */
2386 VLIB_CLI_COMMAND (pcap_dispatch_trace_command, static) = {
2387     .path = "pcap dispatch trace",
2388     .short_help =
2389     "pcap dispatch trace [on|off] [max <nn>] [file <name>] [status]\n"
2390     "              [buffer-trace <input-node-name> <nn>]",
2391     .function = pcap_dispatch_trace_command_fn,
2392 };
2393 /* *INDENT-ON* */
2394
2395 /*
2396  * fd.io coding-style-patch-verification: ON
2397  *
2398  * Local Variables:
2399  * eval: (c-set-style "gnu")
2400  * End:
2401  */