3 * Function graph tracer.
4 * Copyright (c) 2008 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>
16 #define TRACE_GRAPH_INDENT 2
19 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
20 #define TRACE_GRAPH_PRINT_CPU 0x2
21 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
22 #define TRACE_GRAPH_PRINT_PROC 0x8
24 static struct tracer_opt trace_opts[] = {
25 /* Display overruns ? */
26 { TRACER_OPT(funcgraph-overrun, TRACE_GRAPH_PRINT_OVERRUN) },
28 { TRACER_OPT(funcgraph-cpu, TRACE_GRAPH_PRINT_CPU) },
29 /* Display Overhead ? */
30 { TRACER_OPT(funcgraph-overhead, TRACE_GRAPH_PRINT_OVERHEAD) },
31 /* Display proc name/pid */
32 { TRACER_OPT(funcgraph-proc, TRACE_GRAPH_PRINT_PROC) },
36 static struct tracer_flags tracer_flags = {
37 /* Don't display overruns and proc by default */
38 .val = TRACE_GRAPH_PRINT_CPU | TRACE_GRAPH_PRINT_OVERHEAD,
42 /* pid on the last trace processed */
43 static pid_t last_pid[NR_CPUS] = { [0 ... NR_CPUS-1] = -1 };
45 static int graph_trace_init(struct trace_array *tr)
49 for_each_online_cpu(cpu)
50 tracing_reset(tr, cpu);
52 ret = register_ftrace_graph(&trace_graph_return,
56 tracing_start_cmdline_record();
61 static void graph_trace_reset(struct trace_array *tr)
63 tracing_stop_cmdline_record();
64 unregister_ftrace_graph();
67 static inline int log10_cpu(int nb)
76 static enum print_line_t
77 print_graph_cpu(struct trace_seq *s, int cpu)
81 int log10_this = log10_cpu(cpu);
82 int log10_all = log10_cpu(cpus_weight_nr(cpu_online_map));
86 * Start with a space character - to make it stand out
87 * to the right a bit when trace output is pasted into
90 ret = trace_seq_printf(s, " ");
93 * Tricky - we space the CPU field according to the max
94 * number of online CPUs. On a 2-cpu system it would take
95 * a maximum of 1 digit - on a 128 cpu system it would
96 * take up to 3 digits:
98 for (i = 0; i < log10_all - log10_this; i++) {
99 ret = trace_seq_printf(s, " ");
101 return TRACE_TYPE_PARTIAL_LINE;
103 ret = trace_seq_printf(s, "%d) ", cpu);
105 return TRACE_TYPE_PARTIAL_LINE;
107 return TRACE_TYPE_HANDLED;
110 #define TRACE_GRAPH_PROCINFO_LENGTH 14
112 static enum print_line_t
113 print_graph_proc(struct trace_seq *s, pid_t pid)
120 /* sign + log10(MAX_INT) + '\0' */
123 strncpy(comm, trace_find_cmdline(pid), 7);
125 sprintf(pid_str, "%d", pid);
127 /* 1 stands for the "-" character */
128 len = strlen(comm) + strlen(pid_str) + 1;
130 if (len < TRACE_GRAPH_PROCINFO_LENGTH)
131 spaces = TRACE_GRAPH_PROCINFO_LENGTH - len;
133 /* First spaces to align center */
134 for (i = 0; i < spaces / 2; i++) {
135 ret = trace_seq_printf(s, " ");
137 return TRACE_TYPE_PARTIAL_LINE;
140 ret = trace_seq_printf(s, "%s-%s", comm, pid_str);
142 return TRACE_TYPE_PARTIAL_LINE;
144 /* Last spaces to align center */
145 for (i = 0; i < spaces - (spaces / 2); i++) {
146 ret = trace_seq_printf(s, " ");
148 return TRACE_TYPE_PARTIAL_LINE;
150 return TRACE_TYPE_HANDLED;
154 /* If the pid changed since the last trace, output this event */
155 static enum print_line_t
156 verif_pid(struct trace_seq *s, pid_t pid, int cpu)
161 if (last_pid[cpu] != -1 && last_pid[cpu] == pid)
162 return TRACE_TYPE_HANDLED;
164 prev_pid = last_pid[cpu];
168 * Context-switch trace line:
170 ------------------------------------------
171 | 1) migration/0--1 => sshd-1755
172 ------------------------------------------
175 ret = trace_seq_printf(s,
176 "\n ------------------------------------------\n |");
178 TRACE_TYPE_PARTIAL_LINE;
180 ret = print_graph_cpu(s, cpu);
181 if (ret == TRACE_TYPE_PARTIAL_LINE)
182 TRACE_TYPE_PARTIAL_LINE;
184 ret = print_graph_proc(s, prev_pid);
185 if (ret == TRACE_TYPE_PARTIAL_LINE)
186 TRACE_TYPE_PARTIAL_LINE;
188 ret = trace_seq_printf(s, " => ");
190 TRACE_TYPE_PARTIAL_LINE;
192 ret = print_graph_proc(s, pid);
193 if (ret == TRACE_TYPE_PARTIAL_LINE)
194 TRACE_TYPE_PARTIAL_LINE;
196 ret = trace_seq_printf(s,
197 "\n ------------------------------------------\n\n");
199 TRACE_TYPE_PARTIAL_LINE;
205 trace_branch_is_leaf(struct trace_iterator *iter,
206 struct ftrace_graph_ent_entry *curr)
208 struct ring_buffer_iter *ring_iter;
209 struct ring_buffer_event *event;
210 struct ftrace_graph_ret_entry *next;
212 ring_iter = iter->buffer_iter[iter->cpu];
217 event = ring_buffer_iter_peek(ring_iter, NULL);
222 next = ring_buffer_event_data(event);
224 if (next->ent.type != TRACE_GRAPH_RET)
227 if (curr->ent.pid != next->ent.pid ||
228 curr->graph_ent.func != next->ret.func)
236 print_graph_duration(unsigned long long duration, struct trace_seq *s)
238 unsigned long nsecs_rem = do_div(duration, 1000);
239 return trace_seq_printf(s, "%4llu.%3lu us | ", duration, nsecs_rem);
242 /* Signal a overhead of time execution to the output */
244 print_graph_overhead(unsigned long long duration, struct trace_seq *s)
246 /* Duration exceeded 100 msecs */
247 if (duration > 100000ULL)
248 return trace_seq_printf(s, "! ");
250 /* Duration exceeded 10 msecs */
251 if (duration > 10000ULL)
252 return trace_seq_printf(s, "+ ");
254 return trace_seq_printf(s, " ");
257 /* Case of a leaf function on its call entry */
258 static enum print_line_t
259 print_graph_entry_leaf(struct trace_iterator *iter,
260 struct ftrace_graph_ent_entry *entry, struct trace_seq *s)
262 struct ftrace_graph_ret_entry *ret_entry;
263 struct ftrace_graph_ret *graph_ret;
264 struct ring_buffer_event *event;
265 struct ftrace_graph_ent *call;
266 unsigned long long duration;
270 event = ring_buffer_read(iter->buffer_iter[iter->cpu], NULL);
271 ret_entry = ring_buffer_event_data(event);
272 graph_ret = &ret_entry->ret;
273 call = &entry->graph_ent;
274 duration = graph_ret->rettime - graph_ret->calltime;
276 /* Must not exceed 8 characters: 9999.999 us */
277 if (duration > 10000000ULL)
278 duration = 9999999ULL;
281 if (tracer_flags.val & TRACE_GRAPH_PRINT_OVERHEAD) {
282 ret = print_graph_overhead(duration, s);
284 return TRACE_TYPE_PARTIAL_LINE;
288 ret = print_graph_duration(duration, s);
290 return TRACE_TYPE_PARTIAL_LINE;
293 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++) {
294 ret = trace_seq_printf(s, " ");
296 return TRACE_TYPE_PARTIAL_LINE;
299 ret = seq_print_ip_sym(s, call->func, 0);
301 return TRACE_TYPE_PARTIAL_LINE;
303 ret = trace_seq_printf(s, "();\n");
305 return TRACE_TYPE_PARTIAL_LINE;
307 return TRACE_TYPE_HANDLED;
310 static enum print_line_t
311 print_graph_entry_nested(struct ftrace_graph_ent_entry *entry,
316 struct ftrace_graph_ent *call = &entry->graph_ent;
319 if (tracer_flags.val & TRACE_GRAPH_PRINT_OVERHEAD) {
320 ret = trace_seq_printf(s, " ");
322 return TRACE_TYPE_PARTIAL_LINE;
326 ret = trace_seq_printf(s, " | ");
329 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++) {
330 ret = trace_seq_printf(s, " ");
332 return TRACE_TYPE_PARTIAL_LINE;
335 ret = seq_print_ip_sym(s, call->func, 0);
337 return TRACE_TYPE_PARTIAL_LINE;
339 ret = trace_seq_printf(s, "() {\n");
341 return TRACE_TYPE_PARTIAL_LINE;
343 return TRACE_TYPE_HANDLED;
346 static enum print_line_t
347 print_graph_entry(struct ftrace_graph_ent_entry *field, struct trace_seq *s,
348 struct trace_iterator *iter, int cpu)
351 struct trace_entry *ent = iter->ent;
354 if (verif_pid(s, ent->pid, cpu) == TRACE_TYPE_PARTIAL_LINE)
355 return TRACE_TYPE_PARTIAL_LINE;
358 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU) {
359 ret = print_graph_cpu(s, cpu);
360 if (ret == TRACE_TYPE_PARTIAL_LINE)
361 return TRACE_TYPE_PARTIAL_LINE;
365 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC) {
366 ret = print_graph_proc(s, ent->pid);
367 if (ret == TRACE_TYPE_PARTIAL_LINE)
368 return TRACE_TYPE_PARTIAL_LINE;
370 ret = trace_seq_printf(s, " | ");
372 return TRACE_TYPE_PARTIAL_LINE;
375 if (trace_branch_is_leaf(iter, field))
376 return print_graph_entry_leaf(iter, field, s);
378 return print_graph_entry_nested(field, s);
382 static enum print_line_t
383 print_graph_return(struct ftrace_graph_ret *trace, struct trace_seq *s,
384 struct trace_entry *ent, int cpu)
388 unsigned long long duration = trace->rettime - trace->calltime;
390 /* Must not exceed 8 characters: xxxx.yyy us */
391 if (duration > 10000000ULL)
392 duration = 9999999ULL;
395 if (verif_pid(s, ent->pid, cpu) == TRACE_TYPE_PARTIAL_LINE)
396 return TRACE_TYPE_PARTIAL_LINE;
399 if (tracer_flags.val & TRACE_GRAPH_PRINT_CPU) {
400 ret = print_graph_cpu(s, cpu);
401 if (ret == TRACE_TYPE_PARTIAL_LINE)
402 return TRACE_TYPE_PARTIAL_LINE;
406 if (tracer_flags.val & TRACE_GRAPH_PRINT_PROC) {
407 ret = print_graph_proc(s, ent->pid);
408 if (ret == TRACE_TYPE_PARTIAL_LINE)
409 return TRACE_TYPE_PARTIAL_LINE;
411 ret = trace_seq_printf(s, " | ");
413 return TRACE_TYPE_PARTIAL_LINE;
417 if (tracer_flags.val & TRACE_GRAPH_PRINT_OVERHEAD) {
418 ret = print_graph_overhead(duration, s);
420 return TRACE_TYPE_PARTIAL_LINE;
424 ret = print_graph_duration(duration, s);
426 return TRACE_TYPE_PARTIAL_LINE;
429 for (i = 0; i < trace->depth * TRACE_GRAPH_INDENT; i++) {
430 ret = trace_seq_printf(s, " ");
432 return TRACE_TYPE_PARTIAL_LINE;
435 ret = trace_seq_printf(s, "}\n");
437 return TRACE_TYPE_PARTIAL_LINE;
440 if (tracer_flags.val & TRACE_GRAPH_PRINT_OVERRUN) {
441 ret = trace_seq_printf(s, " (Overruns: %lu)\n",
444 return TRACE_TYPE_PARTIAL_LINE;
446 return TRACE_TYPE_HANDLED;
450 print_graph_function(struct trace_iterator *iter)
452 struct trace_seq *s = &iter->seq;
453 struct trace_entry *entry = iter->ent;
455 switch (entry->type) {
456 case TRACE_GRAPH_ENT: {
457 struct ftrace_graph_ent_entry *field;
458 trace_assign_type(field, entry);
459 return print_graph_entry(field, s, iter,
462 case TRACE_GRAPH_RET: {
463 struct ftrace_graph_ret_entry *field;
464 trace_assign_type(field, entry);
465 return print_graph_return(&field->ret, s, entry, iter->cpu);
468 return TRACE_TYPE_UNHANDLED;
472 static struct tracer graph_trace __read_mostly = {
473 .name = "function_graph",
474 .init = graph_trace_init,
475 .reset = graph_trace_reset,
476 .print_line = print_graph_function,
477 .flags = &tracer_flags,
480 static __init int init_graph_trace(void)
482 return register_tracer(&graph_trace);
485 device_initcall(init_graph_trace);