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/uaccess.h>
10 #include <linux/ftrace.h>
11 #include <linux/interrupt.h>
12 #include <linux/slab.h>
16 #include "trace_output.h"
18 static bool kill_ftrace_graph;
21 * ftrace_graph_is_dead - returns true if ftrace_graph_stop() was called
23 * ftrace_graph_stop() is called when a severe error is detected in
24 * the function graph tracing. This function is called by the critical
25 * paths of function graph to keep those paths from doing any more harm.
27 bool ftrace_graph_is_dead(void)
29 return kill_ftrace_graph;
33 * ftrace_graph_stop - set to permanently disable function graph tracincg
35 * In case of an error int function graph tracing, this is called
36 * to try to keep function graph tracing from causing any more harm.
37 * Usually this is pretty severe and this is called to try to at least
38 * get a warning out to the user.
40 void ftrace_graph_stop(void)
42 kill_ftrace_graph = true;
45 /* When set, irq functions will be ignored */
46 static int ftrace_graph_skip_irqs;
48 struct fgraph_cpu_data {
53 unsigned long enter_funcs[FTRACE_RETFUNC_DEPTH];
57 struct fgraph_cpu_data __percpu *cpu_data;
59 /* Place to preserve last processed entry. */
60 struct ftrace_graph_ent_entry ent;
61 struct ftrace_graph_ret_entry ret;
66 #define TRACE_GRAPH_INDENT 2
68 static unsigned int max_depth;
70 static struct tracer_opt trace_opts[] = {
71 /* Display overruns? (for self-debug purpose) */
72 { TRACER_OPT(funcgraph-overrun, TRACE_GRAPH_PRINT_OVERRUN) },
74 { TRACER_OPT(funcgraph-cpu, TRACE_GRAPH_PRINT_CPU) },
75 /* Display Overhead ? */
76 { TRACER_OPT(funcgraph-overhead, TRACE_GRAPH_PRINT_OVERHEAD) },
77 /* Display proc name/pid */
78 { TRACER_OPT(funcgraph-proc, TRACE_GRAPH_PRINT_PROC) },
79 /* Display duration of execution */
80 { TRACER_OPT(funcgraph-duration, TRACE_GRAPH_PRINT_DURATION) },
81 /* Display absolute time of an entry */
82 { TRACER_OPT(funcgraph-abstime, TRACE_GRAPH_PRINT_ABS_TIME) },
83 /* Display interrupts */
84 { TRACER_OPT(funcgraph-irqs, TRACE_GRAPH_PRINT_IRQS) },
85 /* Display function name after trailing } */
86 { TRACER_OPT(funcgraph-tail, TRACE_GRAPH_PRINT_TAIL) },
87 /* Include sleep time (scheduled out) between entry and return */
88 { TRACER_OPT(sleep-time, TRACE_GRAPH_SLEEP_TIME) },
89 /* Include time within nested functions */
90 { TRACER_OPT(graph-time, TRACE_GRAPH_GRAPH_TIME) },
94 static struct tracer_flags tracer_flags = {
95 /* Don't display overruns, proc, or tail by default */
96 .val = TRACE_GRAPH_PRINT_CPU | TRACE_GRAPH_PRINT_OVERHEAD |
97 TRACE_GRAPH_PRINT_DURATION | TRACE_GRAPH_PRINT_IRQS |
98 TRACE_GRAPH_SLEEP_TIME | TRACE_GRAPH_GRAPH_TIME,
102 static struct trace_array *graph_array;
105 * DURATION column is being also used to display IRQ signs,
106 * following values are used by print_graph_irq and others
107 * to fill in space into DURATION column.
110 FLAGS_FILL_FULL = 1 << TRACE_GRAPH_PRINT_FILL_SHIFT,
111 FLAGS_FILL_START = 2 << TRACE_GRAPH_PRINT_FILL_SHIFT,
112 FLAGS_FILL_END = 3 << TRACE_GRAPH_PRINT_FILL_SHIFT,
116 print_graph_duration(struct trace_array *tr, unsigned long long duration,
117 struct trace_seq *s, u32 flags);
119 /* Add a function return address to the trace stack on thread info.*/
121 ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
122 unsigned long frame_pointer, unsigned long *retp)
124 unsigned long long calltime;
127 if (unlikely(ftrace_graph_is_dead()))
130 if (!current->ret_stack)
134 * We must make sure the ret_stack is tested before we read
139 /* The return trace stack is full */
140 if (current->curr_ret_stack == FTRACE_RETFUNC_DEPTH - 1) {
141 atomic_inc(¤t->trace_overrun);
146 * The curr_ret_stack is an index to ftrace return stack of
147 * current task. Its value should be in [0, FTRACE_RETFUNC_
148 * DEPTH) when the function graph tracer is used. To support
149 * filtering out specific functions, it makes the index
150 * negative by subtracting huge value (FTRACE_NOTRACE_DEPTH)
151 * so when it sees a negative index the ftrace will ignore
152 * the record. And the index gets recovered when returning
153 * from the filtered function by adding the FTRACE_NOTRACE_
154 * DEPTH and then it'll continue to record functions normally.
156 * The curr_ret_stack is initialized to -1 and get increased
157 * in this function. So it can be less than -1 only if it was
158 * filtered out via ftrace_graph_notrace_addr() which can be
159 * set from set_graph_notrace file in tracefs by user.
161 if (current->curr_ret_stack < -1)
164 calltime = trace_clock_local();
166 index = ++current->curr_ret_stack;
167 if (ftrace_graph_notrace_addr(func))
168 current->curr_ret_stack -= FTRACE_NOTRACE_DEPTH;
170 current->ret_stack[index].ret = ret;
171 current->ret_stack[index].func = func;
172 current->ret_stack[index].calltime = calltime;
173 #ifdef HAVE_FUNCTION_GRAPH_FP_TEST
174 current->ret_stack[index].fp = frame_pointer;
176 #ifdef HAVE_FUNCTION_GRAPH_RET_ADDR_PTR
177 current->ret_stack[index].retp = retp;
179 *depth = current->curr_ret_stack;
184 /* Retrieve a function return address to the trace stack on thread info.*/
186 ftrace_pop_return_trace(struct ftrace_graph_ret *trace, unsigned long *ret,
187 unsigned long frame_pointer)
191 index = current->curr_ret_stack;
194 * A negative index here means that it's just returned from a
195 * notrace'd function. Recover index to get an original
196 * return address. See ftrace_push_return_trace().
198 * TODO: Need to check whether the stack gets corrupted.
201 index += FTRACE_NOTRACE_DEPTH;
203 if (unlikely(index < 0 || index >= FTRACE_RETFUNC_DEPTH)) {
206 /* Might as well panic, otherwise we have no where to go */
207 *ret = (unsigned long)panic;
211 #ifdef HAVE_FUNCTION_GRAPH_FP_TEST
213 * The arch may choose to record the frame pointer used
214 * and check it here to make sure that it is what we expect it
215 * to be. If gcc does not set the place holder of the return
216 * address in the frame pointer, and does a copy instead, then
217 * the function graph trace will fail. This test detects this
220 * Currently, x86_32 with optimize for size (-Os) makes the latest
223 * Note, -mfentry does not use frame pointers, and this test
224 * is not needed if CC_USING_FENTRY is set.
226 if (unlikely(current->ret_stack[index].fp != frame_pointer)) {
228 WARN(1, "Bad frame pointer: expected %lx, received %lx\n"
229 " from func %ps return to %lx\n",
230 current->ret_stack[index].fp,
232 (void *)current->ret_stack[index].func,
233 current->ret_stack[index].ret);
234 *ret = (unsigned long)panic;
239 *ret = current->ret_stack[index].ret;
240 trace->func = current->ret_stack[index].func;
241 trace->calltime = current->ret_stack[index].calltime;
242 trace->overrun = atomic_read(¤t->trace_overrun);
243 trace->depth = index;
247 * Send the trace to the ring-buffer.
248 * @return the original return address.
250 unsigned long ftrace_return_to_handler(unsigned long frame_pointer)
252 struct ftrace_graph_ret trace;
255 ftrace_pop_return_trace(&trace, &ret, frame_pointer);
256 trace.rettime = trace_clock_local();
258 current->curr_ret_stack--;
260 * The curr_ret_stack can be less than -1 only if it was
261 * filtered out and it's about to return from the function.
262 * Recover the index and continue to trace normal functions.
264 if (current->curr_ret_stack < -1) {
265 current->curr_ret_stack += FTRACE_NOTRACE_DEPTH;
270 * The trace should run after decrementing the ret counter
271 * in case an interrupt were to come in. We don't want to
272 * lose the interrupt if max_depth is set.
274 ftrace_graph_return(&trace);
276 if (unlikely(!ret)) {
279 /* Might as well panic. What else to do? */
280 ret = (unsigned long)panic;
287 * ftrace_graph_ret_addr - convert a potentially modified stack return address
288 * to its original value
290 * This function can be called by stack unwinding code to convert a found stack
291 * return address ('ret') to its original value, in case the function graph
292 * tracer has modified it to be 'return_to_handler'. If the address hasn't
293 * been modified, the unchanged value of 'ret' is returned.
295 * 'idx' is a state variable which should be initialized by the caller to zero
296 * before the first call.
298 * 'retp' is a pointer to the return address on the stack. It's ignored if
299 * the arch doesn't have HAVE_FUNCTION_GRAPH_RET_ADDR_PTR defined.
301 #ifdef HAVE_FUNCTION_GRAPH_RET_ADDR_PTR
302 unsigned long ftrace_graph_ret_addr(struct task_struct *task, int *idx,
303 unsigned long ret, unsigned long *retp)
305 int index = task->curr_ret_stack;
308 if (ret != (unsigned long)return_to_handler)
312 index += FTRACE_NOTRACE_DEPTH;
317 for (i = 0; i <= index; i++)
318 if (task->ret_stack[i].retp == retp)
319 return task->ret_stack[i].ret;
323 #else /* !HAVE_FUNCTION_GRAPH_RET_ADDR_PTR */
324 unsigned long ftrace_graph_ret_addr(struct task_struct *task, int *idx,
325 unsigned long ret, unsigned long *retp)
329 if (ret != (unsigned long)return_to_handler)
332 task_idx = task->curr_ret_stack;
334 if (!task->ret_stack || task_idx < *idx)
340 return task->ret_stack[task_idx].ret;
342 #endif /* HAVE_FUNCTION_GRAPH_RET_ADDR_PTR */
344 int __trace_graph_entry(struct trace_array *tr,
345 struct ftrace_graph_ent *trace,
349 struct trace_event_call *call = &event_funcgraph_entry;
350 struct ring_buffer_event *event;
351 struct ring_buffer *buffer = tr->trace_buffer.buffer;
352 struct ftrace_graph_ent_entry *entry;
354 event = trace_buffer_lock_reserve(buffer, TRACE_GRAPH_ENT,
355 sizeof(*entry), flags, pc);
358 entry = ring_buffer_event_data(event);
359 entry->graph_ent = *trace;
360 if (!call_filter_check_discard(call, entry, buffer, event))
361 __buffer_unlock_commit(buffer, event);
366 static inline int ftrace_graph_ignore_irqs(void)
368 if (!ftrace_graph_skip_irqs || trace_recursion_test(TRACE_IRQ_BIT))
374 int trace_graph_entry(struct ftrace_graph_ent *trace)
376 struct trace_array *tr = graph_array;
377 struct trace_array_cpu *data;
384 if (!ftrace_trace_task(tr))
387 /* trace it when it is-nested-in or is a function enabled. */
388 if ((!(trace->depth || ftrace_graph_addr(trace->func)) ||
389 ftrace_graph_ignore_irqs()) || (trace->depth < 0) ||
390 (max_depth && trace->depth >= max_depth))
394 * Do not trace a function if it's filtered by set_graph_notrace.
395 * Make the index of ret stack negative to indicate that it should
396 * ignore further functions. But it needs its own ret stack entry
397 * to recover the original index in order to continue tracing after
398 * returning from the function.
400 if (ftrace_graph_notrace_addr(trace->func))
404 * Stop here if tracing_threshold is set. We only write function return
405 * events to the ring buffer.
410 local_irq_save(flags);
411 cpu = raw_smp_processor_id();
412 data = per_cpu_ptr(tr->trace_buffer.data, cpu);
413 disabled = atomic_inc_return(&data->disabled);
414 if (likely(disabled == 1)) {
415 pc = preempt_count();
416 ret = __trace_graph_entry(tr, trace, flags, pc);
421 atomic_dec(&data->disabled);
422 local_irq_restore(flags);
428 __trace_graph_function(struct trace_array *tr,
429 unsigned long ip, unsigned long flags, int pc)
431 u64 time = trace_clock_local();
432 struct ftrace_graph_ent ent = {
436 struct ftrace_graph_ret ret = {
443 __trace_graph_entry(tr, &ent, flags, pc);
444 __trace_graph_return(tr, &ret, flags, pc);
448 trace_graph_function(struct trace_array *tr,
449 unsigned long ip, unsigned long parent_ip,
450 unsigned long flags, int pc)
452 __trace_graph_function(tr, ip, flags, pc);
455 void __trace_graph_return(struct trace_array *tr,
456 struct ftrace_graph_ret *trace,
460 struct trace_event_call *call = &event_funcgraph_exit;
461 struct ring_buffer_event *event;
462 struct ring_buffer *buffer = tr->trace_buffer.buffer;
463 struct ftrace_graph_ret_entry *entry;
465 event = trace_buffer_lock_reserve(buffer, TRACE_GRAPH_RET,
466 sizeof(*entry), flags, pc);
469 entry = ring_buffer_event_data(event);
471 if (!call_filter_check_discard(call, entry, buffer, event))
472 __buffer_unlock_commit(buffer, event);
475 void trace_graph_return(struct ftrace_graph_ret *trace)
477 struct trace_array *tr = graph_array;
478 struct trace_array_cpu *data;
484 local_irq_save(flags);
485 cpu = raw_smp_processor_id();
486 data = per_cpu_ptr(tr->trace_buffer.data, cpu);
487 disabled = atomic_inc_return(&data->disabled);
488 if (likely(disabled == 1)) {
489 pc = preempt_count();
490 __trace_graph_return(tr, trace, flags, pc);
492 atomic_dec(&data->disabled);
493 local_irq_restore(flags);
496 void set_graph_array(struct trace_array *tr)
500 /* Make graph_array visible before we start tracing */
505 static void trace_graph_thresh_return(struct ftrace_graph_ret *trace)
507 if (tracing_thresh &&
508 (trace->rettime - trace->calltime < tracing_thresh))
511 trace_graph_return(trace);
514 static int graph_trace_init(struct trace_array *tr)
520 ret = register_ftrace_graph(&trace_graph_thresh_return,
523 ret = register_ftrace_graph(&trace_graph_return,
527 tracing_start_cmdline_record();
532 static void graph_trace_reset(struct trace_array *tr)
534 tracing_stop_cmdline_record();
535 unregister_ftrace_graph();
538 static int graph_trace_update_thresh(struct trace_array *tr)
540 graph_trace_reset(tr);
541 return graph_trace_init(tr);
544 static int max_bytes_for_cpu;
546 static void print_graph_cpu(struct trace_seq *s, int cpu)
549 * Start with a space character - to make it stand out
550 * to the right a bit when trace output is pasted into
553 trace_seq_printf(s, " %*d) ", max_bytes_for_cpu, cpu);
556 #define TRACE_GRAPH_PROCINFO_LENGTH 14
558 static void print_graph_proc(struct trace_seq *s, pid_t pid)
560 char comm[TASK_COMM_LEN];
561 /* sign + log10(MAX_INT) + '\0' */
567 trace_find_cmdline(pid, comm);
569 sprintf(pid_str, "%d", pid);
571 /* 1 stands for the "-" character */
572 len = strlen(comm) + strlen(pid_str) + 1;
574 if (len < TRACE_GRAPH_PROCINFO_LENGTH)
575 spaces = TRACE_GRAPH_PROCINFO_LENGTH - len;
577 /* First spaces to align center */
578 for (i = 0; i < spaces / 2; i++)
579 trace_seq_putc(s, ' ');
581 trace_seq_printf(s, "%s-%s", comm, pid_str);
583 /* Last spaces to align center */
584 for (i = 0; i < spaces - (spaces / 2); i++)
585 trace_seq_putc(s, ' ');
589 static void print_graph_lat_fmt(struct trace_seq *s, struct trace_entry *entry)
591 trace_seq_putc(s, ' ');
592 trace_print_lat_fmt(s, entry);
595 /* If the pid changed since the last trace, output this event */
597 verif_pid(struct trace_seq *s, pid_t pid, int cpu, struct fgraph_data *data)
605 last_pid = &(per_cpu_ptr(data->cpu_data, cpu)->last_pid);
607 if (*last_pid == pid)
610 prev_pid = *last_pid;
616 * Context-switch trace line:
618 ------------------------------------------
619 | 1) migration/0--1 => sshd-1755
620 ------------------------------------------
623 trace_seq_puts(s, " ------------------------------------------\n");
624 print_graph_cpu(s, cpu);
625 print_graph_proc(s, prev_pid);
626 trace_seq_puts(s, " => ");
627 print_graph_proc(s, pid);
628 trace_seq_puts(s, "\n ------------------------------------------\n\n");
631 static struct ftrace_graph_ret_entry *
632 get_return_for_leaf(struct trace_iterator *iter,
633 struct ftrace_graph_ent_entry *curr)
635 struct fgraph_data *data = iter->private;
636 struct ring_buffer_iter *ring_iter = NULL;
637 struct ring_buffer_event *event;
638 struct ftrace_graph_ret_entry *next;
641 * If the previous output failed to write to the seq buffer,
642 * then we just reuse the data from before.
644 if (data && data->failed) {
649 ring_iter = trace_buffer_iter(iter, iter->cpu);
651 /* First peek to compare current entry and the next one */
653 event = ring_buffer_iter_peek(ring_iter, NULL);
656 * We need to consume the current entry to see
659 ring_buffer_consume(iter->trace_buffer->buffer, iter->cpu,
661 event = ring_buffer_peek(iter->trace_buffer->buffer, iter->cpu,
668 next = ring_buffer_event_data(event);
672 * Save current and next entries for later reference
673 * if the output fails.
677 * If the next event is not a return type, then
678 * we only care about what type it is. Otherwise we can
679 * safely copy the entire event.
681 if (next->ent.type == TRACE_GRAPH_RET)
684 data->ret.ent.type = next->ent.type;
688 if (next->ent.type != TRACE_GRAPH_RET)
691 if (curr->ent.pid != next->ent.pid ||
692 curr->graph_ent.func != next->ret.func)
695 /* this is a leaf, now advance the iterator */
697 ring_buffer_read(ring_iter, NULL);
702 static void print_graph_abs_time(u64 t, struct trace_seq *s)
704 unsigned long usecs_rem;
706 usecs_rem = do_div(t, NSEC_PER_SEC);
709 trace_seq_printf(s, "%5lu.%06lu | ",
710 (unsigned long)t, usecs_rem);
714 print_graph_irq(struct trace_iterator *iter, unsigned long addr,
715 enum trace_type type, int cpu, pid_t pid, u32 flags)
717 struct trace_array *tr = iter->tr;
718 struct trace_seq *s = &iter->seq;
719 struct trace_entry *ent = iter->ent;
721 if (addr < (unsigned long)__irqentry_text_start ||
722 addr >= (unsigned long)__irqentry_text_end)
725 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
727 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
728 print_graph_abs_time(iter->ts, s);
731 if (flags & TRACE_GRAPH_PRINT_CPU)
732 print_graph_cpu(s, cpu);
735 if (flags & TRACE_GRAPH_PRINT_PROC) {
736 print_graph_proc(s, pid);
737 trace_seq_puts(s, " | ");
741 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
742 print_graph_lat_fmt(s, ent);
746 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_START);
748 if (type == TRACE_GRAPH_ENT)
749 trace_seq_puts(s, "==========>");
751 trace_seq_puts(s, "<==========");
753 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_END);
754 trace_seq_putc(s, '\n');
758 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s)
760 unsigned long nsecs_rem = do_div(duration, 1000);
761 /* log10(ULONG_MAX) + '\0' */
767 sprintf(usecs_str, "%lu", (unsigned long) duration);
770 trace_seq_printf(s, "%s", usecs_str);
772 len = strlen(usecs_str);
774 /* Print nsecs (we don't want to exceed 7 numbers) */
776 size_t slen = min_t(size_t, sizeof(nsecs_str), 8UL - len);
778 snprintf(nsecs_str, slen, "%03lu", nsecs_rem);
779 trace_seq_printf(s, ".%s", nsecs_str);
780 len += strlen(nsecs_str) + 1;
783 trace_seq_puts(s, " us ");
785 /* Print remaining spaces to fit the row's width */
786 for (i = len; i < 8; i++)
787 trace_seq_putc(s, ' ');
791 print_graph_duration(struct trace_array *tr, unsigned long long duration,
792 struct trace_seq *s, u32 flags)
794 if (!(flags & TRACE_GRAPH_PRINT_DURATION) ||
795 !(tr->trace_flags & TRACE_ITER_CONTEXT_INFO))
798 /* No real adata, just filling the column with spaces */
799 switch (flags & TRACE_GRAPH_PRINT_FILL_MASK) {
800 case FLAGS_FILL_FULL:
801 trace_seq_puts(s, " | ");
803 case FLAGS_FILL_START:
804 trace_seq_puts(s, " ");
807 trace_seq_puts(s, " |");
811 /* Signal a overhead of time execution to the output */
812 if (flags & TRACE_GRAPH_PRINT_OVERHEAD)
813 trace_seq_printf(s, "%c ", trace_find_mark(duration));
815 trace_seq_puts(s, " ");
817 trace_print_graph_duration(duration, s);
818 trace_seq_puts(s, "| ");
821 /* Case of a leaf function on its call entry */
822 static enum print_line_t
823 print_graph_entry_leaf(struct trace_iterator *iter,
824 struct ftrace_graph_ent_entry *entry,
825 struct ftrace_graph_ret_entry *ret_entry,
826 struct trace_seq *s, u32 flags)
828 struct fgraph_data *data = iter->private;
829 struct trace_array *tr = iter->tr;
830 struct ftrace_graph_ret *graph_ret;
831 struct ftrace_graph_ent *call;
832 unsigned long long duration;
836 graph_ret = &ret_entry->ret;
837 call = &entry->graph_ent;
838 duration = graph_ret->rettime - graph_ret->calltime;
841 struct fgraph_cpu_data *cpu_data;
843 cpu_data = per_cpu_ptr(data->cpu_data, cpu);
845 /* If a graph tracer ignored set_graph_notrace */
846 if (call->depth < -1)
847 call->depth += FTRACE_NOTRACE_DEPTH;
850 * Comments display at + 1 to depth. Since
851 * this is a leaf function, keep the comments
852 * equal to this depth.
854 cpu_data->depth = call->depth - 1;
856 /* No need to keep this function around for this depth */
857 if (call->depth < FTRACE_RETFUNC_DEPTH &&
858 !WARN_ON_ONCE(call->depth < 0))
859 cpu_data->enter_funcs[call->depth] = 0;
862 /* Overhead and duration */
863 print_graph_duration(tr, duration, s, flags);
866 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++)
867 trace_seq_putc(s, ' ');
869 trace_seq_printf(s, "%ps();\n", (void *)call->func);
871 print_graph_irq(iter, graph_ret->func, TRACE_GRAPH_RET,
872 cpu, iter->ent->pid, flags);
874 return trace_handle_return(s);
877 static enum print_line_t
878 print_graph_entry_nested(struct trace_iterator *iter,
879 struct ftrace_graph_ent_entry *entry,
880 struct trace_seq *s, int cpu, u32 flags)
882 struct ftrace_graph_ent *call = &entry->graph_ent;
883 struct fgraph_data *data = iter->private;
884 struct trace_array *tr = iter->tr;
888 struct fgraph_cpu_data *cpu_data;
891 /* If a graph tracer ignored set_graph_notrace */
892 if (call->depth < -1)
893 call->depth += FTRACE_NOTRACE_DEPTH;
895 cpu_data = per_cpu_ptr(data->cpu_data, cpu);
896 cpu_data->depth = call->depth;
898 /* Save this function pointer to see if the exit matches */
899 if (call->depth < FTRACE_RETFUNC_DEPTH &&
900 !WARN_ON_ONCE(call->depth < 0))
901 cpu_data->enter_funcs[call->depth] = call->func;
905 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_FULL);
908 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++)
909 trace_seq_putc(s, ' ');
911 trace_seq_printf(s, "%ps() {\n", (void *)call->func);
913 if (trace_seq_has_overflowed(s))
914 return TRACE_TYPE_PARTIAL_LINE;
917 * we already consumed the current entry to check the next one
918 * and see if this is a leaf.
920 return TRACE_TYPE_NO_CONSUME;
924 print_graph_prologue(struct trace_iterator *iter, struct trace_seq *s,
925 int type, unsigned long addr, u32 flags)
927 struct fgraph_data *data = iter->private;
928 struct trace_entry *ent = iter->ent;
929 struct trace_array *tr = iter->tr;
933 verif_pid(s, ent->pid, cpu, data);
937 print_graph_irq(iter, addr, type, cpu, ent->pid, flags);
939 if (!(tr->trace_flags & TRACE_ITER_CONTEXT_INFO))
943 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
944 print_graph_abs_time(iter->ts, s);
947 if (flags & TRACE_GRAPH_PRINT_CPU)
948 print_graph_cpu(s, cpu);
951 if (flags & TRACE_GRAPH_PRINT_PROC) {
952 print_graph_proc(s, ent->pid);
953 trace_seq_puts(s, " | ");
957 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
958 print_graph_lat_fmt(s, ent);
964 * Entry check for irq code
967 * - we are inside irq code
968 * - we just entered irq code
971 * - funcgraph-interrupts option is set
972 * - we are not inside irq code
975 check_irq_entry(struct trace_iterator *iter, u32 flags,
976 unsigned long addr, int depth)
980 struct fgraph_data *data = iter->private;
983 * If we are either displaying irqs, or we got called as
984 * a graph event and private data does not exist,
985 * then we bypass the irq check.
987 if ((flags & TRACE_GRAPH_PRINT_IRQS) ||
991 depth_irq = &(per_cpu_ptr(data->cpu_data, cpu)->depth_irq);
994 * We are inside the irq code
999 if ((addr < (unsigned long)__irqentry_text_start) ||
1000 (addr >= (unsigned long)__irqentry_text_end))
1004 * We are entering irq code.
1011 * Return check for irq code
1014 * - we are inside irq code
1015 * - we just left irq code
1018 * - funcgraph-interrupts option is set
1019 * - we are not inside irq code
1022 check_irq_return(struct trace_iterator *iter, u32 flags, int depth)
1024 int cpu = iter->cpu;
1026 struct fgraph_data *data = iter->private;
1029 * If we are either displaying irqs, or we got called as
1030 * a graph event and private data does not exist,
1031 * then we bypass the irq check.
1033 if ((flags & TRACE_GRAPH_PRINT_IRQS) ||
1037 depth_irq = &(per_cpu_ptr(data->cpu_data, cpu)->depth_irq);
1040 * We are not inside the irq code.
1042 if (*depth_irq == -1)
1046 * We are inside the irq code, and this is returning entry.
1047 * Let's not trace it and clear the entry depth, since
1048 * we are out of irq code.
1050 * This condition ensures that we 'leave the irq code' once
1051 * we are out of the entry depth. Thus protecting us from
1052 * the RETURN entry loss.
1054 if (*depth_irq >= depth) {
1060 * We are inside the irq code, and this is not the entry.
1065 static enum print_line_t
1066 print_graph_entry(struct ftrace_graph_ent_entry *field, struct trace_seq *s,
1067 struct trace_iterator *iter, u32 flags)
1069 struct fgraph_data *data = iter->private;
1070 struct ftrace_graph_ent *call = &field->graph_ent;
1071 struct ftrace_graph_ret_entry *leaf_ret;
1072 static enum print_line_t ret;
1073 int cpu = iter->cpu;
1075 if (check_irq_entry(iter, flags, call->func, call->depth))
1076 return TRACE_TYPE_HANDLED;
1078 print_graph_prologue(iter, s, TRACE_GRAPH_ENT, call->func, flags);
1080 leaf_ret = get_return_for_leaf(iter, field);
1082 ret = print_graph_entry_leaf(iter, field, leaf_ret, s, flags);
1084 ret = print_graph_entry_nested(iter, field, s, cpu, flags);
1088 * If we failed to write our output, then we need to make
1089 * note of it. Because we already consumed our entry.
1101 static enum print_line_t
1102 print_graph_return(struct ftrace_graph_ret *trace, struct trace_seq *s,
1103 struct trace_entry *ent, struct trace_iterator *iter,
1106 unsigned long long duration = trace->rettime - trace->calltime;
1107 struct fgraph_data *data = iter->private;
1108 struct trace_array *tr = iter->tr;
1109 pid_t pid = ent->pid;
1110 int cpu = iter->cpu;
1114 if (check_irq_return(iter, flags, trace->depth))
1115 return TRACE_TYPE_HANDLED;
1118 struct fgraph_cpu_data *cpu_data;
1119 int cpu = iter->cpu;
1121 cpu_data = per_cpu_ptr(data->cpu_data, cpu);
1124 * Comments display at + 1 to depth. This is the
1125 * return from a function, we now want the comments
1126 * to display at the same level of the bracket.
1128 cpu_data->depth = trace->depth - 1;
1130 if (trace->depth < FTRACE_RETFUNC_DEPTH &&
1131 !WARN_ON_ONCE(trace->depth < 0)) {
1132 if (cpu_data->enter_funcs[trace->depth] != trace->func)
1134 cpu_data->enter_funcs[trace->depth] = 0;
1138 print_graph_prologue(iter, s, 0, 0, flags);
1140 /* Overhead and duration */
1141 print_graph_duration(tr, duration, s, flags);
1144 for (i = 0; i < trace->depth * TRACE_GRAPH_INDENT; i++)
1145 trace_seq_putc(s, ' ');
1148 * If the return function does not have a matching entry,
1149 * then the entry was lost. Instead of just printing
1150 * the '}' and letting the user guess what function this
1151 * belongs to, write out the function name. Always do
1152 * that if the funcgraph-tail option is enabled.
1154 if (func_match && !(flags & TRACE_GRAPH_PRINT_TAIL))
1155 trace_seq_puts(s, "}\n");
1157 trace_seq_printf(s, "} /* %ps */\n", (void *)trace->func);
1160 if (flags & TRACE_GRAPH_PRINT_OVERRUN)
1161 trace_seq_printf(s, " (Overruns: %lu)\n",
1164 print_graph_irq(iter, trace->func, TRACE_GRAPH_RET,
1167 return trace_handle_return(s);
1170 static enum print_line_t
1171 print_graph_comment(struct trace_seq *s, struct trace_entry *ent,
1172 struct trace_iterator *iter, u32 flags)
1174 struct trace_array *tr = iter->tr;
1175 unsigned long sym_flags = (tr->trace_flags & TRACE_ITER_SYM_MASK);
1176 struct fgraph_data *data = iter->private;
1177 struct trace_event *event;
1183 depth = per_cpu_ptr(data->cpu_data, iter->cpu)->depth;
1185 print_graph_prologue(iter, s, 0, 0, flags);
1188 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_FULL);
1192 for (i = 0; i < (depth + 1) * TRACE_GRAPH_INDENT; i++)
1193 trace_seq_putc(s, ' ');
1196 trace_seq_puts(s, "/* ");
1198 switch (iter->ent->type) {
1200 ret = trace_print_bputs_msg_only(iter);
1201 if (ret != TRACE_TYPE_HANDLED)
1205 ret = trace_print_bprintk_msg_only(iter);
1206 if (ret != TRACE_TYPE_HANDLED)
1210 ret = trace_print_printk_msg_only(iter);
1211 if (ret != TRACE_TYPE_HANDLED)
1215 event = ftrace_find_event(ent->type);
1217 return TRACE_TYPE_UNHANDLED;
1219 ret = event->funcs->trace(iter, sym_flags, event);
1220 if (ret != TRACE_TYPE_HANDLED)
1224 if (trace_seq_has_overflowed(s))
1227 /* Strip ending newline */
1228 if (s->buffer[s->seq.len - 1] == '\n') {
1229 s->buffer[s->seq.len - 1] = '\0';
1233 trace_seq_puts(s, " */\n");
1235 return trace_handle_return(s);
1240 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
1242 struct ftrace_graph_ent_entry *field;
1243 struct fgraph_data *data = iter->private;
1244 struct trace_entry *entry = iter->ent;
1245 struct trace_seq *s = &iter->seq;
1246 int cpu = iter->cpu;
1249 if (data && per_cpu_ptr(data->cpu_data, cpu)->ignore) {
1250 per_cpu_ptr(data->cpu_data, cpu)->ignore = 0;
1251 return TRACE_TYPE_HANDLED;
1255 * If the last output failed, there's a possibility we need
1256 * to print out the missing entry which would never go out.
1258 if (data && data->failed) {
1260 iter->cpu = data->cpu;
1261 ret = print_graph_entry(field, s, iter, flags);
1262 if (ret == TRACE_TYPE_HANDLED && iter->cpu != cpu) {
1263 per_cpu_ptr(data->cpu_data, iter->cpu)->ignore = 1;
1264 ret = TRACE_TYPE_NO_CONSUME;
1270 switch (entry->type) {
1271 case TRACE_GRAPH_ENT: {
1273 * print_graph_entry() may consume the current event,
1274 * thus @field may become invalid, so we need to save it.
1275 * sizeof(struct ftrace_graph_ent_entry) is very small,
1276 * it can be safely saved at the stack.
1278 struct ftrace_graph_ent_entry saved;
1279 trace_assign_type(field, entry);
1281 return print_graph_entry(&saved, s, iter, flags);
1283 case TRACE_GRAPH_RET: {
1284 struct ftrace_graph_ret_entry *field;
1285 trace_assign_type(field, entry);
1286 return print_graph_return(&field->ret, s, entry, iter, flags);
1290 /* dont trace stack and functions as comments */
1291 return TRACE_TYPE_UNHANDLED;
1294 return print_graph_comment(s, entry, iter, flags);
1297 return TRACE_TYPE_HANDLED;
1300 static enum print_line_t
1301 print_graph_function(struct trace_iterator *iter)
1303 return print_graph_function_flags(iter, tracer_flags.val);
1306 static enum print_line_t
1307 print_graph_function_event(struct trace_iterator *iter, int flags,
1308 struct trace_event *event)
1310 return print_graph_function(iter);
1313 static void print_lat_header(struct seq_file *s, u32 flags)
1315 static const char spaces[] = " " /* 16 spaces */
1317 " "; /* 17 spaces */
1320 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
1322 if (flags & TRACE_GRAPH_PRINT_CPU)
1324 if (flags & TRACE_GRAPH_PRINT_PROC)
1327 seq_printf(s, "#%.*s _-----=> irqs-off \n", size, spaces);
1328 seq_printf(s, "#%.*s / _----=> need-resched \n", size, spaces);
1329 seq_printf(s, "#%.*s| / _---=> hardirq/softirq \n", size, spaces);
1330 seq_printf(s, "#%.*s|| / _--=> preempt-depth \n", size, spaces);
1331 seq_printf(s, "#%.*s||| / \n", size, spaces);
1334 static void __print_graph_headers_flags(struct trace_array *tr,
1335 struct seq_file *s, u32 flags)
1337 int lat = tr->trace_flags & TRACE_ITER_LATENCY_FMT;
1340 print_lat_header(s, flags);
1344 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
1345 seq_puts(s, " TIME ");
1346 if (flags & TRACE_GRAPH_PRINT_CPU)
1347 seq_puts(s, " CPU");
1348 if (flags & TRACE_GRAPH_PRINT_PROC)
1349 seq_puts(s, " TASK/PID ");
1351 seq_puts(s, "||||");
1352 if (flags & TRACE_GRAPH_PRINT_DURATION)
1353 seq_puts(s, " DURATION ");
1354 seq_puts(s, " FUNCTION CALLS\n");
1358 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
1360 if (flags & TRACE_GRAPH_PRINT_CPU)
1362 if (flags & TRACE_GRAPH_PRINT_PROC)
1363 seq_puts(s, " | | ");
1365 seq_puts(s, "||||");
1366 if (flags & TRACE_GRAPH_PRINT_DURATION)
1367 seq_puts(s, " | | ");
1368 seq_puts(s, " | | | |\n");
1371 static void print_graph_headers(struct seq_file *s)
1373 print_graph_headers_flags(s, tracer_flags.val);
1376 void print_graph_headers_flags(struct seq_file *s, u32 flags)
1378 struct trace_iterator *iter = s->private;
1379 struct trace_array *tr = iter->tr;
1381 if (!(tr->trace_flags & TRACE_ITER_CONTEXT_INFO))
1384 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT) {
1385 /* print nothing if the buffers are empty */
1386 if (trace_empty(iter))
1389 print_trace_header(s, iter);
1392 __print_graph_headers_flags(tr, s, flags);
1395 void graph_trace_open(struct trace_iterator *iter)
1397 /* pid and depth on the last trace processed */
1398 struct fgraph_data *data;
1402 iter->private = NULL;
1404 /* We can be called in atomic context via ftrace_dump() */
1405 gfpflags = (in_atomic() || irqs_disabled()) ? GFP_ATOMIC : GFP_KERNEL;
1407 data = kzalloc(sizeof(*data), gfpflags);
1411 data->cpu_data = alloc_percpu_gfp(struct fgraph_cpu_data, gfpflags);
1412 if (!data->cpu_data)
1415 for_each_possible_cpu(cpu) {
1416 pid_t *pid = &(per_cpu_ptr(data->cpu_data, cpu)->last_pid);
1417 int *depth = &(per_cpu_ptr(data->cpu_data, cpu)->depth);
1418 int *ignore = &(per_cpu_ptr(data->cpu_data, cpu)->ignore);
1419 int *depth_irq = &(per_cpu_ptr(data->cpu_data, cpu)->depth_irq);
1427 iter->private = data;
1434 pr_warn("function graph tracer: not enough memory\n");
1437 void graph_trace_close(struct trace_iterator *iter)
1439 struct fgraph_data *data = iter->private;
1442 free_percpu(data->cpu_data);
1448 func_graph_set_flag(struct trace_array *tr, u32 old_flags, u32 bit, int set)
1450 if (bit == TRACE_GRAPH_PRINT_IRQS)
1451 ftrace_graph_skip_irqs = !set;
1453 if (bit == TRACE_GRAPH_SLEEP_TIME)
1454 ftrace_graph_sleep_time_control(set);
1456 if (bit == TRACE_GRAPH_GRAPH_TIME)
1457 ftrace_graph_graph_time_control(set);
1462 static struct trace_event_functions graph_functions = {
1463 .trace = print_graph_function_event,
1466 static struct trace_event graph_trace_entry_event = {
1467 .type = TRACE_GRAPH_ENT,
1468 .funcs = &graph_functions,
1471 static struct trace_event graph_trace_ret_event = {
1472 .type = TRACE_GRAPH_RET,
1473 .funcs = &graph_functions
1476 static struct tracer graph_trace __tracer_data = {
1477 .name = "function_graph",
1478 .update_thresh = graph_trace_update_thresh,
1479 .open = graph_trace_open,
1480 .pipe_open = graph_trace_open,
1481 .close = graph_trace_close,
1482 .pipe_close = graph_trace_close,
1483 .init = graph_trace_init,
1484 .reset = graph_trace_reset,
1485 .print_line = print_graph_function,
1486 .print_header = print_graph_headers,
1487 .flags = &tracer_flags,
1488 .set_flag = func_graph_set_flag,
1489 #ifdef CONFIG_FTRACE_SELFTEST
1490 .selftest = trace_selftest_startup_function_graph,
1496 graph_depth_write(struct file *filp, const char __user *ubuf, size_t cnt,
1502 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
1514 graph_depth_read(struct file *filp, char __user *ubuf, size_t cnt,
1517 char buf[15]; /* More than enough to hold UINT_MAX + "\n"*/
1520 n = sprintf(buf, "%d\n", max_depth);
1522 return simple_read_from_buffer(ubuf, cnt, ppos, buf, n);
1525 static const struct file_operations graph_depth_fops = {
1526 .open = tracing_open_generic,
1527 .write = graph_depth_write,
1528 .read = graph_depth_read,
1529 .llseek = generic_file_llseek,
1532 static __init int init_graph_tracefs(void)
1534 struct dentry *d_tracer;
1536 d_tracer = tracing_init_dentry();
1537 if (IS_ERR(d_tracer))
1540 trace_create_file("max_graph_depth", 0644, d_tracer,
1541 NULL, &graph_depth_fops);
1545 fs_initcall(init_graph_tracefs);
1547 static __init int init_graph_trace(void)
1549 max_bytes_for_cpu = snprintf(NULL, 0, "%d", nr_cpu_ids - 1);
1551 if (!register_trace_event(&graph_trace_entry_event)) {
1552 pr_warn("Warning: could not register graph trace events\n");
1556 if (!register_trace_event(&graph_trace_ret_event)) {
1557 pr_warn("Warning: could not register graph trace events\n");
1561 return register_tracer(&graph_trace);
1564 core_initcall(init_graph_trace);