src/vlib/main.c

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