2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * main.c: main vector processing loop
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
41 #include <vppinfra/format.h>
42 #include <vlib/vlib.h>
43 #include <vlib/threads.h>
44 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
46 #include <vlib/unix/unix.h>
48 /* Actually allocate a few extra slots of vector data to support
49 speculative vector enqueues which overflow vector data in next frame. */
50 #define VLIB_FRAME_SIZE_ALLOC (VLIB_FRAME_SIZE + 4)
53 vlib_frame_bytes (u32 n_scalar_bytes, u32 n_vector_bytes)
57 /* Make room for vlib_frame_t plus scalar arguments. */
58 n_bytes = vlib_frame_vector_byte_offset (n_scalar_bytes);
60 /* Make room for vector arguments.
61 Allocate a few extra slots of vector data to support
62 speculative vector enqueues which overflow vector data in next frame. */
63 #define VLIB_FRAME_SIZE_EXTRA 4
64 n_bytes += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * n_vector_bytes;
66 /* Magic number is first 32bit number after vector data.
67 Used to make sure that vector data is never overrun. */
68 #define VLIB_FRAME_MAGIC (0xabadc0ed)
69 n_bytes += sizeof (u32);
71 /* Pad to cache line. */
72 n_bytes = round_pow2 (n_bytes, CLIB_CACHE_LINE_BYTES);
78 vlib_frame_find_magic (vlib_frame_t * f, vlib_node_t * node)
82 p += vlib_frame_vector_byte_offset (node->scalar_size);
84 p += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * node->vector_size;
89 static inline vlib_frame_size_t *
90 get_frame_size_info (vlib_node_main_t * nm,
91 u32 n_scalar_bytes, u32 n_vector_bytes)
93 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
94 uword key = (n_scalar_bytes << 16) | n_vector_bytes;
97 p = hash_get (nm->frame_size_hash, key);
102 i = vec_len (nm->frame_sizes);
103 vec_validate (nm->frame_sizes, i);
104 hash_set (nm->frame_size_hash, key, i);
107 return vec_elt_at_index (nm->frame_sizes, i);
109 ASSERT (vlib_frame_bytes (n_scalar_bytes, n_vector_bytes)
110 == (vlib_frame_bytes (0, 4)));
111 return vec_elt_at_index (nm->frame_sizes, 0);
115 static vlib_frame_t *
116 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
119 vlib_node_main_t *nm = &vm->node_main;
120 vlib_frame_size_t *fs;
121 vlib_node_t *to_node;
123 u32 l, n, scalar_size, vector_size;
125 ASSERT (vm == vlib_get_main ());
127 to_node = vlib_get_node (vm, to_node_index);
129 scalar_size = to_node->scalar_size;
130 vector_size = to_node->vector_size;
132 fs = get_frame_size_info (nm, scalar_size, vector_size);
133 n = vlib_frame_bytes (scalar_size, vector_size);
134 if ((l = vec_len (fs->free_frames)) > 0)
136 /* Allocate from end of free list. */
137 f = fs->free_frames[l - 1];
138 _vec_len (fs->free_frames) = l - 1;
142 f = clib_mem_alloc_aligned_no_fail (n, VLIB_FRAME_ALIGN);
145 /* Poison frame when debugging. */
147 clib_memset (f, 0xfe, n);
149 /* Insert magic number. */
153 magic = vlib_frame_find_magic (f, to_node);
154 *magic = VLIB_FRAME_MAGIC;
157 f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
159 f->scalar_size = scalar_size;
160 f->vector_size = vector_size;
163 fs->n_alloc_frames += 1;
168 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
169 Returns frame index. */
170 static vlib_frame_t *
171 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
174 vlib_node_t *from_node;
176 from_node = vlib_get_node (vm, from_node_runtime->node_index);
177 ASSERT (to_next_index < vec_len (from_node->next_nodes));
179 return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
180 /* frame_flags */ 0);
184 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
186 vlib_frame_t *f = vlib_frame_alloc_to_node (vm, to_node_index,
188 VLIB_FRAME_FREE_AFTER_DISPATCH);
189 return vlib_get_frame (vm, f);
193 vlib_validate_frame_indices (vlib_frame_t * f)
198 u32 *from = vlib_frame_vector_args (f);
200 /* Check for bad buffer index values */
201 for (i = 0; i < f->n_vectors; i++)
205 clib_warning ("BUG: buffer index 0 at index %d", i);
208 else if (from[i] == 0xfefefefe)
210 clib_warning ("BUG: frame poison pattern at index %d", i);
218 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
220 vlib_pending_frame_t *p;
221 vlib_node_t *to_node;
223 if (f->n_vectors == 0)
226 ASSERT (vm == vlib_get_main ());
228 vlib_validate_frame_indices (f);
230 to_node = vlib_get_node (vm, to_node_index);
232 vec_add2 (vm->node_main.pending_frames, p, 1);
234 f->frame_flags |= VLIB_FRAME_PENDING;
235 p->frame = vlib_get_frame (vm, f);
236 p->node_runtime_index = to_node->runtime_index;
237 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
240 /* Free given frame. */
242 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
244 vlib_node_main_t *nm = &vm->node_main;
246 vlib_frame_size_t *fs;
248 ASSERT (vm == vlib_get_main ());
249 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
251 node = vlib_get_node (vm, r->node_index);
252 fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
254 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
256 /* No next frames may point to freed frame. */
259 vlib_next_frame_t *nf;
260 vec_foreach (nf, vm->node_main.next_frames) ASSERT (nf->frame != f);
263 f->frame_flags &= ~(VLIB_FRAME_IS_ALLOCATED | VLIB_FRAME_NO_APPEND);
265 vec_add1 (fs->free_frames, f);
266 ASSERT (fs->n_alloc_frames > 0);
267 fs->n_alloc_frames -= 1;
270 static clib_error_t *
271 show_frame_stats (vlib_main_t * vm,
272 unformat_input_t * input, vlib_cli_command_t * cmd)
274 vlib_node_main_t *nm = &vm->node_main;
275 vlib_frame_size_t *fs;
277 vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
278 vec_foreach (fs, nm->frame_sizes)
280 u32 n_alloc = fs->n_alloc_frames;
281 u32 n_free = vec_len (fs->free_frames);
283 if (n_alloc + n_free > 0)
284 vlib_cli_output (vm, "%=6d%=12d%=12d",
285 fs - nm->frame_sizes, n_alloc, n_free);
292 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
293 .path = "show vlib frame-allocation",
294 .short_help = "Show node dispatch frame statistics",
295 .function = show_frame_stats,
299 /* Change ownership of enqueue rights to given next node. */
301 vlib_next_frame_change_ownership (vlib_main_t * vm,
302 vlib_node_runtime_t * node_runtime,
305 vlib_node_main_t *nm = &vm->node_main;
306 vlib_next_frame_t *next_frame;
307 vlib_node_t *node, *next_node;
309 node = vec_elt (nm->nodes, node_runtime->node_index);
311 /* Only internal & input nodes are allowed to call other nodes. */
312 ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
313 || node->type == VLIB_NODE_TYPE_INPUT
314 || node->type == VLIB_NODE_TYPE_PROCESS);
316 ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
319 vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
320 next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
322 if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
324 /* Get frame from previous owner. */
325 vlib_next_frame_t *owner_next_frame;
326 vlib_next_frame_t tmp;
329 vlib_node_get_next_frame (vm,
330 next_node->owner_node_index,
331 next_node->owner_next_index);
333 /* Swap target next frame with owner's. */
334 tmp = owner_next_frame[0];
335 owner_next_frame[0] = next_frame[0];
339 * If next_frame is already pending, we have to track down
340 * all pending frames and fix their next_frame_index fields.
342 if (next_frame->flags & VLIB_FRAME_PENDING)
344 vlib_pending_frame_t *p;
345 if (next_frame->frame != NULL)
347 vec_foreach (p, nm->pending_frames)
349 if (p->frame == next_frame->frame)
351 p->next_frame_index =
352 next_frame - vm->node_main.next_frames;
360 /* No previous owner. Take ownership. */
361 next_frame->flags |= VLIB_FRAME_OWNER;
364 /* Record new owner. */
365 next_node->owner_node_index = node->index;
366 next_node->owner_next_index = next_index;
368 /* Now we should be owner. */
369 ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
372 /* Make sure that magic number is still there.
373 Otherwise, it is likely that caller has overrun frame arguments. */
375 validate_frame_magic (vlib_main_t * vm,
376 vlib_frame_t * f, vlib_node_t * n, uword next_index)
378 vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
379 u32 *magic = vlib_frame_find_magic (f, next_node);
380 ASSERT (VLIB_FRAME_MAGIC == magic[0]);
384 vlib_get_next_frame_internal (vlib_main_t * vm,
385 vlib_node_runtime_t * node,
386 u32 next_index, u32 allocate_new_next_frame)
389 vlib_next_frame_t *nf;
392 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
394 /* Make sure this next frame owns right to enqueue to destination frame. */
395 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
396 vlib_next_frame_change_ownership (vm, node, next_index);
398 /* ??? Don't need valid flag: can use frame_index == ~0 */
399 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
401 nf->frame = vlib_frame_alloc (vm, node, next_index);
402 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
407 /* Has frame been removed from pending vector (e.g. finished dispatching)?
408 If so we can reuse frame. */
409 if ((nf->flags & VLIB_FRAME_PENDING)
410 && !(f->frame_flags & VLIB_FRAME_PENDING))
412 nf->flags &= ~VLIB_FRAME_PENDING;
417 /* Allocate new frame if current one is marked as no-append or
418 it is already full. */
419 n_used = f->n_vectors;
420 if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0) ||
421 (f->frame_flags & VLIB_FRAME_NO_APPEND))
423 /* Old frame may need to be freed after dispatch, since we'll have
424 two redundant frames from node -> next node. */
425 if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
427 vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame);
428 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
431 /* Allocate new frame to replace full one. */
432 f = nf->frame = vlib_frame_alloc (vm, node, next_index);
433 n_used = f->n_vectors;
436 /* Should have free vectors in frame now. */
437 ASSERT (n_used < VLIB_FRAME_SIZE);
441 validate_frame_magic (vm, f,
442 vlib_get_node (vm, node->node_index), next_index);
449 vlib_put_next_frame_validate (vlib_main_t * vm,
450 vlib_node_runtime_t * rt,
451 u32 next_index, u32 n_vectors_left)
453 vlib_node_main_t *nm = &vm->node_main;
454 vlib_next_frame_t *nf;
456 vlib_node_runtime_t *next_rt;
457 vlib_node_t *next_node;
458 u32 n_before, n_after;
460 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
461 f = vlib_get_frame (vm, nf->frame);
463 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
465 vlib_validate_frame_indices (f);
467 n_after = VLIB_FRAME_SIZE - n_vectors_left;
468 n_before = f->n_vectors;
470 ASSERT (n_after >= n_before);
472 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
473 nf->node_runtime_index);
474 next_node = vlib_get_node (vm, next_rt->node_index);
475 if (n_after > 0 && next_node->validate_frame)
477 u8 *msg = next_node->validate_frame (vm, rt, f);
480 clib_warning ("%v", msg);
488 vlib_put_next_frame (vlib_main_t * vm,
489 vlib_node_runtime_t * r,
490 u32 next_index, u32 n_vectors_left)
492 vlib_node_main_t *nm = &vm->node_main;
493 vlib_next_frame_t *nf;
495 u32 n_vectors_in_frame;
498 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
500 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
501 f = vlib_get_frame (vm, nf->frame);
503 /* Make sure that magic number is still there. Otherwise, caller
504 has overrun frame meta data. */
507 vlib_node_t *node = vlib_get_node (vm, r->node_index);
508 validate_frame_magic (vm, f, node, next_index);
511 /* Convert # of vectors left -> number of vectors there. */
512 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
513 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
515 f->n_vectors = n_vectors_in_frame;
517 /* If vectors were added to frame, add to pending vector. */
518 if (PREDICT_TRUE (n_vectors_in_frame > 0))
520 vlib_pending_frame_t *p;
523 r->cached_next_index = next_index;
525 if (!(f->frame_flags & VLIB_FRAME_PENDING))
527 __attribute__ ((unused)) vlib_node_t *node;
528 vlib_node_t *next_node;
529 vlib_node_runtime_t *next_runtime;
531 node = vlib_get_node (vm, r->node_index);
532 next_node = vlib_get_next_node (vm, r->node_index, next_index);
533 next_runtime = vlib_node_get_runtime (vm, next_node->index);
535 vec_add2 (nm->pending_frames, p, 1);
537 p->frame = nf->frame;
538 p->node_runtime_index = nf->node_runtime_index;
539 p->next_frame_index = nf - nm->next_frames;
540 nf->flags |= VLIB_FRAME_PENDING;
541 f->frame_flags |= VLIB_FRAME_PENDING;
544 * If we're going to dispatch this frame on another thread,
545 * force allocation of a new frame. Otherwise, we create
546 * a dangling frame reference. Each thread has its own copy of
547 * the next_frames vector.
549 if (0 && r->thread_index != next_runtime->thread_index)
552 nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
556 /* Copy trace flag from next_frame and from runtime. */
558 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
559 flags & VLIB_NODE_FLAG_TRACE);
561 v0 = nf->vectors_since_last_overflow;
562 v1 = v0 + n_vectors_in_frame;
563 nf->vectors_since_last_overflow = v1;
564 if (PREDICT_FALSE (v1 < v0))
566 vlib_node_t *node = vlib_get_node (vm, r->node_index);
567 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
572 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
574 vlib_node_runtime_sync_stats (vlib_main_t * vm,
575 vlib_node_runtime_t * r,
576 uword n_calls, uword n_vectors, uword n_clocks)
578 vlib_node_t *n = vlib_get_node (vm, r->node_index);
580 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
581 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
582 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
583 n->stats_total.max_clock = r->max_clock;
584 n->stats_total.max_clock_n = r->max_clock_n;
586 r->calls_since_last_overflow = 0;
587 r->vectors_since_last_overflow = 0;
588 r->clocks_since_last_overflow = 0;
591 always_inline void __attribute__ ((unused))
592 vlib_process_sync_stats (vlib_main_t * vm,
594 uword n_calls, uword n_vectors, uword n_clocks)
596 vlib_node_runtime_t *rt = &p->node_runtime;
597 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
598 vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks);
599 n->stats_total.suspends += p->n_suspends;
604 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
606 vlib_node_runtime_t *rt;
608 if (n->type == VLIB_NODE_TYPE_PROCESS)
610 /* Nothing to do for PROCESS nodes except in main thread */
611 if (vm != &vlib_global_main)
614 vlib_process_t *p = vlib_get_process_from_node (vm, n);
615 n->stats_total.suspends += p->n_suspends;
617 rt = &p->node_runtime;
621 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
624 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0);
626 /* Sync up runtime next frame vector counters with main node structure. */
628 vlib_next_frame_t *nf;
630 for (i = 0; i < rt->n_next_nodes; i++)
632 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
633 vec_elt (n->n_vectors_by_next_node, i) +=
634 nf->vectors_since_last_overflow;
635 nf->vectors_since_last_overflow = 0;
641 vlib_node_runtime_update_stats (vlib_main_t * vm,
642 vlib_node_runtime_t * node,
644 uword n_vectors, uword n_clocks)
646 u32 ca0, ca1, v0, v1, cl0, cl1, r;
648 cl0 = cl1 = node->clocks_since_last_overflow;
649 ca0 = ca1 = node->calls_since_last_overflow;
650 v0 = v1 = node->vectors_since_last_overflow;
654 cl1 = cl0 + n_clocks;
656 node->calls_since_last_overflow = ca1;
657 node->clocks_since_last_overflow = cl1;
658 node->vectors_since_last_overflow = v1;
660 node->max_clock_n = node->max_clock > n_clocks ?
661 node->max_clock_n : n_vectors;
662 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
664 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
666 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0))
668 node->calls_since_last_overflow = ca0;
669 node->clocks_since_last_overflow = cl0;
670 node->vectors_since_last_overflow = v0;
672 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks);
679 vlib_process_update_stats (vlib_main_t * vm,
681 uword n_calls, uword n_vectors, uword n_clocks)
683 vlib_node_runtime_update_stats (vm, &p->node_runtime,
684 n_calls, n_vectors, n_clocks);
687 static clib_error_t *
688 vlib_cli_elog_clear (vlib_main_t * vm,
689 unformat_input_t * input, vlib_cli_command_t * cmd)
691 elog_reset_buffer (&vm->elog_main);
696 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
697 .path = "event-logger clear",
698 .short_help = "Clear the event log",
699 .function = vlib_cli_elog_clear,
704 static clib_error_t *
705 elog_save_buffer (vlib_main_t * vm,
706 unformat_input_t * input, vlib_cli_command_t * cmd)
708 elog_main_t *em = &vm->elog_main;
709 char *file, *chroot_file;
710 clib_error_t *error = 0;
712 if (!unformat (input, "%s", &file))
714 vlib_cli_output (vm, "expected file name, got `%U'",
715 format_unformat_error, input);
719 /* It's fairly hard to get "../oopsie" through unformat; just in case */
720 if (strstr (file, "..") || index (file, '/'))
722 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
726 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
730 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
731 elog_n_events_in_buffer (em),
732 elog_buffer_capacity (em), chroot_file);
734 vlib_worker_thread_barrier_sync (vm);
735 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
736 vlib_worker_thread_barrier_release (vm);
737 vec_free (chroot_file);
742 vlib_post_mortem_dump (void)
744 vlib_main_t *vm = &vlib_global_main;
745 elog_main_t *em = &vm->elog_main;
750 if ((vm->elog_post_mortem_dump + vm->dispatch_pcap_postmortem) == 0)
753 if (vm->dispatch_pcap_postmortem)
756 pcap_main_t *pm = &vm->dispatch_pcap_main;
758 pm->n_packets_to_capture = pm->n_packets_captured;
759 pm->file_name = (char *) format (0, "/tmp/dispatch_post_mortem.%d%c",
761 error = pcap_write (pm);
764 clib_error_report (error);
766 * We're in the middle of crashing. Don't try to free the filename.
770 if (vm->elog_post_mortem_dump)
772 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
773 error = elog_write_file (em, (char *) filename, 1 /* flush ring */ );
775 clib_error_report (error);
777 * We're in the middle of crashing. Don't try to free the filename.
783 VLIB_CLI_COMMAND (elog_save_cli, static) = {
784 .path = "event-logger save",
785 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
786 .function = elog_save_buffer,
790 static clib_error_t *
791 elog_stop (vlib_main_t * vm,
792 unformat_input_t * input, vlib_cli_command_t * cmd)
794 elog_main_t *em = &vm->elog_main;
796 em->n_total_events_disable_limit = em->n_total_events;
798 vlib_cli_output (vm, "Stopped the event logger...");
803 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
804 .path = "event-logger stop",
805 .short_help = "Stop the event-logger",
806 .function = elog_stop,
810 static clib_error_t *
811 elog_restart (vlib_main_t * vm,
812 unformat_input_t * input, vlib_cli_command_t * cmd)
814 elog_main_t *em = &vm->elog_main;
816 em->n_total_events_disable_limit = ~0;
818 vlib_cli_output (vm, "Restarted the event logger...");
823 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
824 .path = "event-logger restart",
825 .short_help = "Restart the event-logger",
826 .function = elog_restart,
830 static clib_error_t *
831 elog_resize_command_fn (vlib_main_t * vm,
832 unformat_input_t * input, vlib_cli_command_t * cmd)
834 elog_main_t *em = &vm->elog_main;
837 /* Stop the parade */
838 elog_reset_buffer (&vm->elog_main);
840 if (unformat (input, "%d", &tmp))
842 elog_alloc (em, tmp);
843 em->n_total_events_disable_limit = ~0;
846 return clib_error_return (0, "Must specify how many events in the ring");
848 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
853 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
854 .path = "event-logger resize",
855 .short_help = "event-logger resize <nnn>",
856 .function = elog_resize_command_fn,
860 #endif /* CLIB_UNIX */
863 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
865 elog_main_t *em = &vm->elog_main;
866 elog_event_t *e, *es;
869 /* Show events in VLIB time since log clock starts after VLIB clock. */
870 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
871 * vm->clib_time.seconds_per_clock;
873 es = elog_peek_events (em);
874 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
876 em->n_total_events < em->n_total_events_disable_limit ?
877 "running" : "stopped");
880 vlib_cli_output (vm, "%18.9f: %U",
881 e->time + dt, format_elog_event, em, e);
883 if (n_events_to_show == 0)
890 static clib_error_t *
891 elog_show_buffer (vlib_main_t * vm,
892 unformat_input_t * input, vlib_cli_command_t * cmd)
894 u32 n_events_to_show;
895 clib_error_t *error = 0;
897 n_events_to_show = 250;
898 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
900 if (unformat (input, "%d", &n_events_to_show))
902 else if (unformat (input, "all"))
903 n_events_to_show = ~0;
905 return unformat_parse_error (input);
907 elog_show_buffer_internal (vm, n_events_to_show);
912 VLIB_CLI_COMMAND (elog_show_cli, static) = {
913 .path = "show event-logger",
914 .short_help = "Show event logger info",
915 .function = elog_show_buffer,
920 vlib_gdb_show_event_log (void)
922 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
926 vlib_elog_main_loop_event (vlib_main_t * vm,
928 u64 time, u32 n_vectors, u32 is_return)
930 vlib_main_t *evm = &vlib_global_main;
931 elog_main_t *em = &evm->elog_main;
932 int enabled = evm->elog_trace_graph_dispatch |
933 evm->elog_trace_graph_circuit;
935 if (PREDICT_FALSE (enabled && n_vectors))
937 if (PREDICT_FALSE (!elog_is_enabled (em)))
939 evm->elog_trace_graph_dispatch = 0;
940 evm->elog_trace_graph_circuit = 0;
944 (evm->elog_trace_graph_dispatch ||
945 (evm->elog_trace_graph_circuit &&
946 node_index == evm->elog_trace_graph_circuit_node_index)))
950 vec_elt_at_index (is_return
951 ? evm->node_return_elog_event_types
952 : evm->node_call_elog_event_types,
956 &vlib_worker_threads[vm->thread_index].elog_track
957 : &em->default_track),
958 /* data to log */ n_vectors);
963 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
964 void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 node_index);
965 void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
968 vlib_buffer_trace_trajectory_init (vlib_buffer_t * b)
970 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_init_cb != 0))
972 (*vlib_buffer_trace_trajectory_init_cb) (b);
979 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
981 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
982 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_cb != 0))
984 (*vlib_buffer_trace_trajectory_cb) (b, node_index);
989 u8 *format_vnet_buffer_flags (u8 * s, va_list * args) __attribute__ ((weak));
991 format_vnet_buffer_flags (u8 * s, va_list * args)
993 s = format (s, "BUG STUB %s", __FUNCTION__);
997 u8 *format_vnet_buffer_opaque (u8 * s, va_list * args) __attribute__ ((weak));
999 format_vnet_buffer_opaque (u8 * s, va_list * args)
1001 s = format (s, "BUG STUB %s", __FUNCTION__);
1005 u8 *format_vnet_buffer_opaque2 (u8 * s, va_list * args)
1006 __attribute__ ((weak));
1008 format_vnet_buffer_opaque2 (u8 * s, va_list * args)
1010 s = format (s, "BUG STUB %s", __FUNCTION__);
1015 format_buffer_metadata (u8 * s, va_list * args)
1017 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
1019 s = format (s, "flags: %U\n", format_vnet_buffer_flags, b);
1020 s = format (s, "current_data: %d, current_length: %d\n",
1021 (i32) (b->current_data), (i32) (b->current_length));
1024 "current_config_index/punt_reason: %d, flow_id: %x, next_buffer: %x\n",
1025 b->current_config_index, b->flow_id, b->next_buffer);
1027 format (s, "error: %d, ref_count: %d, buffer_pool_index: %d\n",
1028 (u32) (b->error), (u32) (b->ref_count),
1029 (u32) (b->buffer_pool_index));
1031 format (s, "trace_handle: 0x%x, len_not_first_buf: %d\n", b->trace_handle,
1032 b->total_length_not_including_first_buffer);
1036 #define A(x) vec_add1(vm->pcap_buffer, (x))
1039 dispatch_pcap_trace (vlib_main_t * vm,
1040 vlib_node_runtime_t * node, vlib_frame_t * frame)
1043 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **bufp, *b;
1044 pcap_main_t *pm = &vlib_global_main.dispatch_pcap_main;
1045 vlib_trace_main_t *tm = &vm->trace_main;
1049 f64 time_now = vlib_time_now (vm);
1054 /* Input nodes don't have frames yet */
1055 if (frame == 0 || frame->n_vectors == 0)
1058 from = vlib_frame_vector_args (frame);
1059 vlib_get_buffers (vm, from, bufs, frame->n_vectors);
1062 n = vlib_get_node (vm, node->node_index);
1064 for (i = 0; i < frame->n_vectors; i++)
1066 if (PREDICT_TRUE (pm->n_packets_captured < pm->n_packets_to_capture))
1070 vec_reset_length (vm->pcap_buffer);
1073 /* Version, flags */
1074 A ((u8) VLIB_PCAP_MAJOR_VERSION);
1075 A ((u8) VLIB_PCAP_MINOR_VERSION);
1076 A (0 /* string_count */ );
1077 A (n->protocol_hint);
1079 /* Buffer index (big endian) */
1080 A ((from[i] >> 24) & 0xff);
1081 A ((from[i] >> 16) & 0xff);
1082 A ((from[i] >> 8) & 0xff);
1083 A ((from[i] >> 0) & 0xff);
1085 /* Node name, NULL-terminated ASCII */
1086 vm->pcap_buffer = format (vm->pcap_buffer, "%v%c", n->name, 0);
1089 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1090 format_buffer_metadata, b, 0);
1092 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1093 format_vnet_buffer_opaque, b, 0);
1095 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1096 format_vnet_buffer_opaque2, b, 0);
1099 /* Is this packet traced? */
1100 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1102 vlib_trace_header_t **h
1103 = pool_elt_at_index (tm->trace_buffer_pool,
1104 vlib_buffer_get_trace_index (b));
1106 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1107 format_vlib_trace, vm, h[0], 0);
1111 /* Save the string count */
1112 vm->pcap_buffer[2] = string_count;
1114 /* Figure out how many bytes in the pcap trace */
1115 capture_size = vec_len (vm->pcap_buffer) +
1116 +vlib_buffer_length_in_chain (vm, b);
1118 clib_spinlock_lock_if_init (&pm->lock);
1119 n_left = clib_min (capture_size, 16384);
1120 d = pcap_add_packet (pm, time_now, n_left, capture_size);
1122 /* Copy the header */
1123 clib_memcpy_fast (d, vm->pcap_buffer, vec_len (vm->pcap_buffer));
1124 d += vec_len (vm->pcap_buffer);
1127 (vlib_buffer_length_in_chain (vm, b),
1128 (16384 - vec_len (vm->pcap_buffer)));
1129 /* Copy the packet data */
1132 u32 copy_length = clib_min ((u32) n_left, b->current_length);
1133 clib_memcpy_fast (d, b->data + b->current_data, copy_length);
1134 n_left -= b->current_length;
1137 d += b->current_length;
1138 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
1139 b = vlib_get_buffer (vm, b->next_buffer);
1141 clib_spinlock_unlock_if_init (&pm->lock);
1146 static_always_inline u64
1147 dispatch_node (vlib_main_t * vm,
1148 vlib_node_runtime_t * node,
1149 vlib_node_type_t type,
1150 vlib_node_state_t dispatch_state,
1151 vlib_frame_t * frame, u64 last_time_stamp)
1155 vlib_node_main_t *nm = &vm->node_main;
1156 vlib_next_frame_t *nf;
1160 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1161 ASSERT (n->type == type);
1164 /* Only non-internal nodes may be disabled. */
1165 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
1167 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
1168 return last_time_stamp;
1171 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
1172 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
1174 u32 c = node->input_main_loops_per_call;
1175 /* Only call node when count reaches zero. */
1178 node->input_main_loops_per_call = c - 1;
1179 return last_time_stamp;
1183 /* Speculatively prefetch next frames. */
1184 if (node->n_next_nodes > 0)
1186 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
1187 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
1190 vm->cpu_time_last_node_dispatch = last_time_stamp;
1192 vlib_elog_main_loop_event (vm, node->node_index,
1193 last_time_stamp, frame ? frame->n_vectors : 0,
1196 vlib_node_runtime_perf_counter (vm, node, frame, 0, last_time_stamp,
1197 VLIB_NODE_RUNTIME_PERF_BEFORE);
1200 * Turn this on if you run into
1201 * "bad monkey" contexts, and you want to know exactly
1202 * which nodes they've visited... See ixge.c...
1204 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
1208 from = vlib_frame_vector_args (frame);
1209 for (i = 0; i < frame->n_vectors; i++)
1211 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1212 add_trajectory_trace (b, node->node_index);
1214 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1215 dispatch_pcap_trace (vm, node, frame);
1217 if (PREDICT_TRUE (vm->dispatch_wrapper_fn == 0))
1218 n = node->function (vm, node, frame);
1220 n = vm->dispatch_wrapper_fn (vm, node, frame);
1224 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1225 dispatch_pcap_trace (vm, node, frame);
1227 if (PREDICT_TRUE (vm->dispatch_wrapper_fn == 0))
1228 n = node->function (vm, node, frame);
1230 n = vm->dispatch_wrapper_fn (vm, node, frame);
1233 t = clib_cpu_time_now ();
1235 vlib_node_runtime_perf_counter (vm, node, frame, n, t,
1236 VLIB_NODE_RUNTIME_PERF_AFTER);
1238 vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
1240 vm->main_loop_vectors_processed += n;
1241 vm->main_loop_nodes_processed += n > 0;
1243 v = vlib_node_runtime_update_stats (vm, node,
1246 /* n_clocks */ t - last_time_stamp);
1248 /* When in interrupt mode and vector rate crosses threshold switch to
1250 if (PREDICT_FALSE ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1251 || (dispatch_state == VLIB_NODE_STATE_POLLING
1254 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))))
1257 ELOG_TYPE_DECLARE (e) =
1259 .function = (char *) __FUNCTION__,
1260 .format = "%s vector length %d, switching to %s",
1261 .format_args = "T4i4t4",
1262 .n_enum_strings = 2,
1264 "interrupt", "polling",
1270 u32 node_name, vector_length, is_polling;
1273 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1274 && v >= nm->polling_threshold_vector_length) &&
1276 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1278 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1279 n->state = VLIB_NODE_STATE_POLLING;
1280 node->state = VLIB_NODE_STATE_POLLING;
1282 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1283 node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1284 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1285 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1287 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1289 vlib_worker_thread_t *w = vlib_worker_threads
1292 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1294 ed->node_name = n->name_elog_string;
1295 ed->vector_length = v;
1299 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1300 && v <= nm->interrupt_threshold_vector_length)
1302 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1304 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1306 /* Switch to interrupt mode after dispatch in polling one more time.
1307 This allows driver to re-enable interrupts. */
1308 n->state = VLIB_NODE_STATE_INTERRUPT;
1309 node->state = VLIB_NODE_STATE_INTERRUPT;
1311 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1312 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1313 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
1318 vlib_worker_thread_t *w = vlib_worker_threads
1321 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1322 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
1324 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1326 ed->node_name = n->name_elog_string;
1327 ed->vector_length = v;
1338 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1339 u64 last_time_stamp)
1341 vlib_node_main_t *nm = &vm->node_main;
1343 vlib_next_frame_t *nf, nf_placeholder;
1344 vlib_node_runtime_t *n;
1345 vlib_frame_t *restore_frame;
1346 vlib_pending_frame_t *p;
1348 /* See comment below about dangling references to nm->pending_frames */
1349 p = nm->pending_frames + pending_frame_index;
1351 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1352 p->node_runtime_index);
1354 f = vlib_get_frame (vm, p->frame);
1355 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1357 /* No next frame: so use placeholder on stack. */
1358 nf = &nf_placeholder;
1359 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1363 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1365 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1367 /* Force allocation of new frame while current frame is being
1369 restore_frame = NULL;
1370 if (nf->frame == p->frame)
1373 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1374 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1375 restore_frame = p->frame;
1378 /* Frame must be pending. */
1379 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1380 ASSERT (f->n_vectors > 0);
1382 /* Copy trace flag from next frame to node.
1383 Trace flag indicates that at least one vector in the dispatched
1385 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1386 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1387 nf->flags &= ~VLIB_FRAME_TRACE;
1389 last_time_stamp = dispatch_node (vm, n,
1390 VLIB_NODE_TYPE_INTERNAL,
1391 VLIB_NODE_STATE_POLLING,
1392 f, last_time_stamp);
1393 /* Internal node vector-rate accounting, for summary stats */
1394 vm->internal_node_vectors += f->n_vectors;
1395 vm->internal_node_calls++;
1396 vm->internal_node_last_vectors_per_main_loop =
1397 (f->n_vectors > vm->internal_node_last_vectors_per_main_loop) ?
1398 f->n_vectors : vm->internal_node_last_vectors_per_main_loop;
1400 f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
1402 /* Frame is ready to be used again, so restore it. */
1403 if (restore_frame != NULL)
1406 * We musn't restore a frame that is flagged to be freed. This
1407 * shouldn't happen since frames to be freed post dispatch are
1408 * those used when the to-node frame becomes full i.e. they form a
1409 * sort of queue of frames to a single node. If we get here then
1410 * the to-node frame and the pending frame *were* the same, and so
1411 * we removed the to-node frame. Therefore this frame is no
1412 * longer part of the queue for that node and hence it cannot be
1415 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1418 * NB: dispatching node n can result in the creation and scheduling
1419 * of new frames, and hence in the reallocation of nm->pending_frames.
1420 * Recompute p, or no supper. This was broken for more than 10 years.
1422 p = nm->pending_frames + pending_frame_index;
1425 * p->next_frame_index can change during node dispatch if node
1426 * function decides to change graph hook up.
1428 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1429 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1431 if (NULL == nf->frame)
1433 /* no new frame has been assigned to this node, use the saved one */
1434 nf->frame = restore_frame;
1439 /* The node has gained a frame, implying packets from the current frame
1440 were re-queued to this same node. we don't need the saved one
1442 vlib_frame_free (vm, n, f);
1447 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1449 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1450 vlib_frame_free (vm, n, f);
1454 return last_time_stamp;
1458 vlib_process_stack_is_valid (vlib_process_t * p)
1460 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1466 vlib_process_t *process;
1467 vlib_frame_t *frame;
1468 } vlib_process_bootstrap_args_t;
1470 /* Called in process stack. */
1472 vlib_process_bootstrap (uword _a)
1474 vlib_process_bootstrap_args_t *a;
1476 vlib_node_runtime_t *node;
1481 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1485 vlib_process_finish_switch_stack (vm);
1488 node = &p->node_runtime;
1490 n = node->function (vm, node, f);
1492 ASSERT (vlib_process_stack_is_valid (p));
1494 vlib_process_start_switch_stack (vm, 0);
1495 clib_longjmp (&p->return_longjmp, n);
1500 /* Called in main stack. */
1501 static_always_inline uword
1502 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1504 vlib_process_bootstrap_args_t a;
1511 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1512 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1514 vlib_process_start_switch_stack (vm, p);
1515 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1516 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1519 vlib_process_finish_switch_stack (vm);
1524 static_always_inline uword
1525 vlib_process_resume (vlib_main_t * vm, vlib_process_t * p)
1528 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1529 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1530 | VLIB_PROCESS_RESUME_PENDING);
1531 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1532 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1534 vlib_process_start_switch_stack (vm, p);
1535 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1538 vlib_process_finish_switch_stack (vm);
1543 dispatch_process (vlib_main_t * vm,
1544 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1546 vlib_node_main_t *nm = &vm->node_main;
1547 vlib_node_runtime_t *node_runtime = &p->node_runtime;
1548 vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1549 u32 old_process_index;
1551 uword n_vectors, is_suspend;
1553 if (node->state != VLIB_NODE_STATE_POLLING
1554 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1555 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1556 return last_time_stamp;
1558 p->flags |= VLIB_PROCESS_IS_RUNNING;
1560 t = last_time_stamp;
1561 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1562 f ? f->n_vectors : 0, /* is_after */ 0);
1564 /* Save away current process for suspend. */
1565 old_process_index = nm->current_process_index;
1566 nm->current_process_index = node->runtime_index;
1568 vlib_node_runtime_perf_counter (vm, node_runtime, f, 0, last_time_stamp,
1569 VLIB_NODE_RUNTIME_PERF_BEFORE);
1571 n_vectors = vlib_process_startup (vm, p, f);
1573 nm->current_process_index = old_process_index;
1575 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1576 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1579 vlib_pending_frame_t *pf;
1582 pool_get (nm->suspended_process_frames, pf);
1583 pf->node_runtime_index = node->runtime_index;
1585 pf->next_frame_index = ~0;
1588 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1590 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1592 TWT (tw_timer_wheel) * tw =
1593 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1594 p->stop_timer_handle =
1595 TW (tw_timer_start) (tw,
1596 vlib_timing_wheel_data_set_suspended_process
1597 (node->runtime_index) /* [sic] pool idex */ ,
1599 p->resume_clock_interval);
1603 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1605 t = clib_cpu_time_now ();
1607 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1610 vlib_node_runtime_perf_counter (vm, node_runtime, f, n_vectors, t,
1611 VLIB_NODE_RUNTIME_PERF_AFTER);
1613 vlib_process_update_stats (vm, p,
1614 /* n_calls */ !is_suspend,
1615 /* n_vectors */ n_vectors,
1616 /* n_clocks */ t - last_time_stamp);
1622 vlib_start_process (vlib_main_t * vm, uword process_index)
1624 vlib_node_main_t *nm = &vm->node_main;
1625 vlib_process_t *p = vec_elt (nm->processes, process_index);
1626 dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1630 dispatch_suspended_process (vlib_main_t * vm,
1631 uword process_index, u64 last_time_stamp)
1633 vlib_node_main_t *nm = &vm->node_main;
1634 vlib_node_runtime_t *node_runtime;
1638 vlib_pending_frame_t *pf;
1639 u64 t, n_vectors, is_suspend;
1641 t = last_time_stamp;
1643 p = vec_elt (nm->processes, process_index);
1644 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1645 return last_time_stamp;
1647 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1648 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1650 pf = pool_elt_at_index (nm->suspended_process_frames,
1651 p->suspended_process_frame_index);
1653 node_runtime = &p->node_runtime;
1654 node = vlib_get_node (vm, node_runtime->node_index);
1657 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1658 f ? f->n_vectors : 0, /* is_after */ 0);
1660 /* Save away current process for suspend. */
1661 nm->current_process_index = node->runtime_index;
1663 vlib_node_runtime_perf_counter (vm, node_runtime, f, 0, last_time_stamp,
1664 VLIB_NODE_RUNTIME_PERF_BEFORE);
1666 n_vectors = vlib_process_resume (vm, p);
1667 t = clib_cpu_time_now ();
1669 nm->current_process_index = ~0;
1671 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1674 /* Suspend it again. */
1677 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1679 p->stop_timer_handle =
1680 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1681 vlib_timing_wheel_data_set_suspended_process
1682 (node->runtime_index) /* [sic] pool idex */ ,
1684 p->resume_clock_interval);
1689 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1690 pool_put_index (nm->suspended_process_frames,
1691 p->suspended_process_frame_index);
1692 p->suspended_process_frame_index = ~0;
1695 t = clib_cpu_time_now ();
1696 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1699 vlib_node_runtime_perf_counter (vm, node_runtime, f, n_vectors, t,
1700 VLIB_NODE_RUNTIME_PERF_AFTER);
1702 vlib_process_update_stats (vm, p,
1703 /* n_calls */ !is_suspend,
1704 /* n_vectors */ n_vectors,
1705 /* n_clocks */ t - last_time_stamp);
1710 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1712 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1717 pcap_postmortem_reset (vlib_main_t * vm)
1719 pcap_main_t *pm = &vm->dispatch_pcap_main;
1721 /* Reset the trace buffer and capture count */
1722 clib_spinlock_lock_if_init (&pm->lock);
1723 vec_reset_length (pm->pcap_data);
1724 pm->n_packets_captured = 0;
1725 clib_spinlock_unlock_if_init (&pm->lock);
1729 static_always_inline void
1730 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1732 vlib_node_main_t *nm = &vm->node_main;
1733 vlib_thread_main_t *tm = vlib_get_thread_main ();
1737 vlib_frame_queue_main_t *fqm;
1738 u32 frame_queue_check_counter = 0;
1740 /* Initialize pending node vector. */
1743 vec_resize (nm->pending_frames, 32);
1744 _vec_len (nm->pending_frames) = 0;
1747 /* Mark time of main loop start. */
1750 cpu_time_now = vm->clib_time.last_cpu_time;
1751 vm->cpu_time_main_loop_start = cpu_time_now;
1754 cpu_time_now = clib_cpu_time_now ();
1756 /* Pre-allocate interupt runtime indices and lock. */
1757 vec_alloc_aligned (nm->pending_interrupts, 1, CLIB_CACHE_LINE_BYTES);
1759 /* Pre-allocate expired nodes. */
1760 if (!nm->polling_threshold_vector_length)
1761 nm->polling_threshold_vector_length = 10;
1762 if (!nm->interrupt_threshold_vector_length)
1763 nm->interrupt_threshold_vector_length = 5;
1765 vm->cpu_id = clib_get_current_cpu_id ();
1766 vm->numa_node = clib_get_current_numa_node ();
1767 os_set_numa_index (vm->numa_node);
1769 /* Start all processes. */
1775 * Perform an initial barrier sync. Pays no attention to
1776 * the barrier sync hold-down timer scheme, which won't work
1777 * at this point in time.
1779 vlib_worker_thread_initial_barrier_sync_and_release (vm);
1781 nm->current_process_index = ~0;
1782 for (i = 0; i < vec_len (nm->processes); i++)
1783 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1789 vlib_node_runtime_t *n;
1791 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1794 vl_api_send_pending_rpc_requests (vm);
1798 vlib_worker_thread_barrier_check ();
1800 if (PREDICT_FALSE (vm->check_frame_queues + frame_queue_check_counter))
1804 if (vm->check_frame_queues)
1806 frame_queue_check_counter = 100;
1807 vm->check_frame_queues = 0;
1810 vec_foreach (fqm, tm->frame_queue_mains)
1811 processed += vlib_frame_queue_dequeue (vm, fqm);
1813 /* No handoff queue work found? */
1815 frame_queue_check_counter = 100;
1817 frame_queue_check_counter--;
1820 if (PREDICT_FALSE (vec_len (vm->worker_thread_main_loop_callbacks)))
1821 clib_call_callbacks (vm->worker_thread_main_loop_callbacks, vm,
1825 * When trying to understand aggravating, hard-to-reproduce
1826 * bugs: reset / restart the pcap dispatch trace once per
1827 * main thread dispatch cycle. All threads share the same
1828 * (spinlock-protected) dispatch trace buffer. It might take
1829 * a few tries to capture a good post-mortem trace of
1830 * a multi-thread issue. Best we can do without a big refactor job.
1832 if (is_main && PREDICT_FALSE (vm->dispatch_pcap_postmortem != 0))
1833 pcap_postmortem_reset (vm);
1835 /* Process pre-input nodes. */
1836 cpu_time_now = clib_cpu_time_now ();
1837 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1838 cpu_time_now = dispatch_node (vm, n,
1839 VLIB_NODE_TYPE_PRE_INPUT,
1840 VLIB_NODE_STATE_POLLING,
1844 /* Next process input nodes. */
1845 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1846 cpu_time_now = dispatch_node (vm, n,
1847 VLIB_NODE_TYPE_INPUT,
1848 VLIB_NODE_STATE_POLLING,
1852 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1853 vm->queue_signal_callback (vm);
1855 if (__atomic_load_n (nm->pending_interrupts, __ATOMIC_ACQUIRE))
1858 *nm->pending_interrupts = 0;
1861 clib_interrupt_get_next (nm->interrupts, int_num)) != -1)
1863 vlib_node_runtime_t *n;
1864 clib_interrupt_clear (nm->interrupts, int_num);
1865 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1867 cpu_time_now = dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1868 VLIB_NODE_STATE_INTERRUPT,
1869 /* frame */ 0, cpu_time_now);
1873 /* Input nodes may have added work to the pending vector.
1874 Process pending vector until there is nothing left.
1875 All pending vectors will be processed from input -> output. */
1876 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1877 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1878 /* Reset pending vector for next iteration. */
1879 _vec_len (nm->pending_frames) = 0;
1884 ELOG_TYPE_DECLARE (es) =
1886 .format = "process tw start",
1889 ELOG_TYPE_DECLARE (ee) =
1891 .format = "process tw end: %d",
1892 .format_args = "i4",
1901 /* Check if process nodes have expired from timing wheel. */
1902 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1904 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1905 ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1907 nm->data_from_advancing_timing_wheel =
1908 TW (tw_timer_expire_timers_vec)
1909 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1910 nm->data_from_advancing_timing_wheel);
1912 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1914 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1916 ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1918 _vec_len (nm->data_from_advancing_timing_wheel);
1922 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1926 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1929 u32 d = nm->data_from_advancing_timing_wheel[i];
1930 u32 di = vlib_timing_wheel_data_get_index (d);
1932 if (vlib_timing_wheel_data_is_timed_event (d))
1934 vlib_signal_timed_event_data_t *te =
1935 pool_elt_at_index (nm->signal_timed_event_data_pool,
1938 vlib_get_node (vm, te->process_node_index);
1940 vec_elt (nm->processes, n->runtime_index);
1943 vlib_process_signal_event_helper (nm, n, p,
1944 te->event_type_index,
1946 te->n_data_elt_bytes);
1947 if (te->n_data_bytes < sizeof (te->inline_event_data))
1948 clib_memcpy_fast (data, te->inline_event_data,
1952 clib_memcpy_fast (data, te->event_data_as_vector,
1954 vec_free (te->event_data_as_vector);
1956 pool_put (nm->signal_timed_event_data_pool, te);
1960 cpu_time_now = clib_cpu_time_now ();
1962 dispatch_suspended_process (vm, di, cpu_time_now);
1965 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1968 vlib_increment_main_loop_counter (vm);
1969 /* Record time stamp in case there are no enabled nodes and above
1970 calls do not update time stamp. */
1971 cpu_time_now = clib_cpu_time_now ();
1972 vm->loops_this_reporting_interval++;
1973 now = clib_time_now_internal (&vm->clib_time, cpu_time_now);
1974 /* Time to update loops_per_second? */
1975 if (PREDICT_FALSE (now >= vm->loop_interval_end))
1977 /* Next sample ends in 20ms */
1978 if (vm->loop_interval_start)
1980 f64 this_loops_per_second;
1982 this_loops_per_second =
1983 ((f64) vm->loops_this_reporting_interval) / (now -
1984 vm->loop_interval_start);
1986 vm->loops_per_second =
1987 vm->loops_per_second * vm->damping_constant +
1988 (1.0 - vm->damping_constant) * this_loops_per_second;
1989 if (vm->loops_per_second != 0.0)
1990 vm->seconds_per_loop = 1.0 / vm->loops_per_second;
1992 vm->seconds_per_loop = 0.0;
1994 /* New interval starts now, and ends in 20ms */
1995 vm->loop_interval_start = now;
1996 vm->loop_interval_end = now + 2e-4;
1997 vm->loops_this_reporting_interval = 0;
2003 vlib_main_loop (vlib_main_t * vm)
2005 vlib_main_or_worker_loop (vm, /* is_main */ 1);
2009 vlib_worker_loop (vlib_main_t * vm)
2011 vlib_main_or_worker_loop (vm, /* is_main */ 0);
2014 vlib_main_t vlib_global_main;
2016 static clib_error_t *
2017 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
2019 int turn_on_mem_trace = 0;
2021 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2023 if (unformat (input, "memory-trace"))
2024 turn_on_mem_trace = 1;
2026 else if (unformat (input, "elog-events %d",
2027 &vm->configured_elog_ring_size))
2028 vm->configured_elog_ring_size =
2029 1 << max_log2 (vm->configured_elog_ring_size);
2030 else if (unformat (input, "elog-post-mortem-dump"))
2031 vm->elog_post_mortem_dump = 1;
2032 else if (unformat (input, "buffer-alloc-success-rate %f",
2033 &vm->buffer_alloc_success_rate))
2035 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
2036 return clib_error_return
2037 (0, "Buffer fault injection not configured");
2039 else if (unformat (input, "buffer-alloc-success-seed %u",
2040 &vm->buffer_alloc_success_seed))
2042 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
2043 return clib_error_return
2044 (0, "Buffer fault injection not configured");
2047 return unformat_parse_error (input);
2050 unformat_free (input);
2052 /* Enable memory trace as early as possible. */
2053 if (turn_on_mem_trace)
2059 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
2062 placeholder_queue_signal_callback (vlib_main_t * vm)
2066 #define foreach_weak_reference_stub \
2067 _(vlib_map_stat_segment_init) \
2069 _(vlibmemory_init) \
2070 _(map_api_segment_init)
2073 clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
2074 clib_error_t *name (vlib_main_t *vm) { return 0; }
2075 foreach_weak_reference_stub;
2078 void vl_api_set_elog_main (elog_main_t * m) __attribute__ ((weak));
2080 vl_api_set_elog_main (elog_main_t * m)
2082 clib_warning ("STUB");
2085 int vl_api_set_elog_trace_api_messages (int enable) __attribute__ ((weak));
2087 vl_api_set_elog_trace_api_messages (int enable)
2089 clib_warning ("STUB");
2093 int vl_api_get_elog_trace_api_messages (void) __attribute__ ((weak));
2095 vl_api_get_elog_trace_api_messages (void)
2097 clib_warning ("STUB");
2101 /* Main function. */
2103 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
2105 clib_error_t *volatile error;
2106 vlib_node_main_t *nm = &vm->node_main;
2108 vm->queue_signal_callback = placeholder_queue_signal_callback;
2110 /* Reconfigure event log which is enabled very early */
2111 if (vm->configured_elog_ring_size &&
2112 vm->configured_elog_ring_size != vm->elog_main.event_ring_size)
2113 elog_resize (&vm->elog_main, vm->configured_elog_ring_size);
2114 vl_api_set_elog_main (&vm->elog_main);
2115 (void) vl_api_set_elog_trace_api_messages (1);
2121 if ((error = vlib_physmem_init (vm)))
2123 clib_error_report (error);
2127 if ((error = vlib_map_stat_segment_init (vm)))
2129 clib_error_report (error);
2133 if ((error = vlib_buffer_main_init (vm)))
2135 clib_error_report (error);
2139 if ((error = vlib_thread_init (vm)))
2141 clib_error_report (error);
2145 /* Register static nodes so that init functions may use them. */
2146 vlib_register_all_static_nodes (vm);
2148 /* Set seed for random number generator.
2149 Allow user to specify seed to make random sequence deterministic. */
2150 if (!unformat (input, "seed %wd", &vm->random_seed))
2151 vm->random_seed = clib_cpu_time_now ();
2152 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
2154 /* Initialize node graph. */
2155 if ((error = vlib_node_main_init (vm)))
2157 /* Arrange for graph hook up error to not be fatal when debugging. */
2159 clib_error_report (error);
2164 /* Direct call / weak reference, for vlib standalone use-cases */
2165 if ((error = vpe_api_init (vm)))
2167 clib_error_report (error);
2171 if ((error = vlibmemory_init (vm)))
2173 clib_error_report (error);
2177 if ((error = map_api_segment_init (vm)))
2179 clib_error_report (error);
2183 /* See unix/main.c; most likely already set up */
2184 if (vm->init_functions_called == 0)
2185 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
2186 if ((error = vlib_call_all_init_functions (vm)))
2189 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
2190 CLIB_CACHE_LINE_BYTES);
2192 vec_validate (nm->data_from_advancing_timing_wheel, 10);
2193 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
2195 /* Create the process timing wheel */
2196 TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
2197 0 /* no callback */ ,
2198 10e-6 /* timer period 10us */ ,
2199 ~0 /* max expirations per call */ );
2201 vec_validate (vm->pending_rpc_requests, 0);
2202 _vec_len (vm->pending_rpc_requests) = 0;
2203 vec_validate (vm->processing_rpc_requests, 0);
2204 _vec_len (vm->processing_rpc_requests) = 0;
2206 /* Default params for the buffer allocator fault injector, if configured */
2207 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0)
2209 vm->buffer_alloc_success_seed = 0xdeaddabe;
2210 vm->buffer_alloc_success_rate = 0.80;
2213 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
2217 * Use exponential smoothing, with a half-life of 1 second
2218 * reported_rate(t) = reported_rate(t-1) * K + rate(t)*(1-K)
2220 * Sample every 20ms, aka 50 samples per second
2221 * K = exp (-1.0/20.0);
2224 vm->damping_constant = exp (-1.0 / 20.0);
2226 /* Sort per-thread init functions before we start threads */
2227 vlib_sort_init_exit_functions (&vm->worker_init_function_registrations);
2229 /* Call all main loop enter functions. */
2231 clib_error_t *sub_error;
2232 sub_error = vlib_call_all_main_loop_enter_functions (vm);
2234 clib_error_report (sub_error);
2237 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2239 case VLIB_MAIN_LOOP_EXIT_NONE:
2240 vm->main_loop_exit_set = 1;
2243 case VLIB_MAIN_LOOP_EXIT_CLI:
2247 error = vm->main_loop_error;
2251 vlib_main_loop (vm);
2254 vlib_worker_thread_barrier_sync (vm);
2255 /* Call all exit functions. */
2257 clib_error_t *sub_error;
2258 sub_error = vlib_call_all_main_loop_exit_functions (vm);
2260 clib_error_report (sub_error);
2262 vlib_worker_thread_barrier_release (vm);
2265 clib_error_report (error);
2271 vlib_pcap_dispatch_trace_configure (vlib_pcap_dispatch_trace_args_t * a)
2273 vlib_main_t *vm = vlib_get_main ();
2274 pcap_main_t *pm = &vm->dispatch_pcap_main;
2275 vlib_trace_main_t *tm;
2276 vlib_trace_node_t *tn;
2280 if (vm->dispatch_pcap_enable)
2284 (vm, "pcap dispatch capture enabled: %d of %d pkts...",
2285 pm->n_packets_captured, pm->n_packets_to_capture);
2286 vlib_cli_output (vm, "capture to file %s", pm->file_name);
2288 for (i = 0; i < vec_len (vm->dispatch_buffer_trace_nodes); i++)
2290 vlib_cli_output (vm,
2291 "Buffer trace of %d pkts from %U enabled...",
2292 a->buffer_traces_to_capture,
2293 format_vlib_node_name, vm,
2294 vm->dispatch_buffer_trace_nodes[i]);
2298 vlib_cli_output (vm, "pcap dispatch capture disabled");
2302 /* Consistency checks */
2304 /* Enable w/ capture already enabled not allowed */
2305 if (vm->dispatch_pcap_enable && a->enable)
2306 return -7; /* VNET_API_ERROR_INVALID_VALUE */
2308 /* Disable capture with capture already disabled, not interesting */
2309 if (vm->dispatch_pcap_enable == 0 && a->enable == 0)
2310 return -81; /* VNET_API_ERROR_VALUE_EXIST */
2312 /* Change number of packets to capture while capturing */
2313 if (vm->dispatch_pcap_enable && a->enable
2314 && (pm->n_packets_to_capture != a->packets_to_capture))
2315 return -8; /* VNET_API_ERROR_INVALID_VALUE_2 */
2317 /* Independent of enable/disable, to allow buffer trace multi nodes */
2318 if (a->buffer_trace_node_index != ~0)
2321 foreach_vlib_main ((
2323 tm = &this_vlib_main->trace_main;
2324 tm->verbose = 0; /* not sure this ever did anything... */
2325 vec_validate (tm->nodes, a->buffer_trace_node_index);
2326 tn = tm->nodes + a->buffer_trace_node_index;
2327 tn->limit += a->buffer_traces_to_capture;
2330 tm->filter_flag = FILTER_FLAG_POST_MORTEM;
2331 tm->filter_count = ~0;
2333 tm->trace_enable = 1;
2336 vec_add1 (vm->dispatch_buffer_trace_nodes, a->buffer_trace_node_index);
2341 /* Clean up from previous run, if any */
2342 vec_free (pm->file_name);
2343 vec_free (pm->pcap_data);
2344 memset (pm, 0, sizeof (*pm));
2346 vec_validate_aligned (vnet_trace_placeholder, 2048,
2347 CLIB_CACHE_LINE_BYTES);
2349 clib_spinlock_init (&(pm->lock));
2351 if (a->filename == 0)
2352 a->filename = format (0, "/tmp/dispatch.pcap%c", 0);
2354 pm->file_name = (char *) a->filename;
2355 pm->n_packets_captured = 0;
2356 pm->packet_type = PCAP_PACKET_TYPE_vpp;
2357 pm->n_packets_to_capture = a->packets_to_capture;
2358 vm->dispatch_pcap_postmortem = a->post_mortem;
2360 foreach_vlib_main (({ this_vlib_main->dispatch_pcap_enable = 1;}));
2366 foreach_vlib_main ((
2368 this_vlib_main->dispatch_pcap_enable = 0;
2369 this_vlib_main->dispatch_pcap_postmortem = 0;
2370 tm = &this_vlib_main->trace_main;
2371 tm->filter_flag = 0;
2372 tm->filter_count = 0;
2373 tm->trace_enable = 0;
2376 vec_reset_length (vm->dispatch_buffer_trace_nodes);
2377 if (pm->n_packets_captured)
2379 clib_error_t *error;
2380 pm->n_packets_to_capture = pm->n_packets_captured;
2381 vlib_cli_output (vm, "Write %d packets to %s, and stop capture...",
2382 pm->n_packets_captured, pm->file_name);
2383 error = pcap_write (pm);
2384 if (pm->flags & PCAP_MAIN_INIT_DONE)
2386 /* Report I/O errors... */
2389 clib_error_report (error);
2390 return -11; /* VNET_API_ERROR_SYSCALL_ERROR_1 */
2395 return -6; /* VNET_API_ERROR_NO_SUCH_ENTRY */
2401 static clib_error_t *
2402 dispatch_trace_command_fn (vlib_main_t * vm,
2403 unformat_input_t * input, vlib_cli_command_t * cmd)
2405 unformat_input_t _line_input, *line_input = &_line_input;
2406 vlib_pcap_dispatch_trace_args_t _a, *a = &_a;
2412 int post_mortem = 0;
2413 u32 node_index = ~0, buffer_traces_to_capture = 100;
2415 /* Get a line of input. */
2416 if (!unformat_user (input, unformat_line_input, line_input))
2419 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2421 if (unformat (line_input, "on %=", &enable, 1))
2423 else if (unformat (line_input, "enable %=", &enable, 1))
2425 else if (unformat (line_input, "off %=", &enable, 0))
2427 else if (unformat (line_input, "disable %=", &enable, 0))
2429 else if (unformat (line_input, "max %d", &max))
2431 else if (unformat (line_input, "packets-to-capture %d", &max))
2433 else if (unformat (line_input, "file %U", unformat_vlib_tmpfile,
2436 else if (unformat (line_input, "status %=", &status, 1))
2438 else if (unformat (line_input, "buffer-trace %U %d",
2439 unformat_vlib_node, vm, &node_index,
2440 &buffer_traces_to_capture))
2442 else if (unformat (line_input, "post-mortem %=", &post_mortem, 1))
2446 return clib_error_return (0, "unknown input `%U'",
2447 format_unformat_error, line_input);
2451 unformat_free (line_input);
2453 /* no need for memset (a, 0, sizeof (*a)), set all fields here. */
2454 a->filename = filename;
2457 a->packets_to_capture = max;
2458 a->buffer_trace_node_index = node_index;
2459 a->buffer_traces_to_capture = buffer_traces_to_capture;
2460 a->post_mortem = post_mortem;
2462 rv = vlib_pcap_dispatch_trace_configure (a);
2470 return clib_error_return (0, "dispatch trace already enabled...");
2473 return clib_error_return (0, "dispatch trace already disabled...");
2476 return clib_error_return
2477 (0, "can't change number of records to capture while tracing...");
2480 return clib_error_return (0, "I/O writing trace capture...");
2483 return clib_error_return (0, "No packets captured...");
2486 vlib_cli_output (vm, "WARNING: trace configure returned %d", rv);
2493 * This command is used to start or stop pcap dispatch trace capture, or show
2494 * the capture status.
2496 * This command has the following optional parameters:
2498 * - <b>on|off</b> - Used to start or stop capture.
2500 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2501 * of packets have been received, buffer is flushed to file. Once another
2502 * '<em>nn</em>' number of packets have been received, buffer is flushed
2503 * to file, overwriting previous write. If not entered, value defaults
2504 * to 100. Can only be updated if packet capture is off.
2506 * - <b>file <name></b> - Used to specify the output filename. The file will
2507 * be placed in the '<em>/tmp</em>' directory, so only the filename is
2508 * supported. Directory should not be entered. If file already exists, file
2509 * will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
2510 * will be used. Can only be updated if packet capture is off.
2512 * - <b>status</b> - Displays the current status and configured attributes
2513 * associated with a packet capture. If packet capture is in progress,
2514 * '<em>status</em>' also will return the number of packets currently in
2515 * the local buffer. All additional attributes entered on command line
2516 * with '<em>status</em>' will be ignored and not applied.
2519 * Example of how to display the status of capture when off:
2520 * @cliexstart{pcap dispatch trace status}
2521 * max is 100, for any interface to file /tmp/vpe.pcap
2522 * pcap dispatch capture is off...
2524 * Example of how to start a dispatch trace capture:
2525 * @cliexstart{pcap dispatch trace on max 35 file dispatchTrace.pcap}
2526 * pcap dispatch capture on...
2528 * Example of how to start a dispatch trace capture with buffer tracing
2529 * @cliexstart{pcap dispatch trace on max 10000 file dispatchTrace.pcap buffer-trace dpdk-input 1000}
2530 * pcap dispatch capture on...
2532 * Example of how to display the status of a tx packet capture in progress:
2533 * @cliexstart{pcap tx trace status}
2534 * max is 35, dispatch trace to file /tmp/vppTest.pcap
2535 * pcap tx capture is on: 20 of 35 pkts...
2537 * Example of how to stop a tx packet capture:
2538 * @cliexstart{vppctl pcap dispatch trace off}
2539 * captured 21 pkts...
2540 * saved to /tmp/dispatchTrace.pcap...
2541 * Example of how to start a post-mortem dispatch trace:
2542 * pcap dispatch trace on max 20000 buffer-trace
2543 * dpdk-input 3000000000 post-mortem
2547 VLIB_CLI_COMMAND (pcap_dispatch_trace_command, static) = {
2548 .path = "pcap dispatch trace",
2550 "pcap dispatch trace [on|off] [max <nn>] [file <name>] [status]\n"
2551 " [buffer-trace <input-node-name> <nn>][post-mortem]",
2552 .function = dispatch_trace_command_fn,
2557 vlib_get_main_not_inline (void)
2559 return vlib_get_main ();
2563 vlib_get_elog_main_not_inline ()
2565 return &vlib_global_main.elog_main;
2569 * fd.io coding-style-patch-verification: ON
2572 * eval: (c-set-style "gnu")