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