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 to_node = vlib_get_node (vm, to_node_index);
127 scalar_size = to_node->scalar_size;
128 vector_size = to_node->vector_size;
130 fs = get_frame_size_info (nm, scalar_size, vector_size);
131 n = vlib_frame_bytes (scalar_size, vector_size);
132 if ((l = vec_len (fs->free_frames)) > 0)
134 /* Allocate from end of free list. */
135 f = fs->free_frames[l - 1];
136 _vec_len (fs->free_frames) = l - 1;
140 f = clib_mem_alloc_aligned_no_fail (n, VLIB_FRAME_ALIGN);
143 /* Poison frame when debugging. */
145 clib_memset (f, 0xfe, n);
147 /* Insert magic number. */
151 magic = vlib_frame_find_magic (f, to_node);
152 *magic = VLIB_FRAME_MAGIC;
155 f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
157 f->scalar_size = scalar_size;
158 f->vector_size = vector_size;
161 fs->n_alloc_frames += 1;
166 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
167 Returns frame index. */
168 static vlib_frame_t *
169 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
172 vlib_node_t *from_node;
174 from_node = vlib_get_node (vm, from_node_runtime->node_index);
175 ASSERT (to_next_index < vec_len (from_node->next_nodes));
177 return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
178 /* frame_flags */ 0);
182 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
184 vlib_frame_t *f = vlib_frame_alloc_to_node (vm, to_node_index,
186 VLIB_FRAME_FREE_AFTER_DISPATCH);
187 return vlib_get_frame (vm, f);
191 vlib_validate_frame_indices (vlib_frame_t * f)
196 u32 *from = vlib_frame_vector_args (f);
198 /* Check for bad buffer index values */
199 for (i = 0; i < f->n_vectors; i++)
203 clib_warning ("BUG: buffer index 0 at index %d", i);
206 else if (from[i] == 0xfefefefe)
208 clib_warning ("BUG: frame poison pattern at index %d", i);
216 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
218 vlib_pending_frame_t *p;
219 vlib_node_t *to_node;
221 if (f->n_vectors == 0)
224 vlib_validate_frame_indices (f);
226 to_node = vlib_get_node (vm, to_node_index);
228 vec_add2 (vm->node_main.pending_frames, p, 1);
230 f->frame_flags |= VLIB_FRAME_PENDING;
231 p->frame = vlib_get_frame (vm, f);
232 p->node_runtime_index = to_node->runtime_index;
233 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
236 /* Free given frame. */
238 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
240 vlib_node_main_t *nm = &vm->node_main;
242 vlib_frame_size_t *fs;
244 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
246 node = vlib_get_node (vm, r->node_index);
247 fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
249 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
251 /* No next frames may point to freed frame. */
254 vlib_next_frame_t *nf;
255 vec_foreach (nf, vm->node_main.next_frames) ASSERT (nf->frame != f);
258 f->frame_flags &= ~(VLIB_FRAME_IS_ALLOCATED | VLIB_FRAME_NO_APPEND);
260 vec_add1 (fs->free_frames, f);
261 ASSERT (fs->n_alloc_frames > 0);
262 fs->n_alloc_frames -= 1;
265 static clib_error_t *
266 show_frame_stats (vlib_main_t * vm,
267 unformat_input_t * input, vlib_cli_command_t * cmd)
269 vlib_node_main_t *nm = &vm->node_main;
270 vlib_frame_size_t *fs;
272 vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
273 vec_foreach (fs, nm->frame_sizes)
275 u32 n_alloc = fs->n_alloc_frames;
276 u32 n_free = vec_len (fs->free_frames);
278 if (n_alloc + n_free > 0)
279 vlib_cli_output (vm, "%=6d%=12d%=12d",
280 fs - nm->frame_sizes, n_alloc, n_free);
287 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
288 .path = "show vlib frame-allocation",
289 .short_help = "Show node dispatch frame statistics",
290 .function = show_frame_stats,
294 /* Change ownership of enqueue rights to given next node. */
296 vlib_next_frame_change_ownership (vlib_main_t * vm,
297 vlib_node_runtime_t * node_runtime,
300 vlib_node_main_t *nm = &vm->node_main;
301 vlib_next_frame_t *next_frame;
302 vlib_node_t *node, *next_node;
304 node = vec_elt (nm->nodes, node_runtime->node_index);
306 /* Only internal & input nodes are allowed to call other nodes. */
307 ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
308 || node->type == VLIB_NODE_TYPE_INPUT
309 || node->type == VLIB_NODE_TYPE_PROCESS);
311 ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
314 vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
315 next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
317 if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
319 /* Get frame from previous owner. */
320 vlib_next_frame_t *owner_next_frame;
321 vlib_next_frame_t tmp;
324 vlib_node_get_next_frame (vm,
325 next_node->owner_node_index,
326 next_node->owner_next_index);
328 /* Swap target next frame with owner's. */
329 tmp = owner_next_frame[0];
330 owner_next_frame[0] = next_frame[0];
334 * If next_frame is already pending, we have to track down
335 * all pending frames and fix their next_frame_index fields.
337 if (next_frame->flags & VLIB_FRAME_PENDING)
339 vlib_pending_frame_t *p;
340 if (next_frame->frame != NULL)
342 vec_foreach (p, nm->pending_frames)
344 if (p->frame == next_frame->frame)
346 p->next_frame_index =
347 next_frame - vm->node_main.next_frames;
355 /* No previous owner. Take ownership. */
356 next_frame->flags |= VLIB_FRAME_OWNER;
359 /* Record new owner. */
360 next_node->owner_node_index = node->index;
361 next_node->owner_next_index = next_index;
363 /* Now we should be owner. */
364 ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
367 /* Make sure that magic number is still there.
368 Otherwise, it is likely that caller has overrun frame arguments. */
370 validate_frame_magic (vlib_main_t * vm,
371 vlib_frame_t * f, vlib_node_t * n, uword next_index)
373 vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
374 u32 *magic = vlib_frame_find_magic (f, next_node);
375 ASSERT (VLIB_FRAME_MAGIC == magic[0]);
379 vlib_get_next_frame_internal (vlib_main_t * vm,
380 vlib_node_runtime_t * node,
381 u32 next_index, u32 allocate_new_next_frame)
384 vlib_next_frame_t *nf;
387 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
389 /* Make sure this next frame owns right to enqueue to destination frame. */
390 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
391 vlib_next_frame_change_ownership (vm, node, next_index);
393 /* ??? Don't need valid flag: can use frame_index == ~0 */
394 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
396 nf->frame = vlib_frame_alloc (vm, node, next_index);
397 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
402 /* Has frame been removed from pending vector (e.g. finished dispatching)?
403 If so we can reuse frame. */
404 if ((nf->flags & VLIB_FRAME_PENDING)
405 && !(f->frame_flags & VLIB_FRAME_PENDING))
407 nf->flags &= ~VLIB_FRAME_PENDING;
412 /* Allocate new frame if current one is marked as no-append or
413 it is already full. */
414 n_used = f->n_vectors;
415 if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0) ||
416 (f->frame_flags & VLIB_FRAME_NO_APPEND))
418 /* Old frame may need to be freed after dispatch, since we'll have
419 two redundant frames from node -> next node. */
420 if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
422 vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame);
423 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
426 /* Allocate new frame to replace full one. */
427 f = nf->frame = vlib_frame_alloc (vm, node, next_index);
428 n_used = f->n_vectors;
431 /* Should have free vectors in frame now. */
432 ASSERT (n_used < VLIB_FRAME_SIZE);
436 validate_frame_magic (vm, f,
437 vlib_get_node (vm, node->node_index), next_index);
444 vlib_put_next_frame_validate (vlib_main_t * vm,
445 vlib_node_runtime_t * rt,
446 u32 next_index, u32 n_vectors_left)
448 vlib_node_main_t *nm = &vm->node_main;
449 vlib_next_frame_t *nf;
451 vlib_node_runtime_t *next_rt;
452 vlib_node_t *next_node;
453 u32 n_before, n_after;
455 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
456 f = vlib_get_frame (vm, nf->frame);
458 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
460 vlib_validate_frame_indices (f);
462 n_after = VLIB_FRAME_SIZE - n_vectors_left;
463 n_before = f->n_vectors;
465 ASSERT (n_after >= n_before);
467 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
468 nf->node_runtime_index);
469 next_node = vlib_get_node (vm, next_rt->node_index);
470 if (n_after > 0 && next_node->validate_frame)
472 u8 *msg = next_node->validate_frame (vm, rt, f);
475 clib_warning ("%v", msg);
483 vlib_put_next_frame (vlib_main_t * vm,
484 vlib_node_runtime_t * r,
485 u32 next_index, u32 n_vectors_left)
487 vlib_node_main_t *nm = &vm->node_main;
488 vlib_next_frame_t *nf;
490 u32 n_vectors_in_frame;
493 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
495 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
496 f = vlib_get_frame (vm, nf->frame);
498 /* Make sure that magic number is still there. Otherwise, caller
499 has overrun frame meta data. */
502 vlib_node_t *node = vlib_get_node (vm, r->node_index);
503 validate_frame_magic (vm, f, node, next_index);
506 /* Convert # of vectors left -> number of vectors there. */
507 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
508 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
510 f->n_vectors = n_vectors_in_frame;
512 /* If vectors were added to frame, add to pending vector. */
513 if (PREDICT_TRUE (n_vectors_in_frame > 0))
515 vlib_pending_frame_t *p;
518 r->cached_next_index = next_index;
520 if (!(f->frame_flags & VLIB_FRAME_PENDING))
522 __attribute__ ((unused)) vlib_node_t *node;
523 vlib_node_t *next_node;
524 vlib_node_runtime_t *next_runtime;
526 node = vlib_get_node (vm, r->node_index);
527 next_node = vlib_get_next_node (vm, r->node_index, next_index);
528 next_runtime = vlib_node_get_runtime (vm, next_node->index);
530 vec_add2 (nm->pending_frames, p, 1);
532 p->frame = nf->frame;
533 p->node_runtime_index = nf->node_runtime_index;
534 p->next_frame_index = nf - nm->next_frames;
535 nf->flags |= VLIB_FRAME_PENDING;
536 f->frame_flags |= VLIB_FRAME_PENDING;
539 * If we're going to dispatch this frame on another thread,
540 * force allocation of a new frame. Otherwise, we create
541 * a dangling frame reference. Each thread has its own copy of
542 * the next_frames vector.
544 if (0 && r->thread_index != next_runtime->thread_index)
547 nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
551 /* Copy trace flag from next_frame and from runtime. */
553 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
554 flags & VLIB_NODE_FLAG_TRACE);
556 v0 = nf->vectors_since_last_overflow;
557 v1 = v0 + n_vectors_in_frame;
558 nf->vectors_since_last_overflow = v1;
559 if (PREDICT_FALSE (v1 < v0))
561 vlib_node_t *node = vlib_get_node (vm, r->node_index);
562 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
567 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
569 vlib_node_runtime_sync_stats (vlib_main_t * vm,
570 vlib_node_runtime_t * r,
571 uword n_calls, uword n_vectors, uword n_clocks,
572 uword n_ticks0, uword n_ticks1)
574 vlib_node_t *n = vlib_get_node (vm, r->node_index);
576 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
577 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
578 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
579 n->stats_total.perf_counter0_ticks += n_ticks0 +
580 r->perf_counter0_ticks_since_last_overflow;
581 n->stats_total.perf_counter1_ticks += n_ticks1 +
582 r->perf_counter1_ticks_since_last_overflow;
583 n->stats_total.perf_counter_vectors += n_vectors +
584 r->perf_counter_vectors_since_last_overflow;
585 n->stats_total.max_clock = r->max_clock;
586 n->stats_total.max_clock_n = r->max_clock_n;
588 r->calls_since_last_overflow = 0;
589 r->vectors_since_last_overflow = 0;
590 r->clocks_since_last_overflow = 0;
591 r->perf_counter0_ticks_since_last_overflow = 0ULL;
592 r->perf_counter1_ticks_since_last_overflow = 0ULL;
593 r->perf_counter_vectors_since_last_overflow = 0ULL;
596 always_inline void __attribute__ ((unused))
597 vlib_process_sync_stats (vlib_main_t * vm,
599 uword n_calls, uword n_vectors, uword n_clocks,
600 uword n_ticks0, uword n_ticks1)
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,
606 n->stats_total.suspends += p->n_suspends;
611 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
613 vlib_node_runtime_t *rt;
615 if (n->type == VLIB_NODE_TYPE_PROCESS)
617 /* Nothing to do for PROCESS nodes except in main thread */
618 if (vm != &vlib_global_main)
621 vlib_process_t *p = vlib_get_process_from_node (vm, n);
622 n->stats_total.suspends += p->n_suspends;
624 rt = &p->node_runtime;
628 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
631 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0, 0, 0);
633 /* Sync up runtime next frame vector counters with main node structure. */
635 vlib_next_frame_t *nf;
637 for (i = 0; i < rt->n_next_nodes; i++)
639 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
640 vec_elt (n->n_vectors_by_next_node, i) +=
641 nf->vectors_since_last_overflow;
642 nf->vectors_since_last_overflow = 0;
648 vlib_node_runtime_update_stats (vlib_main_t * vm,
649 vlib_node_runtime_t * node,
651 uword n_vectors, uword n_clocks,
652 uword n_ticks0, uword n_ticks1)
654 u32 ca0, ca1, v0, v1, cl0, cl1, r;
655 u32 ptick00, ptick01, ptick10, ptick11, pvec0, pvec1;
657 cl0 = cl1 = node->clocks_since_last_overflow;
658 ca0 = ca1 = node->calls_since_last_overflow;
659 v0 = v1 = node->vectors_since_last_overflow;
660 ptick00 = ptick01 = node->perf_counter0_ticks_since_last_overflow;
661 ptick10 = ptick11 = node->perf_counter1_ticks_since_last_overflow;
662 pvec0 = pvec1 = node->perf_counter_vectors_since_last_overflow;
666 cl1 = cl0 + n_clocks;
667 ptick01 = ptick00 + n_ticks0;
668 ptick11 = ptick10 + n_ticks1;
669 pvec1 = pvec0 + n_vectors;
671 node->calls_since_last_overflow = ca1;
672 node->clocks_since_last_overflow = cl1;
673 node->vectors_since_last_overflow = v1;
674 node->perf_counter0_ticks_since_last_overflow = ptick01;
675 node->perf_counter1_ticks_since_last_overflow = ptick11;
676 node->perf_counter_vectors_since_last_overflow = pvec1;
678 node->max_clock_n = node->max_clock > n_clocks ?
679 node->max_clock_n : n_vectors;
680 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
682 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
684 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0) || (ptick01 < ptick00)
685 || (ptick11 < ptick10) || (pvec1 < pvec0))
687 node->calls_since_last_overflow = ca0;
688 node->clocks_since_last_overflow = cl0;
689 node->vectors_since_last_overflow = v0;
690 node->perf_counter0_ticks_since_last_overflow = ptick00;
691 node->perf_counter1_ticks_since_last_overflow = ptick10;
692 node->perf_counter_vectors_since_last_overflow = pvec0;
694 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks,
702 vlib_node_runtime_perf_counter (vlib_main_t * vm, u64 * pmc0, u64 * pmc1,
703 vlib_node_runtime_t * node,
704 vlib_frame_t * frame, int before_or_after)
708 if (PREDICT_FALSE (vec_len (vm->vlib_node_runtime_perf_counter_cbs) != 0))
709 clib_call_callbacks (vm->vlib_node_runtime_perf_counter_cbs, vm, pmc0,
710 pmc1, node, frame, before_or_after);
714 vlib_process_update_stats (vlib_main_t * vm,
716 uword n_calls, uword n_vectors, uword n_clocks)
718 vlib_node_runtime_update_stats (vm, &p->node_runtime,
719 n_calls, n_vectors, n_clocks, 0ULL, 0ULL);
722 static clib_error_t *
723 vlib_cli_elog_clear (vlib_main_t * vm,
724 unformat_input_t * input, vlib_cli_command_t * cmd)
726 elog_reset_buffer (&vm->elog_main);
731 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
732 .path = "event-logger clear",
733 .short_help = "Clear the event log",
734 .function = vlib_cli_elog_clear,
739 static clib_error_t *
740 elog_save_buffer (vlib_main_t * vm,
741 unformat_input_t * input, vlib_cli_command_t * cmd)
743 elog_main_t *em = &vm->elog_main;
744 char *file, *chroot_file;
745 clib_error_t *error = 0;
747 if (!unformat (input, "%s", &file))
749 vlib_cli_output (vm, "expected file name, got `%U'",
750 format_unformat_error, input);
754 /* It's fairly hard to get "../oopsie" through unformat; just in case */
755 if (strstr (file, "..") || index (file, '/'))
757 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
761 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
765 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
766 elog_n_events_in_buffer (em),
767 elog_buffer_capacity (em), chroot_file);
769 vlib_worker_thread_barrier_sync (vm);
770 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
771 vlib_worker_thread_barrier_release (vm);
772 vec_free (chroot_file);
777 elog_post_mortem_dump (void)
779 vlib_main_t *vm = &vlib_global_main;
780 elog_main_t *em = &vm->elog_main;
784 if (!vm->elog_post_mortem_dump)
787 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
788 error = elog_write_file (em, (char *) filename, 1 /* flush ring */ );
790 clib_error_report (error);
795 VLIB_CLI_COMMAND (elog_save_cli, static) = {
796 .path = "event-logger save",
797 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
798 .function = elog_save_buffer,
802 static clib_error_t *
803 elog_stop (vlib_main_t * vm,
804 unformat_input_t * input, vlib_cli_command_t * cmd)
806 elog_main_t *em = &vm->elog_main;
808 em->n_total_events_disable_limit = em->n_total_events;
810 vlib_cli_output (vm, "Stopped the event logger...");
815 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
816 .path = "event-logger stop",
817 .short_help = "Stop the event-logger",
818 .function = elog_stop,
822 static clib_error_t *
823 elog_restart (vlib_main_t * vm,
824 unformat_input_t * input, vlib_cli_command_t * cmd)
826 elog_main_t *em = &vm->elog_main;
828 em->n_total_events_disable_limit = ~0;
830 vlib_cli_output (vm, "Restarted the event logger...");
835 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
836 .path = "event-logger restart",
837 .short_help = "Restart the event-logger",
838 .function = elog_restart,
842 static clib_error_t *
843 elog_resize (vlib_main_t * vm,
844 unformat_input_t * input, vlib_cli_command_t * cmd)
846 elog_main_t *em = &vm->elog_main;
849 /* Stop the parade */
850 elog_reset_buffer (&vm->elog_main);
852 if (unformat (input, "%d", &tmp))
854 elog_alloc (em, tmp);
855 em->n_total_events_disable_limit = ~0;
858 return clib_error_return (0, "Must specify how many events in the ring");
860 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
865 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
866 .path = "event-logger resize",
867 .short_help = "event-logger resize <nnn>",
868 .function = elog_resize,
872 #endif /* CLIB_UNIX */
875 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
877 elog_main_t *em = &vm->elog_main;
878 elog_event_t *e, *es;
881 /* Show events in VLIB time since log clock starts after VLIB clock. */
882 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
883 * vm->clib_time.seconds_per_clock;
885 es = elog_peek_events (em);
886 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
888 em->n_total_events < em->n_total_events_disable_limit ?
889 "running" : "stopped");
892 vlib_cli_output (vm, "%18.9f: %U",
893 e->time + dt, format_elog_event, em, e);
895 if (n_events_to_show == 0)
902 static clib_error_t *
903 elog_show_buffer (vlib_main_t * vm,
904 unformat_input_t * input, vlib_cli_command_t * cmd)
906 u32 n_events_to_show;
907 clib_error_t *error = 0;
909 n_events_to_show = 250;
910 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
912 if (unformat (input, "%d", &n_events_to_show))
914 else if (unformat (input, "all"))
915 n_events_to_show = ~0;
917 return unformat_parse_error (input);
919 elog_show_buffer_internal (vm, n_events_to_show);
924 VLIB_CLI_COMMAND (elog_show_cli, static) = {
925 .path = "show event-logger",
926 .short_help = "Show event logger info",
927 .function = elog_show_buffer,
932 vlib_gdb_show_event_log (void)
934 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
938 vlib_elog_main_loop_event (vlib_main_t * vm,
940 u64 time, u32 n_vectors, u32 is_return)
942 vlib_main_t *evm = &vlib_global_main;
943 elog_main_t *em = &evm->elog_main;
944 int enabled = evm->elog_trace_graph_dispatch |
945 evm->elog_trace_graph_circuit;
947 if (PREDICT_FALSE (enabled && n_vectors))
949 if (PREDICT_FALSE (!elog_is_enabled (em)))
951 evm->elog_trace_graph_dispatch = 0;
952 evm->elog_trace_graph_circuit = 0;
956 (evm->elog_trace_graph_dispatch ||
957 (evm->elog_trace_graph_circuit &&
958 node_index == evm->elog_trace_graph_circuit_node_index)))
962 vec_elt_at_index (is_return
963 ? evm->node_return_elog_event_types
964 : evm->node_call_elog_event_types,
968 &vlib_worker_threads[vm->thread_index].elog_track
969 : &em->default_track),
970 /* data to log */ n_vectors);
975 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
976 void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 node_index);
977 void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
980 vlib_buffer_trace_trajectory_init (vlib_buffer_t * b)
982 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_init_cb != 0))
984 (*vlib_buffer_trace_trajectory_init_cb) (b);
991 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
993 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
994 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_cb != 0))
996 (*vlib_buffer_trace_trajectory_cb) (b, node_index);
1001 u8 *format_vnet_buffer_flags (u8 * s, va_list * args) __attribute__ ((weak));
1003 format_vnet_buffer_flags (u8 * s, va_list * args)
1005 s = format (s, "BUG STUB %s", __FUNCTION__);
1009 u8 *format_vnet_buffer_opaque (u8 * s, va_list * args) __attribute__ ((weak));
1011 format_vnet_buffer_opaque (u8 * s, va_list * args)
1013 s = format (s, "BUG STUB %s", __FUNCTION__);
1017 u8 *format_vnet_buffer_opaque2 (u8 * s, va_list * args)
1018 __attribute__ ((weak));
1020 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
1022 s = format (s, "BUG STUB %s", __FUNCTION__);
1027 format_buffer_metadata (u8 * s, va_list * args)
1029 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
1031 s = format (s, "flags: %U\n", format_vnet_buffer_flags, b);
1032 s = format (s, "current_data: %d, current_length: %d\n",
1033 (i32) (b->current_data), (i32) (b->current_length));
1036 "current_config_index/punt_reason: %d, flow_id: %x, next_buffer: %x\n",
1037 b->current_config_index, b->flow_id, b->next_buffer);
1039 format (s, "error: %d, ref_count: %d, buffer_pool_index: %d\n",
1040 (u32) (b->error), (u32) (b->ref_count),
1041 (u32) (b->buffer_pool_index));
1043 format (s, "trace_handle: 0x%x, len_not_first_buf: %d\n", b->trace_handle,
1044 b->total_length_not_including_first_buffer);
1048 #define A(x) vec_add1(vm->pcap_buffer, (x))
1051 dispatch_pcap_trace (vlib_main_t * vm,
1052 vlib_node_runtime_t * node, vlib_frame_t * frame)
1055 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **bufp, *b;
1056 pcap_main_t *pm = &vlib_global_main.dispatch_pcap_main;
1057 vlib_trace_main_t *tm = &vm->trace_main;
1061 f64 time_now = vlib_time_now (vm);
1066 /* Input nodes don't have frames yet */
1067 if (frame == 0 || frame->n_vectors == 0)
1070 from = vlib_frame_vector_args (frame);
1071 vlib_get_buffers (vm, from, bufs, frame->n_vectors);
1074 n = vlib_get_node (vm, node->node_index);
1076 for (i = 0; i < frame->n_vectors; i++)
1078 if (PREDICT_TRUE (pm->n_packets_captured < pm->n_packets_to_capture))
1082 vec_reset_length (vm->pcap_buffer);
1085 /* Version, flags */
1086 A ((u8) VLIB_PCAP_MAJOR_VERSION);
1087 A ((u8) VLIB_PCAP_MINOR_VERSION);
1088 A (0 /* string_count */ );
1089 A (n->protocol_hint);
1091 /* Buffer index (big endian) */
1092 A ((from[i] >> 24) & 0xff);
1093 A ((from[i] >> 16) & 0xff);
1094 A ((from[i] >> 8) & 0xff);
1095 A ((from[i] >> 0) & 0xff);
1097 /* Node name, NULL-terminated ASCII */
1098 vm->pcap_buffer = format (vm->pcap_buffer, "%v%c", n->name, 0);
1101 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1102 format_buffer_metadata, b, 0);
1104 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1105 format_vnet_buffer_opaque, b, 0);
1107 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1108 format_vnet_buffer_opaque2, b, 0);
1111 /* Is this packet traced? */
1112 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1114 vlib_trace_header_t **h
1115 = pool_elt_at_index (tm->trace_buffer_pool,
1116 vlib_buffer_get_trace_index (b));
1118 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1119 format_vlib_trace, vm, h[0], 0);
1123 /* Save the string count */
1124 vm->pcap_buffer[2] = string_count;
1126 /* Figure out how many bytes in the pcap trace */
1127 capture_size = vec_len (vm->pcap_buffer) +
1128 +vlib_buffer_length_in_chain (vm, b);
1130 clib_spinlock_lock_if_init (&pm->lock);
1131 n_left = clib_min (capture_size, 16384);
1132 d = pcap_add_packet (pm, time_now, n_left, capture_size);
1134 /* Copy the header */
1135 clib_memcpy_fast (d, vm->pcap_buffer, vec_len (vm->pcap_buffer));
1136 d += vec_len (vm->pcap_buffer);
1139 (vlib_buffer_length_in_chain (vm, b),
1140 (16384 - vec_len (vm->pcap_buffer)));
1141 /* Copy the packet data */
1144 u32 copy_length = clib_min ((u32) n_left, b->current_length);
1145 clib_memcpy_fast (d, b->data + b->current_data, copy_length);
1146 n_left -= b->current_length;
1149 d += b->current_length;
1150 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
1151 b = vlib_get_buffer (vm, b->next_buffer);
1153 clib_spinlock_unlock_if_init (&pm->lock);
1158 static_always_inline u64
1159 dispatch_node (vlib_main_t * vm,
1160 vlib_node_runtime_t * node,
1161 vlib_node_type_t type,
1162 vlib_node_state_t dispatch_state,
1163 vlib_frame_t * frame, u64 last_time_stamp)
1167 vlib_node_main_t *nm = &vm->node_main;
1168 vlib_next_frame_t *nf;
1169 u64 pmc_before[2], pmc_after[2], pmc_delta[2];
1173 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1174 ASSERT (n->type == type);
1177 /* Only non-internal nodes may be disabled. */
1178 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
1180 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
1181 return last_time_stamp;
1184 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
1185 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
1187 u32 c = node->input_main_loops_per_call;
1188 /* Only call node when count reaches zero. */
1191 node->input_main_loops_per_call = c - 1;
1192 return last_time_stamp;
1196 /* Speculatively prefetch next frames. */
1197 if (node->n_next_nodes > 0)
1199 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
1200 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
1203 vm->cpu_time_last_node_dispatch = last_time_stamp;
1205 vlib_elog_main_loop_event (vm, node->node_index,
1206 last_time_stamp, frame ? frame->n_vectors : 0,
1209 vlib_node_runtime_perf_counter (vm, &pmc_before[0], &pmc_before[1],
1210 node, frame, 0 /* before */ );
1213 * Turn this on if you run into
1214 * "bad monkey" contexts, and you want to know exactly
1215 * which nodes they've visited... See ixge.c...
1217 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
1221 from = vlib_frame_vector_args (frame);
1222 for (i = 0; i < frame->n_vectors; i++)
1224 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1225 add_trajectory_trace (b, node->node_index);
1227 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1228 dispatch_pcap_trace (vm, node, frame);
1229 n = node->function (vm, node, frame);
1233 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1234 dispatch_pcap_trace (vm, node, frame);
1235 n = node->function (vm, node, frame);
1238 t = clib_cpu_time_now ();
1241 * To validate accounting: pmc_delta = t - pmc_before;
1242 * perf ticks should equal clocks/pkt...
1244 vlib_node_runtime_perf_counter (vm, &pmc_after[0], &pmc_after[1], node,
1245 frame, 1 /* after */ );
1247 pmc_delta[0] = pmc_after[0] - pmc_before[0];
1248 pmc_delta[1] = pmc_after[1] - pmc_before[1];
1250 vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
1252 vm->main_loop_vectors_processed += n;
1253 vm->main_loop_nodes_processed += n > 0;
1255 v = vlib_node_runtime_update_stats (vm, node,
1258 /* n_clocks */ t - last_time_stamp,
1259 pmc_delta[0] /* PMC0 */ ,
1260 pmc_delta[1] /* PMC1 */ );
1262 /* When in interrupt mode and vector rate crosses threshold switch to
1264 if (PREDICT_FALSE ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1265 || (dispatch_state == VLIB_NODE_STATE_POLLING
1268 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))))
1271 ELOG_TYPE_DECLARE (e) =
1273 .function = (char *) __FUNCTION__,
1274 .format = "%s vector length %d, switching to %s",
1275 .format_args = "T4i4t4",
1276 .n_enum_strings = 2,
1278 "interrupt", "polling",
1284 u32 node_name, vector_length, is_polling;
1287 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1288 && v >= nm->polling_threshold_vector_length) &&
1290 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1292 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1293 n->state = VLIB_NODE_STATE_POLLING;
1294 node->state = VLIB_NODE_STATE_POLLING;
1296 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1297 node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1298 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1299 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1301 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1303 vlib_worker_thread_t *w = vlib_worker_threads
1306 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1308 ed->node_name = n->name_elog_string;
1309 ed->vector_length = v;
1313 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1314 && v <= nm->interrupt_threshold_vector_length)
1316 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1318 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1320 /* Switch to interrupt mode after dispatch in polling one more time.
1321 This allows driver to re-enable interrupts. */
1322 n->state = VLIB_NODE_STATE_INTERRUPT;
1323 node->state = VLIB_NODE_STATE_INTERRUPT;
1325 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1326 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1327 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
1332 vlib_worker_thread_t *w = vlib_worker_threads
1335 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1336 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1338 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1340 ed->node_name = n->name_elog_string;
1341 ed->vector_length = v;
1352 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1353 u64 last_time_stamp)
1355 vlib_node_main_t *nm = &vm->node_main;
1357 vlib_next_frame_t *nf, nf_dummy;
1358 vlib_node_runtime_t *n;
1359 vlib_frame_t *restore_frame;
1360 vlib_pending_frame_t *p;
1362 /* See comment below about dangling references to nm->pending_frames */
1363 p = nm->pending_frames + pending_frame_index;
1365 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1366 p->node_runtime_index);
1368 f = vlib_get_frame (vm, p->frame);
1369 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1371 /* No next frame: so use dummy on stack. */
1373 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1377 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1379 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1381 /* Force allocation of new frame while current frame is being
1383 restore_frame = NULL;
1384 if (nf->frame == p->frame)
1387 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1388 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1389 restore_frame = p->frame;
1392 /* Frame must be pending. */
1393 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1394 ASSERT (f->n_vectors > 0);
1396 /* Copy trace flag from next frame to node.
1397 Trace flag indicates that at least one vector in the dispatched
1399 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1400 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1401 nf->flags &= ~VLIB_FRAME_TRACE;
1403 last_time_stamp = dispatch_node (vm, n,
1404 VLIB_NODE_TYPE_INTERNAL,
1405 VLIB_NODE_STATE_POLLING,
1406 f, last_time_stamp);
1407 /* Internal node vector-rate accounting, for summary stats */
1408 vm->internal_node_vectors += f->n_vectors;
1409 vm->internal_node_calls++;
1410 vm->internal_node_last_vectors_per_main_loop =
1411 (f->n_vectors > vm->internal_node_last_vectors_per_main_loop) ?
1412 f->n_vectors : vm->internal_node_last_vectors_per_main_loop;
1414 f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
1416 /* Frame is ready to be used again, so restore it. */
1417 if (restore_frame != NULL)
1420 * We musn't restore a frame that is flagged to be freed. This
1421 * shouldn't happen since frames to be freed post dispatch are
1422 * those used when the to-node frame becomes full i.e. they form a
1423 * sort of queue of frames to a single node. If we get here then
1424 * the to-node frame and the pending frame *were* the same, and so
1425 * we removed the to-node frame. Therefore this frame is no
1426 * longer part of the queue for that node and hence it cannot be
1429 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1432 * NB: dispatching node n can result in the creation and scheduling
1433 * of new frames, and hence in the reallocation of nm->pending_frames.
1434 * Recompute p, or no supper. This was broken for more than 10 years.
1436 p = nm->pending_frames + pending_frame_index;
1439 * p->next_frame_index can change during node dispatch if node
1440 * function decides to change graph hook up.
1442 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1443 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1445 if (NULL == nf->frame)
1447 /* no new frame has been assigned to this node, use the saved one */
1448 nf->frame = restore_frame;
1453 /* The node has gained a frame, implying packets from the current frame
1454 were re-queued to this same node. we don't need the saved one
1456 vlib_frame_free (vm, n, f);
1461 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1463 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1464 vlib_frame_free (vm, n, f);
1468 return last_time_stamp;
1472 vlib_process_stack_is_valid (vlib_process_t * p)
1474 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1480 vlib_process_t *process;
1481 vlib_frame_t *frame;
1482 } vlib_process_bootstrap_args_t;
1484 /* Called in process stack. */
1486 vlib_process_bootstrap (uword _a)
1488 vlib_process_bootstrap_args_t *a;
1490 vlib_node_runtime_t *node;
1495 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1500 node = &p->node_runtime;
1502 n = node->function (vm, node, f);
1504 ASSERT (vlib_process_stack_is_valid (p));
1506 clib_longjmp (&p->return_longjmp, n);
1511 /* Called in main stack. */
1512 static_always_inline uword
1513 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1515 vlib_process_bootstrap_args_t a;
1522 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1523 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1524 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1525 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1530 static_always_inline uword
1531 vlib_process_resume (vlib_process_t * p)
1534 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1535 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1536 | VLIB_PROCESS_RESUME_PENDING);
1537 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1538 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1539 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1544 dispatch_process (vlib_main_t * vm,
1545 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1547 vlib_node_main_t *nm = &vm->node_main;
1548 vlib_node_runtime_t *node_runtime = &p->node_runtime;
1549 vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1550 u32 old_process_index;
1552 uword n_vectors, is_suspend;
1554 if (node->state != VLIB_NODE_STATE_POLLING
1555 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1556 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1557 return last_time_stamp;
1559 p->flags |= VLIB_PROCESS_IS_RUNNING;
1561 t = last_time_stamp;
1562 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1563 f ? f->n_vectors : 0, /* is_after */ 0);
1565 /* Save away current process for suspend. */
1566 old_process_index = nm->current_process_index;
1567 nm->current_process_index = node->runtime_index;
1569 n_vectors = vlib_process_startup (vm, p, f);
1571 nm->current_process_index = old_process_index;
1573 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1574 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1577 vlib_pending_frame_t *pf;
1580 pool_get (nm->suspended_process_frames, pf);
1581 pf->node_runtime_index = node->runtime_index;
1583 pf->next_frame_index = ~0;
1586 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1588 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1590 TWT (tw_timer_wheel) * tw =
1591 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1592 p->stop_timer_handle =
1593 TW (tw_timer_start) (tw,
1594 vlib_timing_wheel_data_set_suspended_process
1595 (node->runtime_index) /* [sic] pool idex */ ,
1597 p->resume_clock_interval);
1601 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1603 t = clib_cpu_time_now ();
1605 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1608 vlib_process_update_stats (vm, p,
1609 /* n_calls */ !is_suspend,
1610 /* n_vectors */ n_vectors,
1611 /* n_clocks */ t - last_time_stamp);
1617 vlib_start_process (vlib_main_t * vm, uword process_index)
1619 vlib_node_main_t *nm = &vm->node_main;
1620 vlib_process_t *p = vec_elt (nm->processes, process_index);
1621 dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1625 dispatch_suspended_process (vlib_main_t * vm,
1626 uword process_index, u64 last_time_stamp)
1628 vlib_node_main_t *nm = &vm->node_main;
1629 vlib_node_runtime_t *node_runtime;
1633 vlib_pending_frame_t *pf;
1634 u64 t, n_vectors, is_suspend;
1636 t = last_time_stamp;
1638 p = vec_elt (nm->processes, process_index);
1639 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1640 return last_time_stamp;
1642 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1643 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1645 pf = pool_elt_at_index (nm->suspended_process_frames,
1646 p->suspended_process_frame_index);
1648 node_runtime = &p->node_runtime;
1649 node = vlib_get_node (vm, node_runtime->node_index);
1652 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1653 f ? f->n_vectors : 0, /* is_after */ 0);
1655 /* Save away current process for suspend. */
1656 nm->current_process_index = node->runtime_index;
1658 n_vectors = vlib_process_resume (p);
1659 t = clib_cpu_time_now ();
1661 nm->current_process_index = ~0;
1663 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1666 /* Suspend it again. */
1669 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1671 p->stop_timer_handle =
1672 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1673 vlib_timing_wheel_data_set_suspended_process
1674 (node->runtime_index) /* [sic] pool idex */ ,
1676 p->resume_clock_interval);
1681 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1682 pool_put_index (nm->suspended_process_frames,
1683 p->suspended_process_frame_index);
1684 p->suspended_process_frame_index = ~0;
1687 t = clib_cpu_time_now ();
1688 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1691 vlib_process_update_stats (vm, p,
1692 /* n_calls */ !is_suspend,
1693 /* n_vectors */ n_vectors,
1694 /* n_clocks */ t - last_time_stamp);
1699 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1701 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1706 static_always_inline void
1707 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1709 vlib_node_main_t *nm = &vm->node_main;
1710 vlib_thread_main_t *tm = vlib_get_thread_main ();
1714 vlib_frame_queue_main_t *fqm;
1715 u32 *last_node_runtime_indices = 0;
1716 u32 frame_queue_check_counter = 0;
1718 /* Initialize pending node vector. */
1721 vec_resize (nm->pending_frames, 32);
1722 _vec_len (nm->pending_frames) = 0;
1725 /* Mark time of main loop start. */
1728 cpu_time_now = vm->clib_time.last_cpu_time;
1729 vm->cpu_time_main_loop_start = cpu_time_now;
1732 cpu_time_now = clib_cpu_time_now ();
1734 /* Pre-allocate interupt runtime indices and lock. */
1735 vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1736 vec_alloc (last_node_runtime_indices, 32);
1738 clib_spinlock_init (&nm->pending_interrupt_lock);
1740 /* Pre-allocate expired nodes. */
1741 if (!nm->polling_threshold_vector_length)
1742 nm->polling_threshold_vector_length = 10;
1743 if (!nm->interrupt_threshold_vector_length)
1744 nm->interrupt_threshold_vector_length = 5;
1746 vm->cpu_id = clib_get_current_cpu_id ();
1747 vm->numa_node = clib_get_current_numa_node ();
1748 os_set_numa_index (vm->numa_node);
1750 /* Start all processes. */
1756 * Perform an initial barrier sync. Pays no attention to
1757 * the barrier sync hold-down timer scheme, which won't work
1758 * at this point in time.
1760 vlib_worker_thread_initial_barrier_sync_and_release (vm);
1762 nm->current_process_index = ~0;
1763 for (i = 0; i < vec_len (nm->processes); i++)
1764 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1770 vlib_node_runtime_t *n;
1772 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1775 vl_api_send_pending_rpc_requests (vm);
1780 vlib_worker_thread_barrier_check ();
1781 if (PREDICT_FALSE (vm->check_frame_queues +
1782 frame_queue_check_counter))
1786 if (vm->check_frame_queues)
1788 frame_queue_check_counter = 100;
1789 vm->check_frame_queues = 0;
1792 vec_foreach (fqm, tm->frame_queue_mains)
1793 processed += vlib_frame_queue_dequeue (vm, fqm);
1795 /* No handoff queue work found? */
1797 frame_queue_check_counter = 100;
1799 frame_queue_check_counter--;
1801 if (PREDICT_FALSE (vec_len (vm->worker_thread_main_loop_callbacks)))
1802 clib_call_callbacks (vm->worker_thread_main_loop_callbacks, vm);
1805 /* Process pre-input nodes. */
1806 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1807 cpu_time_now = dispatch_node (vm, n,
1808 VLIB_NODE_TYPE_PRE_INPUT,
1809 VLIB_NODE_STATE_POLLING,
1813 /* Next process input nodes. */
1814 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1815 cpu_time_now = dispatch_node (vm, n,
1816 VLIB_NODE_TYPE_INPUT,
1817 VLIB_NODE_STATE_POLLING,
1821 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1822 vm->queue_signal_callback (vm);
1824 /* Next handle interrupts. */
1826 /* unlocked read, for performance */
1827 uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1829 if (PREDICT_FALSE (l > 0))
1834 clib_spinlock_lock (&nm->pending_interrupt_lock);
1835 /* Re-read w/ lock held, in case another thread added an item */
1836 l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1839 tmp = nm->pending_interrupt_node_runtime_indices;
1840 nm->pending_interrupt_node_runtime_indices =
1841 last_node_runtime_indices;
1842 last_node_runtime_indices = tmp;
1843 _vec_len (last_node_runtime_indices) = 0;
1845 clib_spinlock_unlock (&nm->pending_interrupt_lock);
1846 for (i = 0; i < l; i++)
1848 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1849 last_node_runtime_indices[i]);
1851 dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1852 VLIB_NODE_STATE_INTERRUPT,
1858 /* Input nodes may have added work to the pending vector.
1859 Process pending vector until there is nothing left.
1860 All pending vectors will be processed from input -> output. */
1861 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1862 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1863 /* Reset pending vector for next iteration. */
1864 _vec_len (nm->pending_frames) = 0;
1869 ELOG_TYPE_DECLARE (es) =
1871 .format = "process tw start",
1874 ELOG_TYPE_DECLARE (ee) =
1876 .format = "process tw end: %d",
1877 .format_args = "i4",
1886 /* Check if process nodes have expired from timing wheel. */
1887 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1889 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1890 ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1892 nm->data_from_advancing_timing_wheel =
1893 TW (tw_timer_expire_timers_vec)
1894 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1895 nm->data_from_advancing_timing_wheel);
1897 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1899 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1901 ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1903 _vec_len (nm->data_from_advancing_timing_wheel);
1907 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1911 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1914 u32 d = nm->data_from_advancing_timing_wheel[i];
1915 u32 di = vlib_timing_wheel_data_get_index (d);
1917 if (vlib_timing_wheel_data_is_timed_event (d))
1919 vlib_signal_timed_event_data_t *te =
1920 pool_elt_at_index (nm->signal_timed_event_data_pool,
1923 vlib_get_node (vm, te->process_node_index);
1925 vec_elt (nm->processes, n->runtime_index);
1928 vlib_process_signal_event_helper (nm, n, p,
1929 te->event_type_index,
1931 te->n_data_elt_bytes);
1932 if (te->n_data_bytes < sizeof (te->inline_event_data))
1933 clib_memcpy_fast (data, te->inline_event_data,
1937 clib_memcpy_fast (data, te->event_data_as_vector,
1939 vec_free (te->event_data_as_vector);
1941 pool_put (nm->signal_timed_event_data_pool, te);
1945 cpu_time_now = clib_cpu_time_now ();
1947 dispatch_suspended_process (vm, di, cpu_time_now);
1950 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1953 vlib_increment_main_loop_counter (vm);
1954 /* Record time stamp in case there are no enabled nodes and above
1955 calls do not update time stamp. */
1956 cpu_time_now = clib_cpu_time_now ();
1957 vm->loops_this_reporting_interval++;
1958 now = clib_time_now_internal (&vm->clib_time, cpu_time_now);
1959 /* Time to update loops_per_second? */
1960 if (PREDICT_FALSE (now >= vm->loop_interval_end))
1962 /* Next sample ends in 20ms */
1963 if (vm->loop_interval_start)
1965 f64 this_loops_per_second;
1967 this_loops_per_second =
1968 ((f64) vm->loops_this_reporting_interval) / (now -
1969 vm->loop_interval_start);
1971 vm->loops_per_second =
1972 vm->loops_per_second * vm->damping_constant +
1973 (1.0 - vm->damping_constant) * this_loops_per_second;
1974 if (vm->loops_per_second != 0.0)
1975 vm->seconds_per_loop = 1.0 / vm->loops_per_second;
1977 vm->seconds_per_loop = 0.0;
1979 /* New interval starts now, and ends in 20ms */
1980 vm->loop_interval_start = now;
1981 vm->loop_interval_end = now + 2e-4;
1982 vm->loops_this_reporting_interval = 0;
1988 vlib_main_loop (vlib_main_t * vm)
1990 vlib_main_or_worker_loop (vm, /* is_main */ 1);
1994 vlib_worker_loop (vlib_main_t * vm)
1996 vlib_main_or_worker_loop (vm, /* is_main */ 0);
1999 vlib_main_t vlib_global_main;
2001 static clib_error_t *
2002 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
2004 int turn_on_mem_trace = 0;
2006 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2008 if (unformat (input, "memory-trace"))
2009 turn_on_mem_trace = 1;
2011 else if (unformat (input, "elog-events %d",
2012 &vm->elog_main.event_ring_size))
2014 else if (unformat (input, "elog-post-mortem-dump"))
2015 vm->elog_post_mortem_dump = 1;
2016 else if (unformat (input, "buffer-alloc-success-rate %f",
2017 &vm->buffer_alloc_success_rate))
2019 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
2020 return clib_error_return
2021 (0, "Buffer fault injection not configured");
2023 else if (unformat (input, "buffer-alloc-success-seed %u",
2024 &vm->buffer_alloc_success_seed))
2026 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
2027 return clib_error_return
2028 (0, "Buffer fault injection not configured");
2031 return unformat_parse_error (input);
2034 unformat_free (input);
2036 /* Enable memory trace as early as possible. */
2037 if (turn_on_mem_trace)
2043 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
2046 dummy_queue_signal_callback (vlib_main_t * vm)
2050 #define foreach_weak_reference_stub \
2051 _(vlib_map_stat_segment_init) \
2053 _(vlibmemory_init) \
2054 _(map_api_segment_init)
2057 clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
2058 clib_error_t *name (vlib_main_t *vm) { return 0; }
2059 foreach_weak_reference_stub;
2062 void vl_api_set_elog_main (elog_main_t * m) __attribute__ ((weak));
2064 vl_api_set_elog_main (elog_main_t * m)
2066 clib_warning ("STUB");
2069 int vl_api_set_elog_trace_api_messages (int enable) __attribute__ ((weak));
2071 vl_api_set_elog_trace_api_messages (int enable)
2073 clib_warning ("STUB");
2077 int vl_api_get_elog_trace_api_messages (void) __attribute__ ((weak));
2079 vl_api_get_elog_trace_api_messages (void)
2081 clib_warning ("STUB");
2085 /* Main function. */
2087 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
2089 clib_error_t *volatile error;
2090 vlib_node_main_t *nm = &vm->node_main;
2092 vm->queue_signal_callback = dummy_queue_signal_callback;
2094 /* Turn on event log. */
2095 if (!vm->elog_main.event_ring_size)
2096 vm->elog_main.event_ring_size = 128 << 10;
2097 elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
2098 elog_enable_disable (&vm->elog_main, 1);
2099 vl_api_set_elog_main (&vm->elog_main);
2100 (void) vl_api_set_elog_trace_api_messages (1);
2106 if ((error = vlib_physmem_init (vm)))
2108 clib_error_report (error);
2112 if ((error = vlib_map_stat_segment_init (vm)))
2114 clib_error_report (error);
2118 if ((error = vlib_buffer_main_init (vm)))
2120 clib_error_report (error);
2124 if ((error = vlib_thread_init (vm)))
2126 clib_error_report (error);
2130 /* Register static nodes so that init functions may use them. */
2131 vlib_register_all_static_nodes (vm);
2133 /* Set seed for random number generator.
2134 Allow user to specify seed to make random sequence deterministic. */
2135 if (!unformat (input, "seed %wd", &vm->random_seed))
2136 vm->random_seed = clib_cpu_time_now ();
2137 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
2139 /* Initialize node graph. */
2140 if ((error = vlib_node_main_init (vm)))
2142 /* Arrange for graph hook up error to not be fatal when debugging. */
2144 clib_error_report (error);
2149 /* Direct call / weak reference, for vlib standalone use-cases */
2150 if ((error = vpe_api_init (vm)))
2152 clib_error_report (error);
2156 if ((error = vlibmemory_init (vm)))
2158 clib_error_report (error);
2162 if ((error = map_api_segment_init (vm)))
2164 clib_error_report (error);
2168 /* See unix/main.c; most likely already set up */
2169 if (vm->init_functions_called == 0)
2170 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
2171 if ((error = vlib_call_all_init_functions (vm)))
2174 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
2175 CLIB_CACHE_LINE_BYTES);
2177 vec_validate (nm->data_from_advancing_timing_wheel, 10);
2178 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
2180 /* Create the process timing wheel */
2181 TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
2182 0 /* no callback */ ,
2183 10e-6 /* timer period 10us */ ,
2184 ~0 /* max expirations per call */ );
2186 vec_validate (vm->pending_rpc_requests, 0);
2187 _vec_len (vm->pending_rpc_requests) = 0;
2188 vec_validate (vm->processing_rpc_requests, 0);
2189 _vec_len (vm->processing_rpc_requests) = 0;
2191 /* Default params for the buffer allocator fault injector, if configured */
2192 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0)
2194 vm->buffer_alloc_success_seed = 0xdeaddabe;
2195 vm->buffer_alloc_success_rate = 0.80;
2198 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
2202 * Use exponential smoothing, with a half-life of 1 second
2203 * reported_rate(t) = reported_rate(t-1) * K + rate(t)*(1-K)
2205 * Sample every 20ms, aka 50 samples per second
2206 * K = exp (-1.0/20.0);
2209 vm->damping_constant = exp (-1.0 / 20.0);
2211 /* Sort per-thread init functions before we start threads */
2212 vlib_sort_init_exit_functions (&vm->worker_init_function_registrations);
2214 /* Call all main loop enter functions. */
2216 clib_error_t *sub_error;
2217 sub_error = vlib_call_all_main_loop_enter_functions (vm);
2219 clib_error_report (sub_error);
2222 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2224 case VLIB_MAIN_LOOP_EXIT_NONE:
2225 vm->main_loop_exit_set = 1;
2228 case VLIB_MAIN_LOOP_EXIT_CLI:
2232 error = vm->main_loop_error;
2236 vlib_main_loop (vm);
2239 /* Call all exit functions. */
2241 clib_error_t *sub_error;
2242 sub_error = vlib_call_all_main_loop_exit_functions (vm);
2244 clib_error_report (sub_error);
2248 clib_error_report (error);
2254 vlib_pcap_dispatch_trace_configure (vlib_pcap_dispatch_trace_args_t * a)
2256 vlib_main_t *vm = vlib_get_main ();
2257 pcap_main_t *pm = &vm->dispatch_pcap_main;
2258 vlib_trace_main_t *tm;
2259 vlib_trace_node_t *tn;
2263 if (vm->dispatch_pcap_enable)
2267 (vm, "pcap dispatch capture enabled: %d of %d pkts...",
2268 pm->n_packets_captured, pm->n_packets_to_capture);
2269 vlib_cli_output (vm, "capture to file %s", pm->file_name);
2271 for (i = 0; i < vec_len (vm->dispatch_buffer_trace_nodes); i++)
2273 vlib_cli_output (vm,
2274 "Buffer trace of %d pkts from %U enabled...",
2275 a->buffer_traces_to_capture,
2276 format_vlib_node_name, vm,
2277 vm->dispatch_buffer_trace_nodes[i]);
2281 vlib_cli_output (vm, "pcap dispatch capture disabled");
2285 /* Consistency checks */
2287 /* Enable w/ capture already enabled not allowed */
2288 if (vm->dispatch_pcap_enable && a->enable)
2289 return -7; /* VNET_API_ERROR_INVALID_VALUE */
2291 /* Disable capture with capture already disabled, not interesting */
2292 if (vm->dispatch_pcap_enable == 0 && a->enable == 0)
2293 return -81; /* VNET_API_ERROR_VALUE_EXIST */
2295 /* Change number of packets to capture while capturing */
2296 if (vm->dispatch_pcap_enable && a->enable
2297 && (pm->n_packets_to_capture != a->packets_to_capture))
2298 return -8; /* VNET_API_ERROR_INVALID_VALUE_2 */
2300 /* Independent of enable/disable, to allow buffer trace multi nodes */
2301 if (a->buffer_trace_node_index != ~0)
2304 foreach_vlib_main ((
2306 tm = &this_vlib_main->trace_main;
2307 tm->verbose = 0; /* not sure this ever did anything... */
2308 vec_validate (tm->nodes, a->buffer_trace_node_index);
2309 tn = tm->nodes + a->buffer_trace_node_index;
2310 tn->limit += a->buffer_traces_to_capture;
2311 tm->trace_enable = 1;
2314 vec_add1 (vm->dispatch_buffer_trace_nodes, a->buffer_trace_node_index);
2319 /* Clean up from previous run, if any */
2320 vec_free (pm->file_name);
2321 vec_free (pm->pcap_data);
2322 memset (pm, 0, sizeof (*pm));
2324 vec_validate_aligned (vnet_trace_dummy, 2048, CLIB_CACHE_LINE_BYTES);
2326 clib_spinlock_init (&(pm->lock));
2328 if (a->filename == 0)
2329 a->filename = format (0, "/tmp/dispatch.pcap%c", 0);
2331 pm->file_name = (char *) a->filename;
2332 pm->n_packets_captured = 0;
2333 pm->packet_type = PCAP_PACKET_TYPE_vpp;
2334 pm->n_packets_to_capture = a->packets_to_capture;
2336 foreach_vlib_main (({this_vlib_main->dispatch_pcap_enable = 1;}));
2342 foreach_vlib_main (({this_vlib_main->dispatch_pcap_enable = 0;}));
2344 vec_reset_length (vm->dispatch_buffer_trace_nodes);
2345 if (pm->n_packets_captured)
2347 clib_error_t *error;
2348 pm->n_packets_to_capture = pm->n_packets_captured;
2349 vlib_cli_output (vm, "Write %d packets to %s, and stop capture...",
2350 pm->n_packets_captured, pm->file_name);
2351 error = pcap_write (pm);
2352 if (pm->flags & PCAP_MAIN_INIT_DONE)
2354 /* Report I/O errors... */
2357 clib_error_report (error);
2358 return -11; /* VNET_API_ERROR_SYSCALL_ERROR_1 */
2363 return -6; /* VNET_API_ERROR_NO_SUCH_ENTRY */
2369 static clib_error_t *
2370 dispatch_trace_command_fn (vlib_main_t * vm,
2371 unformat_input_t * input, vlib_cli_command_t * cmd)
2373 unformat_input_t _line_input, *line_input = &_line_input;
2374 vlib_pcap_dispatch_trace_args_t _a, *a = &_a;
2380 u32 node_index = ~0, buffer_traces_to_capture = 100;
2382 /* Get a line of input. */
2383 if (!unformat_user (input, unformat_line_input, line_input))
2386 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2388 if (unformat (line_input, "on %=", &enable, 1))
2390 else if (unformat (line_input, "enable %=", &enable, 1))
2392 else if (unformat (line_input, "off %=", &enable, 0))
2394 else if (unformat (line_input, "disable %=", &enable, 0))
2396 else if (unformat (line_input, "max %d", &max))
2398 else if (unformat (line_input, "packets-to-capture %d", &max))
2400 else if (unformat (line_input, "file %U", unformat_vlib_tmpfile,
2403 else if (unformat (line_input, "status %=", &status, 1))
2405 else if (unformat (line_input, "buffer-trace %U %d",
2406 unformat_vlib_node, vm, &node_index,
2407 &buffer_traces_to_capture))
2411 return clib_error_return (0, "unknown input `%U'",
2412 format_unformat_error, line_input);
2416 unformat_free (line_input);
2418 /* no need for memset (a, 0, sizeof (*a)), set all fields here. */
2419 a->filename = filename;
2422 a->packets_to_capture = max;
2423 a->buffer_trace_node_index = node_index;
2424 a->buffer_traces_to_capture = buffer_traces_to_capture;
2426 rv = vlib_pcap_dispatch_trace_configure (a);
2434 return clib_error_return (0, "dispatch trace already enabled...");
2437 return clib_error_return (0, "dispatch trace already disabled...");
2440 return clib_error_return
2441 (0, "can't change number of records to capture while tracing...");
2444 return clib_error_return (0, "I/O writing trace capture...");
2447 return clib_error_return (0, "No packets captured...");
2450 vlib_cli_output (vm, "WARNING: trace configure returned %d", rv);
2457 * This command is used to start or stop pcap dispatch trace capture, or show
2458 * the capture status.
2460 * This command has the following optional parameters:
2462 * - <b>on|off</b> - Used to start or stop capture.
2464 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2465 * of packets have been received, buffer is flushed to file. Once another
2466 * '<em>nn</em>' number of packets have been received, buffer is flushed
2467 * to file, overwriting previous write. If not entered, value defaults
2468 * to 100. Can only be updated if packet capture is off.
2470 * - <b>file <name></b> - Used to specify the output filename. The file will
2471 * be placed in the '<em>/tmp</em>' directory, so only the filename is
2472 * supported. Directory should not be entered. If file already exists, file
2473 * will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
2474 * will be used. Can only be updated if packet capture is off.
2476 * - <b>status</b> - Displays the current status and configured attributes
2477 * associated with a packet capture. If packet capture is in progress,
2478 * '<em>status</em>' also will return the number of packets currently in
2479 * the local buffer. All additional attributes entered on command line
2480 * with '<em>status</em>' will be ignored and not applied.
2483 * Example of how to display the status of capture when off:
2484 * @cliexstart{pcap dispatch trace status}
2485 * max is 100, for any interface to file /tmp/vpe.pcap
2486 * pcap dispatch capture is off...
2488 * Example of how to start a dispatch trace capture:
2489 * @cliexstart{pcap dispatch trace on max 35 file dispatchTrace.pcap}
2490 * pcap dispatch capture on...
2492 * Example of how to start a dispatch trace capture with buffer tracing
2493 * @cliexstart{pcap dispatch trace on max 10000 file dispatchTrace.pcap buffer-trace dpdk-input 1000}
2494 * pcap dispatch capture on...
2496 * Example of how to display the status of a tx packet capture in progress:
2497 * @cliexstart{pcap tx trace status}
2498 * max is 35, dispatch trace to file /tmp/vppTest.pcap
2499 * pcap tx capture is on: 20 of 35 pkts...
2501 * Example of how to stop a tx packet capture:
2502 * @cliexstart{vppctl pcap dispatch trace off}
2503 * captured 21 pkts...
2504 * saved to /tmp/dispatchTrace.pcap...
2508 VLIB_CLI_COMMAND (pcap_dispatch_trace_command, static) = {
2509 .path = "pcap dispatch trace",
2511 "pcap dispatch trace [on|off] [max <nn>] [file <name>] [status]\n"
2512 " [buffer-trace <input-node-name> <nn>]",
2513 .function = dispatch_trace_command_fn,
2518 * fd.io coding-style-patch-verification: ON
2521 * eval: (c-set-style "gnu")