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)
56 vlib_frame_bytes (u32 n_scalar_bytes, u32 n_vector_bytes)
60 /* Make room for vlib_frame_t plus scalar arguments. */
61 n_bytes = vlib_frame_vector_byte_offset (n_scalar_bytes);
63 /* Make room for vector arguments.
64 Allocate a few extra slots of vector data to support
65 speculative vector enqueues which overflow vector data in next frame. */
66 #define VLIB_FRAME_SIZE_EXTRA 4
67 n_bytes += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * n_vector_bytes;
69 /* Magic number is first 32bit number after vector data.
70 Used to make sure that vector data is never overrun. */
71 #define VLIB_FRAME_MAGIC (0xabadc0ed)
72 n_bytes += sizeof (u32);
74 /* Pad to cache line. */
75 n_bytes = round_pow2 (n_bytes, CLIB_CACHE_LINE_BYTES);
81 vlib_frame_find_magic (vlib_frame_t * f, vlib_node_t * node)
85 p += vlib_frame_vector_byte_offset (node->scalar_size);
87 p += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * node->vector_size;
92 static inline vlib_frame_size_t *
93 get_frame_size_info (vlib_node_main_t * nm,
94 u32 n_scalar_bytes, u32 n_vector_bytes)
96 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
97 uword key = (n_scalar_bytes << 16) | n_vector_bytes;
100 p = hash_get (nm->frame_size_hash, key);
105 i = vec_len (nm->frame_sizes);
106 vec_validate (nm->frame_sizes, i);
107 hash_set (nm->frame_size_hash, key, i);
110 return vec_elt_at_index (nm->frame_sizes, i);
112 ASSERT (vlib_frame_bytes (n_scalar_bytes, n_vector_bytes)
113 == (vlib_frame_bytes (0, 4)));
114 return vec_elt_at_index (nm->frame_sizes, 0);
118 static vlib_frame_t *
119 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
122 vlib_node_main_t *nm = &vm->node_main;
123 vlib_frame_size_t *fs;
124 vlib_node_t *to_node;
126 u32 l, n, scalar_size, vector_size;
128 to_node = vlib_get_node (vm, to_node_index);
130 scalar_size = to_node->scalar_size;
131 vector_size = to_node->vector_size;
133 fs = get_frame_size_info (nm, scalar_size, vector_size);
134 n = vlib_frame_bytes (scalar_size, vector_size);
135 if ((l = vec_len (fs->free_frames)) > 0)
137 /* Allocate from end of free list. */
138 f = fs->free_frames[l - 1];
139 _vec_len (fs->free_frames) = l - 1;
143 f = clib_mem_alloc_aligned_no_fail (n, VLIB_FRAME_ALIGN);
146 /* Poison frame when debugging. */
148 clib_memset (f, 0xfe, n);
150 /* Insert magic number. */
154 magic = vlib_frame_find_magic (f, to_node);
155 *magic = VLIB_FRAME_MAGIC;
158 f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
160 f->scalar_size = scalar_size;
161 f->vector_size = vector_size;
164 fs->n_alloc_frames += 1;
169 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
170 Returns frame index. */
171 static vlib_frame_t *
172 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
175 vlib_node_t *from_node;
177 from_node = vlib_get_node (vm, from_node_runtime->node_index);
178 ASSERT (to_next_index < vec_len (from_node->next_nodes));
180 return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
181 /* frame_flags */ 0);
185 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
187 vlib_frame_t *f = vlib_frame_alloc_to_node (vm, to_node_index,
189 VLIB_FRAME_FREE_AFTER_DISPATCH);
190 return vlib_get_frame (vm, f);
194 vlib_validate_frame_indices (vlib_frame_t * f)
199 u32 *from = vlib_frame_vector_args (f);
201 /* Check for bad buffer index values */
202 for (i = 0; i < f->n_vectors; i++)
206 clib_warning ("BUG: buffer index 0 at index %d", i);
209 else if (from[i] == 0xfefefefe)
211 clib_warning ("BUG: frame poison pattern at index %d", i);
219 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
221 vlib_pending_frame_t *p;
222 vlib_node_t *to_node;
224 if (f->n_vectors == 0)
227 vlib_validate_frame_indices (f);
229 to_node = vlib_get_node (vm, to_node_index);
231 vec_add2 (vm->node_main.pending_frames, p, 1);
233 f->frame_flags |= VLIB_FRAME_PENDING;
234 p->frame = vlib_get_frame (vm, f);
235 p->node_runtime_index = to_node->runtime_index;
236 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
239 /* Free given frame. */
241 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
243 vlib_node_main_t *nm = &vm->node_main;
245 vlib_frame_size_t *fs;
247 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
249 node = vlib_get_node (vm, r->node_index);
250 fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
252 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
254 /* No next frames may point to freed frame. */
257 vlib_next_frame_t *nf;
258 vec_foreach (nf, vm->node_main.next_frames) ASSERT (nf->frame != f);
261 f->frame_flags &= ~(VLIB_FRAME_IS_ALLOCATED | VLIB_FRAME_NO_APPEND);
263 vec_add1 (fs->free_frames, f);
264 ASSERT (fs->n_alloc_frames > 0);
265 fs->n_alloc_frames -= 1;
268 static clib_error_t *
269 show_frame_stats (vlib_main_t * vm,
270 unformat_input_t * input, vlib_cli_command_t * cmd)
272 vlib_node_main_t *nm = &vm->node_main;
273 vlib_frame_size_t *fs;
275 vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
276 vec_foreach (fs, nm->frame_sizes)
278 u32 n_alloc = fs->n_alloc_frames;
279 u32 n_free = vec_len (fs->free_frames);
281 if (n_alloc + n_free > 0)
282 vlib_cli_output (vm, "%=6d%=12d%=12d",
283 fs - nm->frame_sizes, n_alloc, n_free);
290 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
291 .path = "show vlib frame-allocation",
292 .short_help = "Show node dispatch frame statistics",
293 .function = show_frame_stats,
297 /* Change ownership of enqueue rights to given next node. */
299 vlib_next_frame_change_ownership (vlib_main_t * vm,
300 vlib_node_runtime_t * node_runtime,
303 vlib_node_main_t *nm = &vm->node_main;
304 vlib_next_frame_t *next_frame;
305 vlib_node_t *node, *next_node;
307 node = vec_elt (nm->nodes, node_runtime->node_index);
309 /* Only internal & input nodes are allowed to call other nodes. */
310 ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
311 || node->type == VLIB_NODE_TYPE_INPUT
312 || node->type == VLIB_NODE_TYPE_PROCESS);
314 ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
317 vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
318 next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
320 if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
322 /* Get frame from previous owner. */
323 vlib_next_frame_t *owner_next_frame;
324 vlib_next_frame_t tmp;
327 vlib_node_get_next_frame (vm,
328 next_node->owner_node_index,
329 next_node->owner_next_index);
331 /* Swap target next frame with owner's. */
332 tmp = owner_next_frame[0];
333 owner_next_frame[0] = next_frame[0];
337 * If next_frame is already pending, we have to track down
338 * all pending frames and fix their next_frame_index fields.
340 if (next_frame->flags & VLIB_FRAME_PENDING)
342 vlib_pending_frame_t *p;
343 if (next_frame->frame != NULL)
345 vec_foreach (p, nm->pending_frames)
347 if (p->frame == next_frame->frame)
349 p->next_frame_index =
350 next_frame - vm->node_main.next_frames;
358 /* No previous owner. Take ownership. */
359 next_frame->flags |= VLIB_FRAME_OWNER;
362 /* Record new owner. */
363 next_node->owner_node_index = node->index;
364 next_node->owner_next_index = next_index;
366 /* Now we should be owner. */
367 ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
370 /* Make sure that magic number is still there.
371 Otherwise, it is likely that caller has overrun frame arguments. */
373 validate_frame_magic (vlib_main_t * vm,
374 vlib_frame_t * f, vlib_node_t * n, uword next_index)
376 vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
377 u32 *magic = vlib_frame_find_magic (f, next_node);
378 ASSERT (VLIB_FRAME_MAGIC == magic[0]);
382 vlib_get_next_frame_internal (vlib_main_t * vm,
383 vlib_node_runtime_t * node,
384 u32 next_index, u32 allocate_new_next_frame)
387 vlib_next_frame_t *nf;
390 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
392 /* Make sure this next frame owns right to enqueue to destination frame. */
393 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
394 vlib_next_frame_change_ownership (vm, node, next_index);
396 /* ??? Don't need valid flag: can use frame_index == ~0 */
397 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
399 nf->frame = vlib_frame_alloc (vm, node, next_index);
400 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
405 /* Has frame been removed from pending vector (e.g. finished dispatching)?
406 If so we can reuse frame. */
407 if ((nf->flags & VLIB_FRAME_PENDING)
408 && !(f->frame_flags & VLIB_FRAME_PENDING))
410 nf->flags &= ~VLIB_FRAME_PENDING;
415 /* Allocate new frame if current one is marked as no-append or
416 it is already full. */
417 n_used = f->n_vectors;
418 if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0) ||
419 (f->frame_flags & VLIB_FRAME_NO_APPEND))
421 /* Old frame may need to be freed after dispatch, since we'll have
422 two redundant frames from node -> next node. */
423 if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
425 vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame);
426 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
429 /* Allocate new frame to replace full one. */
430 f = nf->frame = vlib_frame_alloc (vm, node, next_index);
431 n_used = f->n_vectors;
434 /* Should have free vectors in frame now. */
435 ASSERT (n_used < VLIB_FRAME_SIZE);
439 validate_frame_magic (vm, f,
440 vlib_get_node (vm, node->node_index), next_index);
447 vlib_put_next_frame_validate (vlib_main_t * vm,
448 vlib_node_runtime_t * rt,
449 u32 next_index, u32 n_vectors_left)
451 vlib_node_main_t *nm = &vm->node_main;
452 vlib_next_frame_t *nf;
454 vlib_node_runtime_t *next_rt;
455 vlib_node_t *next_node;
456 u32 n_before, n_after;
458 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
459 f = vlib_get_frame (vm, nf->frame);
461 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
463 vlib_validate_frame_indices (f);
465 n_after = VLIB_FRAME_SIZE - n_vectors_left;
466 n_before = f->n_vectors;
468 ASSERT (n_after >= n_before);
470 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
471 nf->node_runtime_index);
472 next_node = vlib_get_node (vm, next_rt->node_index);
473 if (n_after > 0 && next_node->validate_frame)
475 u8 *msg = next_node->validate_frame (vm, rt, f);
478 clib_warning ("%v", msg);
486 vlib_put_next_frame (vlib_main_t * vm,
487 vlib_node_runtime_t * r,
488 u32 next_index, u32 n_vectors_left)
490 vlib_node_main_t *nm = &vm->node_main;
491 vlib_next_frame_t *nf;
493 u32 n_vectors_in_frame;
496 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
498 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
499 f = vlib_get_frame (vm, nf->frame);
501 /* Make sure that magic number is still there. Otherwise, caller
502 has overrun frame meta data. */
505 vlib_node_t *node = vlib_get_node (vm, r->node_index);
506 validate_frame_magic (vm, f, node, next_index);
509 /* Convert # of vectors left -> number of vectors there. */
510 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
511 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
513 f->n_vectors = n_vectors_in_frame;
515 /* If vectors were added to frame, add to pending vector. */
516 if (PREDICT_TRUE (n_vectors_in_frame > 0))
518 vlib_pending_frame_t *p;
521 r->cached_next_index = next_index;
523 if (!(f->frame_flags & VLIB_FRAME_PENDING))
525 __attribute__ ((unused)) vlib_node_t *node;
526 vlib_node_t *next_node;
527 vlib_node_runtime_t *next_runtime;
529 node = vlib_get_node (vm, r->node_index);
530 next_node = vlib_get_next_node (vm, r->node_index, next_index);
531 next_runtime = vlib_node_get_runtime (vm, next_node->index);
533 vec_add2 (nm->pending_frames, p, 1);
535 p->frame = nf->frame;
536 p->node_runtime_index = nf->node_runtime_index;
537 p->next_frame_index = nf - nm->next_frames;
538 nf->flags |= VLIB_FRAME_PENDING;
539 f->frame_flags |= VLIB_FRAME_PENDING;
542 * If we're going to dispatch this frame on another thread,
543 * force allocation of a new frame. Otherwise, we create
544 * a dangling frame reference. Each thread has its own copy of
545 * the next_frames vector.
547 if (0 && r->thread_index != next_runtime->thread_index)
550 nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
554 /* Copy trace flag from next_frame and from runtime. */
556 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
557 flags & VLIB_NODE_FLAG_TRACE);
559 v0 = nf->vectors_since_last_overflow;
560 v1 = v0 + n_vectors_in_frame;
561 nf->vectors_since_last_overflow = v1;
562 if (PREDICT_FALSE (v1 < v0))
564 vlib_node_t *node = vlib_get_node (vm, r->node_index);
565 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
570 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
572 vlib_node_runtime_sync_stats (vlib_main_t * vm,
573 vlib_node_runtime_t * r,
574 uword n_calls, uword n_vectors, uword n_clocks,
575 uword n_ticks0, uword n_ticks1)
577 vlib_node_t *n = vlib_get_node (vm, r->node_index);
579 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
580 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
581 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
582 n->stats_total.perf_counter0_ticks += n_ticks0 +
583 r->perf_counter0_ticks_since_last_overflow;
584 n->stats_total.perf_counter1_ticks += n_ticks1 +
585 r->perf_counter1_ticks_since_last_overflow;
586 n->stats_total.perf_counter_vectors += n_vectors +
587 r->perf_counter_vectors_since_last_overflow;
588 n->stats_total.max_clock = r->max_clock;
589 n->stats_total.max_clock_n = r->max_clock_n;
591 r->calls_since_last_overflow = 0;
592 r->vectors_since_last_overflow = 0;
593 r->clocks_since_last_overflow = 0;
594 r->perf_counter0_ticks_since_last_overflow = 0ULL;
595 r->perf_counter1_ticks_since_last_overflow = 0ULL;
596 r->perf_counter_vectors_since_last_overflow = 0ULL;
599 always_inline void __attribute__ ((unused))
600 vlib_process_sync_stats (vlib_main_t * vm,
602 uword n_calls, uword n_vectors, uword n_clocks,
603 uword n_ticks0, uword n_ticks1)
605 vlib_node_runtime_t *rt = &p->node_runtime;
606 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
607 vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks,
609 n->stats_total.suspends += p->n_suspends;
614 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
616 vlib_node_runtime_t *rt;
618 if (n->type == VLIB_NODE_TYPE_PROCESS)
620 /* Nothing to do for PROCESS nodes except in main thread */
621 if (vm != &vlib_global_main)
624 vlib_process_t *p = vlib_get_process_from_node (vm, n);
625 n->stats_total.suspends += p->n_suspends;
627 rt = &p->node_runtime;
631 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
634 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0, 0, 0);
636 /* Sync up runtime next frame vector counters with main node structure. */
638 vlib_next_frame_t *nf;
640 for (i = 0; i < rt->n_next_nodes; i++)
642 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
643 vec_elt (n->n_vectors_by_next_node, i) +=
644 nf->vectors_since_last_overflow;
645 nf->vectors_since_last_overflow = 0;
651 vlib_node_runtime_update_stats (vlib_main_t * vm,
652 vlib_node_runtime_t * node,
654 uword n_vectors, uword n_clocks,
655 uword n_ticks0, uword n_ticks1)
657 u32 ca0, ca1, v0, v1, cl0, cl1, r;
658 u32 ptick00, ptick01, ptick10, ptick11, pvec0, pvec1;
660 cl0 = cl1 = node->clocks_since_last_overflow;
661 ca0 = ca1 = node->calls_since_last_overflow;
662 v0 = v1 = node->vectors_since_last_overflow;
663 ptick00 = ptick01 = node->perf_counter0_ticks_since_last_overflow;
664 ptick10 = ptick11 = node->perf_counter1_ticks_since_last_overflow;
665 pvec0 = pvec1 = node->perf_counter_vectors_since_last_overflow;
669 cl1 = cl0 + n_clocks;
670 ptick01 = ptick00 + n_ticks0;
671 ptick11 = ptick10 + n_ticks1;
672 pvec1 = pvec0 + n_vectors;
674 node->calls_since_last_overflow = ca1;
675 node->clocks_since_last_overflow = cl1;
676 node->vectors_since_last_overflow = v1;
677 node->perf_counter0_ticks_since_last_overflow = ptick01;
678 node->perf_counter1_ticks_since_last_overflow = ptick11;
679 node->perf_counter_vectors_since_last_overflow = pvec1;
681 node->max_clock_n = node->max_clock > n_clocks ?
682 node->max_clock_n : n_vectors;
683 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
685 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
687 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0) || (ptick01 < ptick00)
688 || (ptick11 < ptick10) || (pvec1 < pvec0))
690 node->calls_since_last_overflow = ca0;
691 node->clocks_since_last_overflow = cl0;
692 node->vectors_since_last_overflow = v0;
693 node->perf_counter0_ticks_since_last_overflow = ptick00;
694 node->perf_counter1_ticks_since_last_overflow = ptick10;
695 node->perf_counter_vectors_since_last_overflow = pvec0;
697 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks,
705 vlib_node_runtime_perf_counter (vlib_main_t * vm, u64 * pmc0, u64 * pmc1,
706 vlib_node_runtime_t * node,
707 vlib_frame_t * frame, int before_or_after)
711 if (PREDICT_FALSE (vec_len (vm->vlib_node_runtime_perf_counter_cbs) != 0))
712 clib_call_callbacks (vm->vlib_node_runtime_perf_counter_cbs, vm, pmc0,
713 pmc1, node, frame, before_or_after);
717 vlib_process_update_stats (vlib_main_t * vm,
719 uword n_calls, uword n_vectors, uword n_clocks)
721 vlib_node_runtime_update_stats (vm, &p->node_runtime,
722 n_calls, n_vectors, n_clocks, 0ULL, 0ULL);
725 static clib_error_t *
726 vlib_cli_elog_clear (vlib_main_t * vm,
727 unformat_input_t * input, vlib_cli_command_t * cmd)
729 elog_reset_buffer (&vm->elog_main);
734 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
735 .path = "event-logger clear",
736 .short_help = "Clear the event log",
737 .function = vlib_cli_elog_clear,
742 static clib_error_t *
743 elog_save_buffer (vlib_main_t * vm,
744 unformat_input_t * input, vlib_cli_command_t * cmd)
746 elog_main_t *em = &vm->elog_main;
747 char *file, *chroot_file;
748 clib_error_t *error = 0;
750 if (!unformat (input, "%s", &file))
752 vlib_cli_output (vm, "expected file name, got `%U'",
753 format_unformat_error, input);
757 /* It's fairly hard to get "../oopsie" through unformat; just in case */
758 if (strstr (file, "..") || index (file, '/'))
760 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
764 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
768 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
769 elog_n_events_in_buffer (em),
770 elog_buffer_capacity (em), chroot_file);
772 vlib_worker_thread_barrier_sync (vm);
773 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
774 vlib_worker_thread_barrier_release (vm);
775 vec_free (chroot_file);
780 elog_post_mortem_dump (void)
782 vlib_main_t *vm = &vlib_global_main;
783 elog_main_t *em = &vm->elog_main;
787 if (!vm->elog_post_mortem_dump)
790 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
791 error = elog_write_file (em, (char *) filename, 1 /* flush ring */ );
793 clib_error_report (error);
798 VLIB_CLI_COMMAND (elog_save_cli, static) = {
799 .path = "event-logger save",
800 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
801 .function = elog_save_buffer,
805 static clib_error_t *
806 elog_stop (vlib_main_t * vm,
807 unformat_input_t * input, vlib_cli_command_t * cmd)
809 elog_main_t *em = &vm->elog_main;
811 em->n_total_events_disable_limit = em->n_total_events;
813 vlib_cli_output (vm, "Stopped the event logger...");
818 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
819 .path = "event-logger stop",
820 .short_help = "Stop the event-logger",
821 .function = elog_stop,
825 static clib_error_t *
826 elog_restart (vlib_main_t * vm,
827 unformat_input_t * input, vlib_cli_command_t * cmd)
829 elog_main_t *em = &vm->elog_main;
831 em->n_total_events_disable_limit = ~0;
833 vlib_cli_output (vm, "Restarted the event logger...");
838 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
839 .path = "event-logger restart",
840 .short_help = "Restart the event-logger",
841 .function = elog_restart,
845 static clib_error_t *
846 elog_resize (vlib_main_t * vm,
847 unformat_input_t * input, vlib_cli_command_t * cmd)
849 elog_main_t *em = &vm->elog_main;
852 /* Stop the parade */
853 elog_reset_buffer (&vm->elog_main);
855 if (unformat (input, "%d", &tmp))
857 elog_alloc (em, tmp);
858 em->n_total_events_disable_limit = ~0;
861 return clib_error_return (0, "Must specify how many events in the ring");
863 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
868 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
869 .path = "event-logger resize",
870 .short_help = "event-logger resize <nnn>",
871 .function = elog_resize,
875 #endif /* CLIB_UNIX */
878 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
880 elog_main_t *em = &vm->elog_main;
881 elog_event_t *e, *es;
884 /* Show events in VLIB time since log clock starts after VLIB clock. */
885 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
886 * vm->clib_time.seconds_per_clock;
888 es = elog_peek_events (em);
889 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
891 em->n_total_events < em->n_total_events_disable_limit ?
892 "running" : "stopped");
895 vlib_cli_output (vm, "%18.9f: %U",
896 e->time + dt, format_elog_event, em, e);
898 if (n_events_to_show == 0)
905 static clib_error_t *
906 elog_show_buffer (vlib_main_t * vm,
907 unformat_input_t * input, vlib_cli_command_t * cmd)
909 u32 n_events_to_show;
910 clib_error_t *error = 0;
912 n_events_to_show = 250;
913 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
915 if (unformat (input, "%d", &n_events_to_show))
917 else if (unformat (input, "all"))
918 n_events_to_show = ~0;
920 return unformat_parse_error (input);
922 elog_show_buffer_internal (vm, n_events_to_show);
927 VLIB_CLI_COMMAND (elog_show_cli, static) = {
928 .path = "show event-logger",
929 .short_help = "Show event logger info",
930 .function = elog_show_buffer,
935 vlib_gdb_show_event_log (void)
937 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
941 vlib_elog_main_loop_event (vlib_main_t * vm,
943 u64 time, u32 n_vectors, u32 is_return)
945 vlib_main_t *evm = &vlib_global_main;
946 elog_main_t *em = &evm->elog_main;
947 int enabled = evm->elog_trace_graph_dispatch |
948 evm->elog_trace_graph_circuit;
950 if (PREDICT_FALSE (enabled && n_vectors))
952 if (PREDICT_FALSE (!elog_is_enabled (em)))
954 evm->elog_trace_graph_dispatch = 0;
955 evm->elog_trace_graph_circuit = 0;
959 (evm->elog_trace_graph_dispatch ||
960 (evm->elog_trace_graph_circuit &&
961 node_index == evm->elog_trace_graph_circuit_node_index)))
965 vec_elt_at_index (is_return
966 ? evm->node_return_elog_event_types
967 : evm->node_call_elog_event_types,
971 &vlib_worker_threads[vm->thread_index].elog_track
972 : &em->default_track),
973 /* data to log */ n_vectors);
978 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
979 void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 node_index);
980 void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
983 vlib_buffer_trace_trajectory_init (vlib_buffer_t * b)
985 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_init_cb != 0))
987 (*vlib_buffer_trace_trajectory_init_cb) (b);
994 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
996 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
997 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_cb != 0))
999 (*vlib_buffer_trace_trajectory_cb) (b, node_index);
1004 u8 *format_vnet_buffer_flags (u8 * s, va_list * args) __attribute__ ((weak));
1006 format_vnet_buffer_flags (u8 * s, va_list * args)
1008 s = format (s, "BUG STUB %s", __FUNCTION__);
1012 u8 *format_vnet_buffer_opaque (u8 * s, va_list * args) __attribute__ ((weak));
1014 format_vnet_buffer_opaque (u8 * s, va_list * args)
1016 s = format (s, "BUG STUB %s", __FUNCTION__);
1020 u8 *format_vnet_buffer_opaque2 (u8 * s, va_list * args)
1021 __attribute__ ((weak));
1023 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
1025 s = format (s, "BUG STUB %s", __FUNCTION__);
1030 format_buffer_metadata (u8 * s, va_list * args)
1032 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
1034 s = format (s, "flags: %U\n", format_vnet_buffer_flags, b);
1035 s = format (s, "current_data: %d, current_length: %d\n",
1036 (i32) (b->current_data), (i32) (b->current_length));
1039 "current_config_index/punt_reason: %d, flow_id: %x, next_buffer: %x\n",
1040 b->current_config_index, b->flow_id, b->next_buffer);
1042 format (s, "error: %d, ref_count: %d, buffer_pool_index: %d\n",
1043 (u32) (b->error), (u32) (b->ref_count),
1044 (u32) (b->buffer_pool_index));
1046 format (s, "trace_handle: 0x%x, len_not_first_buf: %d\n", b->trace_handle,
1047 b->total_length_not_including_first_buffer);
1051 #define A(x) vec_add1(vm->pcap_buffer, (x))
1054 dispatch_pcap_trace (vlib_main_t * vm,
1055 vlib_node_runtime_t * node, vlib_frame_t * frame)
1058 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **bufp, *b;
1059 pcap_main_t *pm = &vlib_global_main.dispatch_pcap_main;
1060 vlib_trace_main_t *tm = &vm->trace_main;
1064 f64 time_now = vlib_time_now (vm);
1069 /* Input nodes don't have frames yet */
1070 if (frame == 0 || frame->n_vectors == 0)
1073 from = vlib_frame_vector_args (frame);
1074 vlib_get_buffers (vm, from, bufs, frame->n_vectors);
1077 n = vlib_get_node (vm, node->node_index);
1079 for (i = 0; i < frame->n_vectors; i++)
1081 if (PREDICT_TRUE (pm->n_packets_captured < pm->n_packets_to_capture))
1085 vec_reset_length (vm->pcap_buffer);
1088 /* Version, flags */
1089 A ((u8) VLIB_PCAP_MAJOR_VERSION);
1090 A ((u8) VLIB_PCAP_MINOR_VERSION);
1091 A (0 /* string_count */ );
1092 A (n->protocol_hint);
1094 /* Buffer index (big endian) */
1095 A ((from[i] >> 24) & 0xff);
1096 A ((from[i] >> 16) & 0xff);
1097 A ((from[i] >> 8) & 0xff);
1098 A ((from[i] >> 0) & 0xff);
1100 /* Node name, NULL-terminated ASCII */
1101 vm->pcap_buffer = format (vm->pcap_buffer, "%v%c", n->name, 0);
1104 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1105 format_buffer_metadata, b, 0);
1107 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1108 format_vnet_buffer_opaque, b, 0);
1110 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1111 format_vnet_buffer_opaque2, b, 0);
1114 /* Is this packet traced? */
1115 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1117 vlib_trace_header_t **h
1118 = pool_elt_at_index (tm->trace_buffer_pool,
1119 vlib_buffer_get_trace_index (b));
1121 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1122 format_vlib_trace, vm, h[0], 0);
1126 /* Save the string count */
1127 vm->pcap_buffer[2] = string_count;
1129 /* Figure out how many bytes in the pcap trace */
1130 capture_size = vec_len (vm->pcap_buffer) +
1131 +vlib_buffer_length_in_chain (vm, b);
1133 clib_spinlock_lock_if_init (&pm->lock);
1134 n_left = clib_min (capture_size, 16384);
1135 d = pcap_add_packet (pm, time_now, n_left, capture_size);
1137 /* Copy the header */
1138 clib_memcpy_fast (d, vm->pcap_buffer, vec_len (vm->pcap_buffer));
1139 d += vec_len (vm->pcap_buffer);
1142 (vlib_buffer_length_in_chain (vm, b),
1143 (16384 - vec_len (vm->pcap_buffer)));
1144 /* Copy the packet data */
1147 u32 copy_length = clib_min ((u32) n_left, b->current_length);
1148 clib_memcpy_fast (d, b->data + b->current_data, copy_length);
1149 n_left -= b->current_length;
1152 d += b->current_length;
1153 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
1154 b = vlib_get_buffer (vm, b->next_buffer);
1156 clib_spinlock_unlock_if_init (&pm->lock);
1161 static_always_inline u64
1162 dispatch_node (vlib_main_t * vm,
1163 vlib_node_runtime_t * node,
1164 vlib_node_type_t type,
1165 vlib_node_state_t dispatch_state,
1166 vlib_frame_t * frame, u64 last_time_stamp)
1170 vlib_node_main_t *nm = &vm->node_main;
1171 vlib_next_frame_t *nf;
1172 u64 pmc_before[2], pmc_after[2], pmc_delta[2];
1176 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1177 ASSERT (n->type == type);
1180 /* Only non-internal nodes may be disabled. */
1181 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
1183 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
1184 return last_time_stamp;
1187 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
1188 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
1190 u32 c = node->input_main_loops_per_call;
1191 /* Only call node when count reaches zero. */
1194 node->input_main_loops_per_call = c - 1;
1195 return last_time_stamp;
1199 /* Speculatively prefetch next frames. */
1200 if (node->n_next_nodes > 0)
1202 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
1203 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
1206 vm->cpu_time_last_node_dispatch = last_time_stamp;
1208 vlib_elog_main_loop_event (vm, node->node_index,
1209 last_time_stamp, frame ? frame->n_vectors : 0,
1212 vlib_node_runtime_perf_counter (vm, &pmc_before[0], &pmc_before[1],
1213 node, frame, 0 /* before */ );
1216 * Turn this on if you run into
1217 * "bad monkey" contexts, and you want to know exactly
1218 * which nodes they've visited... See ixge.c...
1220 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
1224 from = vlib_frame_vector_args (frame);
1225 for (i = 0; i < frame->n_vectors; i++)
1227 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1228 add_trajectory_trace (b, node->node_index);
1230 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1231 dispatch_pcap_trace (vm, node, frame);
1232 n = node->function (vm, node, frame);
1236 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1237 dispatch_pcap_trace (vm, node, frame);
1238 n = node->function (vm, node, frame);
1241 t = clib_cpu_time_now ();
1244 * To validate accounting: pmc_delta = t - pmc_before;
1245 * perf ticks should equal clocks/pkt...
1247 vlib_node_runtime_perf_counter (vm, &pmc_after[0], &pmc_after[1], node,
1248 frame, 1 /* after */ );
1250 pmc_delta[0] = pmc_after[0] - pmc_before[0];
1251 pmc_delta[1] = pmc_after[1] - pmc_before[1];
1253 vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
1255 vm->main_loop_vectors_processed += n;
1256 vm->main_loop_nodes_processed += n > 0;
1258 v = vlib_node_runtime_update_stats (vm, node,
1261 /* n_clocks */ t - last_time_stamp,
1262 pmc_delta[0] /* PMC0 */ ,
1263 pmc_delta[1] /* PMC1 */ );
1265 /* When in interrupt mode and vector rate crosses threshold switch to
1267 if (PREDICT_FALSE ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1268 || (dispatch_state == VLIB_NODE_STATE_POLLING
1271 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))))
1274 ELOG_TYPE_DECLARE (e) =
1276 .function = (char *) __FUNCTION__,
1277 .format = "%s vector length %d, switching to %s",
1278 .format_args = "T4i4t4",
1279 .n_enum_strings = 2,
1281 "interrupt", "polling",
1287 u32 node_name, vector_length, is_polling;
1290 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1291 && v >= nm->polling_threshold_vector_length) &&
1293 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1295 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1296 n->state = VLIB_NODE_STATE_POLLING;
1297 node->state = VLIB_NODE_STATE_POLLING;
1299 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1300 node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1301 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1302 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1304 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1306 vlib_worker_thread_t *w = vlib_worker_threads
1309 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1311 ed->node_name = n->name_elog_string;
1312 ed->vector_length = v;
1316 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1317 && v <= nm->interrupt_threshold_vector_length)
1319 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1321 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1323 /* Switch to interrupt mode after dispatch in polling one more time.
1324 This allows driver to re-enable interrupts. */
1325 n->state = VLIB_NODE_STATE_INTERRUPT;
1326 node->state = VLIB_NODE_STATE_INTERRUPT;
1328 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1329 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1330 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
1335 vlib_worker_thread_t *w = vlib_worker_threads
1338 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1339 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1341 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1343 ed->node_name = n->name_elog_string;
1344 ed->vector_length = v;
1355 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1356 u64 last_time_stamp)
1358 vlib_node_main_t *nm = &vm->node_main;
1360 vlib_next_frame_t *nf, nf_dummy;
1361 vlib_node_runtime_t *n;
1362 vlib_frame_t *restore_frame;
1363 vlib_pending_frame_t *p;
1365 /* See comment below about dangling references to nm->pending_frames */
1366 p = nm->pending_frames + pending_frame_index;
1368 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1369 p->node_runtime_index);
1371 f = vlib_get_frame (vm, p->frame);
1372 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1374 /* No next frame: so use dummy on stack. */
1376 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1380 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1382 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1384 /* Force allocation of new frame while current frame is being
1386 restore_frame = NULL;
1387 if (nf->frame == p->frame)
1390 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1391 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1392 restore_frame = p->frame;
1395 /* Frame must be pending. */
1396 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1397 ASSERT (f->n_vectors > 0);
1399 /* Copy trace flag from next frame to node.
1400 Trace flag indicates that at least one vector in the dispatched
1402 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1403 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1404 nf->flags &= ~VLIB_FRAME_TRACE;
1406 last_time_stamp = dispatch_node (vm, n,
1407 VLIB_NODE_TYPE_INTERNAL,
1408 VLIB_NODE_STATE_POLLING,
1409 f, last_time_stamp);
1410 /* Internal node vector-rate accounting, for summary stats */
1411 vm->internal_node_vectors += f->n_vectors;
1412 vm->internal_node_calls++;
1413 vm->internal_node_last_vectors_per_main_loop =
1414 (f->n_vectors > vm->internal_node_last_vectors_per_main_loop) ?
1415 f->n_vectors : vm->internal_node_last_vectors_per_main_loop;
1417 f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
1419 /* Frame is ready to be used again, so restore it. */
1420 if (restore_frame != NULL)
1423 * We musn't restore a frame that is flagged to be freed. This
1424 * shouldn't happen since frames to be freed post dispatch are
1425 * those used when the to-node frame becomes full i.e. they form a
1426 * sort of queue of frames to a single node. If we get here then
1427 * the to-node frame and the pending frame *were* the same, and so
1428 * we removed the to-node frame. Therefore this frame is no
1429 * longer part of the queue for that node and hence it cannot be
1432 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1435 * NB: dispatching node n can result in the creation and scheduling
1436 * of new frames, and hence in the reallocation of nm->pending_frames.
1437 * Recompute p, or no supper. This was broken for more than 10 years.
1439 p = nm->pending_frames + pending_frame_index;
1442 * p->next_frame_index can change during node dispatch if node
1443 * function decides to change graph hook up.
1445 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1446 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1448 if (NULL == nf->frame)
1450 /* no new frame has been assigned to this node, use the saved one */
1451 nf->frame = restore_frame;
1456 /* The node has gained a frame, implying packets from the current frame
1457 were re-queued to this same node. we don't need the saved one
1459 vlib_frame_free (vm, n, f);
1464 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1466 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1467 vlib_frame_free (vm, n, f);
1471 return last_time_stamp;
1475 vlib_process_stack_is_valid (vlib_process_t * p)
1477 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1483 vlib_process_t *process;
1484 vlib_frame_t *frame;
1485 } vlib_process_bootstrap_args_t;
1487 /* Called in process stack. */
1489 vlib_process_bootstrap (uword _a)
1491 vlib_process_bootstrap_args_t *a;
1493 vlib_node_runtime_t *node;
1498 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1503 node = &p->node_runtime;
1505 n = node->function (vm, node, f);
1507 ASSERT (vlib_process_stack_is_valid (p));
1509 clib_longjmp (&p->return_longjmp, n);
1514 /* Called in main stack. */
1515 static_always_inline uword
1516 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1518 vlib_process_bootstrap_args_t a;
1525 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1526 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1527 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1528 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1533 static_always_inline uword
1534 vlib_process_resume (vlib_process_t * p)
1537 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1538 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1539 | VLIB_PROCESS_RESUME_PENDING);
1540 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1541 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1542 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1547 dispatch_process (vlib_main_t * vm,
1548 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1550 vlib_node_main_t *nm = &vm->node_main;
1551 vlib_node_runtime_t *node_runtime = &p->node_runtime;
1552 vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1553 u32 old_process_index;
1555 uword n_vectors, is_suspend;
1557 if (node->state != VLIB_NODE_STATE_POLLING
1558 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1559 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1560 return last_time_stamp;
1562 p->flags |= VLIB_PROCESS_IS_RUNNING;
1564 t = last_time_stamp;
1565 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1566 f ? f->n_vectors : 0, /* is_after */ 0);
1568 /* Save away current process for suspend. */
1569 old_process_index = nm->current_process_index;
1570 nm->current_process_index = node->runtime_index;
1572 n_vectors = vlib_process_startup (vm, p, f);
1574 nm->current_process_index = old_process_index;
1576 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1577 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1580 vlib_pending_frame_t *pf;
1583 pool_get (nm->suspended_process_frames, pf);
1584 pf->node_runtime_index = node->runtime_index;
1586 pf->next_frame_index = ~0;
1589 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1591 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1593 TWT (tw_timer_wheel) * tw =
1594 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1595 p->stop_timer_handle =
1596 TW (tw_timer_start) (tw,
1597 vlib_timing_wheel_data_set_suspended_process
1598 (node->runtime_index) /* [sic] pool idex */ ,
1600 p->resume_clock_interval);
1604 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1606 t = clib_cpu_time_now ();
1608 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1611 vlib_process_update_stats (vm, p,
1612 /* n_calls */ !is_suspend,
1613 /* n_vectors */ n_vectors,
1614 /* n_clocks */ t - last_time_stamp);
1620 vlib_start_process (vlib_main_t * vm, uword process_index)
1622 vlib_node_main_t *nm = &vm->node_main;
1623 vlib_process_t *p = vec_elt (nm->processes, process_index);
1624 dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1628 dispatch_suspended_process (vlib_main_t * vm,
1629 uword process_index, u64 last_time_stamp)
1631 vlib_node_main_t *nm = &vm->node_main;
1632 vlib_node_runtime_t *node_runtime;
1636 vlib_pending_frame_t *pf;
1637 u64 t, n_vectors, is_suspend;
1639 t = last_time_stamp;
1641 p = vec_elt (nm->processes, process_index);
1642 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1643 return last_time_stamp;
1645 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1646 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1648 pf = pool_elt_at_index (nm->suspended_process_frames,
1649 p->suspended_process_frame_index);
1651 node_runtime = &p->node_runtime;
1652 node = vlib_get_node (vm, node_runtime->node_index);
1655 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1656 f ? f->n_vectors : 0, /* is_after */ 0);
1658 /* Save away current process for suspend. */
1659 nm->current_process_index = node->runtime_index;
1661 n_vectors = vlib_process_resume (p);
1662 t = clib_cpu_time_now ();
1664 nm->current_process_index = ~0;
1666 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1669 /* Suspend it again. */
1672 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1674 p->stop_timer_handle =
1675 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1676 vlib_timing_wheel_data_set_suspended_process
1677 (node->runtime_index) /* [sic] pool idex */ ,
1679 p->resume_clock_interval);
1684 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1685 pool_put_index (nm->suspended_process_frames,
1686 p->suspended_process_frame_index);
1687 p->suspended_process_frame_index = ~0;
1690 t = clib_cpu_time_now ();
1691 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1694 vlib_process_update_stats (vm, p,
1695 /* n_calls */ !is_suspend,
1696 /* n_vectors */ n_vectors,
1697 /* n_clocks */ t - last_time_stamp);
1702 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1704 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1709 static_always_inline void
1710 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1712 vlib_node_main_t *nm = &vm->node_main;
1713 vlib_thread_main_t *tm = vlib_get_thread_main ();
1717 vlib_frame_queue_main_t *fqm;
1718 u32 *last_node_runtime_indices = 0;
1719 u32 frame_queue_check_counter = 0;
1721 /* Initialize pending node vector. */
1724 vec_resize (nm->pending_frames, 32);
1725 _vec_len (nm->pending_frames) = 0;
1728 /* Mark time of main loop start. */
1731 cpu_time_now = vm->clib_time.last_cpu_time;
1732 vm->cpu_time_main_loop_start = cpu_time_now;
1735 cpu_time_now = clib_cpu_time_now ();
1737 /* Pre-allocate interupt runtime indices and lock. */
1738 vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1739 vec_alloc (last_node_runtime_indices, 32);
1741 clib_spinlock_init (&nm->pending_interrupt_lock);
1743 /* Pre-allocate expired nodes. */
1744 if (!nm->polling_threshold_vector_length)
1745 nm->polling_threshold_vector_length = 10;
1746 if (!nm->interrupt_threshold_vector_length)
1747 nm->interrupt_threshold_vector_length = 5;
1749 vm->cpu_id = clib_get_current_cpu_id ();
1750 vm->numa_node = clib_get_current_numa_node ();
1751 os_set_numa_index (vm->numa_node);
1753 /* Start all processes. */
1759 * Perform an initial barrier sync. Pays no attention to
1760 * the barrier sync hold-down timer scheme, which won't work
1761 * at this point in time.
1763 vlib_worker_thread_initial_barrier_sync_and_release (vm);
1765 nm->current_process_index = ~0;
1766 for (i = 0; i < vec_len (nm->processes); i++)
1767 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1773 vlib_node_runtime_t *n;
1775 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1778 vl_api_send_pending_rpc_requests (vm);
1783 vlib_worker_thread_barrier_check ();
1784 if (PREDICT_FALSE (vm->check_frame_queues +
1785 frame_queue_check_counter))
1789 if (vm->check_frame_queues)
1791 frame_queue_check_counter = 100;
1792 vm->check_frame_queues = 0;
1795 vec_foreach (fqm, tm->frame_queue_mains)
1796 processed += vlib_frame_queue_dequeue (vm, fqm);
1798 /* No handoff queue work found? */
1800 frame_queue_check_counter = 100;
1802 frame_queue_check_counter--;
1804 if (PREDICT_FALSE (vec_len (vm->worker_thread_main_loop_callbacks)))
1805 clib_call_callbacks (vm->worker_thread_main_loop_callbacks, vm);
1808 /* Process pre-input nodes. */
1809 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1810 cpu_time_now = dispatch_node (vm, n,
1811 VLIB_NODE_TYPE_PRE_INPUT,
1812 VLIB_NODE_STATE_POLLING,
1816 /* Next process input nodes. */
1817 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1818 cpu_time_now = dispatch_node (vm, n,
1819 VLIB_NODE_TYPE_INPUT,
1820 VLIB_NODE_STATE_POLLING,
1824 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1825 vm->queue_signal_callback (vm);
1827 /* Next handle interrupts. */
1829 /* unlocked read, for performance */
1830 uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1832 if (PREDICT_FALSE (l > 0))
1837 clib_spinlock_lock (&nm->pending_interrupt_lock);
1838 /* Re-read w/ lock held, in case another thread added an item */
1839 l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1842 tmp = nm->pending_interrupt_node_runtime_indices;
1843 nm->pending_interrupt_node_runtime_indices =
1844 last_node_runtime_indices;
1845 last_node_runtime_indices = tmp;
1846 _vec_len (last_node_runtime_indices) = 0;
1848 clib_spinlock_unlock (&nm->pending_interrupt_lock);
1849 for (i = 0; i < l; i++)
1851 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1852 last_node_runtime_indices[i]);
1854 dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1855 VLIB_NODE_STATE_INTERRUPT,
1861 /* Input nodes may have added work to the pending vector.
1862 Process pending vector until there is nothing left.
1863 All pending vectors will be processed from input -> output. */
1864 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1865 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1866 /* Reset pending vector for next iteration. */
1867 _vec_len (nm->pending_frames) = 0;
1872 ELOG_TYPE_DECLARE (es) =
1874 .format = "process tw start",
1877 ELOG_TYPE_DECLARE (ee) =
1879 .format = "process tw end: %d",
1880 .format_args = "i4",
1889 /* Check if process nodes have expired from timing wheel. */
1890 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1892 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1893 ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1895 nm->data_from_advancing_timing_wheel =
1896 TW (tw_timer_expire_timers_vec)
1897 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1898 nm->data_from_advancing_timing_wheel);
1900 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1902 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1904 ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1906 _vec_len (nm->data_from_advancing_timing_wheel);
1910 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1914 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1917 u32 d = nm->data_from_advancing_timing_wheel[i];
1918 u32 di = vlib_timing_wheel_data_get_index (d);
1920 if (vlib_timing_wheel_data_is_timed_event (d))
1922 vlib_signal_timed_event_data_t *te =
1923 pool_elt_at_index (nm->signal_timed_event_data_pool,
1926 vlib_get_node (vm, te->process_node_index);
1928 vec_elt (nm->processes, n->runtime_index);
1931 vlib_process_signal_event_helper (nm, n, p,
1932 te->event_type_index,
1934 te->n_data_elt_bytes);
1935 if (te->n_data_bytes < sizeof (te->inline_event_data))
1936 clib_memcpy_fast (data, te->inline_event_data,
1940 clib_memcpy_fast (data, te->event_data_as_vector,
1942 vec_free (te->event_data_as_vector);
1944 pool_put (nm->signal_timed_event_data_pool, te);
1948 cpu_time_now = clib_cpu_time_now ();
1950 dispatch_suspended_process (vm, di, cpu_time_now);
1953 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1956 vlib_increment_main_loop_counter (vm);
1957 /* Record time stamp in case there are no enabled nodes and above
1958 calls do not update time stamp. */
1959 cpu_time_now = clib_cpu_time_now ();
1960 vm->loops_this_reporting_interval++;
1961 now = clib_time_now_internal (&vm->clib_time, cpu_time_now);
1962 /* Time to update loops_per_second? */
1963 if (PREDICT_FALSE (now >= vm->loop_interval_end))
1965 /* Next sample ends in 20ms */
1966 if (vm->loop_interval_start)
1968 f64 this_loops_per_second;
1970 this_loops_per_second =
1971 ((f64) vm->loops_this_reporting_interval) / (now -
1972 vm->loop_interval_start);
1974 vm->loops_per_second =
1975 vm->loops_per_second * vm->damping_constant +
1976 (1.0 - vm->damping_constant) * this_loops_per_second;
1977 if (vm->loops_per_second != 0.0)
1978 vm->seconds_per_loop = 1.0 / vm->loops_per_second;
1980 vm->seconds_per_loop = 0.0;
1982 /* New interval starts now, and ends in 20ms */
1983 vm->loop_interval_start = now;
1984 vm->loop_interval_end = now + 2e-4;
1985 vm->loops_this_reporting_interval = 0;
1991 vlib_main_loop (vlib_main_t * vm)
1993 vlib_main_or_worker_loop (vm, /* is_main */ 1);
1997 vlib_worker_loop (vlib_main_t * vm)
1999 vlib_main_or_worker_loop (vm, /* is_main */ 0);
2002 vlib_main_t vlib_global_main;
2004 static clib_error_t *
2005 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
2007 int turn_on_mem_trace = 0;
2009 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2011 if (unformat (input, "memory-trace"))
2012 turn_on_mem_trace = 1;
2014 else if (unformat (input, "elog-events %d",
2015 &vm->elog_main.event_ring_size))
2017 else if (unformat (input, "elog-post-mortem-dump"))
2018 vm->elog_post_mortem_dump = 1;
2019 else if (unformat (input, "buffer-alloc-success-rate %f",
2020 &vm->buffer_alloc_success_rate))
2022 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
2023 return clib_error_return
2024 (0, "Buffer fault injection not configured");
2026 else if (unformat (input, "buffer-alloc-success-seed %u",
2027 &vm->buffer_alloc_success_seed))
2029 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
2030 return clib_error_return
2031 (0, "Buffer fault injection not configured");
2034 return unformat_parse_error (input);
2037 unformat_free (input);
2039 /* Enable memory trace as early as possible. */
2040 if (turn_on_mem_trace)
2046 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
2049 dummy_queue_signal_callback (vlib_main_t * vm)
2053 #define foreach_weak_reference_stub \
2054 _(vlib_map_stat_segment_init) \
2056 _(vlibmemory_init) \
2057 _(map_api_segment_init)
2060 clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
2061 clib_error_t *name (vlib_main_t *vm) { return 0; }
2062 foreach_weak_reference_stub;
2065 void vl_api_set_elog_main (elog_main_t * m) __attribute__ ((weak));
2067 vl_api_set_elog_main (elog_main_t * m)
2069 clib_warning ("STUB");
2072 int vl_api_set_elog_trace_api_messages (int enable) __attribute__ ((weak));
2074 vl_api_set_elog_trace_api_messages (int enable)
2076 clib_warning ("STUB");
2080 int vl_api_get_elog_trace_api_messages (void) __attribute__ ((weak));
2082 vl_api_get_elog_trace_api_messages (void)
2084 clib_warning ("STUB");
2088 /* Main function. */
2090 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
2092 clib_error_t *volatile error;
2093 vlib_node_main_t *nm = &vm->node_main;
2095 vm->queue_signal_callback = dummy_queue_signal_callback;
2097 /* Turn on event log. */
2098 if (!vm->elog_main.event_ring_size)
2099 vm->elog_main.event_ring_size = 128 << 10;
2100 elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
2101 elog_enable_disable (&vm->elog_main, 1);
2102 vl_api_set_elog_main (&vm->elog_main);
2103 (void) vl_api_set_elog_trace_api_messages (1);
2109 if ((error = vlib_physmem_init (vm)))
2111 clib_error_report (error);
2115 if ((error = vlib_map_stat_segment_init (vm)))
2117 clib_error_report (error);
2121 if ((error = vlib_buffer_main_init (vm)))
2123 clib_error_report (error);
2127 if ((error = vlib_thread_init (vm)))
2129 clib_error_report (error);
2133 /* Register static nodes so that init functions may use them. */
2134 vlib_register_all_static_nodes (vm);
2136 /* Set seed for random number generator.
2137 Allow user to specify seed to make random sequence deterministic. */
2138 if (!unformat (input, "seed %wd", &vm->random_seed))
2139 vm->random_seed = clib_cpu_time_now ();
2140 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
2142 /* Initialize node graph. */
2143 if ((error = vlib_node_main_init (vm)))
2145 /* Arrange for graph hook up error to not be fatal when debugging. */
2147 clib_error_report (error);
2152 /* Direct call / weak reference, for vlib standalone use-cases */
2153 if ((error = vpe_api_init (vm)))
2155 clib_error_report (error);
2159 if ((error = vlibmemory_init (vm)))
2161 clib_error_report (error);
2165 if ((error = map_api_segment_init (vm)))
2167 clib_error_report (error);
2171 /* See unix/main.c; most likely already set up */
2172 if (vm->init_functions_called == 0)
2173 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
2174 if ((error = vlib_call_all_init_functions (vm)))
2177 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
2178 CLIB_CACHE_LINE_BYTES);
2180 vec_validate (nm->data_from_advancing_timing_wheel, 10);
2181 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
2183 /* Create the process timing wheel */
2184 TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
2185 0 /* no callback */ ,
2186 10e-6 /* timer period 10us */ ,
2187 ~0 /* max expirations per call */ );
2189 vec_validate (vm->pending_rpc_requests, 0);
2190 _vec_len (vm->pending_rpc_requests) = 0;
2191 vec_validate (vm->processing_rpc_requests, 0);
2192 _vec_len (vm->processing_rpc_requests) = 0;
2194 /* Default params for the buffer allocator fault injector, if configured */
2195 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0)
2197 vm->buffer_alloc_success_seed = 0xdeaddabe;
2198 vm->buffer_alloc_success_rate = 0.80;
2201 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
2205 * Use exponential smoothing, with a half-life of 1 second
2206 * reported_rate(t) = reported_rate(t-1) * K + rate(t)*(1-K)
2208 * Sample every 20ms, aka 50 samples per second
2209 * K = exp (-1.0/20.0);
2212 vm->damping_constant = exp (-1.0 / 20.0);
2214 /* Sort per-thread init functions before we start threads */
2215 vlib_sort_init_exit_functions (&vm->worker_init_function_registrations);
2217 /* Call all main loop enter functions. */
2219 clib_error_t *sub_error;
2220 sub_error = vlib_call_all_main_loop_enter_functions (vm);
2222 clib_error_report (sub_error);
2225 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2227 case VLIB_MAIN_LOOP_EXIT_NONE:
2228 vm->main_loop_exit_set = 1;
2231 case VLIB_MAIN_LOOP_EXIT_CLI:
2235 error = vm->main_loop_error;
2239 vlib_main_loop (vm);
2242 /* Call all exit functions. */
2244 clib_error_t *sub_error;
2245 sub_error = vlib_call_all_main_loop_exit_functions (vm);
2247 clib_error_report (sub_error);
2251 clib_error_report (error);
2257 vlib_pcap_dispatch_trace_configure (vlib_pcap_dispatch_trace_args_t * a)
2259 vlib_main_t *vm = vlib_get_main ();
2260 pcap_main_t *pm = &vm->dispatch_pcap_main;
2261 vlib_trace_main_t *tm;
2262 vlib_trace_node_t *tn;
2266 if (vm->dispatch_pcap_enable)
2270 (vm, "pcap dispatch capture enabled: %d of %d pkts...",
2271 pm->n_packets_captured, pm->n_packets_to_capture);
2272 vlib_cli_output (vm, "capture to file %s", pm->file_name);
2274 for (i = 0; i < vec_len (vm->dispatch_buffer_trace_nodes); i++)
2276 vlib_cli_output (vm,
2277 "Buffer trace of %d pkts from %U enabled...",
2278 a->buffer_traces_to_capture,
2279 format_vlib_node_name, vm,
2280 vm->dispatch_buffer_trace_nodes[i]);
2284 vlib_cli_output (vm, "pcap dispatch capture disabled");
2288 /* Consistency checks */
2290 /* Enable w/ capture already enabled not allowed */
2291 if (vm->dispatch_pcap_enable && a->enable)
2292 return -7; /* VNET_API_ERROR_INVALID_VALUE */
2294 /* Disable capture with capture already disabled, not interesting */
2295 if (vm->dispatch_pcap_enable == 0 && a->enable == 0)
2296 return -81; /* VNET_API_ERROR_VALUE_EXIST */
2298 /* Change number of packets to capture while capturing */
2299 if (vm->dispatch_pcap_enable && a->enable
2300 && (pm->n_packets_to_capture != a->packets_to_capture))
2301 return -8; /* VNET_API_ERROR_INVALID_VALUE_2 */
2303 /* Independent of enable/disable, to allow buffer trace multi nodes */
2304 if (a->buffer_trace_node_index != ~0)
2307 foreach_vlib_main ((
2309 tm = &this_vlib_main->trace_main;
2310 tm->verbose = 0; /* not sure this ever did anything... */
2311 vec_validate (tm->nodes, a->buffer_trace_node_index);
2312 tn = tm->nodes + a->buffer_trace_node_index;
2313 tn->limit += a->buffer_traces_to_capture;
2314 tm->trace_enable = 1;
2317 vec_add1 (vm->dispatch_buffer_trace_nodes, a->buffer_trace_node_index);
2322 /* Clean up from previous run, if any */
2323 vec_free (pm->file_name);
2324 vec_free (pm->pcap_data);
2325 memset (pm, 0, sizeof (*pm));
2327 vec_validate_aligned (vnet_trace_dummy, 2048, CLIB_CACHE_LINE_BYTES);
2329 clib_spinlock_init (&(pm->lock));
2331 if (a->filename == 0)
2332 a->filename = format (0, "/tmp/dispatch.pcap%c", 0);
2334 pm->file_name = (char *) a->filename;
2335 pm->n_packets_captured = 0;
2336 pm->packet_type = PCAP_PACKET_TYPE_vpp;
2337 pm->n_packets_to_capture = a->packets_to_capture;
2339 foreach_vlib_main (({this_vlib_main->dispatch_pcap_enable = 1;}));
2345 foreach_vlib_main (({this_vlib_main->dispatch_pcap_enable = 0;}));
2347 vec_reset_length (vm->dispatch_buffer_trace_nodes);
2348 if (pm->n_packets_captured)
2350 clib_error_t *error;
2351 pm->n_packets_to_capture = pm->n_packets_captured;
2352 vlib_cli_output (vm, "Write %d packets to %s, and stop capture...",
2353 pm->n_packets_captured, pm->file_name);
2354 error = pcap_write (pm);
2355 if (pm->flags & PCAP_MAIN_INIT_DONE)
2357 /* Report I/O errors... */
2360 clib_error_report (error);
2361 return -11; /* VNET_API_ERROR_SYSCALL_ERROR_1 */
2366 return -6; /* VNET_API_ERROR_NO_SUCH_ENTRY */
2372 static clib_error_t *
2373 dispatch_trace_command_fn (vlib_main_t * vm,
2374 unformat_input_t * input, vlib_cli_command_t * cmd)
2376 unformat_input_t _line_input, *line_input = &_line_input;
2377 vlib_pcap_dispatch_trace_args_t _a, *a = &_a;
2383 u32 node_index = ~0, buffer_traces_to_capture = 100;
2385 /* Get a line of input. */
2386 if (!unformat_user (input, unformat_line_input, line_input))
2389 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2391 if (unformat (line_input, "on %=", &enable, 1))
2393 else if (unformat (line_input, "enable %=", &enable, 1))
2395 else if (unformat (line_input, "off %=", &enable, 0))
2397 else if (unformat (line_input, "disable %=", &enable, 0))
2399 else if (unformat (line_input, "max %d", &max))
2401 else if (unformat (line_input, "packets-to-capture %d", &max))
2403 else if (unformat (line_input, "file %U", unformat_vlib_tmpfile,
2406 else if (unformat (line_input, "status %=", &status, 1))
2408 else if (unformat (line_input, "buffer-trace %U %d",
2409 unformat_vlib_node, vm, &node_index,
2410 &buffer_traces_to_capture))
2414 return clib_error_return (0, "unknown input `%U'",
2415 format_unformat_error, line_input);
2419 unformat_free (line_input);
2421 /* no need for memset (a, 0, sizeof (*a)), set all fields here. */
2422 a->filename = filename;
2425 a->packets_to_capture = max;
2426 a->buffer_trace_node_index = node_index;
2427 a->buffer_traces_to_capture = buffer_traces_to_capture;
2429 rv = vlib_pcap_dispatch_trace_configure (a);
2437 return clib_error_return (0, "dispatch trace already enabled...");
2440 return clib_error_return (0, "dispatch trace already disabled...");
2443 return clib_error_return
2444 (0, "can't change number of records to capture while tracing...");
2447 return clib_error_return (0, "I/O writing trace capture...");
2450 return clib_error_return (0, "No packets captured...");
2453 vlib_cli_output (vm, "WARNING: trace configure returned %d", rv);
2460 * This command is used to start or stop pcap dispatch trace capture, or show
2461 * the capture status.
2463 * This command has the following optional parameters:
2465 * - <b>on|off</b> - Used to start or stop capture.
2467 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2468 * of packets have been received, buffer is flushed to file. Once another
2469 * '<em>nn</em>' number of packets have been received, buffer is flushed
2470 * to file, overwriting previous write. If not entered, value defaults
2471 * to 100. Can only be updated if packet capture is off.
2473 * - <b>file <name></b> - Used to specify the output filename. The file will
2474 * be placed in the '<em>/tmp</em>' directory, so only the filename is
2475 * supported. Directory should not be entered. If file already exists, file
2476 * will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
2477 * will be used. Can only be updated if packet capture is off.
2479 * - <b>status</b> - Displays the current status and configured attributes
2480 * associated with a packet capture. If packet capture is in progress,
2481 * '<em>status</em>' also will return the number of packets currently in
2482 * the local buffer. All additional attributes entered on command line
2483 * with '<em>status</em>' will be ignored and not applied.
2486 * Example of how to display the status of capture when off:
2487 * @cliexstart{pcap dispatch trace status}
2488 * max is 100, for any interface to file /tmp/vpe.pcap
2489 * pcap dispatch capture is off...
2491 * Example of how to start a dispatch trace capture:
2492 * @cliexstart{pcap dispatch trace on max 35 file dispatchTrace.pcap}
2493 * pcap dispatch capture on...
2495 * Example of how to start a dispatch trace capture with buffer tracing
2496 * @cliexstart{pcap dispatch trace on max 10000 file dispatchTrace.pcap buffer-trace dpdk-input 1000}
2497 * pcap dispatch capture on...
2499 * Example of how to display the status of a tx packet capture in progress:
2500 * @cliexstart{pcap tx trace status}
2501 * max is 35, dispatch trace to file /tmp/vppTest.pcap
2502 * pcap tx capture is on: 20 of 35 pkts...
2504 * Example of how to stop a tx packet capture:
2505 * @cliexstart{vppctl pcap dispatch trace off}
2506 * captured 21 pkts...
2507 * saved to /tmp/dispatchTrace.pcap...
2511 VLIB_CLI_COMMAND (pcap_dispatch_trace_command, static) = {
2512 .path = "pcap dispatch trace",
2514 "pcap dispatch trace [on|off] [max <nn>] [file <name>] [status]\n"
2515 " [buffer-trace <input-node-name> <nn>]",
2516 .function = dispatch_trace_command_fn,
2521 * fd.io coding-style-patch-verification: ON
2524 * eval: (c-set-style "gnu")