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)
55 int ret = register_ftrace_graph(&trace_graph_return,
59 tracing_start_cmdline_record();
64 static void graph_trace_reset(struct trace_array *tr)
66 tracing_stop_cmdline_record();
67 unregister_ftrace_graph();
70 static inline int log10_cpu(int nb)
79 static enum print_line_t
80 print_graph_cpu(struct trace_seq *s, int cpu)
84 int log10_this = log10_cpu(cpu);
85 int log10_all = log10_cpu(cpumask_weight(cpu_online_mask));
89 * Start with a space character - to make it stand out
90 * to the right a bit when trace output is pasted into
93 ret = trace_seq_printf(s, " ");
96 * Tricky - we space the CPU field according to the max
97 * number of online CPUs. On a 2-cpu system it would take
98 * a maximum of 1 digit - on a 128 cpu system it would
99 * take up to 3 digits:
101 for (i = 0; i < log10_all - log10_this; i++) {
102 ret = trace_seq_printf(s, " ");
104 return TRACE_TYPE_PARTIAL_LINE;
106 ret = trace_seq_printf(s, "%d) ", cpu);
108 return TRACE_TYPE_PARTIAL_LINE;
110 return TRACE_TYPE_HANDLED;
113 #define TRACE_GRAPH_PROCINFO_LENGTH 14
115 static enum print_line_t
116 print_graph_proc(struct trace_seq *s, pid_t pid)
123 /* sign + log10(MAX_INT) + '\0' */
126 strncpy(comm, trace_find_cmdline(pid), 7);
128 sprintf(pid_str, "%d", pid);
130 /* 1 stands for the "-" character */
131 len = strlen(comm) + strlen(pid_str) + 1;
133 if (len < TRACE_GRAPH_PROCINFO_LENGTH)
134 spaces = TRACE_GRAPH_PROCINFO_LENGTH - len;
136 /* First spaces to align center */
137 for (i = 0; i < spaces / 2; i++) {
138 ret = trace_seq_printf(s, " ");
140 return TRACE_TYPE_PARTIAL_LINE;
143 ret = trace_seq_printf(s, "%s-%s", comm, pid_str);
145 return TRACE_TYPE_PARTIAL_LINE;
147 /* Last spaces to align center */
148 for (i = 0; i < spaces - (spaces / 2); i++) {
149 ret = trace_seq_printf(s, " ");
151 return TRACE_TYPE_PARTIAL_LINE;
153 return TRACE_TYPE_HANDLED;
157 /* If the pid changed since the last trace, output this event */
158 static enum print_line_t
159 verif_pid(struct trace_seq *s, pid_t pid, int cpu, pid_t *last_pids_cpu)
166 return TRACE_TYPE_HANDLED;
168 last_pid = per_cpu_ptr(last_pids_cpu, cpu);
170 if (*last_pid == pid)
171 return TRACE_TYPE_HANDLED;
173 prev_pid = *last_pid;
177 return TRACE_TYPE_HANDLED;
179 * Context-switch trace line:
181 ------------------------------------------
182 | 1) migration/0--1 => sshd-1755
183 ------------------------------------------
186 ret = trace_seq_printf(s,
187 " ------------------------------------------\n");
189 TRACE_TYPE_PARTIAL_LINE;
191 ret = print_graph_cpu(s, cpu);
192 if (ret == TRACE_TYPE_PARTIAL_LINE)
193 TRACE_TYPE_PARTIAL_LINE;
195 ret = print_graph_proc(s, prev_pid);
196 if (ret == TRACE_TYPE_PARTIAL_LINE)
197 TRACE_TYPE_PARTIAL_LINE;
199 ret = trace_seq_printf(s, " => ");
201 TRACE_TYPE_PARTIAL_LINE;
203 ret = print_graph_proc(s, pid);
204 if (ret == TRACE_TYPE_PARTIAL_LINE)
205 TRACE_TYPE_PARTIAL_LINE;
207 ret = trace_seq_printf(s,
208 "\n ------------------------------------------\n\n");
210 TRACE_TYPE_PARTIAL_LINE;
216 trace_branch_is_leaf(struct trace_iterator *iter,
217 struct ftrace_graph_ent_entry *curr)
219 struct ring_buffer_iter *ring_iter;
220 struct ring_buffer_event *event;
221 struct ftrace_graph_ret_entry *next;
223 ring_iter = iter->buffer_iter[iter->cpu];
228 event = ring_buffer_iter_peek(ring_iter, NULL);
233 next = ring_buffer_event_data(event);
235 if (next->ent.type != TRACE_GRAPH_RET)
238 if (curr->ent.pid != next->ent.pid ||
239 curr->graph_ent.func != next->ret.func)
245 /* Signal a overhead of time execution to the output */
247 print_graph_overhead(unsigned long long duration, struct trace_seq *s)
249 /* If duration disappear, we don't need anything */
250 if (!(tracer_flags.val & TRACE_GRAPH_PRINT_DURATION))
253 /* Non nested entry or return */
255 return trace_seq_printf(s, " ");
257 if (tracer_flags.val & TRACE_GRAPH_PRINT_OVERHEAD) {
258 /* Duration exceeded 100 msecs */
259 if (duration > 100000ULL)
260 return trace_seq_printf(s, "! ");
262 /* Duration exceeded 10 msecs */
263 if (duration > 10000ULL)
264 return trace_seq_printf(s, "+ ");
267 return trace_seq_printf(s, " ");
270 static enum print_line_t
271 print_graph_irq(struct trace_seq *s, unsigned long addr,
272 enum trace_type type, int cpu, pid_t pid)
276 if (addr < (unsigned long)__irqentry_text_start ||
277 addr >= (unsigned long)__irqentry_text_end)
278 return TRACE_TYPE_UNHANDLED;
281 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU) {
282 ret = print_graph_cpu(s, cpu);
283 if (ret == TRACE_TYPE_PARTIAL_LINE)
284 return TRACE_TYPE_PARTIAL_LINE;
287 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC) {
288 ret = print_graph_proc(s, pid);
289 if (ret == TRACE_TYPE_PARTIAL_LINE)
290 return TRACE_TYPE_PARTIAL_LINE;
291 ret = trace_seq_printf(s, " | ");
293 return TRACE_TYPE_PARTIAL_LINE;
297 ret = print_graph_overhead(-1, s);
299 return TRACE_TYPE_PARTIAL_LINE;
301 if (type == TRACE_GRAPH_ENT)
302 ret = trace_seq_printf(s, "==========>");
304 ret = trace_seq_printf(s, "<==========");
307 return TRACE_TYPE_PARTIAL_LINE;
309 /* Don't close the duration column if haven't one */
310 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION)
311 trace_seq_printf(s, " |");
312 ret = trace_seq_printf(s, "\n");
315 return TRACE_TYPE_PARTIAL_LINE;
316 return TRACE_TYPE_HANDLED;
319 static enum print_line_t
320 print_graph_duration(unsigned long long duration, struct trace_seq *s)
322 unsigned long nsecs_rem = do_div(duration, 1000);
323 /* log10(ULONG_MAX) + '\0' */
329 sprintf(msecs_str, "%lu", (unsigned long) duration);
332 ret = trace_seq_printf(s, "%s", msecs_str);
334 return TRACE_TYPE_PARTIAL_LINE;
336 len = strlen(msecs_str);
338 /* Print nsecs (we don't want to exceed 7 numbers) */
340 snprintf(nsecs_str, 8 - len, "%03lu", nsecs_rem);
341 ret = trace_seq_printf(s, ".%s", nsecs_str);
343 return TRACE_TYPE_PARTIAL_LINE;
344 len += strlen(nsecs_str);
347 ret = trace_seq_printf(s, " us ");
349 return TRACE_TYPE_PARTIAL_LINE;
351 /* Print remaining spaces to fit the row's width */
352 for (i = len; i < 7; i++) {
353 ret = trace_seq_printf(s, " ");
355 return TRACE_TYPE_PARTIAL_LINE;
358 ret = trace_seq_printf(s, "| ");
360 return TRACE_TYPE_PARTIAL_LINE;
361 return TRACE_TYPE_HANDLED;
365 static int print_graph_abs_time(u64 t, struct trace_seq *s)
367 unsigned long usecs_rem;
369 usecs_rem = do_div(t, 1000000000);
372 return trace_seq_printf(s, "%5lu.%06lu | ",
373 (unsigned long)t, usecs_rem);
376 /* Case of a leaf function on its call entry */
377 static enum print_line_t
378 print_graph_entry_leaf(struct trace_iterator *iter,
379 struct ftrace_graph_ent_entry *entry, struct trace_seq *s)
381 struct ftrace_graph_ret_entry *ret_entry;
382 struct ftrace_graph_ret *graph_ret;
383 struct ring_buffer_event *event;
384 struct ftrace_graph_ent *call;
385 unsigned long long duration;
389 event = ring_buffer_read(iter->buffer_iter[iter->cpu], NULL);
390 ret_entry = ring_buffer_event_data(event);
391 graph_ret = &ret_entry->ret;
392 call = &entry->graph_ent;
393 duration = graph_ret->rettime - graph_ret->calltime;
396 ret = print_graph_overhead(duration, s);
398 return TRACE_TYPE_PARTIAL_LINE;
401 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION) {
402 ret = print_graph_duration(duration, s);
403 if (ret == TRACE_TYPE_PARTIAL_LINE)
404 return TRACE_TYPE_PARTIAL_LINE;
408 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++) {
409 ret = trace_seq_printf(s, " ");
411 return TRACE_TYPE_PARTIAL_LINE;
414 ret = seq_print_ip_sym(s, call->func, 0);
416 return TRACE_TYPE_PARTIAL_LINE;
418 ret = trace_seq_printf(s, "();\n");
420 return TRACE_TYPE_PARTIAL_LINE;
422 return TRACE_TYPE_HANDLED;
425 static enum print_line_t
426 print_graph_entry_nested(struct ftrace_graph_ent_entry *entry,
427 struct trace_seq *s, pid_t pid, int cpu)
431 struct ftrace_graph_ent *call = &entry->graph_ent;
434 ret = print_graph_overhead(-1, s);
436 return TRACE_TYPE_PARTIAL_LINE;
439 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION) {
440 ret = trace_seq_printf(s, " | ");
442 return TRACE_TYPE_PARTIAL_LINE;
446 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++) {
447 ret = trace_seq_printf(s, " ");
449 return TRACE_TYPE_PARTIAL_LINE;
452 ret = seq_print_ip_sym(s, call->func, 0);
454 return TRACE_TYPE_PARTIAL_LINE;
456 ret = trace_seq_printf(s, "() {\n");
458 return TRACE_TYPE_PARTIAL_LINE;
460 return TRACE_TYPE_HANDLED;
463 static enum print_line_t
464 print_graph_entry(struct ftrace_graph_ent_entry *field, struct trace_seq *s,
465 struct trace_iterator *iter)
469 pid_t *last_entry = iter->private;
470 struct trace_entry *ent = iter->ent;
471 struct ftrace_graph_ent *call = &field->graph_ent;
474 if (verif_pid(s, ent->pid, cpu, last_entry) == TRACE_TYPE_PARTIAL_LINE)
475 return TRACE_TYPE_PARTIAL_LINE;
478 ret = print_graph_irq(s, call->func, TRACE_GRAPH_ENT, cpu, ent->pid);
479 if (ret == TRACE_TYPE_PARTIAL_LINE)
480 return TRACE_TYPE_PARTIAL_LINE;
483 if (tracer_flags.val & TRACE_GRAPH_PRINT_ABS_TIME) {
484 ret = print_graph_abs_time(iter->ts, s);
486 return TRACE_TYPE_PARTIAL_LINE;
490 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU) {
491 ret = print_graph_cpu(s, cpu);
492 if (ret == TRACE_TYPE_PARTIAL_LINE)
493 return TRACE_TYPE_PARTIAL_LINE;
497 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC) {
498 ret = print_graph_proc(s, ent->pid);
499 if (ret == TRACE_TYPE_PARTIAL_LINE)
500 return TRACE_TYPE_PARTIAL_LINE;
502 ret = trace_seq_printf(s, " | ");
504 return TRACE_TYPE_PARTIAL_LINE;
507 if (trace_branch_is_leaf(iter, field))
508 return print_graph_entry_leaf(iter, field, s);
510 return print_graph_entry_nested(field, s, iter->ent->pid, cpu);
514 static enum print_line_t
515 print_graph_return(struct ftrace_graph_ret *trace, struct trace_seq *s,
516 struct trace_entry *ent, struct trace_iterator *iter)
521 pid_t *last_pid = iter->private;
522 unsigned long long duration = trace->rettime - trace->calltime;
525 if (verif_pid(s, ent->pid, cpu, last_pid) == TRACE_TYPE_PARTIAL_LINE)
526 return TRACE_TYPE_PARTIAL_LINE;
529 if (tracer_flags.val & TRACE_GRAPH_PRINT_ABS_TIME) {
530 ret = print_graph_abs_time(iter->ts, s);
532 return TRACE_TYPE_PARTIAL_LINE;
536 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU) {
537 ret = print_graph_cpu(s, cpu);
538 if (ret == TRACE_TYPE_PARTIAL_LINE)
539 return TRACE_TYPE_PARTIAL_LINE;
543 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC) {
544 ret = print_graph_proc(s, ent->pid);
545 if (ret == TRACE_TYPE_PARTIAL_LINE)
546 return TRACE_TYPE_PARTIAL_LINE;
548 ret = trace_seq_printf(s, " | ");
550 return TRACE_TYPE_PARTIAL_LINE;
554 ret = print_graph_overhead(duration, s);
556 return TRACE_TYPE_PARTIAL_LINE;
559 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION) {
560 ret = print_graph_duration(duration, s);
561 if (ret == TRACE_TYPE_PARTIAL_LINE)
562 return TRACE_TYPE_PARTIAL_LINE;
566 for (i = 0; i < trace->depth * TRACE_GRAPH_INDENT; i++) {
567 ret = trace_seq_printf(s, " ");
569 return TRACE_TYPE_PARTIAL_LINE;
572 ret = trace_seq_printf(s, "}\n");
574 return TRACE_TYPE_PARTIAL_LINE;
577 if (tracer_flags.val & TRACE_GRAPH_PRINT_OVERRUN) {
578 ret = trace_seq_printf(s, " (Overruns: %lu)\n",
581 return TRACE_TYPE_PARTIAL_LINE;
584 ret = print_graph_irq(s, trace->func, TRACE_GRAPH_RET, cpu, ent->pid);
585 if (ret == TRACE_TYPE_PARTIAL_LINE)
586 return TRACE_TYPE_PARTIAL_LINE;
588 return TRACE_TYPE_HANDLED;
591 static enum print_line_t
592 print_graph_comment(struct print_entry *trace, struct trace_seq *s,
593 struct trace_entry *ent, struct trace_iterator *iter)
598 pid_t *last_pid = iter->private;
601 if (tracer_flags.val & TRACE_GRAPH_PRINT_ABS_TIME) {
602 ret = print_graph_abs_time(iter->ts, s);
604 return TRACE_TYPE_PARTIAL_LINE;
608 if (verif_pid(s, ent->pid, cpu, last_pid) == TRACE_TYPE_PARTIAL_LINE)
609 return TRACE_TYPE_PARTIAL_LINE;
612 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU) {
613 ret = print_graph_cpu(s, cpu);
614 if (ret == TRACE_TYPE_PARTIAL_LINE)
615 return TRACE_TYPE_PARTIAL_LINE;
619 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC) {
620 ret = print_graph_proc(s, ent->pid);
621 if (ret == TRACE_TYPE_PARTIAL_LINE)
622 return TRACE_TYPE_PARTIAL_LINE;
624 ret = trace_seq_printf(s, " | ");
626 return TRACE_TYPE_PARTIAL_LINE;
630 ret = print_graph_overhead(-1, s);
632 return TRACE_TYPE_PARTIAL_LINE;
635 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION) {
636 ret = trace_seq_printf(s, " | ");
638 return TRACE_TYPE_PARTIAL_LINE;
642 if (trace->depth > 0)
643 for (i = 0; i < (trace->depth + 1) * TRACE_GRAPH_INDENT; i++) {
644 ret = trace_seq_printf(s, " ");
646 return TRACE_TYPE_PARTIAL_LINE;
650 ret = trace_seq_printf(s, "/* %s", trace->buf);
652 return TRACE_TYPE_PARTIAL_LINE;
654 /* Strip ending newline */
655 if (s->buffer[s->len - 1] == '\n') {
656 s->buffer[s->len - 1] = '\0';
660 ret = trace_seq_printf(s, " */\n");
662 return TRACE_TYPE_PARTIAL_LINE;
664 return TRACE_TYPE_HANDLED;
669 print_graph_function(struct trace_iterator *iter)
671 struct trace_seq *s = &iter->seq;
672 struct trace_entry *entry = iter->ent;
674 switch (entry->type) {
675 case TRACE_GRAPH_ENT: {
676 struct ftrace_graph_ent_entry *field;
677 trace_assign_type(field, entry);
678 return print_graph_entry(field, s, iter);
680 case TRACE_GRAPH_RET: {
681 struct ftrace_graph_ret_entry *field;
682 trace_assign_type(field, entry);
683 return print_graph_return(&field->ret, s, entry, iter);
686 struct print_entry *field;
687 trace_assign_type(field, entry);
688 return print_graph_comment(field, s, entry, iter);
691 return TRACE_TYPE_UNHANDLED;
695 static void print_graph_headers(struct seq_file *s)
699 if (tracer_flags.val & TRACE_GRAPH_PRINT_ABS_TIME)
700 seq_printf(s, " TIME ");
701 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU)
702 seq_printf(s, "CPU");
703 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC)
704 seq_printf(s, " TASK/PID ");
705 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION)
706 seq_printf(s, " DURATION ");
707 seq_printf(s, " FUNCTION CALLS\n");
711 if (tracer_flags.val & TRACE_GRAPH_PRINT_ABS_TIME)
712 seq_printf(s, " | ");
713 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU)
715 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC)
716 seq_printf(s, " | | ");
717 if (tracer_flags.val & TRACE_GRAPH_PRINT_DURATION)
718 seq_printf(s, " | | ");
719 seq_printf(s, " | | | |\n");
722 static void graph_trace_open(struct trace_iterator *iter)
724 /* pid on the last trace processed */
725 pid_t *last_pid = alloc_percpu(pid_t);
729 pr_warning("function graph tracer: not enough memory\n");
731 for_each_possible_cpu(cpu) {
732 pid_t *pid = per_cpu_ptr(last_pid, cpu);
736 iter->private = last_pid;
739 static void graph_trace_close(struct trace_iterator *iter)
741 percpu_free(iter->private);
744 static struct tracer graph_trace __read_mostly = {
745 .name = "function_graph",
746 .open = graph_trace_open,
747 .close = graph_trace_close,
748 .init = graph_trace_init,
749 .reset = graph_trace_reset,
750 .print_line = print_graph_function,
751 .print_header = print_graph_headers,
752 .flags = &tracer_flags,
755 static __init int init_graph_trace(void)
757 return register_tracer(&graph_trace);
760 device_initcall(init_graph_trace);