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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * main.c: main vector processing loop
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
41 #include <vppinfra/format.h>
42 #include <vlib/vlib.h>
43 #include <vlib/threads.h>
44 #include <vlib/stats/stats.h>
45 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
47 #include <vlib/unix/unix.h>
49 #define VLIB_FRAME_MAGIC (0xabadc0ed)
52 vlib_frame_find_magic (vlib_frame_t * f, vlib_node_t * node)
54 return (void *) f + node->magic_offset;
58 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
61 vlib_node_main_t *nm = &vm->node_main;
62 vlib_frame_size_t *fs;
67 ASSERT (vm == vlib_get_main ());
69 to_node = vlib_get_node (vm, to_node_index);
71 vec_validate (nm->frame_sizes, to_node->frame_size_index);
72 fs = vec_elt_at_index (nm->frame_sizes, to_node->frame_size_index);
74 if (fs->frame_size == 0)
75 fs->frame_size = to_node->frame_size;
77 ASSERT (fs->frame_size == to_node->frame_size);
80 if ((l = vec_len (fs->free_frames)) > 0)
82 /* Allocate from end of free list. */
83 f = fs->free_frames[l - 1];
84 vec_set_len (fs->free_frames, l - 1);
88 f = clib_mem_alloc_aligned_no_fail (n, CLIB_CACHE_LINE_BYTES);
91 /* Poison frame when debugging. */
93 clib_memset_u8 (f, 0xfe, n);
95 /* Insert magic number. */
99 magic = vlib_frame_find_magic (f, to_node);
100 *magic = VLIB_FRAME_MAGIC;
103 f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
105 f->scalar_offset = to_node->scalar_offset;
106 f->vector_offset = to_node->vector_offset;
107 f->aux_offset = to_node->aux_offset;
109 f->frame_size_index = to_node->frame_size_index;
111 fs->n_alloc_frames += 1;
116 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
117 Returns frame index. */
118 static vlib_frame_t *
119 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
122 vlib_node_t *from_node;
124 from_node = vlib_get_node (vm, from_node_runtime->node_index);
125 ASSERT (to_next_index < vec_len (from_node->next_nodes));
127 return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
128 /* frame_flags */ 0);
132 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
134 vlib_frame_t *f = vlib_frame_alloc_to_node (vm, to_node_index,
136 VLIB_FRAME_FREE_AFTER_DISPATCH);
137 return vlib_get_frame (vm, f);
141 vlib_validate_frame_indices (vlib_frame_t * f)
146 u32 *from = vlib_frame_vector_args (f);
148 /* Check for bad buffer index values */
149 for (i = 0; i < f->n_vectors; i++)
153 clib_warning ("BUG: buffer index 0 at index %d", i);
156 else if (from[i] == 0xfefefefe)
158 clib_warning ("BUG: frame poison pattern at index %d", i);
166 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
168 vlib_pending_frame_t *p;
169 vlib_node_t *to_node;
171 if (f->n_vectors == 0)
174 ASSERT (vm == vlib_get_main ());
176 vlib_validate_frame_indices (f);
178 to_node = vlib_get_node (vm, to_node_index);
180 vec_add2 (vm->node_main.pending_frames, p, 1);
182 f->frame_flags |= VLIB_FRAME_PENDING;
183 p->frame = vlib_get_frame (vm, f);
184 p->node_runtime_index = to_node->runtime_index;
185 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
188 /* Free given frame. */
190 vlib_frame_free (vlib_main_t *vm, vlib_frame_t *f)
192 vlib_node_main_t *nm = &vm->node_main;
193 vlib_frame_size_t *fs;
195 ASSERT (vm == vlib_get_main ());
196 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
198 fs = vec_elt_at_index (nm->frame_sizes, f->frame_size_index);
200 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
202 /* No next frames may point to freed frame. */
205 vlib_next_frame_t *nf;
206 vec_foreach (nf, vm->node_main.next_frames) ASSERT (nf->frame != f);
209 f->frame_flags &= ~(VLIB_FRAME_IS_ALLOCATED | VLIB_FRAME_NO_APPEND);
212 vec_add1 (fs->free_frames, f);
213 ASSERT (fs->n_alloc_frames > 0);
214 fs->n_alloc_frames -= 1;
217 static clib_error_t *
218 show_frame_stats (vlib_main_t * vm,
219 unformat_input_t * input, vlib_cli_command_t * cmd)
221 vlib_frame_size_t *fs;
223 vlib_cli_output (vm, "%=8s%=6s%=12s%=12s", "Thread", "Size", "# Alloc",
227 vlib_node_main_t *nm = &this_vlib_main->node_main;
228 vec_foreach (fs, nm->frame_sizes)
230 u32 n_alloc = fs->n_alloc_frames;
231 u32 n_free = vec_len (fs->free_frames);
233 if (n_alloc + n_free > 0)
234 vlib_cli_output (vm, "%=8d%=6d%=12d%=12d",
235 this_vlib_main->thread_index, fs->frame_size,
243 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
244 .path = "show vlib frame-allocation",
245 .short_help = "Show node dispatch frame statistics",
246 .function = show_frame_stats,
249 /* Change ownership of enqueue rights to given next node. */
251 vlib_next_frame_change_ownership (vlib_main_t * vm,
252 vlib_node_runtime_t * node_runtime,
255 vlib_node_main_t *nm = &vm->node_main;
256 vlib_next_frame_t *next_frame;
257 vlib_node_t *node, *next_node;
259 node = vec_elt (nm->nodes, node_runtime->node_index);
261 /* Only internal & input nodes are allowed to call other nodes. */
262 ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
263 || node->type == VLIB_NODE_TYPE_INPUT
264 || node->type == VLIB_NODE_TYPE_PROCESS);
266 ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
269 vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
270 next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
272 if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
274 /* Get frame from previous owner. */
275 vlib_next_frame_t *owner_next_frame;
276 vlib_next_frame_t tmp;
279 vlib_node_get_next_frame (vm,
280 next_node->owner_node_index,
281 next_node->owner_next_index);
283 /* Swap target next frame with owner's. */
284 tmp = owner_next_frame[0];
285 owner_next_frame[0] = next_frame[0];
289 * If next_frame is already pending, we have to track down
290 * all pending frames and fix their next_frame_index fields.
292 if (next_frame->flags & VLIB_FRAME_PENDING)
294 vlib_pending_frame_t *p;
295 if (next_frame->frame != NULL)
297 vec_foreach (p, nm->pending_frames)
299 if (p->frame == next_frame->frame)
301 p->next_frame_index =
302 next_frame - vm->node_main.next_frames;
310 /* No previous owner. Take ownership. */
311 next_frame->flags |= VLIB_FRAME_OWNER;
314 /* Record new owner. */
315 next_node->owner_node_index = node->index;
316 next_node->owner_next_index = next_index;
318 /* Now we should be owner. */
319 ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
322 /* Make sure that magic number is still there.
323 Otherwise, it is likely that caller has overrun frame arguments. */
325 validate_frame_magic (vlib_main_t * vm,
326 vlib_frame_t * f, vlib_node_t * n, uword next_index)
328 vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
329 u32 *magic = vlib_frame_find_magic (f, next_node);
330 ASSERT (VLIB_FRAME_MAGIC == magic[0]);
334 vlib_get_next_frame_internal (vlib_main_t * vm,
335 vlib_node_runtime_t * node,
336 u32 next_index, u32 allocate_new_next_frame)
339 vlib_next_frame_t *nf;
342 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
344 /* Make sure this next frame owns right to enqueue to destination frame. */
345 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
346 vlib_next_frame_change_ownership (vm, node, next_index);
348 /* ??? Don't need valid flag: can use frame_index == ~0 */
349 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
351 nf->frame = vlib_frame_alloc (vm, node, next_index);
352 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
357 /* Has frame been removed from pending vector (e.g. finished dispatching)?
358 If so we can reuse frame. */
359 if ((nf->flags & VLIB_FRAME_PENDING)
360 && !(f->frame_flags & VLIB_FRAME_PENDING))
362 nf->flags &= ~VLIB_FRAME_PENDING;
367 /* Allocate new frame if current one is marked as no-append or
368 it is already full. */
369 n_used = f->n_vectors;
370 if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0) ||
371 (f->frame_flags & VLIB_FRAME_NO_APPEND))
373 /* Old frame may need to be freed after dispatch, since we'll have
374 two redundant frames from node -> next node. */
375 if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
377 vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame);
378 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
381 /* Allocate new frame to replace full one. */
382 f = nf->frame = vlib_frame_alloc (vm, node, next_index);
383 n_used = f->n_vectors;
386 /* Should have free vectors in frame now. */
387 ASSERT (n_used < VLIB_FRAME_SIZE);
391 validate_frame_magic (vm, f,
392 vlib_get_node (vm, node->node_index), next_index);
399 vlib_put_next_frame_validate (vlib_main_t * vm,
400 vlib_node_runtime_t * rt,
401 u32 next_index, u32 n_vectors_left)
403 vlib_node_main_t *nm = &vm->node_main;
404 vlib_next_frame_t *nf;
406 vlib_node_runtime_t *next_rt;
407 vlib_node_t *next_node;
408 u32 n_before, n_after;
410 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
411 f = vlib_get_frame (vm, nf->frame);
413 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
415 vlib_validate_frame_indices (f);
417 n_after = VLIB_FRAME_SIZE - n_vectors_left;
418 n_before = f->n_vectors;
420 ASSERT (n_after >= n_before);
422 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
423 nf->node_runtime_index);
424 next_node = vlib_get_node (vm, next_rt->node_index);
425 if (n_after > 0 && next_node->validate_frame)
427 u8 *msg = next_node->validate_frame (vm, rt, f);
430 clib_warning ("%v", msg);
438 vlib_put_next_frame (vlib_main_t * vm,
439 vlib_node_runtime_t * r,
440 u32 next_index, u32 n_vectors_left)
442 vlib_node_main_t *nm = &vm->node_main;
443 vlib_next_frame_t *nf;
445 u32 n_vectors_in_frame;
448 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
450 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
451 f = vlib_get_frame (vm, nf->frame);
453 /* Make sure that magic number is still there. Otherwise, caller
454 has overrun frame meta data. */
457 vlib_node_t *node = vlib_get_node (vm, r->node_index);
458 validate_frame_magic (vm, f, node, next_index);
461 /* Convert # of vectors left -> number of vectors there. */
462 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
463 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
465 f->n_vectors = n_vectors_in_frame;
467 /* If vectors were added to frame, add to pending vector. */
468 if (PREDICT_TRUE (n_vectors_in_frame > 0))
470 vlib_pending_frame_t *p;
473 r->cached_next_index = next_index;
475 if (!(f->frame_flags & VLIB_FRAME_PENDING))
477 __attribute__ ((unused)) vlib_node_t *node;
479 node = vlib_get_node (vm, r->node_index);
481 vec_add2 (nm->pending_frames, p, 1);
483 p->frame = nf->frame;
484 p->node_runtime_index = nf->node_runtime_index;
485 p->next_frame_index = nf - nm->next_frames;
486 nf->flags |= VLIB_FRAME_PENDING;
487 f->frame_flags |= VLIB_FRAME_PENDING;
490 /* Copy trace flag from next_frame and from runtime. */
492 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
493 flags & VLIB_NODE_FLAG_TRACE);
495 v0 = nf->vectors_since_last_overflow;
496 v1 = v0 + n_vectors_in_frame;
497 nf->vectors_since_last_overflow = v1;
498 if (PREDICT_FALSE (v1 < v0))
500 vlib_node_t *node = vlib_get_node (vm, r->node_index);
501 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
506 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
508 vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
509 uword n_calls, uword n_vectors,
512 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
513 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
514 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
515 n->stats_total.max_clock = r->max_clock;
516 n->stats_total.max_clock_n = r->max_clock_n;
518 r->calls_since_last_overflow = 0;
519 r->vectors_since_last_overflow = 0;
520 r->clocks_since_last_overflow = 0;
524 vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
525 uword n_calls, uword n_vectors, uword n_clocks)
527 vlib_node_t *n = vlib_get_node (vm, r->node_index);
528 vlib_node_runtime_sync_stats_node (n, r, n_calls, n_vectors, n_clocks);
531 always_inline void __attribute__ ((unused))
532 vlib_process_sync_stats (vlib_main_t * vm,
534 uword n_calls, uword n_vectors, uword n_clocks)
536 vlib_node_runtime_t *rt = &p->node_runtime;
537 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
538 vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks);
539 n->stats_total.suspends += p->n_suspends;
544 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
546 vlib_node_runtime_t *rt;
548 if (n->type == VLIB_NODE_TYPE_PROCESS)
550 /* Nothing to do for PROCESS nodes except in main thread */
551 if (vm != vlib_get_first_main ())
554 vlib_process_t *p = vlib_get_process_from_node (vm, n);
555 n->stats_total.suspends += p->n_suspends;
557 rt = &p->node_runtime;
561 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
564 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0);
566 /* Sync up runtime next frame vector counters with main node structure. */
568 vlib_next_frame_t *nf;
570 for (i = 0; i < rt->n_next_nodes; i++)
572 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
573 vec_elt (n->n_vectors_by_next_node, i) +=
574 nf->vectors_since_last_overflow;
575 nf->vectors_since_last_overflow = 0;
581 vlib_node_runtime_update_stats (vlib_main_t * vm,
582 vlib_node_runtime_t * node,
584 uword n_vectors, uword n_clocks)
586 u32 ca0, ca1, v0, v1, cl0, cl1, r;
588 cl0 = cl1 = node->clocks_since_last_overflow;
589 ca0 = ca1 = node->calls_since_last_overflow;
590 v0 = v1 = node->vectors_since_last_overflow;
594 cl1 = cl0 + n_clocks;
596 node->calls_since_last_overflow = ca1;
597 node->clocks_since_last_overflow = cl1;
598 node->vectors_since_last_overflow = v1;
600 node->max_clock_n = node->max_clock > n_clocks ?
601 node->max_clock_n : n_vectors;
602 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
604 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
606 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0))
608 node->calls_since_last_overflow = ca0;
609 node->clocks_since_last_overflow = cl0;
610 node->vectors_since_last_overflow = v0;
612 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks);
619 vlib_process_update_stats (vlib_main_t * vm,
621 uword n_calls, uword n_vectors, uword n_clocks)
623 vlib_node_runtime_update_stats (vm, &p->node_runtime,
624 n_calls, n_vectors, n_clocks);
627 static clib_error_t *
628 vlib_cli_elog_clear (vlib_main_t * vm,
629 unformat_input_t * input, vlib_cli_command_t * cmd)
631 elog_reset_buffer (&vlib_global_main.elog_main);
635 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
636 .path = "event-logger clear",
637 .short_help = "Clear the event log",
638 .function = vlib_cli_elog_clear,
642 static clib_error_t *
643 elog_save_buffer (vlib_main_t * vm,
644 unformat_input_t * input, vlib_cli_command_t * cmd)
646 elog_main_t *em = &vlib_global_main.elog_main;
647 char *file, *chroot_file;
648 clib_error_t *error = 0;
650 if (!unformat (input, "%s", &file))
652 vlib_cli_output (vm, "expected file name, got `%U'",
653 format_unformat_error, input);
657 /* It's fairly hard to get "../oopsie" through unformat; just in case */
658 if (strstr (file, "..") || index (file, '/'))
660 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
664 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
668 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
669 elog_n_events_in_buffer (em),
670 elog_buffer_capacity (em), chroot_file);
672 vlib_worker_thread_barrier_sync (vm);
673 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
674 vlib_worker_thread_barrier_release (vm);
675 vec_free (chroot_file);
680 vlib_post_mortem_dump (void)
682 vlib_global_main_t *vgm = vlib_get_global_main ();
684 for (int i = 0; i < vec_len (vgm->post_mortem_callbacks); i++)
685 (vgm->post_mortem_callbacks[i]) ();
688 VLIB_CLI_COMMAND (elog_save_cli, static) = {
689 .path = "event-logger save",
690 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
691 .function = elog_save_buffer,
694 static clib_error_t *
695 elog_stop (vlib_main_t * vm,
696 unformat_input_t * input, vlib_cli_command_t * cmd)
698 elog_main_t *em = &vlib_global_main.elog_main;
700 em->n_total_events_disable_limit = em->n_total_events;
702 vlib_cli_output (vm, "Stopped the event logger...");
706 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
707 .path = "event-logger stop",
708 .short_help = "Stop the event-logger",
709 .function = elog_stop,
712 static clib_error_t *
713 elog_restart (vlib_main_t * vm,
714 unformat_input_t * input, vlib_cli_command_t * cmd)
716 elog_main_t *em = &vlib_global_main.elog_main;
718 em->n_total_events_disable_limit = ~0;
720 vlib_cli_output (vm, "Restarted the event logger...");
724 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
725 .path = "event-logger restart",
726 .short_help = "Restart the event-logger",
727 .function = elog_restart,
730 static clib_error_t *
731 elog_resize_command_fn (vlib_main_t * vm,
732 unformat_input_t * input, vlib_cli_command_t * cmd)
734 elog_main_t *em = &vlib_global_main.elog_main;
737 /* Stop the parade */
738 elog_reset_buffer (em);
740 if (unformat (input, "%d", &tmp))
742 elog_alloc (em, tmp);
743 em->n_total_events_disable_limit = ~0;
746 return clib_error_return (0, "Must specify how many events in the ring");
748 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
752 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
753 .path = "event-logger resize",
754 .short_help = "event-logger resize <nnn>",
755 .function = elog_resize_command_fn,
758 #endif /* CLIB_UNIX */
761 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
763 elog_main_t *em = &vlib_global_main.elog_main;
764 elog_event_t *e, *es;
767 /* Show events in VLIB time since log clock starts after VLIB clock. */
768 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
769 * vm->clib_time.seconds_per_clock;
771 es = elog_peek_events (em);
772 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
774 em->n_total_events < em->n_total_events_disable_limit ?
775 "running" : "stopped");
778 vlib_cli_output (vm, "%18.9f: %U",
779 e->time + dt, format_elog_event, em, e);
781 if (n_events_to_show == 0)
788 static clib_error_t *
789 elog_show_buffer (vlib_main_t * vm,
790 unformat_input_t * input, vlib_cli_command_t * cmd)
792 u32 n_events_to_show;
793 clib_error_t *error = 0;
795 n_events_to_show = 250;
796 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
798 if (unformat (input, "%d", &n_events_to_show))
800 else if (unformat (input, "all"))
801 n_events_to_show = ~0;
803 return unformat_parse_error (input);
805 elog_show_buffer_internal (vm, n_events_to_show);
809 VLIB_CLI_COMMAND (elog_show_cli, static) = {
810 .path = "show event-logger",
811 .short_help = "Show event logger info",
812 .function = elog_show_buffer,
816 vlib_gdb_show_event_log (void)
818 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
822 vlib_elog_main_loop_event (vlib_main_t * vm,
824 u64 time, u32 n_vectors, u32 is_return)
826 vlib_main_t *evm = vlib_get_first_main ();
827 elog_main_t *em = vlib_get_elog_main ();
828 int enabled = evm->elog_trace_graph_dispatch |
829 evm->elog_trace_graph_circuit;
831 if (PREDICT_FALSE (enabled && n_vectors))
833 if (PREDICT_FALSE (!elog_is_enabled (em)))
835 evm->elog_trace_graph_dispatch = 0;
836 evm->elog_trace_graph_circuit = 0;
840 (evm->elog_trace_graph_dispatch ||
841 (evm->elog_trace_graph_circuit &&
842 node_index == evm->elog_trace_graph_circuit_node_index)))
846 vec_elt_at_index (is_return
847 ? evm->node_return_elog_event_types
848 : evm->node_call_elog_event_types,
852 &vlib_worker_threads[vm->thread_index].elog_track
853 : &em->default_track),
854 /* data to log */ n_vectors);
860 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
862 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
863 if (PREDICT_FALSE (b->trajectory_nb >= VLIB_BUFFER_TRACE_TRAJECTORY_MAX))
865 b->trajectory_trace[b->trajectory_nb] = node_index;
870 static_always_inline u64
871 dispatch_node (vlib_main_t * vm,
872 vlib_node_runtime_t * node,
873 vlib_node_type_t type,
874 vlib_node_state_t dispatch_state,
875 vlib_frame_t * frame, u64 last_time_stamp)
879 vlib_node_main_t *nm = &vm->node_main;
880 vlib_next_frame_t *nf;
884 vlib_node_t *n = vlib_get_node (vm, node->node_index);
885 ASSERT (n->type == type);
888 /* Only non-internal nodes may be disabled. */
889 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
891 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
892 return last_time_stamp;
895 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
896 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
898 u32 c = node->input_main_loops_per_call;
899 /* Only call node when count reaches zero. */
902 node->input_main_loops_per_call = c - 1;
903 return last_time_stamp;
907 /* Speculatively prefetch next frames. */
908 if (node->n_next_nodes > 0)
910 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
911 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
914 vm->cpu_time_last_node_dispatch = last_time_stamp;
916 vlib_elog_main_loop_event (vm, node->node_index,
917 last_time_stamp, frame ? frame->n_vectors : 0,
920 vlib_node_runtime_perf_counter (vm, node, frame, 0, last_time_stamp,
921 VLIB_NODE_RUNTIME_PERF_BEFORE);
924 * Turn this on if you run into
925 * "bad monkey" contexts, and you want to know exactly
926 * which nodes they've visited... See ixge.c...
928 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
932 from = vlib_frame_vector_args (frame);
933 for (i = 0; i < frame->n_vectors; i++)
935 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
936 add_trajectory_trace (b, node->node_index);
938 if (PREDICT_TRUE (vm->dispatch_wrapper_fn == 0))
939 n = node->function (vm, node, frame);
941 n = vm->dispatch_wrapper_fn (vm, node, frame);
945 if (PREDICT_TRUE (vm->dispatch_wrapper_fn == 0))
946 n = node->function (vm, node, frame);
948 n = vm->dispatch_wrapper_fn (vm, node, frame);
951 t = clib_cpu_time_now ();
953 vlib_node_runtime_perf_counter (vm, node, frame, n, t,
954 VLIB_NODE_RUNTIME_PERF_AFTER);
956 vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
958 vm->main_loop_vectors_processed += n;
959 vm->main_loop_nodes_processed += n > 0;
961 v = vlib_node_runtime_update_stats (vm, node,
964 /* n_clocks */ t - last_time_stamp);
966 /* When in adaptive mode and vector rate crosses threshold switch to
967 polling mode and vice versa. */
968 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_ADAPTIVE_MODE))
970 ELOG_TYPE_DECLARE (e) =
972 .function = (char *) __FUNCTION__,
973 .format = "%s vector length %d, switching to %s",
974 .format_args = "T4i4t4",
977 "interrupt", "polling",
982 u32 node_name, vector_length, is_polling;
985 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
986 && v >= nm->polling_threshold_vector_length) &&
988 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
990 vlib_node_t *n = vlib_get_node (vm, node->node_index);
991 n->state = VLIB_NODE_STATE_POLLING;
992 node->state = VLIB_NODE_STATE_POLLING;
994 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
995 node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
996 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
997 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1000 vlib_get_first_main ()->elog_trace_graph_dispatch))
1002 vlib_worker_thread_t *w = vlib_worker_threads
1005 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1007 ed->node_name = n->name_elog_string;
1008 ed->vector_length = v;
1012 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1013 && v <= nm->interrupt_threshold_vector_length)
1015 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1017 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1019 /* Switch to interrupt mode after dispatch in polling one more time.
1020 This allows driver to re-enable interrupts. */
1021 n->state = VLIB_NODE_STATE_INTERRUPT;
1022 node->state = VLIB_NODE_STATE_INTERRUPT;
1024 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1025 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1026 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
1031 vlib_worker_thread_t *w = vlib_worker_threads
1034 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1036 vlib_get_first_main ()->elog_trace_graph_dispatch))
1038 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1040 ed->node_name = n->name_elog_string;
1041 ed->vector_length = v;
1052 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1053 u64 last_time_stamp)
1055 vlib_node_main_t *nm = &vm->node_main;
1057 vlib_next_frame_t *nf, nf_placeholder;
1058 vlib_node_runtime_t *n;
1059 vlib_frame_t *restore_frame;
1060 vlib_pending_frame_t *p;
1062 /* See comment below about dangling references to nm->pending_frames */
1063 p = nm->pending_frames + pending_frame_index;
1065 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1066 p->node_runtime_index);
1068 f = vlib_get_frame (vm, p->frame);
1069 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1071 /* No next frame: so use placeholder on stack. */
1072 nf = &nf_placeholder;
1073 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1077 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1079 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1081 /* Force allocation of new frame while current frame is being
1083 restore_frame = NULL;
1084 if (nf->frame == p->frame)
1087 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1088 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1089 restore_frame = p->frame;
1092 /* Frame must be pending. */
1093 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1094 ASSERT (f->n_vectors > 0);
1096 /* Copy trace flag from next frame to node.
1097 Trace flag indicates that at least one vector in the dispatched
1099 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1100 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1101 nf->flags &= ~VLIB_FRAME_TRACE;
1103 last_time_stamp = dispatch_node (vm, n,
1104 VLIB_NODE_TYPE_INTERNAL,
1105 VLIB_NODE_STATE_POLLING,
1106 f, last_time_stamp);
1107 /* Internal node vector-rate accounting, for summary stats */
1108 vm->internal_node_vectors += f->n_vectors;
1109 vm->internal_node_calls++;
1110 vm->internal_node_last_vectors_per_main_loop =
1111 (f->n_vectors > vm->internal_node_last_vectors_per_main_loop) ?
1112 f->n_vectors : vm->internal_node_last_vectors_per_main_loop;
1114 f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
1116 /* Frame is ready to be used again, so restore it. */
1117 if (restore_frame != NULL)
1120 * We musn't restore a frame that is flagged to be freed. This
1121 * shouldn't happen since frames to be freed post dispatch are
1122 * those used when the to-node frame becomes full i.e. they form a
1123 * sort of queue of frames to a single node. If we get here then
1124 * the to-node frame and the pending frame *were* the same, and so
1125 * we removed the to-node frame. Therefore this frame is no
1126 * longer part of the queue for that node and hence it cannot be
1129 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1132 * NB: dispatching node n can result in the creation and scheduling
1133 * of new frames, and hence in the reallocation of nm->pending_frames.
1134 * Recompute p, or no supper. This was broken for more than 10 years.
1136 p = nm->pending_frames + pending_frame_index;
1139 * p->next_frame_index can change during node dispatch if node
1140 * function decides to change graph hook up.
1142 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1143 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1145 if (NULL == nf->frame)
1147 /* no new frame has been assigned to this node, use the saved one */
1148 nf->frame = restore_frame;
1154 /* The node has gained a frame, implying packets from the current frame
1155 were re-queued to this same node. we don't need the saved one
1157 vlib_frame_free (vm, f);
1162 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1164 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1165 vlib_frame_free (vm, f);
1169 return last_time_stamp;
1173 vlib_process_stack_is_valid (vlib_process_t * p)
1175 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1181 vlib_process_t *process;
1182 vlib_frame_t *frame;
1183 } vlib_process_bootstrap_args_t;
1185 /* Called in process stack. */
1187 vlib_process_bootstrap (uword _a)
1189 vlib_process_bootstrap_args_t *a;
1191 vlib_node_runtime_t *node;
1196 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1200 vlib_process_finish_switch_stack (vm);
1203 node = &p->node_runtime;
1205 n = node->function (vm, node, f);
1207 ASSERT (vlib_process_stack_is_valid (p));
1209 vlib_process_start_switch_stack (vm, 0);
1210 clib_longjmp (&p->return_longjmp, n);
1215 /* Called in main stack. */
1216 static_always_inline uword
1217 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1219 vlib_process_bootstrap_args_t a;
1226 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1227 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1229 vlib_process_start_switch_stack (vm, p);
1230 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1231 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1234 vlib_process_finish_switch_stack (vm);
1239 static_always_inline uword
1240 vlib_process_resume (vlib_main_t * vm, vlib_process_t * p)
1243 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1244 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1245 | VLIB_PROCESS_RESUME_PENDING);
1246 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1247 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1249 vlib_process_start_switch_stack (vm, p);
1250 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1253 vlib_process_finish_switch_stack (vm);
1258 dispatch_process (vlib_main_t * vm,
1259 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
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 u32 old_process_index;
1266 uword n_vectors, is_suspend;
1268 if (node->state != VLIB_NODE_STATE_POLLING
1269 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1270 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1271 return last_time_stamp;
1273 p->flags |= VLIB_PROCESS_IS_RUNNING;
1275 t = last_time_stamp;
1276 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1277 f ? f->n_vectors : 0, /* is_after */ 0);
1279 /* Save away current process for suspend. */
1280 old_process_index = nm->current_process_index;
1281 nm->current_process_index = node->runtime_index;
1283 vlib_node_runtime_perf_counter (vm, node_runtime, f, 0, last_time_stamp,
1284 VLIB_NODE_RUNTIME_PERF_BEFORE);
1286 n_vectors = vlib_process_startup (vm, p, f);
1288 nm->current_process_index = old_process_index;
1290 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1291 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1294 vlib_pending_frame_t *pf;
1297 pool_get (nm->suspended_process_frames, pf);
1298 pf->node_runtime_index = node->runtime_index;
1300 pf->next_frame_index = ~0;
1303 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1305 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1307 TWT (tw_timer_wheel) * tw =
1308 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1309 p->stop_timer_handle =
1310 TW (tw_timer_start) (tw,
1311 vlib_timing_wheel_data_set_suspended_process
1312 (node->runtime_index) /* [sic] pool idex */ ,
1314 p->resume_clock_interval);
1318 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1320 t = clib_cpu_time_now ();
1322 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1325 vlib_node_runtime_perf_counter (vm, node_runtime, f, n_vectors, t,
1326 VLIB_NODE_RUNTIME_PERF_AFTER);
1328 vlib_process_update_stats (vm, p,
1329 /* n_calls */ !is_suspend,
1330 /* n_vectors */ n_vectors,
1331 /* n_clocks */ t - last_time_stamp);
1337 vlib_start_process (vlib_main_t * vm, uword process_index)
1339 vlib_node_main_t *nm = &vm->node_main;
1340 vlib_process_t *p = vec_elt (nm->processes, process_index);
1341 u64 cpu_time_now = clib_cpu_time_now ();
1342 dispatch_process (vm, p, /* frame */ 0, cpu_time_now);
1346 dispatch_suspended_process (vlib_main_t * vm,
1347 uword process_index, u64 last_time_stamp)
1349 vlib_node_main_t *nm = &vm->node_main;
1350 vlib_node_runtime_t *node_runtime;
1354 vlib_pending_frame_t *pf;
1355 u64 t, n_vectors, is_suspend;
1357 t = last_time_stamp;
1359 p = vec_elt (nm->processes, process_index);
1360 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1361 return last_time_stamp;
1363 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1364 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1366 pf = pool_elt_at_index (nm->suspended_process_frames,
1367 p->suspended_process_frame_index);
1369 node_runtime = &p->node_runtime;
1370 node = vlib_get_node (vm, node_runtime->node_index);
1373 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1374 f ? f->n_vectors : 0, /* is_after */ 0);
1376 /* Save away current process for suspend. */
1377 nm->current_process_index = node->runtime_index;
1379 vlib_node_runtime_perf_counter (vm, node_runtime, f, 0, last_time_stamp,
1380 VLIB_NODE_RUNTIME_PERF_BEFORE);
1382 n_vectors = vlib_process_resume (vm, p);
1383 t = clib_cpu_time_now ();
1385 nm->current_process_index = ~0;
1387 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1390 /* Suspend it again. */
1393 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1395 p->stop_timer_handle =
1396 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1397 vlib_timing_wheel_data_set_suspended_process
1398 (node->runtime_index) /* [sic] pool idex */ ,
1400 p->resume_clock_interval);
1405 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1406 pool_put_index (nm->suspended_process_frames,
1407 p->suspended_process_frame_index);
1408 p->suspended_process_frame_index = ~0;
1411 t = clib_cpu_time_now ();
1412 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1415 vlib_node_runtime_perf_counter (vm, node_runtime, f, n_vectors, t,
1416 VLIB_NODE_RUNTIME_PERF_AFTER);
1418 vlib_process_update_stats (vm, p,
1419 /* n_calls */ !is_suspend,
1420 /* n_vectors */ n_vectors,
1421 /* n_clocks */ t - last_time_stamp);
1426 static_always_inline void
1427 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1429 vlib_node_main_t *nm = &vm->node_main;
1430 vlib_thread_main_t *tm = vlib_get_thread_main ();
1434 vlib_frame_queue_main_t *fqm;
1435 u32 frame_queue_check_counter = 0;
1437 /* Initialize pending node vector. */
1440 vec_resize (nm->pending_frames, 32);
1441 vec_set_len (nm->pending_frames, 0);
1444 /* Mark time of main loop start. */
1447 cpu_time_now = vm->clib_time.last_cpu_time;
1448 vm->cpu_time_main_loop_start = cpu_time_now;
1451 cpu_time_now = clib_cpu_time_now ();
1453 /* Pre-allocate expired nodes. */
1454 if (!nm->polling_threshold_vector_length)
1455 nm->polling_threshold_vector_length = 10;
1456 if (!nm->interrupt_threshold_vector_length)
1457 nm->interrupt_threshold_vector_length = 5;
1459 vm->cpu_id = clib_get_current_cpu_id ();
1460 vm->numa_node = clib_get_current_numa_node ();
1461 os_set_numa_index (vm->numa_node);
1463 /* Start all processes. */
1469 * Perform an initial barrier sync. Pays no attention to
1470 * the barrier sync hold-down timer scheme, which won't work
1471 * at this point in time.
1473 vlib_worker_thread_initial_barrier_sync_and_release (vm);
1475 nm->current_process_index = ~0;
1476 for (i = 0; i < vec_len (nm->processes); i++)
1477 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1483 vlib_node_runtime_t *n;
1485 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1488 vlib_worker_flush_pending_rpc_requests (vm);
1492 vlib_worker_thread_barrier_check ();
1494 if (PREDICT_FALSE (vm->check_frame_queues + frame_queue_check_counter))
1497 vlib_frame_queue_dequeue_fn_t *fn;
1499 if (vm->check_frame_queues)
1501 frame_queue_check_counter = 100;
1502 vm->check_frame_queues = 0;
1505 vec_foreach (fqm, tm->frame_queue_mains)
1507 fn = fqm->frame_queue_dequeue_fn;
1508 processed += (fn) (vm, fqm);
1511 /* No handoff queue work found? */
1513 frame_queue_check_counter = 100;
1515 frame_queue_check_counter--;
1518 if (PREDICT_FALSE (vec_len (vm->worker_thread_main_loop_callbacks)))
1519 clib_call_callbacks (vm->worker_thread_main_loop_callbacks, vm,
1522 /* Process pre-input nodes. */
1523 cpu_time_now = clib_cpu_time_now ();
1524 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1525 cpu_time_now = dispatch_node (vm, n,
1526 VLIB_NODE_TYPE_PRE_INPUT,
1527 VLIB_NODE_STATE_POLLING,
1531 if (clib_interrupt_is_any_pending (nm->pre_input_node_interrupts))
1535 while ((int_num = clib_interrupt_get_next_and_clear (
1536 nm->pre_input_node_interrupts, int_num)) != -1)
1538 vlib_node_runtime_t *n;
1539 n = vec_elt_at_index (
1540 nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT], int_num);
1541 cpu_time_now = dispatch_node (vm, n, VLIB_NODE_TYPE_PRE_INPUT,
1542 VLIB_NODE_STATE_INTERRUPT,
1543 /* frame */ 0, cpu_time_now);
1547 /* Next process input nodes. */
1548 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1549 cpu_time_now = dispatch_node (vm, n,
1550 VLIB_NODE_TYPE_INPUT,
1551 VLIB_NODE_STATE_POLLING,
1555 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1556 vm->queue_signal_callback (vm);
1558 if (clib_interrupt_is_any_pending (nm->input_node_interrupts))
1562 while ((int_num = clib_interrupt_get_next_and_clear (
1563 nm->input_node_interrupts, int_num)) != -1)
1565 vlib_node_runtime_t *n;
1566 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1568 cpu_time_now = dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1569 VLIB_NODE_STATE_INTERRUPT,
1570 /* frame */ 0, cpu_time_now);
1574 /* Input nodes may have added work to the pending vector.
1575 Process pending vector until there is nothing left.
1576 All pending vectors will be processed from input -> output. */
1577 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1578 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1579 /* Reset pending vector for next iteration. */
1580 vec_set_len (nm->pending_frames, 0);
1584 ELOG_TYPE_DECLARE (es) =
1586 .format = "process tw start",
1589 ELOG_TYPE_DECLARE (ee) =
1591 .format = "process tw end: %d",
1592 .format_args = "i4",
1600 /* Check if process nodes have expired from timing wheel. */
1601 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1603 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1604 ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1606 TW (tw_timer_expire_timers)
1607 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm));
1609 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1611 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1613 ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1615 _vec_len (nm->data_from_advancing_timing_wheel);
1619 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1623 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1626 u32 d = nm->data_from_advancing_timing_wheel[i];
1627 u32 di = vlib_timing_wheel_data_get_index (d);
1629 if (vlib_timing_wheel_data_is_timed_event (d))
1631 vlib_signal_timed_event_data_t *te =
1632 pool_elt_at_index (nm->signal_timed_event_data_pool,
1635 vlib_get_node (vm, te->process_node_index);
1637 vec_elt (nm->processes, n->runtime_index);
1638 p->stop_timer_handle = ~0;
1641 vlib_process_signal_event_helper (nm, n, p,
1642 te->event_type_index,
1644 te->n_data_elt_bytes);
1645 if (te->n_data_bytes < sizeof (te->inline_event_data))
1646 clib_memcpy_fast (data, te->inline_event_data,
1650 clib_memcpy_fast (data, te->event_data_as_vector,
1652 vec_free (te->event_data_as_vector);
1654 pool_put (nm->signal_timed_event_data_pool, te);
1658 cpu_time_now = clib_cpu_time_now ();
1660 dispatch_suspended_process (vm, di, cpu_time_now);
1663 vec_set_len (nm->data_from_advancing_timing_wheel, 0);
1666 vlib_increment_main_loop_counter (vm);
1667 /* Record time stamp in case there are no enabled nodes and above
1668 calls do not update time stamp. */
1669 cpu_time_now = clib_cpu_time_now ();
1670 vm->loops_this_reporting_interval++;
1671 now = clib_time_now_internal (&vm->clib_time, cpu_time_now);
1672 /* Time to update loops_per_second? */
1673 if (PREDICT_FALSE (now >= vm->loop_interval_end))
1675 /* Next sample ends in 20ms */
1676 if (vm->loop_interval_start)
1678 f64 this_loops_per_second;
1680 this_loops_per_second =
1681 ((f64) vm->loops_this_reporting_interval) / (now -
1682 vm->loop_interval_start);
1684 vm->loops_per_second =
1685 vm->loops_per_second * vm->damping_constant +
1686 (1.0 - vm->damping_constant) * this_loops_per_second;
1687 if (vm->loops_per_second != 0.0)
1688 vm->seconds_per_loop = 1.0 / vm->loops_per_second;
1690 vm->seconds_per_loop = 0.0;
1692 /* New interval starts now, and ends in 20ms */
1693 vm->loop_interval_start = now;
1694 vm->loop_interval_end = now + 2e-4;
1695 vm->loops_this_reporting_interval = 0;
1701 vlib_main_loop (vlib_main_t * vm)
1703 vlib_main_or_worker_loop (vm, /* is_main */ 1);
1707 vlib_worker_loop (vlib_main_t * vm)
1709 vlib_main_or_worker_loop (vm, /* is_main */ 0);
1712 vlib_global_main_t vlib_global_main;
1715 vlib_add_del_post_mortem_callback (void *cb, int is_add)
1717 vlib_global_main_t *vgm = vlib_get_global_main ();
1722 for (i = vec_len (vgm->post_mortem_callbacks) - 1; i >= 0; i--)
1723 if (vgm->post_mortem_callbacks[i] == cb)
1724 vec_del1 (vgm->post_mortem_callbacks, i);
1728 for (i = 0; i < vec_len (vgm->post_mortem_callbacks); i++)
1729 if (vgm->post_mortem_callbacks[i] == cb)
1731 vec_add1 (vgm->post_mortem_callbacks, cb);
1735 elog_post_mortem_dump (void)
1737 elog_main_t *em = vlib_get_elog_main ();
1740 clib_error_t *error;
1742 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
1743 error = elog_write_file (em, (char *) filename, 1 /* flush ring */);
1745 clib_error_report (error);
1747 * We're in the middle of crashing. Don't try to free the filename.
1751 static clib_error_t *
1752 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1754 vlib_global_main_t *vgm = vlib_get_global_main ();
1755 int turn_on_mem_trace = 0;
1757 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1759 if (unformat (input, "memory-trace"))
1760 turn_on_mem_trace = 1;
1762 else if (unformat (input, "elog-events %d",
1763 &vgm->configured_elog_ring_size))
1764 vgm->configured_elog_ring_size =
1765 1 << max_log2 (vgm->configured_elog_ring_size);
1766 else if (unformat (input, "elog-post-mortem-dump"))
1767 vlib_add_del_post_mortem_callback (elog_post_mortem_dump,
1769 else if (unformat (input, "buffer-alloc-success-rate %f",
1770 &vm->buffer_alloc_success_rate))
1772 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
1773 return clib_error_return
1774 (0, "Buffer fault injection not configured");
1776 else if (unformat (input, "buffer-alloc-success-seed %u",
1777 &vm->buffer_alloc_success_seed))
1779 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
1780 return clib_error_return
1781 (0, "Buffer fault injection not configured");
1784 return unformat_parse_error (input);
1787 unformat_free (input);
1789 /* Enable memory trace as early as possible. */
1790 if (turn_on_mem_trace)
1796 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1799 placeholder_queue_signal_callback (vlib_main_t * vm)
1803 #define foreach_weak_reference_stub \
1805 _(vlibmemory_init) \
1806 _(map_api_segment_init)
1809 clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
1810 clib_error_t *name (vlib_main_t *vm) { return 0; }
1811 foreach_weak_reference_stub;
1814 void vl_api_set_elog_main (elog_main_t * m) __attribute__ ((weak));
1816 vl_api_set_elog_main (elog_main_t * m)
1818 clib_warning ("STUB");
1821 int vl_api_set_elog_trace_api_messages (int enable) __attribute__ ((weak));
1823 vl_api_set_elog_trace_api_messages (int enable)
1825 clib_warning ("STUB");
1829 int vl_api_get_elog_trace_api_messages (void) __attribute__ ((weak));
1831 vl_api_get_elog_trace_api_messages (void)
1833 clib_warning ("STUB");
1838 process_expired_timer_cb (u32 *expired_timer_handles)
1840 vlib_main_t *vm = vlib_get_main ();
1841 vlib_node_main_t *nm = &vm->node_main;
1844 vec_foreach (handle, expired_timer_handles)
1846 u32 pi = vlib_timing_wheel_data_get_index (*handle);
1847 vlib_process_t *p = vec_elt (nm->processes, pi);
1849 p->stop_timer_handle = ~0;
1851 vec_append (nm->data_from_advancing_timing_wheel, expired_timer_handles);
1854 /* Main function. */
1856 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
1858 vlib_global_main_t *vgm = vlib_get_global_main ();
1859 clib_error_t *volatile error;
1860 vlib_node_main_t *nm = &vm->node_main;
1862 vm->queue_signal_callback = placeholder_queue_signal_callback;
1864 /* Reconfigure event log which is enabled very early */
1865 if (vgm->configured_elog_ring_size &&
1866 vgm->configured_elog_ring_size != vgm->elog_main.event_ring_size)
1867 elog_resize (&vgm->elog_main, vgm->configured_elog_ring_size);
1868 vl_api_set_elog_main (vlib_get_elog_main ());
1869 (void) vl_api_set_elog_trace_api_messages (1);
1875 if ((error = vlib_physmem_init (vm)))
1877 clib_error_report (error);
1881 if ((error = vlib_log_init (vm)))
1883 clib_error_report (error);
1887 if ((error = vlib_stats_init (vm)))
1889 clib_error_report (error);
1893 if ((error = vlib_buffer_main_init (vm)))
1895 clib_error_report (error);
1899 if ((error = vlib_thread_init (vm)))
1901 clib_error_report (error);
1905 /* Register node ifunction variants */
1906 vlib_register_all_node_march_variants (vm);
1908 /* Register static nodes so that init functions may use them. */
1909 vlib_register_all_static_nodes (vm);
1911 /* Set seed for random number generator.
1912 Allow user to specify seed to make random sequence deterministic. */
1913 if (!unformat (input, "seed %wd", &vm->random_seed))
1914 vm->random_seed = clib_cpu_time_now ();
1915 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
1917 /* Initialize node graph. */
1918 if ((error = vlib_node_main_init (vm)))
1920 /* Arrange for graph hook up error to not be fatal when debugging. */
1922 clib_error_report (error);
1927 /* Direct call / weak reference, for vlib standalone use-cases */
1928 if ((error = vpe_api_init (vm)))
1930 clib_error_report (error);
1934 if ((error = vlibmemory_init (vm)))
1936 clib_error_report (error);
1940 if ((error = map_api_segment_init (vm)))
1942 clib_error_report (error);
1946 /* See unix/main.c; most likely already set up */
1947 if (vgm->init_functions_called == 0)
1948 vgm->init_functions_called = hash_create (0, /* value bytes */ 0);
1949 if ((error = vlib_call_all_init_functions (vm)))
1952 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
1953 CLIB_CACHE_LINE_BYTES);
1955 vec_validate (nm->data_from_advancing_timing_wheel, 10);
1956 vec_set_len (nm->data_from_advancing_timing_wheel, 0);
1958 /* Create the process timing wheel */
1959 TW (tw_timer_wheel_init)
1960 ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1961 process_expired_timer_cb /* callback */, 10e-6 /* timer period 10us */,
1962 ~0 /* max expirations per call */);
1964 vec_validate (vm->pending_rpc_requests, 0);
1965 vec_set_len (vm->pending_rpc_requests, 0);
1966 vec_validate (vm->processing_rpc_requests, 0);
1967 vec_set_len (vm->processing_rpc_requests, 0);
1969 /* Default params for the buffer allocator fault injector, if configured */
1970 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0)
1972 vm->buffer_alloc_success_seed = 0xdeaddabe;
1973 vm->buffer_alloc_success_rate = 0.80;
1976 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
1980 * Use exponential smoothing, with a half-life of 1 second
1981 * reported_rate(t) = reported_rate(t-1) * K + rate(t)*(1-K)
1983 * Sample every 20ms, aka 50 samples per second
1984 * K = exp (-1.0/20.0);
1987 vm->damping_constant = exp (-1.0 / 20.0);
1989 /* Sort per-thread init functions before we start threads */
1990 vlib_sort_init_exit_functions (&vgm->worker_init_function_registrations);
1992 /* Call all main loop enter functions. */
1994 clib_error_t *sub_error;
1995 sub_error = vlib_call_all_main_loop_enter_functions (vm);
1997 clib_error_report (sub_error);
2000 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2002 case VLIB_MAIN_LOOP_EXIT_NONE:
2003 vm->main_loop_exit_set = 1;
2006 case VLIB_MAIN_LOOP_EXIT_CLI:
2010 error = vm->main_loop_error;
2014 vlib_main_loop (vm);
2017 /* Stop worker threads, barrier will not be released */
2018 vlib_worker_thread_barrier_sync (vm);
2020 /* Call all exit functions. */
2022 clib_error_t *sub_error;
2023 sub_error = vlib_call_all_main_loop_exit_functions (vm);
2025 clib_error_report (sub_error);
2029 clib_error_report (error);
2031 return vm->main_loop_exit_status;
2035 vlib_get_main_not_inline (void)
2037 return vlib_get_main ();
2041 vlib_get_elog_main_not_inline ()
2043 return &vlib_global_main.elog_main;
2047 vlib_exit_with_status (vlib_main_t *vm, int status)
2049 vm->main_loop_exit_status = status;
2050 __atomic_store_n (&vm->main_loop_exit_now, 1, __ATOMIC_RELEASE);
2054 * fd.io coding-style-patch-verification: ON
2057 * eval: (c-set-style "gnu")