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