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     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
 161   fs->n_alloc_frames += 1;
 162
 163   return fi;
 164 }
 165
 166 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
 167    Returns frame index. */
 168 static u32
 169 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
 170                   u32 to_next_index)
 171 {
 172   vlib_node_t *from_node;
 173
 174   from_node = vlib_get_node (vm, from_node_runtime->node_index);
 175   ASSERT (to_next_index < vec_len (from_node->next_nodes));
 176
 177   return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
 178                                    /* frame_flags */ 0);
 179 }
 180
 181 vlib_frame_t *
 182 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
 183 {
 184   u32 fi = vlib_frame_alloc_to_node (vm, to_node_index,
 185                                      /* frame_flags */
 186                                      VLIB_FRAME_FREE_AFTER_DISPATCH);
 187   return vlib_get_frame (vm, fi);
 188 }
 189
 190 void
 191 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
 192 {
 193   vlib_pending_frame_t *p;
 194   vlib_node_t *to_node;
 195
 196   if (f->n_vectors == 0)
 197     return;
 198
 199   to_node = vlib_get_node (vm, to_node_index);
 200
 201   vec_add2 (vm->node_main.pending_frames, p, 1);
 202
 203   f->frame_flags |= VLIB_FRAME_PENDING;
 204   p->frame_index = vlib_frame_index (vm, f);
 205   p->node_runtime_index = to_node->runtime_index;
 206   p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
 207 }
 208
 209 /* Free given frame. */
 210 void
 211 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
 212 {
 213   vlib_node_main_t *nm = &vm->node_main;
 214   vlib_node_t *node;
 215   vlib_frame_size_t *fs;
 216   u32 frame_index;
 217
 218   ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
 219
 220   node = vlib_get_node (vm, r->node_index);
 221   fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
 222
 223   frame_index = vlib_frame_index (vm, f);
 224
 225   ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
 226
 227   /* No next frames may point to freed frame. */
 228   if (CLIB_DEBUG > 0)
 229     {
 230       vlib_next_frame_t *nf;
 231       vec_foreach (nf, vm->node_main.next_frames)
 232         ASSERT (nf->frame_index != frame_index);
 233     }
 234
 235   f->frame_flags &= ~VLIB_FRAME_IS_ALLOCATED;
 236
 237   vec_add1 (fs->free_frame_indices, frame_index);
 238   ASSERT (fs->n_alloc_frames > 0);
 239   fs->n_alloc_frames -= 1;
 240 }
 241
 242 static clib_error_t *
 243 show_frame_stats (vlib_main_t * vm,
 244                   unformat_input_t * input, vlib_cli_command_t * cmd)
 245 {
 246   vlib_node_main_t *nm = &vm->node_main;
 247   vlib_frame_size_t *fs;
 248
 249   vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
 250   vec_foreach (fs, nm->frame_sizes)
 251   {
 252     u32 n_alloc = fs->n_alloc_frames;
 253     u32 n_free = vec_len (fs->free_frame_indices);
 254
 255     if (n_alloc + n_free > 0)
 256       vlib_cli_output (vm, "%=6d%=12d%=12d",
 257                        fs - nm->frame_sizes, n_alloc, n_free);
 258   }
 259
 260   return 0;
 261 }
 262
 263 /* *INDENT-OFF* */
 264 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
 265   .path = "show vlib frame-allocation",
 266   .short_help = "Show node dispatch frame statistics",
 267   .function = show_frame_stats,
 268 };
 269 /* *INDENT-ON* */
 270
 271 /* Change ownership of enqueue rights to given next node. */
 272 static void
 273 vlib_next_frame_change_ownership (vlib_main_t * vm,
 274                                   vlib_node_runtime_t * node_runtime,
 275                                   u32 next_index)
 276 {
 277   vlib_node_main_t *nm = &vm->node_main;
 278   vlib_next_frame_t *next_frame;
 279   vlib_node_t *node, *next_node;
 280
 281   node = vec_elt (nm->nodes, node_runtime->node_index);
 282
 283   /* Only internal & input nodes are allowed to call other nodes. */
 284   ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
 285           || node->type == VLIB_NODE_TYPE_INPUT
 286           || node->type == VLIB_NODE_TYPE_PROCESS);
 287
 288   ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
 289
 290   next_frame =
 291     vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
 292   next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
 293
 294   if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
 295     {
 296       /* Get frame from previous owner. */
 297       vlib_next_frame_t *owner_next_frame;
 298       vlib_next_frame_t tmp;
 299
 300       owner_next_frame =
 301         vlib_node_get_next_frame (vm,
 302                                   next_node->owner_node_index,
 303                                   next_node->owner_next_index);
 304
 305       /* Swap target next frame with owner's. */
 306       tmp = owner_next_frame[0];
 307       owner_next_frame[0] = next_frame[0];
 308       next_frame[0] = tmp;
 309
 310       /*
 311        * If next_frame is already pending, we have to track down
 312        * all pending frames and fix their next_frame_index fields.
 313        */
 314       if (next_frame->flags & VLIB_FRAME_PENDING)
 315         {
 316           vlib_pending_frame_t *p;
 317           if (next_frame->frame_index != ~0)
 318             {
 319               vec_foreach (p, nm->pending_frames)
 320               {
 321                 if (p->frame_index == next_frame->frame_index)
 322                   {
 323                     p->next_frame_index =
 324                       next_frame - vm->node_main.next_frames;
 325                   }
 326               }
 327             }
 328         }
 329     }
 330   else
 331     {
 332       /* No previous owner. Take ownership. */
 333       next_frame->flags |= VLIB_FRAME_OWNER;
 334     }
 335
 336   /* Record new owner. */
 337   next_node->owner_node_index = node->index;
 338   next_node->owner_next_index = next_index;
 339
 340   /* Now we should be owner. */
 341   ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
 342 }
 343
 344 /* Make sure that magic number is still there.
 345    Otherwise, it is likely that caller has overrun frame arguments. */
 346 always_inline void
 347 validate_frame_magic (vlib_main_t * vm,
 348                       vlib_frame_t * f, vlib_node_t * n, uword next_index)
 349 {
 350   vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
 351   u32 *magic = vlib_frame_find_magic (f, next_node);
 352   ASSERT (VLIB_FRAME_MAGIC == magic[0]);
 353 }
 354
 355 vlib_frame_t *
 356 vlib_get_next_frame_internal (vlib_main_t * vm,
 357                               vlib_node_runtime_t * node,
 358                               u32 next_index, u32 allocate_new_next_frame)
 359 {
 360   vlib_frame_t *f;
 361   vlib_next_frame_t *nf;
 362   u32 n_used;
 363
 364   nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
 365
 366   /* Make sure this next frame owns right to enqueue to destination frame. */
 367   if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
 368     vlib_next_frame_change_ownership (vm, node, next_index);
 369
 370   /* ??? Don't need valid flag: can use frame_index == ~0 */
 371   if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
 372     {
 373       nf->frame_index = vlib_frame_alloc (vm, node, next_index);
 374       nf->flags |= VLIB_FRAME_IS_ALLOCATED;
 375     }
 376
 377   f = vlib_get_frame (vm, nf->frame_index);
 378
 379   /* Has frame been removed from pending vector (e.g. finished dispatching)?
 380      If so we can reuse frame. */
 381   if ((nf->flags & VLIB_FRAME_PENDING)
 382       && !(f->frame_flags & VLIB_FRAME_PENDING))
 383     {
 384       nf->flags &= ~VLIB_FRAME_PENDING;
 385       f->n_vectors = 0;
 386     }
 387
 388   /* Allocate new frame if current one is already full. */
 389   n_used = f->n_vectors;
 390   if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0))
 391     {
 392       /* Old frame may need to be freed after dispatch, since we'll have
 393          two redundant frames from node -> next node. */
 394       if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
 395         {
 396           vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame_index);
 397           f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
 398         }
 399
 400       /* Allocate new frame to replace full one. */
 401       nf->frame_index = vlib_frame_alloc (vm, node, next_index);
 402       f = vlib_get_frame (vm, nf->frame_index);
 403       n_used = f->n_vectors;
 404     }
 405
 406   /* Should have free vectors in frame now. */
 407   ASSERT (n_used < VLIB_FRAME_SIZE);
 408
 409   if (CLIB_DEBUG > 0)
 410     {
 411       validate_frame_magic (vm, f,
 412                             vlib_get_node (vm, node->node_index), next_index);
 413     }
 414
 415   return f;
 416 }
 417
 418 static void
 419 vlib_put_next_frame_validate (vlib_main_t * vm,
 420                               vlib_node_runtime_t * rt,
 421                               u32 next_index, u32 n_vectors_left)
 422 {
 423   vlib_node_main_t *nm = &vm->node_main;
 424   vlib_next_frame_t *nf;
 425   vlib_frame_t *f;
 426   vlib_node_runtime_t *next_rt;
 427   vlib_node_t *next_node;
 428   u32 n_before, n_after;
 429
 430   nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
 431   f = vlib_get_frame (vm, nf->frame_index);
 432
 433   ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
 434   n_after = VLIB_FRAME_SIZE - n_vectors_left;
 435   n_before = f->n_vectors;
 436
 437   ASSERT (n_after >= n_before);
 438
 439   next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
 440                               nf->node_runtime_index);
 441   next_node = vlib_get_node (vm, next_rt->node_index);
 442   if (n_after > 0 && next_node->validate_frame)
 443     {
 444       u8 *msg = next_node->validate_frame (vm, rt, f);
 445       if (msg)
 446         {
 447           clib_warning ("%v", msg);
 448           ASSERT (0);
 449         }
 450       vec_free (msg);
 451     }
 452 }
 453
 454 void
 455 vlib_put_next_frame (vlib_main_t * vm,
 456                      vlib_node_runtime_t * r,
 457                      u32 next_index, u32 n_vectors_left)
 458 {
 459   vlib_node_main_t *nm = &vm->node_main;
 460   vlib_next_frame_t *nf;
 461   vlib_frame_t *f;
 462   u32 n_vectors_in_frame;
 463
 464   if (buffer_main.callbacks_registered == 0 && CLIB_DEBUG > 0)
 465     vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
 466
 467   nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
 468   f = vlib_get_frame (vm, nf->frame_index);
 469
 470   /* Make sure that magic number is still there.  Otherwise, caller
 471      has overrun frame meta data. */
 472   if (CLIB_DEBUG > 0)
 473     {
 474       vlib_node_t *node = vlib_get_node (vm, r->node_index);
 475       validate_frame_magic (vm, f, node, next_index);
 476     }
 477
 478   /* Convert # of vectors left -> number of vectors there. */
 479   ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
 480   n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
 481
 482   f->n_vectors = n_vectors_in_frame;
 483
 484   /* If vectors were added to frame, add to pending vector. */
 485   if (PREDICT_TRUE (n_vectors_in_frame > 0))
 486     {
 487       vlib_pending_frame_t *p;
 488       u32 v0, v1;
 489
 490       r->cached_next_index = next_index;
 491
 492       if (!(f->frame_flags & VLIB_FRAME_PENDING))
 493         {
 494           __attribute__ ((unused)) vlib_node_t *node;
 495           vlib_node_t *next_node;
 496           vlib_node_runtime_t *next_runtime;
 497
 498           node = vlib_get_node (vm, r->node_index);
 499           next_node = vlib_get_next_node (vm, r->node_index, next_index);
 500           next_runtime = vlib_node_get_runtime (vm, next_node->index);
 501
 502           vec_add2 (nm->pending_frames, p, 1);
 503
 504           p->frame_index = nf->frame_index;
 505           p->node_runtime_index = nf->node_runtime_index;
 506           p->next_frame_index = nf - nm->next_frames;
 507           nf->flags |= VLIB_FRAME_PENDING;
 508           f->frame_flags |= VLIB_FRAME_PENDING;
 509
 510           /*
 511            * If we're going to dispatch this frame on another thread,
 512            * force allocation of a new frame. Otherwise, we create
 513            * a dangling frame reference. Each thread has its own copy of
 514            * the next_frames vector.
 515            */
 516           if (0 && r->thread_index != next_runtime->thread_index)
 517             {
 518               nf->frame_index = ~0;
 519               nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
 520             }
 521         }
 522
 523       /* Copy trace flag from next_frame and from runtime. */
 524       nf->flags |=
 525         (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
 526                                               flags & VLIB_NODE_FLAG_TRACE);
 527
 528       v0 = nf->vectors_since_last_overflow;
 529       v1 = v0 + n_vectors_in_frame;
 530       nf->vectors_since_last_overflow = v1;
 531       if (PREDICT_FALSE (v1 < v0))
 532         {
 533           vlib_node_t *node = vlib_get_node (vm, r->node_index);
 534           vec_elt (node->n_vectors_by_next_node, next_index) += v0;
 535         }
 536     }
 537 }
 538
 539 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
 540 never_inline void
 541 vlib_node_runtime_sync_stats (vlib_main_t * vm,
 542                               vlib_node_runtime_t * r,
 543                               uword n_calls, uword n_vectors, uword n_clocks)
 544 {
 545   vlib_node_t *n = vlib_get_node (vm, r->node_index);
 546
 547   n->stats_total.calls += n_calls + r->calls_since_last_overflow;
 548   n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
 549   n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
 550   n->stats_total.max_clock = r->max_clock;
 551   n->stats_total.max_clock_n = r->max_clock_n;
 552
 553   r->calls_since_last_overflow = 0;
 554   r->vectors_since_last_overflow = 0;
 555   r->clocks_since_last_overflow = 0;
 556 }
 557
 558 always_inline void __attribute__ ((unused))
 559 vlib_process_sync_stats (vlib_main_t * vm,
 560                          vlib_process_t * p,
 561                          uword n_calls, uword n_vectors, uword n_clocks)
 562 {
 563   vlib_node_runtime_t *rt = &p->node_runtime;
 564   vlib_node_t *n = vlib_get_node (vm, rt->node_index);
 565   vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks);
 566   n->stats_total.suspends += p->n_suspends;
 567   p->n_suspends = 0;
 568 }
 569
 570 void
 571 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
 572 {
 573   vlib_node_runtime_t *rt;
 574
 575   if (n->type == VLIB_NODE_TYPE_PROCESS)
 576     {
 577       /* Nothing to do for PROCESS nodes except in main thread */
 578       if (vm != &vlib_global_main)
 579         return;
 580
 581       vlib_process_t *p = vlib_get_process_from_node (vm, n);
 582       n->stats_total.suspends += p->n_suspends;
 583       p->n_suspends = 0;
 584       rt = &p->node_runtime;
 585     }
 586   else
 587     rt =
 588       vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
 589                         n->runtime_index);
 590
 591   vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0);
 592
 593   /* Sync up runtime next frame vector counters with main node structure. */
 594   {
 595     vlib_next_frame_t *nf;
 596     uword i;
 597     for (i = 0; i < rt->n_next_nodes; i++)
 598       {
 599         nf = vlib_node_runtime_get_next_frame (vm, rt, i);
 600         vec_elt (n->n_vectors_by_next_node, i) +=
 601           nf->vectors_since_last_overflow;
 602         nf->vectors_since_last_overflow = 0;
 603       }
 604   }
 605 }
 606
 607 always_inline u32
 608 vlib_node_runtime_update_stats (vlib_main_t * vm,
 609                                 vlib_node_runtime_t * node,
 610                                 uword n_calls,
 611                                 uword n_vectors, uword n_clocks)
 612 {
 613   u32 ca0, ca1, v0, v1, cl0, cl1, r;
 614
 615   cl0 = cl1 = node->clocks_since_last_overflow;
 616   ca0 = ca1 = node->calls_since_last_overflow;
 617   v0 = v1 = node->vectors_since_last_overflow;
 618
 619   ca1 = ca0 + n_calls;
 620   v1 = v0 + n_vectors;
 621   cl1 = cl0 + n_clocks;
 622
 623   node->calls_since_last_overflow = ca1;
 624   node->clocks_since_last_overflow = cl1;
 625   node->vectors_since_last_overflow = v1;
 626   node->max_clock_n = node->max_clock > n_clocks ?
 627     node->max_clock_n : n_vectors;
 628   node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
 629
 630   r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
 631
 632   if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0))
 633     {
 634       node->calls_since_last_overflow = ca0;
 635       node->clocks_since_last_overflow = cl0;
 636       node->vectors_since_last_overflow = v0;
 637       vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks);
 638     }
 639
 640   return r;
 641 }
 642
 643 always_inline void
 644 vlib_process_update_stats (vlib_main_t * vm,
 645                            vlib_process_t * p,
 646                            uword n_calls, uword n_vectors, uword n_clocks)
 647 {
 648   vlib_node_runtime_update_stats (vm, &p->node_runtime,
 649                                   n_calls, n_vectors, n_clocks);
 650 }
 651
 652 static clib_error_t *
 653 vlib_cli_elog_clear (vlib_main_t * vm,
 654                      unformat_input_t * input, vlib_cli_command_t * cmd)
 655 {
 656   elog_reset_buffer (&vm->elog_main);
 657   return 0;
 658 }
 659
 660 /* *INDENT-OFF* */
 661 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
 662   .path = "event-logger clear",
 663   .short_help = "Clear the event log",
 664   .function = vlib_cli_elog_clear,
 665 };
 666 /* *INDENT-ON* */
 667
 668 #ifdef CLIB_UNIX
 669 static clib_error_t *
 670 elog_save_buffer (vlib_main_t * vm,
 671                   unformat_input_t * input, vlib_cli_command_t * cmd)
 672 {
 673   elog_main_t *em = &vm->elog_main;
 674   char *file, *chroot_file;
 675   clib_error_t *error = 0;
 676
 677   if (!unformat (input, "%s", &file))
 678     {
 679       vlib_cli_output (vm, "expected file name, got `%U'",
 680                        format_unformat_error, input);
 681       return 0;
 682     }
 683
 684   /* It's fairly hard to get "../oopsie" through unformat; just in case */
 685   if (strstr (file, "..") || index (file, '/'))
 686     {
 687       vlib_cli_output (vm, "illegal characters in filename '%s'", file);
 688       return 0;
 689     }
 690
 691   chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
 692
 693   vec_free (file);
 694
 695   vlib_cli_output (vm, "Saving %wd of %wd events to %s",
 696                    elog_n_events_in_buffer (em),
 697                    elog_buffer_capacity (em), chroot_file);
 698
 699   vlib_worker_thread_barrier_sync (vm);
 700   error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
 701   vlib_worker_thread_barrier_release (vm);
 702   vec_free (chroot_file);
 703   return error;
 704 }
 705
 706 void
 707 elog_post_mortem_dump (void)
 708 {
 709   vlib_main_t *vm = &vlib_global_main;
 710   elog_main_t *em = &vm->elog_main;
 711   u8 *filename;
 712   clib_error_t *error;
 713
 714   if (!vm->elog_post_mortem_dump)
 715     return;
 716
 717   filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
 718   error = elog_write_file (em, (char *) filename, 1 /* flush ring */ );
 719   if (error)
 720     clib_error_report (error);
 721   vec_free (filename);
 722 }
 723
 724 /* *INDENT-OFF* */
 725 VLIB_CLI_COMMAND (elog_save_cli, static) = {
 726   .path = "event-logger save",
 727   .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
 728   .function = elog_save_buffer,
 729 };
 730 /* *INDENT-ON* */
 731
 732 static clib_error_t *
 733 elog_stop (vlib_main_t * vm,
 734            unformat_input_t * input, vlib_cli_command_t * cmd)
 735 {
 736   elog_main_t *em = &vm->elog_main;
 737
 738   em->n_total_events_disable_limit = em->n_total_events;
 739
 740   vlib_cli_output (vm, "Stopped the event logger...");
 741   return 0;
 742 }
 743
 744 /* *INDENT-OFF* */
 745 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
 746   .path = "event-logger stop",
 747   .short_help = "Stop the event-logger",
 748   .function = elog_stop,
 749 };
 750 /* *INDENT-ON* */
 751
 752 static clib_error_t *
 753 elog_restart (vlib_main_t * vm,
 754               unformat_input_t * input, vlib_cli_command_t * cmd)
 755 {
 756   elog_main_t *em = &vm->elog_main;
 757
 758   em->n_total_events_disable_limit = ~0;
 759
 760   vlib_cli_output (vm, "Restarted the event logger...");
 761   return 0;
 762 }
 763
 764 /* *INDENT-OFF* */
 765 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
 766   .path = "event-logger restart",
 767   .short_help = "Restart the event-logger",
 768   .function = elog_restart,
 769 };
 770 /* *INDENT-ON* */
 771
 772 static clib_error_t *
 773 elog_resize (vlib_main_t * vm,
 774              unformat_input_t * input, vlib_cli_command_t * cmd)
 775 {
 776   elog_main_t *em = &vm->elog_main;
 777   u32 tmp;
 778
 779   /* Stop the parade */
 780   elog_reset_buffer (&vm->elog_main);
 781
 782   if (unformat (input, "%d", &tmp))
 783     {
 784       elog_alloc (em, tmp);
 785       em->n_total_events_disable_limit = ~0;
 786     }
 787   else
 788     return clib_error_return (0, "Must specify how many events in the ring");
 789
 790   vlib_cli_output (vm, "Resized ring and restarted the event logger...");
 791   return 0;
 792 }
 793
 794 /* *INDENT-OFF* */
 795 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
 796   .path = "event-logger resize",
 797   .short_help = "event-logger resize <nnn>",
 798   .function = elog_resize,
 799 };
 800 /* *INDENT-ON* */
 801
 802 #endif /* CLIB_UNIX */
 803
 804 static void
 805 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
 806 {
 807   elog_main_t *em = &vm->elog_main;
 808   elog_event_t *e, *es;
 809   f64 dt;
 810
 811   /* Show events in VLIB time since log clock starts after VLIB clock. */
 812   dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
 813     * vm->clib_time.seconds_per_clock;
 814
 815   es = elog_peek_events (em);
 816   vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
 817                    em->event_ring_size,
 818                    em->n_total_events < em->n_total_events_disable_limit ?
 819                    "running" : "stopped");
 820   vec_foreach (e, es)
 821   {
 822     vlib_cli_output (vm, "%18.9f: %U",
 823                      e->time + dt, format_elog_event, em, e);
 824     n_events_to_show--;
 825     if (n_events_to_show == 0)
 826       break;
 827   }
 828   vec_free (es);
 829
 830 }
 831
 832 static clib_error_t *
 833 elog_show_buffer (vlib_main_t * vm,
 834                   unformat_input_t * input, vlib_cli_command_t * cmd)
 835 {
 836   u32 n_events_to_show;
 837   clib_error_t *error = 0;
 838
 839   n_events_to_show = 250;
 840   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 841     {
 842       if (unformat (input, "%d", &n_events_to_show))
 843         ;
 844       else if (unformat (input, "all"))
 845         n_events_to_show = ~0;
 846       else
 847         return unformat_parse_error (input);
 848     }
 849   elog_show_buffer_internal (vm, n_events_to_show);
 850   return error;
 851 }
 852
 853 /* *INDENT-OFF* */
 854 VLIB_CLI_COMMAND (elog_show_cli, static) = {
 855   .path = "show event-logger",
 856   .short_help = "Show event logger info",
 857   .function = elog_show_buffer,
 858 };
 859 /* *INDENT-ON* */
 860
 861 void
 862 vlib_gdb_show_event_log (void)
 863 {
 864   elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
 865 }
 866
 867 static inline void
 868 vlib_elog_main_loop_event (vlib_main_t * vm,
 869                            u32 node_index,
 870                            u64 time, u32 n_vectors, u32 is_return)
 871 {
 872   vlib_main_t *evm = &vlib_global_main;
 873   elog_main_t *em = &evm->elog_main;
 874
 875   if (VLIB_ELOG_MAIN_LOOP && n_vectors)
 876     elog_track (em,
 877                 /* event type */
 878                 vec_elt_at_index (is_return
 879                                   ? evm->node_return_elog_event_types
 880                                   : evm->node_call_elog_event_types,
 881                                   node_index),
 882                 /* track */
 883                 (vm->thread_index ? &vlib_worker_threads[vm->thread_index].
 884                  elog_track : &em->default_track),
 885                 /* data to log */ n_vectors);
 886 }
 887
 888 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
 889 void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 node_index);
 890 void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
 891
 892 void
 893 vlib_buffer_trace_trajectory_init (vlib_buffer_t * b)
 894 {
 895   if (PREDICT_TRUE (vlib_buffer_trace_trajectory_init_cb != 0))
 896     {
 897       (*vlib_buffer_trace_trajectory_init_cb) (b);
 898     }
 899 }
 900
 901 #endif
 902
 903 static inline void
 904 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
 905 {
 906 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
 907   if (PREDICT_TRUE (vlib_buffer_trace_trajectory_cb != 0))
 908     {
 909       (*vlib_buffer_trace_trajectory_cb) (b, node_index);
 910     }
 911 #endif
 912 }
 913
 914 static_always_inline u64
 915 dispatch_node (vlib_main_t * vm,
 916                vlib_node_runtime_t * node,
 917                vlib_node_type_t type,
 918                vlib_node_state_t dispatch_state,
 919                vlib_frame_t * frame, u64 last_time_stamp)
 920 {
 921   uword n, v;
 922   u64 t;
 923   vlib_node_main_t *nm = &vm->node_main;
 924   vlib_next_frame_t *nf;
 925
 926   if (CLIB_DEBUG > 0)
 927     {
 928       vlib_node_t *n = vlib_get_node (vm, node->node_index);
 929       ASSERT (n->type == type);
 930     }
 931
 932   /* Only non-internal nodes may be disabled. */
 933   if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
 934     {
 935       ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
 936       return last_time_stamp;
 937     }
 938
 939   if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
 940       && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
 941     {
 942       u32 c = node->input_main_loops_per_call;
 943       /* Only call node when count reaches zero. */
 944       if (c)
 945         {
 946           node->input_main_loops_per_call = c - 1;
 947           return last_time_stamp;
 948         }
 949     }
 950
 951   /* Speculatively prefetch next frames. */
 952   if (node->n_next_nodes > 0)
 953     {
 954       nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
 955       CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
 956     }
 957
 958   vm->cpu_time_last_node_dispatch = last_time_stamp;
 959
 960   if (1 /* || vm->thread_index == node->thread_index */ )
 961     {
 962       vlib_main_t *stat_vm;
 963
 964       stat_vm = /* vlib_mains ? vlib_mains[0] : */ vm;
 965
 966       vlib_elog_main_loop_event (vm, node->node_index,
 967                                  last_time_stamp,
 968                                  frame ? frame->n_vectors : 0,
 969                                  /* is_after */ 0);
 970
 971       /*
 972        * Turn this on if you run into
 973        * "bad monkey" contexts, and you want to know exactly
 974        * which nodes they've visited... See ixge.c...
 975        */
 976       if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
 977         {
 978           int i;
 979           u32 *from;
 980           from = vlib_frame_vector_args (frame);
 981           for (i = 0; i < frame->n_vectors; i++)
 982             {
 983               vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
 984               add_trajectory_trace (b, node->node_index);
 985             }
 986           n = node->function (vm, node, frame);
 987         }
 988       else
 989         n = node->function (vm, node, frame);
 990
 991       t = clib_cpu_time_now ();
 992
 993       vlib_elog_main_loop_event (vm, node->node_index, t, n,    /* is_after */
 994                                  1);
 995
 996       vm->main_loop_vectors_processed += n;
 997       vm->main_loop_nodes_processed += n > 0;
 998
 999       v = vlib_node_runtime_update_stats (stat_vm, node,
1000                                           /* n_calls */ 1,
1001                                           /* n_vectors */ n,
1002                                           /* n_clocks */ t - last_time_stamp);
1003
1004       /* When in interrupt mode and vector rate crosses threshold switch to
1005          polling mode. */
1006       if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1007           || (dispatch_state == VLIB_NODE_STATE_POLLING
1008               && (node->flags
1009                   & VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE)))
1010         {
1011 #ifdef DISPATCH_NODE_ELOG_REQUIRED
1012           ELOG_TYPE_DECLARE (e) =
1013           {
1014             .function = (char *) __FUNCTION__,.format =
1015               "%s vector length %d, switching to %s",.format_args =
1016               "T4i4t4",.n_enum_strings = 2,.enum_strings =
1017             {
1018           "interrupt", "polling",},};
1019           struct
1020           {
1021             u32 node_name, vector_length, is_polling;
1022           } *ed;
1023           vlib_worker_thread_t *w = vlib_worker_threads + vm->thread_index;
1024 #endif
1025
1026           if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1027                && v >= nm->polling_threshold_vector_length) &&
1028               !(node->flags &
1029                 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1030             {
1031               vlib_node_t *n = vlib_get_node (vm, node->node_index);
1032               n->state = VLIB_NODE_STATE_POLLING;
1033               node->state = VLIB_NODE_STATE_POLLING;
1034               node->flags &=
1035                 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1036               node->flags |=
1037                 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1038               nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1039               nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1040
1041 #ifdef DISPATCH_NODE_ELOG_REQUIRED
1042               ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1043                                     w->elog_track);
1044               ed->node_name = n->name_elog_string;
1045               ed->vector_length = v;
1046               ed->is_polling = 1;
1047 #endif
1048             }
1049           else if (dispatch_state == VLIB_NODE_STATE_POLLING
1050                    && v <= nm->interrupt_threshold_vector_length)
1051             {
1052               vlib_node_t *n = vlib_get_node (vm, node->node_index);
1053               if (node->flags &
1054                   VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1055                 {
1056                   /* Switch to interrupt mode after dispatch in polling one more time.
1057                      This allows driver to re-enable interrupts. */
1058                   n->state = VLIB_NODE_STATE_INTERRUPT;
1059                   node->state = VLIB_NODE_STATE_INTERRUPT;
1060                   node->flags &=
1061                     ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1062                   nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -=
1063                     1;
1064                   nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] +=
1065                     1;
1066
1067                 }
1068               else
1069                 {
1070                   node->flags |=
1071                     VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1072 #ifdef DISPATCH_NODE_ELOG_REQUIRED
1073                   ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1074                                         w->elog_track);
1075                   ed->node_name = n->name_elog_string;
1076                   ed->vector_length = v;
1077                   ed->is_polling = 0;
1078 #endif
1079                 }
1080             }
1081         }
1082     }
1083
1084   return t;
1085 }
1086
1087 static u64
1088 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1089                        u64 last_time_stamp)
1090 {
1091   vlib_node_main_t *nm = &vm->node_main;
1092   vlib_frame_t *f;
1093   vlib_next_frame_t *nf, nf_dummy;
1094   vlib_node_runtime_t *n;
1095   u32 restore_frame_index;
1096   vlib_pending_frame_t *p;
1097
1098   /* See comment below about dangling references to nm->pending_frames */
1099   p = nm->pending_frames + pending_frame_index;
1100
1101   n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1102                         p->node_runtime_index);
1103
1104   f = vlib_get_frame (vm, p->frame_index);
1105   if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1106     {
1107       /* No next frame: so use dummy on stack. */
1108       nf = &nf_dummy;
1109       nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1110       nf->frame_index = ~p->frame_index;
1111     }
1112   else
1113     nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1114
1115   ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1116
1117   /* Force allocation of new frame while current frame is being
1118      dispatched. */
1119   restore_frame_index = ~0;
1120   if (nf->frame_index == p->frame_index)
1121     {
1122       nf->frame_index = ~0;
1123       nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1124       if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1125         restore_frame_index = p->frame_index;
1126     }
1127
1128   /* Frame must be pending. */
1129   ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1130   ASSERT (f->n_vectors > 0);
1131
1132   /* Copy trace flag from next frame to node.
1133      Trace flag indicates that at least one vector in the dispatched
1134      frame is traced. */
1135   n->flags &= ~VLIB_NODE_FLAG_TRACE;
1136   n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1137   nf->flags &= ~VLIB_FRAME_TRACE;
1138
1139   last_time_stamp = dispatch_node (vm, n,
1140                                    VLIB_NODE_TYPE_INTERNAL,
1141                                    VLIB_NODE_STATE_POLLING,
1142                                    f, last_time_stamp);
1143
1144   f->frame_flags &= ~VLIB_FRAME_PENDING;
1145
1146   /* Frame is ready to be used again, so restore it. */
1147   if (restore_frame_index != ~0)
1148     {
1149       /*
1150        * We musn't restore a frame that is flagged to be freed. This
1151        * shouldn't happen since frames to be freed post dispatch are
1152        * those used when the to-node frame becomes full i.e. they form a
1153        * sort of queue of frames to a single node. If we get here then
1154        * the to-node frame and the pending frame *were* the same, and so
1155        * we removed the to-node frame.  Therefore this frame is no
1156        * longer part of the queue for that node and hence it cannot be
1157        * it's overspill.
1158        */
1159       ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1160
1161       /*
1162        * NB: dispatching node n can result in the creation and scheduling
1163        * of new frames, and hence in the reallocation of nm->pending_frames.
1164        * Recompute p, or no supper. This was broken for more than 10 years.
1165        */
1166       p = nm->pending_frames + pending_frame_index;
1167
1168       /*
1169        * p->next_frame_index can change during node dispatch if node
1170        * function decides to change graph hook up.
1171        */
1172       nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1173       nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1174
1175       if (~0 == nf->frame_index)
1176         {
1177           /* no new frame has been assigned to this node, use the saved one */
1178           nf->frame_index = restore_frame_index;
1179           f->n_vectors = 0;
1180         }
1181       else
1182         {
1183           /* The node has gained a frame, implying packets from the current frame
1184              were re-queued to this same node. we don't need the saved one
1185              anymore */
1186           vlib_frame_free (vm, n, f);
1187         }
1188     }
1189   else
1190     {
1191       if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1192         {
1193           ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1194           vlib_frame_free (vm, n, f);
1195         }
1196     }
1197
1198   return last_time_stamp;
1199 }
1200
1201 always_inline uword
1202 vlib_process_stack_is_valid (vlib_process_t * p)
1203 {
1204   return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1205 }
1206
1207 typedef struct
1208 {
1209   vlib_main_t *vm;
1210   vlib_process_t *process;
1211   vlib_frame_t *frame;
1212 } vlib_process_bootstrap_args_t;
1213
1214 /* Called in process stack. */
1215 static uword
1216 vlib_process_bootstrap (uword _a)
1217 {
1218   vlib_process_bootstrap_args_t *a;
1219   vlib_main_t *vm;
1220   vlib_node_runtime_t *node;
1221   vlib_frame_t *f;
1222   vlib_process_t *p;
1223   uword n;
1224
1225   a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1226
1227   vm = a->vm;
1228   p = a->process;
1229   f = a->frame;
1230   node = &p->node_runtime;
1231
1232   n = node->function (vm, node, f);
1233
1234   ASSERT (vlib_process_stack_is_valid (p));
1235
1236   clib_longjmp (&p->return_longjmp, n);
1237
1238   return n;
1239 }
1240
1241 /* Called in main stack. */
1242 static_always_inline uword
1243 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1244 {
1245   vlib_process_bootstrap_args_t a;
1246   uword r;
1247
1248   a.vm = vm;
1249   a.process = p;
1250   a.frame = f;
1251
1252   r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1253   if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1254     r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1255                       (void *) p->stack + (1 << p->log2_n_stack_bytes));
1256
1257   return r;
1258 }
1259
1260 static_always_inline uword
1261 vlib_process_resume (vlib_process_t * p)
1262 {
1263   uword r;
1264   p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1265                 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1266                 | VLIB_PROCESS_RESUME_PENDING);
1267   r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1268   if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1269     clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1270   return r;
1271 }
1272
1273 static u64
1274 dispatch_process (vlib_main_t * vm,
1275                   vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1276 {
1277   vlib_node_main_t *nm = &vm->node_main;
1278   vlib_node_runtime_t *node_runtime = &p->node_runtime;
1279   vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1280   u32 old_process_index;
1281   u64 t;
1282   uword n_vectors, is_suspend;
1283
1284   if (node->state != VLIB_NODE_STATE_POLLING
1285       || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1286                       | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1287     return last_time_stamp;
1288
1289   p->flags |= VLIB_PROCESS_IS_RUNNING;
1290
1291   t = last_time_stamp;
1292   vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1293                              f ? f->n_vectors : 0, /* is_after */ 0);
1294
1295   /* Save away current process for suspend. */
1296   old_process_index = nm->current_process_index;
1297   nm->current_process_index = node->runtime_index;
1298
1299   n_vectors = vlib_process_startup (vm, p, f);
1300
1301   nm->current_process_index = old_process_index;
1302
1303   ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1304   is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1305   if (is_suspend)
1306     {
1307       vlib_pending_frame_t *pf;
1308
1309       n_vectors = 0;
1310       pool_get (nm->suspended_process_frames, pf);
1311       pf->node_runtime_index = node->runtime_index;
1312       pf->frame_index = f ? vlib_frame_index (vm, f) : ~0;
1313       pf->next_frame_index = ~0;
1314
1315       p->n_suspends += 1;
1316       p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1317
1318       if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1319         {
1320           TWT (tw_timer_wheel) * tw =
1321             (TWT (tw_timer_wheel) *) nm->timing_wheel;
1322           p->stop_timer_handle =
1323             TW (tw_timer_start) (tw,
1324                                  vlib_timing_wheel_data_set_suspended_process
1325                                  (node->runtime_index) /* [sic] pool idex */ ,
1326                                  0 /* timer_id */ ,
1327                                  p->resume_clock_interval);
1328         }
1329     }
1330   else
1331     p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1332
1333   t = clib_cpu_time_now ();
1334
1335   vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1336                              /* is_after */ 1);
1337
1338   vlib_process_update_stats (vm, p,
1339                              /* n_calls */ !is_suspend,
1340                              /* n_vectors */ n_vectors,
1341                              /* n_clocks */ t - last_time_stamp);
1342
1343   return t;
1344 }
1345
1346 void
1347 vlib_start_process (vlib_main_t * vm, uword process_index)
1348 {
1349   vlib_node_main_t *nm = &vm->node_main;
1350   vlib_process_t *p = vec_elt (nm->processes, process_index);
1351   dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1352 }
1353
1354 static u64
1355 dispatch_suspended_process (vlib_main_t * vm,
1356                             uword process_index, u64 last_time_stamp)
1357 {
1358   vlib_node_main_t *nm = &vm->node_main;
1359   vlib_node_runtime_t *node_runtime;
1360   vlib_node_t *node;
1361   vlib_frame_t *f;
1362   vlib_process_t *p;
1363   vlib_pending_frame_t *pf;
1364   u64 t, n_vectors, is_suspend;
1365
1366   t = last_time_stamp;
1367
1368   p = vec_elt (nm->processes, process_index);
1369   if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1370     return last_time_stamp;
1371
1372   ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1373                       | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1374
1375   pf =
1376     pool_elt_at_index (nm->suspended_process_frames,
1377                        p->suspended_process_frame_index);
1378
1379   node_runtime = &p->node_runtime;
1380   node = vlib_get_node (vm, node_runtime->node_index);
1381   f = pf->frame_index != ~0 ? vlib_get_frame (vm, pf->frame_index) : 0;
1382
1383   vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1384                              f ? f->n_vectors : 0, /* is_after */ 0);
1385
1386   /* Save away current process for suspend. */
1387   nm->current_process_index = node->runtime_index;
1388
1389   n_vectors = vlib_process_resume (p);
1390   t = clib_cpu_time_now ();
1391
1392   nm->current_process_index = ~0;
1393
1394   is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1395   if (is_suspend)
1396     {
1397       /* Suspend it again. */
1398       n_vectors = 0;
1399       p->n_suspends += 1;
1400       if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1401         {
1402           p->stop_timer_handle =
1403             TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1404                                  vlib_timing_wheel_data_set_suspended_process
1405                                  (node->runtime_index) /* [sic] pool idex */ ,
1406                                  0 /* timer_id */ ,
1407                                  p->resume_clock_interval);
1408         }
1409     }
1410   else
1411     {
1412       p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1413       p->suspended_process_frame_index = ~0;
1414       pool_put (nm->suspended_process_frames, pf);
1415     }
1416
1417   t = clib_cpu_time_now ();
1418   vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1419                              /* is_after */ 1);
1420
1421   vlib_process_update_stats (vm, p,
1422                              /* n_calls */ !is_suspend,
1423                              /* n_vectors */ n_vectors,
1424                              /* n_clocks */ t - last_time_stamp);
1425
1426   return t;
1427 }
1428
1429 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1430 void
1431 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1432 {
1433 }
1434
1435
1436 static_always_inline void
1437 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1438 {
1439   vlib_node_main_t *nm = &vm->node_main;
1440   vlib_thread_main_t *tm = vlib_get_thread_main ();
1441   uword i;
1442   u64 cpu_time_now;
1443   vlib_frame_queue_main_t *fqm;
1444   u32 *last_node_runtime_indices = 0;
1445
1446   /* Initialize pending node vector. */
1447   if (is_main)
1448     {
1449       vec_resize (nm->pending_frames, 32);
1450       _vec_len (nm->pending_frames) = 0;
1451     }
1452
1453   /* Mark time of main loop start. */
1454   if (is_main)
1455     {
1456       cpu_time_now = vm->clib_time.last_cpu_time;
1457       vm->cpu_time_main_loop_start = cpu_time_now;
1458     }
1459   else
1460     cpu_time_now = clib_cpu_time_now ();
1461
1462   /* Pre-allocate interupt runtime indices and lock. */
1463   vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1464   vec_alloc (last_node_runtime_indices, 32);
1465   if (!is_main)
1466     clib_spinlock_init (&nm->pending_interrupt_lock);
1467
1468   /* Pre-allocate expired nodes. */
1469   if (!nm->polling_threshold_vector_length)
1470     nm->polling_threshold_vector_length = 10;
1471   if (!nm->interrupt_threshold_vector_length)
1472     nm->interrupt_threshold_vector_length = 5;
1473
1474   /* Start all processes. */
1475   if (is_main)
1476     {
1477       uword i;
1478       nm->current_process_index = ~0;
1479       for (i = 0; i < vec_len (nm->processes); i++)
1480         cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1481                                          cpu_time_now);
1482     }
1483
1484   while (1)
1485     {
1486       vlib_node_runtime_t *n;
1487
1488       if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1489         vl_api_send_pending_rpc_requests (vm);
1490
1491       if (!is_main)
1492         {
1493           vlib_worker_thread_barrier_check ();
1494           vec_foreach (fqm, tm->frame_queue_mains)
1495             vlib_frame_queue_dequeue (vm, fqm);
1496         }
1497
1498       /* Process pre-input nodes. */
1499       vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1500         cpu_time_now = dispatch_node (vm, n,
1501                                       VLIB_NODE_TYPE_PRE_INPUT,
1502                                       VLIB_NODE_STATE_POLLING,
1503                                       /* frame */ 0,
1504                                       cpu_time_now);
1505
1506       /* Next process input nodes. */
1507       vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1508         cpu_time_now = dispatch_node (vm, n,
1509                                       VLIB_NODE_TYPE_INPUT,
1510                                       VLIB_NODE_STATE_POLLING,
1511                                       /* frame */ 0,
1512                                       cpu_time_now);
1513
1514       if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1515         vm->queue_signal_callback (vm);
1516
1517       /* Next handle interrupts. */
1518       {
1519         /* unlocked read, for performance */
1520         uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1521         uword i;
1522         if (PREDICT_FALSE (l > 0))
1523           {
1524             u32 *tmp;
1525             if (!is_main)
1526               {
1527                 clib_spinlock_lock (&nm->pending_interrupt_lock);
1528                 /* Re-read w/ lock held, in case another thread added an item */
1529                 l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1530               }
1531
1532             tmp = nm->pending_interrupt_node_runtime_indices;
1533             nm->pending_interrupt_node_runtime_indices =
1534               last_node_runtime_indices;
1535             last_node_runtime_indices = tmp;
1536             _vec_len (last_node_runtime_indices) = 0;
1537             if (!is_main)
1538               clib_spinlock_unlock (&nm->pending_interrupt_lock);
1539             for (i = 0; i < l; i++)
1540               {
1541                 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1542                                       last_node_runtime_indices[i]);
1543                 cpu_time_now =
1544                   dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1545                                  VLIB_NODE_STATE_INTERRUPT,
1546                                  /* frame */ 0,
1547                                  cpu_time_now);
1548               }
1549           }
1550       }
1551       /* Input nodes may have added work to the pending vector.
1552          Process pending vector until there is nothing left.
1553          All pending vectors will be processed from input -> output. */
1554       for (i = 0; i < _vec_len (nm->pending_frames); i++)
1555         cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1556       /* Reset pending vector for next iteration. */
1557       _vec_len (nm->pending_frames) = 0;
1558
1559       if (is_main)
1560         {
1561           /* Check if process nodes have expired from timing wheel. */
1562           ASSERT (nm->data_from_advancing_timing_wheel != 0);
1563
1564           nm->data_from_advancing_timing_wheel =
1565             TW (tw_timer_expire_timers_vec)
1566             ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1567              nm->data_from_advancing_timing_wheel);
1568
1569           ASSERT (nm->data_from_advancing_timing_wheel != 0);
1570
1571           if (PREDICT_FALSE
1572               (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1573             {
1574               uword i;
1575
1576               for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1577                    i++)
1578                 {
1579                   u32 d = nm->data_from_advancing_timing_wheel[i];
1580                   u32 di = vlib_timing_wheel_data_get_index (d);
1581
1582                   if (vlib_timing_wheel_data_is_timed_event (d))
1583                     {
1584                       vlib_signal_timed_event_data_t *te =
1585                         pool_elt_at_index (nm->signal_timed_event_data_pool,
1586                                            di);
1587                       vlib_node_t *n =
1588                         vlib_get_node (vm, te->process_node_index);
1589                       vlib_process_t *p =
1590                         vec_elt (nm->processes, n->runtime_index);
1591                       void *data;
1592                       data =
1593                         vlib_process_signal_event_helper (nm, n, p,
1594                                                           te->event_type_index,
1595                                                           te->n_data_elts,
1596                                                           te->n_data_elt_bytes);
1597                       if (te->n_data_bytes < sizeof (te->inline_event_data))
1598                         clib_memcpy (data, te->inline_event_data,
1599                                      te->n_data_bytes);
1600                       else
1601                         {
1602                           clib_memcpy (data, te->event_data_as_vector,
1603                                        te->n_data_bytes);
1604                           vec_free (te->event_data_as_vector);
1605                         }
1606                       pool_put (nm->signal_timed_event_data_pool, te);
1607                     }
1608                   else
1609                     {
1610                       cpu_time_now = clib_cpu_time_now ();
1611                       cpu_time_now =
1612                         dispatch_suspended_process (vm, di, cpu_time_now);
1613                     }
1614                 }
1615               _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1616             }
1617         }
1618       vlib_increment_main_loop_counter (vm);
1619
1620       /* Record time stamp in case there are no enabled nodes and above
1621          calls do not update time stamp. */
1622       cpu_time_now = clib_cpu_time_now ();
1623     }
1624 }
1625
1626 static void
1627 vlib_main_loop (vlib_main_t * vm)
1628 {
1629   vlib_main_or_worker_loop (vm, /* is_main */ 1);
1630 }
1631
1632 void
1633 vlib_worker_loop (vlib_main_t * vm)
1634 {
1635   vlib_main_or_worker_loop (vm, /* is_main */ 0);
1636 }
1637
1638 vlib_main_t vlib_global_main;
1639
1640 static clib_error_t *
1641 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1642 {
1643   int turn_on_mem_trace = 0;
1644
1645   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1646     {
1647       if (unformat (input, "memory-trace"))
1648         turn_on_mem_trace = 1;
1649
1650       else if (unformat (input, "elog-events %d",
1651                          &vm->elog_main.event_ring_size))
1652         ;
1653       else if (unformat (input, "elog-post-mortem-dump"))
1654         vm->elog_post_mortem_dump = 1;
1655       else
1656         return unformat_parse_error (input);
1657     }
1658
1659   unformat_free (input);
1660
1661   /* Enable memory trace as early as possible. */
1662   if (turn_on_mem_trace)
1663     clib_mem_trace (1);
1664
1665   return 0;
1666 }
1667
1668 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1669
1670 static void
1671 dummy_queue_signal_callback (vlib_main_t * vm)
1672 {
1673 }
1674
1675 #define foreach_weak_reference_stub             \
1676 _(vlib_map_stat_segment_init)                   \
1677 _(vpe_api_init)                                 \
1678 _(vlibmemory_init)                              \
1679 _(map_api_segment_init)
1680
1681 #define _(name)                                                 \
1682 clib_error_t *name (vlib_main_t *vm) __attribute__((weak));     \
1683 clib_error_t *name (vlib_main_t *vm) { return 0; }
1684 foreach_weak_reference_stub;
1685 #undef _
1686
1687 /* Main function. */
1688 int
1689 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
1690 {
1691   clib_error_t *volatile error;
1692   vlib_node_main_t *nm = &vm->node_main;
1693
1694   vm->queue_signal_callback = dummy_queue_signal_callback;
1695
1696   clib_time_init (&vm->clib_time);
1697
1698   /* Turn on event log. */
1699   if (!vm->elog_main.event_ring_size)
1700     vm->elog_main.event_ring_size = 128 << 10;
1701   elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
1702   elog_enable_disable (&vm->elog_main, 1);
1703
1704   /* Default name. */
1705   if (!vm->name)
1706     vm->name = "VLIB";
1707
1708   if ((error = unix_physmem_init (vm)))
1709     {
1710       clib_error_report (error);
1711       goto done;
1712     }
1713
1714   if ((error = vlib_buffer_main_init (vm)))
1715     {
1716       clib_error_report (error);
1717       goto done;
1718     }
1719
1720   if ((error = vlib_thread_init (vm)))
1721     {
1722       clib_error_report (error);
1723       goto done;
1724     }
1725
1726   if ((error = vlib_map_stat_segment_init (vm)))
1727     {
1728       clib_error_report (error);
1729       goto done;
1730     }
1731
1732   /* Register static nodes so that init functions may use them. */
1733   vlib_register_all_static_nodes (vm);
1734
1735   /* Set seed for random number generator.
1736      Allow user to specify seed to make random sequence deterministic. */
1737   if (!unformat (input, "seed %wd", &vm->random_seed))
1738     vm->random_seed = clib_cpu_time_now ();
1739   clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
1740
1741   /* Initialize node graph. */
1742   if ((error = vlib_node_main_init (vm)))
1743     {
1744       /* Arrange for graph hook up error to not be fatal when debugging. */
1745       if (CLIB_DEBUG > 0)
1746         clib_error_report (error);
1747       else
1748         goto done;
1749     }
1750
1751   /* Direct call / weak reference, for vlib standalone use-cases */
1752   if ((error = vpe_api_init (vm)))
1753     {
1754       clib_error_report (error);
1755       goto done;
1756     }
1757
1758   if ((error = vlibmemory_init (vm)))
1759     {
1760       clib_error_report (error);
1761       goto done;
1762     }
1763
1764   if ((error = map_api_segment_init (vm)))
1765     {
1766       clib_error_report (error);
1767       goto done;
1768     }
1769
1770   /* See unix/main.c; most likely already set up */
1771   if (vm->init_functions_called == 0)
1772     vm->init_functions_called = hash_create (0, /* value bytes */ 0);
1773   if ((error = vlib_call_all_init_functions (vm)))
1774     goto done;
1775
1776   /* Create default buffer free list. */
1777   vlib_buffer_create_free_list (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
1778                                 "default");
1779
1780   nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
1781                                              CLIB_CACHE_LINE_BYTES);
1782
1783   vec_validate (nm->data_from_advancing_timing_wheel, 10);
1784   _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1785
1786   /* Create the process timing wheel */
1787   TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1788                             0 /* no callback */ ,
1789                             10e-6 /* timer period 10us */ ,
1790                             ~0 /* max expirations per call */ );
1791
1792   vec_validate (vm->pending_rpc_requests, 0);
1793   _vec_len (vm->pending_rpc_requests) = 0;
1794
1795   switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
1796     {
1797     case VLIB_MAIN_LOOP_EXIT_NONE:
1798       vm->main_loop_exit_set = 1;
1799       break;
1800
1801     case VLIB_MAIN_LOOP_EXIT_CLI:
1802       goto done;
1803
1804     default:
1805       error = vm->main_loop_error;
1806       goto done;
1807     }
1808
1809   if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
1810     goto done;
1811
1812   /* Call all main loop enter functions. */
1813   {
1814     clib_error_t *sub_error;
1815     sub_error = vlib_call_all_main_loop_enter_functions (vm);
1816     if (sub_error)
1817       clib_error_report (sub_error);
1818   }
1819
1820   vlib_main_loop (vm);
1821
1822 done:
1823   /* Call all exit functions. */
1824   {
1825     clib_error_t *sub_error;
1826     sub_error = vlib_call_all_main_loop_exit_functions (vm);
1827     if (sub_error)
1828       clib_error_report (sub_error);
1829   }
1830
1831   if (error)
1832     clib_error_report (error);
1833
1834   return 0;
1835 }
1836
1837 /*
1838  * fd.io coding-style-patch-verification: ON
1839  *
1840  * Local Variables:
1841  * eval: (c-set-style "gnu")
1842  * End:
1843  */