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>
47 #include <vlib/unix/cj.h>
49 CJ_GLOBAL_LOG_PROTOTYPE;
51 /* Actually allocate a few extra slots of vector data to support
52 speculative vector enqueues which overflow vector data in next frame. */
53 #define VLIB_FRAME_SIZE_ALLOC (VLIB_FRAME_SIZE + 4)
58 vlib_frame_bytes (u32 n_scalar_bytes, u32 n_vector_bytes)
62 /* Make room for vlib_frame_t plus scalar arguments. */
63 n_bytes = vlib_frame_vector_byte_offset (n_scalar_bytes);
65 /* Make room for vector arguments.
66 Allocate a few extra slots of vector data to support
67 speculative vector enqueues which overflow vector data in next frame. */
68 #define VLIB_FRAME_SIZE_EXTRA 4
69 n_bytes += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * n_vector_bytes;
71 /* Magic number is first 32bit number after vector data.
72 Used to make sure that vector data is never overrun. */
73 #define VLIB_FRAME_MAGIC (0xabadc0ed)
74 n_bytes += sizeof (u32);
76 /* Pad to cache line. */
77 n_bytes = round_pow2 (n_bytes, CLIB_CACHE_LINE_BYTES);
83 vlib_frame_find_magic (vlib_frame_t * f, vlib_node_t * node)
87 p += vlib_frame_vector_byte_offset (node->scalar_size);
89 p += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * node->vector_size;
94 static vlib_frame_size_t *
95 get_frame_size_info (vlib_node_main_t * nm,
96 u32 n_scalar_bytes, u32 n_vector_bytes)
98 uword key = (n_scalar_bytes << 16) | n_vector_bytes;
101 p = hash_get (nm->frame_size_hash, key);
106 i = vec_len (nm->frame_sizes);
107 vec_validate (nm->frame_sizes, i);
108 hash_set (nm->frame_size_hash, key, i);
111 return vec_elt_at_index (nm->frame_sizes, i);
115 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
118 vlib_node_main_t *nm = &vm->node_main;
119 vlib_frame_size_t *fs;
120 vlib_node_t *to_node;
122 u32 fi, l, n, scalar_size, vector_size;
124 to_node = vlib_get_node (vm, to_node_index);
126 scalar_size = to_node->scalar_size;
127 vector_size = to_node->vector_size;
129 fs = get_frame_size_info (nm, scalar_size, vector_size);
130 n = vlib_frame_bytes (scalar_size, vector_size);
131 if ((l = vec_len (fs->free_frame_indices)) > 0)
133 /* Allocate from end of free list. */
134 fi = fs->free_frame_indices[l - 1];
135 f = vlib_get_frame_no_check (vm, fi);
136 _vec_len (fs->free_frame_indices) = l - 1;
140 f = clib_mem_alloc_aligned_no_fail (n, VLIB_FRAME_ALIGN);
141 fi = vlib_frame_index_no_check (vm, f);
144 /* Poison frame when debugging. */
146 clib_memset (f, 0xfe, n);
148 /* Insert magic number. */
152 magic = vlib_frame_find_magic (f, to_node);
153 *magic = VLIB_FRAME_MAGIC;
156 f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
158 f->scalar_size = scalar_size;
159 f->vector_size = vector_size;
162 fs->n_alloc_frames += 1;
167 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
168 Returns frame index. */
170 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
173 vlib_node_t *from_node;
175 from_node = vlib_get_node (vm, from_node_runtime->node_index);
176 ASSERT (to_next_index < vec_len (from_node->next_nodes));
178 return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
179 /* frame_flags */ 0);
183 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
185 u32 fi = vlib_frame_alloc_to_node (vm, to_node_index,
187 VLIB_FRAME_FREE_AFTER_DISPATCH);
188 return vlib_get_frame (vm, fi);
192 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
194 vlib_pending_frame_t *p;
195 vlib_node_t *to_node;
197 if (f->n_vectors == 0)
200 to_node = vlib_get_node (vm, to_node_index);
202 vec_add2 (vm->node_main.pending_frames, p, 1);
204 f->frame_flags |= VLIB_FRAME_PENDING;
205 p->frame_index = vlib_frame_index (vm, f);
206 p->node_runtime_index = to_node->runtime_index;
207 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
210 /* Free given frame. */
212 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
214 vlib_node_main_t *nm = &vm->node_main;
216 vlib_frame_size_t *fs;
219 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
221 node = vlib_get_node (vm, r->node_index);
222 fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
224 frame_index = vlib_frame_index (vm, f);
226 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
228 /* No next frames may point to freed frame. */
231 vlib_next_frame_t *nf;
232 vec_foreach (nf, vm->node_main.next_frames)
233 ASSERT (nf->frame_index != frame_index);
236 f->frame_flags &= ~VLIB_FRAME_IS_ALLOCATED;
238 vec_add1 (fs->free_frame_indices, frame_index);
239 ASSERT (fs->n_alloc_frames > 0);
240 fs->n_alloc_frames -= 1;
243 static clib_error_t *
244 show_frame_stats (vlib_main_t * vm,
245 unformat_input_t * input, vlib_cli_command_t * cmd)
247 vlib_node_main_t *nm = &vm->node_main;
248 vlib_frame_size_t *fs;
250 vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
251 vec_foreach (fs, nm->frame_sizes)
253 u32 n_alloc = fs->n_alloc_frames;
254 u32 n_free = vec_len (fs->free_frame_indices);
256 if (n_alloc + n_free > 0)
257 vlib_cli_output (vm, "%=6d%=12d%=12d",
258 fs - nm->frame_sizes, n_alloc, n_free);
265 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
266 .path = "show vlib frame-allocation",
267 .short_help = "Show node dispatch frame statistics",
268 .function = show_frame_stats,
272 /* Change ownership of enqueue rights to given next node. */
274 vlib_next_frame_change_ownership (vlib_main_t * vm,
275 vlib_node_runtime_t * node_runtime,
278 vlib_node_main_t *nm = &vm->node_main;
279 vlib_next_frame_t *next_frame;
280 vlib_node_t *node, *next_node;
282 node = vec_elt (nm->nodes, node_runtime->node_index);
284 /* Only internal & input nodes are allowed to call other nodes. */
285 ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
286 || node->type == VLIB_NODE_TYPE_INPUT
287 || node->type == VLIB_NODE_TYPE_PROCESS);
289 ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
292 vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
293 next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
295 if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
297 /* Get frame from previous owner. */
298 vlib_next_frame_t *owner_next_frame;
299 vlib_next_frame_t tmp;
302 vlib_node_get_next_frame (vm,
303 next_node->owner_node_index,
304 next_node->owner_next_index);
306 /* Swap target next frame with owner's. */
307 tmp = owner_next_frame[0];
308 owner_next_frame[0] = next_frame[0];
312 * If next_frame is already pending, we have to track down
313 * all pending frames and fix their next_frame_index fields.
315 if (next_frame->flags & VLIB_FRAME_PENDING)
317 vlib_pending_frame_t *p;
318 if (next_frame->frame_index != ~0)
320 vec_foreach (p, nm->pending_frames)
322 if (p->frame_index == next_frame->frame_index)
324 p->next_frame_index =
325 next_frame - vm->node_main.next_frames;
333 /* No previous owner. Take ownership. */
334 next_frame->flags |= VLIB_FRAME_OWNER;
337 /* Record new owner. */
338 next_node->owner_node_index = node->index;
339 next_node->owner_next_index = next_index;
341 /* Now we should be owner. */
342 ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
345 /* Make sure that magic number is still there.
346 Otherwise, it is likely that caller has overrun frame arguments. */
348 validate_frame_magic (vlib_main_t * vm,
349 vlib_frame_t * f, vlib_node_t * n, uword next_index)
351 vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
352 u32 *magic = vlib_frame_find_magic (f, next_node);
353 ASSERT (VLIB_FRAME_MAGIC == magic[0]);
357 vlib_get_next_frame_internal (vlib_main_t * vm,
358 vlib_node_runtime_t * node,
359 u32 next_index, u32 allocate_new_next_frame)
362 vlib_next_frame_t *nf;
365 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
367 /* Make sure this next frame owns right to enqueue to destination frame. */
368 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
369 vlib_next_frame_change_ownership (vm, node, next_index);
371 /* ??? Don't need valid flag: can use frame_index == ~0 */
372 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
374 nf->frame_index = vlib_frame_alloc (vm, node, next_index);
375 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
378 f = vlib_get_frame (vm, nf->frame_index);
380 /* Has frame been removed from pending vector (e.g. finished dispatching)?
381 If so we can reuse frame. */
382 if ((nf->flags & VLIB_FRAME_PENDING)
383 && !(f->frame_flags & VLIB_FRAME_PENDING))
385 nf->flags &= ~VLIB_FRAME_PENDING;
390 /* Allocate new frame if current one is already full. */
391 n_used = f->n_vectors;
392 if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0))
394 /* Old frame may need to be freed after dispatch, since we'll have
395 two redundant frames from node -> next node. */
396 if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
398 vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame_index);
399 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
402 /* Allocate new frame to replace full one. */
403 nf->frame_index = vlib_frame_alloc (vm, node, next_index);
404 f = vlib_get_frame (vm, nf->frame_index);
405 n_used = f->n_vectors;
408 /* Should have free vectors in frame now. */
409 ASSERT (n_used < VLIB_FRAME_SIZE);
413 validate_frame_magic (vm, f,
414 vlib_get_node (vm, node->node_index), next_index);
421 vlib_put_next_frame_validate (vlib_main_t * vm,
422 vlib_node_runtime_t * rt,
423 u32 next_index, u32 n_vectors_left)
425 vlib_node_main_t *nm = &vm->node_main;
426 vlib_next_frame_t *nf;
428 vlib_node_runtime_t *next_rt;
429 vlib_node_t *next_node;
430 u32 n_before, n_after;
432 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
433 f = vlib_get_frame (vm, nf->frame_index);
435 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
436 n_after = VLIB_FRAME_SIZE - n_vectors_left;
437 n_before = f->n_vectors;
439 ASSERT (n_after >= n_before);
441 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
442 nf->node_runtime_index);
443 next_node = vlib_get_node (vm, next_rt->node_index);
444 if (n_after > 0 && next_node->validate_frame)
446 u8 *msg = next_node->validate_frame (vm, rt, f);
449 clib_warning ("%v", msg);
457 vlib_put_next_frame (vlib_main_t * vm,
458 vlib_node_runtime_t * r,
459 u32 next_index, u32 n_vectors_left)
461 vlib_node_main_t *nm = &vm->node_main;
462 vlib_next_frame_t *nf;
464 u32 n_vectors_in_frame;
466 if (vm->buffer_main->callbacks_registered == 0 && CLIB_DEBUG > 0)
467 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
469 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
470 f = vlib_get_frame (vm, nf->frame_index);
472 /* Make sure that magic number is still there. Otherwise, caller
473 has overrun frame meta data. */
476 vlib_node_t *node = vlib_get_node (vm, r->node_index);
477 validate_frame_magic (vm, f, node, next_index);
480 /* Convert # of vectors left -> number of vectors there. */
481 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
482 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
484 f->n_vectors = n_vectors_in_frame;
486 /* If vectors were added to frame, add to pending vector. */
487 if (PREDICT_TRUE (n_vectors_in_frame > 0))
489 vlib_pending_frame_t *p;
492 r->cached_next_index = next_index;
494 if (!(f->frame_flags & VLIB_FRAME_PENDING))
496 __attribute__ ((unused)) vlib_node_t *node;
497 vlib_node_t *next_node;
498 vlib_node_runtime_t *next_runtime;
500 node = vlib_get_node (vm, r->node_index);
501 next_node = vlib_get_next_node (vm, r->node_index, next_index);
502 next_runtime = vlib_node_get_runtime (vm, next_node->index);
504 vec_add2 (nm->pending_frames, p, 1);
506 p->frame_index = nf->frame_index;
507 p->node_runtime_index = nf->node_runtime_index;
508 p->next_frame_index = nf - nm->next_frames;
509 nf->flags |= VLIB_FRAME_PENDING;
510 f->frame_flags |= VLIB_FRAME_PENDING;
513 * If we're going to dispatch this frame on another thread,
514 * force allocation of a new frame. Otherwise, we create
515 * a dangling frame reference. Each thread has its own copy of
516 * the next_frames vector.
518 if (0 && r->thread_index != next_runtime->thread_index)
520 nf->frame_index = ~0;
521 nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
525 /* Copy trace flag from next_frame and from runtime. */
527 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
528 flags & VLIB_NODE_FLAG_TRACE);
530 v0 = nf->vectors_since_last_overflow;
531 v1 = v0 + n_vectors_in_frame;
532 nf->vectors_since_last_overflow = v1;
533 if (PREDICT_FALSE (v1 < v0))
535 vlib_node_t *node = vlib_get_node (vm, r->node_index);
536 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
541 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
543 vlib_node_runtime_sync_stats (vlib_main_t * vm,
544 vlib_node_runtime_t * r,
545 uword n_calls, uword n_vectors, uword n_clocks,
548 vlib_node_t *n = vlib_get_node (vm, r->node_index);
550 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
551 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
552 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
553 n->stats_total.perf_counter_ticks += n_ticks +
554 r->perf_counter_ticks_since_last_overflow;
555 n->stats_total.perf_counter_vectors += n_vectors +
556 r->perf_counter_vectors_since_last_overflow;
557 n->stats_total.max_clock = r->max_clock;
558 n->stats_total.max_clock_n = r->max_clock_n;
560 r->calls_since_last_overflow = 0;
561 r->vectors_since_last_overflow = 0;
562 r->clocks_since_last_overflow = 0;
563 r->perf_counter_ticks_since_last_overflow = 0ULL;
564 r->perf_counter_vectors_since_last_overflow = 0ULL;
567 always_inline void __attribute__ ((unused))
568 vlib_process_sync_stats (vlib_main_t * vm,
570 uword n_calls, uword n_vectors, uword n_clocks,
573 vlib_node_runtime_t *rt = &p->node_runtime;
574 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
575 vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks,
577 n->stats_total.suspends += p->n_suspends;
582 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
584 vlib_node_runtime_t *rt;
586 if (n->type == VLIB_NODE_TYPE_PROCESS)
588 /* Nothing to do for PROCESS nodes except in main thread */
589 if (vm != &vlib_global_main)
592 vlib_process_t *p = vlib_get_process_from_node (vm, n);
593 n->stats_total.suspends += p->n_suspends;
595 rt = &p->node_runtime;
599 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
602 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0, 0);
604 /* Sync up runtime next frame vector counters with main node structure. */
606 vlib_next_frame_t *nf;
608 for (i = 0; i < rt->n_next_nodes; i++)
610 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
611 vec_elt (n->n_vectors_by_next_node, i) +=
612 nf->vectors_since_last_overflow;
613 nf->vectors_since_last_overflow = 0;
619 vlib_node_runtime_update_stats (vlib_main_t * vm,
620 vlib_node_runtime_t * node,
622 uword n_vectors, uword n_clocks,
625 u32 ca0, ca1, v0, v1, cl0, cl1, r;
626 u32 ptick0, ptick1, pvec0, pvec1;
628 cl0 = cl1 = node->clocks_since_last_overflow;
629 ca0 = ca1 = node->calls_since_last_overflow;
630 v0 = v1 = node->vectors_since_last_overflow;
631 ptick0 = ptick1 = node->perf_counter_ticks_since_last_overflow;
632 pvec0 = pvec1 = node->perf_counter_vectors_since_last_overflow;
636 cl1 = cl0 + n_clocks;
637 ptick1 = ptick0 + n_ticks;
638 pvec1 = pvec0 + n_vectors;
640 node->calls_since_last_overflow = ca1;
641 node->clocks_since_last_overflow = cl1;
642 node->vectors_since_last_overflow = v1;
643 node->perf_counter_ticks_since_last_overflow = ptick1;
644 node->perf_counter_vectors_since_last_overflow = pvec1;
646 node->max_clock_n = node->max_clock > n_clocks ?
647 node->max_clock_n : n_vectors;
648 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
650 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
652 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0) || (ptick1 < ptick0)
655 node->calls_since_last_overflow = ca0;
656 node->clocks_since_last_overflow = cl0;
657 node->vectors_since_last_overflow = v0;
658 node->perf_counter_ticks_since_last_overflow = ptick0;
659 node->perf_counter_vectors_since_last_overflow = pvec0;
661 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks,
669 vlib_node_runtime_perf_counter (vlib_main_t * vm)
671 if (PREDICT_FALSE (vm->vlib_node_runtime_perf_counter_cb != 0))
672 return ((*vm->vlib_node_runtime_perf_counter_cb) (vm));
677 vlib_process_update_stats (vlib_main_t * vm,
679 uword n_calls, uword n_vectors, uword n_clocks,
682 vlib_node_runtime_update_stats (vm, &p->node_runtime,
683 n_calls, n_vectors, n_clocks, n_ticks);
686 static clib_error_t *
687 vlib_cli_elog_clear (vlib_main_t * vm,
688 unformat_input_t * input, vlib_cli_command_t * cmd)
690 elog_reset_buffer (&vm->elog_main);
695 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
696 .path = "event-logger clear",
697 .short_help = "Clear the event log",
698 .function = vlib_cli_elog_clear,
703 static clib_error_t *
704 elog_save_buffer (vlib_main_t * vm,
705 unformat_input_t * input, vlib_cli_command_t * cmd)
707 elog_main_t *em = &vm->elog_main;
708 char *file, *chroot_file;
709 clib_error_t *error = 0;
711 if (!unformat (input, "%s", &file))
713 vlib_cli_output (vm, "expected file name, got `%U'",
714 format_unformat_error, input);
718 /* It's fairly hard to get "../oopsie" through unformat; just in case */
719 if (strstr (file, "..") || index (file, '/'))
721 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
725 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
729 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
730 elog_n_events_in_buffer (em),
731 elog_buffer_capacity (em), chroot_file);
733 vlib_worker_thread_barrier_sync (vm);
734 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
735 vlib_worker_thread_barrier_release (vm);
736 vec_free (chroot_file);
741 elog_post_mortem_dump (void)
743 vlib_main_t *vm = &vlib_global_main;
744 elog_main_t *em = &vm->elog_main;
748 if (!vm->elog_post_mortem_dump)
751 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
752 error = elog_write_file (em, (char *) filename, 1 /* flush ring */ );
754 clib_error_report (error);
759 VLIB_CLI_COMMAND (elog_save_cli, static) = {
760 .path = "event-logger save",
761 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
762 .function = elog_save_buffer,
766 static clib_error_t *
767 elog_stop (vlib_main_t * vm,
768 unformat_input_t * input, vlib_cli_command_t * cmd)
770 elog_main_t *em = &vm->elog_main;
772 em->n_total_events_disable_limit = em->n_total_events;
774 vlib_cli_output (vm, "Stopped the event logger...");
779 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
780 .path = "event-logger stop",
781 .short_help = "Stop the event-logger",
782 .function = elog_stop,
786 static clib_error_t *
787 elog_restart (vlib_main_t * vm,
788 unformat_input_t * input, vlib_cli_command_t * cmd)
790 elog_main_t *em = &vm->elog_main;
792 em->n_total_events_disable_limit = ~0;
794 vlib_cli_output (vm, "Restarted the event logger...");
799 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
800 .path = "event-logger restart",
801 .short_help = "Restart the event-logger",
802 .function = elog_restart,
806 static clib_error_t *
807 elog_resize (vlib_main_t * vm,
808 unformat_input_t * input, vlib_cli_command_t * cmd)
810 elog_main_t *em = &vm->elog_main;
813 /* Stop the parade */
814 elog_reset_buffer (&vm->elog_main);
816 if (unformat (input, "%d", &tmp))
818 elog_alloc (em, tmp);
819 em->n_total_events_disable_limit = ~0;
822 return clib_error_return (0, "Must specify how many events in the ring");
824 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
829 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
830 .path = "event-logger resize",
831 .short_help = "event-logger resize <nnn>",
832 .function = elog_resize,
836 #endif /* CLIB_UNIX */
839 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
841 elog_main_t *em = &vm->elog_main;
842 elog_event_t *e, *es;
845 /* Show events in VLIB time since log clock starts after VLIB clock. */
846 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
847 * vm->clib_time.seconds_per_clock;
849 es = elog_peek_events (em);
850 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
852 em->n_total_events < em->n_total_events_disable_limit ?
853 "running" : "stopped");
856 vlib_cli_output (vm, "%18.9f: %U",
857 e->time + dt, format_elog_event, em, e);
859 if (n_events_to_show == 0)
866 static clib_error_t *
867 elog_show_buffer (vlib_main_t * vm,
868 unformat_input_t * input, vlib_cli_command_t * cmd)
870 u32 n_events_to_show;
871 clib_error_t *error = 0;
873 n_events_to_show = 250;
874 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
876 if (unformat (input, "%d", &n_events_to_show))
878 else if (unformat (input, "all"))
879 n_events_to_show = ~0;
881 return unformat_parse_error (input);
883 elog_show_buffer_internal (vm, n_events_to_show);
888 VLIB_CLI_COMMAND (elog_show_cli, static) = {
889 .path = "show event-logger",
890 .short_help = "Show event logger info",
891 .function = elog_show_buffer,
896 vlib_gdb_show_event_log (void)
898 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
902 vlib_elog_main_loop_event (vlib_main_t * vm,
904 u64 time, u32 n_vectors, u32 is_return)
906 vlib_main_t *evm = &vlib_global_main;
907 elog_main_t *em = &evm->elog_main;
909 if (VLIB_ELOG_MAIN_LOOP && n_vectors)
912 vec_elt_at_index (is_return
913 ? evm->node_return_elog_event_types
914 : evm->node_call_elog_event_types,
917 (vm->thread_index ? &vlib_worker_threads[vm->thread_index].
918 elog_track : &em->default_track),
919 /* data to log */ n_vectors);
922 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
923 void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 node_index);
924 void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
927 vlib_buffer_trace_trajectory_init (vlib_buffer_t * b)
929 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_init_cb != 0))
931 (*vlib_buffer_trace_trajectory_init_cb) (b);
938 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
940 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
941 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_cb != 0))
943 (*vlib_buffer_trace_trajectory_cb) (b, node_index);
948 u8 *format_vnet_buffer_flags (u8 * s, va_list * args) __attribute__ ((weak));
950 format_vnet_buffer_flags (u8 * s, va_list * args)
952 s = format (s, "BUG STUB %s", __FUNCTION__);
956 u8 *format_vnet_buffer_opaque (u8 * s, va_list * args) __attribute__ ((weak));
958 format_vnet_buffer_opaque (u8 * s, va_list * args)
960 s = format (s, "BUG STUB %s", __FUNCTION__);
964 u8 *format_vnet_buffer_opaque2 (u8 * s, va_list * args)
965 __attribute__ ((weak));
967 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
969 s = format (s, "BUG STUB %s", __FUNCTION__);
974 format_buffer_metadata (u8 * s, va_list * args)
976 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
978 s = format (s, "flags: %U\n", format_vnet_buffer_flags, b);
979 s = format (s, "current_data: %d, current_length: %d\n",
980 (i32) (b->current_data), (i32) (b->current_length));
981 s = format (s, "current_config_index: %d, flow_id: %x, next_buffer: %x\n",
982 b->current_config_index, b->flow_id, b->next_buffer);
983 s = format (s, "error: %d, n_add_refs: %d, buffer_pool_index: %d\n",
984 (u32) (b->error), (u32) (b->n_add_refs),
985 (u32) (b->buffer_pool_index));
987 "trace_index: %d, len_not_first_buf: %d\n",
988 b->trace_index, b->total_length_not_including_first_buffer);
992 #define A(x) vec_add1(vm->pcap_buffer, (x))
995 dispatch_pcap_trace (vlib_main_t * vm,
996 vlib_node_runtime_t * node, vlib_frame_t * frame)
999 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **bufp, *b;
1000 pcap_main_t *pm = &vm->dispatch_pcap_main;
1001 vlib_trace_main_t *tm = &vm->trace_main;
1005 f64 time_now = vlib_time_now (vm);
1010 /* Input nodes don't have frames yet */
1011 if (frame == 0 || frame->n_vectors == 0)
1014 from = vlib_frame_vector_args (frame);
1015 vlib_get_buffers (vm, from, bufs, frame->n_vectors);
1018 n = vlib_get_node (vm, node->node_index);
1020 for (i = 0; i < frame->n_vectors; i++)
1022 if (PREDICT_TRUE (pm->n_packets_captured < pm->n_packets_to_capture))
1026 vec_reset_length (vm->pcap_buffer);
1029 /* Version, flags */
1030 A ((u8) VLIB_PCAP_MAJOR_VERSION);
1031 A ((u8) VLIB_PCAP_MINOR_VERSION);
1032 A (0 /* string_count */ );
1033 A (n->protocol_hint);
1035 /* Buffer index (big endian) */
1036 A ((from[i] >> 24) & 0xff);
1037 A ((from[i] >> 16) & 0xff);
1038 A ((from[i] >> 8) & 0xff);
1039 A ((from[i] >> 0) & 0xff);
1041 /* Node name, NULL-terminated ASCII */
1042 vm->pcap_buffer = format (vm->pcap_buffer, "%v%c", n->name, 0);
1045 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1046 format_buffer_metadata, b, 0);
1048 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1049 format_vnet_buffer_opaque, b, 0);
1051 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1052 format_vnet_buffer_opaque2, b, 0);
1055 /* Is this packet traced? */
1056 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1058 vlib_trace_header_t **h
1059 = pool_elt_at_index (tm->trace_buffer_pool, b->trace_index);
1061 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1062 format_vlib_trace, vm, h[0], 0);
1066 /* Save the string count */
1067 vm->pcap_buffer[2] = string_count;
1069 /* Figure out how many bytes in the pcap trace */
1070 capture_size = vec_len (vm->pcap_buffer) +
1071 +vlib_buffer_length_in_chain (vm, b);
1073 clib_spinlock_lock_if_init (&pm->lock);
1074 n_left = clib_min (capture_size, 16384);
1075 d = pcap_add_packet (pm, time_now, n_left, capture_size);
1077 /* Copy the header */
1078 clib_memcpy_fast (d, vm->pcap_buffer, vec_len (vm->pcap_buffer));
1079 d += vec_len (vm->pcap_buffer);
1082 (vlib_buffer_length_in_chain (vm, b),
1083 (16384 - vec_len (vm->pcap_buffer)));
1084 /* Copy the packet data */
1087 u32 copy_length = clib_min ((u32) n_left, b->current_length);
1088 clib_memcpy_fast (d, b->data + b->current_data, copy_length);
1089 n_left -= b->current_length;
1092 d += b->current_length;
1093 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
1094 b = vlib_get_buffer (vm, b->next_buffer);
1096 clib_spinlock_unlock_if_init (&pm->lock);
1101 static_always_inline u64
1102 dispatch_node (vlib_main_t * vm,
1103 vlib_node_runtime_t * node,
1104 vlib_node_type_t type,
1105 vlib_node_state_t dispatch_state,
1106 vlib_frame_t * frame, u64 last_time_stamp)
1110 vlib_node_main_t *nm = &vm->node_main;
1111 vlib_next_frame_t *nf;
1115 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1116 ASSERT (n->type == type);
1119 /* Only non-internal nodes may be disabled. */
1120 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
1122 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
1123 return last_time_stamp;
1126 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
1127 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
1129 u32 c = node->input_main_loops_per_call;
1130 /* Only call node when count reaches zero. */
1133 node->input_main_loops_per_call = c - 1;
1134 return last_time_stamp;
1138 /* Speculatively prefetch next frames. */
1139 if (node->n_next_nodes > 0)
1141 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
1142 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
1145 vm->cpu_time_last_node_dispatch = last_time_stamp;
1147 if (1 /* || vm->thread_index == node->thread_index */ )
1149 u64 pmc_before, pmc_delta;
1151 vlib_elog_main_loop_event (vm, node->node_index,
1153 frame ? frame->n_vectors : 0,
1157 * To validate accounting: pmc_before = last_time_stamp
1158 * perf ticks should equal clocks/pkt...
1160 pmc_before = vlib_node_runtime_perf_counter (vm);
1163 * Turn this on if you run into
1164 * "bad monkey" contexts, and you want to know exactly
1165 * which nodes they've visited... See ixge.c...
1167 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
1171 from = vlib_frame_vector_args (frame);
1172 for (i = 0; i < frame->n_vectors; i++)
1174 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1175 add_trajectory_trace (b, node->node_index);
1177 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1178 dispatch_pcap_trace (vm, node, frame);
1179 n = node->function (vm, node, frame);
1183 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1184 dispatch_pcap_trace (vm, node, frame);
1185 n = node->function (vm, node, frame);
1188 t = clib_cpu_time_now ();
1191 * To validate accounting: pmc_delta = t - pmc_before;
1192 * perf ticks should equal clocks/pkt...
1194 pmc_delta = vlib_node_runtime_perf_counter (vm) - pmc_before;
1196 vlib_elog_main_loop_event (vm, node->node_index, t, n, /* is_after */
1199 vm->main_loop_vectors_processed += n;
1200 vm->main_loop_nodes_processed += n > 0;
1202 v = vlib_node_runtime_update_stats (vm, node,
1205 /* n_clocks */ t - last_time_stamp,
1206 pmc_delta /* PMC ticks */ );
1208 /* When in interrupt mode and vector rate crosses threshold switch to
1210 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1211 || (dispatch_state == VLIB_NODE_STATE_POLLING
1213 & VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE)))
1215 #ifdef DISPATCH_NODE_ELOG_REQUIRED
1216 ELOG_TYPE_DECLARE (e) =
1218 .function = (char *) __FUNCTION__,.format =
1219 "%s vector length %d, switching to %s",.format_args =
1220 "T4i4t4",.n_enum_strings = 2,.enum_strings =
1222 "interrupt", "polling",},};
1225 u32 node_name, vector_length, is_polling;
1227 vlib_worker_thread_t *w = vlib_worker_threads + vm->thread_index;
1230 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1231 && v >= nm->polling_threshold_vector_length) &&
1233 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1235 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1236 n->state = VLIB_NODE_STATE_POLLING;
1237 node->state = VLIB_NODE_STATE_POLLING;
1239 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1241 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1242 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1243 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1245 #ifdef DISPATCH_NODE_ELOG_REQUIRED
1246 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1248 ed->node_name = n->name_elog_string;
1249 ed->vector_length = v;
1253 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1254 && v <= nm->interrupt_threshold_vector_length)
1256 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1258 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1260 /* Switch to interrupt mode after dispatch in polling one more time.
1261 This allows driver to re-enable interrupts. */
1262 n->state = VLIB_NODE_STATE_INTERRUPT;
1263 node->state = VLIB_NODE_STATE_INTERRUPT;
1265 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1266 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -=
1268 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] +=
1275 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1276 #ifdef DISPATCH_NODE_ELOG_REQUIRED
1277 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1279 ed->node_name = n->name_elog_string;
1280 ed->vector_length = v;
1292 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1293 u64 last_time_stamp)
1295 vlib_node_main_t *nm = &vm->node_main;
1297 vlib_next_frame_t *nf, nf_dummy;
1298 vlib_node_runtime_t *n;
1299 u32 restore_frame_index;
1300 vlib_pending_frame_t *p;
1302 /* See comment below about dangling references to nm->pending_frames */
1303 p = nm->pending_frames + pending_frame_index;
1305 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1306 p->node_runtime_index);
1308 f = vlib_get_frame (vm, p->frame_index);
1309 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1311 /* No next frame: so use dummy on stack. */
1313 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1314 nf->frame_index = ~p->frame_index;
1317 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1319 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1321 /* Force allocation of new frame while current frame is being
1323 restore_frame_index = ~0;
1324 if (nf->frame_index == p->frame_index)
1326 nf->frame_index = ~0;
1327 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1328 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1329 restore_frame_index = p->frame_index;
1332 /* Frame must be pending. */
1333 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1334 ASSERT (f->n_vectors > 0);
1336 /* Copy trace flag from next frame to node.
1337 Trace flag indicates that at least one vector in the dispatched
1339 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1340 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1341 nf->flags &= ~VLIB_FRAME_TRACE;
1343 last_time_stamp = dispatch_node (vm, n,
1344 VLIB_NODE_TYPE_INTERNAL,
1345 VLIB_NODE_STATE_POLLING,
1346 f, last_time_stamp);
1348 f->frame_flags &= ~VLIB_FRAME_PENDING;
1350 /* Frame is ready to be used again, so restore it. */
1351 if (restore_frame_index != ~0)
1354 * We musn't restore a frame that is flagged to be freed. This
1355 * shouldn't happen since frames to be freed post dispatch are
1356 * those used when the to-node frame becomes full i.e. they form a
1357 * sort of queue of frames to a single node. If we get here then
1358 * the to-node frame and the pending frame *were* the same, and so
1359 * we removed the to-node frame. Therefore this frame is no
1360 * longer part of the queue for that node and hence it cannot be
1363 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1366 * NB: dispatching node n can result in the creation and scheduling
1367 * of new frames, and hence in the reallocation of nm->pending_frames.
1368 * Recompute p, or no supper. This was broken for more than 10 years.
1370 p = nm->pending_frames + pending_frame_index;
1373 * p->next_frame_index can change during node dispatch if node
1374 * function decides to change graph hook up.
1376 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1377 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1379 if (~0 == nf->frame_index)
1381 /* no new frame has been assigned to this node, use the saved one */
1382 nf->frame_index = restore_frame_index;
1387 /* The node has gained a frame, implying packets from the current frame
1388 were re-queued to this same node. we don't need the saved one
1390 vlib_frame_free (vm, n, f);
1395 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1397 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1398 vlib_frame_free (vm, n, f);
1402 return last_time_stamp;
1406 vlib_process_stack_is_valid (vlib_process_t * p)
1408 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1414 vlib_process_t *process;
1415 vlib_frame_t *frame;
1416 } vlib_process_bootstrap_args_t;
1418 /* Called in process stack. */
1420 vlib_process_bootstrap (uword _a)
1422 vlib_process_bootstrap_args_t *a;
1424 vlib_node_runtime_t *node;
1429 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1434 node = &p->node_runtime;
1436 n = node->function (vm, node, f);
1438 ASSERT (vlib_process_stack_is_valid (p));
1440 clib_longjmp (&p->return_longjmp, n);
1445 /* Called in main stack. */
1446 static_always_inline uword
1447 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1449 vlib_process_bootstrap_args_t a;
1456 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1457 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1458 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1459 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1464 static_always_inline uword
1465 vlib_process_resume (vlib_process_t * p)
1468 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1469 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1470 | VLIB_PROCESS_RESUME_PENDING);
1471 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1472 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1473 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1478 dispatch_process (vlib_main_t * vm,
1479 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1481 vlib_node_main_t *nm = &vm->node_main;
1482 vlib_node_runtime_t *node_runtime = &p->node_runtime;
1483 vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1484 u32 old_process_index;
1486 uword n_vectors, is_suspend;
1488 if (node->state != VLIB_NODE_STATE_POLLING
1489 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1490 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1491 return last_time_stamp;
1493 p->flags |= VLIB_PROCESS_IS_RUNNING;
1495 t = last_time_stamp;
1496 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1497 f ? f->n_vectors : 0, /* is_after */ 0);
1499 /* Save away current process for suspend. */
1500 old_process_index = nm->current_process_index;
1501 nm->current_process_index = node->runtime_index;
1503 n_vectors = vlib_process_startup (vm, p, f);
1505 nm->current_process_index = old_process_index;
1507 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1508 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1511 vlib_pending_frame_t *pf;
1514 pool_get (nm->suspended_process_frames, pf);
1515 pf->node_runtime_index = node->runtime_index;
1516 pf->frame_index = f ? vlib_frame_index (vm, f) : ~0;
1517 pf->next_frame_index = ~0;
1520 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1522 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1524 TWT (tw_timer_wheel) * tw =
1525 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1526 p->stop_timer_handle =
1527 TW (tw_timer_start) (tw,
1528 vlib_timing_wheel_data_set_suspended_process
1529 (node->runtime_index) /* [sic] pool idex */ ,
1531 p->resume_clock_interval);
1535 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1537 t = clib_cpu_time_now ();
1539 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1542 vlib_process_update_stats (vm, p,
1543 /* n_calls */ !is_suspend,
1544 /* n_vectors */ n_vectors,
1545 /* n_clocks */ t - last_time_stamp,
1546 /* pmc_ticks */ 0ULL);
1552 vlib_start_process (vlib_main_t * vm, uword process_index)
1554 vlib_node_main_t *nm = &vm->node_main;
1555 vlib_process_t *p = vec_elt (nm->processes, process_index);
1556 dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1560 dispatch_suspended_process (vlib_main_t * vm,
1561 uword process_index, u64 last_time_stamp)
1563 vlib_node_main_t *nm = &vm->node_main;
1564 vlib_node_runtime_t *node_runtime;
1568 vlib_pending_frame_t *pf;
1569 u64 t, n_vectors, is_suspend;
1571 t = last_time_stamp;
1573 p = vec_elt (nm->processes, process_index);
1574 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1575 return last_time_stamp;
1577 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1578 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1580 pf = pool_elt_at_index (nm->suspended_process_frames,
1581 p->suspended_process_frame_index);
1583 node_runtime = &p->node_runtime;
1584 node = vlib_get_node (vm, node_runtime->node_index);
1585 f = pf->frame_index != ~0 ? vlib_get_frame (vm, pf->frame_index) : 0;
1587 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1588 f ? f->n_vectors : 0, /* is_after */ 0);
1590 /* Save away current process for suspend. */
1591 nm->current_process_index = node->runtime_index;
1593 n_vectors = vlib_process_resume (p);
1594 t = clib_cpu_time_now ();
1596 nm->current_process_index = ~0;
1598 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1601 /* Suspend it again. */
1604 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1606 p->stop_timer_handle =
1607 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1608 vlib_timing_wheel_data_set_suspended_process
1609 (node->runtime_index) /* [sic] pool idex */ ,
1611 p->resume_clock_interval);
1616 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1617 pool_put_index (nm->suspended_process_frames,
1618 p->suspended_process_frame_index);
1619 p->suspended_process_frame_index = ~0;
1622 t = clib_cpu_time_now ();
1623 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1626 vlib_process_update_stats (vm, p,
1627 /* n_calls */ !is_suspend,
1628 /* n_vectors */ n_vectors,
1629 /* n_clocks */ t - last_time_stamp,
1630 /* pmc_ticks */ 0ULL);
1635 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1637 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1642 static_always_inline void
1643 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1645 vlib_node_main_t *nm = &vm->node_main;
1646 vlib_thread_main_t *tm = vlib_get_thread_main ();
1649 vlib_frame_queue_main_t *fqm;
1650 u32 *last_node_runtime_indices = 0;
1652 /* Initialize pending node vector. */
1655 vec_resize (nm->pending_frames, 32);
1656 _vec_len (nm->pending_frames) = 0;
1659 /* Mark time of main loop start. */
1662 cpu_time_now = vm->clib_time.last_cpu_time;
1663 vm->cpu_time_main_loop_start = cpu_time_now;
1666 cpu_time_now = clib_cpu_time_now ();
1668 /* Pre-allocate interupt runtime indices and lock. */
1669 vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1670 vec_alloc (last_node_runtime_indices, 32);
1672 clib_spinlock_init (&nm->pending_interrupt_lock);
1674 /* Pre-allocate expired nodes. */
1675 if (!nm->polling_threshold_vector_length)
1676 nm->polling_threshold_vector_length = 10;
1677 if (!nm->interrupt_threshold_vector_length)
1678 nm->interrupt_threshold_vector_length = 5;
1680 /* Make sure the performance monitor counter is disabled */
1681 vm->perf_counter_id = ~0;
1683 /* Start all processes. */
1687 nm->current_process_index = ~0;
1688 for (i = 0; i < vec_len (nm->processes); i++)
1689 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1695 vlib_node_runtime_t *n;
1697 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1700 vl_api_send_pending_rpc_requests (vm);
1705 vlib_worker_thread_barrier_check ();
1706 vec_foreach (fqm, tm->frame_queue_mains)
1707 vlib_frame_queue_dequeue (vm, fqm);
1708 if (PREDICT_FALSE (vm->worker_thread_main_loop_callback != 0))
1709 ((void (*)(vlib_main_t *)) vm->worker_thread_main_loop_callback)
1713 /* Process pre-input nodes. */
1714 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1715 cpu_time_now = dispatch_node (vm, n,
1716 VLIB_NODE_TYPE_PRE_INPUT,
1717 VLIB_NODE_STATE_POLLING,
1721 /* Next process input nodes. */
1722 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1723 cpu_time_now = dispatch_node (vm, n,
1724 VLIB_NODE_TYPE_INPUT,
1725 VLIB_NODE_STATE_POLLING,
1729 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1730 vm->queue_signal_callback (vm);
1732 /* Next handle interrupts. */
1734 /* unlocked read, for performance */
1735 uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1737 if (PREDICT_FALSE (l > 0))
1742 clib_spinlock_lock (&nm->pending_interrupt_lock);
1743 /* Re-read w/ lock held, in case another thread added an item */
1744 l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1747 tmp = nm->pending_interrupt_node_runtime_indices;
1748 nm->pending_interrupt_node_runtime_indices =
1749 last_node_runtime_indices;
1750 last_node_runtime_indices = tmp;
1751 _vec_len (last_node_runtime_indices) = 0;
1753 clib_spinlock_unlock (&nm->pending_interrupt_lock);
1754 for (i = 0; i < l; i++)
1756 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1757 last_node_runtime_indices[i]);
1759 dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1760 VLIB_NODE_STATE_INTERRUPT,
1766 /* Input nodes may have added work to the pending vector.
1767 Process pending vector until there is nothing left.
1768 All pending vectors will be processed from input -> output. */
1769 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1770 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1771 /* Reset pending vector for next iteration. */
1772 _vec_len (nm->pending_frames) = 0;
1776 /* Check if process nodes have expired from timing wheel. */
1777 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1779 nm->data_from_advancing_timing_wheel =
1780 TW (tw_timer_expire_timers_vec)
1781 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1782 nm->data_from_advancing_timing_wheel);
1784 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1787 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1791 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1794 u32 d = nm->data_from_advancing_timing_wheel[i];
1795 u32 di = vlib_timing_wheel_data_get_index (d);
1797 if (vlib_timing_wheel_data_is_timed_event (d))
1799 vlib_signal_timed_event_data_t *te =
1800 pool_elt_at_index (nm->signal_timed_event_data_pool,
1803 vlib_get_node (vm, te->process_node_index);
1805 vec_elt (nm->processes, n->runtime_index);
1808 vlib_process_signal_event_helper (nm, n, p,
1809 te->event_type_index,
1811 te->n_data_elt_bytes);
1812 if (te->n_data_bytes < sizeof (te->inline_event_data))
1813 clib_memcpy_fast (data, te->inline_event_data,
1817 clib_memcpy_fast (data, te->event_data_as_vector,
1819 vec_free (te->event_data_as_vector);
1821 pool_put (nm->signal_timed_event_data_pool, te);
1825 cpu_time_now = clib_cpu_time_now ();
1827 dispatch_suspended_process (vm, di, cpu_time_now);
1830 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1833 vlib_increment_main_loop_counter (vm);
1835 /* Record time stamp in case there are no enabled nodes and above
1836 calls do not update time stamp. */
1837 cpu_time_now = clib_cpu_time_now ();
1842 vlib_main_loop (vlib_main_t * vm)
1844 vlib_main_or_worker_loop (vm, /* is_main */ 1);
1848 vlib_worker_loop (vlib_main_t * vm)
1850 vlib_main_or_worker_loop (vm, /* is_main */ 0);
1853 vlib_main_t vlib_global_main;
1855 static clib_error_t *
1856 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1858 int turn_on_mem_trace = 0;
1860 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1862 if (unformat (input, "memory-trace"))
1863 turn_on_mem_trace = 1;
1865 else if (unformat (input, "elog-events %d",
1866 &vm->elog_main.event_ring_size))
1868 else if (unformat (input, "elog-post-mortem-dump"))
1869 vm->elog_post_mortem_dump = 1;
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 dummy_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 /* Main function. */
1904 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
1906 clib_error_t *volatile error;
1907 vlib_node_main_t *nm = &vm->node_main;
1909 vm->queue_signal_callback = dummy_queue_signal_callback;
1911 clib_time_init (&vm->clib_time);
1913 /* Turn on event log. */
1914 if (!vm->elog_main.event_ring_size)
1915 vm->elog_main.event_ring_size = 128 << 10;
1916 elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
1917 elog_enable_disable (&vm->elog_main, 1);
1923 if ((error = vlib_physmem_init (vm)))
1925 clib_error_report (error);
1929 if ((error = vlib_buffer_main_init (vm)))
1931 clib_error_report (error);
1935 if ((error = vlib_thread_init (vm)))
1937 clib_error_report (error);
1941 if ((error = vlib_map_stat_segment_init (vm)))
1943 clib_error_report (error);
1947 /* Register static nodes so that init functions may use them. */
1948 vlib_register_all_static_nodes (vm);
1950 /* Set seed for random number generator.
1951 Allow user to specify seed to make random sequence deterministic. */
1952 if (!unformat (input, "seed %wd", &vm->random_seed))
1953 vm->random_seed = clib_cpu_time_now ();
1954 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
1956 /* Initialize node graph. */
1957 if ((error = vlib_node_main_init (vm)))
1959 /* Arrange for graph hook up error to not be fatal when debugging. */
1961 clib_error_report (error);
1966 /* Direct call / weak reference, for vlib standalone use-cases */
1967 if ((error = vpe_api_init (vm)))
1969 clib_error_report (error);
1973 if ((error = vlibmemory_init (vm)))
1975 clib_error_report (error);
1979 if ((error = map_api_segment_init (vm)))
1981 clib_error_report (error);
1985 /* See unix/main.c; most likely already set up */
1986 if (vm->init_functions_called == 0)
1987 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
1988 if ((error = vlib_call_all_init_functions (vm)))
1991 /* Create default buffer free list. */
1992 vlib_buffer_create_free_list (vm, VLIB_BUFFER_DATA_SIZE, "default");
1994 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
1995 CLIB_CACHE_LINE_BYTES);
1997 vec_validate (nm->data_from_advancing_timing_wheel, 10);
1998 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
2000 /* Create the process timing wheel */
2001 TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
2002 0 /* no callback */ ,
2003 10e-6 /* timer period 10us */ ,
2004 ~0 /* max expirations per call */ );
2006 vec_validate (vm->pending_rpc_requests, 0);
2007 _vec_len (vm->pending_rpc_requests) = 0;
2008 vec_validate (vm->processing_rpc_requests, 0);
2009 _vec_len (vm->processing_rpc_requests) = 0;
2011 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2013 case VLIB_MAIN_LOOP_EXIT_NONE:
2014 vm->main_loop_exit_set = 1;
2017 case VLIB_MAIN_LOOP_EXIT_CLI:
2021 error = vm->main_loop_error;
2025 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
2028 /* Call all main loop enter functions. */
2030 clib_error_t *sub_error;
2031 sub_error = vlib_call_all_main_loop_enter_functions (vm);
2033 clib_error_report (sub_error);
2036 vlib_main_loop (vm);
2039 /* Call all exit functions. */
2041 clib_error_t *sub_error;
2042 sub_error = vlib_call_all_main_loop_exit_functions (vm);
2044 clib_error_report (sub_error);
2048 clib_error_report (error);
2053 static inline clib_error_t *
2054 pcap_dispatch_trace_command_internal (vlib_main_t * vm,
2055 unformat_input_t * input,
2056 vlib_cli_command_t * cmd, int rx_tx)
2058 #define PCAP_DEF_PKT_TO_CAPTURE (100)
2060 unformat_input_t _line_input, *line_input = &_line_input;
2061 pcap_main_t *pm = &vm->dispatch_pcap_main;
2063 u8 *chroot_filename = 0;
2067 clib_error_t *error = 0;
2068 u32 node_index, add;
2069 vlib_trace_main_t *tm;
2070 vlib_trace_node_t *tn;
2072 /* Get a line of input. */
2073 if (!unformat_user (input, unformat_line_input, line_input))
2076 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2078 if (unformat (line_input, "on"))
2080 if (vm->dispatch_pcap_enable == 0)
2086 vlib_cli_output (vm, "pcap dispatch capture already on...");
2091 else if (unformat (line_input, "off"))
2093 if (vm->dispatch_pcap_enable)
2096 (vm, "captured %d pkts...", pm->n_packets_captured);
2097 if (pm->n_packets_captured)
2099 pm->n_packets_to_capture = pm->n_packets_captured;
2100 error = pcap_write (pm);
2102 clib_error_report (error);
2104 vlib_cli_output (vm, "saved to %s...", pm->file_name);
2106 vm->dispatch_pcap_enable = 0;
2110 vlib_cli_output (vm, "pcap tx capture already off...");
2115 else if (unformat (line_input, "max %d", &max))
2117 if (vm->dispatch_pcap_enable)
2121 "can't change max value while pcap tx capture active...");
2125 pm->n_packets_to_capture = max;
2127 else if (unformat (line_input, "file %s", &filename))
2129 if (vm->dispatch_pcap_enable)
2132 (vm, "can't change file while pcap tx capture active...");
2137 /* Brain-police user path input */
2138 if (strstr ((char *) filename, "..")
2139 || index ((char *) filename, '/'))
2141 vlib_cli_output (vm, "illegal characters in filename '%s'",
2143 vlib_cli_output (vm, "Hint: .. and / are not allowed.");
2144 vec_free (filename);
2149 chroot_filename = format (0, "/tmp/%s%c", filename, 0);
2150 vec_free (filename);
2152 else if (unformat (line_input, "status"))
2154 if (vm->dispatch_pcap_enable)
2157 (vm, "pcap dispatch capture is on: %d of %d pkts...",
2158 pm->n_packets_captured, pm->n_packets_to_capture);
2159 vlib_cli_output (vm, "Capture to file %s", pm->file_name);
2163 vlib_cli_output (vm, "pcap dispatch capture is off...");
2167 else if (unformat (line_input, "buffer-trace %U %d",
2168 unformat_vlib_node, vm, &node_index, &add))
2170 if (vnet_trace_dummy == 0)
2171 vec_validate_aligned (vnet_trace_dummy, 2048,
2172 CLIB_CACHE_LINE_BYTES);
2173 vlib_cli_output (vm, "Buffer tracing of %d pkts from %U enabled...",
2174 add, format_vlib_node_name, vm, node_index);
2177 foreach_vlib_main ((
2179 tm = &this_vlib_main->trace_main;
2180 tm->verbose = 0; /* not sure this ever did anything... */
2181 vec_validate (tm->nodes, node_index);
2182 tn = tm->nodes + node_index;
2184 tm->trace_enable = 1;
2191 error = clib_error_return (0, "unknown input `%U'",
2192 format_unformat_error, line_input);
2197 unformat_free (line_input);
2202 /* Since no error, save configured values. */
2203 if (chroot_filename)
2206 vec_free (pm->file_name);
2207 vec_add1 (chroot_filename, 0);
2208 pm->file_name = (char *) chroot_filename;
2212 pm->n_packets_to_capture = max;
2216 if (pm->file_name == 0)
2217 pm->file_name = (char *) format (0, "/tmp/dispatch.pcap%c", 0);
2219 pm->n_packets_captured = 0;
2220 pm->packet_type = PCAP_PACKET_TYPE_vpp;
2222 clib_spinlock_init (&(pm->lock));
2223 vm->dispatch_pcap_enable = 1;
2224 vlib_cli_output (vm, "pcap dispatch capture on...");
2227 else if (chroot_filename)
2228 vec_free (chroot_filename);
2233 static clib_error_t *
2234 pcap_dispatch_trace_command_fn (vlib_main_t * vm,
2235 unformat_input_t * input,
2236 vlib_cli_command_t * cmd)
2238 return pcap_dispatch_trace_command_internal (vm, input, cmd, VLIB_RX);
2242 * This command is used to start or stop pcap dispatch trace capture, or show
2243 * the capture status.
2245 * This command has the following optional parameters:
2247 * - <b>on|off</b> - Used to start or stop capture.
2249 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2250 * of packets have been received, buffer is flushed to file. Once another
2251 * '<em>nn</em>' number of packets have been received, buffer is flushed
2252 * to file, overwriting previous write. If not entered, value defaults
2253 * to 100. Can only be updated if packet capture is off.
2255 * - <b>file <name></b> - Used to specify the output filename. The file will
2256 * be placed in the '<em>/tmp</em>' directory, so only the filename is
2257 * supported. Directory should not be entered. If file already exists, file
2258 * will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
2259 * will be used. Can only be updated if packet capture is off.
2261 * - <b>status</b> - Displays the current status and configured attributes
2262 * associated with a packet capture. If packet capture is in progress,
2263 * '<em>status</em>' also will return the number of packets currently in
2264 * the local buffer. All additional attributes entered on command line
2265 * with '<em>status</em>' will be ignored and not applied.
2268 * Example of how to display the status of capture when off:
2269 * @cliexstart{pcap dispatch trace status}
2270 * max is 100, for any interface to file /tmp/vpe.pcap
2271 * pcap dispatch capture is off...
2273 * Example of how to start a dispatch trace capture:
2274 * @cliexstart{pcap dispatch trace on max 35 file dispatchTrace.pcap}
2275 * pcap dispatch capture on...
2277 * Example of how to start a dispatch trace capture with buffer tracing
2278 * @cliexstart{pcap dispatch trace on max 10000 file dispatchTrace.pcap buffer-trace dpdk-input 1000}
2279 * pcap dispatch capture on...
2281 * Example of how to display the status of a tx packet capture in progress:
2282 * @cliexstart{pcap tx trace status}
2283 * max is 35, dispatch trace to file /tmp/vppTest.pcap
2284 * pcap tx capture is on: 20 of 35 pkts...
2286 * Example of how to stop a tx packet capture:
2287 * @cliexstart{vppctl pcap dispatch trace off}
2288 * captured 21 pkts...
2289 * saved to /tmp/dispatchTrace.pcap...
2293 VLIB_CLI_COMMAND (pcap_dispatch_trace_command, static) = {
2294 .path = "pcap dispatch trace",
2296 "pcap dispatch trace [on|off] [max <nn>] [file <name>] [status]\n"
2297 " [buffer-trace <input-node-name> <nn>]",
2298 .function = pcap_dispatch_trace_command_fn,
2303 * fd.io coding-style-patch-verification: ON
2306 * eval: (c-set-style "gnu")