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 inline vlib_frame_size_t *
95 get_frame_size_info (vlib_node_main_t * nm,
96 u32 n_scalar_bytes, u32 n_vector_bytes)
98 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
99 uword key = (n_scalar_bytes << 16) | n_vector_bytes;
102 p = hash_get (nm->frame_size_hash, key);
107 i = vec_len (nm->frame_sizes);
108 vec_validate (nm->frame_sizes, i);
109 hash_set (nm->frame_size_hash, key, i);
112 return vec_elt_at_index (nm->frame_sizes, i);
114 ASSERT (vlib_frame_bytes (n_scalar_bytes, n_vector_bytes)
115 == (vlib_frame_bytes (0, 4)));
116 return vec_elt_at_index (nm->frame_sizes, 0);
121 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
124 vlib_node_main_t *nm = &vm->node_main;
125 vlib_frame_size_t *fs;
126 vlib_node_t *to_node;
128 u32 fi, l, n, scalar_size, vector_size;
130 to_node = vlib_get_node (vm, to_node_index);
132 scalar_size = to_node->scalar_size;
133 vector_size = to_node->vector_size;
135 fs = get_frame_size_info (nm, scalar_size, vector_size);
136 n = vlib_frame_bytes (scalar_size, vector_size);
137 if ((l = vec_len (fs->free_frame_indices)) > 0)
139 /* Allocate from end of free list. */
140 fi = fs->free_frame_indices[l - 1];
141 f = vlib_get_frame_no_check (vm, fi);
142 _vec_len (fs->free_frame_indices) = l - 1;
146 f = clib_mem_alloc_aligned_no_fail (n, VLIB_FRAME_ALIGN);
147 fi = vlib_frame_index_no_check (vm, f);
150 /* Poison frame when debugging. */
152 clib_memset (f, 0xfe, n);
154 /* Insert magic number. */
158 magic = vlib_frame_find_magic (f, to_node);
159 *magic = VLIB_FRAME_MAGIC;
162 f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
164 f->scalar_size = scalar_size;
165 f->vector_size = vector_size;
168 fs->n_alloc_frames += 1;
173 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
174 Returns frame index. */
176 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
179 vlib_node_t *from_node;
181 from_node = vlib_get_node (vm, from_node_runtime->node_index);
182 ASSERT (to_next_index < vec_len (from_node->next_nodes));
184 return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
185 /* frame_flags */ 0);
189 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
191 u32 fi = vlib_frame_alloc_to_node (vm, to_node_index,
193 VLIB_FRAME_FREE_AFTER_DISPATCH);
194 return vlib_get_frame (vm, fi);
198 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
200 vlib_pending_frame_t *p;
201 vlib_node_t *to_node;
203 if (f->n_vectors == 0)
206 to_node = vlib_get_node (vm, to_node_index);
208 vec_add2 (vm->node_main.pending_frames, p, 1);
210 f->frame_flags |= VLIB_FRAME_PENDING;
211 p->frame_index = vlib_frame_index (vm, f);
212 p->node_runtime_index = to_node->runtime_index;
213 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
216 /* Free given frame. */
218 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
220 vlib_node_main_t *nm = &vm->node_main;
222 vlib_frame_size_t *fs;
225 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
227 node = vlib_get_node (vm, r->node_index);
228 fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
230 frame_index = vlib_frame_index (vm, f);
232 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
234 /* No next frames may point to freed frame. */
237 vlib_next_frame_t *nf;
238 vec_foreach (nf, vm->node_main.next_frames)
239 ASSERT (nf->frame_index != frame_index);
242 f->frame_flags &= ~(VLIB_FRAME_IS_ALLOCATED | VLIB_FRAME_NO_APPEND);
244 vec_add1 (fs->free_frame_indices, frame_index);
245 ASSERT (fs->n_alloc_frames > 0);
246 fs->n_alloc_frames -= 1;
249 static clib_error_t *
250 show_frame_stats (vlib_main_t * vm,
251 unformat_input_t * input, vlib_cli_command_t * cmd)
253 vlib_node_main_t *nm = &vm->node_main;
254 vlib_frame_size_t *fs;
256 vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
257 vec_foreach (fs, nm->frame_sizes)
259 u32 n_alloc = fs->n_alloc_frames;
260 u32 n_free = vec_len (fs->free_frame_indices);
262 if (n_alloc + n_free > 0)
263 vlib_cli_output (vm, "%=6d%=12d%=12d",
264 fs - nm->frame_sizes, n_alloc, n_free);
271 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
272 .path = "show vlib frame-allocation",
273 .short_help = "Show node dispatch frame statistics",
274 .function = show_frame_stats,
278 /* Change ownership of enqueue rights to given next node. */
280 vlib_next_frame_change_ownership (vlib_main_t * vm,
281 vlib_node_runtime_t * node_runtime,
284 vlib_node_main_t *nm = &vm->node_main;
285 vlib_next_frame_t *next_frame;
286 vlib_node_t *node, *next_node;
288 node = vec_elt (nm->nodes, node_runtime->node_index);
290 /* Only internal & input nodes are allowed to call other nodes. */
291 ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
292 || node->type == VLIB_NODE_TYPE_INPUT
293 || node->type == VLIB_NODE_TYPE_PROCESS);
295 ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
298 vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
299 next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
301 if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
303 /* Get frame from previous owner. */
304 vlib_next_frame_t *owner_next_frame;
305 vlib_next_frame_t tmp;
308 vlib_node_get_next_frame (vm,
309 next_node->owner_node_index,
310 next_node->owner_next_index);
312 /* Swap target next frame with owner's. */
313 tmp = owner_next_frame[0];
314 owner_next_frame[0] = next_frame[0];
318 * If next_frame is already pending, we have to track down
319 * all pending frames and fix their next_frame_index fields.
321 if (next_frame->flags & VLIB_FRAME_PENDING)
323 vlib_pending_frame_t *p;
324 if (next_frame->frame_index != ~0)
326 vec_foreach (p, nm->pending_frames)
328 if (p->frame_index == next_frame->frame_index)
330 p->next_frame_index =
331 next_frame - vm->node_main.next_frames;
339 /* No previous owner. Take ownership. */
340 next_frame->flags |= VLIB_FRAME_OWNER;
343 /* Record new owner. */
344 next_node->owner_node_index = node->index;
345 next_node->owner_next_index = next_index;
347 /* Now we should be owner. */
348 ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
351 /* Make sure that magic number is still there.
352 Otherwise, it is likely that caller has overrun frame arguments. */
354 validate_frame_magic (vlib_main_t * vm,
355 vlib_frame_t * f, vlib_node_t * n, uword next_index)
357 vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
358 u32 *magic = vlib_frame_find_magic (f, next_node);
359 ASSERT (VLIB_FRAME_MAGIC == magic[0]);
363 vlib_get_next_frame_internal (vlib_main_t * vm,
364 vlib_node_runtime_t * node,
365 u32 next_index, u32 allocate_new_next_frame)
368 vlib_next_frame_t *nf;
371 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
373 /* Make sure this next frame owns right to enqueue to destination frame. */
374 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
375 vlib_next_frame_change_ownership (vm, node, next_index);
377 /* ??? Don't need valid flag: can use frame_index == ~0 */
378 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
380 nf->frame_index = vlib_frame_alloc (vm, node, next_index);
381 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
384 f = vlib_get_frame (vm, nf->frame_index);
386 /* Has frame been removed from pending vector (e.g. finished dispatching)?
387 If so we can reuse frame. */
388 if ((nf->flags & VLIB_FRAME_PENDING)
389 && !(f->frame_flags & VLIB_FRAME_PENDING))
391 nf->flags &= ~VLIB_FRAME_PENDING;
396 /* Allocate new frame if current one is marked as no-append or
397 it is already full. */
398 n_used = f->n_vectors;
399 if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0) ||
400 (f->frame_flags & VLIB_FRAME_NO_APPEND))
402 /* Old frame may need to be freed after dispatch, since we'll have
403 two redundant frames from node -> next node. */
404 if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
406 vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame_index);
407 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
410 /* Allocate new frame to replace full one. */
411 nf->frame_index = vlib_frame_alloc (vm, node, next_index);
412 f = vlib_get_frame (vm, nf->frame_index);
413 n_used = f->n_vectors;
416 /* Should have free vectors in frame now. */
417 ASSERT (n_used < VLIB_FRAME_SIZE);
421 validate_frame_magic (vm, f,
422 vlib_get_node (vm, node->node_index), next_index);
429 vlib_put_next_frame_validate (vlib_main_t * vm,
430 vlib_node_runtime_t * rt,
431 u32 next_index, u32 n_vectors_left)
433 vlib_node_main_t *nm = &vm->node_main;
434 vlib_next_frame_t *nf;
436 vlib_node_runtime_t *next_rt;
437 vlib_node_t *next_node;
438 u32 n_before, n_after;
440 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
441 f = vlib_get_frame (vm, nf->frame_index);
443 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
444 n_after = VLIB_FRAME_SIZE - n_vectors_left;
445 n_before = f->n_vectors;
447 ASSERT (n_after >= n_before);
449 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
450 nf->node_runtime_index);
451 next_node = vlib_get_node (vm, next_rt->node_index);
452 if (n_after > 0 && next_node->validate_frame)
454 u8 *msg = next_node->validate_frame (vm, rt, f);
457 clib_warning ("%v", msg);
465 vlib_put_next_frame (vlib_main_t * vm,
466 vlib_node_runtime_t * r,
467 u32 next_index, u32 n_vectors_left)
469 vlib_node_main_t *nm = &vm->node_main;
470 vlib_next_frame_t *nf;
472 u32 n_vectors_in_frame;
475 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
477 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
478 f = vlib_get_frame (vm, nf->frame_index);
480 /* Make sure that magic number is still there. Otherwise, caller
481 has overrun frame meta data. */
484 vlib_node_t *node = vlib_get_node (vm, r->node_index);
485 validate_frame_magic (vm, f, node, next_index);
488 /* Convert # of vectors left -> number of vectors there. */
489 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
490 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
492 f->n_vectors = n_vectors_in_frame;
494 /* If vectors were added to frame, add to pending vector. */
495 if (PREDICT_TRUE (n_vectors_in_frame > 0))
497 vlib_pending_frame_t *p;
500 r->cached_next_index = next_index;
502 if (!(f->frame_flags & VLIB_FRAME_PENDING))
504 __attribute__ ((unused)) vlib_node_t *node;
505 vlib_node_t *next_node;
506 vlib_node_runtime_t *next_runtime;
508 node = vlib_get_node (vm, r->node_index);
509 next_node = vlib_get_next_node (vm, r->node_index, next_index);
510 next_runtime = vlib_node_get_runtime (vm, next_node->index);
512 vec_add2 (nm->pending_frames, p, 1);
514 p->frame_index = nf->frame_index;
515 p->node_runtime_index = nf->node_runtime_index;
516 p->next_frame_index = nf - nm->next_frames;
517 nf->flags |= VLIB_FRAME_PENDING;
518 f->frame_flags |= VLIB_FRAME_PENDING;
521 * If we're going to dispatch this frame on another thread,
522 * force allocation of a new frame. Otherwise, we create
523 * a dangling frame reference. Each thread has its own copy of
524 * the next_frames vector.
526 if (0 && r->thread_index != next_runtime->thread_index)
528 nf->frame_index = ~0;
529 nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
533 /* Copy trace flag from next_frame and from runtime. */
535 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
536 flags & VLIB_NODE_FLAG_TRACE);
538 v0 = nf->vectors_since_last_overflow;
539 v1 = v0 + n_vectors_in_frame;
540 nf->vectors_since_last_overflow = v1;
541 if (PREDICT_FALSE (v1 < v0))
543 vlib_node_t *node = vlib_get_node (vm, r->node_index);
544 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
549 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
551 vlib_node_runtime_sync_stats (vlib_main_t * vm,
552 vlib_node_runtime_t * r,
553 uword n_calls, uword n_vectors, uword n_clocks,
554 uword n_ticks0, uword n_ticks1)
556 vlib_node_t *n = vlib_get_node (vm, r->node_index);
558 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
559 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
560 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
561 n->stats_total.perf_counter0_ticks += n_ticks0 +
562 r->perf_counter0_ticks_since_last_overflow;
563 n->stats_total.perf_counter1_ticks += n_ticks1 +
564 r->perf_counter1_ticks_since_last_overflow;
565 n->stats_total.perf_counter_vectors += n_vectors +
566 r->perf_counter_vectors_since_last_overflow;
567 n->stats_total.max_clock = r->max_clock;
568 n->stats_total.max_clock_n = r->max_clock_n;
570 r->calls_since_last_overflow = 0;
571 r->vectors_since_last_overflow = 0;
572 r->clocks_since_last_overflow = 0;
573 r->perf_counter0_ticks_since_last_overflow = 0ULL;
574 r->perf_counter1_ticks_since_last_overflow = 0ULL;
575 r->perf_counter_vectors_since_last_overflow = 0ULL;
578 always_inline void __attribute__ ((unused))
579 vlib_process_sync_stats (vlib_main_t * vm,
581 uword n_calls, uword n_vectors, uword n_clocks,
582 uword n_ticks0, uword n_ticks1)
584 vlib_node_runtime_t *rt = &p->node_runtime;
585 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
586 vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks,
588 n->stats_total.suspends += p->n_suspends;
593 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
595 vlib_node_runtime_t *rt;
597 if (n->type == VLIB_NODE_TYPE_PROCESS)
599 /* Nothing to do for PROCESS nodes except in main thread */
600 if (vm != &vlib_global_main)
603 vlib_process_t *p = vlib_get_process_from_node (vm, n);
604 n->stats_total.suspends += p->n_suspends;
606 rt = &p->node_runtime;
610 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
613 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0, 0, 0);
615 /* Sync up runtime next frame vector counters with main node structure. */
617 vlib_next_frame_t *nf;
619 for (i = 0; i < rt->n_next_nodes; i++)
621 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
622 vec_elt (n->n_vectors_by_next_node, i) +=
623 nf->vectors_since_last_overflow;
624 nf->vectors_since_last_overflow = 0;
630 vlib_node_runtime_update_stats (vlib_main_t * vm,
631 vlib_node_runtime_t * node,
633 uword n_vectors, uword n_clocks,
634 uword n_ticks0, uword n_ticks1)
636 u32 ca0, ca1, v0, v1, cl0, cl1, r;
637 u32 ptick00, ptick01, ptick10, ptick11, pvec0, pvec1;
639 cl0 = cl1 = node->clocks_since_last_overflow;
640 ca0 = ca1 = node->calls_since_last_overflow;
641 v0 = v1 = node->vectors_since_last_overflow;
642 ptick00 = ptick01 = node->perf_counter0_ticks_since_last_overflow;
643 ptick10 = ptick11 = node->perf_counter1_ticks_since_last_overflow;
644 pvec0 = pvec1 = node->perf_counter_vectors_since_last_overflow;
648 cl1 = cl0 + n_clocks;
649 ptick01 = ptick00 + n_ticks0;
650 ptick11 = ptick10 + n_ticks1;
651 pvec1 = pvec0 + n_vectors;
653 node->calls_since_last_overflow = ca1;
654 node->clocks_since_last_overflow = cl1;
655 node->vectors_since_last_overflow = v1;
656 node->perf_counter0_ticks_since_last_overflow = ptick01;
657 node->perf_counter1_ticks_since_last_overflow = ptick11;
658 node->perf_counter_vectors_since_last_overflow = pvec1;
660 node->max_clock_n = node->max_clock > n_clocks ?
661 node->max_clock_n : n_vectors;
662 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
664 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
666 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0) || (ptick01 < ptick00)
667 || (ptick11 < ptick10) || (pvec1 < pvec0))
669 node->calls_since_last_overflow = ca0;
670 node->clocks_since_last_overflow = cl0;
671 node->vectors_since_last_overflow = v0;
672 node->perf_counter0_ticks_since_last_overflow = ptick00;
673 node->perf_counter1_ticks_since_last_overflow = ptick10;
674 node->perf_counter_vectors_since_last_overflow = pvec0;
676 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks,
684 vlib_node_runtime_perf_counter (vlib_main_t * vm, u64 * pmc0, u64 * pmc1,
685 vlib_node_runtime_t * node,
686 vlib_frame_t * frame, int before_or_after)
690 if (PREDICT_FALSE (vec_len (vm->vlib_node_runtime_perf_counter_cbs) != 0))
691 clib_call_callbacks (vm->vlib_node_runtime_perf_counter_cbs, vm, pmc0,
692 pmc1, node, frame, before_or_after);
696 vlib_process_update_stats (vlib_main_t * vm,
698 uword n_calls, uword n_vectors, uword n_clocks)
700 vlib_node_runtime_update_stats (vm, &p->node_runtime,
701 n_calls, n_vectors, n_clocks, 0ULL, 0ULL);
704 static clib_error_t *
705 vlib_cli_elog_clear (vlib_main_t * vm,
706 unformat_input_t * input, vlib_cli_command_t * cmd)
708 elog_reset_buffer (&vm->elog_main);
713 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
714 .path = "event-logger clear",
715 .short_help = "Clear the event log",
716 .function = vlib_cli_elog_clear,
721 static clib_error_t *
722 elog_save_buffer (vlib_main_t * vm,
723 unformat_input_t * input, vlib_cli_command_t * cmd)
725 elog_main_t *em = &vm->elog_main;
726 char *file, *chroot_file;
727 clib_error_t *error = 0;
729 if (!unformat (input, "%s", &file))
731 vlib_cli_output (vm, "expected file name, got `%U'",
732 format_unformat_error, input);
736 /* It's fairly hard to get "../oopsie" through unformat; just in case */
737 if (strstr (file, "..") || index (file, '/'))
739 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
743 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
747 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
748 elog_n_events_in_buffer (em),
749 elog_buffer_capacity (em), chroot_file);
751 vlib_worker_thread_barrier_sync (vm);
752 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
753 vlib_worker_thread_barrier_release (vm);
754 vec_free (chroot_file);
759 elog_post_mortem_dump (void)
761 vlib_main_t *vm = &vlib_global_main;
762 elog_main_t *em = &vm->elog_main;
766 if (!vm->elog_post_mortem_dump)
769 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
770 error = elog_write_file (em, (char *) filename, 1 /* flush ring */ );
772 clib_error_report (error);
777 VLIB_CLI_COMMAND (elog_save_cli, static) = {
778 .path = "event-logger save",
779 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
780 .function = elog_save_buffer,
784 static clib_error_t *
785 elog_stop (vlib_main_t * vm,
786 unformat_input_t * input, vlib_cli_command_t * cmd)
788 elog_main_t *em = &vm->elog_main;
790 em->n_total_events_disable_limit = em->n_total_events;
792 vlib_cli_output (vm, "Stopped the event logger...");
797 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
798 .path = "event-logger stop",
799 .short_help = "Stop the event-logger",
800 .function = elog_stop,
804 static clib_error_t *
805 elog_restart (vlib_main_t * vm,
806 unformat_input_t * input, vlib_cli_command_t * cmd)
808 elog_main_t *em = &vm->elog_main;
810 em->n_total_events_disable_limit = ~0;
812 vlib_cli_output (vm, "Restarted the event logger...");
817 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
818 .path = "event-logger restart",
819 .short_help = "Restart the event-logger",
820 .function = elog_restart,
824 static clib_error_t *
825 elog_resize (vlib_main_t * vm,
826 unformat_input_t * input, vlib_cli_command_t * cmd)
828 elog_main_t *em = &vm->elog_main;
831 /* Stop the parade */
832 elog_reset_buffer (&vm->elog_main);
834 if (unformat (input, "%d", &tmp))
836 elog_alloc (em, tmp);
837 em->n_total_events_disable_limit = ~0;
840 return clib_error_return (0, "Must specify how many events in the ring");
842 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
847 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
848 .path = "event-logger resize",
849 .short_help = "event-logger resize <nnn>",
850 .function = elog_resize,
854 #endif /* CLIB_UNIX */
857 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
859 elog_main_t *em = &vm->elog_main;
860 elog_event_t *e, *es;
863 /* Show events in VLIB time since log clock starts after VLIB clock. */
864 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
865 * vm->clib_time.seconds_per_clock;
867 es = elog_peek_events (em);
868 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
870 em->n_total_events < em->n_total_events_disable_limit ?
871 "running" : "stopped");
874 vlib_cli_output (vm, "%18.9f: %U",
875 e->time + dt, format_elog_event, em, e);
877 if (n_events_to_show == 0)
884 static clib_error_t *
885 elog_show_buffer (vlib_main_t * vm,
886 unformat_input_t * input, vlib_cli_command_t * cmd)
888 u32 n_events_to_show;
889 clib_error_t *error = 0;
891 n_events_to_show = 250;
892 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
894 if (unformat (input, "%d", &n_events_to_show))
896 else if (unformat (input, "all"))
897 n_events_to_show = ~0;
899 return unformat_parse_error (input);
901 elog_show_buffer_internal (vm, n_events_to_show);
906 VLIB_CLI_COMMAND (elog_show_cli, static) = {
907 .path = "show event-logger",
908 .short_help = "Show event logger info",
909 .function = elog_show_buffer,
914 vlib_gdb_show_event_log (void)
916 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
920 vlib_elog_main_loop_event (vlib_main_t * vm,
922 u64 time, u32 n_vectors, u32 is_return)
924 vlib_main_t *evm = &vlib_global_main;
925 elog_main_t *em = &evm->elog_main;
926 int enabled = evm->elog_trace_graph_dispatch |
927 evm->elog_trace_graph_circuit;
929 if (PREDICT_FALSE (enabled && n_vectors))
931 if (PREDICT_FALSE (!elog_is_enabled (em)))
933 evm->elog_trace_graph_dispatch = 0;
934 evm->elog_trace_graph_circuit = 0;
938 (evm->elog_trace_graph_dispatch ||
939 (evm->elog_trace_graph_circuit &&
940 node_index == evm->elog_trace_graph_circuit_node_index)))
944 vec_elt_at_index (is_return
945 ? evm->node_return_elog_event_types
946 : evm->node_call_elog_event_types,
950 &vlib_worker_threads[vm->thread_index].elog_track
951 : &em->default_track),
952 /* data to log */ n_vectors);
957 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
958 void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 node_index);
959 void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
962 vlib_buffer_trace_trajectory_init (vlib_buffer_t * b)
964 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_init_cb != 0))
966 (*vlib_buffer_trace_trajectory_init_cb) (b);
973 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
975 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
976 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_cb != 0))
978 (*vlib_buffer_trace_trajectory_cb) (b, node_index);
983 u8 *format_vnet_buffer_flags (u8 * s, va_list * args) __attribute__ ((weak));
985 format_vnet_buffer_flags (u8 * s, va_list * args)
987 s = format (s, "BUG STUB %s", __FUNCTION__);
991 u8 *format_vnet_buffer_opaque (u8 * s, va_list * args) __attribute__ ((weak));
993 format_vnet_buffer_opaque (u8 * s, va_list * args)
995 s = format (s, "BUG STUB %s", __FUNCTION__);
999 u8 *format_vnet_buffer_opaque2 (u8 * s, va_list * args)
1000 __attribute__ ((weak));
1002 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
1004 s = format (s, "BUG STUB %s", __FUNCTION__);
1009 format_buffer_metadata (u8 * s, va_list * args)
1011 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
1013 s = format (s, "flags: %U\n", format_vnet_buffer_flags, b);
1014 s = format (s, "current_data: %d, current_length: %d\n",
1015 (i32) (b->current_data), (i32) (b->current_length));
1016 s = format (s, "current_config_index: %d, flow_id: %x, next_buffer: %x\n",
1017 b->current_config_index, b->flow_id, b->next_buffer);
1018 s = format (s, "error: %d, ref_count: %d, buffer_pool_index: %d\n",
1019 (u32) (b->error), (u32) (b->ref_count),
1020 (u32) (b->buffer_pool_index));
1022 "trace_index: %d, len_not_first_buf: %d\n",
1023 b->trace_index, b->total_length_not_including_first_buffer);
1027 #define A(x) vec_add1(vm->pcap_buffer, (x))
1030 dispatch_pcap_trace (vlib_main_t * vm,
1031 vlib_node_runtime_t * node, vlib_frame_t * frame)
1034 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **bufp, *b;
1035 pcap_main_t *pm = &vm->dispatch_pcap_main;
1036 vlib_trace_main_t *tm = &vm->trace_main;
1040 f64 time_now = vlib_time_now (vm);
1045 /* Input nodes don't have frames yet */
1046 if (frame == 0 || frame->n_vectors == 0)
1049 from = vlib_frame_vector_args (frame);
1050 vlib_get_buffers (vm, from, bufs, frame->n_vectors);
1053 n = vlib_get_node (vm, node->node_index);
1055 for (i = 0; i < frame->n_vectors; i++)
1057 if (PREDICT_TRUE (pm->n_packets_captured < pm->n_packets_to_capture))
1061 vec_reset_length (vm->pcap_buffer);
1064 /* Version, flags */
1065 A ((u8) VLIB_PCAP_MAJOR_VERSION);
1066 A ((u8) VLIB_PCAP_MINOR_VERSION);
1067 A (0 /* string_count */ );
1068 A (n->protocol_hint);
1070 /* Buffer index (big endian) */
1071 A ((from[i] >> 24) & 0xff);
1072 A ((from[i] >> 16) & 0xff);
1073 A ((from[i] >> 8) & 0xff);
1074 A ((from[i] >> 0) & 0xff);
1076 /* Node name, NULL-terminated ASCII */
1077 vm->pcap_buffer = format (vm->pcap_buffer, "%v%c", n->name, 0);
1080 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1081 format_buffer_metadata, b, 0);
1083 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1084 format_vnet_buffer_opaque, b, 0);
1086 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1087 format_vnet_buffer_opaque2, b, 0);
1090 /* Is this packet traced? */
1091 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1093 vlib_trace_header_t **h
1094 = pool_elt_at_index (tm->trace_buffer_pool, b->trace_index);
1096 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1097 format_vlib_trace, vm, h[0], 0);
1101 /* Save the string count */
1102 vm->pcap_buffer[2] = string_count;
1104 /* Figure out how many bytes in the pcap trace */
1105 capture_size = vec_len (vm->pcap_buffer) +
1106 +vlib_buffer_length_in_chain (vm, b);
1108 clib_spinlock_lock_if_init (&pm->lock);
1109 n_left = clib_min (capture_size, 16384);
1110 d = pcap_add_packet (pm, time_now, n_left, capture_size);
1112 /* Copy the header */
1113 clib_memcpy_fast (d, vm->pcap_buffer, vec_len (vm->pcap_buffer));
1114 d += vec_len (vm->pcap_buffer);
1117 (vlib_buffer_length_in_chain (vm, b),
1118 (16384 - vec_len (vm->pcap_buffer)));
1119 /* Copy the packet data */
1122 u32 copy_length = clib_min ((u32) n_left, b->current_length);
1123 clib_memcpy_fast (d, b->data + b->current_data, copy_length);
1124 n_left -= b->current_length;
1127 d += b->current_length;
1128 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
1129 b = vlib_get_buffer (vm, b->next_buffer);
1131 clib_spinlock_unlock_if_init (&pm->lock);
1136 static_always_inline u64
1137 dispatch_node (vlib_main_t * vm,
1138 vlib_node_runtime_t * node,
1139 vlib_node_type_t type,
1140 vlib_node_state_t dispatch_state,
1141 vlib_frame_t * frame, u64 last_time_stamp)
1145 vlib_node_main_t *nm = &vm->node_main;
1146 vlib_next_frame_t *nf;
1147 u64 pmc_before[2], pmc_after[2], pmc_delta[2];
1151 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1152 ASSERT (n->type == type);
1155 /* Only non-internal nodes may be disabled. */
1156 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
1158 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
1159 return last_time_stamp;
1162 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
1163 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
1165 u32 c = node->input_main_loops_per_call;
1166 /* Only call node when count reaches zero. */
1169 node->input_main_loops_per_call = c - 1;
1170 return last_time_stamp;
1174 /* Speculatively prefetch next frames. */
1175 if (node->n_next_nodes > 0)
1177 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
1178 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
1181 vm->cpu_time_last_node_dispatch = last_time_stamp;
1183 vlib_elog_main_loop_event (vm, node->node_index,
1184 last_time_stamp, frame ? frame->n_vectors : 0,
1187 vlib_node_runtime_perf_counter (vm, &pmc_before[0], &pmc_before[1],
1188 node, frame, 0 /* before */ );
1191 * Turn this on if you run into
1192 * "bad monkey" contexts, and you want to know exactly
1193 * which nodes they've visited... See ixge.c...
1195 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
1199 from = vlib_frame_vector_args (frame);
1200 for (i = 0; i < frame->n_vectors; i++)
1202 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1203 add_trajectory_trace (b, node->node_index);
1205 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1206 dispatch_pcap_trace (vm, node, frame);
1207 n = node->function (vm, node, frame);
1211 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1212 dispatch_pcap_trace (vm, node, frame);
1213 n = node->function (vm, node, frame);
1216 t = clib_cpu_time_now ();
1219 * To validate accounting: pmc_delta = t - pmc_before;
1220 * perf ticks should equal clocks/pkt...
1222 vlib_node_runtime_perf_counter (vm, &pmc_after[0], &pmc_after[1], node,
1223 frame, 1 /* after */ );
1225 pmc_delta[0] = pmc_after[0] - pmc_before[0];
1226 pmc_delta[1] = pmc_after[1] - pmc_before[1];
1228 vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
1230 vm->main_loop_vectors_processed += n;
1231 vm->main_loop_nodes_processed += n > 0;
1233 v = vlib_node_runtime_update_stats (vm, node,
1236 /* n_clocks */ t - last_time_stamp,
1237 pmc_delta[0] /* PMC0 */ ,
1238 pmc_delta[1] /* PMC1 */ );
1240 /* When in interrupt mode and vector rate crosses threshold switch to
1242 if (PREDICT_FALSE ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1243 || (dispatch_state == VLIB_NODE_STATE_POLLING
1246 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))))
1249 ELOG_TYPE_DECLARE (e) =
1251 .function = (char *) __FUNCTION__,
1252 .format = "%s vector length %d, switching to %s",
1253 .format_args = "T4i4t4",
1254 .n_enum_strings = 2,
1256 "interrupt", "polling",
1262 u32 node_name, vector_length, is_polling;
1265 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1266 && v >= nm->polling_threshold_vector_length) &&
1268 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1270 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1271 n->state = VLIB_NODE_STATE_POLLING;
1272 node->state = VLIB_NODE_STATE_POLLING;
1274 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1275 node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1276 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1277 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1279 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1281 vlib_worker_thread_t *w = vlib_worker_threads
1284 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1286 ed->node_name = n->name_elog_string;
1287 ed->vector_length = v;
1291 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1292 && v <= nm->interrupt_threshold_vector_length)
1294 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1296 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1298 /* Switch to interrupt mode after dispatch in polling one more time.
1299 This allows driver to re-enable interrupts. */
1300 n->state = VLIB_NODE_STATE_INTERRUPT;
1301 node->state = VLIB_NODE_STATE_INTERRUPT;
1303 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1304 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1305 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
1310 vlib_worker_thread_t *w = vlib_worker_threads
1313 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1314 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1316 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1318 ed->node_name = n->name_elog_string;
1319 ed->vector_length = v;
1330 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1331 u64 last_time_stamp)
1333 vlib_node_main_t *nm = &vm->node_main;
1335 vlib_next_frame_t *nf, nf_dummy;
1336 vlib_node_runtime_t *n;
1337 u32 restore_frame_index;
1338 vlib_pending_frame_t *p;
1340 /* See comment below about dangling references to nm->pending_frames */
1341 p = nm->pending_frames + pending_frame_index;
1343 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1344 p->node_runtime_index);
1346 f = vlib_get_frame (vm, p->frame_index);
1347 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1349 /* No next frame: so use dummy on stack. */
1351 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1352 nf->frame_index = ~p->frame_index;
1355 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1357 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1359 /* Force allocation of new frame while current frame is being
1361 restore_frame_index = ~0;
1362 if (nf->frame_index == p->frame_index)
1364 nf->frame_index = ~0;
1365 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1366 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1367 restore_frame_index = p->frame_index;
1370 /* Frame must be pending. */
1371 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1372 ASSERT (f->n_vectors > 0);
1374 /* Copy trace flag from next frame to node.
1375 Trace flag indicates that at least one vector in the dispatched
1377 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1378 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1379 nf->flags &= ~VLIB_FRAME_TRACE;
1381 last_time_stamp = dispatch_node (vm, n,
1382 VLIB_NODE_TYPE_INTERNAL,
1383 VLIB_NODE_STATE_POLLING,
1384 f, last_time_stamp);
1386 f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
1388 /* Frame is ready to be used again, so restore it. */
1389 if (restore_frame_index != ~0)
1392 * We musn't restore a frame that is flagged to be freed. This
1393 * shouldn't happen since frames to be freed post dispatch are
1394 * those used when the to-node frame becomes full i.e. they form a
1395 * sort of queue of frames to a single node. If we get here then
1396 * the to-node frame and the pending frame *were* the same, and so
1397 * we removed the to-node frame. Therefore this frame is no
1398 * longer part of the queue for that node and hence it cannot be
1401 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1404 * NB: dispatching node n can result in the creation and scheduling
1405 * of new frames, and hence in the reallocation of nm->pending_frames.
1406 * Recompute p, or no supper. This was broken for more than 10 years.
1408 p = nm->pending_frames + pending_frame_index;
1411 * p->next_frame_index can change during node dispatch if node
1412 * function decides to change graph hook up.
1414 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1415 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1417 if (~0 == nf->frame_index)
1419 /* no new frame has been assigned to this node, use the saved one */
1420 nf->frame_index = restore_frame_index;
1425 /* The node has gained a frame, implying packets from the current frame
1426 were re-queued to this same node. we don't need the saved one
1428 vlib_frame_free (vm, n, f);
1433 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1435 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1436 vlib_frame_free (vm, n, f);
1440 return last_time_stamp;
1444 vlib_process_stack_is_valid (vlib_process_t * p)
1446 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1452 vlib_process_t *process;
1453 vlib_frame_t *frame;
1454 } vlib_process_bootstrap_args_t;
1456 /* Called in process stack. */
1458 vlib_process_bootstrap (uword _a)
1460 vlib_process_bootstrap_args_t *a;
1462 vlib_node_runtime_t *node;
1467 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1472 node = &p->node_runtime;
1474 n = node->function (vm, node, f);
1476 ASSERT (vlib_process_stack_is_valid (p));
1478 clib_longjmp (&p->return_longjmp, n);
1483 /* Called in main stack. */
1484 static_always_inline uword
1485 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1487 vlib_process_bootstrap_args_t a;
1494 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1495 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1496 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1497 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1502 static_always_inline uword
1503 vlib_process_resume (vlib_process_t * p)
1506 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1507 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1508 | VLIB_PROCESS_RESUME_PENDING);
1509 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1510 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1511 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1516 dispatch_process (vlib_main_t * vm,
1517 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1519 vlib_node_main_t *nm = &vm->node_main;
1520 vlib_node_runtime_t *node_runtime = &p->node_runtime;
1521 vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1522 u32 old_process_index;
1524 uword n_vectors, is_suspend;
1526 if (node->state != VLIB_NODE_STATE_POLLING
1527 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1528 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1529 return last_time_stamp;
1531 p->flags |= VLIB_PROCESS_IS_RUNNING;
1533 t = last_time_stamp;
1534 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1535 f ? f->n_vectors : 0, /* is_after */ 0);
1537 /* Save away current process for suspend. */
1538 old_process_index = nm->current_process_index;
1539 nm->current_process_index = node->runtime_index;
1541 n_vectors = vlib_process_startup (vm, p, f);
1543 nm->current_process_index = old_process_index;
1545 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1546 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1549 vlib_pending_frame_t *pf;
1552 pool_get (nm->suspended_process_frames, pf);
1553 pf->node_runtime_index = node->runtime_index;
1554 pf->frame_index = f ? vlib_frame_index (vm, f) : ~0;
1555 pf->next_frame_index = ~0;
1558 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1560 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1562 TWT (tw_timer_wheel) * tw =
1563 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1564 p->stop_timer_handle =
1565 TW (tw_timer_start) (tw,
1566 vlib_timing_wheel_data_set_suspended_process
1567 (node->runtime_index) /* [sic] pool idex */ ,
1569 p->resume_clock_interval);
1573 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1575 t = clib_cpu_time_now ();
1577 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1580 vlib_process_update_stats (vm, p,
1581 /* n_calls */ !is_suspend,
1582 /* n_vectors */ n_vectors,
1583 /* n_clocks */ t - last_time_stamp);
1589 vlib_start_process (vlib_main_t * vm, uword process_index)
1591 vlib_node_main_t *nm = &vm->node_main;
1592 vlib_process_t *p = vec_elt (nm->processes, process_index);
1593 dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1597 dispatch_suspended_process (vlib_main_t * vm,
1598 uword process_index, u64 last_time_stamp)
1600 vlib_node_main_t *nm = &vm->node_main;
1601 vlib_node_runtime_t *node_runtime;
1605 vlib_pending_frame_t *pf;
1606 u64 t, n_vectors, is_suspend;
1608 t = last_time_stamp;
1610 p = vec_elt (nm->processes, process_index);
1611 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1612 return last_time_stamp;
1614 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1615 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1617 pf = pool_elt_at_index (nm->suspended_process_frames,
1618 p->suspended_process_frame_index);
1620 node_runtime = &p->node_runtime;
1621 node = vlib_get_node (vm, node_runtime->node_index);
1622 f = pf->frame_index != ~0 ? vlib_get_frame (vm, pf->frame_index) : 0;
1624 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1625 f ? f->n_vectors : 0, /* is_after */ 0);
1627 /* Save away current process for suspend. */
1628 nm->current_process_index = node->runtime_index;
1630 n_vectors = vlib_process_resume (p);
1631 t = clib_cpu_time_now ();
1633 nm->current_process_index = ~0;
1635 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1638 /* Suspend it again. */
1641 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1643 p->stop_timer_handle =
1644 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1645 vlib_timing_wheel_data_set_suspended_process
1646 (node->runtime_index) /* [sic] pool idex */ ,
1648 p->resume_clock_interval);
1653 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1654 pool_put_index (nm->suspended_process_frames,
1655 p->suspended_process_frame_index);
1656 p->suspended_process_frame_index = ~0;
1659 t = clib_cpu_time_now ();
1660 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1663 vlib_process_update_stats (vm, p,
1664 /* n_calls */ !is_suspend,
1665 /* n_vectors */ n_vectors,
1666 /* n_clocks */ t - last_time_stamp);
1671 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1673 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1678 static_always_inline void
1679 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1681 vlib_node_main_t *nm = &vm->node_main;
1682 vlib_thread_main_t *tm = vlib_get_thread_main ();
1685 vlib_frame_queue_main_t *fqm;
1686 u32 *last_node_runtime_indices = 0;
1687 u32 frame_queue_check_counter = 0;
1689 /* Initialize pending node vector. */
1692 vec_resize (nm->pending_frames, 32);
1693 _vec_len (nm->pending_frames) = 0;
1696 /* Mark time of main loop start. */
1699 cpu_time_now = vm->clib_time.last_cpu_time;
1700 vm->cpu_time_main_loop_start = cpu_time_now;
1703 cpu_time_now = clib_cpu_time_now ();
1705 /* Pre-allocate interupt runtime indices and lock. */
1706 vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1707 vec_alloc (last_node_runtime_indices, 32);
1709 clib_spinlock_init (&nm->pending_interrupt_lock);
1711 /* Pre-allocate expired nodes. */
1712 if (!nm->polling_threshold_vector_length)
1713 nm->polling_threshold_vector_length = 10;
1714 if (!nm->interrupt_threshold_vector_length)
1715 nm->interrupt_threshold_vector_length = 5;
1717 vm->cpu_id = clib_get_current_cpu_id ();
1718 vm->numa_node = clib_get_current_numa_node ();
1720 /* Start all processes. */
1724 nm->current_process_index = ~0;
1725 for (i = 0; i < vec_len (nm->processes); i++)
1726 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1732 vlib_node_runtime_t *n;
1734 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1737 vl_api_send_pending_rpc_requests (vm);
1742 vlib_worker_thread_barrier_check ();
1743 if (PREDICT_FALSE (vm->check_frame_queues +
1744 frame_queue_check_counter))
1748 if (vm->check_frame_queues)
1750 frame_queue_check_counter = 100;
1751 vm->check_frame_queues = 0;
1754 vec_foreach (fqm, tm->frame_queue_mains)
1755 processed += vlib_frame_queue_dequeue (vm, fqm);
1757 /* No handoff queue work found? */
1759 frame_queue_check_counter = 100;
1761 frame_queue_check_counter--;
1763 if (PREDICT_FALSE (vec_len (vm->worker_thread_main_loop_callbacks)))
1764 clib_call_callbacks (vm->worker_thread_main_loop_callbacks, vm);
1767 /* Process pre-input nodes. */
1768 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1769 cpu_time_now = dispatch_node (vm, n,
1770 VLIB_NODE_TYPE_PRE_INPUT,
1771 VLIB_NODE_STATE_POLLING,
1775 /* Next process input nodes. */
1776 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1777 cpu_time_now = dispatch_node (vm, n,
1778 VLIB_NODE_TYPE_INPUT,
1779 VLIB_NODE_STATE_POLLING,
1783 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1784 vm->queue_signal_callback (vm);
1786 /* Next handle interrupts. */
1788 /* unlocked read, for performance */
1789 uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1791 if (PREDICT_FALSE (l > 0))
1796 clib_spinlock_lock (&nm->pending_interrupt_lock);
1797 /* Re-read w/ lock held, in case another thread added an item */
1798 l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1801 tmp = nm->pending_interrupt_node_runtime_indices;
1802 nm->pending_interrupt_node_runtime_indices =
1803 last_node_runtime_indices;
1804 last_node_runtime_indices = tmp;
1805 _vec_len (last_node_runtime_indices) = 0;
1807 clib_spinlock_unlock (&nm->pending_interrupt_lock);
1808 for (i = 0; i < l; i++)
1810 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1811 last_node_runtime_indices[i]);
1813 dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1814 VLIB_NODE_STATE_INTERRUPT,
1820 /* Input nodes may have added work to the pending vector.
1821 Process pending vector until there is nothing left.
1822 All pending vectors will be processed from input -> output. */
1823 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1824 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1825 /* Reset pending vector for next iteration. */
1826 _vec_len (nm->pending_frames) = 0;
1831 ELOG_TYPE_DECLARE (es) =
1833 .format = "process tw start",
1836 ELOG_TYPE_DECLARE (ee) =
1838 .format = "process tw end: %d",
1839 .format_args = "i4",
1848 /* Check if process nodes have expired from timing wheel. */
1849 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1851 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1852 ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1854 nm->data_from_advancing_timing_wheel =
1855 TW (tw_timer_expire_timers_vec)
1856 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1857 nm->data_from_advancing_timing_wheel);
1859 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1861 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1863 ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1865 _vec_len (nm->data_from_advancing_timing_wheel);
1869 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1873 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1876 u32 d = nm->data_from_advancing_timing_wheel[i];
1877 u32 di = vlib_timing_wheel_data_get_index (d);
1879 if (vlib_timing_wheel_data_is_timed_event (d))
1881 vlib_signal_timed_event_data_t *te =
1882 pool_elt_at_index (nm->signal_timed_event_data_pool,
1885 vlib_get_node (vm, te->process_node_index);
1887 vec_elt (nm->processes, n->runtime_index);
1890 vlib_process_signal_event_helper (nm, n, p,
1891 te->event_type_index,
1893 te->n_data_elt_bytes);
1894 if (te->n_data_bytes < sizeof (te->inline_event_data))
1895 clib_memcpy_fast (data, te->inline_event_data,
1899 clib_memcpy_fast (data, te->event_data_as_vector,
1901 vec_free (te->event_data_as_vector);
1903 pool_put (nm->signal_timed_event_data_pool, te);
1907 cpu_time_now = clib_cpu_time_now ();
1909 dispatch_suspended_process (vm, di, cpu_time_now);
1912 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1915 vlib_increment_main_loop_counter (vm);
1917 /* Record time stamp in case there are no enabled nodes and above
1918 calls do not update time stamp. */
1919 cpu_time_now = clib_cpu_time_now ();
1924 vlib_main_loop (vlib_main_t * vm)
1926 vlib_main_or_worker_loop (vm, /* is_main */ 1);
1930 vlib_worker_loop (vlib_main_t * vm)
1932 vlib_main_or_worker_loop (vm, /* is_main */ 0);
1935 vlib_main_t vlib_global_main;
1937 static clib_error_t *
1938 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1940 int turn_on_mem_trace = 0;
1942 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1944 if (unformat (input, "memory-trace"))
1945 turn_on_mem_trace = 1;
1947 else if (unformat (input, "elog-events %d",
1948 &vm->elog_main.event_ring_size))
1950 else if (unformat (input, "elog-post-mortem-dump"))
1951 vm->elog_post_mortem_dump = 1;
1953 return unformat_parse_error (input);
1956 unformat_free (input);
1958 /* Enable memory trace as early as possible. */
1959 if (turn_on_mem_trace)
1965 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1968 dummy_queue_signal_callback (vlib_main_t * vm)
1972 #define foreach_weak_reference_stub \
1973 _(vlib_map_stat_segment_init) \
1975 _(vlibmemory_init) \
1976 _(map_api_segment_init)
1979 clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
1980 clib_error_t *name (vlib_main_t *vm) { return 0; }
1981 foreach_weak_reference_stub;
1984 /* Main function. */
1986 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
1988 clib_error_t *volatile error;
1989 vlib_node_main_t *nm = &vm->node_main;
1991 vm->queue_signal_callback = dummy_queue_signal_callback;
1993 clib_time_init (&vm->clib_time);
1995 /* Turn on event log. */
1996 if (!vm->elog_main.event_ring_size)
1997 vm->elog_main.event_ring_size = 128 << 10;
1998 elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
1999 elog_enable_disable (&vm->elog_main, 1);
2005 if ((error = vlib_physmem_init (vm)))
2007 clib_error_report (error);
2011 if ((error = vlib_map_stat_segment_init (vm)))
2013 clib_error_report (error);
2017 if ((error = vlib_buffer_main_init (vm)))
2019 clib_error_report (error);
2023 if ((error = vlib_thread_init (vm)))
2025 clib_error_report (error);
2029 /* Register static nodes so that init functions may use them. */
2030 vlib_register_all_static_nodes (vm);
2032 /* Set seed for random number generator.
2033 Allow user to specify seed to make random sequence deterministic. */
2034 if (!unformat (input, "seed %wd", &vm->random_seed))
2035 vm->random_seed = clib_cpu_time_now ();
2036 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
2038 /* Initialize node graph. */
2039 if ((error = vlib_node_main_init (vm)))
2041 /* Arrange for graph hook up error to not be fatal when debugging. */
2043 clib_error_report (error);
2048 /* Direct call / weak reference, for vlib standalone use-cases */
2049 if ((error = vpe_api_init (vm)))
2051 clib_error_report (error);
2055 if ((error = vlibmemory_init (vm)))
2057 clib_error_report (error);
2061 if ((error = map_api_segment_init (vm)))
2063 clib_error_report (error);
2067 /* See unix/main.c; most likely already set up */
2068 if (vm->init_functions_called == 0)
2069 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
2070 if ((error = vlib_call_all_init_functions (vm)))
2073 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
2074 CLIB_CACHE_LINE_BYTES);
2076 vec_validate (nm->data_from_advancing_timing_wheel, 10);
2077 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
2079 /* Create the process timing wheel */
2080 TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
2081 0 /* no callback */ ,
2082 10e-6 /* timer period 10us */ ,
2083 ~0 /* max expirations per call */ );
2085 vec_validate (vm->pending_rpc_requests, 0);
2086 _vec_len (vm->pending_rpc_requests) = 0;
2087 vec_validate (vm->processing_rpc_requests, 0);
2088 _vec_len (vm->processing_rpc_requests) = 0;
2090 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
2093 /* Call all main loop enter functions. */
2095 clib_error_t *sub_error;
2096 sub_error = vlib_call_all_main_loop_enter_functions (vm);
2098 clib_error_report (sub_error);
2101 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2103 case VLIB_MAIN_LOOP_EXIT_NONE:
2104 vm->main_loop_exit_set = 1;
2107 case VLIB_MAIN_LOOP_EXIT_CLI:
2111 error = vm->main_loop_error;
2115 vlib_main_loop (vm);
2118 /* Call all exit functions. */
2120 clib_error_t *sub_error;
2121 sub_error = vlib_call_all_main_loop_exit_functions (vm);
2123 clib_error_report (sub_error);
2127 clib_error_report (error);
2132 static inline clib_error_t *
2133 pcap_dispatch_trace_command_internal (vlib_main_t * vm,
2134 unformat_input_t * input,
2135 vlib_cli_command_t * cmd, int rx_tx)
2137 unformat_input_t _line_input, *line_input = &_line_input;
2138 pcap_main_t *pm = &vm->dispatch_pcap_main;
2143 clib_error_t *error = 0;
2144 u32 node_index, add;
2145 vlib_trace_main_t *tm;
2146 vlib_trace_node_t *tn;
2148 /* Get a line of input. */
2149 if (!unformat_user (input, unformat_line_input, line_input))
2152 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2154 if (unformat (line_input, "on"))
2156 if (vm->dispatch_pcap_enable == 0)
2162 vlib_cli_output (vm, "pcap dispatch capture already on...");
2167 else if (unformat (line_input, "off"))
2169 if (vm->dispatch_pcap_enable)
2172 (vm, "captured %d pkts...", pm->n_packets_captured);
2173 if (pm->n_packets_captured)
2175 pm->n_packets_to_capture = pm->n_packets_captured;
2176 error = pcap_write (pm);
2178 clib_error_report (error);
2180 vlib_cli_output (vm, "saved to %s...", pm->file_name);
2182 vm->dispatch_pcap_enable = 0;
2186 vlib_cli_output (vm, "pcap tx capture already off...");
2191 else if (unformat (line_input, "max %d", &max))
2193 if (vm->dispatch_pcap_enable)
2197 "can't change max value while pcap tx capture active...");
2201 pm->n_packets_to_capture = max;
2205 (line_input, "file %U", unformat_vlib_tmpfile, &filename))
2207 if (vm->dispatch_pcap_enable)
2210 (vm, "can't change file while pcap tx capture active...");
2215 else if (unformat (line_input, "status"))
2217 if (vm->dispatch_pcap_enable)
2220 (vm, "pcap dispatch capture is on: %d of %d pkts...",
2221 pm->n_packets_captured, pm->n_packets_to_capture);
2222 vlib_cli_output (vm, "Capture to file %s", pm->file_name);
2226 vlib_cli_output (vm, "pcap dispatch capture is off...");
2230 else if (unformat (line_input, "buffer-trace %U %d",
2231 unformat_vlib_node, vm, &node_index, &add))
2233 if (vnet_trace_dummy == 0)
2234 vec_validate_aligned (vnet_trace_dummy, 2048,
2235 CLIB_CACHE_LINE_BYTES);
2236 vlib_cli_output (vm, "Buffer tracing of %d pkts from %U enabled...",
2237 add, format_vlib_node_name, vm, node_index);
2240 foreach_vlib_main ((
2242 tm = &this_vlib_main->trace_main;
2243 tm->verbose = 0; /* not sure this ever did anything... */
2244 vec_validate (tm->nodes, node_index);
2245 tn = tm->nodes + node_index;
2247 tm->trace_enable = 1;
2254 error = clib_error_return (0, "unknown input `%U'",
2255 format_unformat_error, line_input);
2260 unformat_free (line_input);
2264 /* Clean up from previous run */
2265 vec_free (pm->file_name);
2266 vec_free (pm->pcap_data);
2268 memset (pm, 0, sizeof (*pm));
2269 pm->n_packets_to_capture = max;
2274 filename = format (0, "/tmp/dispatch.pcap%c", 0);
2276 pm->file_name = (char *) filename;
2277 pm->n_packets_captured = 0;
2278 pm->packet_type = PCAP_PACKET_TYPE_vpp;
2280 clib_spinlock_init (&(pm->lock));
2281 vm->dispatch_pcap_enable = 1;
2282 vlib_cli_output (vm, "pcap dispatch capture on...");
2289 static clib_error_t *
2290 pcap_dispatch_trace_command_fn (vlib_main_t * vm,
2291 unformat_input_t * input,
2292 vlib_cli_command_t * cmd)
2294 return pcap_dispatch_trace_command_internal (vm, input, cmd, VLIB_RX);
2298 * This command is used to start or stop pcap dispatch trace capture, or show
2299 * the capture status.
2301 * This command has the following optional parameters:
2303 * - <b>on|off</b> - Used to start or stop capture.
2305 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2306 * of packets have been received, buffer is flushed to file. Once another
2307 * '<em>nn</em>' number of packets have been received, buffer is flushed
2308 * to file, overwriting previous write. If not entered, value defaults
2309 * to 100. Can only be updated if packet capture is off.
2311 * - <b>file <name></b> - Used to specify the output filename. The file will
2312 * be placed in the '<em>/tmp</em>' directory, so only the filename is
2313 * supported. Directory should not be entered. If file already exists, file
2314 * will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
2315 * will be used. Can only be updated if packet capture is off.
2317 * - <b>status</b> - Displays the current status and configured attributes
2318 * associated with a packet capture. If packet capture is in progress,
2319 * '<em>status</em>' also will return the number of packets currently in
2320 * the local buffer. All additional attributes entered on command line
2321 * with '<em>status</em>' will be ignored and not applied.
2324 * Example of how to display the status of capture when off:
2325 * @cliexstart{pcap dispatch trace status}
2326 * max is 100, for any interface to file /tmp/vpe.pcap
2327 * pcap dispatch capture is off...
2329 * Example of how to start a dispatch trace capture:
2330 * @cliexstart{pcap dispatch trace on max 35 file dispatchTrace.pcap}
2331 * pcap dispatch capture on...
2333 * Example of how to start a dispatch trace capture with buffer tracing
2334 * @cliexstart{pcap dispatch trace on max 10000 file dispatchTrace.pcap buffer-trace dpdk-input 1000}
2335 * pcap dispatch capture on...
2337 * Example of how to display the status of a tx packet capture in progress:
2338 * @cliexstart{pcap tx trace status}
2339 * max is 35, dispatch trace to file /tmp/vppTest.pcap
2340 * pcap tx capture is on: 20 of 35 pkts...
2342 * Example of how to stop a tx packet capture:
2343 * @cliexstart{vppctl pcap dispatch trace off}
2344 * captured 21 pkts...
2345 * saved to /tmp/dispatchTrace.pcap...
2349 VLIB_CLI_COMMAND (pcap_dispatch_trace_command, static) = {
2350 .path = "pcap dispatch trace",
2352 "pcap dispatch trace [on|off] [max <nn>] [file <name>] [status]\n"
2353 " [buffer-trace <input-node-name> <nn>]",
2354 .function = pcap_dispatch_trace_command_fn,
2359 * fd.io coding-style-patch-verification: ON
2362 * eval: (c-set-style "gnu")