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 * trace.c: VLIB trace buffer.
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.
40 #include <vlib/vlib.h>
41 #include <vlib/threads.h>
43 /* Helper function for nodes which only trace buffer data. */
45 vlib_trace_frame_buffers_only (vlib_main_t * vm,
46 vlib_node_runtime_t * node,
49 uword next_buffer_stride,
50 uword n_buffer_data_bytes_in_trace)
60 vlib_buffer_t *b0, *b1;
63 /* Prefetch next iteration. */
64 vlib_prefetch_buffer_with_index (vm, from[2], LOAD);
65 vlib_prefetch_buffer_with_index (vm, from[3], LOAD);
70 b0 = vlib_get_buffer (vm, bi0);
71 b1 = vlib_get_buffer (vm, bi1);
73 if (b0->flags & VLIB_BUFFER_IS_TRACED)
75 t0 = vlib_add_trace (vm, node, b0, n_buffer_data_bytes_in_trace);
76 clib_memcpy (t0, b0->data + b0->current_data,
77 n_buffer_data_bytes_in_trace);
79 if (b1->flags & VLIB_BUFFER_IS_TRACED)
81 t1 = vlib_add_trace (vm, node, b1, n_buffer_data_bytes_in_trace);
82 clib_memcpy (t1, b1->data + b1->current_data,
83 n_buffer_data_bytes_in_trace);
97 b0 = vlib_get_buffer (vm, bi0);
99 if (b0->flags & VLIB_BUFFER_IS_TRACED)
101 t0 = vlib_add_trace (vm, node, b0, n_buffer_data_bytes_in_trace);
102 clib_memcpy (t0, b0->data + b0->current_data,
103 n_buffer_data_bytes_in_trace);
110 /* Free up all trace buffer memory. */
112 clear_trace_buffer (void)
115 vlib_trace_main_t *tm;
122 tm = &this_vlib_main->trace_main;
123 mainheap = clib_mem_set_heap (this_vlib_main->heap_base);
125 tm->trace_active_hint = 0;
127 for (i = 0; i < vec_len (tm->trace_buffer_pool); i++)
128 if (! pool_is_free_index (tm->trace_buffer_pool, i))
129 vec_free (tm->trace_buffer_pool[i]);
130 pool_free (tm->trace_buffer_pool);
131 clib_mem_set_heap (mainheap);
137 format_vlib_trace (u8 * s, va_list * va)
139 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
140 vlib_trace_header_t *h = va_arg (*va, vlib_trace_header_t *);
141 vlib_trace_header_t *e = vec_end (h);
142 vlib_node_t *node, *prev_node;
143 clib_time_t *ct = &vm->clib_time;
149 node = vlib_get_node (vm, h->node_index);
151 if (node != prev_node)
154 (h->time - vm->cpu_time_main_loop_start) * ct->seconds_per_clock;
156 format (s, "\n%U: %v", format_time_interval, "h:m:s:u", t,
161 if (node->format_trace)
162 s = format (s, "\n %U", node->format_trace, vm, node, h->data);
164 s = format (s, "\n %U", node->format_buffer, h->data);
166 h = vlib_trace_header_next (h);
172 /* Root of all trace cli commands. */
174 VLIB_CLI_COMMAND (trace_cli_command,static) = {
176 .short_help = "Packet tracer commands",
181 trace_cmp (void *a1, void *a2)
183 vlib_trace_header_t **t1 = a1;
184 vlib_trace_header_t **t2 = a2;
185 i64 dt = t1[0]->time - t2[0]->time;
186 return dt < 0 ? -1 : (dt > 0 ? +1 : 0);
190 * Return 1 if this packet passes the trace filter, or 0 otherwise
193 filter_accept (vlib_trace_main_t * tm, vlib_trace_header_t * h)
195 vlib_trace_header_t *e = vec_end (h);
197 if (tm->filter_flag == 0)
200 if (tm->filter_flag == FILTER_FLAG_INCLUDE)
204 if (h->node_index == tm->filter_node_index)
206 h = vlib_trace_header_next (h);
210 else /* FILTER_FLAG_EXCLUDE */
214 if (h->node_index == tm->filter_node_index)
216 h = vlib_trace_header_next (h);
225 * Remove traces from the trace buffer pool that don't pass the filter
228 trace_apply_filter (vlib_main_t * vm)
230 vlib_trace_main_t *tm = &vm->trace_main;
231 vlib_trace_header_t **h;
232 vlib_trace_header_t ***traces_to_remove = 0;
239 if (tm->filter_flag == FILTER_FLAG_NONE)
243 * Ideally we would retain the first N traces that pass the filter instead
248 pool_foreach (h, tm->trace_buffer_pool,
250 accept = filter_accept(tm, h[0]);
252 if ((n_accepted == tm->filter_count) || !accept)
253 vec_add1 (traces_to_remove, h);
259 /* remove all traces that we don't want to keep */
260 for (index = 0; index < vec_len (traces_to_remove); index++)
262 trace_index = traces_to_remove[index] - tm->trace_buffer_pool;
263 _vec_len (tm->trace_buffer_pool[trace_index]) = 0;
264 pool_put_index (tm->trace_buffer_pool, trace_index);
267 vec_free (traces_to_remove);
270 static clib_error_t *
271 cli_show_trace_buffer (vlib_main_t * vm,
272 unformat_input_t * input, vlib_cli_command_t * cmd)
274 vlib_trace_main_t *tm;
275 vlib_trace_header_t **h, **traces;
282 * By default display only this many traces. To display more, explicitly
283 * specify a max. This prevents unexpectedly huge outputs.
286 while (unformat_check_input (input) != (uword) UNFORMAT_END_OF_INPUT)
288 if (unformat (input, "max %d", &max))
291 return clib_error_create ("expected 'max COUNT', got `%U'",
292 format_unformat_error, input);
296 /* Get active traces from pool. */
303 fmt = "------------------- Start of thread %d %s -------------------\n";
304 s = format (s, fmt, index, vlib_worker_threads[index].name);
306 tm = &this_vlib_main->trace_main;
308 mainheap = clib_mem_set_heap (this_vlib_main->heap_base);
310 trace_apply_filter(this_vlib_main);
313 pool_foreach (h, tm->trace_buffer_pool,
315 vec_add1 (traces, h[0]);
318 if (vec_len (traces) == 0)
320 clib_mem_set_heap (mainheap);
321 s = format (s, "No packets in trace buffer\n");
325 /* Sort them by increasing time. */
326 vec_sort_with_function (traces, trace_cmp);
328 for (i = 0; i < vec_len (traces); i++)
332 vlib_cli_output (vm, "Limiting display to %d packets."
333 " To display more specify max.", max);
337 clib_mem_set_heap (mainheap);
339 s = format (s, "Packet %d\n%U\n\n", i + 1,
340 format_vlib_trace, vm, traces[i]);
342 mainheap = clib_mem_set_heap (this_vlib_main->heap_base);
347 clib_mem_set_heap (mainheap);
353 vlib_cli_output (vm, "%v", s);
359 VLIB_CLI_COMMAND (show_trace_cli,static) = {
360 .path = "show trace",
361 .short_help = "Show trace buffer [max COUNT]",
362 .function = cli_show_trace_buffer,
366 static clib_error_t *
367 cli_add_trace_buffer (vlib_main_t * vm,
368 unformat_input_t * input, vlib_cli_command_t * cmd)
370 unformat_input_t _line_input, *line_input = &_line_input;
371 vlib_trace_main_t *tm;
372 vlib_trace_node_t *tn;
375 clib_error_t *error = 0;
377 if (!unformat_user (input, unformat_line_input, line_input))
380 while (unformat_check_input (line_input) != (uword) UNFORMAT_END_OF_INPUT)
382 if (unformat (line_input, "%U %d",
383 unformat_vlib_node, vm, &node_index, &add))
385 else if (unformat (line_input, "verbose"))
389 error = clib_error_create ("expected NODE COUNT, got `%U'",
390 format_unformat_error, line_input);
399 tm = &this_vlib_main->trace_main;
400 tm->trace_active_hint = 1;
401 tm->verbose = verbose;
403 clib_mem_set_heap (this_vlib_main->heap_base);
404 vec_validate (tm->nodes, node_index);
405 tn = tm->nodes + node_index;
406 tn->limit += add; clib_mem_set_heap (oldheap);
411 unformat_free (line_input);
417 VLIB_CLI_COMMAND (add_trace_cli,static) = {
419 .short_help = "Trace given number of packets",
420 .function = cli_add_trace_buffer,
426 * Configure a filter for packet traces.
428 * This supplements the packet trace feature so that only packets matching
429 * the filter are included in the trace. Currently the only filter is to
430 * keep packets that include a certain node in the trace or exclude a certain
433 * The count of traced packets in the "trace add" command is still used to
434 * create a certain number of traces. The "trace filter" command specifies
435 * how many of those packets should be retained in the trace.
437 * For example, 1Mpps of traffic is arriving and one of those packets is being
438 * dropped. To capture the trace for only that dropped packet, you can do:
439 * trace filter include error-drop 1
440 * trace add dpdk-input 1000000
444 * Note that the filter could be implemented by capturing all traces and just
445 * reducing traces displayed by the "show trace" function. But that would
446 * require a lot of memory for storing the traces, making that infeasible.
448 * To remove traces from the trace pool that do not include a certain node
449 * requires that the trace be "complete" before applying the filter. To
450 * accomplish this, the trace pool is filtered upon each iteraction of the
451 * main vlib loop. Doing so keeps the number of allocated traces down to a
452 * reasonably low number. This requires that tracing for a buffer is not
453 * performed after the vlib main loop interation completes. i.e. you can't
454 * save away a buffer temporarily then inject it back into the graph and
455 * expect that the trace_index is still valid (such as a traffic manager might
456 * do). A new trace buffer should be allocated for those types of packets.
458 * The filter can be extended to support multiple nodes and other match
459 * criteria (e.g. input sw_if_index, mac address) but for now just checks if
460 * a specified node is in the trace or not in the trace.
462 static clib_error_t *
463 cli_filter_trace (vlib_main_t * vm,
464 unformat_input_t * input, vlib_cli_command_t * cmd)
466 vlib_trace_main_t *tm = &vm->trace_main;
467 u32 filter_node_index;
472 if (unformat (input, "include %U %d",
473 unformat_vlib_node, vm, &filter_node_index, &filter_count))
475 filter_flag = FILTER_FLAG_INCLUDE;
477 else if (unformat (input, "exclude %U %d",
478 unformat_vlib_node, vm, &filter_node_index,
481 filter_flag = FILTER_FLAG_EXCLUDE;
483 else if (unformat (input, "none"))
485 filter_flag = FILTER_FLAG_NONE;
486 filter_node_index = 0;
492 ("expected 'include NODE COUNT' or 'exclude NODE COUNT' or 'none', got `%U'",
493 format_unformat_error, input);
498 tm = &this_vlib_main->trace_main;
499 tm->filter_node_index = filter_node_index;
500 tm->filter_flag = filter_flag;
501 tm->filter_count = filter_count;
504 * Clear the trace limits to stop any in-progress tracing
505 * Prevents runaway trace allocations when the filter changes (or is removed)
507 mainheap = clib_mem_set_heap (this_vlib_main->heap_base);
508 vec_free (tm->nodes);
509 clib_mem_set_heap (mainheap);
517 VLIB_CLI_COMMAND (filter_trace_cli,static) = {
518 .path = "trace filter",
519 .short_help = "filter trace output - include NODE COUNT | exclude NODE COUNT | none",
520 .function = cli_filter_trace,
524 static clib_error_t *
525 cli_clear_trace_buffer (vlib_main_t * vm,
526 unformat_input_t * input, vlib_cli_command_t * cmd)
528 clear_trace_buffer ();
533 VLIB_CLI_COMMAND (clear_trace_cli,static) = {
534 .path = "clear trace",
535 .short_help = "Clear trace buffer and free memory",
536 .function = cli_clear_trace_buffer,
540 /* Dummy function to get us linked in. */
542 vlib_trace_cli_reference (void)
547 * fd.io coding-style-patch-verification: ON
550 * eval: (c-set-style "gnu")