3 * Function graph tracer.
4 * Copyright (c) 2008-2009 Frederic Weisbecker <fweisbec@gmail.com>
5 * Mostly borrowed from function tracer which
6 * is Copyright (c) Steven Rostedt <srostedt@redhat.com>
9 #include <linux/debugfs.h>
10 #include <linux/uaccess.h>
11 #include <linux/ftrace.h>
15 #include "trace_output.h"
17 #define TRACE_GRAPH_INDENT 2
20 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
21 #define TRACE_GRAPH_PRINT_CPU 0x2
22 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
23 #define TRACE_GRAPH_PRINT_PROC 0x8
24 #define TRACE_GRAPH_PRINT_DURATION 0x10
25 #define TRACE_GRAPH_PRINT_ABS_TIME 0X20
27 static struct tracer_opt trace_opts[] = {
28 /* Display overruns? (for self-debug purpose) */
29 { TRACER_OPT(funcgraph-overrun, TRACE_GRAPH_PRINT_OVERRUN) },
31 { TRACER_OPT(funcgraph-cpu, TRACE_GRAPH_PRINT_CPU) },
32 /* Display Overhead ? */
33 { TRACER_OPT(funcgraph-overhead, TRACE_GRAPH_PRINT_OVERHEAD) },
34 /* Display proc name/pid */
35 { TRACER_OPT(funcgraph-proc, TRACE_GRAPH_PRINT_PROC) },
36 /* Display duration of execution */
37 { TRACER_OPT(funcgraph-duration, TRACE_GRAPH_PRINT_DURATION) },
38 /* Display absolute time of an entry */
39 { TRACER_OPT(funcgraph-abstime, TRACE_GRAPH_PRINT_ABS_TIME) },
43 static struct tracer_flags tracer_flags = {
44 /* Don't display overruns and proc by default */
45 .val = TRACE_GRAPH_PRINT_CPU | TRACE_GRAPH_PRINT_OVERHEAD |
46 TRACE_GRAPH_PRINT_DURATION,
50 /* pid on the last trace processed */
53 static int graph_trace_init(struct trace_array *tr)
57 for_each_online_cpu(cpu)
58 tracing_reset(tr, cpu);
60 ret = register_ftrace_graph(&trace_graph_return,
64 tracing_start_cmdline_record();
69 static void graph_trace_reset(struct trace_array *tr)
71 tracing_stop_cmdline_record();
72 unregister_ftrace_graph();
75 static inline int log10_cpu(int nb)
84 static enum print_line_t
85 print_graph_cpu(struct trace_seq *s, int cpu)
89 int log10_this = log10_cpu(cpu);
90 int log10_all = log10_cpu(cpumask_weight(cpu_online_mask));
94 * Start with a space character - to make it stand out
95 * to the right a bit when trace output is pasted into
98 ret = trace_seq_printf(s, " ");
101 * Tricky - we space the CPU field according to the max
102 * number of online CPUs. On a 2-cpu system it would take
103 * a maximum of 1 digit - on a 128 cpu system it would
104 * take up to 3 digits:
106 for (i = 0; i < log10_all - log10_this; i++) {
107 ret = trace_seq_printf(s, " ");
109 return TRACE_TYPE_PARTIAL_LINE;
111 ret = trace_seq_printf(s, "%d) ", cpu);
113 return TRACE_TYPE_PARTIAL_LINE;
115 return TRACE_TYPE_HANDLED;
118 #define TRACE_GRAPH_PROCINFO_LENGTH 14
120 static enum print_line_t
121 print_graph_proc(struct trace_seq *s, pid_t pid)
128 /* sign + log10(MAX_INT) + '\0' */
131 strncpy(comm, trace_find_cmdline(pid), 7);
133 sprintf(pid_str, "%d", pid);
135 /* 1 stands for the "-" character */
136 len = strlen(comm) + strlen(pid_str) + 1;
138 if (len < TRACE_GRAPH_PROCINFO_LENGTH)
139 spaces = TRACE_GRAPH_PROCINFO_LENGTH - len;
141 /* First spaces to align center */
142 for (i = 0; i < spaces / 2; i++) {
143 ret = trace_seq_printf(s, " ");
145 return TRACE_TYPE_PARTIAL_LINE;
148 ret = trace_seq_printf(s, "%s-%s", comm, pid_str);
150 return TRACE_TYPE_PARTIAL_LINE;
152 /* Last spaces to align center */
153 for (i = 0; i < spaces - (spaces / 2); i++) {
154 ret = trace_seq_printf(s, " ");
156 return TRACE_TYPE_PARTIAL_LINE;
158 return TRACE_TYPE_HANDLED;
162 /* If the pid changed since the last trace, output this event */
163 static enum print_line_t
164 verif_pid(struct trace_seq *s, pid_t pid, int cpu, pid_t *last_pids_cpu)
171 return TRACE_TYPE_HANDLED;
173 last_pid = per_cpu_ptr(last_pids_cpu, cpu);
175 if (*last_pid == pid)
176 return TRACE_TYPE_HANDLED;
178 prev_pid = *last_pid;
182 return TRACE_TYPE_HANDLED;
184 * Context-switch trace line:
186 ------------------------------------------
187 | 1) migration/0--1 => sshd-1755
188 ------------------------------------------
191 ret = trace_seq_printf(s,
192 " ------------------------------------------\n");
194 TRACE_TYPE_PARTIAL_LINE;
196 ret = print_graph_cpu(s, cpu);
197 if (ret == TRACE_TYPE_PARTIAL_LINE)
198 TRACE_TYPE_PARTIAL_LINE;
200 ret = print_graph_proc(s, prev_pid);
201 if (ret == TRACE_TYPE_PARTIAL_LINE)
202 TRACE_TYPE_PARTIAL_LINE;
204 ret = trace_seq_printf(s, " => ");
206 TRACE_TYPE_PARTIAL_LINE;
208 ret = print_graph_proc(s, pid);
209 if (ret == TRACE_TYPE_PARTIAL_LINE)
210 TRACE_TYPE_PARTIAL_LINE;
212 ret = trace_seq_printf(s,
213 "\n ------------------------------------------\n\n");
215 TRACE_TYPE_PARTIAL_LINE;
221 trace_branch_is_leaf(struct trace_iterator *iter,
222 struct ftrace_graph_ent_entry *curr)
224 struct ring_buffer_iter *ring_iter;
225 struct ring_buffer_event *event;
226 struct ftrace_graph_ret_entry *next;
228 ring_iter = iter->buffer_iter[iter->cpu];
233 event = ring_buffer_iter_peek(ring_iter, NULL);
238 next = ring_buffer_event_data(event);
240 if (next->ent.type != TRACE_GRAPH_RET)
243 if (curr->ent.pid != next->ent.pid ||
244 curr->graph_ent.func != next->ret.func)
250 /* Signal a overhead of time execution to the output */
252 print_graph_overhead(unsigned long long duration, struct trace_seq *s)
254 /* If duration disappear, we don't need anything */
255 if (!(tracer_flags.val & TRACE_GRAPH_PRINT_DURATION))
258 /* Non nested entry or return */
260 return trace_seq_printf(s, " ");
262 if (tracer_flags.val & TRACE_GRAPH_PRINT_OVERHEAD) {
263 /* Duration exceeded 100 msecs */
264 if (duration > 100000ULL)
265 return trace_seq_printf(s, "! ");
267 /* Duration exceeded 10 msecs */
268 if (duration > 10000ULL)
269 return trace_seq_printf(s, "+ ");
272 return trace_seq_printf(s, " ");
275 static enum print_line_t
276 print_graph_irq(struct trace_seq *s, unsigned long addr,
277 enum trace_type type, int cpu, pid_t pid)
281 if (addr < (unsigned long)__irqentry_text_start ||
282 addr >= (unsigned long)__irqentry_text_end)
283 return TRACE_TYPE_UNHANDLED;
286 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU) {
287 ret = print_graph_cpu(s, cpu);
288 if (ret == TRACE_TYPE_PARTIAL_LINE)
289 return TRACE_TYPE_PARTIAL_LINE;
292 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC) {
293 ret = print_graph_proc(s, pid);
294 if (ret == TRACE_TYPE_PARTIAL_LINE)
295 return TRACE_TYPE_PARTIAL_LINE;
296 ret = trace_seq_printf(s, " | ");
298 return TRACE_TYPE_PARTIAL_LINE;
302 ret = print_graph_overhead(-1, s);
304 return TRACE_TYPE_PARTIAL_LINE;
306 if (type == TRACE_GRAPH_ENT)
307 ret = trace_seq_printf(s, "==========>");
309 ret = trace_seq_printf(s, "<==========");
312 return TRACE_TYPE_PARTIAL_LINE;
314 /* Don't close the duration column if haven't one */
315 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION)
316 trace_seq_printf(s, " |");
317 ret = trace_seq_printf(s, "\n");
320 return TRACE_TYPE_PARTIAL_LINE;
321 return TRACE_TYPE_HANDLED;
324 static enum print_line_t
325 print_graph_duration(unsigned long long duration, struct trace_seq *s)
327 unsigned long nsecs_rem = do_div(duration, 1000);
328 /* log10(ULONG_MAX) + '\0' */
334 sprintf(msecs_str, "%lu", (unsigned long) duration);
337 ret = trace_seq_printf(s, "%s", msecs_str);
339 return TRACE_TYPE_PARTIAL_LINE;
341 len = strlen(msecs_str);
343 /* Print nsecs (we don't want to exceed 7 numbers) */
345 snprintf(nsecs_str, 8 - len, "%03lu", nsecs_rem);
346 ret = trace_seq_printf(s, ".%s", nsecs_str);
348 return TRACE_TYPE_PARTIAL_LINE;
349 len += strlen(nsecs_str);
352 ret = trace_seq_printf(s, " us ");
354 return TRACE_TYPE_PARTIAL_LINE;
356 /* Print remaining spaces to fit the row's width */
357 for (i = len; i < 7; i++) {
358 ret = trace_seq_printf(s, " ");
360 return TRACE_TYPE_PARTIAL_LINE;
363 ret = trace_seq_printf(s, "| ");
365 return TRACE_TYPE_PARTIAL_LINE;
366 return TRACE_TYPE_HANDLED;
370 static int print_graph_abs_time(u64 t, struct trace_seq *s)
372 unsigned long usecs_rem;
374 usecs_rem = do_div(t, 1000000000);
377 return trace_seq_printf(s, "%5lu.%06lu | ",
378 (unsigned long)t, usecs_rem);
381 /* Case of a leaf function on its call entry */
382 static enum print_line_t
383 print_graph_entry_leaf(struct trace_iterator *iter,
384 struct ftrace_graph_ent_entry *entry, struct trace_seq *s)
386 struct ftrace_graph_ret_entry *ret_entry;
387 struct ftrace_graph_ret *graph_ret;
388 struct ring_buffer_event *event;
389 struct ftrace_graph_ent *call;
390 unsigned long long duration;
394 event = ring_buffer_read(iter->buffer_iter[iter->cpu], NULL);
395 ret_entry = ring_buffer_event_data(event);
396 graph_ret = &ret_entry->ret;
397 call = &entry->graph_ent;
398 duration = graph_ret->rettime - graph_ret->calltime;
401 ret = print_graph_overhead(duration, s);
403 return TRACE_TYPE_PARTIAL_LINE;
406 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION) {
407 ret = print_graph_duration(duration, s);
408 if (ret == TRACE_TYPE_PARTIAL_LINE)
409 return TRACE_TYPE_PARTIAL_LINE;
413 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++) {
414 ret = trace_seq_printf(s, " ");
416 return TRACE_TYPE_PARTIAL_LINE;
419 ret = seq_print_ip_sym(s, call->func, 0);
421 return TRACE_TYPE_PARTIAL_LINE;
423 ret = trace_seq_printf(s, "();\n");
425 return TRACE_TYPE_PARTIAL_LINE;
427 return TRACE_TYPE_HANDLED;
430 static enum print_line_t
431 print_graph_entry_nested(struct ftrace_graph_ent_entry *entry,
432 struct trace_seq *s, pid_t pid, int cpu)
436 struct ftrace_graph_ent *call = &entry->graph_ent;
439 ret = print_graph_overhead(-1, s);
441 return TRACE_TYPE_PARTIAL_LINE;
444 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION) {
445 ret = trace_seq_printf(s, " | ");
447 return TRACE_TYPE_PARTIAL_LINE;
451 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++) {
452 ret = trace_seq_printf(s, " ");
454 return TRACE_TYPE_PARTIAL_LINE;
457 ret = seq_print_ip_sym(s, call->func, 0);
459 return TRACE_TYPE_PARTIAL_LINE;
461 ret = trace_seq_printf(s, "() {\n");
463 return TRACE_TYPE_PARTIAL_LINE;
465 return TRACE_TYPE_HANDLED;
468 static enum print_line_t
469 print_graph_entry(struct ftrace_graph_ent_entry *field, struct trace_seq *s,
470 struct trace_iterator *iter)
474 pid_t *last_entry = iter->private;
475 struct trace_entry *ent = iter->ent;
476 struct ftrace_graph_ent *call = &field->graph_ent;
479 if (verif_pid(s, ent->pid, cpu, last_entry) == TRACE_TYPE_PARTIAL_LINE)
480 return TRACE_TYPE_PARTIAL_LINE;
483 ret = print_graph_irq(s, call->func, TRACE_GRAPH_ENT, cpu, ent->pid);
484 if (ret == TRACE_TYPE_PARTIAL_LINE)
485 return TRACE_TYPE_PARTIAL_LINE;
488 if (tracer_flags.val & TRACE_GRAPH_PRINT_ABS_TIME) {
489 ret = print_graph_abs_time(iter->ts, s);
491 return TRACE_TYPE_PARTIAL_LINE;
495 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU) {
496 ret = print_graph_cpu(s, cpu);
497 if (ret == TRACE_TYPE_PARTIAL_LINE)
498 return TRACE_TYPE_PARTIAL_LINE;
502 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC) {
503 ret = print_graph_proc(s, ent->pid);
504 if (ret == TRACE_TYPE_PARTIAL_LINE)
505 return TRACE_TYPE_PARTIAL_LINE;
507 ret = trace_seq_printf(s, " | ");
509 return TRACE_TYPE_PARTIAL_LINE;
512 if (trace_branch_is_leaf(iter, field))
513 return print_graph_entry_leaf(iter, field, s);
515 return print_graph_entry_nested(field, s, iter->ent->pid, cpu);
519 static enum print_line_t
520 print_graph_return(struct ftrace_graph_ret *trace, struct trace_seq *s,
521 struct trace_entry *ent, struct trace_iterator *iter)
526 pid_t *last_pid = iter->private;
527 unsigned long long duration = trace->rettime - trace->calltime;
530 if (verif_pid(s, ent->pid, cpu, last_pid) == TRACE_TYPE_PARTIAL_LINE)
531 return TRACE_TYPE_PARTIAL_LINE;
534 if (tracer_flags.val & TRACE_GRAPH_PRINT_ABS_TIME) {
535 ret = print_graph_abs_time(iter->ts, s);
537 return TRACE_TYPE_PARTIAL_LINE;
541 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU) {
542 ret = print_graph_cpu(s, cpu);
543 if (ret == TRACE_TYPE_PARTIAL_LINE)
544 return TRACE_TYPE_PARTIAL_LINE;
548 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC) {
549 ret = print_graph_proc(s, ent->pid);
550 if (ret == TRACE_TYPE_PARTIAL_LINE)
551 return TRACE_TYPE_PARTIAL_LINE;
553 ret = trace_seq_printf(s, " | ");
555 return TRACE_TYPE_PARTIAL_LINE;
559 ret = print_graph_overhead(duration, s);
561 return TRACE_TYPE_PARTIAL_LINE;
564 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION) {
565 ret = print_graph_duration(duration, s);
566 if (ret == TRACE_TYPE_PARTIAL_LINE)
567 return TRACE_TYPE_PARTIAL_LINE;
571 for (i = 0; i < trace->depth * TRACE_GRAPH_INDENT; i++) {
572 ret = trace_seq_printf(s, " ");
574 return TRACE_TYPE_PARTIAL_LINE;
577 ret = trace_seq_printf(s, "}\n");
579 return TRACE_TYPE_PARTIAL_LINE;
582 if (tracer_flags.val & TRACE_GRAPH_PRINT_OVERRUN) {
583 ret = trace_seq_printf(s, " (Overruns: %lu)\n",
586 return TRACE_TYPE_PARTIAL_LINE;
589 ret = print_graph_irq(s, trace->func, TRACE_GRAPH_RET, cpu, ent->pid);
590 if (ret == TRACE_TYPE_PARTIAL_LINE)
591 return TRACE_TYPE_PARTIAL_LINE;
593 return TRACE_TYPE_HANDLED;
596 static enum print_line_t
597 print_graph_comment(struct print_entry *trace, struct trace_seq *s,
598 struct trace_entry *ent, struct trace_iterator *iter)
603 pid_t *last_pid = iter->private;
606 if (tracer_flags.val & TRACE_GRAPH_PRINT_ABS_TIME) {
607 ret = print_graph_abs_time(iter->ts, s);
609 return TRACE_TYPE_PARTIAL_LINE;
613 if (verif_pid(s, ent->pid, cpu, last_pid) == TRACE_TYPE_PARTIAL_LINE)
614 return TRACE_TYPE_PARTIAL_LINE;
617 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU) {
618 ret = print_graph_cpu(s, cpu);
619 if (ret == TRACE_TYPE_PARTIAL_LINE)
620 return TRACE_TYPE_PARTIAL_LINE;
624 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC) {
625 ret = print_graph_proc(s, ent->pid);
626 if (ret == TRACE_TYPE_PARTIAL_LINE)
627 return TRACE_TYPE_PARTIAL_LINE;
629 ret = trace_seq_printf(s, " | ");
631 return TRACE_TYPE_PARTIAL_LINE;
635 ret = print_graph_overhead(-1, s);
637 return TRACE_TYPE_PARTIAL_LINE;
640 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION) {
641 ret = trace_seq_printf(s, " | ");
643 return TRACE_TYPE_PARTIAL_LINE;
647 if (trace->depth > 0)
648 for (i = 0; i < (trace->depth + 1) * TRACE_GRAPH_INDENT; i++) {
649 ret = trace_seq_printf(s, " ");
651 return TRACE_TYPE_PARTIAL_LINE;
655 ret = trace_seq_printf(s, "/* %s", trace->buf);
657 return TRACE_TYPE_PARTIAL_LINE;
659 /* Strip ending newline */
660 if (s->buffer[s->len - 1] == '\n') {
661 s->buffer[s->len - 1] = '\0';
665 ret = trace_seq_printf(s, " */\n");
667 return TRACE_TYPE_PARTIAL_LINE;
669 return TRACE_TYPE_HANDLED;
674 print_graph_function(struct trace_iterator *iter)
676 struct trace_seq *s = &iter->seq;
677 struct trace_entry *entry = iter->ent;
679 switch (entry->type) {
680 case TRACE_GRAPH_ENT: {
681 struct ftrace_graph_ent_entry *field;
682 trace_assign_type(field, entry);
683 return print_graph_entry(field, s, iter);
685 case TRACE_GRAPH_RET: {
686 struct ftrace_graph_ret_entry *field;
687 trace_assign_type(field, entry);
688 return print_graph_return(&field->ret, s, entry, iter);
691 struct print_entry *field;
692 trace_assign_type(field, entry);
693 return print_graph_comment(field, s, entry, iter);
696 return TRACE_TYPE_UNHANDLED;
700 static void print_graph_headers(struct seq_file *s)
704 if (tracer_flags.val & TRACE_GRAPH_PRINT_ABS_TIME)
705 seq_printf(s, " TIME ");
706 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU)
707 seq_printf(s, "CPU");
708 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC)
709 seq_printf(s, " TASK/PID ");
710 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION)
711 seq_printf(s, " DURATION ");
712 seq_printf(s, " FUNCTION CALLS\n");
716 if (tracer_flags.val & TRACE_GRAPH_PRINT_ABS_TIME)
717 seq_printf(s, " | ");
718 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU)
720 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC)
721 seq_printf(s, " | | ");
722 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION)
723 seq_printf(s, " | | ");
724 seq_printf(s, " | | | |\n");
727 static void graph_trace_open(struct trace_iterator *iter)
729 /* pid on the last trace processed */
730 pid_t *last_pid = alloc_percpu(pid_t);
734 pr_warning("function graph tracer: not enough memory\n");
736 for_each_possible_cpu(cpu) {
737 pid_t *pid = per_cpu_ptr(last_pid, cpu);
741 iter->private = last_pid;
744 static void graph_trace_close(struct trace_iterator *iter)
746 percpu_free(iter->private);
749 static struct tracer graph_trace __read_mostly = {
750 .name = "function_graph",
751 .open = graph_trace_open,
752 .close = graph_trace_close,
753 .init = graph_trace_init,
754 .reset = graph_trace_reset,
755 .print_line = print_graph_function,
756 .print_header = print_graph_headers,
757 .flags = &tracer_flags,
760 static __init int init_graph_trace(void)
762 return register_tracer(&graph_trace);
765 device_initcall(init_graph_trace);