vlib/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
  45 #include <vlib/unix/cj.h>
  46
  47 CJ_GLOBAL_LOG_PROTOTYPE;
  48
  49 /* Actually allocate a few extra slots of vector data to support
  50    speculative vector enqueues which overflow vector data in next frame. */
  51 #define VLIB_FRAME_SIZE_ALLOC (VLIB_FRAME_SIZE + 4)
  52
  53 always_inline u32
  54 vlib_frame_bytes (u32 n_scalar_bytes, u32 n_vector_bytes)
  55 {
  56   u32 n_bytes;
  57
  58   /* Make room for vlib_frame_t plus scalar arguments. */
  59   n_bytes = vlib_frame_vector_byte_offset (n_scalar_bytes);
  60
  61   /* Make room for vector arguments.
  62      Allocate a few extra slots of vector data to support
  63      speculative vector enqueues which overflow vector data in next frame. */
  64 #define VLIB_FRAME_SIZE_EXTRA 4
  65   n_bytes += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * n_vector_bytes;
  66
  67   /* Magic number is first 32bit number after vector data.
  68      Used to make sure that vector data is never overrun. */
  69 #define VLIB_FRAME_MAGIC (0xabadc0ed)
  70   n_bytes += sizeof (u32);
  71
  72   /* Pad to cache line. */
  73   n_bytes = round_pow2 (n_bytes, CLIB_CACHE_LINE_BYTES);
  74
  75   return n_bytes;
  76 }
  77
  78 always_inline u32 *
  79 vlib_frame_find_magic (vlib_frame_t * f, vlib_node_t * node)
  80 {
  81   void *p = f;
  82
  83   p += vlib_frame_vector_byte_offset (node->scalar_size);
  84
  85   p += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * node->vector_size;
  86
  87   return p;
  88 }
  89
  90 static vlib_frame_size_t *
  91 get_frame_size_info (vlib_node_main_t * nm,
  92                      u32 n_scalar_bytes, u32 n_vector_bytes)
  93 {
  94   uword key = (n_scalar_bytes << 16) | n_vector_bytes;
  95   uword *p, i;
  96
  97   p = hash_get (nm->frame_size_hash, key);
  98   if (p)
  99     i = p[0];
 100   else
 101     {
 102       i = vec_len (nm->frame_sizes);
 103       vec_validate (nm->frame_sizes, i);
 104       hash_set (nm->frame_size_hash, key, i);
 105     }
 106
 107   return vec_elt_at_index (nm->frame_sizes, i);
 108 }
 109
 110 static u32
 111 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
 112                           u32 frame_flags)
 113 {
 114   vlib_node_main_t *nm = &vm->node_main;
 115   vlib_frame_size_t *fs;
 116   vlib_node_t *to_node;
 117   vlib_frame_t *f;
 118   u32 fi, l, n, scalar_size, vector_size;
 119
 120   to_node = vlib_get_node (vm, to_node_index);
 121
 122   scalar_size = to_node->scalar_size;
 123   vector_size = to_node->vector_size;
 124
 125   fs = get_frame_size_info (nm, scalar_size, vector_size);
 126   n = vlib_frame_bytes (scalar_size, vector_size);
 127   if ((l = vec_len (fs->free_frame_indices)) > 0)
 128     {
 129       /* Allocate from end of free list. */
 130       fi = fs->free_frame_indices[l - 1];
 131       f = vlib_get_frame_no_check (vm, fi);
 132       _vec_len (fs->free_frame_indices) = l - 1;
 133     }
 134   else
 135     {
 136       f = clib_mem_alloc_aligned_no_fail (n, VLIB_FRAME_ALIGN);
 137       f->cpu_index = vm->cpu_index;
 138       fi = vlib_frame_index_no_check (vm, f);
 139     }
 140
 141   /* Poison frame when debugging. */
 142   if (CLIB_DEBUG > 0)
 143     {
 144       u32 save_cpu_index = f->cpu_index;
 145
 146       memset (f, 0xfe, n);
 147
 148       f->cpu_index = save_cpu_index;
 149     }
 150
 151   /* Insert magic number. */
 152   {
 153     u32 *magic;
 154
 155     magic = vlib_frame_find_magic (f, to_node);
 156     *magic = VLIB_FRAME_MAGIC;
 157   }
 158
 159   f->flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
 160   f->n_vectors = 0;
 161   f->scalar_size = scalar_size;
 162   f->vector_size = vector_size;
 163
 164   fs->n_alloc_frames += 1;
 165
 166   return fi;
 167 }
 168
 169 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
 170    Returns frame index. */
 171 static u32
 172 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
 173                   u32 to_next_index)
 174 {
 175   vlib_node_t *from_node;
 176
 177   from_node = vlib_get_node (vm, from_node_runtime->node_index);
 178   ASSERT (to_next_index < vec_len (from_node->next_nodes));
 179
 180   return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
 181                                    /* frame_flags */ 0);
 182 }
 183
 184 vlib_frame_t *
 185 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
 186 {
 187   u32 fi = vlib_frame_alloc_to_node (vm, to_node_index,
 188                                      /* frame_flags */
 189                                      VLIB_FRAME_FREE_AFTER_DISPATCH);
 190   return vlib_get_frame (vm, fi);
 191 }
 192
 193 void
 194 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
 195 {
 196   vlib_pending_frame_t *p;
 197   vlib_node_t *to_node;
 198
 199   if (f->n_vectors == 0)
 200     return;
 201
 202   to_node = vlib_get_node (vm, to_node_index);
 203
 204   vec_add2 (vm->node_main.pending_frames, p, 1);
 205
 206   f->flags |= VLIB_FRAME_PENDING;
 207   p->frame_index = vlib_frame_index (vm, f);
 208   p->node_runtime_index = to_node->runtime_index;
 209   p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
 210 }
 211
 212 /* Free given frame. */
 213 void
 214 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
 215 {
 216   vlib_node_main_t *nm = &vm->node_main;
 217   vlib_node_t *node;
 218   vlib_frame_size_t *fs;
 219   u32 frame_index;
 220
 221   ASSERT (f->flags & VLIB_FRAME_IS_ALLOCATED);
 222
 223   node = vlib_get_node (vm, r->node_index);
 224   fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
 225
 226   frame_index = vlib_frame_index (vm, f);
 227
 228   ASSERT (f->flags & VLIB_FRAME_IS_ALLOCATED);
 229
 230   /* No next frames may point to freed frame. */
 231   if (CLIB_DEBUG > 0)
 232     {
 233       vlib_next_frame_t *nf;
 234       vec_foreach (nf, vm->node_main.next_frames)
 235         ASSERT (nf->frame_index != frame_index);
 236     }
 237
 238   f->flags &= ~VLIB_FRAME_IS_ALLOCATED;
 239
 240   vec_add1 (fs->free_frame_indices, frame_index);
 241   ASSERT (fs->n_alloc_frames > 0);
 242   fs->n_alloc_frames -= 1;
 243 }
 244
 245 static clib_error_t *
 246 show_frame_stats (vlib_main_t * vm,
 247                   unformat_input_t * input, vlib_cli_command_t * cmd)
 248 {
 249   vlib_node_main_t *nm = &vm->node_main;
 250   vlib_frame_size_t *fs;
 251
 252   vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
 253   vec_foreach (fs, nm->frame_sizes)
 254   {
 255     u32 n_alloc = fs->n_alloc_frames;
 256     u32 n_free = vec_len (fs->free_frame_indices);
 257
 258     if (n_alloc + n_free > 0)
 259       vlib_cli_output (vm, "%=6d%=12d%=12d",
 260                        fs - nm->frame_sizes, n_alloc, n_free);
 261   }
 262
 263   return 0;
 264 }
 265
 266 /* *INDENT-OFF* */
 267 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
 268   .path = "show vlib frame-allocation",
 269   .short_help = "Show node dispatch frame statistics",
 270   .function = show_frame_stats,
 271 };
 272 /* *INDENT-ON* */
 273
 274 /* Change ownership of enqueue rights to given next node. */
 275 static void
 276 vlib_next_frame_change_ownership (vlib_main_t * vm,
 277                                   vlib_node_runtime_t * node_runtime,
 278                                   u32 next_index)
 279 {
 280   vlib_node_main_t *nm = &vm->node_main;
 281   vlib_next_frame_t *next_frame;
 282   vlib_node_t *node, *next_node;
 283
 284   node = vec_elt (nm->nodes, node_runtime->node_index);
 285
 286   /* Only internal & input nodes are allowed to call other nodes. */
 287   ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
 288           || node->type == VLIB_NODE_TYPE_INPUT
 289           || node->type == VLIB_NODE_TYPE_PROCESS);
 290
 291   ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
 292
 293   next_frame =
 294     vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
 295   next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
 296
 297   if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
 298     {
 299       /* Get frame from previous owner. */
 300       vlib_next_frame_t *owner_next_frame;
 301       vlib_next_frame_t tmp;
 302
 303       owner_next_frame =
 304         vlib_node_get_next_frame (vm,
 305                                   next_node->owner_node_index,
 306                                   next_node->owner_next_index);
 307
 308       /* Swap target next frame with owner's. */
 309       tmp = owner_next_frame[0];
 310       owner_next_frame[0] = next_frame[0];
 311       next_frame[0] = tmp;
 312
 313       /*
 314        * If next_frame is already pending, we have to track down
 315        * all pending frames and fix their next_frame_index fields.
 316        */
 317       if (next_frame->flags & VLIB_FRAME_PENDING)
 318         {
 319           vlib_pending_frame_t *p;
 320           if (next_frame->frame_index != ~0)
 321             {
 322               vec_foreach (p, nm->pending_frames)
 323               {
 324                 if (p->frame_index == next_frame->frame_index)
 325                   {
 326                     p->next_frame_index =
 327                       next_frame - vm->node_main.next_frames;
 328                   }
 329               }
 330             }
 331         }
 332     }
 333   else
 334     {
 335       /* No previous owner. Take ownership. */
 336       next_frame->flags |= VLIB_FRAME_OWNER;
 337     }
 338
 339   /* Record new owner. */
 340   next_node->owner_node_index = node->index;
 341   next_node->owner_next_index = next_index;
 342
 343   /* Now we should be owner. */
 344   ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
 345 }
 346
 347 /* Make sure that magic number is still there.
 348    Otherwise, it is likely that caller has overrun frame arguments. */
 349 always_inline void
 350 validate_frame_magic (vlib_main_t * vm,
 351                       vlib_frame_t * f, vlib_node_t * n, uword next_index)
 352 {
 353   vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
 354   u32 *magic = vlib_frame_find_magic (f, next_node);
 355   ASSERT (VLIB_FRAME_MAGIC == magic[0]);
 356 }
 357
 358 vlib_frame_t *
 359 vlib_get_next_frame_internal (vlib_main_t * vm,
 360                               vlib_node_runtime_t * node,
 361                               u32 next_index, u32 allocate_new_next_frame)
 362 {
 363   vlib_frame_t *f;
 364   vlib_next_frame_t *nf;
 365   u32 n_used;
 366
 367   nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
 368
 369   /* Make sure this next frame owns right to enqueue to destination frame. */
 370   if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
 371     vlib_next_frame_change_ownership (vm, node, next_index);
 372
 373   /* ??? Don't need valid flag: can use frame_index == ~0 */
 374   if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
 375     {
 376       nf->frame_index = vlib_frame_alloc (vm, node, next_index);
 377       nf->flags |= VLIB_FRAME_IS_ALLOCATED;
 378     }
 379
 380   f = vlib_get_frame (vm, nf->frame_index);
 381
 382   /* Has frame been removed from pending vector (e.g. finished dispatching)?
 383      If so we can reuse frame. */
 384   if ((nf->flags & VLIB_FRAME_PENDING) && !(f->flags & VLIB_FRAME_PENDING))
 385     {
 386       nf->flags &= ~VLIB_FRAME_PENDING;
 387       f->n_vectors = 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->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 (DPDK == 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->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->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->cpu_index != next_runtime->cpu_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 {
 547   vlib_node_t *n = vlib_get_node (vm, r->node_index);
 548
 549   n->stats_total.calls += n_calls + r->calls_since_last_overflow;
 550   n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
 551   n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
 552   n->stats_total.max_clock = r->max_clock;
 553   n->stats_total.max_clock_n = r->max_clock_n;
 554
 555   r->calls_since_last_overflow = 0;
 556   r->vectors_since_last_overflow = 0;
 557   r->clocks_since_last_overflow = 0;
 558 }
 559
 560 always_inline void __attribute__ ((unused))
 561 vlib_process_sync_stats (vlib_main_t * vm,
 562                          vlib_process_t * p,
 563                          uword n_calls, uword n_vectors, uword n_clocks)
 564 {
 565   vlib_node_runtime_t *rt = &p->node_runtime;
 566   vlib_node_t *n = vlib_get_node (vm, rt->node_index);
 567   vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks);
 568   n->stats_total.suspends += p->n_suspends;
 569   p->n_suspends = 0;
 570 }
 571
 572 void
 573 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
 574 {
 575   vlib_node_runtime_t *rt;
 576
 577   if (n->type == VLIB_NODE_TYPE_PROCESS)
 578     {
 579       /* Nothing to do for PROCESS nodes except in main thread */
 580       if (vm != &vlib_global_main)
 581         return;
 582
 583       vlib_process_t *p = vlib_get_process_from_node (vm, n);
 584       n->stats_total.suspends += p->n_suspends;
 585       p->n_suspends = 0;
 586       rt = &p->node_runtime;
 587     }
 588   else
 589     rt =
 590       vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
 591                         n->runtime_index);
 592
 593   vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0);
 594
 595   /* Sync up runtime next frame vector counters with main node structure. */
 596   {
 597     vlib_next_frame_t *nf;
 598     uword i;
 599     for (i = 0; i < rt->n_next_nodes; i++)
 600       {
 601         nf = vlib_node_runtime_get_next_frame (vm, rt, i);
 602         vec_elt (n->n_vectors_by_next_node, i) +=
 603           nf->vectors_since_last_overflow;
 604         nf->vectors_since_last_overflow = 0;
 605       }
 606   }
 607 }
 608
 609 always_inline u32
 610 vlib_node_runtime_update_stats (vlib_main_t * vm,
 611                                 vlib_node_runtime_t * node,
 612                                 uword n_calls,
 613                                 uword n_vectors, uword n_clocks)
 614 {
 615   u32 ca0, ca1, v0, v1, cl0, cl1, r;
 616
 617   cl0 = cl1 = node->clocks_since_last_overflow;
 618   ca0 = ca1 = node->calls_since_last_overflow;
 619   v0 = v1 = node->vectors_since_last_overflow;
 620
 621   ca1 = ca0 + n_calls;
 622   v1 = v0 + n_vectors;
 623   cl1 = cl0 + n_clocks;
 624
 625   node->calls_since_last_overflow = ca1;
 626   node->clocks_since_last_overflow = cl1;
 627   node->vectors_since_last_overflow = v1;
 628   node->max_clock_n = node->max_clock > n_clocks ?
 629     node->max_clock_n : n_vectors;
 630   node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
 631
 632   r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
 633
 634   if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0))
 635     {
 636       node->calls_since_last_overflow = ca0;
 637       node->clocks_since_last_overflow = cl0;
 638       node->vectors_since_last_overflow = v0;
 639       vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks);
 640     }
 641
 642   return r;
 643 }
 644
 645 always_inline void
 646 vlib_process_update_stats (vlib_main_t * vm,
 647                            vlib_process_t * p,
 648                            uword n_calls, uword n_vectors, uword n_clocks)
 649 {
 650   vlib_node_runtime_update_stats (vm, &p->node_runtime,
 651                                   n_calls, n_vectors, n_clocks);
 652 }
 653
 654 static clib_error_t *
 655 vlib_cli_elog_clear (vlib_main_t * vm,
 656                      unformat_input_t * input, vlib_cli_command_t * cmd)
 657 {
 658   elog_reset_buffer (&vm->elog_main);
 659   return 0;
 660 }
 661
 662 /* *INDENT-OFF* */
 663 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
 664   .path = "event-logger clear",
 665   .short_help = "Clear the event log",
 666   .function = vlib_cli_elog_clear,
 667 };
 668 /* *INDENT-ON* */
 669
 670 #ifdef CLIB_UNIX
 671 static clib_error_t *
 672 elog_save_buffer (vlib_main_t * vm,
 673                   unformat_input_t * input, vlib_cli_command_t * cmd)
 674 {
 675   elog_main_t *em = &vm->elog_main;
 676   char *file, *chroot_file;
 677   clib_error_t *error = 0;
 678
 679   if (!unformat (input, "%s", &file))
 680     {
 681       vlib_cli_output (vm, "expected file name, got `%U'",
 682                        format_unformat_error, input);
 683       return 0;
 684     }
 685
 686   /* It's fairly hard to get "../oopsie" through unformat; just in case */
 687   if (strstr (file, "..") || index (file, '/'))
 688     {
 689       vlib_cli_output (vm, "illegal characters in filename '%s'", file);
 690       return 0;
 691     }
 692
 693   chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
 694
 695   vec_free (file);
 696
 697   vlib_cli_output (vm, "Saving %wd of %wd events to %s",
 698                    elog_n_events_in_buffer (em),
 699                    elog_buffer_capacity (em), chroot_file);
 700
 701   vlib_worker_thread_barrier_sync (vm);
 702   error = elog_write_file (em, chroot_file);
 703   vlib_worker_thread_barrier_release (vm);
 704   vec_free (chroot_file);
 705   return error;
 706 }
 707
 708 /* *INDENT-OFF* */
 709 VLIB_CLI_COMMAND (elog_save_cli, static) = {
 710   .path = "event-logger save",
 711   .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
 712   .function = elog_save_buffer,
 713 };
 714 /* *INDENT-ON* */
 715
 716 static clib_error_t *
 717 elog_stop (vlib_main_t * vm,
 718            unformat_input_t * input, vlib_cli_command_t * cmd)
 719 {
 720   elog_main_t *em = &vm->elog_main;
 721
 722   em->n_total_events_disable_limit = em->n_total_events;
 723
 724   vlib_cli_output (vm, "Stopped the event logger...");
 725   return 0;
 726 }
 727
 728 /* *INDENT-OFF* */
 729 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
 730   .path = "event-logger stop",
 731   .short_help = "Stop the event-logger",
 732   .function = elog_stop,
 733 };
 734 /* *INDENT-ON* */
 735
 736 static clib_error_t *
 737 elog_restart (vlib_main_t * vm,
 738               unformat_input_t * input, vlib_cli_command_t * cmd)
 739 {
 740   elog_main_t *em = &vm->elog_main;
 741
 742   em->n_total_events_disable_limit = ~0;
 743
 744   vlib_cli_output (vm, "Restarted the event logger...");
 745   return 0;
 746 }
 747
 748 /* *INDENT-OFF* */
 749 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
 750   .path = "event-logger restart",
 751   .short_help = "Restart the event-logger",
 752   .function = elog_restart,
 753 };
 754 /* *INDENT-ON* */
 755
 756 static clib_error_t *
 757 elog_resize (vlib_main_t * vm,
 758              unformat_input_t * input, vlib_cli_command_t * cmd)
 759 {
 760   elog_main_t *em = &vm->elog_main;
 761   u32 tmp;
 762
 763   /* Stop the parade */
 764   elog_reset_buffer (&vm->elog_main);
 765
 766   if (unformat (input, "%d", &tmp))
 767     {
 768       elog_alloc (em, tmp);
 769       em->n_total_events_disable_limit = ~0;
 770     }
 771   else
 772     return clib_error_return (0, "Must specify how many events in the ring");
 773
 774   vlib_cli_output (vm, "Resized ring and restarted the event logger...");
 775   return 0;
 776 }
 777
 778 /* *INDENT-OFF* */
 779 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
 780   .path = "event-logger resize",
 781   .short_help = "event-logger resize <nnn>",
 782   .function = elog_resize,
 783 };
 784 /* *INDENT-ON* */
 785
 786 #endif /* CLIB_UNIX */
 787
 788 static void
 789 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
 790 {
 791   elog_main_t *em = &vm->elog_main;
 792   elog_event_t *e, *es;
 793   f64 dt;
 794
 795   /* Show events in VLIB time since log clock starts after VLIB clock. */
 796   dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
 797     * vm->clib_time.seconds_per_clock;
 798
 799   es = elog_peek_events (em);
 800   vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
 801                    em->event_ring_size,
 802                    em->n_total_events < em->n_total_events_disable_limit ?
 803                    "running" : "stopped");
 804   vec_foreach (e, es)
 805   {
 806     vlib_cli_output (vm, "%18.9f: %U",
 807                      e->time + dt, format_elog_event, em, e);
 808     n_events_to_show--;
 809     if (n_events_to_show == 0)
 810       break;
 811   }
 812   vec_free (es);
 813
 814 }
 815
 816 static clib_error_t *
 817 elog_show_buffer (vlib_main_t * vm,
 818                   unformat_input_t * input, vlib_cli_command_t * cmd)
 819 {
 820   u32 n_events_to_show;
 821   clib_error_t *error = 0;
 822
 823   n_events_to_show = 250;
 824   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 825     {
 826       if (unformat (input, "%d", &n_events_to_show))
 827         ;
 828       else if (unformat (input, "all"))
 829         n_events_to_show = ~0;
 830       else
 831         return unformat_parse_error (input);
 832     }
 833   elog_show_buffer_internal (vm, n_events_to_show);
 834   return error;
 835 }
 836
 837 /* *INDENT-OFF* */
 838 VLIB_CLI_COMMAND (elog_show_cli, static) = {
 839   .path = "show event-logger",
 840   .short_help = "Show event logger info",
 841   .function = elog_show_buffer,
 842 };
 843 /* *INDENT-ON* */
 844
 845 void
 846 vlib_gdb_show_event_log (void)
 847 {
 848   elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
 849 }
 850
 851 static inline void
 852 vlib_elog_main_loop_event (vlib_main_t * vm,
 853                            u32 node_index,
 854                            u64 time, u32 n_vectors, u32 is_return)
 855 {
 856   vlib_main_t *evm = &vlib_global_main;
 857   elog_main_t *em = &evm->elog_main;
 858
 859   if (VLIB_ELOG_MAIN_LOOP && n_vectors)
 860     elog_track (em,
 861                 /* event type */
 862                 vec_elt_at_index (is_return
 863                                   ? evm->node_return_elog_event_types
 864                                   : evm->node_call_elog_event_types,
 865                                   node_index),
 866                 /* track */
 867                 (vm->cpu_index ? &vlib_worker_threads[vm->cpu_index].
 868                  elog_track : &em->default_track),
 869                 /* data to log */ n_vectors);
 870 }
 871
 872 void
 873 vlib_dump_context_trace (vlib_main_t * vm, u32 bi)
 874 {
 875   vlib_node_main_t *vnm = &vm->node_main;
 876   vlib_buffer_t *b;
 877   u8 i, n;
 878
 879   if (VLIB_BUFFER_TRACE_TRAJECTORY)
 880     {
 881       b = vlib_get_buffer (vm, bi);
 882       n = b->pre_data[0];
 883
 884       fformat (stderr, "Context trace for bi %d b 0x%llx, visited %d\n",
 885                bi, b, n);
 886
 887       if (n == 0 || n > 20)
 888         {
 889           fformat (stderr, "n is unreasonable\n");
 890           return;
 891         }
 892
 893
 894       for (i = 0; i < n; i++)
 895         {
 896           u32 node_index;
 897
 898           node_index = b->pre_data[i + 1];
 899
 900           if (node_index > vec_len (vnm->nodes))
 901             {
 902               fformat (stderr, "Skip bogus node index %d\n", node_index);
 903               continue;
 904             }
 905
 906           fformat (stderr, "%v (%d)\n", vnm->nodes[node_index]->name,
 907                    node_index);
 908         }
 909     }
 910   else
 911     {
 912       fformat (stderr,
 913                "in vlib/buffers.h, #define VLIB_BUFFER_TRACE_TRAJECTORY 1\n");
 914     }
 915 }
 916
 917
 918 /* static_always_inline */ u64
 919 dispatch_node (vlib_main_t * vm,
 920                vlib_node_runtime_t * node,
 921                vlib_node_type_t type,
 922                vlib_node_state_t dispatch_state,
 923                vlib_frame_t * frame, u64 last_time_stamp)
 924 {
 925   uword n, v;
 926   u64 t;
 927   vlib_node_main_t *nm = &vm->node_main;
 928   vlib_next_frame_t *nf;
 929
 930   if (CLIB_DEBUG > 0)
 931     {
 932       vlib_node_t *n = vlib_get_node (vm, node->node_index);
 933       ASSERT (n->type == type);
 934     }
 935
 936   /* Only non-internal nodes may be disabled. */
 937   if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
 938     {
 939       ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
 940       return last_time_stamp;
 941     }
 942
 943   if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
 944       && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
 945     {
 946       u32 c = node->input_main_loops_per_call;
 947       /* Only call node when count reaches zero. */
 948       if (c)
 949         {
 950           node->input_main_loops_per_call = c - 1;
 951           return last_time_stamp;
 952         }
 953     }
 954
 955   /* Speculatively prefetch next frames. */
 956   if (node->n_next_nodes > 0)
 957     {
 958       nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
 959       CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
 960     }
 961
 962   vm->cpu_time_last_node_dispatch = last_time_stamp;
 963
 964   if (1 /* || vm->cpu_index == node->cpu_index */ )
 965     {
 966       vlib_main_t *stat_vm;
 967
 968       stat_vm = /* vlib_mains ? vlib_mains[0] : */ vm;
 969
 970       vlib_elog_main_loop_event (vm, node->node_index,
 971                                  last_time_stamp,
 972                                  frame ? frame->n_vectors : 0,
 973                                  /* is_after */ 0);
 974
 975       /*
 976        * Turn this on if you run into
 977        * "bad monkey" contexts, and you want to know exactly
 978        * which nodes they've visited... See ixge.c...
 979        */
 980       if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
 981         {
 982           int i;
 983           int log_index;
 984           u32 *from;
 985           from = vlib_frame_vector_args (frame);
 986           for (i = 0; i < frame->n_vectors; i++)
 987             {
 988               vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
 989               ASSERT (b->pre_data[0] < 32);
 990               log_index = b->pre_data[0]++ + 1;
 991               b->pre_data[log_index] = node->node_index;
 992             }
 993           n = node->function (vm, node, frame);
 994         }
 995       else
 996         n = node->function (vm, node, frame);
 997
 998       t = clib_cpu_time_now ();
 999
1000       vlib_elog_main_loop_event (vm, node->node_index, t, n,    /* is_after */
1001                                  1);
1002
1003       vm->main_loop_vectors_processed += n;
1004       vm->main_loop_nodes_processed += n > 0;
1005
1006       v = vlib_node_runtime_update_stats (stat_vm, node,
1007                                           /* n_calls */ 1,
1008                                           /* n_vectors */ n,
1009                                           /* n_clocks */ t - last_time_stamp);
1010
1011       /* When in interrupt mode and vector rate crosses threshold switch to
1012          polling mode. */
1013       if ((DPDK == 0 && dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1014           || (DPDK == 0 && dispatch_state == VLIB_NODE_STATE_POLLING
1015               && (node->flags
1016                   & VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE)))
1017         {
1018           ELOG_TYPE_DECLARE (e) =
1019           {
1020             .function = (char *) __FUNCTION__,.format =
1021               "%s vector length %d, switching to %s",.format_args =
1022               "T4i4t4",.n_enum_strings = 2,.enum_strings =
1023             {
1024           "interrupt", "polling",},};
1025           struct
1026           {
1027             u32 node_name, vector_length, is_polling;
1028           } *ed;
1029
1030           if (dispatch_state == VLIB_NODE_STATE_INTERRUPT
1031               && v >= nm->polling_threshold_vector_length)
1032             {
1033               vlib_node_t *n = vlib_get_node (vm, node->node_index);
1034               n->state = VLIB_NODE_STATE_POLLING;
1035               node->state = VLIB_NODE_STATE_POLLING;
1036               ASSERT (!
1037                       (node->flags &
1038                        VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE));
1039               node->flags &=
1040                 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1041               node->flags |=
1042                 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1043               nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1044               nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1045
1046               ed = ELOG_DATA (&vm->elog_main, e);
1047               ed->node_name = n->name_elog_string;
1048               ed->vector_length = v;
1049               ed->is_polling = 1;
1050             }
1051           else if (dispatch_state == VLIB_NODE_STATE_POLLING
1052                    && v <= nm->interrupt_threshold_vector_length)
1053             {
1054               vlib_node_t *n = vlib_get_node (vm, node->node_index);
1055               if (node->flags &
1056                   VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1057                 {
1058                   /* Switch to interrupt mode after dispatch in polling one more time.
1059                      This allows driver to re-enable interrupts. */
1060                   n->state = VLIB_NODE_STATE_INTERRUPT;
1061                   node->state = VLIB_NODE_STATE_INTERRUPT;
1062                   node->flags &=
1063                     ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1064                   nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -=
1065                     1;
1066                   nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] +=
1067                     1;
1068
1069                 }
1070               else
1071                 {
1072                   node->flags |=
1073                     VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1074                   ed = ELOG_DATA (&vm->elog_main, e);
1075                   ed->node_name = n->name_elog_string;
1076                   ed->vector_length = v;
1077                   ed->is_polling = 0;
1078                 }
1079             }
1080         }
1081     }
1082
1083   return t;
1084 }
1085
1086 /* static */ u64
1087 dispatch_pending_node (vlib_main_t * vm,
1088                        vlib_pending_frame_t * p, u64 last_time_stamp)
1089 {
1090   vlib_node_main_t *nm = &vm->node_main;
1091   vlib_frame_t *f;
1092   vlib_next_frame_t *nf, nf_dummy;
1093   vlib_node_runtime_t *n;
1094   u32 restore_frame_index;
1095
1096   n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1097                         p->node_runtime_index);
1098
1099   f = vlib_get_frame (vm, p->frame_index);
1100   if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1101     {
1102       /* No next frame: so use dummy on stack. */
1103       nf = &nf_dummy;
1104       nf->flags = f->flags & VLIB_NODE_FLAG_TRACE;
1105       nf->frame_index = ~p->frame_index;
1106     }
1107   else
1108     nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1109
1110   ASSERT (f->flags & VLIB_FRAME_IS_ALLOCATED);
1111
1112   /* Force allocation of new frame while current frame is being
1113      dispatched. */
1114   restore_frame_index = ~0;
1115   if (nf->frame_index == p->frame_index)
1116     {
1117       nf->frame_index = ~0;
1118       nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1119       if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1120         restore_frame_index = p->frame_index;
1121     }
1122
1123   /* Frame must be pending. */
1124   ASSERT (f->flags & VLIB_FRAME_PENDING);
1125   ASSERT (f->n_vectors > 0);
1126
1127   /* Copy trace flag from next frame to node.
1128      Trace flag indicates that at least one vector in the dispatched
1129      frame is traced. */
1130   n->flags &= ~VLIB_NODE_FLAG_TRACE;
1131   n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1132   nf->flags &= ~VLIB_FRAME_TRACE;
1133
1134   last_time_stamp = dispatch_node (vm, n,
1135                                    VLIB_NODE_TYPE_INTERNAL,
1136                                    VLIB_NODE_STATE_POLLING,
1137                                    f, last_time_stamp);
1138
1139   f->flags &= ~VLIB_FRAME_PENDING;
1140
1141   /* Frame is ready to be used again, so restore it. */
1142   if (restore_frame_index != ~0)
1143     {
1144       /* we musn't restore a frame that is flagged to be freed. This shouldn't
1145          happen since frames to be freed post dispatch are those used
1146          when the to-node frame becomes full i.e. they form a sort of queue of
1147          frames to a single node. If we get here then the to-node frame and the
1148          pending frame *were* the same, and so we removed the to-node frame.
1149          Therefore this frame is no longer part of the queue for that node
1150          and hence it cannot be it's overspill.
1151        */
1152       ASSERT (!(f->flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1153
1154       /* p->next_frame_index can change during node dispatch if node
1155          function decides to change graph hook up. */
1156       nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1157       nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1158
1159       if (~0 == nf->frame_index)
1160         {
1161           /* no new frame has been assigned to this node, use the saved one */
1162           nf->frame_index = restore_frame_index;
1163           f->n_vectors = 0;
1164         }
1165       else
1166         {
1167           /* The node has gained a frame, implying packets from the current frame
1168              were re-queued to this same node. we don't need the saved one
1169              anymore */
1170           vlib_frame_free (vm, n, f);
1171         }
1172     }
1173   else
1174     {
1175       if (f->flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1176         {
1177           ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1178           vlib_frame_free (vm, n, f);
1179         }
1180     }
1181
1182   return last_time_stamp;
1183 }
1184
1185 always_inline uword
1186 vlib_process_stack_is_valid (vlib_process_t * p)
1187 {
1188   return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1189 }
1190
1191 typedef struct
1192 {
1193   vlib_main_t *vm;
1194   vlib_process_t *process;
1195   vlib_frame_t *frame;
1196 } vlib_process_bootstrap_args_t;
1197
1198 /* Called in process stack. */
1199 static uword
1200 vlib_process_bootstrap (uword _a)
1201 {
1202   vlib_process_bootstrap_args_t *a;
1203   vlib_main_t *vm;
1204   vlib_node_runtime_t *node;
1205   vlib_frame_t *f;
1206   vlib_process_t *p;
1207   uword n;
1208
1209   a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1210
1211   vm = a->vm;
1212   p = a->process;
1213   f = a->frame;
1214   node = &p->node_runtime;
1215
1216   n = node->function (vm, node, f);
1217
1218   ASSERT (vlib_process_stack_is_valid (p));
1219
1220   clib_longjmp (&p->return_longjmp, n);
1221
1222   return n;
1223 }
1224
1225 /* Called in main stack. */
1226 static_always_inline uword
1227 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1228 {
1229   vlib_process_bootstrap_args_t a;
1230   uword r;
1231
1232   a.vm = vm;
1233   a.process = p;
1234   a.frame = f;
1235
1236   r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1237   if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1238     r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1239                       (void *) p->stack + (1 << p->log2_n_stack_bytes));
1240
1241   return r;
1242 }
1243
1244 static_always_inline uword
1245 vlib_process_resume (vlib_process_t * p)
1246 {
1247   uword r;
1248   p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1249                 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1250                 | VLIB_PROCESS_RESUME_PENDING);
1251   r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1252   if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1253     clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1254   return r;
1255 }
1256
1257 static u64
1258 dispatch_process (vlib_main_t * vm,
1259                   vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1260 {
1261   vlib_node_main_t *nm = &vm->node_main;
1262   vlib_node_runtime_t *node_runtime = &p->node_runtime;
1263   vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1264   u64 t;
1265   uword n_vectors, is_suspend;
1266
1267   if (node->state != VLIB_NODE_STATE_POLLING
1268       || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1269                       | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1270     return last_time_stamp;
1271
1272   p->flags |= VLIB_PROCESS_IS_RUNNING;
1273
1274   t = last_time_stamp;
1275   vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1276                              f ? f->n_vectors : 0, /* is_after */ 0);
1277
1278   /* Save away current process for suspend. */
1279   nm->current_process_index = node->runtime_index;
1280
1281   n_vectors = vlib_process_startup (vm, p, f);
1282
1283   nm->current_process_index = ~0;
1284
1285   ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1286   is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1287   if (is_suspend)
1288     {
1289       vlib_pending_frame_t *pf;
1290
1291       n_vectors = 0;
1292       pool_get (nm->suspended_process_frames, pf);
1293       pf->node_runtime_index = node->runtime_index;
1294       pf->frame_index = f ? vlib_frame_index (vm, f) : ~0;
1295       pf->next_frame_index = ~0;
1296
1297       p->n_suspends += 1;
1298       p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1299
1300       if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1301         timing_wheel_insert (&nm->timing_wheel, p->resume_cpu_time,
1302                              vlib_timing_wheel_data_set_suspended_process
1303                              (node->runtime_index));
1304     }
1305   else
1306     p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1307
1308   t = clib_cpu_time_now ();
1309
1310   vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1311                              /* is_after */ 1);
1312
1313   vlib_process_update_stats (vm, p,
1314                              /* n_calls */ !is_suspend,
1315                              /* n_vectors */ n_vectors,
1316                              /* n_clocks */ t - last_time_stamp);
1317
1318   return t;
1319 }
1320
1321 void
1322 vlib_start_process (vlib_main_t * vm, uword process_index)
1323 {
1324   vlib_node_main_t *nm = &vm->node_main;
1325   vlib_process_t *p = vec_elt (nm->processes, process_index);
1326   dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1327 }
1328
1329 static u64
1330 dispatch_suspended_process (vlib_main_t * vm,
1331                             uword process_index, u64 last_time_stamp)
1332 {
1333   vlib_node_main_t *nm = &vm->node_main;
1334   vlib_node_runtime_t *node_runtime;
1335   vlib_node_t *node;
1336   vlib_frame_t *f;
1337   vlib_process_t *p;
1338   vlib_pending_frame_t *pf;
1339   u64 t, n_vectors, is_suspend;
1340
1341   t = last_time_stamp;
1342
1343   p = vec_elt (nm->processes, process_index);
1344   if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1345     return last_time_stamp;
1346
1347   ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1348                       | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1349
1350   pf =
1351     pool_elt_at_index (nm->suspended_process_frames,
1352                        p->suspended_process_frame_index);
1353
1354   node_runtime = &p->node_runtime;
1355   node = vlib_get_node (vm, node_runtime->node_index);
1356   f = pf->frame_index != ~0 ? vlib_get_frame (vm, pf->frame_index) : 0;
1357
1358   vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1359                              f ? f->n_vectors : 0, /* is_after */ 0);
1360
1361   /* Save away current process for suspend. */
1362   nm->current_process_index = node->runtime_index;
1363
1364   n_vectors = vlib_process_resume (p);
1365   t = clib_cpu_time_now ();
1366
1367   nm->current_process_index = ~0;
1368
1369   is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1370   if (is_suspend)
1371     {
1372       /* Suspend it again. */
1373       n_vectors = 0;
1374       p->n_suspends += 1;
1375       if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1376         timing_wheel_insert (&nm->timing_wheel, p->resume_cpu_time,
1377                              vlib_timing_wheel_data_set_suspended_process
1378                              (node->runtime_index));
1379     }
1380   else
1381     {
1382       p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1383       p->suspended_process_frame_index = ~0;
1384       pool_put (nm->suspended_process_frames, pf);
1385     }
1386
1387   t = clib_cpu_time_now ();
1388   vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1389                              /* is_after */ 1);
1390
1391   vlib_process_update_stats (vm, p,
1392                              /* n_calls */ !is_suspend,
1393                              /* n_vectors */ n_vectors,
1394                              /* n_clocks */ t - last_time_stamp);
1395
1396   return t;
1397 }
1398
1399 static void
1400 vlib_main_loop (vlib_main_t * vm)
1401 {
1402   vlib_node_main_t *nm = &vm->node_main;
1403   uword i;
1404   u64 cpu_time_now;
1405
1406   /* Initialize pending node vector. */
1407   vec_resize (nm->pending_frames, 32);
1408   _vec_len (nm->pending_frames) = 0;
1409
1410   /* Mark time of main loop start. */
1411   cpu_time_now = vm->clib_time.last_cpu_time;
1412   vm->cpu_time_main_loop_start = cpu_time_now;
1413
1414   /* Arrange for first level of timing wheel to cover times we care
1415      most about. */
1416   nm->timing_wheel.min_sched_time = 10e-6;
1417   nm->timing_wheel.max_sched_time = 10e-3;
1418   timing_wheel_init (&nm->timing_wheel,
1419                      cpu_time_now, vm->clib_time.clocks_per_second);
1420
1421   /* Pre-allocate expired nodes. */
1422   vec_alloc (nm->data_from_advancing_timing_wheel, 32);
1423   vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1424
1425   if (!nm->polling_threshold_vector_length)
1426     nm->polling_threshold_vector_length = 10;
1427   if (!nm->interrupt_threshold_vector_length)
1428     nm->interrupt_threshold_vector_length = 5;
1429
1430   nm->current_process_index = ~0;
1431
1432   /* Start all processes. */
1433   {
1434     uword i;
1435     for (i = 0; i < vec_len (nm->processes); i++)
1436       cpu_time_now =
1437         dispatch_process (vm, nm->processes[i], /* frame */ 0, cpu_time_now);
1438   }
1439
1440   while (1)
1441     {
1442       vlib_node_runtime_t *n;
1443
1444       /* Process pre-input nodes. */
1445       vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1446         cpu_time_now = dispatch_node (vm, n,
1447                                       VLIB_NODE_TYPE_PRE_INPUT,
1448                                       VLIB_NODE_STATE_POLLING,
1449                                       /* frame */ 0,
1450                                       cpu_time_now);
1451
1452       /* Next process input nodes. */
1453       vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1454         cpu_time_now = dispatch_node (vm, n,
1455                                       VLIB_NODE_TYPE_INPUT,
1456                                       VLIB_NODE_STATE_POLLING,
1457                                       /* frame */ 0,
1458                                       cpu_time_now);
1459
1460       if (PREDICT_TRUE (vm->queue_signal_pending == 0))
1461         vm->queue_signal_callback (vm);
1462
1463       /* Next handle interrupts. */
1464       {
1465         uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1466         uword i;
1467         if (l > 0)
1468           {
1469             _vec_len (nm->pending_interrupt_node_runtime_indices) = 0;
1470             for (i = 0; i < l; i++)
1471               {
1472                 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1473                                       nm->
1474                                       pending_interrupt_node_runtime_indices
1475                                       [i]);
1476                 cpu_time_now =
1477                   dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1478                                  VLIB_NODE_STATE_INTERRUPT,
1479                                  /* frame */ 0,
1480                                  cpu_time_now);
1481               }
1482           }
1483       }
1484
1485       /* Check if process nodes have expired from timing wheel. */
1486       nm->data_from_advancing_timing_wheel
1487         = timing_wheel_advance (&nm->timing_wheel, cpu_time_now,
1488                                 nm->data_from_advancing_timing_wheel,
1489                                 &nm->cpu_time_next_process_ready);
1490
1491       ASSERT (nm->data_from_advancing_timing_wheel != 0);
1492       if (PREDICT_FALSE (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1493         {
1494           uword i;
1495
1496         processes_timing_wheel_data:
1497           for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1498                i++)
1499             {
1500               u32 d = nm->data_from_advancing_timing_wheel[i];
1501               u32 di = vlib_timing_wheel_data_get_index (d);
1502
1503               if (vlib_timing_wheel_data_is_timed_event (d))
1504                 {
1505                   vlib_signal_timed_event_data_t *te =
1506                     pool_elt_at_index (nm->signal_timed_event_data_pool, di);
1507                   vlib_node_t *n = vlib_get_node (vm, te->process_node_index);
1508                   vlib_process_t *p =
1509                     vec_elt (nm->processes, n->runtime_index);
1510                   void *data;
1511                   data =
1512                     vlib_process_signal_event_helper (nm, n, p,
1513                                                       te->event_type_index,
1514                                                       te->n_data_elts,
1515                                                       te->n_data_elt_bytes);
1516                   if (te->n_data_bytes < sizeof (te->inline_event_data))
1517                     clib_memcpy (data, te->inline_event_data,
1518                                  te->n_data_bytes);
1519                   else
1520                     {
1521                       clib_memcpy (data, te->event_data_as_vector,
1522                                    te->n_data_bytes);
1523                       vec_free (te->event_data_as_vector);
1524                     }
1525                   pool_put (nm->signal_timed_event_data_pool, te);
1526                 }
1527               else
1528                 {
1529                   cpu_time_now = clib_cpu_time_now ();
1530                   cpu_time_now =
1531                     dispatch_suspended_process (vm, di, cpu_time_now);
1532                 }
1533             }
1534
1535           /* Reset vector. */
1536           _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1537         }
1538
1539       /* Input nodes may have added work to the pending vector.
1540          Process pending vector until there is nothing left.
1541          All pending vectors will be processed from input -> output. */
1542       for (i = 0; i < _vec_len (nm->pending_frames); i++)
1543         cpu_time_now = dispatch_pending_node (vm, nm->pending_frames + i,
1544                                               cpu_time_now);
1545       /* Reset pending vector for next iteration. */
1546       _vec_len (nm->pending_frames) = 0;
1547
1548       /* Pending internal nodes may resume processes. */
1549       if (_vec_len (nm->data_from_advancing_timing_wheel) > 0)
1550         goto processes_timing_wheel_data;
1551
1552       vlib_increment_main_loop_counter (vm);
1553
1554       /* Record time stamp in case there are no enabled nodes and above
1555          calls do not update time stamp. */
1556       cpu_time_now = clib_cpu_time_now ();
1557     }
1558 }
1559
1560 vlib_main_t vlib_global_main;
1561
1562 static clib_error_t *
1563 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1564 {
1565   int turn_on_mem_trace = 0;
1566
1567   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1568     {
1569       if (unformat (input, "memory-trace"))
1570         turn_on_mem_trace = 1;
1571
1572       else if (unformat (input, "elog-events %d",
1573                          &vm->elog_main.event_ring_size))
1574         ;
1575       else
1576         return unformat_parse_error (input);
1577     }
1578
1579   unformat_free (input);
1580
1581   /* Enable memory trace as early as possible. */
1582   if (turn_on_mem_trace)
1583     clib_mem_trace (1);
1584
1585   return 0;
1586 }
1587
1588 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1589
1590 static void
1591 dummy_queue_signal_callback (vlib_main_t * vm)
1592 {
1593 }
1594
1595 /* Main function. */
1596 int
1597 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
1598 {
1599   clib_error_t *volatile error;
1600
1601   vm->queue_signal_callback = dummy_queue_signal_callback;
1602
1603   clib_time_init (&vm->clib_time);
1604
1605   /* Turn on event log. */
1606   if (!vm->elog_main.event_ring_size)
1607     vm->elog_main.event_ring_size = 128 << 10;
1608   elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
1609   elog_enable_disable (&vm->elog_main, 1);
1610
1611   /* Default name. */
1612   if (!vm->name)
1613     vm->name = "VLIB";
1614
1615   vec_validate (vm->buffer_main, 0);
1616
1617   if ((error = vlib_thread_init (vm)))
1618     {
1619       clib_error_report (error);
1620       goto done;
1621     }
1622
1623   /* Register static nodes so that init functions may use them. */
1624   vlib_register_all_static_nodes (vm);
1625
1626   /* Set seed for random number generator.
1627      Allow user to specify seed to make random sequence deterministic. */
1628   if (!unformat (input, "seed %wd", &vm->random_seed))
1629     vm->random_seed = clib_cpu_time_now ();
1630   clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
1631
1632   /* Initialize node graph. */
1633   if ((error = vlib_node_main_init (vm)))
1634     {
1635       /* Arrange for graph hook up error to not be fatal when debugging. */
1636       if (CLIB_DEBUG > 0)
1637         clib_error_report (error);
1638       else
1639         goto done;
1640     }
1641
1642   /* See unix/main.c; most likely already set up */
1643   if (vm->init_functions_called == 0)
1644     vm->init_functions_called = hash_create (0, /* value bytes */ 0);
1645   if ((error = vlib_call_all_init_functions (vm)))
1646     goto done;
1647
1648   /* Create default buffer free list. */
1649   vlib_buffer_get_or_create_free_list (vm,
1650                                        VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
1651                                        "default");
1652
1653   switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
1654     {
1655     case VLIB_MAIN_LOOP_EXIT_NONE:
1656       vm->main_loop_exit_set = 1;
1657       break;
1658
1659     case VLIB_MAIN_LOOP_EXIT_CLI:
1660       goto done;
1661
1662     default:
1663       error = vm->main_loop_error;
1664       goto done;
1665     }
1666
1667   if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
1668     goto done;
1669
1670   /* Call all main loop enter functions. */
1671   {
1672     clib_error_t *sub_error;
1673     sub_error = vlib_call_all_main_loop_enter_functions (vm);
1674     if (sub_error)
1675       clib_error_report (sub_error);
1676   }
1677
1678   vlib_main_loop (vm);
1679
1680 done:
1681   /* Call all exit functions. */
1682   {
1683     clib_error_t *sub_error;
1684     sub_error = vlib_call_all_main_loop_exit_functions (vm);
1685     if (sub_error)
1686       clib_error_report (sub_error);
1687   }
1688
1689   if (error)
1690     clib_error_report (error);
1691
1692   return 0;
1693 }
1694
1695 /*
1696  * fd.io coding-style-patch-verification: ON
1697  *
1698  * Local Variables:
1699  * eval: (c-set-style "gnu")
1700  * End:
1701  */