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