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);
120 static vlib_frame_t *
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 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_frames)) > 0)
139 /* Allocate from end of free list. */
140 f = fs->free_frames[l - 1];
141 _vec_len (fs->free_frames) = l - 1;
145 f = clib_mem_alloc_aligned_no_fail (n, VLIB_FRAME_ALIGN);
148 /* Poison frame when debugging. */
150 clib_memset (f, 0xfe, n);
152 /* Insert magic number. */
156 magic = vlib_frame_find_magic (f, to_node);
157 *magic = VLIB_FRAME_MAGIC;
160 f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
162 f->scalar_size = scalar_size;
163 f->vector_size = vector_size;
166 fs->n_alloc_frames += 1;
171 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
172 Returns frame index. */
173 static vlib_frame_t *
174 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
177 vlib_node_t *from_node;
179 from_node = vlib_get_node (vm, from_node_runtime->node_index);
180 ASSERT (to_next_index < vec_len (from_node->next_nodes));
182 return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
183 /* frame_flags */ 0);
187 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
189 vlib_frame_t *f = vlib_frame_alloc_to_node (vm, to_node_index,
191 VLIB_FRAME_FREE_AFTER_DISPATCH);
192 return vlib_get_frame (vm, f);
196 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
198 vlib_pending_frame_t *p;
199 vlib_node_t *to_node;
201 if (f->n_vectors == 0)
204 to_node = vlib_get_node (vm, to_node_index);
206 vec_add2 (vm->node_main.pending_frames, p, 1);
208 f->frame_flags |= VLIB_FRAME_PENDING;
209 p->frame = vlib_get_frame (vm, f);
210 p->node_runtime_index = to_node->runtime_index;
211 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
214 /* Free given frame. */
216 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
218 vlib_node_main_t *nm = &vm->node_main;
220 vlib_frame_size_t *fs;
222 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
224 node = vlib_get_node (vm, r->node_index);
225 fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
227 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
229 /* No next frames may point to freed frame. */
232 vlib_next_frame_t *nf;
233 vec_foreach (nf, vm->node_main.next_frames) ASSERT (nf->frame != f);
236 f->frame_flags &= ~(VLIB_FRAME_IS_ALLOCATED | VLIB_FRAME_NO_APPEND);
238 vec_add1 (fs->free_frames, f);
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_frames);
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 != NULL)
320 vec_foreach (p, nm->pending_frames)
322 if (p->frame == next_frame->frame)
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 = vlib_frame_alloc (vm, node, next_index);
375 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
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);
401 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
404 /* Allocate new frame to replace full one. */
405 f = nf->frame = vlib_frame_alloc (vm, node, next_index);
406 n_used = f->n_vectors;
409 /* Should have free vectors in frame now. */
410 ASSERT (n_used < VLIB_FRAME_SIZE);
414 validate_frame_magic (vm, f,
415 vlib_get_node (vm, node->node_index), next_index);
422 vlib_put_next_frame_validate (vlib_main_t * vm,
423 vlib_node_runtime_t * rt,
424 u32 next_index, u32 n_vectors_left)
426 vlib_node_main_t *nm = &vm->node_main;
427 vlib_next_frame_t *nf;
429 vlib_node_runtime_t *next_rt;
430 vlib_node_t *next_node;
431 u32 n_before, n_after;
433 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
434 f = vlib_get_frame (vm, nf->frame);
436 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
437 n_after = VLIB_FRAME_SIZE - n_vectors_left;
438 n_before = f->n_vectors;
440 ASSERT (n_after >= n_before);
442 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
443 nf->node_runtime_index);
444 next_node = vlib_get_node (vm, next_rt->node_index);
445 if (n_after > 0 && next_node->validate_frame)
447 u8 *msg = next_node->validate_frame (vm, rt, f);
450 clib_warning ("%v", msg);
458 vlib_put_next_frame (vlib_main_t * vm,
459 vlib_node_runtime_t * r,
460 u32 next_index, u32 n_vectors_left)
462 vlib_node_main_t *nm = &vm->node_main;
463 vlib_next_frame_t *nf;
465 u32 n_vectors_in_frame;
468 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
470 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
471 f = vlib_get_frame (vm, nf->frame);
473 /* Make sure that magic number is still there. Otherwise, caller
474 has overrun frame meta data. */
477 vlib_node_t *node = vlib_get_node (vm, r->node_index);
478 validate_frame_magic (vm, f, node, next_index);
481 /* Convert # of vectors left -> number of vectors there. */
482 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
483 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
485 f->n_vectors = n_vectors_in_frame;
487 /* If vectors were added to frame, add to pending vector. */
488 if (PREDICT_TRUE (n_vectors_in_frame > 0))
490 vlib_pending_frame_t *p;
493 r->cached_next_index = next_index;
495 if (!(f->frame_flags & VLIB_FRAME_PENDING))
497 __attribute__ ((unused)) vlib_node_t *node;
498 vlib_node_t *next_node;
499 vlib_node_runtime_t *next_runtime;
501 node = vlib_get_node (vm, r->node_index);
502 next_node = vlib_get_next_node (vm, r->node_index, next_index);
503 next_runtime = vlib_node_get_runtime (vm, next_node->index);
505 vec_add2 (nm->pending_frames, p, 1);
507 p->frame = nf->frame;
508 p->node_runtime_index = nf->node_runtime_index;
509 p->next_frame_index = nf - nm->next_frames;
510 nf->flags |= VLIB_FRAME_PENDING;
511 f->frame_flags |= VLIB_FRAME_PENDING;
514 * If we're going to dispatch this frame on another thread,
515 * force allocation of a new frame. Otherwise, we create
516 * a dangling frame reference. Each thread has its own copy of
517 * the next_frames vector.
519 if (0 && r->thread_index != next_runtime->thread_index)
522 nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
526 /* Copy trace flag from next_frame and from runtime. */
528 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
529 flags & VLIB_NODE_FLAG_TRACE);
531 v0 = nf->vectors_since_last_overflow;
532 v1 = v0 + n_vectors_in_frame;
533 nf->vectors_since_last_overflow = v1;
534 if (PREDICT_FALSE (v1 < v0))
536 vlib_node_t *node = vlib_get_node (vm, r->node_index);
537 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
542 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
544 vlib_node_runtime_sync_stats (vlib_main_t * vm,
545 vlib_node_runtime_t * r,
546 uword n_calls, uword n_vectors, uword n_clocks,
547 uword n_ticks0, uword n_ticks1)
549 vlib_node_t *n = vlib_get_node (vm, r->node_index);
551 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
552 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
553 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
554 n->stats_total.perf_counter0_ticks += n_ticks0 +
555 r->perf_counter0_ticks_since_last_overflow;
556 n->stats_total.perf_counter1_ticks += n_ticks1 +
557 r->perf_counter1_ticks_since_last_overflow;
558 n->stats_total.perf_counter_vectors += n_vectors +
559 r->perf_counter_vectors_since_last_overflow;
560 n->stats_total.max_clock = r->max_clock;
561 n->stats_total.max_clock_n = r->max_clock_n;
563 r->calls_since_last_overflow = 0;
564 r->vectors_since_last_overflow = 0;
565 r->clocks_since_last_overflow = 0;
566 r->perf_counter0_ticks_since_last_overflow = 0ULL;
567 r->perf_counter1_ticks_since_last_overflow = 0ULL;
568 r->perf_counter_vectors_since_last_overflow = 0ULL;
571 always_inline void __attribute__ ((unused))
572 vlib_process_sync_stats (vlib_main_t * vm,
574 uword n_calls, uword n_vectors, uword n_clocks,
575 uword n_ticks0, uword n_ticks1)
577 vlib_node_runtime_t *rt = &p->node_runtime;
578 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
579 vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks,
581 n->stats_total.suspends += p->n_suspends;
586 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
588 vlib_node_runtime_t *rt;
590 if (n->type == VLIB_NODE_TYPE_PROCESS)
592 /* Nothing to do for PROCESS nodes except in main thread */
593 if (vm != &vlib_global_main)
596 vlib_process_t *p = vlib_get_process_from_node (vm, n);
597 n->stats_total.suspends += p->n_suspends;
599 rt = &p->node_runtime;
603 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
606 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0, 0, 0);
608 /* Sync up runtime next frame vector counters with main node structure. */
610 vlib_next_frame_t *nf;
612 for (i = 0; i < rt->n_next_nodes; i++)
614 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
615 vec_elt (n->n_vectors_by_next_node, i) +=
616 nf->vectors_since_last_overflow;
617 nf->vectors_since_last_overflow = 0;
623 vlib_node_runtime_update_stats (vlib_main_t * vm,
624 vlib_node_runtime_t * node,
626 uword n_vectors, uword n_clocks,
627 uword n_ticks0, uword n_ticks1)
629 u32 ca0, ca1, v0, v1, cl0, cl1, r;
630 u32 ptick00, ptick01, ptick10, ptick11, pvec0, pvec1;
632 cl0 = cl1 = node->clocks_since_last_overflow;
633 ca0 = ca1 = node->calls_since_last_overflow;
634 v0 = v1 = node->vectors_since_last_overflow;
635 ptick00 = ptick01 = node->perf_counter0_ticks_since_last_overflow;
636 ptick10 = ptick11 = node->perf_counter1_ticks_since_last_overflow;
637 pvec0 = pvec1 = node->perf_counter_vectors_since_last_overflow;
641 cl1 = cl0 + n_clocks;
642 ptick01 = ptick00 + n_ticks0;
643 ptick11 = ptick10 + n_ticks1;
644 pvec1 = pvec0 + n_vectors;
646 node->calls_since_last_overflow = ca1;
647 node->clocks_since_last_overflow = cl1;
648 node->vectors_since_last_overflow = v1;
649 node->perf_counter0_ticks_since_last_overflow = ptick01;
650 node->perf_counter1_ticks_since_last_overflow = ptick11;
651 node->perf_counter_vectors_since_last_overflow = pvec1;
653 node->max_clock_n = node->max_clock > n_clocks ?
654 node->max_clock_n : n_vectors;
655 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
657 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
659 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0) || (ptick01 < ptick00)
660 || (ptick11 < ptick10) || (pvec1 < pvec0))
662 node->calls_since_last_overflow = ca0;
663 node->clocks_since_last_overflow = cl0;
664 node->vectors_since_last_overflow = v0;
665 node->perf_counter0_ticks_since_last_overflow = ptick00;
666 node->perf_counter1_ticks_since_last_overflow = ptick10;
667 node->perf_counter_vectors_since_last_overflow = pvec0;
669 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks,
677 vlib_node_runtime_perf_counter (vlib_main_t * vm, u64 * pmc0, u64 * pmc1,
678 vlib_node_runtime_t * node,
679 vlib_frame_t * frame, int before_or_after)
683 if (PREDICT_FALSE (vec_len (vm->vlib_node_runtime_perf_counter_cbs) != 0))
684 clib_call_callbacks (vm->vlib_node_runtime_perf_counter_cbs, vm, pmc0,
685 pmc1, node, frame, before_or_after);
689 vlib_process_update_stats (vlib_main_t * vm,
691 uword n_calls, uword n_vectors, uword n_clocks)
693 vlib_node_runtime_update_stats (vm, &p->node_runtime,
694 n_calls, n_vectors, n_clocks, 0ULL, 0ULL);
697 static clib_error_t *
698 vlib_cli_elog_clear (vlib_main_t * vm,
699 unformat_input_t * input, vlib_cli_command_t * cmd)
701 elog_reset_buffer (&vm->elog_main);
706 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
707 .path = "event-logger clear",
708 .short_help = "Clear the event log",
709 .function = vlib_cli_elog_clear,
714 static clib_error_t *
715 elog_save_buffer (vlib_main_t * vm,
716 unformat_input_t * input, vlib_cli_command_t * cmd)
718 elog_main_t *em = &vm->elog_main;
719 char *file, *chroot_file;
720 clib_error_t *error = 0;
722 if (!unformat (input, "%s", &file))
724 vlib_cli_output (vm, "expected file name, got `%U'",
725 format_unformat_error, input);
729 /* It's fairly hard to get "../oopsie" through unformat; just in case */
730 if (strstr (file, "..") || index (file, '/'))
732 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
736 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
740 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
741 elog_n_events_in_buffer (em),
742 elog_buffer_capacity (em), chroot_file);
744 vlib_worker_thread_barrier_sync (vm);
745 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
746 vlib_worker_thread_barrier_release (vm);
747 vec_free (chroot_file);
752 elog_post_mortem_dump (void)
754 vlib_main_t *vm = &vlib_global_main;
755 elog_main_t *em = &vm->elog_main;
759 if (!vm->elog_post_mortem_dump)
762 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
763 error = elog_write_file (em, (char *) filename, 1 /* flush ring */ );
765 clib_error_report (error);
770 VLIB_CLI_COMMAND (elog_save_cli, static) = {
771 .path = "event-logger save",
772 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
773 .function = elog_save_buffer,
777 static clib_error_t *
778 elog_stop (vlib_main_t * vm,
779 unformat_input_t * input, vlib_cli_command_t * cmd)
781 elog_main_t *em = &vm->elog_main;
783 em->n_total_events_disable_limit = em->n_total_events;
785 vlib_cli_output (vm, "Stopped the event logger...");
790 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
791 .path = "event-logger stop",
792 .short_help = "Stop the event-logger",
793 .function = elog_stop,
797 static clib_error_t *
798 elog_restart (vlib_main_t * vm,
799 unformat_input_t * input, vlib_cli_command_t * cmd)
801 elog_main_t *em = &vm->elog_main;
803 em->n_total_events_disable_limit = ~0;
805 vlib_cli_output (vm, "Restarted the event logger...");
810 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
811 .path = "event-logger restart",
812 .short_help = "Restart the event-logger",
813 .function = elog_restart,
817 static clib_error_t *
818 elog_resize (vlib_main_t * vm,
819 unformat_input_t * input, vlib_cli_command_t * cmd)
821 elog_main_t *em = &vm->elog_main;
824 /* Stop the parade */
825 elog_reset_buffer (&vm->elog_main);
827 if (unformat (input, "%d", &tmp))
829 elog_alloc (em, tmp);
830 em->n_total_events_disable_limit = ~0;
833 return clib_error_return (0, "Must specify how many events in the ring");
835 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
840 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
841 .path = "event-logger resize",
842 .short_help = "event-logger resize <nnn>",
843 .function = elog_resize,
847 #endif /* CLIB_UNIX */
850 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
852 elog_main_t *em = &vm->elog_main;
853 elog_event_t *e, *es;
856 /* Show events in VLIB time since log clock starts after VLIB clock. */
857 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
858 * vm->clib_time.seconds_per_clock;
860 es = elog_peek_events (em);
861 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
863 em->n_total_events < em->n_total_events_disable_limit ?
864 "running" : "stopped");
867 vlib_cli_output (vm, "%18.9f: %U",
868 e->time + dt, format_elog_event, em, e);
870 if (n_events_to_show == 0)
877 static clib_error_t *
878 elog_show_buffer (vlib_main_t * vm,
879 unformat_input_t * input, vlib_cli_command_t * cmd)
881 u32 n_events_to_show;
882 clib_error_t *error = 0;
884 n_events_to_show = 250;
885 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
887 if (unformat (input, "%d", &n_events_to_show))
889 else if (unformat (input, "all"))
890 n_events_to_show = ~0;
892 return unformat_parse_error (input);
894 elog_show_buffer_internal (vm, n_events_to_show);
899 VLIB_CLI_COMMAND (elog_show_cli, static) = {
900 .path = "show event-logger",
901 .short_help = "Show event logger info",
902 .function = elog_show_buffer,
907 vlib_gdb_show_event_log (void)
909 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
913 vlib_elog_main_loop_event (vlib_main_t * vm,
915 u64 time, u32 n_vectors, u32 is_return)
917 vlib_main_t *evm = &vlib_global_main;
918 elog_main_t *em = &evm->elog_main;
919 int enabled = evm->elog_trace_graph_dispatch |
920 evm->elog_trace_graph_circuit;
922 if (PREDICT_FALSE (enabled && n_vectors))
924 if (PREDICT_FALSE (!elog_is_enabled (em)))
926 evm->elog_trace_graph_dispatch = 0;
927 evm->elog_trace_graph_circuit = 0;
931 (evm->elog_trace_graph_dispatch ||
932 (evm->elog_trace_graph_circuit &&
933 node_index == evm->elog_trace_graph_circuit_node_index)))
937 vec_elt_at_index (is_return
938 ? evm->node_return_elog_event_types
939 : evm->node_call_elog_event_types,
943 &vlib_worker_threads[vm->thread_index].elog_track
944 : &em->default_track),
945 /* data to log */ n_vectors);
950 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
951 void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 node_index);
952 void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
955 vlib_buffer_trace_trajectory_init (vlib_buffer_t * b)
957 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_init_cb != 0))
959 (*vlib_buffer_trace_trajectory_init_cb) (b);
966 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
968 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
969 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_cb != 0))
971 (*vlib_buffer_trace_trajectory_cb) (b, node_index);
976 u8 *format_vnet_buffer_flags (u8 * s, va_list * args) __attribute__ ((weak));
978 format_vnet_buffer_flags (u8 * s, va_list * args)
980 s = format (s, "BUG STUB %s", __FUNCTION__);
984 u8 *format_vnet_buffer_opaque (u8 * s, va_list * args) __attribute__ ((weak));
986 format_vnet_buffer_opaque (u8 * s, va_list * args)
988 s = format (s, "BUG STUB %s", __FUNCTION__);
992 u8 *format_vnet_buffer_opaque2 (u8 * s, va_list * args)
993 __attribute__ ((weak));
995 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
997 s = format (s, "BUG STUB %s", __FUNCTION__);
1002 format_buffer_metadata (u8 * s, va_list * args)
1004 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
1006 s = format (s, "flags: %U\n", format_vnet_buffer_flags, b);
1007 s = format (s, "current_data: %d, current_length: %d\n",
1008 (i32) (b->current_data), (i32) (b->current_length));
1009 s = format (s, "current_config_index: %d, flow_id: %x, next_buffer: %x\n",
1010 b->current_config_index, b->flow_id, b->next_buffer);
1011 s = format (s, "error: %d, ref_count: %d, buffer_pool_index: %d\n",
1012 (u32) (b->error), (u32) (b->ref_count),
1013 (u32) (b->buffer_pool_index));
1015 "trace_handle: 0x%x, len_not_first_buf: %d\n",
1016 b->trace_handle, b->total_length_not_including_first_buffer);
1020 #define A(x) vec_add1(vm->pcap_buffer, (x))
1023 dispatch_pcap_trace (vlib_main_t * vm,
1024 vlib_node_runtime_t * node, vlib_frame_t * frame)
1027 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **bufp, *b;
1028 pcap_main_t *pm = &vm->dispatch_pcap_main;
1029 vlib_trace_main_t *tm = &vm->trace_main;
1033 f64 time_now = vlib_time_now (vm);
1038 /* Input nodes don't have frames yet */
1039 if (frame == 0 || frame->n_vectors == 0)
1042 from = vlib_frame_vector_args (frame);
1043 vlib_get_buffers (vm, from, bufs, frame->n_vectors);
1046 n = vlib_get_node (vm, node->node_index);
1048 for (i = 0; i < frame->n_vectors; i++)
1050 if (PREDICT_TRUE (pm->n_packets_captured < pm->n_packets_to_capture))
1054 vec_reset_length (vm->pcap_buffer);
1057 /* Version, flags */
1058 A ((u8) VLIB_PCAP_MAJOR_VERSION);
1059 A ((u8) VLIB_PCAP_MINOR_VERSION);
1060 A (0 /* string_count */ );
1061 A (n->protocol_hint);
1063 /* Buffer index (big endian) */
1064 A ((from[i] >> 24) & 0xff);
1065 A ((from[i] >> 16) & 0xff);
1066 A ((from[i] >> 8) & 0xff);
1067 A ((from[i] >> 0) & 0xff);
1069 /* Node name, NULL-terminated ASCII */
1070 vm->pcap_buffer = format (vm->pcap_buffer, "%v%c", n->name, 0);
1073 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1074 format_buffer_metadata, b, 0);
1076 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1077 format_vnet_buffer_opaque, b, 0);
1079 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1080 format_vnet_buffer_opaque2, b, 0);
1083 /* Is this packet traced? */
1084 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1086 vlib_trace_header_t **h
1087 = pool_elt_at_index (tm->trace_buffer_pool,
1088 vlib_buffer_get_trace_index (b));
1090 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1091 format_vlib_trace, vm, h[0], 0);
1095 /* Save the string count */
1096 vm->pcap_buffer[2] = string_count;
1098 /* Figure out how many bytes in the pcap trace */
1099 capture_size = vec_len (vm->pcap_buffer) +
1100 +vlib_buffer_length_in_chain (vm, b);
1102 clib_spinlock_lock_if_init (&pm->lock);
1103 n_left = clib_min (capture_size, 16384);
1104 d = pcap_add_packet (pm, time_now, n_left, capture_size);
1106 /* Copy the header */
1107 clib_memcpy_fast (d, vm->pcap_buffer, vec_len (vm->pcap_buffer));
1108 d += vec_len (vm->pcap_buffer);
1111 (vlib_buffer_length_in_chain (vm, b),
1112 (16384 - vec_len (vm->pcap_buffer)));
1113 /* Copy the packet data */
1116 u32 copy_length = clib_min ((u32) n_left, b->current_length);
1117 clib_memcpy_fast (d, b->data + b->current_data, copy_length);
1118 n_left -= b->current_length;
1121 d += b->current_length;
1122 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
1123 b = vlib_get_buffer (vm, b->next_buffer);
1125 clib_spinlock_unlock_if_init (&pm->lock);
1130 static_always_inline u64
1131 dispatch_node (vlib_main_t * vm,
1132 vlib_node_runtime_t * node,
1133 vlib_node_type_t type,
1134 vlib_node_state_t dispatch_state,
1135 vlib_frame_t * frame, u64 last_time_stamp)
1139 vlib_node_main_t *nm = &vm->node_main;
1140 vlib_next_frame_t *nf;
1141 u64 pmc_before[2], pmc_after[2], pmc_delta[2];
1145 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1146 ASSERT (n->type == type);
1149 /* Only non-internal nodes may be disabled. */
1150 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
1152 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
1153 return last_time_stamp;
1156 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
1157 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
1159 u32 c = node->input_main_loops_per_call;
1160 /* Only call node when count reaches zero. */
1163 node->input_main_loops_per_call = c - 1;
1164 return last_time_stamp;
1168 /* Speculatively prefetch next frames. */
1169 if (node->n_next_nodes > 0)
1171 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
1172 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
1175 vm->cpu_time_last_node_dispatch = last_time_stamp;
1177 vlib_elog_main_loop_event (vm, node->node_index,
1178 last_time_stamp, frame ? frame->n_vectors : 0,
1181 vlib_node_runtime_perf_counter (vm, &pmc_before[0], &pmc_before[1],
1182 node, frame, 0 /* before */ );
1185 * Turn this on if you run into
1186 * "bad monkey" contexts, and you want to know exactly
1187 * which nodes they've visited... See ixge.c...
1189 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
1193 from = vlib_frame_vector_args (frame);
1194 for (i = 0; i < frame->n_vectors; i++)
1196 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1197 add_trajectory_trace (b, node->node_index);
1199 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1200 dispatch_pcap_trace (vm, node, frame);
1201 n = node->function (vm, node, frame);
1205 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1206 dispatch_pcap_trace (vm, node, frame);
1207 n = node->function (vm, node, frame);
1210 t = clib_cpu_time_now ();
1213 * To validate accounting: pmc_delta = t - pmc_before;
1214 * perf ticks should equal clocks/pkt...
1216 vlib_node_runtime_perf_counter (vm, &pmc_after[0], &pmc_after[1], node,
1217 frame, 1 /* after */ );
1219 pmc_delta[0] = pmc_after[0] - pmc_before[0];
1220 pmc_delta[1] = pmc_after[1] - pmc_before[1];
1222 vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
1224 vm->main_loop_vectors_processed += n;
1225 vm->main_loop_nodes_processed += n > 0;
1227 v = vlib_node_runtime_update_stats (vm, node,
1230 /* n_clocks */ t - last_time_stamp,
1231 pmc_delta[0] /* PMC0 */ ,
1232 pmc_delta[1] /* PMC1 */ );
1234 /* When in interrupt mode and vector rate crosses threshold switch to
1236 if (PREDICT_FALSE ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1237 || (dispatch_state == VLIB_NODE_STATE_POLLING
1240 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))))
1243 ELOG_TYPE_DECLARE (e) =
1245 .function = (char *) __FUNCTION__,
1246 .format = "%s vector length %d, switching to %s",
1247 .format_args = "T4i4t4",
1248 .n_enum_strings = 2,
1250 "interrupt", "polling",
1256 u32 node_name, vector_length, is_polling;
1259 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1260 && v >= nm->polling_threshold_vector_length) &&
1262 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1264 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1265 n->state = VLIB_NODE_STATE_POLLING;
1266 node->state = VLIB_NODE_STATE_POLLING;
1268 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1269 node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1270 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1271 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1273 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1275 vlib_worker_thread_t *w = vlib_worker_threads
1278 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1280 ed->node_name = n->name_elog_string;
1281 ed->vector_length = v;
1285 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1286 && v <= nm->interrupt_threshold_vector_length)
1288 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1290 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1292 /* Switch to interrupt mode after dispatch in polling one more time.
1293 This allows driver to re-enable interrupts. */
1294 n->state = VLIB_NODE_STATE_INTERRUPT;
1295 node->state = VLIB_NODE_STATE_INTERRUPT;
1297 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1298 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1299 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
1304 vlib_worker_thread_t *w = vlib_worker_threads
1307 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1308 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1310 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1312 ed->node_name = n->name_elog_string;
1313 ed->vector_length = v;
1324 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1325 u64 last_time_stamp)
1327 vlib_node_main_t *nm = &vm->node_main;
1329 vlib_next_frame_t *nf, nf_dummy;
1330 vlib_node_runtime_t *n;
1331 vlib_frame_t *restore_frame;
1332 vlib_pending_frame_t *p;
1334 /* See comment below about dangling references to nm->pending_frames */
1335 p = nm->pending_frames + pending_frame_index;
1337 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1338 p->node_runtime_index);
1340 f = vlib_get_frame (vm, p->frame);
1341 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1343 /* No next frame: so use dummy on stack. */
1345 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1349 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1351 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1353 /* Force allocation of new frame while current frame is being
1355 restore_frame = NULL;
1356 if (nf->frame == p->frame)
1359 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1360 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1361 restore_frame = p->frame;
1364 /* Frame must be pending. */
1365 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1366 ASSERT (f->n_vectors > 0);
1368 /* Copy trace flag from next frame to node.
1369 Trace flag indicates that at least one vector in the dispatched
1371 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1372 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1373 nf->flags &= ~VLIB_FRAME_TRACE;
1375 last_time_stamp = dispatch_node (vm, n,
1376 VLIB_NODE_TYPE_INTERNAL,
1377 VLIB_NODE_STATE_POLLING,
1378 f, last_time_stamp);
1380 f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
1382 /* Frame is ready to be used again, so restore it. */
1383 if (restore_frame != NULL)
1386 * We musn't restore a frame that is flagged to be freed. This
1387 * shouldn't happen since frames to be freed post dispatch are
1388 * those used when the to-node frame becomes full i.e. they form a
1389 * sort of queue of frames to a single node. If we get here then
1390 * the to-node frame and the pending frame *were* the same, and so
1391 * we removed the to-node frame. Therefore this frame is no
1392 * longer part of the queue for that node and hence it cannot be
1395 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1398 * NB: dispatching node n can result in the creation and scheduling
1399 * of new frames, and hence in the reallocation of nm->pending_frames.
1400 * Recompute p, or no supper. This was broken for more than 10 years.
1402 p = nm->pending_frames + pending_frame_index;
1405 * p->next_frame_index can change during node dispatch if node
1406 * function decides to change graph hook up.
1408 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1409 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1411 if (NULL == nf->frame)
1413 /* no new frame has been assigned to this node, use the saved one */
1414 nf->frame = restore_frame;
1419 /* The node has gained a frame, implying packets from the current frame
1420 were re-queued to this same node. we don't need the saved one
1422 vlib_frame_free (vm, n, f);
1427 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1429 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1430 vlib_frame_free (vm, n, f);
1434 return last_time_stamp;
1438 vlib_process_stack_is_valid (vlib_process_t * p)
1440 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1446 vlib_process_t *process;
1447 vlib_frame_t *frame;
1448 } vlib_process_bootstrap_args_t;
1450 /* Called in process stack. */
1452 vlib_process_bootstrap (uword _a)
1454 vlib_process_bootstrap_args_t *a;
1456 vlib_node_runtime_t *node;
1461 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1466 node = &p->node_runtime;
1468 n = node->function (vm, node, f);
1470 ASSERT (vlib_process_stack_is_valid (p));
1472 clib_longjmp (&p->return_longjmp, n);
1477 /* Called in main stack. */
1478 static_always_inline uword
1479 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1481 vlib_process_bootstrap_args_t a;
1488 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1489 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1490 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1491 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1496 static_always_inline uword
1497 vlib_process_resume (vlib_process_t * p)
1500 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1501 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1502 | VLIB_PROCESS_RESUME_PENDING);
1503 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1504 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1505 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1510 dispatch_process (vlib_main_t * vm,
1511 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1513 vlib_node_main_t *nm = &vm->node_main;
1514 vlib_node_runtime_t *node_runtime = &p->node_runtime;
1515 vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1516 u32 old_process_index;
1518 uword n_vectors, is_suspend;
1520 if (node->state != VLIB_NODE_STATE_POLLING
1521 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1522 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1523 return last_time_stamp;
1525 p->flags |= VLIB_PROCESS_IS_RUNNING;
1527 t = last_time_stamp;
1528 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1529 f ? f->n_vectors : 0, /* is_after */ 0);
1531 /* Save away current process for suspend. */
1532 old_process_index = nm->current_process_index;
1533 nm->current_process_index = node->runtime_index;
1535 n_vectors = vlib_process_startup (vm, p, f);
1537 nm->current_process_index = old_process_index;
1539 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1540 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1543 vlib_pending_frame_t *pf;
1546 pool_get (nm->suspended_process_frames, pf);
1547 pf->node_runtime_index = node->runtime_index;
1549 pf->next_frame_index = ~0;
1552 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1554 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1556 TWT (tw_timer_wheel) * tw =
1557 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1558 p->stop_timer_handle =
1559 TW (tw_timer_start) (tw,
1560 vlib_timing_wheel_data_set_suspended_process
1561 (node->runtime_index) /* [sic] pool idex */ ,
1563 p->resume_clock_interval);
1567 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1569 t = clib_cpu_time_now ();
1571 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1574 vlib_process_update_stats (vm, p,
1575 /* n_calls */ !is_suspend,
1576 /* n_vectors */ n_vectors,
1577 /* n_clocks */ t - last_time_stamp);
1583 vlib_start_process (vlib_main_t * vm, uword process_index)
1585 vlib_node_main_t *nm = &vm->node_main;
1586 vlib_process_t *p = vec_elt (nm->processes, process_index);
1587 dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1591 dispatch_suspended_process (vlib_main_t * vm,
1592 uword process_index, u64 last_time_stamp)
1594 vlib_node_main_t *nm = &vm->node_main;
1595 vlib_node_runtime_t *node_runtime;
1599 vlib_pending_frame_t *pf;
1600 u64 t, n_vectors, is_suspend;
1602 t = last_time_stamp;
1604 p = vec_elt (nm->processes, process_index);
1605 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1606 return last_time_stamp;
1608 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1609 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1611 pf = pool_elt_at_index (nm->suspended_process_frames,
1612 p->suspended_process_frame_index);
1614 node_runtime = &p->node_runtime;
1615 node = vlib_get_node (vm, node_runtime->node_index);
1618 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1619 f ? f->n_vectors : 0, /* is_after */ 0);
1621 /* Save away current process for suspend. */
1622 nm->current_process_index = node->runtime_index;
1624 n_vectors = vlib_process_resume (p);
1625 t = clib_cpu_time_now ();
1627 nm->current_process_index = ~0;
1629 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1632 /* Suspend it again. */
1635 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1637 p->stop_timer_handle =
1638 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1639 vlib_timing_wheel_data_set_suspended_process
1640 (node->runtime_index) /* [sic] pool idex */ ,
1642 p->resume_clock_interval);
1647 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1648 pool_put_index (nm->suspended_process_frames,
1649 p->suspended_process_frame_index);
1650 p->suspended_process_frame_index = ~0;
1653 t = clib_cpu_time_now ();
1654 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1657 vlib_process_update_stats (vm, p,
1658 /* n_calls */ !is_suspend,
1659 /* n_vectors */ n_vectors,
1660 /* n_clocks */ t - last_time_stamp);
1665 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1667 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1672 static_always_inline void
1673 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1675 vlib_node_main_t *nm = &vm->node_main;
1676 vlib_thread_main_t *tm = vlib_get_thread_main ();
1679 vlib_frame_queue_main_t *fqm;
1680 u32 *last_node_runtime_indices = 0;
1681 u32 frame_queue_check_counter = 0;
1683 /* Initialize pending node vector. */
1686 vec_resize (nm->pending_frames, 32);
1687 _vec_len (nm->pending_frames) = 0;
1690 /* Mark time of main loop start. */
1693 cpu_time_now = vm->clib_time.last_cpu_time;
1694 vm->cpu_time_main_loop_start = cpu_time_now;
1697 cpu_time_now = clib_cpu_time_now ();
1699 /* Pre-allocate interupt runtime indices and lock. */
1700 vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1701 vec_alloc (last_node_runtime_indices, 32);
1703 clib_spinlock_init (&nm->pending_interrupt_lock);
1705 /* Pre-allocate expired nodes. */
1706 if (!nm->polling_threshold_vector_length)
1707 nm->polling_threshold_vector_length = 10;
1708 if (!nm->interrupt_threshold_vector_length)
1709 nm->interrupt_threshold_vector_length = 5;
1711 vm->cpu_id = clib_get_current_cpu_id ();
1712 vm->numa_node = clib_get_current_numa_node ();
1714 /* Start all processes. */
1720 * Perform an initial barrier sync. Pays no attention to
1721 * the barrier sync hold-down timer scheme, which won't work
1722 * at this point in time.
1724 vlib_worker_thread_initial_barrier_sync_and_release (vm);
1726 nm->current_process_index = ~0;
1727 for (i = 0; i < vec_len (nm->processes); i++)
1728 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1734 vlib_node_runtime_t *n;
1736 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1739 vl_api_send_pending_rpc_requests (vm);
1744 vlib_worker_thread_barrier_check ();
1745 if (PREDICT_FALSE (vm->check_frame_queues +
1746 frame_queue_check_counter))
1750 if (vm->check_frame_queues)
1752 frame_queue_check_counter = 100;
1753 vm->check_frame_queues = 0;
1756 vec_foreach (fqm, tm->frame_queue_mains)
1757 processed += vlib_frame_queue_dequeue (vm, fqm);
1759 /* No handoff queue work found? */
1761 frame_queue_check_counter = 100;
1763 frame_queue_check_counter--;
1765 if (PREDICT_FALSE (vec_len (vm->worker_thread_main_loop_callbacks)))
1766 clib_call_callbacks (vm->worker_thread_main_loop_callbacks, vm);
1769 /* Process pre-input nodes. */
1770 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1771 cpu_time_now = dispatch_node (vm, n,
1772 VLIB_NODE_TYPE_PRE_INPUT,
1773 VLIB_NODE_STATE_POLLING,
1777 /* Next process input nodes. */
1778 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1779 cpu_time_now = dispatch_node (vm, n,
1780 VLIB_NODE_TYPE_INPUT,
1781 VLIB_NODE_STATE_POLLING,
1785 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1786 vm->queue_signal_callback (vm);
1788 /* Next handle interrupts. */
1790 /* unlocked read, for performance */
1791 uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1793 if (PREDICT_FALSE (l > 0))
1798 clib_spinlock_lock (&nm->pending_interrupt_lock);
1799 /* Re-read w/ lock held, in case another thread added an item */
1800 l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1803 tmp = nm->pending_interrupt_node_runtime_indices;
1804 nm->pending_interrupt_node_runtime_indices =
1805 last_node_runtime_indices;
1806 last_node_runtime_indices = tmp;
1807 _vec_len (last_node_runtime_indices) = 0;
1809 clib_spinlock_unlock (&nm->pending_interrupt_lock);
1810 for (i = 0; i < l; i++)
1812 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1813 last_node_runtime_indices[i]);
1815 dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1816 VLIB_NODE_STATE_INTERRUPT,
1822 /* Input nodes may have added work to the pending vector.
1823 Process pending vector until there is nothing left.
1824 All pending vectors will be processed from input -> output. */
1825 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1826 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1827 /* Reset pending vector for next iteration. */
1828 _vec_len (nm->pending_frames) = 0;
1833 ELOG_TYPE_DECLARE (es) =
1835 .format = "process tw start",
1838 ELOG_TYPE_DECLARE (ee) =
1840 .format = "process tw end: %d",
1841 .format_args = "i4",
1850 /* Check if process nodes have expired from timing wheel. */
1851 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1853 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1854 ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1856 nm->data_from_advancing_timing_wheel =
1857 TW (tw_timer_expire_timers_vec)
1858 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1859 nm->data_from_advancing_timing_wheel);
1861 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1863 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1865 ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1867 _vec_len (nm->data_from_advancing_timing_wheel);
1871 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1875 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1878 u32 d = nm->data_from_advancing_timing_wheel[i];
1879 u32 di = vlib_timing_wheel_data_get_index (d);
1881 if (vlib_timing_wheel_data_is_timed_event (d))
1883 vlib_signal_timed_event_data_t *te =
1884 pool_elt_at_index (nm->signal_timed_event_data_pool,
1887 vlib_get_node (vm, te->process_node_index);
1889 vec_elt (nm->processes, n->runtime_index);
1892 vlib_process_signal_event_helper (nm, n, p,
1893 te->event_type_index,
1895 te->n_data_elt_bytes);
1896 if (te->n_data_bytes < sizeof (te->inline_event_data))
1897 clib_memcpy_fast (data, te->inline_event_data,
1901 clib_memcpy_fast (data, te->event_data_as_vector,
1903 vec_free (te->event_data_as_vector);
1905 pool_put (nm->signal_timed_event_data_pool, te);
1909 cpu_time_now = clib_cpu_time_now ();
1911 dispatch_suspended_process (vm, di, cpu_time_now);
1914 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1917 vlib_increment_main_loop_counter (vm);
1919 /* Record time stamp in case there are no enabled nodes and above
1920 calls do not update time stamp. */
1921 cpu_time_now = clib_cpu_time_now ();
1926 vlib_main_loop (vlib_main_t * vm)
1928 vlib_main_or_worker_loop (vm, /* is_main */ 1);
1932 vlib_worker_loop (vlib_main_t * vm)
1934 vlib_main_or_worker_loop (vm, /* is_main */ 0);
1937 vlib_main_t vlib_global_main;
1939 static clib_error_t *
1940 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1942 int turn_on_mem_trace = 0;
1944 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1946 if (unformat (input, "memory-trace"))
1947 turn_on_mem_trace = 1;
1949 else if (unformat (input, "elog-events %d",
1950 &vm->elog_main.event_ring_size))
1952 else if (unformat (input, "elog-post-mortem-dump"))
1953 vm->elog_post_mortem_dump = 1;
1955 return unformat_parse_error (input);
1958 unformat_free (input);
1960 /* Enable memory trace as early as possible. */
1961 if (turn_on_mem_trace)
1967 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1970 dummy_queue_signal_callback (vlib_main_t * vm)
1974 #define foreach_weak_reference_stub \
1975 _(vlib_map_stat_segment_init) \
1977 _(vlibmemory_init) \
1978 _(map_api_segment_init)
1981 clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
1982 clib_error_t *name (vlib_main_t *vm) { return 0; }
1983 foreach_weak_reference_stub;
1986 void vl_api_set_elog_main (elog_main_t * m) __attribute__ ((weak));
1988 vl_api_set_elog_main (elog_main_t * m)
1990 clib_warning ("STUB");
1993 int vl_api_set_elog_trace_api_messages (int enable) __attribute__ ((weak));
1995 vl_api_set_elog_trace_api_messages (int enable)
1997 clib_warning ("STUB");
2001 int vl_api_get_elog_trace_api_messages (void) __attribute__ ((weak));
2003 vl_api_get_elog_trace_api_messages (void)
2005 clib_warning ("STUB");
2009 /* Main function. */
2011 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
2013 clib_error_t *volatile error;
2014 vlib_node_main_t *nm = &vm->node_main;
2016 vm->queue_signal_callback = dummy_queue_signal_callback;
2018 clib_time_init (&vm->clib_time);
2020 /* Turn on event log. */
2021 if (!vm->elog_main.event_ring_size)
2022 vm->elog_main.event_ring_size = 128 << 10;
2023 elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
2024 elog_enable_disable (&vm->elog_main, 1);
2025 vl_api_set_elog_main (&vm->elog_main);
2026 (void) vl_api_set_elog_trace_api_messages (1);
2032 if ((error = vlib_physmem_init (vm)))
2034 clib_error_report (error);
2038 if ((error = vlib_map_stat_segment_init (vm)))
2040 clib_error_report (error);
2044 if ((error = vlib_buffer_main_init (vm)))
2046 clib_error_report (error);
2050 if ((error = vlib_thread_init (vm)))
2052 clib_error_report (error);
2056 /* Register static nodes so that init functions may use them. */
2057 vlib_register_all_static_nodes (vm);
2059 /* Set seed for random number generator.
2060 Allow user to specify seed to make random sequence deterministic. */
2061 if (!unformat (input, "seed %wd", &vm->random_seed))
2062 vm->random_seed = clib_cpu_time_now ();
2063 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
2065 /* Initialize node graph. */
2066 if ((error = vlib_node_main_init (vm)))
2068 /* Arrange for graph hook up error to not be fatal when debugging. */
2070 clib_error_report (error);
2075 /* Direct call / weak reference, for vlib standalone use-cases */
2076 if ((error = vpe_api_init (vm)))
2078 clib_error_report (error);
2082 if ((error = vlibmemory_init (vm)))
2084 clib_error_report (error);
2088 if ((error = map_api_segment_init (vm)))
2090 clib_error_report (error);
2094 /* See unix/main.c; most likely already set up */
2095 if (vm->init_functions_called == 0)
2096 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
2097 if ((error = vlib_call_all_init_functions (vm)))
2100 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
2101 CLIB_CACHE_LINE_BYTES);
2103 vec_validate (nm->data_from_advancing_timing_wheel, 10);
2104 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
2106 /* Create the process timing wheel */
2107 TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
2108 0 /* no callback */ ,
2109 10e-6 /* timer period 10us */ ,
2110 ~0 /* max expirations per call */ );
2112 vec_validate (vm->pending_rpc_requests, 0);
2113 _vec_len (vm->pending_rpc_requests) = 0;
2114 vec_validate (vm->processing_rpc_requests, 0);
2115 _vec_len (vm->processing_rpc_requests) = 0;
2117 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
2120 /* Sort per-thread init functions before we start threads */
2121 vlib_sort_init_exit_functions (&vm->worker_init_function_registrations);
2123 /* Call all main loop enter functions. */
2125 clib_error_t *sub_error;
2126 sub_error = vlib_call_all_main_loop_enter_functions (vm);
2128 clib_error_report (sub_error);
2131 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2133 case VLIB_MAIN_LOOP_EXIT_NONE:
2134 vm->main_loop_exit_set = 1;
2137 case VLIB_MAIN_LOOP_EXIT_CLI:
2141 error = vm->main_loop_error;
2145 vlib_main_loop (vm);
2148 /* Call all exit functions. */
2150 clib_error_t *sub_error;
2151 sub_error = vlib_call_all_main_loop_exit_functions (vm);
2153 clib_error_report (sub_error);
2157 clib_error_report (error);
2162 static inline clib_error_t *
2163 pcap_dispatch_trace_command_internal (vlib_main_t * vm,
2164 unformat_input_t * input,
2165 vlib_cli_command_t * cmd, int rx_tx)
2167 unformat_input_t _line_input, *line_input = &_line_input;
2168 pcap_main_t *pm = &vm->dispatch_pcap_main;
2173 clib_error_t *error = 0;
2174 u32 node_index, add;
2175 vlib_trace_main_t *tm;
2176 vlib_trace_node_t *tn;
2178 /* Get a line of input. */
2179 if (!unformat_user (input, unformat_line_input, line_input))
2182 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2184 if (unformat (line_input, "on"))
2186 if (vm->dispatch_pcap_enable == 0)
2192 vlib_cli_output (vm, "pcap dispatch capture already on...");
2197 else if (unformat (line_input, "off"))
2199 if (vm->dispatch_pcap_enable)
2202 (vm, "captured %d pkts...", pm->n_packets_captured);
2203 if (pm->n_packets_captured)
2205 pm->n_packets_to_capture = pm->n_packets_captured;
2206 error = pcap_write (pm);
2207 if (pm->file_descriptor >= 0)
2210 clib_error_report (error);
2212 vlib_cli_output (vm, "saved to %s...", pm->file_name);
2214 vm->dispatch_pcap_enable = 0;
2218 vlib_cli_output (vm, "pcap tx capture already off...");
2223 else if (unformat (line_input, "max %d", &max))
2225 if (vm->dispatch_pcap_enable)
2229 "can't change max value while pcap tx capture active...");
2233 pm->n_packets_to_capture = max;
2237 (line_input, "file %U", unformat_vlib_tmpfile, &filename))
2239 if (vm->dispatch_pcap_enable)
2242 (vm, "can't change file while pcap tx capture active...");
2247 else if (unformat (line_input, "status"))
2249 if (vm->dispatch_pcap_enable)
2252 (vm, "pcap dispatch capture is on: %d of %d pkts...",
2253 pm->n_packets_captured, pm->n_packets_to_capture);
2254 vlib_cli_output (vm, "Capture to file %s", pm->file_name);
2258 vlib_cli_output (vm, "pcap dispatch capture is off...");
2262 else if (unformat (line_input, "buffer-trace %U %d",
2263 unformat_vlib_node, vm, &node_index, &add))
2265 if (vnet_trace_dummy == 0)
2266 vec_validate_aligned (vnet_trace_dummy, 2048,
2267 CLIB_CACHE_LINE_BYTES);
2268 vlib_cli_output (vm, "Buffer tracing of %d pkts from %U enabled...",
2269 add, format_vlib_node_name, vm, node_index);
2272 foreach_vlib_main ((
2274 tm = &this_vlib_main->trace_main;
2275 tm->verbose = 0; /* not sure this ever did anything... */
2276 vec_validate (tm->nodes, node_index);
2277 tn = tm->nodes + node_index;
2279 tm->trace_enable = 1;
2286 error = clib_error_return (0, "unknown input `%U'",
2287 format_unformat_error, line_input);
2292 unformat_free (line_input);
2296 /* Clean up from previous run */
2297 vec_free (pm->file_name);
2298 vec_free (pm->pcap_data);
2300 memset (pm, 0, sizeof (*pm));
2301 pm->n_packets_to_capture = max;
2306 filename = format (0, "/tmp/dispatch.pcap%c", 0);
2308 pm->file_name = (char *) filename;
2309 pm->n_packets_captured = 0;
2310 pm->packet_type = PCAP_PACKET_TYPE_vpp;
2312 clib_spinlock_init (&(pm->lock));
2313 vm->dispatch_pcap_enable = 1;
2314 vlib_cli_output (vm, "pcap dispatch capture on...");
2321 static clib_error_t *
2322 pcap_dispatch_trace_command_fn (vlib_main_t * vm,
2323 unformat_input_t * input,
2324 vlib_cli_command_t * cmd)
2326 return pcap_dispatch_trace_command_internal (vm, input, cmd, VLIB_RX);
2330 * This command is used to start or stop pcap dispatch trace capture, or show
2331 * the capture status.
2333 * This command has the following optional parameters:
2335 * - <b>on|off</b> - Used to start or stop capture.
2337 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2338 * of packets have been received, buffer is flushed to file. Once another
2339 * '<em>nn</em>' number of packets have been received, buffer is flushed
2340 * to file, overwriting previous write. If not entered, value defaults
2341 * to 100. Can only be updated if packet capture is off.
2343 * - <b>file <name></b> - Used to specify the output filename. The file will
2344 * be placed in the '<em>/tmp</em>' directory, so only the filename is
2345 * supported. Directory should not be entered. If file already exists, file
2346 * will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
2347 * will be used. Can only be updated if packet capture is off.
2349 * - <b>status</b> - Displays the current status and configured attributes
2350 * associated with a packet capture. If packet capture is in progress,
2351 * '<em>status</em>' also will return the number of packets currently in
2352 * the local buffer. All additional attributes entered on command line
2353 * with '<em>status</em>' will be ignored and not applied.
2356 * Example of how to display the status of capture when off:
2357 * @cliexstart{pcap dispatch trace status}
2358 * max is 100, for any interface to file /tmp/vpe.pcap
2359 * pcap dispatch capture is off...
2361 * Example of how to start a dispatch trace capture:
2362 * @cliexstart{pcap dispatch trace on max 35 file dispatchTrace.pcap}
2363 * pcap dispatch capture on...
2365 * Example of how to start a dispatch trace capture with buffer tracing
2366 * @cliexstart{pcap dispatch trace on max 10000 file dispatchTrace.pcap buffer-trace dpdk-input 1000}
2367 * pcap dispatch capture on...
2369 * Example of how to display the status of a tx packet capture in progress:
2370 * @cliexstart{pcap tx trace status}
2371 * max is 35, dispatch trace to file /tmp/vppTest.pcap
2372 * pcap tx capture is on: 20 of 35 pkts...
2374 * Example of how to stop a tx packet capture:
2375 * @cliexstart{vppctl pcap dispatch trace off}
2376 * captured 21 pkts...
2377 * saved to /tmp/dispatchTrace.pcap...
2381 VLIB_CLI_COMMAND (pcap_dispatch_trace_command, static) = {
2382 .path = "pcap dispatch trace",
2384 "pcap dispatch trace [on|off] [max <nn>] [file <name>] [status]\n"
2385 " [buffer-trace <input-node-name> <nn>]",
2386 .function = pcap_dispatch_trace_command_fn,
2391 * fd.io coding-style-patch-verification: ON
2394 * eval: (c-set-style "gnu")