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 /* Actually allocate a few extra slots of vector data to support
49 speculative vector enqueues which overflow vector data in next frame. */
50 #define VLIB_FRAME_SIZE_ALLOC (VLIB_FRAME_SIZE + 4)
53 vlib_frame_bytes (u32 n_scalar_bytes, u32 n_vector_bytes)
57 /* Make room for vlib_frame_t plus scalar arguments. */
58 n_bytes = vlib_frame_vector_byte_offset (n_scalar_bytes);
60 /* Make room for vector arguments.
61 Allocate a few extra slots of vector data to support
62 speculative vector enqueues which overflow vector data in next frame. */
63 #define VLIB_FRAME_SIZE_EXTRA 4
64 n_bytes += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * n_vector_bytes;
66 /* Magic number is first 32bit number after vector data.
67 Used to make sure that vector data is never overrun. */
68 #define VLIB_FRAME_MAGIC (0xabadc0ed)
69 n_bytes += sizeof (u32);
71 /* Pad to cache line. */
72 n_bytes = round_pow2 (n_bytes, CLIB_CACHE_LINE_BYTES);
78 vlib_frame_find_magic (vlib_frame_t * f, vlib_node_t * node)
82 p += vlib_frame_vector_byte_offset (node->scalar_size);
84 p += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * node->vector_size;
89 static inline vlib_frame_size_t *
90 get_frame_size_info (vlib_node_main_t * nm,
91 u32 n_scalar_bytes, u32 n_vector_bytes)
93 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
94 uword key = (n_scalar_bytes << 16) | n_vector_bytes;
97 p = hash_get (nm->frame_size_hash, key);
102 i = vec_len (nm->frame_sizes);
103 vec_validate (nm->frame_sizes, i);
104 hash_set (nm->frame_size_hash, key, i);
107 return vec_elt_at_index (nm->frame_sizes, i);
109 ASSERT (vlib_frame_bytes (n_scalar_bytes, n_vector_bytes)
110 == (vlib_frame_bytes (0, 4)));
111 return vec_elt_at_index (nm->frame_sizes, 0);
115 static vlib_frame_t *
116 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
119 vlib_node_main_t *nm = &vm->node_main;
120 vlib_frame_size_t *fs;
121 vlib_node_t *to_node;
123 u32 l, n, scalar_size, vector_size;
125 ASSERT (vm == vlib_get_main ());
127 to_node = vlib_get_node (vm, to_node_index);
129 scalar_size = to_node->scalar_size;
130 vector_size = to_node->vector_size;
132 fs = get_frame_size_info (nm, scalar_size, vector_size);
133 n = vlib_frame_bytes (scalar_size, vector_size);
134 if ((l = vec_len (fs->free_frames)) > 0)
136 /* Allocate from end of free list. */
137 f = fs->free_frames[l - 1];
138 _vec_len (fs->free_frames) = l - 1;
142 f = clib_mem_alloc_aligned_no_fail (n, VLIB_FRAME_ALIGN);
145 /* Poison frame when debugging. */
147 clib_memset (f, 0xfe, n);
149 /* Insert magic number. */
153 magic = vlib_frame_find_magic (f, to_node);
154 *magic = VLIB_FRAME_MAGIC;
157 f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
159 f->scalar_size = scalar_size;
160 f->vector_size = vector_size;
163 fs->n_alloc_frames += 1;
168 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
169 Returns frame index. */
170 static vlib_frame_t *
171 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
174 vlib_node_t *from_node;
176 from_node = vlib_get_node (vm, from_node_runtime->node_index);
177 ASSERT (to_next_index < vec_len (from_node->next_nodes));
179 return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
180 /* frame_flags */ 0);
184 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
186 vlib_frame_t *f = vlib_frame_alloc_to_node (vm, to_node_index,
188 VLIB_FRAME_FREE_AFTER_DISPATCH);
189 return vlib_get_frame (vm, f);
193 vlib_validate_frame_indices (vlib_frame_t * f)
198 u32 *from = vlib_frame_vector_args (f);
200 /* Check for bad buffer index values */
201 for (i = 0; i < f->n_vectors; i++)
205 clib_warning ("BUG: buffer index 0 at index %d", i);
208 else if (from[i] == 0xfefefefe)
210 clib_warning ("BUG: frame poison pattern at index %d", i);
218 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
220 vlib_pending_frame_t *p;
221 vlib_node_t *to_node;
223 if (f->n_vectors == 0)
226 ASSERT (vm == vlib_get_main ());
228 vlib_validate_frame_indices (f);
230 to_node = vlib_get_node (vm, to_node_index);
232 vec_add2 (vm->node_main.pending_frames, p, 1);
234 f->frame_flags |= VLIB_FRAME_PENDING;
235 p->frame = vlib_get_frame (vm, f);
236 p->node_runtime_index = to_node->runtime_index;
237 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
240 /* Free given frame. */
242 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
244 vlib_node_main_t *nm = &vm->node_main;
246 vlib_frame_size_t *fs;
248 ASSERT (vm == vlib_get_main ());
249 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
251 node = vlib_get_node (vm, r->node_index);
252 fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
254 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
256 /* No next frames may point to freed frame. */
259 vlib_next_frame_t *nf;
260 vec_foreach (nf, vm->node_main.next_frames) ASSERT (nf->frame != f);
263 f->frame_flags &= ~(VLIB_FRAME_IS_ALLOCATED | VLIB_FRAME_NO_APPEND);
265 vec_add1 (fs->free_frames, f);
266 ASSERT (fs->n_alloc_frames > 0);
267 fs->n_alloc_frames -= 1;
270 static clib_error_t *
271 show_frame_stats (vlib_main_t * vm,
272 unformat_input_t * input, vlib_cli_command_t * cmd)
274 vlib_node_main_t *nm = &vm->node_main;
275 vlib_frame_size_t *fs;
277 vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
278 vec_foreach (fs, nm->frame_sizes)
280 u32 n_alloc = fs->n_alloc_frames;
281 u32 n_free = vec_len (fs->free_frames);
283 if (n_alloc + n_free > 0)
284 vlib_cli_output (vm, "%=6d%=12d%=12d",
285 fs - nm->frame_sizes, n_alloc, n_free);
292 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
293 .path = "show vlib frame-allocation",
294 .short_help = "Show node dispatch frame statistics",
295 .function = show_frame_stats,
299 /* Change ownership of enqueue rights to given next node. */
301 vlib_next_frame_change_ownership (vlib_main_t * vm,
302 vlib_node_runtime_t * node_runtime,
305 vlib_node_main_t *nm = &vm->node_main;
306 vlib_next_frame_t *next_frame;
307 vlib_node_t *node, *next_node;
309 node = vec_elt (nm->nodes, node_runtime->node_index);
311 /* Only internal & input nodes are allowed to call other nodes. */
312 ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
313 || node->type == VLIB_NODE_TYPE_INPUT
314 || node->type == VLIB_NODE_TYPE_PROCESS);
316 ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
319 vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
320 next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
322 if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
324 /* Get frame from previous owner. */
325 vlib_next_frame_t *owner_next_frame;
326 vlib_next_frame_t tmp;
329 vlib_node_get_next_frame (vm,
330 next_node->owner_node_index,
331 next_node->owner_next_index);
333 /* Swap target next frame with owner's. */
334 tmp = owner_next_frame[0];
335 owner_next_frame[0] = next_frame[0];
339 * If next_frame is already pending, we have to track down
340 * all pending frames and fix their next_frame_index fields.
342 if (next_frame->flags & VLIB_FRAME_PENDING)
344 vlib_pending_frame_t *p;
345 if (next_frame->frame != NULL)
347 vec_foreach (p, nm->pending_frames)
349 if (p->frame == next_frame->frame)
351 p->next_frame_index =
352 next_frame - vm->node_main.next_frames;
360 /* No previous owner. Take ownership. */
361 next_frame->flags |= VLIB_FRAME_OWNER;
364 /* Record new owner. */
365 next_node->owner_node_index = node->index;
366 next_node->owner_next_index = next_index;
368 /* Now we should be owner. */
369 ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
372 /* Make sure that magic number is still there.
373 Otherwise, it is likely that caller has overrun frame arguments. */
375 validate_frame_magic (vlib_main_t * vm,
376 vlib_frame_t * f, vlib_node_t * n, uword next_index)
378 vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
379 u32 *magic = vlib_frame_find_magic (f, next_node);
380 ASSERT (VLIB_FRAME_MAGIC == magic[0]);
384 vlib_get_next_frame_internal (vlib_main_t * vm,
385 vlib_node_runtime_t * node,
386 u32 next_index, u32 allocate_new_next_frame)
389 vlib_next_frame_t *nf;
392 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
394 /* Make sure this next frame owns right to enqueue to destination frame. */
395 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
396 vlib_next_frame_change_ownership (vm, node, next_index);
398 /* ??? Don't need valid flag: can use frame_index == ~0 */
399 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
401 nf->frame = vlib_frame_alloc (vm, node, next_index);
402 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
407 /* Has frame been removed from pending vector (e.g. finished dispatching)?
408 If so we can reuse frame. */
409 if ((nf->flags & VLIB_FRAME_PENDING)
410 && !(f->frame_flags & VLIB_FRAME_PENDING))
412 nf->flags &= ~VLIB_FRAME_PENDING;
417 /* Allocate new frame if current one is marked as no-append or
418 it is already full. */
419 n_used = f->n_vectors;
420 if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0) ||
421 (f->frame_flags & VLIB_FRAME_NO_APPEND))
423 /* Old frame may need to be freed after dispatch, since we'll have
424 two redundant frames from node -> next node. */
425 if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
427 vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame);
428 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
431 /* Allocate new frame to replace full one. */
432 f = nf->frame = vlib_frame_alloc (vm, node, next_index);
433 n_used = f->n_vectors;
436 /* Should have free vectors in frame now. */
437 ASSERT (n_used < VLIB_FRAME_SIZE);
441 validate_frame_magic (vm, f,
442 vlib_get_node (vm, node->node_index), next_index);
449 vlib_put_next_frame_validate (vlib_main_t * vm,
450 vlib_node_runtime_t * rt,
451 u32 next_index, u32 n_vectors_left)
453 vlib_node_main_t *nm = &vm->node_main;
454 vlib_next_frame_t *nf;
456 vlib_node_runtime_t *next_rt;
457 vlib_node_t *next_node;
458 u32 n_before, n_after;
460 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
461 f = vlib_get_frame (vm, nf->frame);
463 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
465 vlib_validate_frame_indices (f);
467 n_after = VLIB_FRAME_SIZE - n_vectors_left;
468 n_before = f->n_vectors;
470 ASSERT (n_after >= n_before);
472 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
473 nf->node_runtime_index);
474 next_node = vlib_get_node (vm, next_rt->node_index);
475 if (n_after > 0 && next_node->validate_frame)
477 u8 *msg = next_node->validate_frame (vm, rt, f);
480 clib_warning ("%v", msg);
488 vlib_put_next_frame (vlib_main_t * vm,
489 vlib_node_runtime_t * r,
490 u32 next_index, u32 n_vectors_left)
492 vlib_node_main_t *nm = &vm->node_main;
493 vlib_next_frame_t *nf;
495 u32 n_vectors_in_frame;
498 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
500 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
501 f = vlib_get_frame (vm, nf->frame);
503 /* Make sure that magic number is still there. Otherwise, caller
504 has overrun frame meta data. */
507 vlib_node_t *node = vlib_get_node (vm, r->node_index);
508 validate_frame_magic (vm, f, node, next_index);
511 /* Convert # of vectors left -> number of vectors there. */
512 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
513 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
515 f->n_vectors = n_vectors_in_frame;
517 /* If vectors were added to frame, add to pending vector. */
518 if (PREDICT_TRUE (n_vectors_in_frame > 0))
520 vlib_pending_frame_t *p;
523 r->cached_next_index = next_index;
525 if (!(f->frame_flags & VLIB_FRAME_PENDING))
527 __attribute__ ((unused)) vlib_node_t *node;
528 vlib_node_t *next_node;
529 vlib_node_runtime_t *next_runtime;
531 node = vlib_get_node (vm, r->node_index);
532 next_node = vlib_get_next_node (vm, r->node_index, next_index);
533 next_runtime = vlib_node_get_runtime (vm, next_node->index);
535 vec_add2 (nm->pending_frames, p, 1);
537 p->frame = nf->frame;
538 p->node_runtime_index = nf->node_runtime_index;
539 p->next_frame_index = nf - nm->next_frames;
540 nf->flags |= VLIB_FRAME_PENDING;
541 f->frame_flags |= VLIB_FRAME_PENDING;
544 * If we're going to dispatch this frame on another thread,
545 * force allocation of a new frame. Otherwise, we create
546 * a dangling frame reference. Each thread has its own copy of
547 * the next_frames vector.
549 if (0 && r->thread_index != next_runtime->thread_index)
552 nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
556 /* Copy trace flag from next_frame and from runtime. */
558 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
559 flags & VLIB_NODE_FLAG_TRACE);
561 v0 = nf->vectors_since_last_overflow;
562 v1 = v0 + n_vectors_in_frame;
563 nf->vectors_since_last_overflow = v1;
564 if (PREDICT_FALSE (v1 < v0))
566 vlib_node_t *node = vlib_get_node (vm, r->node_index);
567 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
572 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
574 vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
575 uword n_calls, uword n_vectors,
578 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
579 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
580 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
581 n->stats_total.max_clock = r->max_clock;
582 n->stats_total.max_clock_n = r->max_clock_n;
584 r->calls_since_last_overflow = 0;
585 r->vectors_since_last_overflow = 0;
586 r->clocks_since_last_overflow = 0;
590 vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
591 uword n_calls, uword n_vectors, uword n_clocks)
593 vlib_node_t *n = vlib_get_node (vm, r->node_index);
594 vlib_node_runtime_sync_stats_node (n, r, n_calls, n_vectors, n_clocks);
597 always_inline void __attribute__ ((unused))
598 vlib_process_sync_stats (vlib_main_t * vm,
600 uword n_calls, uword n_vectors, uword n_clocks)
602 vlib_node_runtime_t *rt = &p->node_runtime;
603 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
604 vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks);
605 n->stats_total.suspends += p->n_suspends;
610 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
612 vlib_node_runtime_t *rt;
614 if (n->type == VLIB_NODE_TYPE_PROCESS)
616 /* Nothing to do for PROCESS nodes except in main thread */
617 if (vm != vlib_get_first_main ())
620 vlib_process_t *p = vlib_get_process_from_node (vm, n);
621 n->stats_total.suspends += p->n_suspends;
623 rt = &p->node_runtime;
627 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
630 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0);
632 /* Sync up runtime next frame vector counters with main node structure. */
634 vlib_next_frame_t *nf;
636 for (i = 0; i < rt->n_next_nodes; i++)
638 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
639 vec_elt (n->n_vectors_by_next_node, i) +=
640 nf->vectors_since_last_overflow;
641 nf->vectors_since_last_overflow = 0;
647 vlib_node_runtime_update_stats (vlib_main_t * vm,
648 vlib_node_runtime_t * node,
650 uword n_vectors, uword n_clocks)
652 u32 ca0, ca1, v0, v1, cl0, cl1, r;
654 cl0 = cl1 = node->clocks_since_last_overflow;
655 ca0 = ca1 = node->calls_since_last_overflow;
656 v0 = v1 = node->vectors_since_last_overflow;
660 cl1 = cl0 + n_clocks;
662 node->calls_since_last_overflow = ca1;
663 node->clocks_since_last_overflow = cl1;
664 node->vectors_since_last_overflow = v1;
666 node->max_clock_n = node->max_clock > n_clocks ?
667 node->max_clock_n : n_vectors;
668 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
670 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
672 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0))
674 node->calls_since_last_overflow = ca0;
675 node->clocks_since_last_overflow = cl0;
676 node->vectors_since_last_overflow = v0;
678 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks);
685 vlib_process_update_stats (vlib_main_t * vm,
687 uword n_calls, uword n_vectors, uword n_clocks)
689 vlib_node_runtime_update_stats (vm, &p->node_runtime,
690 n_calls, n_vectors, n_clocks);
693 static clib_error_t *
694 vlib_cli_elog_clear (vlib_main_t * vm,
695 unformat_input_t * input, vlib_cli_command_t * cmd)
697 elog_reset_buffer (&vlib_global_main.elog_main);
702 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
703 .path = "event-logger clear",
704 .short_help = "Clear the event log",
705 .function = vlib_cli_elog_clear,
710 static clib_error_t *
711 elog_save_buffer (vlib_main_t * vm,
712 unformat_input_t * input, vlib_cli_command_t * cmd)
714 elog_main_t *em = &vlib_global_main.elog_main;
715 char *file, *chroot_file;
716 clib_error_t *error = 0;
718 if (!unformat (input, "%s", &file))
720 vlib_cli_output (vm, "expected file name, got `%U'",
721 format_unformat_error, input);
725 /* It's fairly hard to get "../oopsie" through unformat; just in case */
726 if (strstr (file, "..") || index (file, '/'))
728 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
732 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
736 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
737 elog_n_events_in_buffer (em),
738 elog_buffer_capacity (em), chroot_file);
740 vlib_worker_thread_barrier_sync (vm);
741 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
742 vlib_worker_thread_barrier_release (vm);
743 vec_free (chroot_file);
748 vlib_post_mortem_dump (void)
750 vlib_global_main_t *vgm = vlib_get_global_main ();
752 for (int i = 0; i < vec_len (vgm->post_mortem_callbacks); i++)
753 (vgm->post_mortem_callbacks[i]) ();
757 VLIB_CLI_COMMAND (elog_save_cli, static) = {
758 .path = "event-logger save",
759 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
760 .function = elog_save_buffer,
764 static clib_error_t *
765 elog_stop (vlib_main_t * vm,
766 unformat_input_t * input, vlib_cli_command_t * cmd)
768 elog_main_t *em = &vlib_global_main.elog_main;
770 em->n_total_events_disable_limit = em->n_total_events;
772 vlib_cli_output (vm, "Stopped the event logger...");
777 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
778 .path = "event-logger stop",
779 .short_help = "Stop the event-logger",
780 .function = elog_stop,
784 static clib_error_t *
785 elog_restart (vlib_main_t * vm,
786 unformat_input_t * input, vlib_cli_command_t * cmd)
788 elog_main_t *em = &vlib_global_main.elog_main;
790 em->n_total_events_disable_limit = ~0;
792 vlib_cli_output (vm, "Restarted the event logger...");
797 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
798 .path = "event-logger restart",
799 .short_help = "Restart the event-logger",
800 .function = elog_restart,
804 static clib_error_t *
805 elog_resize_command_fn (vlib_main_t * vm,
806 unformat_input_t * input, vlib_cli_command_t * cmd)
808 elog_main_t *em = &vlib_global_main.elog_main;
811 /* Stop the parade */
812 elog_reset_buffer (em);
814 if (unformat (input, "%d", &tmp))
816 elog_alloc (em, tmp);
817 em->n_total_events_disable_limit = ~0;
820 return clib_error_return (0, "Must specify how many events in the ring");
822 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
827 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
828 .path = "event-logger resize",
829 .short_help = "event-logger resize <nnn>",
830 .function = elog_resize_command_fn,
834 #endif /* CLIB_UNIX */
837 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
839 elog_main_t *em = &vlib_global_main.elog_main;
840 elog_event_t *e, *es;
843 /* Show events in VLIB time since log clock starts after VLIB clock. */
844 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
845 * vm->clib_time.seconds_per_clock;
847 es = elog_peek_events (em);
848 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
850 em->n_total_events < em->n_total_events_disable_limit ?
851 "running" : "stopped");
854 vlib_cli_output (vm, "%18.9f: %U",
855 e->time + dt, format_elog_event, em, e);
857 if (n_events_to_show == 0)
864 static clib_error_t *
865 elog_show_buffer (vlib_main_t * vm,
866 unformat_input_t * input, vlib_cli_command_t * cmd)
868 u32 n_events_to_show;
869 clib_error_t *error = 0;
871 n_events_to_show = 250;
872 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
874 if (unformat (input, "%d", &n_events_to_show))
876 else if (unformat (input, "all"))
877 n_events_to_show = ~0;
879 return unformat_parse_error (input);
881 elog_show_buffer_internal (vm, n_events_to_show);
886 VLIB_CLI_COMMAND (elog_show_cli, static) = {
887 .path = "show event-logger",
888 .short_help = "Show event logger info",
889 .function = elog_show_buffer,
894 vlib_gdb_show_event_log (void)
896 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
900 vlib_elog_main_loop_event (vlib_main_t * vm,
902 u64 time, u32 n_vectors, u32 is_return)
904 vlib_main_t *evm = vlib_get_first_main ();
905 elog_main_t *em = vlib_get_elog_main ();
906 int enabled = evm->elog_trace_graph_dispatch |
907 evm->elog_trace_graph_circuit;
909 if (PREDICT_FALSE (enabled && n_vectors))
911 if (PREDICT_FALSE (!elog_is_enabled (em)))
913 evm->elog_trace_graph_dispatch = 0;
914 evm->elog_trace_graph_circuit = 0;
918 (evm->elog_trace_graph_dispatch ||
919 (evm->elog_trace_graph_circuit &&
920 node_index == evm->elog_trace_graph_circuit_node_index)))
924 vec_elt_at_index (is_return
925 ? evm->node_return_elog_event_types
926 : evm->node_call_elog_event_types,
930 &vlib_worker_threads[vm->thread_index].elog_track
931 : &em->default_track),
932 /* data to log */ n_vectors);
937 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
938 void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 node_index);
939 void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
942 vlib_buffer_trace_trajectory_init (vlib_buffer_t * b)
944 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_init_cb != 0))
946 (*vlib_buffer_trace_trajectory_init_cb) (b);
953 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
955 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
956 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_cb != 0))
958 (*vlib_buffer_trace_trajectory_cb) (b, node_index);
963 static_always_inline u64
964 dispatch_node (vlib_main_t * vm,
965 vlib_node_runtime_t * node,
966 vlib_node_type_t type,
967 vlib_node_state_t dispatch_state,
968 vlib_frame_t * frame, u64 last_time_stamp)
972 vlib_node_main_t *nm = &vm->node_main;
973 vlib_next_frame_t *nf;
977 vlib_node_t *n = vlib_get_node (vm, node->node_index);
978 ASSERT (n->type == type);
981 /* Only non-internal nodes may be disabled. */
982 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
984 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
985 return last_time_stamp;
988 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
989 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
991 u32 c = node->input_main_loops_per_call;
992 /* Only call node when count reaches zero. */
995 node->input_main_loops_per_call = c - 1;
996 return last_time_stamp;
1000 /* Speculatively prefetch next frames. */
1001 if (node->n_next_nodes > 0)
1003 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
1004 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
1007 vm->cpu_time_last_node_dispatch = last_time_stamp;
1009 vlib_elog_main_loop_event (vm, node->node_index,
1010 last_time_stamp, frame ? frame->n_vectors : 0,
1013 vlib_node_runtime_perf_counter (vm, node, frame, 0, last_time_stamp,
1014 VLIB_NODE_RUNTIME_PERF_BEFORE);
1017 * Turn this on if you run into
1018 * "bad monkey" contexts, and you want to know exactly
1019 * which nodes they've visited... See ixge.c...
1021 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
1025 from = vlib_frame_vector_args (frame);
1026 for (i = 0; i < frame->n_vectors; i++)
1028 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1029 add_trajectory_trace (b, node->node_index);
1031 if (PREDICT_TRUE (vm->dispatch_wrapper_fn == 0))
1032 n = node->function (vm, node, frame);
1034 n = vm->dispatch_wrapper_fn (vm, node, frame);
1038 if (PREDICT_TRUE (vm->dispatch_wrapper_fn == 0))
1039 n = node->function (vm, node, frame);
1041 n = vm->dispatch_wrapper_fn (vm, node, frame);
1044 t = clib_cpu_time_now ();
1046 vlib_node_runtime_perf_counter (vm, node, frame, n, t,
1047 VLIB_NODE_RUNTIME_PERF_AFTER);
1049 vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
1051 vm->main_loop_vectors_processed += n;
1052 vm->main_loop_nodes_processed += n > 0;
1054 v = vlib_node_runtime_update_stats (vm, node,
1057 /* n_clocks */ t - last_time_stamp);
1059 /* When in adaptive mode and vector rate crosses threshold switch to
1060 polling mode and vice versa. */
1061 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_ADAPTIVE_MODE))
1064 ELOG_TYPE_DECLARE (e) =
1066 .function = (char *) __FUNCTION__,
1067 .format = "%s vector length %d, switching to %s",
1068 .format_args = "T4i4t4",
1069 .n_enum_strings = 2,
1071 "interrupt", "polling",
1077 u32 node_name, vector_length, is_polling;
1080 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1081 && v >= nm->polling_threshold_vector_length) &&
1083 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1085 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1086 n->state = VLIB_NODE_STATE_POLLING;
1087 node->state = VLIB_NODE_STATE_POLLING;
1089 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1090 node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1091 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1092 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1095 vlib_get_first_main ()->elog_trace_graph_dispatch))
1097 vlib_worker_thread_t *w = vlib_worker_threads
1100 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1102 ed->node_name = n->name_elog_string;
1103 ed->vector_length = v;
1107 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1108 && v <= nm->interrupt_threshold_vector_length)
1110 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1112 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1114 /* Switch to interrupt mode after dispatch in polling one more time.
1115 This allows driver to re-enable interrupts. */
1116 n->state = VLIB_NODE_STATE_INTERRUPT;
1117 node->state = VLIB_NODE_STATE_INTERRUPT;
1119 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1120 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1121 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
1126 vlib_worker_thread_t *w = vlib_worker_threads
1129 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1131 vlib_get_first_main ()->elog_trace_graph_dispatch))
1133 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1135 ed->node_name = n->name_elog_string;
1136 ed->vector_length = v;
1147 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1148 u64 last_time_stamp)
1150 vlib_node_main_t *nm = &vm->node_main;
1152 vlib_next_frame_t *nf, nf_placeholder;
1153 vlib_node_runtime_t *n;
1154 vlib_frame_t *restore_frame;
1155 vlib_pending_frame_t *p;
1157 /* See comment below about dangling references to nm->pending_frames */
1158 p = nm->pending_frames + pending_frame_index;
1160 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1161 p->node_runtime_index);
1163 f = vlib_get_frame (vm, p->frame);
1164 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1166 /* No next frame: so use placeholder on stack. */
1167 nf = &nf_placeholder;
1168 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1172 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1174 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1176 /* Force allocation of new frame while current frame is being
1178 restore_frame = NULL;
1179 if (nf->frame == p->frame)
1182 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1183 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1184 restore_frame = p->frame;
1187 /* Frame must be pending. */
1188 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1189 ASSERT (f->n_vectors > 0);
1191 /* Copy trace flag from next frame to node.
1192 Trace flag indicates that at least one vector in the dispatched
1194 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1195 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1196 nf->flags &= ~VLIB_FRAME_TRACE;
1198 last_time_stamp = dispatch_node (vm, n,
1199 VLIB_NODE_TYPE_INTERNAL,
1200 VLIB_NODE_STATE_POLLING,
1201 f, last_time_stamp);
1202 /* Internal node vector-rate accounting, for summary stats */
1203 vm->internal_node_vectors += f->n_vectors;
1204 vm->internal_node_calls++;
1205 vm->internal_node_last_vectors_per_main_loop =
1206 (f->n_vectors > vm->internal_node_last_vectors_per_main_loop) ?
1207 f->n_vectors : vm->internal_node_last_vectors_per_main_loop;
1209 f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
1211 /* Frame is ready to be used again, so restore it. */
1212 if (restore_frame != NULL)
1215 * We musn't restore a frame that is flagged to be freed. This
1216 * shouldn't happen since frames to be freed post dispatch are
1217 * those used when the to-node frame becomes full i.e. they form a
1218 * sort of queue of frames to a single node. If we get here then
1219 * the to-node frame and the pending frame *were* the same, and so
1220 * we removed the to-node frame. Therefore this frame is no
1221 * longer part of the queue for that node and hence it cannot be
1224 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1227 * NB: dispatching node n can result in the creation and scheduling
1228 * of new frames, and hence in the reallocation of nm->pending_frames.
1229 * Recompute p, or no supper. This was broken for more than 10 years.
1231 p = nm->pending_frames + pending_frame_index;
1234 * p->next_frame_index can change during node dispatch if node
1235 * function decides to change graph hook up.
1237 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1238 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1240 if (NULL == nf->frame)
1242 /* no new frame has been assigned to this node, use the saved one */
1243 nf->frame = restore_frame;
1248 /* The node has gained a frame, implying packets from the current frame
1249 were re-queued to this same node. we don't need the saved one
1251 vlib_frame_free (vm, n, f);
1256 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1258 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1259 vlib_frame_free (vm, n, f);
1263 return last_time_stamp;
1267 vlib_process_stack_is_valid (vlib_process_t * p)
1269 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1275 vlib_process_t *process;
1276 vlib_frame_t *frame;
1277 } vlib_process_bootstrap_args_t;
1279 /* Called in process stack. */
1281 vlib_process_bootstrap (uword _a)
1283 vlib_process_bootstrap_args_t *a;
1285 vlib_node_runtime_t *node;
1290 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1294 vlib_process_finish_switch_stack (vm);
1297 node = &p->node_runtime;
1299 n = node->function (vm, node, f);
1301 ASSERT (vlib_process_stack_is_valid (p));
1303 vlib_process_start_switch_stack (vm, 0);
1304 clib_longjmp (&p->return_longjmp, n);
1309 /* Called in main stack. */
1310 static_always_inline uword
1311 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1313 vlib_process_bootstrap_args_t a;
1320 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1321 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1323 vlib_process_start_switch_stack (vm, p);
1324 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1325 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1328 vlib_process_finish_switch_stack (vm);
1333 static_always_inline uword
1334 vlib_process_resume (vlib_main_t * vm, vlib_process_t * p)
1337 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1338 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1339 | VLIB_PROCESS_RESUME_PENDING);
1340 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1341 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1343 vlib_process_start_switch_stack (vm, p);
1344 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1347 vlib_process_finish_switch_stack (vm);
1352 dispatch_process (vlib_main_t * vm,
1353 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1355 vlib_node_main_t *nm = &vm->node_main;
1356 vlib_node_runtime_t *node_runtime = &p->node_runtime;
1357 vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1358 u32 old_process_index;
1360 uword n_vectors, is_suspend;
1362 if (node->state != VLIB_NODE_STATE_POLLING
1363 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1364 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1365 return last_time_stamp;
1367 p->flags |= VLIB_PROCESS_IS_RUNNING;
1369 t = last_time_stamp;
1370 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1371 f ? f->n_vectors : 0, /* is_after */ 0);
1373 /* Save away current process for suspend. */
1374 old_process_index = nm->current_process_index;
1375 nm->current_process_index = node->runtime_index;
1377 vlib_node_runtime_perf_counter (vm, node_runtime, f, 0, last_time_stamp,
1378 VLIB_NODE_RUNTIME_PERF_BEFORE);
1380 n_vectors = vlib_process_startup (vm, p, f);
1382 nm->current_process_index = old_process_index;
1384 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1385 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1388 vlib_pending_frame_t *pf;
1391 pool_get (nm->suspended_process_frames, pf);
1392 pf->node_runtime_index = node->runtime_index;
1394 pf->next_frame_index = ~0;
1397 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1399 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1401 TWT (tw_timer_wheel) * tw =
1402 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1403 p->stop_timer_handle =
1404 TW (tw_timer_start) (tw,
1405 vlib_timing_wheel_data_set_suspended_process
1406 (node->runtime_index) /* [sic] pool idex */ ,
1408 p->resume_clock_interval);
1412 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1414 t = clib_cpu_time_now ();
1416 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1419 vlib_node_runtime_perf_counter (vm, node_runtime, f, n_vectors, t,
1420 VLIB_NODE_RUNTIME_PERF_AFTER);
1422 vlib_process_update_stats (vm, p,
1423 /* n_calls */ !is_suspend,
1424 /* n_vectors */ n_vectors,
1425 /* n_clocks */ t - last_time_stamp);
1431 vlib_start_process (vlib_main_t * vm, uword process_index)
1433 vlib_node_main_t *nm = &vm->node_main;
1434 vlib_process_t *p = vec_elt (nm->processes, process_index);
1435 dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1439 dispatch_suspended_process (vlib_main_t * vm,
1440 uword process_index, u64 last_time_stamp)
1442 vlib_node_main_t *nm = &vm->node_main;
1443 vlib_node_runtime_t *node_runtime;
1447 vlib_pending_frame_t *pf;
1448 u64 t, n_vectors, is_suspend;
1450 t = last_time_stamp;
1452 p = vec_elt (nm->processes, process_index);
1453 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1454 return last_time_stamp;
1456 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1457 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1459 pf = pool_elt_at_index (nm->suspended_process_frames,
1460 p->suspended_process_frame_index);
1462 node_runtime = &p->node_runtime;
1463 node = vlib_get_node (vm, node_runtime->node_index);
1466 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1467 f ? f->n_vectors : 0, /* is_after */ 0);
1469 /* Save away current process for suspend. */
1470 nm->current_process_index = node->runtime_index;
1472 vlib_node_runtime_perf_counter (vm, node_runtime, f, 0, last_time_stamp,
1473 VLIB_NODE_RUNTIME_PERF_BEFORE);
1475 n_vectors = vlib_process_resume (vm, p);
1476 t = clib_cpu_time_now ();
1478 nm->current_process_index = ~0;
1480 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1483 /* Suspend it again. */
1486 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1488 p->stop_timer_handle =
1489 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1490 vlib_timing_wheel_data_set_suspended_process
1491 (node->runtime_index) /* [sic] pool idex */ ,
1493 p->resume_clock_interval);
1498 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1499 pool_put_index (nm->suspended_process_frames,
1500 p->suspended_process_frame_index);
1501 p->suspended_process_frame_index = ~0;
1504 t = clib_cpu_time_now ();
1505 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1508 vlib_node_runtime_perf_counter (vm, node_runtime, f, n_vectors, t,
1509 VLIB_NODE_RUNTIME_PERF_AFTER);
1511 vlib_process_update_stats (vm, p,
1512 /* n_calls */ !is_suspend,
1513 /* n_vectors */ n_vectors,
1514 /* n_clocks */ t - last_time_stamp);
1519 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1521 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1525 static_always_inline void
1526 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1528 vlib_node_main_t *nm = &vm->node_main;
1529 vlib_thread_main_t *tm = vlib_get_thread_main ();
1533 vlib_frame_queue_main_t *fqm;
1534 u32 frame_queue_check_counter = 0;
1536 /* Initialize pending node vector. */
1539 vec_resize (nm->pending_frames, 32);
1540 _vec_len (nm->pending_frames) = 0;
1543 /* Mark time of main loop start. */
1546 cpu_time_now = vm->clib_time.last_cpu_time;
1547 vm->cpu_time_main_loop_start = cpu_time_now;
1550 cpu_time_now = clib_cpu_time_now ();
1552 /* Pre-allocate interupt runtime indices and lock. */
1553 vec_alloc_aligned (nm->pending_interrupts, 1, CLIB_CACHE_LINE_BYTES);
1555 /* Pre-allocate expired nodes. */
1556 if (!nm->polling_threshold_vector_length)
1557 nm->polling_threshold_vector_length = 10;
1558 if (!nm->interrupt_threshold_vector_length)
1559 nm->interrupt_threshold_vector_length = 5;
1561 vm->cpu_id = clib_get_current_cpu_id ();
1562 vm->numa_node = clib_get_current_numa_node ();
1563 os_set_numa_index (vm->numa_node);
1565 /* Start all processes. */
1571 * Perform an initial barrier sync. Pays no attention to
1572 * the barrier sync hold-down timer scheme, which won't work
1573 * at this point in time.
1575 vlib_worker_thread_initial_barrier_sync_and_release (vm);
1577 nm->current_process_index = ~0;
1578 for (i = 0; i < vec_len (nm->processes); i++)
1579 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1585 vlib_node_runtime_t *n;
1587 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1590 vl_api_send_pending_rpc_requests (vm);
1594 vlib_worker_thread_barrier_check ();
1596 if (PREDICT_FALSE (vm->check_frame_queues + frame_queue_check_counter))
1600 if (vm->check_frame_queues)
1602 frame_queue_check_counter = 100;
1603 vm->check_frame_queues = 0;
1606 vec_foreach (fqm, tm->frame_queue_mains)
1607 processed += vlib_frame_queue_dequeue (vm, fqm);
1609 /* No handoff queue work found? */
1611 frame_queue_check_counter = 100;
1613 frame_queue_check_counter--;
1616 if (PREDICT_FALSE (vec_len (vm->worker_thread_main_loop_callbacks)))
1617 clib_call_callbacks (vm->worker_thread_main_loop_callbacks, vm,
1620 /* Process pre-input nodes. */
1621 cpu_time_now = clib_cpu_time_now ();
1622 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1623 cpu_time_now = dispatch_node (vm, n,
1624 VLIB_NODE_TYPE_PRE_INPUT,
1625 VLIB_NODE_STATE_POLLING,
1629 /* Next process input nodes. */
1630 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1631 cpu_time_now = dispatch_node (vm, n,
1632 VLIB_NODE_TYPE_INPUT,
1633 VLIB_NODE_STATE_POLLING,
1637 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1638 vm->queue_signal_callback (vm);
1640 if (__atomic_load_n (nm->pending_interrupts, __ATOMIC_ACQUIRE))
1643 *nm->pending_interrupts = 0;
1646 clib_interrupt_get_next (nm->interrupts, int_num)) != -1)
1648 vlib_node_runtime_t *n;
1649 clib_interrupt_clear (nm->interrupts, int_num);
1650 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1652 cpu_time_now = dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1653 VLIB_NODE_STATE_INTERRUPT,
1654 /* frame */ 0, cpu_time_now);
1658 /* Input nodes may have added work to the pending vector.
1659 Process pending vector until there is nothing left.
1660 All pending vectors will be processed from input -> output. */
1661 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1662 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1663 /* Reset pending vector for next iteration. */
1664 _vec_len (nm->pending_frames) = 0;
1669 ELOG_TYPE_DECLARE (es) =
1671 .format = "process tw start",
1674 ELOG_TYPE_DECLARE (ee) =
1676 .format = "process tw end: %d",
1677 .format_args = "i4",
1686 /* Check if process nodes have expired from timing wheel. */
1687 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1689 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1690 ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1692 nm->data_from_advancing_timing_wheel =
1693 TW (tw_timer_expire_timers_vec)
1694 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1695 nm->data_from_advancing_timing_wheel);
1697 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1699 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1701 ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1703 _vec_len (nm->data_from_advancing_timing_wheel);
1707 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1711 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1714 u32 d = nm->data_from_advancing_timing_wheel[i];
1715 u32 di = vlib_timing_wheel_data_get_index (d);
1717 if (vlib_timing_wheel_data_is_timed_event (d))
1719 vlib_signal_timed_event_data_t *te =
1720 pool_elt_at_index (nm->signal_timed_event_data_pool,
1723 vlib_get_node (vm, te->process_node_index);
1725 vec_elt (nm->processes, n->runtime_index);
1728 vlib_process_signal_event_helper (nm, n, p,
1729 te->event_type_index,
1731 te->n_data_elt_bytes);
1732 if (te->n_data_bytes < sizeof (te->inline_event_data))
1733 clib_memcpy_fast (data, te->inline_event_data,
1737 clib_memcpy_fast (data, te->event_data_as_vector,
1739 vec_free (te->event_data_as_vector);
1741 pool_put (nm->signal_timed_event_data_pool, te);
1745 cpu_time_now = clib_cpu_time_now ();
1747 dispatch_suspended_process (vm, di, cpu_time_now);
1750 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1753 vlib_increment_main_loop_counter (vm);
1754 /* Record time stamp in case there are no enabled nodes and above
1755 calls do not update time stamp. */
1756 cpu_time_now = clib_cpu_time_now ();
1757 vm->loops_this_reporting_interval++;
1758 now = clib_time_now_internal (&vm->clib_time, cpu_time_now);
1759 /* Time to update loops_per_second? */
1760 if (PREDICT_FALSE (now >= vm->loop_interval_end))
1762 /* Next sample ends in 20ms */
1763 if (vm->loop_interval_start)
1765 f64 this_loops_per_second;
1767 this_loops_per_second =
1768 ((f64) vm->loops_this_reporting_interval) / (now -
1769 vm->loop_interval_start);
1771 vm->loops_per_second =
1772 vm->loops_per_second * vm->damping_constant +
1773 (1.0 - vm->damping_constant) * this_loops_per_second;
1774 if (vm->loops_per_second != 0.0)
1775 vm->seconds_per_loop = 1.0 / vm->loops_per_second;
1777 vm->seconds_per_loop = 0.0;
1779 /* New interval starts now, and ends in 20ms */
1780 vm->loop_interval_start = now;
1781 vm->loop_interval_end = now + 2e-4;
1782 vm->loops_this_reporting_interval = 0;
1788 vlib_main_loop (vlib_main_t * vm)
1790 vlib_main_or_worker_loop (vm, /* is_main */ 1);
1794 vlib_worker_loop (vlib_main_t * vm)
1796 vlib_main_or_worker_loop (vm, /* is_main */ 0);
1799 vlib_global_main_t vlib_global_main;
1802 vlib_add_del_post_mortem_callback (void *cb, int is_add)
1804 vlib_global_main_t *vgm = vlib_get_global_main ();
1809 for (i = vec_len (vgm->post_mortem_callbacks) - 1; i >= 0; i--)
1810 if (vgm->post_mortem_callbacks[i] == cb)
1811 vec_del1 (vgm->post_mortem_callbacks, i);
1815 for (i = 0; i < vec_len (vgm->post_mortem_callbacks); i++)
1816 if (vgm->post_mortem_callbacks[i] == cb)
1818 vec_add1 (vgm->post_mortem_callbacks, cb);
1822 elog_post_mortem_dump (void)
1824 elog_main_t *em = vlib_get_elog_main ();
1827 clib_error_t *error;
1829 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
1830 error = elog_write_file (em, (char *) filename, 1 /* flush ring */);
1832 clib_error_report (error);
1834 * We're in the middle of crashing. Don't try to free the filename.
1838 static clib_error_t *
1839 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1841 vlib_global_main_t *vgm = vlib_get_global_main ();
1842 int turn_on_mem_trace = 0;
1844 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1846 if (unformat (input, "memory-trace"))
1847 turn_on_mem_trace = 1;
1849 else if (unformat (input, "elog-events %d",
1850 &vgm->configured_elog_ring_size))
1851 vgm->configured_elog_ring_size =
1852 1 << max_log2 (vgm->configured_elog_ring_size);
1853 else if (unformat (input, "elog-post-mortem-dump"))
1854 vlib_add_del_post_mortem_callback (elog_post_mortem_dump,
1856 else if (unformat (input, "buffer-alloc-success-rate %f",
1857 &vm->buffer_alloc_success_rate))
1859 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
1860 return clib_error_return
1861 (0, "Buffer fault injection not configured");
1863 else if (unformat (input, "buffer-alloc-success-seed %u",
1864 &vm->buffer_alloc_success_seed))
1866 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
1867 return clib_error_return
1868 (0, "Buffer fault injection not configured");
1871 return unformat_parse_error (input);
1874 unformat_free (input);
1876 /* Enable memory trace as early as possible. */
1877 if (turn_on_mem_trace)
1883 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1886 placeholder_queue_signal_callback (vlib_main_t * vm)
1890 #define foreach_weak_reference_stub \
1891 _(vlib_map_stat_segment_init) \
1893 _(vlibmemory_init) \
1894 _(map_api_segment_init)
1897 clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
1898 clib_error_t *name (vlib_main_t *vm) { return 0; }
1899 foreach_weak_reference_stub;
1902 void vl_api_set_elog_main (elog_main_t * m) __attribute__ ((weak));
1904 vl_api_set_elog_main (elog_main_t * m)
1906 clib_warning ("STUB");
1909 int vl_api_set_elog_trace_api_messages (int enable) __attribute__ ((weak));
1911 vl_api_set_elog_trace_api_messages (int enable)
1913 clib_warning ("STUB");
1917 int vl_api_get_elog_trace_api_messages (void) __attribute__ ((weak));
1919 vl_api_get_elog_trace_api_messages (void)
1921 clib_warning ("STUB");
1925 /* Main function. */
1927 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
1929 vlib_global_main_t *vgm = vlib_get_global_main ();
1930 clib_error_t *volatile error;
1931 vlib_node_main_t *nm = &vm->node_main;
1933 vm->queue_signal_callback = placeholder_queue_signal_callback;
1935 /* Reconfigure event log which is enabled very early */
1936 if (vgm->configured_elog_ring_size &&
1937 vgm->configured_elog_ring_size != vgm->elog_main.event_ring_size)
1938 elog_resize (&vgm->elog_main, vgm->configured_elog_ring_size);
1939 vl_api_set_elog_main (vlib_get_elog_main ());
1940 (void) vl_api_set_elog_trace_api_messages (1);
1946 if ((error = vlib_physmem_init (vm)))
1948 clib_error_report (error);
1952 if ((error = vlib_map_stat_segment_init (vm)))
1954 clib_error_report (error);
1958 if ((error = vlib_buffer_main_init (vm)))
1960 clib_error_report (error);
1964 if ((error = vlib_thread_init (vm)))
1966 clib_error_report (error);
1970 /* Register node ifunction variants */
1971 vlib_register_all_node_march_variants (vm);
1973 /* Register static nodes so that init functions may use them. */
1974 vlib_register_all_static_nodes (vm);
1976 /* Set seed for random number generator.
1977 Allow user to specify seed to make random sequence deterministic. */
1978 if (!unformat (input, "seed %wd", &vm->random_seed))
1979 vm->random_seed = clib_cpu_time_now ();
1980 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
1982 /* Initialize node graph. */
1983 if ((error = vlib_node_main_init (vm)))
1985 /* Arrange for graph hook up error to not be fatal when debugging. */
1987 clib_error_report (error);
1992 /* Direct call / weak reference, for vlib standalone use-cases */
1993 if ((error = vpe_api_init (vm)))
1995 clib_error_report (error);
1999 if ((error = vlibmemory_init (vm)))
2001 clib_error_report (error);
2005 if ((error = map_api_segment_init (vm)))
2007 clib_error_report (error);
2011 /* See unix/main.c; most likely already set up */
2012 if (vgm->init_functions_called == 0)
2013 vgm->init_functions_called = hash_create (0, /* value bytes */ 0);
2014 if ((error = vlib_call_all_init_functions (vm)))
2017 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
2018 CLIB_CACHE_LINE_BYTES);
2020 vec_validate (nm->data_from_advancing_timing_wheel, 10);
2021 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
2023 /* Create the process timing wheel */
2024 TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
2025 0 /* no callback */ ,
2026 10e-6 /* timer period 10us */ ,
2027 ~0 /* max expirations per call */ );
2029 vec_validate (vm->pending_rpc_requests, 0);
2030 _vec_len (vm->pending_rpc_requests) = 0;
2031 vec_validate (vm->processing_rpc_requests, 0);
2032 _vec_len (vm->processing_rpc_requests) = 0;
2034 /* Default params for the buffer allocator fault injector, if configured */
2035 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0)
2037 vm->buffer_alloc_success_seed = 0xdeaddabe;
2038 vm->buffer_alloc_success_rate = 0.80;
2041 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
2045 * Use exponential smoothing, with a half-life of 1 second
2046 * reported_rate(t) = reported_rate(t-1) * K + rate(t)*(1-K)
2048 * Sample every 20ms, aka 50 samples per second
2049 * K = exp (-1.0/20.0);
2052 vm->damping_constant = exp (-1.0 / 20.0);
2054 /* Sort per-thread init functions before we start threads */
2055 vlib_sort_init_exit_functions (&vgm->worker_init_function_registrations);
2057 /* Call all main loop enter functions. */
2059 clib_error_t *sub_error;
2060 sub_error = vlib_call_all_main_loop_enter_functions (vm);
2062 clib_error_report (sub_error);
2065 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2067 case VLIB_MAIN_LOOP_EXIT_NONE:
2068 vm->main_loop_exit_set = 1;
2071 case VLIB_MAIN_LOOP_EXIT_CLI:
2075 error = vm->main_loop_error;
2079 vlib_main_loop (vm);
2082 vlib_worker_thread_barrier_sync (vm);
2083 /* Call all exit functions. */
2085 clib_error_t *sub_error;
2086 sub_error = vlib_call_all_main_loop_exit_functions (vm);
2088 clib_error_report (sub_error);
2090 vlib_worker_thread_barrier_release (vm);
2093 clib_error_report (error);
2099 vlib_get_main_not_inline (void)
2101 return vlib_get_main ();
2105 vlib_get_elog_main_not_inline ()
2107 return &vlib_global_main.elog_main;
2111 * fd.io coding-style-patch-verification: ON
2114 * eval: (c-set-style "gnu")