2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * main.c: main vector processing loop
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
41 #include <vppinfra/format.h>
42 #include <vlib/vlib.h>
43 #include <vlib/threads.h>
44 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
46 #include <vlib/unix/unix.h>
47 #include <vlib/unix/cj.h>
49 CJ_GLOBAL_LOG_PROTOTYPE;
51 /* Actually allocate a few extra slots of vector data to support
52 speculative vector enqueues which overflow vector data in next frame. */
53 #define VLIB_FRAME_SIZE_ALLOC (VLIB_FRAME_SIZE + 4)
58 vlib_frame_bytes (u32 n_scalar_bytes, u32 n_vector_bytes)
62 /* Make room for vlib_frame_t plus scalar arguments. */
63 n_bytes = vlib_frame_vector_byte_offset (n_scalar_bytes);
65 /* Make room for vector arguments.
66 Allocate a few extra slots of vector data to support
67 speculative vector enqueues which overflow vector data in next frame. */
68 #define VLIB_FRAME_SIZE_EXTRA 4
69 n_bytes += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * n_vector_bytes;
71 /* Magic number is first 32bit number after vector data.
72 Used to make sure that vector data is never overrun. */
73 #define VLIB_FRAME_MAGIC (0xabadc0ed)
74 n_bytes += sizeof (u32);
76 /* Pad to cache line. */
77 n_bytes = round_pow2 (n_bytes, CLIB_CACHE_LINE_BYTES);
83 vlib_frame_find_magic (vlib_frame_t * f, vlib_node_t * node)
87 p += vlib_frame_vector_byte_offset (node->scalar_size);
89 p += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * node->vector_size;
94 static vlib_frame_size_t *
95 get_frame_size_info (vlib_node_main_t * nm,
96 u32 n_scalar_bytes, u32 n_vector_bytes)
98 uword key = (n_scalar_bytes << 16) | n_vector_bytes;
101 p = hash_get (nm->frame_size_hash, key);
106 i = vec_len (nm->frame_sizes);
107 vec_validate (nm->frame_sizes, i);
108 hash_set (nm->frame_size_hash, key, i);
111 return vec_elt_at_index (nm->frame_sizes, i);
115 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
118 vlib_node_main_t *nm = &vm->node_main;
119 vlib_frame_size_t *fs;
120 vlib_node_t *to_node;
122 u32 fi, l, n, scalar_size, vector_size;
124 to_node = vlib_get_node (vm, to_node_index);
126 scalar_size = to_node->scalar_size;
127 vector_size = to_node->vector_size;
129 fs = get_frame_size_info (nm, scalar_size, vector_size);
130 n = vlib_frame_bytes (scalar_size, vector_size);
131 if ((l = vec_len (fs->free_frame_indices)) > 0)
133 /* Allocate from end of free list. */
134 fi = fs->free_frame_indices[l - 1];
135 f = vlib_get_frame_no_check (vm, fi);
136 _vec_len (fs->free_frame_indices) = l - 1;
140 f = clib_mem_alloc_aligned_no_fail (n, VLIB_FRAME_ALIGN);
141 fi = vlib_frame_index_no_check (vm, f);
144 /* Poison frame when debugging. */
146 clib_memset (f, 0xfe, n);
148 /* Insert magic number. */
152 magic = vlib_frame_find_magic (f, to_node);
153 *magic = VLIB_FRAME_MAGIC;
156 f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
158 f->scalar_size = scalar_size;
159 f->vector_size = vector_size;
162 fs->n_alloc_frames += 1;
167 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
168 Returns frame index. */
170 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
173 vlib_node_t *from_node;
175 from_node = vlib_get_node (vm, from_node_runtime->node_index);
176 ASSERT (to_next_index < vec_len (from_node->next_nodes));
178 return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
179 /* frame_flags */ 0);
183 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
185 u32 fi = vlib_frame_alloc_to_node (vm, to_node_index,
187 VLIB_FRAME_FREE_AFTER_DISPATCH);
188 return vlib_get_frame (vm, fi);
192 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
194 vlib_pending_frame_t *p;
195 vlib_node_t *to_node;
197 if (f->n_vectors == 0)
200 to_node = vlib_get_node (vm, to_node_index);
202 vec_add2 (vm->node_main.pending_frames, p, 1);
204 f->frame_flags |= VLIB_FRAME_PENDING;
205 p->frame_index = vlib_frame_index (vm, f);
206 p->node_runtime_index = to_node->runtime_index;
207 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
210 /* Free given frame. */
212 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
214 vlib_node_main_t *nm = &vm->node_main;
216 vlib_frame_size_t *fs;
219 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
221 node = vlib_get_node (vm, r->node_index);
222 fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
224 frame_index = vlib_frame_index (vm, f);
226 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
228 /* No next frames may point to freed frame. */
231 vlib_next_frame_t *nf;
232 vec_foreach (nf, vm->node_main.next_frames)
233 ASSERT (nf->frame_index != frame_index);
236 f->frame_flags &= ~(VLIB_FRAME_IS_ALLOCATED | VLIB_FRAME_NO_APPEND);
238 vec_add1 (fs->free_frame_indices, frame_index);
239 ASSERT (fs->n_alloc_frames > 0);
240 fs->n_alloc_frames -= 1;
243 static clib_error_t *
244 show_frame_stats (vlib_main_t * vm,
245 unformat_input_t * input, vlib_cli_command_t * cmd)
247 vlib_node_main_t *nm = &vm->node_main;
248 vlib_frame_size_t *fs;
250 vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
251 vec_foreach (fs, nm->frame_sizes)
253 u32 n_alloc = fs->n_alloc_frames;
254 u32 n_free = vec_len (fs->free_frame_indices);
256 if (n_alloc + n_free > 0)
257 vlib_cli_output (vm, "%=6d%=12d%=12d",
258 fs - nm->frame_sizes, n_alloc, n_free);
265 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
266 .path = "show vlib frame-allocation",
267 .short_help = "Show node dispatch frame statistics",
268 .function = show_frame_stats,
272 /* Change ownership of enqueue rights to given next node. */
274 vlib_next_frame_change_ownership (vlib_main_t * vm,
275 vlib_node_runtime_t * node_runtime,
278 vlib_node_main_t *nm = &vm->node_main;
279 vlib_next_frame_t *next_frame;
280 vlib_node_t *node, *next_node;
282 node = vec_elt (nm->nodes, node_runtime->node_index);
284 /* Only internal & input nodes are allowed to call other nodes. */
285 ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
286 || node->type == VLIB_NODE_TYPE_INPUT
287 || node->type == VLIB_NODE_TYPE_PROCESS);
289 ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
292 vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
293 next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
295 if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
297 /* Get frame from previous owner. */
298 vlib_next_frame_t *owner_next_frame;
299 vlib_next_frame_t tmp;
302 vlib_node_get_next_frame (vm,
303 next_node->owner_node_index,
304 next_node->owner_next_index);
306 /* Swap target next frame with owner's. */
307 tmp = owner_next_frame[0];
308 owner_next_frame[0] = next_frame[0];
312 * If next_frame is already pending, we have to track down
313 * all pending frames and fix their next_frame_index fields.
315 if (next_frame->flags & VLIB_FRAME_PENDING)
317 vlib_pending_frame_t *p;
318 if (next_frame->frame_index != ~0)
320 vec_foreach (p, nm->pending_frames)
322 if (p->frame_index == next_frame->frame_index)
324 p->next_frame_index =
325 next_frame - vm->node_main.next_frames;
333 /* No previous owner. Take ownership. */
334 next_frame->flags |= VLIB_FRAME_OWNER;
337 /* Record new owner. */
338 next_node->owner_node_index = node->index;
339 next_node->owner_next_index = next_index;
341 /* Now we should be owner. */
342 ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
345 /* Make sure that magic number is still there.
346 Otherwise, it is likely that caller has overrun frame arguments. */
348 validate_frame_magic (vlib_main_t * vm,
349 vlib_frame_t * f, vlib_node_t * n, uword next_index)
351 vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
352 u32 *magic = vlib_frame_find_magic (f, next_node);
353 ASSERT (VLIB_FRAME_MAGIC == magic[0]);
357 vlib_get_next_frame_internal (vlib_main_t * vm,
358 vlib_node_runtime_t * node,
359 u32 next_index, u32 allocate_new_next_frame)
362 vlib_next_frame_t *nf;
365 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
367 /* Make sure this next frame owns right to enqueue to destination frame. */
368 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
369 vlib_next_frame_change_ownership (vm, node, next_index);
371 /* ??? Don't need valid flag: can use frame_index == ~0 */
372 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
374 nf->frame_index = vlib_frame_alloc (vm, node, next_index);
375 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
378 f = vlib_get_frame (vm, nf->frame_index);
380 /* Has frame been removed from pending vector (e.g. finished dispatching)?
381 If so we can reuse frame. */
382 if ((nf->flags & VLIB_FRAME_PENDING)
383 && !(f->frame_flags & VLIB_FRAME_PENDING))
385 nf->flags &= ~VLIB_FRAME_PENDING;
390 /* Allocate new frame if current one is marked as no-append or
391 it is already full. */
392 n_used = f->n_vectors;
393 if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0) ||
394 (f->frame_flags & VLIB_FRAME_NO_APPEND))
396 /* Old frame may need to be freed after dispatch, since we'll have
397 two redundant frames from node -> next node. */
398 if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
400 vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame_index);
401 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
404 /* Allocate new frame to replace full one. */
405 nf->frame_index = vlib_frame_alloc (vm, node, next_index);
406 f = vlib_get_frame (vm, nf->frame_index);
407 n_used = f->n_vectors;
410 /* Should have free vectors in frame now. */
411 ASSERT (n_used < VLIB_FRAME_SIZE);
415 validate_frame_magic (vm, f,
416 vlib_get_node (vm, node->node_index), next_index);
423 vlib_put_next_frame_validate (vlib_main_t * vm,
424 vlib_node_runtime_t * rt,
425 u32 next_index, u32 n_vectors_left)
427 vlib_node_main_t *nm = &vm->node_main;
428 vlib_next_frame_t *nf;
430 vlib_node_runtime_t *next_rt;
431 vlib_node_t *next_node;
432 u32 n_before, n_after;
434 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
435 f = vlib_get_frame (vm, nf->frame_index);
437 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
438 n_after = VLIB_FRAME_SIZE - n_vectors_left;
439 n_before = f->n_vectors;
441 ASSERT (n_after >= n_before);
443 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
444 nf->node_runtime_index);
445 next_node = vlib_get_node (vm, next_rt->node_index);
446 if (n_after > 0 && next_node->validate_frame)
448 u8 *msg = next_node->validate_frame (vm, rt, f);
451 clib_warning ("%v", msg);
459 vlib_put_next_frame (vlib_main_t * vm,
460 vlib_node_runtime_t * r,
461 u32 next_index, u32 n_vectors_left)
463 vlib_node_main_t *nm = &vm->node_main;
464 vlib_next_frame_t *nf;
466 u32 n_vectors_in_frame;
469 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
471 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
472 f = vlib_get_frame (vm, nf->frame_index);
474 /* Make sure that magic number is still there. Otherwise, caller
475 has overrun frame meta data. */
478 vlib_node_t *node = vlib_get_node (vm, r->node_index);
479 validate_frame_magic (vm, f, node, next_index);
482 /* Convert # of vectors left -> number of vectors there. */
483 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
484 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
486 f->n_vectors = n_vectors_in_frame;
488 /* If vectors were added to frame, add to pending vector. */
489 if (PREDICT_TRUE (n_vectors_in_frame > 0))
491 vlib_pending_frame_t *p;
494 r->cached_next_index = next_index;
496 if (!(f->frame_flags & VLIB_FRAME_PENDING))
498 __attribute__ ((unused)) vlib_node_t *node;
499 vlib_node_t *next_node;
500 vlib_node_runtime_t *next_runtime;
502 node = vlib_get_node (vm, r->node_index);
503 next_node = vlib_get_next_node (vm, r->node_index, next_index);
504 next_runtime = vlib_node_get_runtime (vm, next_node->index);
506 vec_add2 (nm->pending_frames, p, 1);
508 p->frame_index = nf->frame_index;
509 p->node_runtime_index = nf->node_runtime_index;
510 p->next_frame_index = nf - nm->next_frames;
511 nf->flags |= VLIB_FRAME_PENDING;
512 f->frame_flags |= VLIB_FRAME_PENDING;
515 * If we're going to dispatch this frame on another thread,
516 * force allocation of a new frame. Otherwise, we create
517 * a dangling frame reference. Each thread has its own copy of
518 * the next_frames vector.
520 if (0 && r->thread_index != next_runtime->thread_index)
522 nf->frame_index = ~0;
523 nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
527 /* Copy trace flag from next_frame and from runtime. */
529 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
530 flags & VLIB_NODE_FLAG_TRACE);
532 v0 = nf->vectors_since_last_overflow;
533 v1 = v0 + n_vectors_in_frame;
534 nf->vectors_since_last_overflow = v1;
535 if (PREDICT_FALSE (v1 < v0))
537 vlib_node_t *node = vlib_get_node (vm, r->node_index);
538 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
543 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
545 vlib_node_runtime_sync_stats (vlib_main_t * vm,
546 vlib_node_runtime_t * r,
547 uword n_calls, uword n_vectors, uword n_clocks,
548 uword n_ticks0, uword n_ticks1)
550 vlib_node_t *n = vlib_get_node (vm, r->node_index);
552 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
553 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
554 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
555 n->stats_total.perf_counter0_ticks += n_ticks0 +
556 r->perf_counter0_ticks_since_last_overflow;
557 n->stats_total.perf_counter1_ticks += n_ticks1 +
558 r->perf_counter1_ticks_since_last_overflow;
559 n->stats_total.perf_counter_vectors += n_vectors +
560 r->perf_counter_vectors_since_last_overflow;
561 n->stats_total.max_clock = r->max_clock;
562 n->stats_total.max_clock_n = r->max_clock_n;
564 r->calls_since_last_overflow = 0;
565 r->vectors_since_last_overflow = 0;
566 r->clocks_since_last_overflow = 0;
567 r->perf_counter0_ticks_since_last_overflow = 0ULL;
568 r->perf_counter1_ticks_since_last_overflow = 0ULL;
569 r->perf_counter_vectors_since_last_overflow = 0ULL;
572 always_inline void __attribute__ ((unused))
573 vlib_process_sync_stats (vlib_main_t * vm,
575 uword n_calls, uword n_vectors, uword n_clocks,
576 uword n_ticks0, uword n_ticks1)
578 vlib_node_runtime_t *rt = &p->node_runtime;
579 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
580 vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks,
582 n->stats_total.suspends += p->n_suspends;
587 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
589 vlib_node_runtime_t *rt;
591 if (n->type == VLIB_NODE_TYPE_PROCESS)
593 /* Nothing to do for PROCESS nodes except in main thread */
594 if (vm != &vlib_global_main)
597 vlib_process_t *p = vlib_get_process_from_node (vm, n);
598 n->stats_total.suspends += p->n_suspends;
600 rt = &p->node_runtime;
604 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
607 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0, 0, 0);
609 /* Sync up runtime next frame vector counters with main node structure. */
611 vlib_next_frame_t *nf;
613 for (i = 0; i < rt->n_next_nodes; i++)
615 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
616 vec_elt (n->n_vectors_by_next_node, i) +=
617 nf->vectors_since_last_overflow;
618 nf->vectors_since_last_overflow = 0;
624 vlib_node_runtime_update_stats (vlib_main_t * vm,
625 vlib_node_runtime_t * node,
627 uword n_vectors, uword n_clocks,
628 uword n_ticks0, uword n_ticks1)
630 u32 ca0, ca1, v0, v1, cl0, cl1, r;
631 u32 ptick00, ptick01, ptick10, ptick11, pvec0, pvec1;
633 cl0 = cl1 = node->clocks_since_last_overflow;
634 ca0 = ca1 = node->calls_since_last_overflow;
635 v0 = v1 = node->vectors_since_last_overflow;
636 ptick00 = ptick01 = node->perf_counter0_ticks_since_last_overflow;
637 ptick10 = ptick11 = node->perf_counter1_ticks_since_last_overflow;
638 pvec0 = pvec1 = node->perf_counter_vectors_since_last_overflow;
642 cl1 = cl0 + n_clocks;
643 ptick01 = ptick00 + n_ticks0;
644 ptick11 = ptick10 + n_ticks1;
645 pvec1 = pvec0 + n_vectors;
647 node->calls_since_last_overflow = ca1;
648 node->clocks_since_last_overflow = cl1;
649 node->vectors_since_last_overflow = v1;
650 node->perf_counter0_ticks_since_last_overflow = ptick01;
651 node->perf_counter1_ticks_since_last_overflow = ptick11;
652 node->perf_counter_vectors_since_last_overflow = pvec1;
654 node->max_clock_n = node->max_clock > n_clocks ?
655 node->max_clock_n : n_vectors;
656 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
658 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
660 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0) || (ptick01 < ptick00)
661 || (ptick11 < ptick10) || (pvec1 < pvec0))
663 node->calls_since_last_overflow = ca0;
664 node->clocks_since_last_overflow = cl0;
665 node->vectors_since_last_overflow = v0;
666 node->perf_counter0_ticks_since_last_overflow = ptick00;
667 node->perf_counter1_ticks_since_last_overflow = ptick10;
668 node->perf_counter_vectors_since_last_overflow = pvec0;
670 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks,
678 vlib_node_runtime_perf_counter (vlib_main_t * vm, u64 * pmc0, u64 * pmc1)
682 if (PREDICT_FALSE (vm->vlib_node_runtime_perf_counter_cb != 0))
683 (*vm->vlib_node_runtime_perf_counter_cb) (vm, pmc0, pmc1);
687 vlib_process_update_stats (vlib_main_t * vm,
689 uword n_calls, uword n_vectors, uword n_clocks)
691 vlib_node_runtime_update_stats (vm, &p->node_runtime,
692 n_calls, n_vectors, n_clocks, 0ULL, 0ULL);
695 static clib_error_t *
696 vlib_cli_elog_clear (vlib_main_t * vm,
697 unformat_input_t * input, vlib_cli_command_t * cmd)
699 elog_reset_buffer (&vm->elog_main);
704 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
705 .path = "event-logger clear",
706 .short_help = "Clear the event log",
707 .function = vlib_cli_elog_clear,
712 static clib_error_t *
713 elog_save_buffer (vlib_main_t * vm,
714 unformat_input_t * input, vlib_cli_command_t * cmd)
716 elog_main_t *em = &vm->elog_main;
717 char *file, *chroot_file;
718 clib_error_t *error = 0;
720 if (!unformat (input, "%s", &file))
722 vlib_cli_output (vm, "expected file name, got `%U'",
723 format_unformat_error, input);
727 /* It's fairly hard to get "../oopsie" through unformat; just in case */
728 if (strstr (file, "..") || index (file, '/'))
730 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
734 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
738 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
739 elog_n_events_in_buffer (em),
740 elog_buffer_capacity (em), chroot_file);
742 vlib_worker_thread_barrier_sync (vm);
743 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
744 vlib_worker_thread_barrier_release (vm);
745 vec_free (chroot_file);
750 elog_post_mortem_dump (void)
752 vlib_main_t *vm = &vlib_global_main;
753 elog_main_t *em = &vm->elog_main;
757 if (!vm->elog_post_mortem_dump)
760 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
761 error = elog_write_file (em, (char *) filename, 1 /* flush ring */ );
763 clib_error_report (error);
768 VLIB_CLI_COMMAND (elog_save_cli, static) = {
769 .path = "event-logger save",
770 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
771 .function = elog_save_buffer,
775 static clib_error_t *
776 elog_stop (vlib_main_t * vm,
777 unformat_input_t * input, vlib_cli_command_t * cmd)
779 elog_main_t *em = &vm->elog_main;
781 em->n_total_events_disable_limit = em->n_total_events;
783 vlib_cli_output (vm, "Stopped the event logger...");
788 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
789 .path = "event-logger stop",
790 .short_help = "Stop the event-logger",
791 .function = elog_stop,
795 static clib_error_t *
796 elog_restart (vlib_main_t * vm,
797 unformat_input_t * input, vlib_cli_command_t * cmd)
799 elog_main_t *em = &vm->elog_main;
801 em->n_total_events_disable_limit = ~0;
803 vlib_cli_output (vm, "Restarted the event logger...");
808 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
809 .path = "event-logger restart",
810 .short_help = "Restart the event-logger",
811 .function = elog_restart,
815 static clib_error_t *
816 elog_resize (vlib_main_t * vm,
817 unformat_input_t * input, vlib_cli_command_t * cmd)
819 elog_main_t *em = &vm->elog_main;
822 /* Stop the parade */
823 elog_reset_buffer (&vm->elog_main);
825 if (unformat (input, "%d", &tmp))
827 elog_alloc (em, tmp);
828 em->n_total_events_disable_limit = ~0;
831 return clib_error_return (0, "Must specify how many events in the ring");
833 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
838 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
839 .path = "event-logger resize",
840 .short_help = "event-logger resize <nnn>",
841 .function = elog_resize,
845 #endif /* CLIB_UNIX */
848 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
850 elog_main_t *em = &vm->elog_main;
851 elog_event_t *e, *es;
854 /* Show events in VLIB time since log clock starts after VLIB clock. */
855 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
856 * vm->clib_time.seconds_per_clock;
858 es = elog_peek_events (em);
859 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
861 em->n_total_events < em->n_total_events_disable_limit ?
862 "running" : "stopped");
865 vlib_cli_output (vm, "%18.9f: %U",
866 e->time + dt, format_elog_event, em, e);
868 if (n_events_to_show == 0)
875 static clib_error_t *
876 elog_show_buffer (vlib_main_t * vm,
877 unformat_input_t * input, vlib_cli_command_t * cmd)
879 u32 n_events_to_show;
880 clib_error_t *error = 0;
882 n_events_to_show = 250;
883 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
885 if (unformat (input, "%d", &n_events_to_show))
887 else if (unformat (input, "all"))
888 n_events_to_show = ~0;
890 return unformat_parse_error (input);
892 elog_show_buffer_internal (vm, n_events_to_show);
897 VLIB_CLI_COMMAND (elog_show_cli, static) = {
898 .path = "show event-logger",
899 .short_help = "Show event logger info",
900 .function = elog_show_buffer,
905 vlib_gdb_show_event_log (void)
907 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
911 vlib_elog_main_loop_event (vlib_main_t * vm,
913 u64 time, u32 n_vectors, u32 is_return)
915 vlib_main_t *evm = &vlib_global_main;
916 elog_main_t *em = &evm->elog_main;
917 int enabled = evm->elog_trace_graph_dispatch |
918 evm->elog_trace_graph_circuit;
920 if (PREDICT_FALSE (enabled && n_vectors))
922 if (PREDICT_FALSE (!elog_is_enabled (em)))
924 evm->elog_trace_graph_dispatch = 0;
925 evm->elog_trace_graph_circuit = 0;
929 (evm->elog_trace_graph_dispatch ||
930 (evm->elog_trace_graph_circuit &&
931 node_index == evm->elog_trace_graph_circuit_node_index)))
935 vec_elt_at_index (is_return
936 ? evm->node_return_elog_event_types
937 : evm->node_call_elog_event_types,
941 &vlib_worker_threads[vm->thread_index].elog_track
942 : &em->default_track),
943 /* data to log */ n_vectors);
948 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
949 void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 node_index);
950 void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
953 vlib_buffer_trace_trajectory_init (vlib_buffer_t * b)
955 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_init_cb != 0))
957 (*vlib_buffer_trace_trajectory_init_cb) (b);
964 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
966 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
967 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_cb != 0))
969 (*vlib_buffer_trace_trajectory_cb) (b, node_index);
974 u8 *format_vnet_buffer_flags (u8 * s, va_list * args) __attribute__ ((weak));
976 format_vnet_buffer_flags (u8 * s, va_list * args)
978 s = format (s, "BUG STUB %s", __FUNCTION__);
982 u8 *format_vnet_buffer_opaque (u8 * s, va_list * args) __attribute__ ((weak));
984 format_vnet_buffer_opaque (u8 * s, va_list * args)
986 s = format (s, "BUG STUB %s", __FUNCTION__);
990 u8 *format_vnet_buffer_opaque2 (u8 * s, va_list * args)
991 __attribute__ ((weak));
993 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
995 s = format (s, "BUG STUB %s", __FUNCTION__);
1000 format_buffer_metadata (u8 * s, va_list * args)
1002 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
1004 s = format (s, "flags: %U\n", format_vnet_buffer_flags, b);
1005 s = format (s, "current_data: %d, current_length: %d\n",
1006 (i32) (b->current_data), (i32) (b->current_length));
1007 s = format (s, "current_config_index: %d, flow_id: %x, next_buffer: %x\n",
1008 b->current_config_index, b->flow_id, b->next_buffer);
1009 s = format (s, "error: %d, ref_count: %d, buffer_pool_index: %d\n",
1010 (u32) (b->error), (u32) (b->ref_count),
1011 (u32) (b->buffer_pool_index));
1013 "trace_index: %d, len_not_first_buf: %d\n",
1014 b->trace_index, b->total_length_not_including_first_buffer);
1018 #define A(x) vec_add1(vm->pcap_buffer, (x))
1021 dispatch_pcap_trace (vlib_main_t * vm,
1022 vlib_node_runtime_t * node, vlib_frame_t * frame)
1025 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **bufp, *b;
1026 pcap_main_t *pm = &vm->dispatch_pcap_main;
1027 vlib_trace_main_t *tm = &vm->trace_main;
1031 f64 time_now = vlib_time_now (vm);
1036 /* Input nodes don't have frames yet */
1037 if (frame == 0 || frame->n_vectors == 0)
1040 from = vlib_frame_vector_args (frame);
1041 vlib_get_buffers (vm, from, bufs, frame->n_vectors);
1044 n = vlib_get_node (vm, node->node_index);
1046 for (i = 0; i < frame->n_vectors; i++)
1048 if (PREDICT_TRUE (pm->n_packets_captured < pm->n_packets_to_capture))
1052 vec_reset_length (vm->pcap_buffer);
1055 /* Version, flags */
1056 A ((u8) VLIB_PCAP_MAJOR_VERSION);
1057 A ((u8) VLIB_PCAP_MINOR_VERSION);
1058 A (0 /* string_count */ );
1059 A (n->protocol_hint);
1061 /* Buffer index (big endian) */
1062 A ((from[i] >> 24) & 0xff);
1063 A ((from[i] >> 16) & 0xff);
1064 A ((from[i] >> 8) & 0xff);
1065 A ((from[i] >> 0) & 0xff);
1067 /* Node name, NULL-terminated ASCII */
1068 vm->pcap_buffer = format (vm->pcap_buffer, "%v%c", n->name, 0);
1071 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1072 format_buffer_metadata, b, 0);
1074 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1075 format_vnet_buffer_opaque, b, 0);
1077 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1078 format_vnet_buffer_opaque2, b, 0);
1081 /* Is this packet traced? */
1082 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1084 vlib_trace_header_t **h
1085 = pool_elt_at_index (tm->trace_buffer_pool, b->trace_index);
1087 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1088 format_vlib_trace, vm, h[0], 0);
1092 /* Save the string count */
1093 vm->pcap_buffer[2] = string_count;
1095 /* Figure out how many bytes in the pcap trace */
1096 capture_size = vec_len (vm->pcap_buffer) +
1097 +vlib_buffer_length_in_chain (vm, b);
1099 clib_spinlock_lock_if_init (&pm->lock);
1100 n_left = clib_min (capture_size, 16384);
1101 d = pcap_add_packet (pm, time_now, n_left, capture_size);
1103 /* Copy the header */
1104 clib_memcpy_fast (d, vm->pcap_buffer, vec_len (vm->pcap_buffer));
1105 d += vec_len (vm->pcap_buffer);
1108 (vlib_buffer_length_in_chain (vm, b),
1109 (16384 - vec_len (vm->pcap_buffer)));
1110 /* Copy the packet data */
1113 u32 copy_length = clib_min ((u32) n_left, b->current_length);
1114 clib_memcpy_fast (d, b->data + b->current_data, copy_length);
1115 n_left -= b->current_length;
1118 d += b->current_length;
1119 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
1120 b = vlib_get_buffer (vm, b->next_buffer);
1122 clib_spinlock_unlock_if_init (&pm->lock);
1127 static_always_inline u64
1128 dispatch_node (vlib_main_t * vm,
1129 vlib_node_runtime_t * node,
1130 vlib_node_type_t type,
1131 vlib_node_state_t dispatch_state,
1132 vlib_frame_t * frame, u64 last_time_stamp)
1136 vlib_node_main_t *nm = &vm->node_main;
1137 vlib_next_frame_t *nf;
1138 u64 pmc_before[2], pmc_after[2], pmc_delta[2];
1142 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1143 ASSERT (n->type == type);
1146 /* Only non-internal nodes may be disabled. */
1147 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
1149 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
1150 return last_time_stamp;
1153 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
1154 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
1156 u32 c = node->input_main_loops_per_call;
1157 /* Only call node when count reaches zero. */
1160 node->input_main_loops_per_call = c - 1;
1161 return last_time_stamp;
1165 /* Speculatively prefetch next frames. */
1166 if (node->n_next_nodes > 0)
1168 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
1169 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
1172 vm->cpu_time_last_node_dispatch = last_time_stamp;
1174 vlib_elog_main_loop_event (vm, node->node_index,
1175 last_time_stamp, frame ? frame->n_vectors : 0,
1178 vlib_node_runtime_perf_counter (vm, &pmc_before[0], &pmc_before[1]);
1181 * Turn this on if you run into
1182 * "bad monkey" contexts, and you want to know exactly
1183 * which nodes they've visited... See ixge.c...
1185 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
1189 from = vlib_frame_vector_args (frame);
1190 for (i = 0; i < frame->n_vectors; i++)
1192 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1193 add_trajectory_trace (b, node->node_index);
1195 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1196 dispatch_pcap_trace (vm, node, frame);
1197 n = node->function (vm, node, frame);
1201 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1202 dispatch_pcap_trace (vm, node, frame);
1203 n = node->function (vm, node, frame);
1206 t = clib_cpu_time_now ();
1209 * To validate accounting: pmc_delta = t - pmc_before;
1210 * perf ticks should equal clocks/pkt...
1212 vlib_node_runtime_perf_counter (vm, &pmc_after[0], &pmc_after[1]);
1214 pmc_delta[0] = pmc_after[0] - pmc_before[0];
1215 pmc_delta[1] = pmc_after[1] - pmc_before[1];
1217 vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
1219 vm->main_loop_vectors_processed += n;
1220 vm->main_loop_nodes_processed += n > 0;
1222 v = vlib_node_runtime_update_stats (vm, node,
1225 /* n_clocks */ t - last_time_stamp,
1226 pmc_delta[0] /* PMC0 */ ,
1227 pmc_delta[1] /* PMC1 */ );
1229 /* When in interrupt mode and vector rate crosses threshold switch to
1231 if (PREDICT_FALSE ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1232 || (dispatch_state == VLIB_NODE_STATE_POLLING
1235 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))))
1238 ELOG_TYPE_DECLARE (e) =
1240 .function = (char *) __FUNCTION__,
1241 .format = "%s vector length %d, switching to %s",
1242 .format_args = "T4i4t4",
1243 .n_enum_strings = 2,
1245 "interrupt", "polling",
1251 u32 node_name, vector_length, is_polling;
1254 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1255 && v >= nm->polling_threshold_vector_length) &&
1257 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1259 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1260 n->state = VLIB_NODE_STATE_POLLING;
1261 node->state = VLIB_NODE_STATE_POLLING;
1263 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1264 node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1265 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1266 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1268 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1270 vlib_worker_thread_t *w = vlib_worker_threads
1273 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1275 ed->node_name = n->name_elog_string;
1276 ed->vector_length = v;
1280 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1281 && v <= nm->interrupt_threshold_vector_length)
1283 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1285 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1287 /* Switch to interrupt mode after dispatch in polling one more time.
1288 This allows driver to re-enable interrupts. */
1289 n->state = VLIB_NODE_STATE_INTERRUPT;
1290 node->state = VLIB_NODE_STATE_INTERRUPT;
1292 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1293 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1294 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
1299 vlib_worker_thread_t *w = vlib_worker_threads
1302 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1303 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1305 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1307 ed->node_name = n->name_elog_string;
1308 ed->vector_length = v;
1319 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1320 u64 last_time_stamp)
1322 vlib_node_main_t *nm = &vm->node_main;
1324 vlib_next_frame_t *nf, nf_dummy;
1325 vlib_node_runtime_t *n;
1326 u32 restore_frame_index;
1327 vlib_pending_frame_t *p;
1329 /* See comment below about dangling references to nm->pending_frames */
1330 p = nm->pending_frames + pending_frame_index;
1332 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1333 p->node_runtime_index);
1335 f = vlib_get_frame (vm, p->frame_index);
1336 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1338 /* No next frame: so use dummy on stack. */
1340 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1341 nf->frame_index = ~p->frame_index;
1344 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1346 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1348 /* Force allocation of new frame while current frame is being
1350 restore_frame_index = ~0;
1351 if (nf->frame_index == p->frame_index)
1353 nf->frame_index = ~0;
1354 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1355 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1356 restore_frame_index = p->frame_index;
1359 /* Frame must be pending. */
1360 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1361 ASSERT (f->n_vectors > 0);
1363 /* Copy trace flag from next frame to node.
1364 Trace flag indicates that at least one vector in the dispatched
1366 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1367 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1368 nf->flags &= ~VLIB_FRAME_TRACE;
1370 last_time_stamp = dispatch_node (vm, n,
1371 VLIB_NODE_TYPE_INTERNAL,
1372 VLIB_NODE_STATE_POLLING,
1373 f, last_time_stamp);
1375 f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
1377 /* Frame is ready to be used again, so restore it. */
1378 if (restore_frame_index != ~0)
1381 * We musn't restore a frame that is flagged to be freed. This
1382 * shouldn't happen since frames to be freed post dispatch are
1383 * those used when the to-node frame becomes full i.e. they form a
1384 * sort of queue of frames to a single node. If we get here then
1385 * the to-node frame and the pending frame *were* the same, and so
1386 * we removed the to-node frame. Therefore this frame is no
1387 * longer part of the queue for that node and hence it cannot be
1390 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1393 * NB: dispatching node n can result in the creation and scheduling
1394 * of new frames, and hence in the reallocation of nm->pending_frames.
1395 * Recompute p, or no supper. This was broken for more than 10 years.
1397 p = nm->pending_frames + pending_frame_index;
1400 * p->next_frame_index can change during node dispatch if node
1401 * function decides to change graph hook up.
1403 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1404 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1406 if (~0 == nf->frame_index)
1408 /* no new frame has been assigned to this node, use the saved one */
1409 nf->frame_index = restore_frame_index;
1414 /* The node has gained a frame, implying packets from the current frame
1415 were re-queued to this same node. we don't need the saved one
1417 vlib_frame_free (vm, n, f);
1422 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1424 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1425 vlib_frame_free (vm, n, f);
1429 return last_time_stamp;
1433 vlib_process_stack_is_valid (vlib_process_t * p)
1435 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1441 vlib_process_t *process;
1442 vlib_frame_t *frame;
1443 } vlib_process_bootstrap_args_t;
1445 /* Called in process stack. */
1447 vlib_process_bootstrap (uword _a)
1449 vlib_process_bootstrap_args_t *a;
1451 vlib_node_runtime_t *node;
1456 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1461 node = &p->node_runtime;
1463 n = node->function (vm, node, f);
1465 ASSERT (vlib_process_stack_is_valid (p));
1467 clib_longjmp (&p->return_longjmp, n);
1472 /* Called in main stack. */
1473 static_always_inline uword
1474 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1476 vlib_process_bootstrap_args_t a;
1483 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1484 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1485 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1486 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1491 static_always_inline uword
1492 vlib_process_resume (vlib_process_t * p)
1495 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1496 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1497 | VLIB_PROCESS_RESUME_PENDING);
1498 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1499 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1500 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1505 dispatch_process (vlib_main_t * vm,
1506 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1508 vlib_node_main_t *nm = &vm->node_main;
1509 vlib_node_runtime_t *node_runtime = &p->node_runtime;
1510 vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1511 u32 old_process_index;
1513 uword n_vectors, is_suspend;
1515 if (node->state != VLIB_NODE_STATE_POLLING
1516 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1517 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1518 return last_time_stamp;
1520 p->flags |= VLIB_PROCESS_IS_RUNNING;
1522 t = last_time_stamp;
1523 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1524 f ? f->n_vectors : 0, /* is_after */ 0);
1526 /* Save away current process for suspend. */
1527 old_process_index = nm->current_process_index;
1528 nm->current_process_index = node->runtime_index;
1530 n_vectors = vlib_process_startup (vm, p, f);
1532 nm->current_process_index = old_process_index;
1534 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1535 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1538 vlib_pending_frame_t *pf;
1541 pool_get (nm->suspended_process_frames, pf);
1542 pf->node_runtime_index = node->runtime_index;
1543 pf->frame_index = f ? vlib_frame_index (vm, f) : ~0;
1544 pf->next_frame_index = ~0;
1547 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1549 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1551 TWT (tw_timer_wheel) * tw =
1552 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1553 p->stop_timer_handle =
1554 TW (tw_timer_start) (tw,
1555 vlib_timing_wheel_data_set_suspended_process
1556 (node->runtime_index) /* [sic] pool idex */ ,
1558 p->resume_clock_interval);
1562 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1564 t = clib_cpu_time_now ();
1566 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1569 vlib_process_update_stats (vm, p,
1570 /* n_calls */ !is_suspend,
1571 /* n_vectors */ n_vectors,
1572 /* n_clocks */ t - last_time_stamp);
1578 vlib_start_process (vlib_main_t * vm, uword process_index)
1580 vlib_node_main_t *nm = &vm->node_main;
1581 vlib_process_t *p = vec_elt (nm->processes, process_index);
1582 dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1586 dispatch_suspended_process (vlib_main_t * vm,
1587 uword process_index, u64 last_time_stamp)
1589 vlib_node_main_t *nm = &vm->node_main;
1590 vlib_node_runtime_t *node_runtime;
1594 vlib_pending_frame_t *pf;
1595 u64 t, n_vectors, is_suspend;
1597 t = last_time_stamp;
1599 p = vec_elt (nm->processes, process_index);
1600 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1601 return last_time_stamp;
1603 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1604 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1606 pf = pool_elt_at_index (nm->suspended_process_frames,
1607 p->suspended_process_frame_index);
1609 node_runtime = &p->node_runtime;
1610 node = vlib_get_node (vm, node_runtime->node_index);
1611 f = pf->frame_index != ~0 ? vlib_get_frame (vm, pf->frame_index) : 0;
1613 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1614 f ? f->n_vectors : 0, /* is_after */ 0);
1616 /* Save away current process for suspend. */
1617 nm->current_process_index = node->runtime_index;
1619 n_vectors = vlib_process_resume (p);
1620 t = clib_cpu_time_now ();
1622 nm->current_process_index = ~0;
1624 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1627 /* Suspend it again. */
1630 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1632 p->stop_timer_handle =
1633 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1634 vlib_timing_wheel_data_set_suspended_process
1635 (node->runtime_index) /* [sic] pool idex */ ,
1637 p->resume_clock_interval);
1642 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1643 pool_put_index (nm->suspended_process_frames,
1644 p->suspended_process_frame_index);
1645 p->suspended_process_frame_index = ~0;
1648 t = clib_cpu_time_now ();
1649 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1652 vlib_process_update_stats (vm, p,
1653 /* n_calls */ !is_suspend,
1654 /* n_vectors */ n_vectors,
1655 /* n_clocks */ t - last_time_stamp);
1660 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1662 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1667 static_always_inline void
1668 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1670 vlib_node_main_t *nm = &vm->node_main;
1671 vlib_thread_main_t *tm = vlib_get_thread_main ();
1674 vlib_frame_queue_main_t *fqm;
1675 u32 *last_node_runtime_indices = 0;
1677 /* Initialize pending node vector. */
1680 vec_resize (nm->pending_frames, 32);
1681 _vec_len (nm->pending_frames) = 0;
1684 /* Mark time of main loop start. */
1687 cpu_time_now = vm->clib_time.last_cpu_time;
1688 vm->cpu_time_main_loop_start = cpu_time_now;
1691 cpu_time_now = clib_cpu_time_now ();
1693 /* Pre-allocate interupt runtime indices and lock. */
1694 vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1695 vec_alloc (last_node_runtime_indices, 32);
1697 clib_spinlock_init (&nm->pending_interrupt_lock);
1699 /* Pre-allocate expired nodes. */
1700 if (!nm->polling_threshold_vector_length)
1701 nm->polling_threshold_vector_length = 10;
1702 if (!nm->interrupt_threshold_vector_length)
1703 nm->interrupt_threshold_vector_length = 5;
1705 vm->cpu_id = clib_get_current_cpu_id ();
1706 vm->numa_node = clib_get_current_numa_node ();
1708 /* Start all processes. */
1712 nm->current_process_index = ~0;
1713 for (i = 0; i < vec_len (nm->processes); i++)
1714 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1720 vlib_node_runtime_t *n;
1722 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1725 vl_api_send_pending_rpc_requests (vm);
1730 vlib_worker_thread_barrier_check ();
1731 vec_foreach (fqm, tm->frame_queue_mains)
1732 vlib_frame_queue_dequeue (vm, fqm);
1733 if (PREDICT_FALSE (vm->worker_thread_main_loop_callback != 0))
1734 ((void (*)(vlib_main_t *)) vm->worker_thread_main_loop_callback)
1738 /* Process pre-input nodes. */
1739 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1740 cpu_time_now = dispatch_node (vm, n,
1741 VLIB_NODE_TYPE_PRE_INPUT,
1742 VLIB_NODE_STATE_POLLING,
1746 /* Next process input nodes. */
1747 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1748 cpu_time_now = dispatch_node (vm, n,
1749 VLIB_NODE_TYPE_INPUT,
1750 VLIB_NODE_STATE_POLLING,
1754 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1755 vm->queue_signal_callback (vm);
1757 /* Next handle interrupts. */
1759 /* unlocked read, for performance */
1760 uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1762 if (PREDICT_FALSE (l > 0))
1767 clib_spinlock_lock (&nm->pending_interrupt_lock);
1768 /* Re-read w/ lock held, in case another thread added an item */
1769 l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1772 tmp = nm->pending_interrupt_node_runtime_indices;
1773 nm->pending_interrupt_node_runtime_indices =
1774 last_node_runtime_indices;
1775 last_node_runtime_indices = tmp;
1776 _vec_len (last_node_runtime_indices) = 0;
1778 clib_spinlock_unlock (&nm->pending_interrupt_lock);
1779 for (i = 0; i < l; i++)
1781 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1782 last_node_runtime_indices[i]);
1784 dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1785 VLIB_NODE_STATE_INTERRUPT,
1791 /* Input nodes may have added work to the pending vector.
1792 Process pending vector until there is nothing left.
1793 All pending vectors will be processed from input -> output. */
1794 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1795 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1796 /* Reset pending vector for next iteration. */
1797 _vec_len (nm->pending_frames) = 0;
1802 ELOG_TYPE_DECLARE (es) =
1804 .format = "process tw start",
1807 ELOG_TYPE_DECLARE (ee) =
1809 .format = "process tw end: %d",
1810 .format_args = "i4",
1819 /* Check if process nodes have expired from timing wheel. */
1820 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1822 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1823 ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1825 nm->data_from_advancing_timing_wheel =
1826 TW (tw_timer_expire_timers_vec)
1827 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1828 nm->data_from_advancing_timing_wheel);
1830 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1832 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1834 ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1836 _vec_len (nm->data_from_advancing_timing_wheel);
1840 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1844 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1847 u32 d = nm->data_from_advancing_timing_wheel[i];
1848 u32 di = vlib_timing_wheel_data_get_index (d);
1850 if (vlib_timing_wheel_data_is_timed_event (d))
1852 vlib_signal_timed_event_data_t *te =
1853 pool_elt_at_index (nm->signal_timed_event_data_pool,
1856 vlib_get_node (vm, te->process_node_index);
1858 vec_elt (nm->processes, n->runtime_index);
1861 vlib_process_signal_event_helper (nm, n, p,
1862 te->event_type_index,
1864 te->n_data_elt_bytes);
1865 if (te->n_data_bytes < sizeof (te->inline_event_data))
1866 clib_memcpy_fast (data, te->inline_event_data,
1870 clib_memcpy_fast (data, te->event_data_as_vector,
1872 vec_free (te->event_data_as_vector);
1874 pool_put (nm->signal_timed_event_data_pool, te);
1878 cpu_time_now = clib_cpu_time_now ();
1880 dispatch_suspended_process (vm, di, cpu_time_now);
1883 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1886 vlib_increment_main_loop_counter (vm);
1888 /* Record time stamp in case there are no enabled nodes and above
1889 calls do not update time stamp. */
1890 cpu_time_now = clib_cpu_time_now ();
1895 vlib_main_loop (vlib_main_t * vm)
1897 vlib_main_or_worker_loop (vm, /* is_main */ 1);
1901 vlib_worker_loop (vlib_main_t * vm)
1903 vlib_main_or_worker_loop (vm, /* is_main */ 0);
1906 vlib_main_t vlib_global_main;
1908 static clib_error_t *
1909 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1911 int turn_on_mem_trace = 0;
1913 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1915 if (unformat (input, "memory-trace"))
1916 turn_on_mem_trace = 1;
1918 else if (unformat (input, "elog-events %d",
1919 &vm->elog_main.event_ring_size))
1921 else if (unformat (input, "elog-post-mortem-dump"))
1922 vm->elog_post_mortem_dump = 1;
1924 return unformat_parse_error (input);
1927 unformat_free (input);
1929 /* Enable memory trace as early as possible. */
1930 if (turn_on_mem_trace)
1936 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1939 dummy_queue_signal_callback (vlib_main_t * vm)
1943 #define foreach_weak_reference_stub \
1944 _(vlib_map_stat_segment_init) \
1946 _(vlibmemory_init) \
1947 _(map_api_segment_init)
1950 clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
1951 clib_error_t *name (vlib_main_t *vm) { return 0; }
1952 foreach_weak_reference_stub;
1955 /* Main function. */
1957 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
1959 clib_error_t *volatile error;
1960 vlib_node_main_t *nm = &vm->node_main;
1962 vm->queue_signal_callback = dummy_queue_signal_callback;
1964 clib_time_init (&vm->clib_time);
1966 /* Turn on event log. */
1967 if (!vm->elog_main.event_ring_size)
1968 vm->elog_main.event_ring_size = 128 << 10;
1969 elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
1970 elog_enable_disable (&vm->elog_main, 1);
1976 if ((error = vlib_physmem_init (vm)))
1978 clib_error_report (error);
1982 if ((error = vlib_map_stat_segment_init (vm)))
1984 clib_error_report (error);
1988 if ((error = vlib_buffer_main_init (vm)))
1990 clib_error_report (error);
1994 if ((error = vlib_thread_init (vm)))
1996 clib_error_report (error);
2000 /* Register static nodes so that init functions may use them. */
2001 vlib_register_all_static_nodes (vm);
2003 /* Set seed for random number generator.
2004 Allow user to specify seed to make random sequence deterministic. */
2005 if (!unformat (input, "seed %wd", &vm->random_seed))
2006 vm->random_seed = clib_cpu_time_now ();
2007 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
2009 /* Initialize node graph. */
2010 if ((error = vlib_node_main_init (vm)))
2012 /* Arrange for graph hook up error to not be fatal when debugging. */
2014 clib_error_report (error);
2019 /* Direct call / weak reference, for vlib standalone use-cases */
2020 if ((error = vpe_api_init (vm)))
2022 clib_error_report (error);
2026 if ((error = vlibmemory_init (vm)))
2028 clib_error_report (error);
2032 if ((error = map_api_segment_init (vm)))
2034 clib_error_report (error);
2038 /* See unix/main.c; most likely already set up */
2039 if (vm->init_functions_called == 0)
2040 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
2041 if ((error = vlib_call_all_init_functions (vm)))
2044 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
2045 CLIB_CACHE_LINE_BYTES);
2047 vec_validate (nm->data_from_advancing_timing_wheel, 10);
2048 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
2050 /* Create the process timing wheel */
2051 TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
2052 0 /* no callback */ ,
2053 10e-6 /* timer period 10us */ ,
2054 ~0 /* max expirations per call */ );
2056 vec_validate (vm->pending_rpc_requests, 0);
2057 _vec_len (vm->pending_rpc_requests) = 0;
2058 vec_validate (vm->processing_rpc_requests, 0);
2059 _vec_len (vm->processing_rpc_requests) = 0;
2061 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2063 case VLIB_MAIN_LOOP_EXIT_NONE:
2064 vm->main_loop_exit_set = 1;
2067 case VLIB_MAIN_LOOP_EXIT_CLI:
2071 error = vm->main_loop_error;
2075 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
2078 /* Call all main loop enter functions. */
2080 clib_error_t *sub_error;
2081 sub_error = vlib_call_all_main_loop_enter_functions (vm);
2083 clib_error_report (sub_error);
2086 vlib_main_loop (vm);
2089 /* Call all exit functions. */
2091 clib_error_t *sub_error;
2092 sub_error = vlib_call_all_main_loop_exit_functions (vm);
2094 clib_error_report (sub_error);
2098 clib_error_report (error);
2103 static inline clib_error_t *
2104 pcap_dispatch_trace_command_internal (vlib_main_t * vm,
2105 unformat_input_t * input,
2106 vlib_cli_command_t * cmd, int rx_tx)
2108 #define PCAP_DEF_PKT_TO_CAPTURE (100)
2110 unformat_input_t _line_input, *line_input = &_line_input;
2111 pcap_main_t *pm = &vm->dispatch_pcap_main;
2113 u8 *chroot_filename = 0;
2117 clib_error_t *error = 0;
2118 u32 node_index, add;
2119 vlib_trace_main_t *tm;
2120 vlib_trace_node_t *tn;
2122 /* Get a line of input. */
2123 if (!unformat_user (input, unformat_line_input, line_input))
2126 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2128 if (unformat (line_input, "on"))
2130 if (vm->dispatch_pcap_enable == 0)
2136 vlib_cli_output (vm, "pcap dispatch capture already on...");
2141 else if (unformat (line_input, "off"))
2143 if (vm->dispatch_pcap_enable)
2146 (vm, "captured %d pkts...", pm->n_packets_captured);
2147 if (pm->n_packets_captured)
2149 pm->n_packets_to_capture = pm->n_packets_captured;
2150 error = pcap_write (pm);
2152 clib_error_report (error);
2154 vlib_cli_output (vm, "saved to %s...", pm->file_name);
2156 vm->dispatch_pcap_enable = 0;
2160 vlib_cli_output (vm, "pcap tx capture already off...");
2165 else if (unformat (line_input, "max %d", &max))
2167 if (vm->dispatch_pcap_enable)
2171 "can't change max value while pcap tx capture active...");
2175 pm->n_packets_to_capture = max;
2179 (line_input, "file %U", unformat_vlib_tmpfile, &filename))
2181 if (vm->dispatch_pcap_enable)
2184 (vm, "can't change file while pcap tx capture active...");
2189 else if (unformat (line_input, "status"))
2191 if (vm->dispatch_pcap_enable)
2194 (vm, "pcap dispatch capture is on: %d of %d pkts...",
2195 pm->n_packets_captured, pm->n_packets_to_capture);
2196 vlib_cli_output (vm, "Capture to file %s", pm->file_name);
2200 vlib_cli_output (vm, "pcap dispatch capture is off...");
2204 else if (unformat (line_input, "buffer-trace %U %d",
2205 unformat_vlib_node, vm, &node_index, &add))
2207 if (vnet_trace_dummy == 0)
2208 vec_validate_aligned (vnet_trace_dummy, 2048,
2209 CLIB_CACHE_LINE_BYTES);
2210 vlib_cli_output (vm, "Buffer tracing of %d pkts from %U enabled...",
2211 add, format_vlib_node_name, vm, node_index);
2214 foreach_vlib_main ((
2216 tm = &this_vlib_main->trace_main;
2217 tm->verbose = 0; /* not sure this ever did anything... */
2218 vec_validate (tm->nodes, node_index);
2219 tn = tm->nodes + node_index;
2221 tm->trace_enable = 1;
2228 error = clib_error_return (0, "unknown input `%U'",
2229 format_unformat_error, line_input);
2234 unformat_free (line_input);
2239 /* Since no error, save configured values. */
2240 if (chroot_filename)
2243 vec_free (pm->file_name);
2244 vec_add1 (chroot_filename, 0);
2245 pm->file_name = (char *) chroot_filename;
2249 pm->n_packets_to_capture = max;
2253 if (pm->file_name == 0)
2254 pm->file_name = (char *) format (0, "/tmp/dispatch.pcap%c", 0);
2256 pm->n_packets_captured = 0;
2257 pm->packet_type = PCAP_PACKET_TYPE_vpp;
2259 clib_spinlock_init (&(pm->lock));
2260 vm->dispatch_pcap_enable = 1;
2261 vlib_cli_output (vm, "pcap dispatch capture on...");
2264 else if (chroot_filename)
2265 vec_free (chroot_filename);
2270 static clib_error_t *
2271 pcap_dispatch_trace_command_fn (vlib_main_t * vm,
2272 unformat_input_t * input,
2273 vlib_cli_command_t * cmd)
2275 return pcap_dispatch_trace_command_internal (vm, input, cmd, VLIB_RX);
2279 * This command is used to start or stop pcap dispatch trace capture, or show
2280 * the capture status.
2282 * This command has the following optional parameters:
2284 * - <b>on|off</b> - Used to start or stop capture.
2286 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2287 * of packets have been received, buffer is flushed to file. Once another
2288 * '<em>nn</em>' number of packets have been received, buffer is flushed
2289 * to file, overwriting previous write. If not entered, value defaults
2290 * to 100. Can only be updated if packet capture is off.
2292 * - <b>file <name></b> - Used to specify the output filename. The file will
2293 * be placed in the '<em>/tmp</em>' directory, so only the filename is
2294 * supported. Directory should not be entered. If file already exists, file
2295 * will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
2296 * will be used. Can only be updated if packet capture is off.
2298 * - <b>status</b> - Displays the current status and configured attributes
2299 * associated with a packet capture. If packet capture is in progress,
2300 * '<em>status</em>' also will return the number of packets currently in
2301 * the local buffer. All additional attributes entered on command line
2302 * with '<em>status</em>' will be ignored and not applied.
2305 * Example of how to display the status of capture when off:
2306 * @cliexstart{pcap dispatch trace status}
2307 * max is 100, for any interface to file /tmp/vpe.pcap
2308 * pcap dispatch capture is off...
2310 * Example of how to start a dispatch trace capture:
2311 * @cliexstart{pcap dispatch trace on max 35 file dispatchTrace.pcap}
2312 * pcap dispatch capture on...
2314 * Example of how to start a dispatch trace capture with buffer tracing
2315 * @cliexstart{pcap dispatch trace on max 10000 file dispatchTrace.pcap buffer-trace dpdk-input 1000}
2316 * pcap dispatch capture on...
2318 * Example of how to display the status of a tx packet capture in progress:
2319 * @cliexstart{pcap tx trace status}
2320 * max is 35, dispatch trace to file /tmp/vppTest.pcap
2321 * pcap tx capture is on: 20 of 35 pkts...
2323 * Example of how to stop a tx packet capture:
2324 * @cliexstart{vppctl pcap dispatch trace off}
2325 * captured 21 pkts...
2326 * saved to /tmp/dispatchTrace.pcap...
2330 VLIB_CLI_COMMAND (pcap_dispatch_trace_command, static) = {
2331 .path = "pcap dispatch trace",
2333 "pcap dispatch trace [on|off] [max <nn>] [file <name>] [status]\n"
2334 " [buffer-trace <input-node-name> <nn>]",
2335 .function = pcap_dispatch_trace_command_fn,
2340 * fd.io coding-style-patch-verification: ON
2343 * eval: (c-set-style "gnu")