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,
244 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
245 .path = "show vlib frame-allocation",
246 .short_help = "Show node dispatch frame statistics",
247 .function = show_frame_stats,
251 /* Change ownership of enqueue rights to given next node. */
253 vlib_next_frame_change_ownership (vlib_main_t * vm,
254 vlib_node_runtime_t * node_runtime,
257 vlib_node_main_t *nm = &vm->node_main;
258 vlib_next_frame_t *next_frame;
259 vlib_node_t *node, *next_node;
261 node = vec_elt (nm->nodes, node_runtime->node_index);
263 /* Only internal & input nodes are allowed to call other nodes. */
264 ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
265 || node->type == VLIB_NODE_TYPE_INPUT
266 || node->type == VLIB_NODE_TYPE_PROCESS);
268 ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
271 vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
272 next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
274 if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
276 /* Get frame from previous owner. */
277 vlib_next_frame_t *owner_next_frame;
278 vlib_next_frame_t tmp;
281 vlib_node_get_next_frame (vm,
282 next_node->owner_node_index,
283 next_node->owner_next_index);
285 /* Swap target next frame with owner's. */
286 tmp = owner_next_frame[0];
287 owner_next_frame[0] = next_frame[0];
291 * If next_frame is already pending, we have to track down
292 * all pending frames and fix their next_frame_index fields.
294 if (next_frame->flags & VLIB_FRAME_PENDING)
296 vlib_pending_frame_t *p;
297 if (next_frame->frame != NULL)
299 vec_foreach (p, nm->pending_frames)
301 if (p->frame == next_frame->frame)
303 p->next_frame_index =
304 next_frame - vm->node_main.next_frames;
312 /* No previous owner. Take ownership. */
313 next_frame->flags |= VLIB_FRAME_OWNER;
316 /* Record new owner. */
317 next_node->owner_node_index = node->index;
318 next_node->owner_next_index = next_index;
320 /* Now we should be owner. */
321 ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
324 /* Make sure that magic number is still there.
325 Otherwise, it is likely that caller has overrun frame arguments. */
327 validate_frame_magic (vlib_main_t * vm,
328 vlib_frame_t * f, vlib_node_t * n, uword next_index)
330 vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
331 u32 *magic = vlib_frame_find_magic (f, next_node);
332 ASSERT (VLIB_FRAME_MAGIC == magic[0]);
336 vlib_get_next_frame_internal (vlib_main_t * vm,
337 vlib_node_runtime_t * node,
338 u32 next_index, u32 allocate_new_next_frame)
341 vlib_next_frame_t *nf;
344 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
346 /* Make sure this next frame owns right to enqueue to destination frame. */
347 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
348 vlib_next_frame_change_ownership (vm, node, next_index);
350 /* ??? Don't need valid flag: can use frame_index == ~0 */
351 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
353 nf->frame = vlib_frame_alloc (vm, node, next_index);
354 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
359 /* Has frame been removed from pending vector (e.g. finished dispatching)?
360 If so we can reuse frame. */
361 if ((nf->flags & VLIB_FRAME_PENDING)
362 && !(f->frame_flags & VLIB_FRAME_PENDING))
364 nf->flags &= ~VLIB_FRAME_PENDING;
369 /* Allocate new frame if current one is marked as no-append or
370 it is already full. */
371 n_used = f->n_vectors;
372 if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0) ||
373 (f->frame_flags & VLIB_FRAME_NO_APPEND))
375 /* Old frame may need to be freed after dispatch, since we'll have
376 two redundant frames from node -> next node. */
377 if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
379 vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame);
380 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
383 /* Allocate new frame to replace full one. */
384 f = nf->frame = vlib_frame_alloc (vm, node, next_index);
385 n_used = f->n_vectors;
388 /* Should have free vectors in frame now. */
389 ASSERT (n_used < VLIB_FRAME_SIZE);
393 validate_frame_magic (vm, f,
394 vlib_get_node (vm, node->node_index), next_index);
401 vlib_put_next_frame_validate (vlib_main_t * vm,
402 vlib_node_runtime_t * rt,
403 u32 next_index, u32 n_vectors_left)
405 vlib_node_main_t *nm = &vm->node_main;
406 vlib_next_frame_t *nf;
408 vlib_node_runtime_t *next_rt;
409 vlib_node_t *next_node;
410 u32 n_before, n_after;
412 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
413 f = vlib_get_frame (vm, nf->frame);
415 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
417 vlib_validate_frame_indices (f);
419 n_after = VLIB_FRAME_SIZE - n_vectors_left;
420 n_before = f->n_vectors;
422 ASSERT (n_after >= n_before);
424 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
425 nf->node_runtime_index);
426 next_node = vlib_get_node (vm, next_rt->node_index);
427 if (n_after > 0 && next_node->validate_frame)
429 u8 *msg = next_node->validate_frame (vm, rt, f);
432 clib_warning ("%v", msg);
440 vlib_put_next_frame (vlib_main_t * vm,
441 vlib_node_runtime_t * r,
442 u32 next_index, u32 n_vectors_left)
444 vlib_node_main_t *nm = &vm->node_main;
445 vlib_next_frame_t *nf;
447 u32 n_vectors_in_frame;
450 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
452 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
453 f = vlib_get_frame (vm, nf->frame);
455 /* Make sure that magic number is still there. Otherwise, caller
456 has overrun frame meta data. */
459 vlib_node_t *node = vlib_get_node (vm, r->node_index);
460 validate_frame_magic (vm, f, node, next_index);
463 /* Convert # of vectors left -> number of vectors there. */
464 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
465 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
467 f->n_vectors = n_vectors_in_frame;
469 /* If vectors were added to frame, add to pending vector. */
470 if (PREDICT_TRUE (n_vectors_in_frame > 0))
472 vlib_pending_frame_t *p;
475 r->cached_next_index = next_index;
477 if (!(f->frame_flags & VLIB_FRAME_PENDING))
479 __attribute__ ((unused)) vlib_node_t *node;
481 node = vlib_get_node (vm, r->node_index);
483 vec_add2 (nm->pending_frames, p, 1);
485 p->frame = nf->frame;
486 p->node_runtime_index = nf->node_runtime_index;
487 p->next_frame_index = nf - nm->next_frames;
488 nf->flags |= VLIB_FRAME_PENDING;
489 f->frame_flags |= VLIB_FRAME_PENDING;
492 /* Copy trace flag from next_frame and from runtime. */
494 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
495 flags & VLIB_NODE_FLAG_TRACE);
497 v0 = nf->vectors_since_last_overflow;
498 v1 = v0 + n_vectors_in_frame;
499 nf->vectors_since_last_overflow = v1;
500 if (PREDICT_FALSE (v1 < v0))
502 vlib_node_t *node = vlib_get_node (vm, r->node_index);
503 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
508 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
510 vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
511 uword n_calls, uword n_vectors,
514 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
515 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
516 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
517 n->stats_total.max_clock = r->max_clock;
518 n->stats_total.max_clock_n = r->max_clock_n;
520 r->calls_since_last_overflow = 0;
521 r->vectors_since_last_overflow = 0;
522 r->clocks_since_last_overflow = 0;
526 vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
527 uword n_calls, uword n_vectors, uword n_clocks)
529 vlib_node_t *n = vlib_get_node (vm, r->node_index);
530 vlib_node_runtime_sync_stats_node (n, r, n_calls, n_vectors, n_clocks);
533 always_inline void __attribute__ ((unused))
534 vlib_process_sync_stats (vlib_main_t * vm,
536 uword n_calls, uword n_vectors, uword n_clocks)
538 vlib_node_runtime_t *rt = &p->node_runtime;
539 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
540 vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks);
541 n->stats_total.suspends += p->n_suspends;
546 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
548 vlib_node_runtime_t *rt;
550 if (n->type == VLIB_NODE_TYPE_PROCESS)
552 /* Nothing to do for PROCESS nodes except in main thread */
553 if (vm != vlib_get_first_main ())
556 vlib_process_t *p = vlib_get_process_from_node (vm, n);
557 n->stats_total.suspends += p->n_suspends;
559 rt = &p->node_runtime;
563 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
566 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0);
568 /* Sync up runtime next frame vector counters with main node structure. */
570 vlib_next_frame_t *nf;
572 for (i = 0; i < rt->n_next_nodes; i++)
574 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
575 vec_elt (n->n_vectors_by_next_node, i) +=
576 nf->vectors_since_last_overflow;
577 nf->vectors_since_last_overflow = 0;
583 vlib_node_runtime_update_stats (vlib_main_t * vm,
584 vlib_node_runtime_t * node,
586 uword n_vectors, uword n_clocks)
588 u32 ca0, ca1, v0, v1, cl0, cl1, r;
590 cl0 = cl1 = node->clocks_since_last_overflow;
591 ca0 = ca1 = node->calls_since_last_overflow;
592 v0 = v1 = node->vectors_since_last_overflow;
596 cl1 = cl0 + n_clocks;
598 node->calls_since_last_overflow = ca1;
599 node->clocks_since_last_overflow = cl1;
600 node->vectors_since_last_overflow = v1;
602 node->max_clock_n = node->max_clock > n_clocks ?
603 node->max_clock_n : n_vectors;
604 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
606 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
608 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0))
610 node->calls_since_last_overflow = ca0;
611 node->clocks_since_last_overflow = cl0;
612 node->vectors_since_last_overflow = v0;
614 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks);
621 vlib_process_update_stats (vlib_main_t * vm,
623 uword n_calls, uword n_vectors, uword n_clocks)
625 vlib_node_runtime_update_stats (vm, &p->node_runtime,
626 n_calls, n_vectors, n_clocks);
629 static clib_error_t *
630 vlib_cli_elog_clear (vlib_main_t * vm,
631 unformat_input_t * input, vlib_cli_command_t * cmd)
633 elog_reset_buffer (&vlib_global_main.elog_main);
638 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
639 .path = "event-logger clear",
640 .short_help = "Clear the event log",
641 .function = vlib_cli_elog_clear,
646 static clib_error_t *
647 elog_save_buffer (vlib_main_t * vm,
648 unformat_input_t * input, vlib_cli_command_t * cmd)
650 elog_main_t *em = &vlib_global_main.elog_main;
651 char *file, *chroot_file;
652 clib_error_t *error = 0;
654 if (!unformat (input, "%s", &file))
656 vlib_cli_output (vm, "expected file name, got `%U'",
657 format_unformat_error, input);
661 /* It's fairly hard to get "../oopsie" through unformat; just in case */
662 if (strstr (file, "..") || index (file, '/'))
664 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
668 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
672 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
673 elog_n_events_in_buffer (em),
674 elog_buffer_capacity (em), chroot_file);
676 vlib_worker_thread_barrier_sync (vm);
677 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
678 vlib_worker_thread_barrier_release (vm);
679 vec_free (chroot_file);
684 vlib_post_mortem_dump (void)
686 vlib_global_main_t *vgm = vlib_get_global_main ();
688 for (int i = 0; i < vec_len (vgm->post_mortem_callbacks); i++)
689 (vgm->post_mortem_callbacks[i]) ();
693 VLIB_CLI_COMMAND (elog_save_cli, static) = {
694 .path = "event-logger save",
695 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
696 .function = elog_save_buffer,
700 static clib_error_t *
701 elog_stop (vlib_main_t * vm,
702 unformat_input_t * input, vlib_cli_command_t * cmd)
704 elog_main_t *em = &vlib_global_main.elog_main;
706 em->n_total_events_disable_limit = em->n_total_events;
708 vlib_cli_output (vm, "Stopped the event logger...");
713 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
714 .path = "event-logger stop",
715 .short_help = "Stop the event-logger",
716 .function = elog_stop,
720 static clib_error_t *
721 elog_restart (vlib_main_t * vm,
722 unformat_input_t * input, vlib_cli_command_t * cmd)
724 elog_main_t *em = &vlib_global_main.elog_main;
726 em->n_total_events_disable_limit = ~0;
728 vlib_cli_output (vm, "Restarted the event logger...");
733 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
734 .path = "event-logger restart",
735 .short_help = "Restart the event-logger",
736 .function = elog_restart,
740 static clib_error_t *
741 elog_resize_command_fn (vlib_main_t * vm,
742 unformat_input_t * input, vlib_cli_command_t * cmd)
744 elog_main_t *em = &vlib_global_main.elog_main;
747 /* Stop the parade */
748 elog_reset_buffer (em);
750 if (unformat (input, "%d", &tmp))
752 elog_alloc (em, tmp);
753 em->n_total_events_disable_limit = ~0;
756 return clib_error_return (0, "Must specify how many events in the ring");
758 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
763 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
764 .path = "event-logger resize",
765 .short_help = "event-logger resize <nnn>",
766 .function = elog_resize_command_fn,
770 #endif /* CLIB_UNIX */
773 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
775 elog_main_t *em = &vlib_global_main.elog_main;
776 elog_event_t *e, *es;
779 /* Show events in VLIB time since log clock starts after VLIB clock. */
780 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
781 * vm->clib_time.seconds_per_clock;
783 es = elog_peek_events (em);
784 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
786 em->n_total_events < em->n_total_events_disable_limit ?
787 "running" : "stopped");
790 vlib_cli_output (vm, "%18.9f: %U",
791 e->time + dt, format_elog_event, em, e);
793 if (n_events_to_show == 0)
800 static clib_error_t *
801 elog_show_buffer (vlib_main_t * vm,
802 unformat_input_t * input, vlib_cli_command_t * cmd)
804 u32 n_events_to_show;
805 clib_error_t *error = 0;
807 n_events_to_show = 250;
808 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
810 if (unformat (input, "%d", &n_events_to_show))
812 else if (unformat (input, "all"))
813 n_events_to_show = ~0;
815 return unformat_parse_error (input);
817 elog_show_buffer_internal (vm, n_events_to_show);
822 VLIB_CLI_COMMAND (elog_show_cli, static) = {
823 .path = "show event-logger",
824 .short_help = "Show event logger info",
825 .function = elog_show_buffer,
830 vlib_gdb_show_event_log (void)
832 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
836 vlib_elog_main_loop_event (vlib_main_t * vm,
838 u64 time, u32 n_vectors, u32 is_return)
840 vlib_main_t *evm = vlib_get_first_main ();
841 elog_main_t *em = vlib_get_elog_main ();
842 int enabled = evm->elog_trace_graph_dispatch |
843 evm->elog_trace_graph_circuit;
845 if (PREDICT_FALSE (enabled && n_vectors))
847 if (PREDICT_FALSE (!elog_is_enabled (em)))
849 evm->elog_trace_graph_dispatch = 0;
850 evm->elog_trace_graph_circuit = 0;
854 (evm->elog_trace_graph_dispatch ||
855 (evm->elog_trace_graph_circuit &&
856 node_index == evm->elog_trace_graph_circuit_node_index)))
860 vec_elt_at_index (is_return
861 ? evm->node_return_elog_event_types
862 : evm->node_call_elog_event_types,
866 &vlib_worker_threads[vm->thread_index].elog_track
867 : &em->default_track),
868 /* data to log */ n_vectors);
874 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
876 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
877 if (PREDICT_FALSE (b->trajectory_nb >= VLIB_BUFFER_TRACE_TRAJECTORY_MAX))
879 b->trajectory_trace[b->trajectory_nb] = node_index;
884 static_always_inline u64
885 dispatch_node (vlib_main_t * vm,
886 vlib_node_runtime_t * node,
887 vlib_node_type_t type,
888 vlib_node_state_t dispatch_state,
889 vlib_frame_t * frame, u64 last_time_stamp)
893 vlib_node_main_t *nm = &vm->node_main;
894 vlib_next_frame_t *nf;
898 vlib_node_t *n = vlib_get_node (vm, node->node_index);
899 ASSERT (n->type == type);
902 /* Only non-internal nodes may be disabled. */
903 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
905 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
906 return last_time_stamp;
909 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
910 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
912 u32 c = node->input_main_loops_per_call;
913 /* Only call node when count reaches zero. */
916 node->input_main_loops_per_call = c - 1;
917 return last_time_stamp;
921 /* Speculatively prefetch next frames. */
922 if (node->n_next_nodes > 0)
924 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
925 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
928 vm->cpu_time_last_node_dispatch = last_time_stamp;
930 vlib_elog_main_loop_event (vm, node->node_index,
931 last_time_stamp, frame ? frame->n_vectors : 0,
934 vlib_node_runtime_perf_counter (vm, node, frame, 0, last_time_stamp,
935 VLIB_NODE_RUNTIME_PERF_BEFORE);
938 * Turn this on if you run into
939 * "bad monkey" contexts, and you want to know exactly
940 * which nodes they've visited... See ixge.c...
942 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
946 from = vlib_frame_vector_args (frame);
947 for (i = 0; i < frame->n_vectors; i++)
949 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
950 add_trajectory_trace (b, node->node_index);
952 if (PREDICT_TRUE (vm->dispatch_wrapper_fn == 0))
953 n = node->function (vm, node, frame);
955 n = vm->dispatch_wrapper_fn (vm, node, frame);
959 if (PREDICT_TRUE (vm->dispatch_wrapper_fn == 0))
960 n = node->function (vm, node, frame);
962 n = vm->dispatch_wrapper_fn (vm, node, frame);
965 t = clib_cpu_time_now ();
967 vlib_node_runtime_perf_counter (vm, node, frame, n, t,
968 VLIB_NODE_RUNTIME_PERF_AFTER);
970 vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
972 vm->main_loop_vectors_processed += n;
973 vm->main_loop_nodes_processed += n > 0;
975 v = vlib_node_runtime_update_stats (vm, node,
978 /* n_clocks */ t - last_time_stamp);
980 /* When in adaptive mode and vector rate crosses threshold switch to
981 polling mode and vice versa. */
982 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_ADAPTIVE_MODE))
985 ELOG_TYPE_DECLARE (e) =
987 .function = (char *) __FUNCTION__,
988 .format = "%s vector length %d, switching to %s",
989 .format_args = "T4i4t4",
992 "interrupt", "polling",
998 u32 node_name, vector_length, is_polling;
1001 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1002 && v >= nm->polling_threshold_vector_length) &&
1004 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1006 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1007 n->state = VLIB_NODE_STATE_POLLING;
1008 node->state = VLIB_NODE_STATE_POLLING;
1010 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1011 node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1012 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1013 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1016 vlib_get_first_main ()->elog_trace_graph_dispatch))
1018 vlib_worker_thread_t *w = vlib_worker_threads
1021 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1023 ed->node_name = n->name_elog_string;
1024 ed->vector_length = v;
1028 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1029 && v <= nm->interrupt_threshold_vector_length)
1031 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1033 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1035 /* Switch to interrupt mode after dispatch in polling one more time.
1036 This allows driver to re-enable interrupts. */
1037 n->state = VLIB_NODE_STATE_INTERRUPT;
1038 node->state = VLIB_NODE_STATE_INTERRUPT;
1040 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1041 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1042 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
1047 vlib_worker_thread_t *w = vlib_worker_threads
1050 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1052 vlib_get_first_main ()->elog_trace_graph_dispatch))
1054 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1056 ed->node_name = n->name_elog_string;
1057 ed->vector_length = v;
1068 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1069 u64 last_time_stamp)
1071 vlib_node_main_t *nm = &vm->node_main;
1073 vlib_next_frame_t *nf, nf_placeholder;
1074 vlib_node_runtime_t *n;
1075 vlib_frame_t *restore_frame;
1076 vlib_pending_frame_t *p;
1078 /* See comment below about dangling references to nm->pending_frames */
1079 p = nm->pending_frames + pending_frame_index;
1081 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1082 p->node_runtime_index);
1084 f = vlib_get_frame (vm, p->frame);
1085 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1087 /* No next frame: so use placeholder on stack. */
1088 nf = &nf_placeholder;
1089 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1093 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1095 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1097 /* Force allocation of new frame while current frame is being
1099 restore_frame = NULL;
1100 if (nf->frame == p->frame)
1103 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1104 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1105 restore_frame = p->frame;
1108 /* Frame must be pending. */
1109 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1110 ASSERT (f->n_vectors > 0);
1112 /* Copy trace flag from next frame to node.
1113 Trace flag indicates that at least one vector in the dispatched
1115 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1116 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1117 nf->flags &= ~VLIB_FRAME_TRACE;
1119 last_time_stamp = dispatch_node (vm, n,
1120 VLIB_NODE_TYPE_INTERNAL,
1121 VLIB_NODE_STATE_POLLING,
1122 f, last_time_stamp);
1123 /* Internal node vector-rate accounting, for summary stats */
1124 vm->internal_node_vectors += f->n_vectors;
1125 vm->internal_node_calls++;
1126 vm->internal_node_last_vectors_per_main_loop =
1127 (f->n_vectors > vm->internal_node_last_vectors_per_main_loop) ?
1128 f->n_vectors : vm->internal_node_last_vectors_per_main_loop;
1130 f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
1132 /* Frame is ready to be used again, so restore it. */
1133 if (restore_frame != NULL)
1136 * We musn't restore a frame that is flagged to be freed. This
1137 * shouldn't happen since frames to be freed post dispatch are
1138 * those used when the to-node frame becomes full i.e. they form a
1139 * sort of queue of frames to a single node. If we get here then
1140 * the to-node frame and the pending frame *were* the same, and so
1141 * we removed the to-node frame. Therefore this frame is no
1142 * longer part of the queue for that node and hence it cannot be
1145 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1148 * NB: dispatching node n can result in the creation and scheduling
1149 * of new frames, and hence in the reallocation of nm->pending_frames.
1150 * Recompute p, or no supper. This was broken for more than 10 years.
1152 p = nm->pending_frames + pending_frame_index;
1155 * p->next_frame_index can change during node dispatch if node
1156 * function decides to change graph hook up.
1158 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1159 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1161 if (NULL == nf->frame)
1163 /* no new frame has been assigned to this node, use the saved one */
1164 nf->frame = restore_frame;
1170 /* The node has gained a frame, implying packets from the current frame
1171 were re-queued to this same node. we don't need the saved one
1173 vlib_frame_free (vm, f);
1178 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1180 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1181 vlib_frame_free (vm, f);
1185 return last_time_stamp;
1189 vlib_process_stack_is_valid (vlib_process_t * p)
1191 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1197 vlib_process_t *process;
1198 vlib_frame_t *frame;
1199 } vlib_process_bootstrap_args_t;
1201 /* Called in process stack. */
1203 vlib_process_bootstrap (uword _a)
1205 vlib_process_bootstrap_args_t *a;
1207 vlib_node_runtime_t *node;
1212 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1216 vlib_process_finish_switch_stack (vm);
1219 node = &p->node_runtime;
1221 n = node->function (vm, node, f);
1223 ASSERT (vlib_process_stack_is_valid (p));
1225 vlib_process_start_switch_stack (vm, 0);
1226 clib_longjmp (&p->return_longjmp, n);
1231 /* Called in main stack. */
1232 static_always_inline uword
1233 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1235 vlib_process_bootstrap_args_t a;
1242 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1243 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1245 vlib_process_start_switch_stack (vm, p);
1246 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1247 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1250 vlib_process_finish_switch_stack (vm);
1255 static_always_inline uword
1256 vlib_process_resume (vlib_main_t * vm, vlib_process_t * p)
1259 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1260 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1261 | VLIB_PROCESS_RESUME_PENDING);
1262 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1263 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1265 vlib_process_start_switch_stack (vm, p);
1266 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1269 vlib_process_finish_switch_stack (vm);
1274 dispatch_process (vlib_main_t * vm,
1275 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1277 vlib_node_main_t *nm = &vm->node_main;
1278 vlib_node_runtime_t *node_runtime = &p->node_runtime;
1279 vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1280 u32 old_process_index;
1282 uword n_vectors, is_suspend;
1284 if (node->state != VLIB_NODE_STATE_POLLING
1285 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1286 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1287 return last_time_stamp;
1289 p->flags |= VLIB_PROCESS_IS_RUNNING;
1291 t = last_time_stamp;
1292 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1293 f ? f->n_vectors : 0, /* is_after */ 0);
1295 /* Save away current process for suspend. */
1296 old_process_index = nm->current_process_index;
1297 nm->current_process_index = node->runtime_index;
1299 vlib_node_runtime_perf_counter (vm, node_runtime, f, 0, last_time_stamp,
1300 VLIB_NODE_RUNTIME_PERF_BEFORE);
1302 n_vectors = vlib_process_startup (vm, p, f);
1304 nm->current_process_index = old_process_index;
1306 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1307 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1310 vlib_pending_frame_t *pf;
1313 pool_get (nm->suspended_process_frames, pf);
1314 pf->node_runtime_index = node->runtime_index;
1316 pf->next_frame_index = ~0;
1319 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1321 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1323 TWT (tw_timer_wheel) * tw =
1324 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1325 p->stop_timer_handle =
1326 TW (tw_timer_start) (tw,
1327 vlib_timing_wheel_data_set_suspended_process
1328 (node->runtime_index) /* [sic] pool idex */ ,
1330 p->resume_clock_interval);
1334 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1336 t = clib_cpu_time_now ();
1338 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1341 vlib_node_runtime_perf_counter (vm, node_runtime, f, n_vectors, t,
1342 VLIB_NODE_RUNTIME_PERF_AFTER);
1344 vlib_process_update_stats (vm, p,
1345 /* n_calls */ !is_suspend,
1346 /* n_vectors */ n_vectors,
1347 /* n_clocks */ t - last_time_stamp);
1353 vlib_start_process (vlib_main_t * vm, uword process_index)
1355 vlib_node_main_t *nm = &vm->node_main;
1356 vlib_process_t *p = vec_elt (nm->processes, process_index);
1357 dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1361 dispatch_suspended_process (vlib_main_t * vm,
1362 uword process_index, u64 last_time_stamp)
1364 vlib_node_main_t *nm = &vm->node_main;
1365 vlib_node_runtime_t *node_runtime;
1369 vlib_pending_frame_t *pf;
1370 u64 t, n_vectors, is_suspend;
1372 t = last_time_stamp;
1374 p = vec_elt (nm->processes, process_index);
1375 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1376 return last_time_stamp;
1378 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1379 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1381 pf = pool_elt_at_index (nm->suspended_process_frames,
1382 p->suspended_process_frame_index);
1384 node_runtime = &p->node_runtime;
1385 node = vlib_get_node (vm, node_runtime->node_index);
1388 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1389 f ? f->n_vectors : 0, /* is_after */ 0);
1391 /* Save away current process for suspend. */
1392 nm->current_process_index = node->runtime_index;
1394 vlib_node_runtime_perf_counter (vm, node_runtime, f, 0, last_time_stamp,
1395 VLIB_NODE_RUNTIME_PERF_BEFORE);
1397 n_vectors = vlib_process_resume (vm, p);
1398 t = clib_cpu_time_now ();
1400 nm->current_process_index = ~0;
1402 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1405 /* Suspend it again. */
1408 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1410 p->stop_timer_handle =
1411 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1412 vlib_timing_wheel_data_set_suspended_process
1413 (node->runtime_index) /* [sic] pool idex */ ,
1415 p->resume_clock_interval);
1420 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1421 pool_put_index (nm->suspended_process_frames,
1422 p->suspended_process_frame_index);
1423 p->suspended_process_frame_index = ~0;
1426 t = clib_cpu_time_now ();
1427 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1430 vlib_node_runtime_perf_counter (vm, node_runtime, f, n_vectors, t,
1431 VLIB_NODE_RUNTIME_PERF_AFTER);
1433 vlib_process_update_stats (vm, p,
1434 /* n_calls */ !is_suspend,
1435 /* n_vectors */ n_vectors,
1436 /* n_clocks */ t - last_time_stamp);
1441 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1443 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1447 static_always_inline void
1448 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1450 vlib_node_main_t *nm = &vm->node_main;
1451 vlib_thread_main_t *tm = vlib_get_thread_main ();
1455 vlib_frame_queue_main_t *fqm;
1456 u32 frame_queue_check_counter = 0;
1458 /* Initialize pending node vector. */
1461 vec_resize (nm->pending_frames, 32);
1462 vec_set_len (nm->pending_frames, 0);
1465 /* Mark time of main loop start. */
1468 cpu_time_now = vm->clib_time.last_cpu_time;
1469 vm->cpu_time_main_loop_start = cpu_time_now;
1472 cpu_time_now = clib_cpu_time_now ();
1474 /* Pre-allocate interupt runtime indices and lock. */
1475 vec_validate_aligned (nm->pending_interrupts, 0, CLIB_CACHE_LINE_BYTES);
1477 /* Pre-allocate expired nodes. */
1478 if (!nm->polling_threshold_vector_length)
1479 nm->polling_threshold_vector_length = 10;
1480 if (!nm->interrupt_threshold_vector_length)
1481 nm->interrupt_threshold_vector_length = 5;
1483 vm->cpu_id = clib_get_current_cpu_id ();
1484 vm->numa_node = clib_get_current_numa_node ();
1485 os_set_numa_index (vm->numa_node);
1487 /* Start all processes. */
1493 * Perform an initial barrier sync. Pays no attention to
1494 * the barrier sync hold-down timer scheme, which won't work
1495 * at this point in time.
1497 vlib_worker_thread_initial_barrier_sync_and_release (vm);
1499 nm->current_process_index = ~0;
1500 for (i = 0; i < vec_len (nm->processes); i++)
1501 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1507 vlib_node_runtime_t *n;
1509 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1512 vl_api_send_pending_rpc_requests (vm);
1516 vlib_worker_thread_barrier_check ();
1518 if (PREDICT_FALSE (vm->check_frame_queues + frame_queue_check_counter))
1521 vlib_frame_queue_dequeue_fn_t *fn;
1523 if (vm->check_frame_queues)
1525 frame_queue_check_counter = 100;
1526 vm->check_frame_queues = 0;
1529 vec_foreach (fqm, tm->frame_queue_mains)
1531 fn = fqm->frame_queue_dequeue_fn;
1532 processed += (fn) (vm, fqm);
1535 /* No handoff queue work found? */
1537 frame_queue_check_counter = 100;
1539 frame_queue_check_counter--;
1542 if (PREDICT_FALSE (vec_len (vm->worker_thread_main_loop_callbacks)))
1543 clib_call_callbacks (vm->worker_thread_main_loop_callbacks, vm,
1546 /* Process pre-input nodes. */
1547 cpu_time_now = clib_cpu_time_now ();
1548 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1549 cpu_time_now = dispatch_node (vm, n,
1550 VLIB_NODE_TYPE_PRE_INPUT,
1551 VLIB_NODE_STATE_POLLING,
1555 /* Next process input nodes. */
1556 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1557 cpu_time_now = dispatch_node (vm, n,
1558 VLIB_NODE_TYPE_INPUT,
1559 VLIB_NODE_STATE_POLLING,
1563 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1564 vm->queue_signal_callback (vm);
1566 if (__atomic_load_n (nm->pending_interrupts, __ATOMIC_ACQUIRE))
1569 *nm->pending_interrupts = 0;
1572 clib_interrupt_get_next (nm->interrupts, int_num)) != -1)
1574 vlib_node_runtime_t *n;
1575 clib_interrupt_clear (nm->interrupts, int_num);
1576 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1578 cpu_time_now = dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1579 VLIB_NODE_STATE_INTERRUPT,
1580 /* frame */ 0, cpu_time_now);
1584 /* Input nodes may have added work to the pending vector.
1585 Process pending vector until there is nothing left.
1586 All pending vectors will be processed from input -> output. */
1587 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1588 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1589 /* Reset pending vector for next iteration. */
1590 vec_set_len (nm->pending_frames, 0);
1595 ELOG_TYPE_DECLARE (es) =
1597 .format = "process tw start",
1600 ELOG_TYPE_DECLARE (ee) =
1602 .format = "process tw end: %d",
1603 .format_args = "i4",
1612 /* Check if process nodes have expired from timing wheel. */
1613 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1615 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1616 ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1618 nm->data_from_advancing_timing_wheel =
1619 TW (tw_timer_expire_timers_vec)
1620 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1621 nm->data_from_advancing_timing_wheel);
1623 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1625 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1627 ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1629 _vec_len (nm->data_from_advancing_timing_wheel);
1633 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1637 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1640 u32 d = nm->data_from_advancing_timing_wheel[i];
1641 u32 di = vlib_timing_wheel_data_get_index (d);
1643 if (vlib_timing_wheel_data_is_timed_event (d))
1645 vlib_signal_timed_event_data_t *te =
1646 pool_elt_at_index (nm->signal_timed_event_data_pool,
1649 vlib_get_node (vm, te->process_node_index);
1651 vec_elt (nm->processes, n->runtime_index);
1654 vlib_process_signal_event_helper (nm, n, p,
1655 te->event_type_index,
1657 te->n_data_elt_bytes);
1658 if (te->n_data_bytes < sizeof (te->inline_event_data))
1659 clib_memcpy_fast (data, te->inline_event_data,
1663 clib_memcpy_fast (data, te->event_data_as_vector,
1665 vec_free (te->event_data_as_vector);
1667 pool_put (nm->signal_timed_event_data_pool, te);
1671 cpu_time_now = clib_cpu_time_now ();
1673 dispatch_suspended_process (vm, di, cpu_time_now);
1676 vec_set_len (nm->data_from_advancing_timing_wheel, 0);
1679 vlib_increment_main_loop_counter (vm);
1680 /* Record time stamp in case there are no enabled nodes and above
1681 calls do not update time stamp. */
1682 cpu_time_now = clib_cpu_time_now ();
1683 vm->loops_this_reporting_interval++;
1684 now = clib_time_now_internal (&vm->clib_time, cpu_time_now);
1685 /* Time to update loops_per_second? */
1686 if (PREDICT_FALSE (now >= vm->loop_interval_end))
1688 /* Next sample ends in 20ms */
1689 if (vm->loop_interval_start)
1691 f64 this_loops_per_second;
1693 this_loops_per_second =
1694 ((f64) vm->loops_this_reporting_interval) / (now -
1695 vm->loop_interval_start);
1697 vm->loops_per_second =
1698 vm->loops_per_second * vm->damping_constant +
1699 (1.0 - vm->damping_constant) * this_loops_per_second;
1700 if (vm->loops_per_second != 0.0)
1701 vm->seconds_per_loop = 1.0 / vm->loops_per_second;
1703 vm->seconds_per_loop = 0.0;
1705 /* New interval starts now, and ends in 20ms */
1706 vm->loop_interval_start = now;
1707 vm->loop_interval_end = now + 2e-4;
1708 vm->loops_this_reporting_interval = 0;
1714 vlib_main_loop (vlib_main_t * vm)
1716 vlib_main_or_worker_loop (vm, /* is_main */ 1);
1720 vlib_worker_loop (vlib_main_t * vm)
1722 vlib_main_or_worker_loop (vm, /* is_main */ 0);
1725 vlib_global_main_t vlib_global_main;
1728 vlib_add_del_post_mortem_callback (void *cb, int is_add)
1730 vlib_global_main_t *vgm = vlib_get_global_main ();
1735 for (i = vec_len (vgm->post_mortem_callbacks) - 1; i >= 0; i--)
1736 if (vgm->post_mortem_callbacks[i] == cb)
1737 vec_del1 (vgm->post_mortem_callbacks, i);
1741 for (i = 0; i < vec_len (vgm->post_mortem_callbacks); i++)
1742 if (vgm->post_mortem_callbacks[i] == cb)
1744 vec_add1 (vgm->post_mortem_callbacks, cb);
1748 elog_post_mortem_dump (void)
1750 elog_main_t *em = vlib_get_elog_main ();
1753 clib_error_t *error;
1755 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
1756 error = elog_write_file (em, (char *) filename, 1 /* flush ring */);
1758 clib_error_report (error);
1760 * We're in the middle of crashing. Don't try to free the filename.
1764 static clib_error_t *
1765 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1767 vlib_global_main_t *vgm = vlib_get_global_main ();
1768 int turn_on_mem_trace = 0;
1770 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1772 if (unformat (input, "memory-trace"))
1773 turn_on_mem_trace = 1;
1775 else if (unformat (input, "elog-events %d",
1776 &vgm->configured_elog_ring_size))
1777 vgm->configured_elog_ring_size =
1778 1 << max_log2 (vgm->configured_elog_ring_size);
1779 else if (unformat (input, "elog-post-mortem-dump"))
1780 vlib_add_del_post_mortem_callback (elog_post_mortem_dump,
1782 else if (unformat (input, "buffer-alloc-success-rate %f",
1783 &vm->buffer_alloc_success_rate))
1785 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
1786 return clib_error_return
1787 (0, "Buffer fault injection not configured");
1789 else if (unformat (input, "buffer-alloc-success-seed %u",
1790 &vm->buffer_alloc_success_seed))
1792 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
1793 return clib_error_return
1794 (0, "Buffer fault injection not configured");
1797 return unformat_parse_error (input);
1800 unformat_free (input);
1802 /* Enable memory trace as early as possible. */
1803 if (turn_on_mem_trace)
1809 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1812 placeholder_queue_signal_callback (vlib_main_t * vm)
1816 #define foreach_weak_reference_stub \
1818 _(vlibmemory_init) \
1819 _(map_api_segment_init)
1822 clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
1823 clib_error_t *name (vlib_main_t *vm) { return 0; }
1824 foreach_weak_reference_stub;
1827 void vl_api_set_elog_main (elog_main_t * m) __attribute__ ((weak));
1829 vl_api_set_elog_main (elog_main_t * m)
1831 clib_warning ("STUB");
1834 int vl_api_set_elog_trace_api_messages (int enable) __attribute__ ((weak));
1836 vl_api_set_elog_trace_api_messages (int enable)
1838 clib_warning ("STUB");
1842 int vl_api_get_elog_trace_api_messages (void) __attribute__ ((weak));
1844 vl_api_get_elog_trace_api_messages (void)
1846 clib_warning ("STUB");
1850 /* Main function. */
1852 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
1854 vlib_global_main_t *vgm = vlib_get_global_main ();
1855 clib_error_t *volatile error;
1856 vlib_node_main_t *nm = &vm->node_main;
1858 vm->queue_signal_callback = placeholder_queue_signal_callback;
1860 /* Reconfigure event log which is enabled very early */
1861 if (vgm->configured_elog_ring_size &&
1862 vgm->configured_elog_ring_size != vgm->elog_main.event_ring_size)
1863 elog_resize (&vgm->elog_main, vgm->configured_elog_ring_size);
1864 vl_api_set_elog_main (vlib_get_elog_main ());
1865 (void) vl_api_set_elog_trace_api_messages (1);
1871 if ((error = vlib_physmem_init (vm)))
1873 clib_error_report (error);
1877 if ((error = vlib_log_init (vm)))
1879 clib_error_report (error);
1883 if ((error = vlib_stats_init (vm)))
1885 clib_error_report (error);
1889 if ((error = vlib_buffer_main_init (vm)))
1891 clib_error_report (error);
1895 if ((error = vlib_thread_init (vm)))
1897 clib_error_report (error);
1901 /* Register node ifunction variants */
1902 vlib_register_all_node_march_variants (vm);
1904 /* Register static nodes so that init functions may use them. */
1905 vlib_register_all_static_nodes (vm);
1907 /* Set seed for random number generator.
1908 Allow user to specify seed to make random sequence deterministic. */
1909 if (!unformat (input, "seed %wd", &vm->random_seed))
1910 vm->random_seed = clib_cpu_time_now ();
1911 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
1913 /* Initialize node graph. */
1914 if ((error = vlib_node_main_init (vm)))
1916 /* Arrange for graph hook up error to not be fatal when debugging. */
1918 clib_error_report (error);
1923 /* Direct call / weak reference, for vlib standalone use-cases */
1924 if ((error = vpe_api_init (vm)))
1926 clib_error_report (error);
1930 if ((error = vlibmemory_init (vm)))
1932 clib_error_report (error);
1936 if ((error = map_api_segment_init (vm)))
1938 clib_error_report (error);
1942 /* See unix/main.c; most likely already set up */
1943 if (vgm->init_functions_called == 0)
1944 vgm->init_functions_called = hash_create (0, /* value bytes */ 0);
1945 if ((error = vlib_call_all_init_functions (vm)))
1948 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
1949 CLIB_CACHE_LINE_BYTES);
1951 vec_validate (nm->data_from_advancing_timing_wheel, 10);
1952 vec_set_len (nm->data_from_advancing_timing_wheel, 0);
1954 /* Create the process timing wheel */
1955 TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1956 0 /* no callback */ ,
1957 10e-6 /* timer period 10us */ ,
1958 ~0 /* max expirations per call */ );
1960 vec_validate (vm->pending_rpc_requests, 0);
1961 vec_set_len (vm->pending_rpc_requests, 0);
1962 vec_validate (vm->processing_rpc_requests, 0);
1963 vec_set_len (vm->processing_rpc_requests, 0);
1965 /* Default params for the buffer allocator fault injector, if configured */
1966 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0)
1968 vm->buffer_alloc_success_seed = 0xdeaddabe;
1969 vm->buffer_alloc_success_rate = 0.80;
1972 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
1976 * Use exponential smoothing, with a half-life of 1 second
1977 * reported_rate(t) = reported_rate(t-1) * K + rate(t)*(1-K)
1979 * Sample every 20ms, aka 50 samples per second
1980 * K = exp (-1.0/20.0);
1983 vm->damping_constant = exp (-1.0 / 20.0);
1985 /* Sort per-thread init functions before we start threads */
1986 vlib_sort_init_exit_functions (&vgm->worker_init_function_registrations);
1988 /* Call all main loop enter functions. */
1990 clib_error_t *sub_error;
1991 sub_error = vlib_call_all_main_loop_enter_functions (vm);
1993 clib_error_report (sub_error);
1996 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
1998 case VLIB_MAIN_LOOP_EXIT_NONE:
1999 vm->main_loop_exit_set = 1;
2002 case VLIB_MAIN_LOOP_EXIT_CLI:
2006 error = vm->main_loop_error;
2010 vlib_main_loop (vm);
2013 /* Stop worker threads, barrier will not be released */
2014 vlib_worker_thread_barrier_sync (vm);
2016 /* Call all exit functions. */
2018 clib_error_t *sub_error;
2019 sub_error = vlib_call_all_main_loop_exit_functions (vm);
2021 clib_error_report (sub_error);
2025 clib_error_report (error);
2027 return vm->main_loop_exit_status;
2031 vlib_get_main_not_inline (void)
2033 return vlib_get_main ();
2037 vlib_get_elog_main_not_inline ()
2039 return &vlib_global_main.elog_main;
2043 vlib_exit_with_status (vlib_main_t *vm, int status)
2045 vm->main_loop_exit_status = status;
2046 __atomic_store_n (&vm->main_loop_exit_now, 1, __ATOMIC_RELEASE);
2050 * fd.io coding-style-patch-verification: ON
2053 * eval: (c-set-style "gnu")