src/vlib/main.c

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