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 <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
46 #include <vlib/unix/unix.h>
48 #define VLIB_FRAME_MAGIC (0xabadc0ed)
51 vlib_frame_find_magic (vlib_frame_t * f, vlib_node_t * node)
53 return (void *) f + node->magic_offset;
57 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
60 vlib_node_main_t *nm = &vm->node_main;
61 vlib_frame_size_t *fs;
66 ASSERT (vm == vlib_get_main ());
68 to_node = vlib_get_node (vm, to_node_index);
70 vec_validate (nm->frame_sizes, to_node->frame_size_index);
71 fs = vec_elt_at_index (nm->frame_sizes, to_node->frame_size_index);
73 if (fs->frame_size == 0)
74 fs->frame_size = to_node->frame_size;
76 ASSERT (fs->frame_size == to_node->frame_size);
79 if ((l = vec_len (fs->free_frames)) > 0)
81 /* Allocate from end of free list. */
82 f = fs->free_frames[l - 1];
83 _vec_len (fs->free_frames) = l - 1;
87 f = clib_mem_alloc_aligned_no_fail (n, CLIB_CACHE_LINE_BYTES);
90 /* Poison frame when debugging. */
92 clib_memset_u8 (f, 0xfe, n);
94 /* Insert magic number. */
98 magic = vlib_frame_find_magic (f, to_node);
99 *magic = VLIB_FRAME_MAGIC;
102 f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
104 f->scalar_offset = to_node->scalar_offset;
105 f->vector_offset = to_node->vector_offset;
106 f->aux_offset = to_node->aux_offset;
109 fs->n_alloc_frames += 1;
114 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
115 Returns frame index. */
116 static vlib_frame_t *
117 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
120 vlib_node_t *from_node;
122 from_node = vlib_get_node (vm, from_node_runtime->node_index);
123 ASSERT (to_next_index < vec_len (from_node->next_nodes));
125 return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
126 /* frame_flags */ 0);
130 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
132 vlib_frame_t *f = vlib_frame_alloc_to_node (vm, to_node_index,
134 VLIB_FRAME_FREE_AFTER_DISPATCH);
135 return vlib_get_frame (vm, f);
139 vlib_validate_frame_indices (vlib_frame_t * f)
144 u32 *from = vlib_frame_vector_args (f);
146 /* Check for bad buffer index values */
147 for (i = 0; i < f->n_vectors; i++)
151 clib_warning ("BUG: buffer index 0 at index %d", i);
154 else if (from[i] == 0xfefefefe)
156 clib_warning ("BUG: frame poison pattern at index %d", i);
164 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
166 vlib_pending_frame_t *p;
167 vlib_node_t *to_node;
169 if (f->n_vectors == 0)
172 ASSERT (vm == vlib_get_main ());
174 vlib_validate_frame_indices (f);
176 to_node = vlib_get_node (vm, to_node_index);
178 vec_add2 (vm->node_main.pending_frames, p, 1);
180 f->frame_flags |= VLIB_FRAME_PENDING;
181 p->frame = vlib_get_frame (vm, f);
182 p->node_runtime_index = to_node->runtime_index;
183 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
186 /* Free given frame. */
188 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
190 vlib_node_main_t *nm = &vm->node_main;
192 vlib_frame_size_t *fs;
194 ASSERT (vm == vlib_get_main ());
195 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
197 node = vlib_get_node (vm, r->node_index);
198 fs = vec_elt_at_index (nm->frame_sizes, node->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);
211 vec_add1 (fs->free_frames, f);
212 ASSERT (fs->n_alloc_frames > 0);
213 fs->n_alloc_frames -= 1;
216 static clib_error_t *
217 show_frame_stats (vlib_main_t * vm,
218 unformat_input_t * input, vlib_cli_command_t * cmd)
220 vlib_frame_size_t *fs;
222 vlib_cli_output (vm, "%=8s%=6s%=12s%=12s", "Thread", "Size", "# Alloc",
226 vlib_node_main_t *nm = &this_vlib_main->node_main;
227 vec_foreach (fs, nm->frame_sizes)
229 u32 n_alloc = fs->n_alloc_frames;
230 u32 n_free = vec_len (fs->free_frames);
232 if (n_alloc + n_free > 0)
233 vlib_cli_output (vm, "%=8d%=6d%=12d%=12d",
234 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,
250 /* Change ownership of enqueue rights to given next node. */
252 vlib_next_frame_change_ownership (vlib_main_t * vm,
253 vlib_node_runtime_t * node_runtime,
256 vlib_node_main_t *nm = &vm->node_main;
257 vlib_next_frame_t *next_frame;
258 vlib_node_t *node, *next_node;
260 node = vec_elt (nm->nodes, node_runtime->node_index);
262 /* Only internal & input nodes are allowed to call other nodes. */
263 ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
264 || node->type == VLIB_NODE_TYPE_INPUT
265 || node->type == VLIB_NODE_TYPE_PROCESS);
267 ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
270 vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
271 next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
273 if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
275 /* Get frame from previous owner. */
276 vlib_next_frame_t *owner_next_frame;
277 vlib_next_frame_t tmp;
280 vlib_node_get_next_frame (vm,
281 next_node->owner_node_index,
282 next_node->owner_next_index);
284 /* Swap target next frame with owner's. */
285 tmp = owner_next_frame[0];
286 owner_next_frame[0] = next_frame[0];
290 * If next_frame is already pending, we have to track down
291 * all pending frames and fix their next_frame_index fields.
293 if (next_frame->flags & VLIB_FRAME_PENDING)
295 vlib_pending_frame_t *p;
296 if (next_frame->frame != NULL)
298 vec_foreach (p, nm->pending_frames)
300 if (p->frame == next_frame->frame)
302 p->next_frame_index =
303 next_frame - vm->node_main.next_frames;
311 /* No previous owner. Take ownership. */
312 next_frame->flags |= VLIB_FRAME_OWNER;
315 /* Record new owner. */
316 next_node->owner_node_index = node->index;
317 next_node->owner_next_index = next_index;
319 /* Now we should be owner. */
320 ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
323 /* Make sure that magic number is still there.
324 Otherwise, it is likely that caller has overrun frame arguments. */
326 validate_frame_magic (vlib_main_t * vm,
327 vlib_frame_t * f, vlib_node_t * n, uword next_index)
329 vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
330 u32 *magic = vlib_frame_find_magic (f, next_node);
331 ASSERT (VLIB_FRAME_MAGIC == magic[0]);
335 vlib_get_next_frame_internal (vlib_main_t * vm,
336 vlib_node_runtime_t * node,
337 u32 next_index, u32 allocate_new_next_frame)
340 vlib_next_frame_t *nf;
343 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
345 /* Make sure this next frame owns right to enqueue to destination frame. */
346 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
347 vlib_next_frame_change_ownership (vm, node, next_index);
349 /* ??? Don't need valid flag: can use frame_index == ~0 */
350 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
352 nf->frame = vlib_frame_alloc (vm, node, next_index);
353 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
358 /* Has frame been removed from pending vector (e.g. finished dispatching)?
359 If so we can reuse frame. */
360 if ((nf->flags & VLIB_FRAME_PENDING)
361 && !(f->frame_flags & VLIB_FRAME_PENDING))
363 nf->flags &= ~VLIB_FRAME_PENDING;
368 /* Allocate new frame if current one is marked as no-append or
369 it is already full. */
370 n_used = f->n_vectors;
371 if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0) ||
372 (f->frame_flags & VLIB_FRAME_NO_APPEND))
374 /* Old frame may need to be freed after dispatch, since we'll have
375 two redundant frames from node -> next node. */
376 if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
378 vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame);
379 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
382 /* Allocate new frame to replace full one. */
383 f = nf->frame = vlib_frame_alloc (vm, node, next_index);
384 n_used = f->n_vectors;
387 /* Should have free vectors in frame now. */
388 ASSERT (n_used < VLIB_FRAME_SIZE);
392 validate_frame_magic (vm, f,
393 vlib_get_node (vm, node->node_index), next_index);
400 vlib_put_next_frame_validate (vlib_main_t * vm,
401 vlib_node_runtime_t * rt,
402 u32 next_index, u32 n_vectors_left)
404 vlib_node_main_t *nm = &vm->node_main;
405 vlib_next_frame_t *nf;
407 vlib_node_runtime_t *next_rt;
408 vlib_node_t *next_node;
409 u32 n_before, n_after;
411 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
412 f = vlib_get_frame (vm, nf->frame);
414 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
416 vlib_validate_frame_indices (f);
418 n_after = VLIB_FRAME_SIZE - n_vectors_left;
419 n_before = f->n_vectors;
421 ASSERT (n_after >= n_before);
423 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
424 nf->node_runtime_index);
425 next_node = vlib_get_node (vm, next_rt->node_index);
426 if (n_after > 0 && next_node->validate_frame)
428 u8 *msg = next_node->validate_frame (vm, rt, f);
431 clib_warning ("%v", msg);
439 vlib_put_next_frame (vlib_main_t * vm,
440 vlib_node_runtime_t * r,
441 u32 next_index, u32 n_vectors_left)
443 vlib_node_main_t *nm = &vm->node_main;
444 vlib_next_frame_t *nf;
446 u32 n_vectors_in_frame;
449 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
451 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
452 f = vlib_get_frame (vm, nf->frame);
454 /* Make sure that magic number is still there. Otherwise, caller
455 has overrun frame meta data. */
458 vlib_node_t *node = vlib_get_node (vm, r->node_index);
459 validate_frame_magic (vm, f, node, next_index);
462 /* Convert # of vectors left -> number of vectors there. */
463 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
464 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
466 f->n_vectors = n_vectors_in_frame;
468 /* If vectors were added to frame, add to pending vector. */
469 if (PREDICT_TRUE (n_vectors_in_frame > 0))
471 vlib_pending_frame_t *p;
474 r->cached_next_index = next_index;
476 if (!(f->frame_flags & VLIB_FRAME_PENDING))
478 __attribute__ ((unused)) vlib_node_t *node;
479 vlib_node_t *next_node;
480 vlib_node_runtime_t *next_runtime;
482 node = vlib_get_node (vm, r->node_index);
483 next_node = vlib_get_next_node (vm, r->node_index, next_index);
484 next_runtime = vlib_node_get_runtime (vm, next_node->index);
486 vec_add2 (nm->pending_frames, p, 1);
488 p->frame = nf->frame;
489 p->node_runtime_index = nf->node_runtime_index;
490 p->next_frame_index = nf - nm->next_frames;
491 nf->flags |= VLIB_FRAME_PENDING;
492 f->frame_flags |= VLIB_FRAME_PENDING;
495 * If we're going to dispatch this frame on another thread,
496 * force allocation of a new frame. Otherwise, we create
497 * a dangling frame reference. Each thread has its own copy of
498 * the next_frames vector.
500 if (0 && r->thread_index != next_runtime->thread_index)
503 nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
507 /* Copy trace flag from next_frame and from runtime. */
509 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
510 flags & VLIB_NODE_FLAG_TRACE);
512 v0 = nf->vectors_since_last_overflow;
513 v1 = v0 + n_vectors_in_frame;
514 nf->vectors_since_last_overflow = v1;
515 if (PREDICT_FALSE (v1 < v0))
517 vlib_node_t *node = vlib_get_node (vm, r->node_index);
518 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
523 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
525 vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
526 uword n_calls, uword n_vectors,
529 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
530 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
531 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
532 n->stats_total.max_clock = r->max_clock;
533 n->stats_total.max_clock_n = r->max_clock_n;
535 r->calls_since_last_overflow = 0;
536 r->vectors_since_last_overflow = 0;
537 r->clocks_since_last_overflow = 0;
541 vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
542 uword n_calls, uword n_vectors, uword n_clocks)
544 vlib_node_t *n = vlib_get_node (vm, r->node_index);
545 vlib_node_runtime_sync_stats_node (n, r, n_calls, n_vectors, n_clocks);
548 always_inline void __attribute__ ((unused))
549 vlib_process_sync_stats (vlib_main_t * vm,
551 uword n_calls, uword n_vectors, uword n_clocks)
553 vlib_node_runtime_t *rt = &p->node_runtime;
554 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
555 vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks);
556 n->stats_total.suspends += p->n_suspends;
561 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
563 vlib_node_runtime_t *rt;
565 if (n->type == VLIB_NODE_TYPE_PROCESS)
567 /* Nothing to do for PROCESS nodes except in main thread */
568 if (vm != vlib_get_first_main ())
571 vlib_process_t *p = vlib_get_process_from_node (vm, n);
572 n->stats_total.suspends += p->n_suspends;
574 rt = &p->node_runtime;
578 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
581 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0);
583 /* Sync up runtime next frame vector counters with main node structure. */
585 vlib_next_frame_t *nf;
587 for (i = 0; i < rt->n_next_nodes; i++)
589 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
590 vec_elt (n->n_vectors_by_next_node, i) +=
591 nf->vectors_since_last_overflow;
592 nf->vectors_since_last_overflow = 0;
598 vlib_node_runtime_update_stats (vlib_main_t * vm,
599 vlib_node_runtime_t * node,
601 uword n_vectors, uword n_clocks)
603 u32 ca0, ca1, v0, v1, cl0, cl1, r;
605 cl0 = cl1 = node->clocks_since_last_overflow;
606 ca0 = ca1 = node->calls_since_last_overflow;
607 v0 = v1 = node->vectors_since_last_overflow;
611 cl1 = cl0 + n_clocks;
613 node->calls_since_last_overflow = ca1;
614 node->clocks_since_last_overflow = cl1;
615 node->vectors_since_last_overflow = v1;
617 node->max_clock_n = node->max_clock > n_clocks ?
618 node->max_clock_n : n_vectors;
619 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
621 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
623 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0))
625 node->calls_since_last_overflow = ca0;
626 node->clocks_since_last_overflow = cl0;
627 node->vectors_since_last_overflow = v0;
629 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks);
636 vlib_process_update_stats (vlib_main_t * vm,
638 uword n_calls, uword n_vectors, uword n_clocks)
640 vlib_node_runtime_update_stats (vm, &p->node_runtime,
641 n_calls, n_vectors, n_clocks);
644 static clib_error_t *
645 vlib_cli_elog_clear (vlib_main_t * vm,
646 unformat_input_t * input, vlib_cli_command_t * cmd)
648 elog_reset_buffer (&vlib_global_main.elog_main);
653 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
654 .path = "event-logger clear",
655 .short_help = "Clear the event log",
656 .function = vlib_cli_elog_clear,
661 static clib_error_t *
662 elog_save_buffer (vlib_main_t * vm,
663 unformat_input_t * input, vlib_cli_command_t * cmd)
665 elog_main_t *em = &vlib_global_main.elog_main;
666 char *file, *chroot_file;
667 clib_error_t *error = 0;
669 if (!unformat (input, "%s", &file))
671 vlib_cli_output (vm, "expected file name, got `%U'",
672 format_unformat_error, input);
676 /* It's fairly hard to get "../oopsie" through unformat; just in case */
677 if (strstr (file, "..") || index (file, '/'))
679 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
683 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
687 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
688 elog_n_events_in_buffer (em),
689 elog_buffer_capacity (em), chroot_file);
691 vlib_worker_thread_barrier_sync (vm);
692 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
693 vlib_worker_thread_barrier_release (vm);
694 vec_free (chroot_file);
699 vlib_post_mortem_dump (void)
701 vlib_global_main_t *vgm = vlib_get_global_main ();
703 for (int i = 0; i < vec_len (vgm->post_mortem_callbacks); i++)
704 (vgm->post_mortem_callbacks[i]) ();
708 VLIB_CLI_COMMAND (elog_save_cli, static) = {
709 .path = "event-logger save",
710 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
711 .function = elog_save_buffer,
715 static clib_error_t *
716 elog_stop (vlib_main_t * vm,
717 unformat_input_t * input, vlib_cli_command_t * cmd)
719 elog_main_t *em = &vlib_global_main.elog_main;
721 em->n_total_events_disable_limit = em->n_total_events;
723 vlib_cli_output (vm, "Stopped the event logger...");
728 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
729 .path = "event-logger stop",
730 .short_help = "Stop the event-logger",
731 .function = elog_stop,
735 static clib_error_t *
736 elog_restart (vlib_main_t * vm,
737 unformat_input_t * input, vlib_cli_command_t * cmd)
739 elog_main_t *em = &vlib_global_main.elog_main;
741 em->n_total_events_disable_limit = ~0;
743 vlib_cli_output (vm, "Restarted the event logger...");
748 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
749 .path = "event-logger restart",
750 .short_help = "Restart the event-logger",
751 .function = elog_restart,
755 static clib_error_t *
756 elog_resize_command_fn (vlib_main_t * vm,
757 unformat_input_t * input, vlib_cli_command_t * cmd)
759 elog_main_t *em = &vlib_global_main.elog_main;
762 /* Stop the parade */
763 elog_reset_buffer (em);
765 if (unformat (input, "%d", &tmp))
767 elog_alloc (em, tmp);
768 em->n_total_events_disable_limit = ~0;
771 return clib_error_return (0, "Must specify how many events in the ring");
773 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
778 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
779 .path = "event-logger resize",
780 .short_help = "event-logger resize <nnn>",
781 .function = elog_resize_command_fn,
785 #endif /* CLIB_UNIX */
788 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
790 elog_main_t *em = &vlib_global_main.elog_main;
791 elog_event_t *e, *es;
794 /* Show events in VLIB time since log clock starts after VLIB clock. */
795 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
796 * vm->clib_time.seconds_per_clock;
798 es = elog_peek_events (em);
799 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
801 em->n_total_events < em->n_total_events_disable_limit ?
802 "running" : "stopped");
805 vlib_cli_output (vm, "%18.9f: %U",
806 e->time + dt, format_elog_event, em, e);
808 if (n_events_to_show == 0)
815 static clib_error_t *
816 elog_show_buffer (vlib_main_t * vm,
817 unformat_input_t * input, vlib_cli_command_t * cmd)
819 u32 n_events_to_show;
820 clib_error_t *error = 0;
822 n_events_to_show = 250;
823 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
825 if (unformat (input, "%d", &n_events_to_show))
827 else if (unformat (input, "all"))
828 n_events_to_show = ~0;
830 return unformat_parse_error (input);
832 elog_show_buffer_internal (vm, n_events_to_show);
837 VLIB_CLI_COMMAND (elog_show_cli, static) = {
838 .path = "show event-logger",
839 .short_help = "Show event logger info",
840 .function = elog_show_buffer,
845 vlib_gdb_show_event_log (void)
847 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
851 vlib_elog_main_loop_event (vlib_main_t * vm,
853 u64 time, u32 n_vectors, u32 is_return)
855 vlib_main_t *evm = vlib_get_first_main ();
856 elog_main_t *em = vlib_get_elog_main ();
857 int enabled = evm->elog_trace_graph_dispatch |
858 evm->elog_trace_graph_circuit;
860 if (PREDICT_FALSE (enabled && n_vectors))
862 if (PREDICT_FALSE (!elog_is_enabled (em)))
864 evm->elog_trace_graph_dispatch = 0;
865 evm->elog_trace_graph_circuit = 0;
869 (evm->elog_trace_graph_dispatch ||
870 (evm->elog_trace_graph_circuit &&
871 node_index == evm->elog_trace_graph_circuit_node_index)))
875 vec_elt_at_index (is_return
876 ? evm->node_return_elog_event_types
877 : evm->node_call_elog_event_types,
881 &vlib_worker_threads[vm->thread_index].elog_track
882 : &em->default_track),
883 /* data to log */ n_vectors);
889 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
891 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
892 if (PREDICT_FALSE (b->trajectory_nb >= VLIB_BUFFER_TRACE_TRAJECTORY_MAX))
894 b->trajectory_trace[b->trajectory_nb] = node_index;
899 static_always_inline u64
900 dispatch_node (vlib_main_t * vm,
901 vlib_node_runtime_t * node,
902 vlib_node_type_t type,
903 vlib_node_state_t dispatch_state,
904 vlib_frame_t * frame, u64 last_time_stamp)
908 vlib_node_main_t *nm = &vm->node_main;
909 vlib_next_frame_t *nf;
913 vlib_node_t *n = vlib_get_node (vm, node->node_index);
914 ASSERT (n->type == type);
917 /* Only non-internal nodes may be disabled. */
918 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
920 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
921 return last_time_stamp;
924 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
925 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
927 u32 c = node->input_main_loops_per_call;
928 /* Only call node when count reaches zero. */
931 node->input_main_loops_per_call = c - 1;
932 return last_time_stamp;
936 /* Speculatively prefetch next frames. */
937 if (node->n_next_nodes > 0)
939 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
940 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
943 vm->cpu_time_last_node_dispatch = last_time_stamp;
945 vlib_elog_main_loop_event (vm, node->node_index,
946 last_time_stamp, frame ? frame->n_vectors : 0,
949 vlib_node_runtime_perf_counter (vm, node, frame, 0, last_time_stamp,
950 VLIB_NODE_RUNTIME_PERF_BEFORE);
953 * Turn this on if you run into
954 * "bad monkey" contexts, and you want to know exactly
955 * which nodes they've visited... See ixge.c...
957 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
961 from = vlib_frame_vector_args (frame);
962 for (i = 0; i < frame->n_vectors; i++)
964 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
965 add_trajectory_trace (b, node->node_index);
967 if (PREDICT_TRUE (vm->dispatch_wrapper_fn == 0))
968 n = node->function (vm, node, frame);
970 n = vm->dispatch_wrapper_fn (vm, node, frame);
974 if (PREDICT_TRUE (vm->dispatch_wrapper_fn == 0))
975 n = node->function (vm, node, frame);
977 n = vm->dispatch_wrapper_fn (vm, node, frame);
980 t = clib_cpu_time_now ();
982 vlib_node_runtime_perf_counter (vm, node, frame, n, t,
983 VLIB_NODE_RUNTIME_PERF_AFTER);
985 vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
987 vm->main_loop_vectors_processed += n;
988 vm->main_loop_nodes_processed += n > 0;
990 v = vlib_node_runtime_update_stats (vm, node,
993 /* n_clocks */ t - last_time_stamp);
995 /* When in adaptive mode and vector rate crosses threshold switch to
996 polling mode and vice versa. */
997 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_ADAPTIVE_MODE))
1000 ELOG_TYPE_DECLARE (e) =
1002 .function = (char *) __FUNCTION__,
1003 .format = "%s vector length %d, switching to %s",
1004 .format_args = "T4i4t4",
1005 .n_enum_strings = 2,
1007 "interrupt", "polling",
1013 u32 node_name, vector_length, is_polling;
1016 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1017 && v >= nm->polling_threshold_vector_length) &&
1019 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1021 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1022 n->state = VLIB_NODE_STATE_POLLING;
1023 node->state = VLIB_NODE_STATE_POLLING;
1025 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1026 node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1027 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1028 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1031 vlib_get_first_main ()->elog_trace_graph_dispatch))
1033 vlib_worker_thread_t *w = vlib_worker_threads
1036 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1038 ed->node_name = n->name_elog_string;
1039 ed->vector_length = v;
1043 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1044 && v <= nm->interrupt_threshold_vector_length)
1046 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1048 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1050 /* Switch to interrupt mode after dispatch in polling one more time.
1051 This allows driver to re-enable interrupts. */
1052 n->state = VLIB_NODE_STATE_INTERRUPT;
1053 node->state = VLIB_NODE_STATE_INTERRUPT;
1055 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1056 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1057 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
1062 vlib_worker_thread_t *w = vlib_worker_threads
1065 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1067 vlib_get_first_main ()->elog_trace_graph_dispatch))
1069 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1071 ed->node_name = n->name_elog_string;
1072 ed->vector_length = v;
1083 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1084 u64 last_time_stamp)
1086 vlib_node_main_t *nm = &vm->node_main;
1088 vlib_next_frame_t *nf, nf_placeholder;
1089 vlib_node_runtime_t *n;
1090 vlib_frame_t *restore_frame;
1091 vlib_pending_frame_t *p;
1093 /* See comment below about dangling references to nm->pending_frames */
1094 p = nm->pending_frames + pending_frame_index;
1096 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1097 p->node_runtime_index);
1099 f = vlib_get_frame (vm, p->frame);
1100 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1102 /* No next frame: so use placeholder on stack. */
1103 nf = &nf_placeholder;
1104 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1108 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1110 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1112 /* Force allocation of new frame while current frame is being
1114 restore_frame = NULL;
1115 if (nf->frame == p->frame)
1118 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1119 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1120 restore_frame = p->frame;
1123 /* Frame must be pending. */
1124 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1125 ASSERT (f->n_vectors > 0);
1127 /* Copy trace flag from next frame to node.
1128 Trace flag indicates that at least one vector in the dispatched
1130 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1131 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1132 nf->flags &= ~VLIB_FRAME_TRACE;
1134 last_time_stamp = dispatch_node (vm, n,
1135 VLIB_NODE_TYPE_INTERNAL,
1136 VLIB_NODE_STATE_POLLING,
1137 f, last_time_stamp);
1138 /* Internal node vector-rate accounting, for summary stats */
1139 vm->internal_node_vectors += f->n_vectors;
1140 vm->internal_node_calls++;
1141 vm->internal_node_last_vectors_per_main_loop =
1142 (f->n_vectors > vm->internal_node_last_vectors_per_main_loop) ?
1143 f->n_vectors : vm->internal_node_last_vectors_per_main_loop;
1145 f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
1147 /* Frame is ready to be used again, so restore it. */
1148 if (restore_frame != NULL)
1151 * We musn't restore a frame that is flagged to be freed. This
1152 * shouldn't happen since frames to be freed post dispatch are
1153 * those used when the to-node frame becomes full i.e. they form a
1154 * sort of queue of frames to a single node. If we get here then
1155 * the to-node frame and the pending frame *were* the same, and so
1156 * we removed the to-node frame. Therefore this frame is no
1157 * longer part of the queue for that node and hence it cannot be
1160 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1163 * NB: dispatching node n can result in the creation and scheduling
1164 * of new frames, and hence in the reallocation of nm->pending_frames.
1165 * Recompute p, or no supper. This was broken for more than 10 years.
1167 p = nm->pending_frames + pending_frame_index;
1170 * p->next_frame_index can change during node dispatch if node
1171 * function decides to change graph hook up.
1173 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1174 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1176 if (NULL == nf->frame)
1178 /* no new frame has been assigned to this node, use the saved one */
1179 nf->frame = restore_frame;
1184 /* The node has gained a frame, implying packets from the current frame
1185 were re-queued to this same node. we don't need the saved one
1187 vlib_frame_free (vm, n, f);
1192 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1194 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1195 vlib_frame_free (vm, n, f);
1199 return last_time_stamp;
1203 vlib_process_stack_is_valid (vlib_process_t * p)
1205 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1211 vlib_process_t *process;
1212 vlib_frame_t *frame;
1213 } vlib_process_bootstrap_args_t;
1215 /* Called in process stack. */
1217 vlib_process_bootstrap (uword _a)
1219 vlib_process_bootstrap_args_t *a;
1221 vlib_node_runtime_t *node;
1226 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1230 vlib_process_finish_switch_stack (vm);
1233 node = &p->node_runtime;
1235 n = node->function (vm, node, f);
1237 ASSERT (vlib_process_stack_is_valid (p));
1239 vlib_process_start_switch_stack (vm, 0);
1240 clib_longjmp (&p->return_longjmp, n);
1245 /* Called in main stack. */
1246 static_always_inline uword
1247 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1249 vlib_process_bootstrap_args_t a;
1256 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1257 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1259 vlib_process_start_switch_stack (vm, p);
1260 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1261 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1264 vlib_process_finish_switch_stack (vm);
1269 static_always_inline uword
1270 vlib_process_resume (vlib_main_t * vm, vlib_process_t * p)
1273 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1274 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1275 | VLIB_PROCESS_RESUME_PENDING);
1276 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1277 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1279 vlib_process_start_switch_stack (vm, p);
1280 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1283 vlib_process_finish_switch_stack (vm);
1288 dispatch_process (vlib_main_t * vm,
1289 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1291 vlib_node_main_t *nm = &vm->node_main;
1292 vlib_node_runtime_t *node_runtime = &p->node_runtime;
1293 vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1294 u32 old_process_index;
1296 uword n_vectors, is_suspend;
1298 if (node->state != VLIB_NODE_STATE_POLLING
1299 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1300 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1301 return last_time_stamp;
1303 p->flags |= VLIB_PROCESS_IS_RUNNING;
1305 t = last_time_stamp;
1306 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1307 f ? f->n_vectors : 0, /* is_after */ 0);
1309 /* Save away current process for suspend. */
1310 old_process_index = nm->current_process_index;
1311 nm->current_process_index = node->runtime_index;
1313 vlib_node_runtime_perf_counter (vm, node_runtime, f, 0, last_time_stamp,
1314 VLIB_NODE_RUNTIME_PERF_BEFORE);
1316 n_vectors = vlib_process_startup (vm, p, f);
1318 nm->current_process_index = old_process_index;
1320 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1321 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1324 vlib_pending_frame_t *pf;
1327 pool_get (nm->suspended_process_frames, pf);
1328 pf->node_runtime_index = node->runtime_index;
1330 pf->next_frame_index = ~0;
1333 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1335 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1337 TWT (tw_timer_wheel) * tw =
1338 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1339 p->stop_timer_handle =
1340 TW (tw_timer_start) (tw,
1341 vlib_timing_wheel_data_set_suspended_process
1342 (node->runtime_index) /* [sic] pool idex */ ,
1344 p->resume_clock_interval);
1348 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1350 t = clib_cpu_time_now ();
1352 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1355 vlib_node_runtime_perf_counter (vm, node_runtime, f, n_vectors, t,
1356 VLIB_NODE_RUNTIME_PERF_AFTER);
1358 vlib_process_update_stats (vm, p,
1359 /* n_calls */ !is_suspend,
1360 /* n_vectors */ n_vectors,
1361 /* n_clocks */ t - last_time_stamp);
1367 vlib_start_process (vlib_main_t * vm, uword process_index)
1369 vlib_node_main_t *nm = &vm->node_main;
1370 vlib_process_t *p = vec_elt (nm->processes, process_index);
1371 dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1375 dispatch_suspended_process (vlib_main_t * vm,
1376 uword process_index, u64 last_time_stamp)
1378 vlib_node_main_t *nm = &vm->node_main;
1379 vlib_node_runtime_t *node_runtime;
1383 vlib_pending_frame_t *pf;
1384 u64 t, n_vectors, is_suspend;
1386 t = last_time_stamp;
1388 p = vec_elt (nm->processes, process_index);
1389 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1390 return last_time_stamp;
1392 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1393 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1395 pf = pool_elt_at_index (nm->suspended_process_frames,
1396 p->suspended_process_frame_index);
1398 node_runtime = &p->node_runtime;
1399 node = vlib_get_node (vm, node_runtime->node_index);
1402 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1403 f ? f->n_vectors : 0, /* is_after */ 0);
1405 /* Save away current process for suspend. */
1406 nm->current_process_index = node->runtime_index;
1408 vlib_node_runtime_perf_counter (vm, node_runtime, f, 0, last_time_stamp,
1409 VLIB_NODE_RUNTIME_PERF_BEFORE);
1411 n_vectors = vlib_process_resume (vm, p);
1412 t = clib_cpu_time_now ();
1414 nm->current_process_index = ~0;
1416 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1419 /* Suspend it again. */
1422 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1424 p->stop_timer_handle =
1425 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1426 vlib_timing_wheel_data_set_suspended_process
1427 (node->runtime_index) /* [sic] pool idex */ ,
1429 p->resume_clock_interval);
1434 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1435 pool_put_index (nm->suspended_process_frames,
1436 p->suspended_process_frame_index);
1437 p->suspended_process_frame_index = ~0;
1440 t = clib_cpu_time_now ();
1441 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1444 vlib_node_runtime_perf_counter (vm, node_runtime, f, n_vectors, t,
1445 VLIB_NODE_RUNTIME_PERF_AFTER);
1447 vlib_process_update_stats (vm, p,
1448 /* n_calls */ !is_suspend,
1449 /* n_vectors */ n_vectors,
1450 /* n_clocks */ t - last_time_stamp);
1455 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1457 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1461 static_always_inline void
1462 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1464 vlib_node_main_t *nm = &vm->node_main;
1465 vlib_thread_main_t *tm = vlib_get_thread_main ();
1469 vlib_frame_queue_main_t *fqm;
1470 u32 frame_queue_check_counter = 0;
1472 /* Initialize pending node vector. */
1475 vec_resize (nm->pending_frames, 32);
1476 _vec_len (nm->pending_frames) = 0;
1479 /* Mark time of main loop start. */
1482 cpu_time_now = vm->clib_time.last_cpu_time;
1483 vm->cpu_time_main_loop_start = cpu_time_now;
1486 cpu_time_now = clib_cpu_time_now ();
1488 /* Pre-allocate interupt runtime indices and lock. */
1489 vec_alloc_aligned (nm->pending_interrupts, 1, CLIB_CACHE_LINE_BYTES);
1491 /* Pre-allocate expired nodes. */
1492 if (!nm->polling_threshold_vector_length)
1493 nm->polling_threshold_vector_length = 10;
1494 if (!nm->interrupt_threshold_vector_length)
1495 nm->interrupt_threshold_vector_length = 5;
1497 vm->cpu_id = clib_get_current_cpu_id ();
1498 vm->numa_node = clib_get_current_numa_node ();
1499 os_set_numa_index (vm->numa_node);
1501 /* Start all processes. */
1507 * Perform an initial barrier sync. Pays no attention to
1508 * the barrier sync hold-down timer scheme, which won't work
1509 * at this point in time.
1511 vlib_worker_thread_initial_barrier_sync_and_release (vm);
1513 nm->current_process_index = ~0;
1514 for (i = 0; i < vec_len (nm->processes); i++)
1515 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1521 vlib_node_runtime_t *n;
1523 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1526 vl_api_send_pending_rpc_requests (vm);
1530 vlib_worker_thread_barrier_check ();
1532 if (PREDICT_FALSE (vm->check_frame_queues + frame_queue_check_counter))
1535 vlib_frame_queue_dequeue_fn_t *fn =
1536 vlib_buffer_func_main.frame_queue_dequeue_fn;
1538 if (vm->check_frame_queues)
1540 frame_queue_check_counter = 100;
1541 vm->check_frame_queues = 0;
1544 vec_foreach (fqm, tm->frame_queue_mains)
1545 processed += (fn) (vm, fqm);
1547 /* No handoff queue work found? */
1549 frame_queue_check_counter = 100;
1551 frame_queue_check_counter--;
1554 if (PREDICT_FALSE (vec_len (vm->worker_thread_main_loop_callbacks)))
1555 clib_call_callbacks (vm->worker_thread_main_loop_callbacks, vm,
1558 /* Process pre-input nodes. */
1559 cpu_time_now = clib_cpu_time_now ();
1560 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1561 cpu_time_now = dispatch_node (vm, n,
1562 VLIB_NODE_TYPE_PRE_INPUT,
1563 VLIB_NODE_STATE_POLLING,
1567 /* Next process input nodes. */
1568 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1569 cpu_time_now = dispatch_node (vm, n,
1570 VLIB_NODE_TYPE_INPUT,
1571 VLIB_NODE_STATE_POLLING,
1575 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1576 vm->queue_signal_callback (vm);
1578 if (__atomic_load_n (nm->pending_interrupts, __ATOMIC_ACQUIRE))
1581 *nm->pending_interrupts = 0;
1584 clib_interrupt_get_next (nm->interrupts, int_num)) != -1)
1586 vlib_node_runtime_t *n;
1587 clib_interrupt_clear (nm->interrupts, int_num);
1588 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1590 cpu_time_now = dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1591 VLIB_NODE_STATE_INTERRUPT,
1592 /* frame */ 0, cpu_time_now);
1596 /* Input nodes may have added work to the pending vector.
1597 Process pending vector until there is nothing left.
1598 All pending vectors will be processed from input -> output. */
1599 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1600 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1601 /* Reset pending vector for next iteration. */
1602 _vec_len (nm->pending_frames) = 0;
1607 ELOG_TYPE_DECLARE (es) =
1609 .format = "process tw start",
1612 ELOG_TYPE_DECLARE (ee) =
1614 .format = "process tw end: %d",
1615 .format_args = "i4",
1624 /* Check if process nodes have expired from timing wheel. */
1625 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1627 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1628 ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1630 nm->data_from_advancing_timing_wheel =
1631 TW (tw_timer_expire_timers_vec)
1632 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1633 nm->data_from_advancing_timing_wheel);
1635 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1637 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1639 ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1641 _vec_len (nm->data_from_advancing_timing_wheel);
1645 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1649 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1652 u32 d = nm->data_from_advancing_timing_wheel[i];
1653 u32 di = vlib_timing_wheel_data_get_index (d);
1655 if (vlib_timing_wheel_data_is_timed_event (d))
1657 vlib_signal_timed_event_data_t *te =
1658 pool_elt_at_index (nm->signal_timed_event_data_pool,
1661 vlib_get_node (vm, te->process_node_index);
1663 vec_elt (nm->processes, n->runtime_index);
1666 vlib_process_signal_event_helper (nm, n, p,
1667 te->event_type_index,
1669 te->n_data_elt_bytes);
1670 if (te->n_data_bytes < sizeof (te->inline_event_data))
1671 clib_memcpy_fast (data, te->inline_event_data,
1675 clib_memcpy_fast (data, te->event_data_as_vector,
1677 vec_free (te->event_data_as_vector);
1679 pool_put (nm->signal_timed_event_data_pool, te);
1683 cpu_time_now = clib_cpu_time_now ();
1685 dispatch_suspended_process (vm, di, cpu_time_now);
1688 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1691 vlib_increment_main_loop_counter (vm);
1692 /* Record time stamp in case there are no enabled nodes and above
1693 calls do not update time stamp. */
1694 cpu_time_now = clib_cpu_time_now ();
1695 vm->loops_this_reporting_interval++;
1696 now = clib_time_now_internal (&vm->clib_time, cpu_time_now);
1697 /* Time to update loops_per_second? */
1698 if (PREDICT_FALSE (now >= vm->loop_interval_end))
1700 /* Next sample ends in 20ms */
1701 if (vm->loop_interval_start)
1703 f64 this_loops_per_second;
1705 this_loops_per_second =
1706 ((f64) vm->loops_this_reporting_interval) / (now -
1707 vm->loop_interval_start);
1709 vm->loops_per_second =
1710 vm->loops_per_second * vm->damping_constant +
1711 (1.0 - vm->damping_constant) * this_loops_per_second;
1712 if (vm->loops_per_second != 0.0)
1713 vm->seconds_per_loop = 1.0 / vm->loops_per_second;
1715 vm->seconds_per_loop = 0.0;
1717 /* New interval starts now, and ends in 20ms */
1718 vm->loop_interval_start = now;
1719 vm->loop_interval_end = now + 2e-4;
1720 vm->loops_this_reporting_interval = 0;
1726 vlib_main_loop (vlib_main_t * vm)
1728 vlib_main_or_worker_loop (vm, /* is_main */ 1);
1732 vlib_worker_loop (vlib_main_t * vm)
1734 vlib_main_or_worker_loop (vm, /* is_main */ 0);
1737 vlib_global_main_t vlib_global_main;
1740 vlib_add_del_post_mortem_callback (void *cb, int is_add)
1742 vlib_global_main_t *vgm = vlib_get_global_main ();
1747 for (i = vec_len (vgm->post_mortem_callbacks) - 1; i >= 0; i--)
1748 if (vgm->post_mortem_callbacks[i] == cb)
1749 vec_del1 (vgm->post_mortem_callbacks, i);
1753 for (i = 0; i < vec_len (vgm->post_mortem_callbacks); i++)
1754 if (vgm->post_mortem_callbacks[i] == cb)
1756 vec_add1 (vgm->post_mortem_callbacks, cb);
1760 elog_post_mortem_dump (void)
1762 elog_main_t *em = vlib_get_elog_main ();
1765 clib_error_t *error;
1767 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
1768 error = elog_write_file (em, (char *) filename, 1 /* flush ring */);
1770 clib_error_report (error);
1772 * We're in the middle of crashing. Don't try to free the filename.
1776 static clib_error_t *
1777 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1779 vlib_global_main_t *vgm = vlib_get_global_main ();
1780 int turn_on_mem_trace = 0;
1782 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1784 if (unformat (input, "memory-trace"))
1785 turn_on_mem_trace = 1;
1787 else if (unformat (input, "elog-events %d",
1788 &vgm->configured_elog_ring_size))
1789 vgm->configured_elog_ring_size =
1790 1 << max_log2 (vgm->configured_elog_ring_size);
1791 else if (unformat (input, "elog-post-mortem-dump"))
1792 vlib_add_del_post_mortem_callback (elog_post_mortem_dump,
1794 else if (unformat (input, "buffer-alloc-success-rate %f",
1795 &vm->buffer_alloc_success_rate))
1797 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
1798 return clib_error_return
1799 (0, "Buffer fault injection not configured");
1801 else if (unformat (input, "buffer-alloc-success-seed %u",
1802 &vm->buffer_alloc_success_seed))
1804 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
1805 return clib_error_return
1806 (0, "Buffer fault injection not configured");
1809 return unformat_parse_error (input);
1812 unformat_free (input);
1814 /* Enable memory trace as early as possible. */
1815 if (turn_on_mem_trace)
1821 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1824 placeholder_queue_signal_callback (vlib_main_t * vm)
1828 #define foreach_weak_reference_stub \
1829 _(vlib_map_stat_segment_init) \
1831 _(vlibmemory_init) \
1832 _(map_api_segment_init)
1835 clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
1836 clib_error_t *name (vlib_main_t *vm) { return 0; }
1837 foreach_weak_reference_stub;
1840 void vl_api_set_elog_main (elog_main_t * m) __attribute__ ((weak));
1842 vl_api_set_elog_main (elog_main_t * m)
1844 clib_warning ("STUB");
1847 int vl_api_set_elog_trace_api_messages (int enable) __attribute__ ((weak));
1849 vl_api_set_elog_trace_api_messages (int enable)
1851 clib_warning ("STUB");
1855 int vl_api_get_elog_trace_api_messages (void) __attribute__ ((weak));
1857 vl_api_get_elog_trace_api_messages (void)
1859 clib_warning ("STUB");
1863 /* Main function. */
1865 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
1867 vlib_global_main_t *vgm = vlib_get_global_main ();
1868 clib_error_t *volatile error;
1869 vlib_node_main_t *nm = &vm->node_main;
1871 vm->queue_signal_callback = placeholder_queue_signal_callback;
1873 /* Reconfigure event log which is enabled very early */
1874 if (vgm->configured_elog_ring_size &&
1875 vgm->configured_elog_ring_size != vgm->elog_main.event_ring_size)
1876 elog_resize (&vgm->elog_main, vgm->configured_elog_ring_size);
1877 vl_api_set_elog_main (vlib_get_elog_main ());
1878 (void) vl_api_set_elog_trace_api_messages (1);
1884 if ((error = vlib_physmem_init (vm)))
1886 clib_error_report (error);
1890 if ((error = vlib_map_stat_segment_init (vm)))
1892 clib_error_report (error);
1896 if ((error = vlib_buffer_main_init (vm)))
1898 clib_error_report (error);
1902 if ((error = vlib_thread_init (vm)))
1904 clib_error_report (error);
1908 /* Register node ifunction variants */
1909 vlib_register_all_node_march_variants (vm);
1911 /* Register static nodes so that init functions may use them. */
1912 vlib_register_all_static_nodes (vm);
1914 /* Set seed for random number generator.
1915 Allow user to specify seed to make random sequence deterministic. */
1916 if (!unformat (input, "seed %wd", &vm->random_seed))
1917 vm->random_seed = clib_cpu_time_now ();
1918 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
1920 /* Initialize node graph. */
1921 if ((error = vlib_node_main_init (vm)))
1923 /* Arrange for graph hook up error to not be fatal when debugging. */
1925 clib_error_report (error);
1930 /* Direct call / weak reference, for vlib standalone use-cases */
1931 if ((error = vpe_api_init (vm)))
1933 clib_error_report (error);
1937 if ((error = vlibmemory_init (vm)))
1939 clib_error_report (error);
1943 if ((error = map_api_segment_init (vm)))
1945 clib_error_report (error);
1949 /* See unix/main.c; most likely already set up */
1950 if (vgm->init_functions_called == 0)
1951 vgm->init_functions_called = hash_create (0, /* value bytes */ 0);
1952 if ((error = vlib_call_all_init_functions (vm)))
1955 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
1956 CLIB_CACHE_LINE_BYTES);
1958 vec_validate (nm->data_from_advancing_timing_wheel, 10);
1959 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1961 /* Create the process timing wheel */
1962 TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1963 0 /* no callback */ ,
1964 10e-6 /* timer period 10us */ ,
1965 ~0 /* max expirations per call */ );
1967 vec_validate (vm->pending_rpc_requests, 0);
1968 _vec_len (vm->pending_rpc_requests) = 0;
1969 vec_validate (vm->processing_rpc_requests, 0);
1970 _vec_len (vm->processing_rpc_requests) = 0;
1972 /* Default params for the buffer allocator fault injector, if configured */
1973 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0)
1975 vm->buffer_alloc_success_seed = 0xdeaddabe;
1976 vm->buffer_alloc_success_rate = 0.80;
1979 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
1983 * Use exponential smoothing, with a half-life of 1 second
1984 * reported_rate(t) = reported_rate(t-1) * K + rate(t)*(1-K)
1986 * Sample every 20ms, aka 50 samples per second
1987 * K = exp (-1.0/20.0);
1990 vm->damping_constant = exp (-1.0 / 20.0);
1992 /* Sort per-thread init functions before we start threads */
1993 vlib_sort_init_exit_functions (&vgm->worker_init_function_registrations);
1995 /* Call all main loop enter functions. */
1997 clib_error_t *sub_error;
1998 sub_error = vlib_call_all_main_loop_enter_functions (vm);
2000 clib_error_report (sub_error);
2003 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2005 case VLIB_MAIN_LOOP_EXIT_NONE:
2006 vm->main_loop_exit_set = 1;
2009 case VLIB_MAIN_LOOP_EXIT_CLI:
2013 error = vm->main_loop_error;
2017 vlib_main_loop (vm);
2020 vlib_worker_thread_barrier_sync (vm);
2021 /* Call all exit functions. */
2023 clib_error_t *sub_error;
2024 sub_error = vlib_call_all_main_loop_exit_functions (vm);
2026 clib_error_report (sub_error);
2028 vlib_worker_thread_barrier_release (vm);
2031 clib_error_report (error);
2033 return vm->main_loop_exit_status;
2037 vlib_get_main_not_inline (void)
2039 return vlib_get_main ();
2043 vlib_get_elog_main_not_inline ()
2045 return &vlib_global_main.elog_main;
2049 vlib_exit_with_status (vlib_main_t *vm, int status)
2051 vm->main_loop_exit_status = status;
2052 __atomic_store_n (&vm->main_loop_exit_now, 1, __ATOMIC_RELEASE);
2056 * fd.io coding-style-patch-verification: ON
2059 * eval: (c-set-style "gnu")