dm thin metadata: fix __udivdi3 undefined on 32-bit
[linux/fpc-iii.git] / kernel / trace / trace_functions_graph.c
blobe212ec4cfb4e748ceda3a8354d44f1cae1e91efc
1 /*
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>
8 */
9 #include <linux/uaccess.h>
10 #include <linux/ftrace.h>
11 #include <linux/slab.h>
12 #include <linux/fs.h>
14 #include "trace.h"
15 #include "trace_output.h"
17 static bool kill_ftrace_graph;
19 /**
20 * ftrace_graph_is_dead - returns true if ftrace_graph_stop() was called
22 * ftrace_graph_stop() is called when a severe error is detected in
23 * the function graph tracing. This function is called by the critical
24 * paths of function graph to keep those paths from doing any more harm.
26 bool ftrace_graph_is_dead(void)
28 return kill_ftrace_graph;
31 /**
32 * ftrace_graph_stop - set to permanently disable function graph tracincg
34 * In case of an error int function graph tracing, this is called
35 * to try to keep function graph tracing from causing any more harm.
36 * Usually this is pretty severe and this is called to try to at least
37 * get a warning out to the user.
39 void ftrace_graph_stop(void)
41 kill_ftrace_graph = true;
44 /* When set, irq functions will be ignored */
45 static int ftrace_graph_skip_irqs;
47 struct fgraph_cpu_data {
48 pid_t last_pid;
49 int depth;
50 int depth_irq;
51 int ignore;
52 unsigned long enter_funcs[FTRACE_RETFUNC_DEPTH];
55 struct fgraph_data {
56 struct fgraph_cpu_data __percpu *cpu_data;
58 /* Place to preserve last processed entry. */
59 struct ftrace_graph_ent_entry ent;
60 struct ftrace_graph_ret_entry ret;
61 int failed;
62 int cpu;
65 #define TRACE_GRAPH_INDENT 2
67 static unsigned int max_depth;
69 static struct tracer_opt trace_opts[] = {
70 /* Display overruns? (for self-debug purpose) */
71 { TRACER_OPT(funcgraph-overrun, TRACE_GRAPH_PRINT_OVERRUN) },
72 /* Display CPU ? */
73 { TRACER_OPT(funcgraph-cpu, TRACE_GRAPH_PRINT_CPU) },
74 /* Display Overhead ? */
75 { TRACER_OPT(funcgraph-overhead, TRACE_GRAPH_PRINT_OVERHEAD) },
76 /* Display proc name/pid */
77 { TRACER_OPT(funcgraph-proc, TRACE_GRAPH_PRINT_PROC) },
78 /* Display duration of execution */
79 { TRACER_OPT(funcgraph-duration, TRACE_GRAPH_PRINT_DURATION) },
80 /* Display absolute time of an entry */
81 { TRACER_OPT(funcgraph-abstime, TRACE_GRAPH_PRINT_ABS_TIME) },
82 /* Display interrupts */
83 { TRACER_OPT(funcgraph-irqs, TRACE_GRAPH_PRINT_IRQS) },
84 /* Display function name after trailing } */
85 { TRACER_OPT(funcgraph-tail, TRACE_GRAPH_PRINT_TAIL) },
86 /* Include sleep time (scheduled out) between entry and return */
87 { TRACER_OPT(sleep-time, TRACE_GRAPH_SLEEP_TIME) },
88 /* Include time within nested functions */
89 { TRACER_OPT(graph-time, TRACE_GRAPH_GRAPH_TIME) },
90 { } /* Empty entry */
93 static struct tracer_flags tracer_flags = {
94 /* Don't display overruns, proc, or tail by default */
95 .val = TRACE_GRAPH_PRINT_CPU | TRACE_GRAPH_PRINT_OVERHEAD |
96 TRACE_GRAPH_PRINT_DURATION | TRACE_GRAPH_PRINT_IRQS |
97 TRACE_GRAPH_SLEEP_TIME | TRACE_GRAPH_GRAPH_TIME,
98 .opts = trace_opts
101 static struct trace_array *graph_array;
104 * DURATION column is being also used to display IRQ signs,
105 * following values are used by print_graph_irq and others
106 * to fill in space into DURATION column.
108 enum {
109 FLAGS_FILL_FULL = 1 << TRACE_GRAPH_PRINT_FILL_SHIFT,
110 FLAGS_FILL_START = 2 << TRACE_GRAPH_PRINT_FILL_SHIFT,
111 FLAGS_FILL_END = 3 << TRACE_GRAPH_PRINT_FILL_SHIFT,
114 static void
115 print_graph_duration(struct trace_array *tr, unsigned long long duration,
116 struct trace_seq *s, u32 flags);
118 /* Add a function return address to the trace stack on thread info.*/
120 ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
121 unsigned long frame_pointer)
123 unsigned long long calltime;
124 int index;
126 if (unlikely(ftrace_graph_is_dead()))
127 return -EBUSY;
129 if (!current->ret_stack)
130 return -EBUSY;
133 * We must make sure the ret_stack is tested before we read
134 * anything else.
136 smp_rmb();
138 /* The return trace stack is full */
139 if (current->curr_ret_stack == FTRACE_RETFUNC_DEPTH - 1) {
140 atomic_inc(&current->trace_overrun);
141 return -EBUSY;
145 * The curr_ret_stack is an index to ftrace return stack of
146 * current task. Its value should be in [0, FTRACE_RETFUNC_
147 * DEPTH) when the function graph tracer is used. To support
148 * filtering out specific functions, it makes the index
149 * negative by subtracting huge value (FTRACE_NOTRACE_DEPTH)
150 * so when it sees a negative index the ftrace will ignore
151 * the record. And the index gets recovered when returning
152 * from the filtered function by adding the FTRACE_NOTRACE_
153 * DEPTH and then it'll continue to record functions normally.
155 * The curr_ret_stack is initialized to -1 and get increased
156 * in this function. So it can be less than -1 only if it was
157 * filtered out via ftrace_graph_notrace_addr() which can be
158 * set from set_graph_notrace file in tracefs by user.
160 if (current->curr_ret_stack < -1)
161 return -EBUSY;
163 calltime = trace_clock_local();
165 index = ++current->curr_ret_stack;
166 if (ftrace_graph_notrace_addr(func))
167 current->curr_ret_stack -= FTRACE_NOTRACE_DEPTH;
168 barrier();
169 current->ret_stack[index].ret = ret;
170 current->ret_stack[index].func = func;
171 current->ret_stack[index].calltime = calltime;
172 current->ret_stack[index].subtime = 0;
173 current->ret_stack[index].fp = frame_pointer;
174 *depth = current->curr_ret_stack;
176 return 0;
179 /* Retrieve a function return address to the trace stack on thread info.*/
180 static void
181 ftrace_pop_return_trace(struct ftrace_graph_ret *trace, unsigned long *ret,
182 unsigned long frame_pointer)
184 int index;
186 index = current->curr_ret_stack;
189 * A negative index here means that it's just returned from a
190 * notrace'd function. Recover index to get an original
191 * return address. See ftrace_push_return_trace().
193 * TODO: Need to check whether the stack gets corrupted.
195 if (index < 0)
196 index += FTRACE_NOTRACE_DEPTH;
198 if (unlikely(index < 0 || index >= FTRACE_RETFUNC_DEPTH)) {
199 ftrace_graph_stop();
200 WARN_ON(1);
201 /* Might as well panic, otherwise we have no where to go */
202 *ret = (unsigned long)panic;
203 return;
206 #if defined(CONFIG_HAVE_FUNCTION_GRAPH_FP_TEST) && !defined(CC_USING_FENTRY)
208 * The arch may choose to record the frame pointer used
209 * and check it here to make sure that it is what we expect it
210 * to be. If gcc does not set the place holder of the return
211 * address in the frame pointer, and does a copy instead, then
212 * the function graph trace will fail. This test detects this
213 * case.
215 * Currently, x86_32 with optimize for size (-Os) makes the latest
216 * gcc do the above.
218 * Note, -mfentry does not use frame pointers, and this test
219 * is not needed if CC_USING_FENTRY is set.
221 if (unlikely(current->ret_stack[index].fp != frame_pointer)) {
222 ftrace_graph_stop();
223 WARN(1, "Bad frame pointer: expected %lx, received %lx\n"
224 " from func %ps return to %lx\n",
225 current->ret_stack[index].fp,
226 frame_pointer,
227 (void *)current->ret_stack[index].func,
228 current->ret_stack[index].ret);
229 *ret = (unsigned long)panic;
230 return;
232 #endif
234 *ret = current->ret_stack[index].ret;
235 trace->func = current->ret_stack[index].func;
236 trace->calltime = current->ret_stack[index].calltime;
237 trace->overrun = atomic_read(&current->trace_overrun);
238 trace->depth = index;
242 * Send the trace to the ring-buffer.
243 * @return the original return address.
245 unsigned long ftrace_return_to_handler(unsigned long frame_pointer)
247 struct ftrace_graph_ret trace;
248 unsigned long ret;
250 ftrace_pop_return_trace(&trace, &ret, frame_pointer);
251 trace.rettime = trace_clock_local();
252 barrier();
253 current->curr_ret_stack--;
255 * The curr_ret_stack can be less than -1 only if it was
256 * filtered out and it's about to return from the function.
257 * Recover the index and continue to trace normal functions.
259 if (current->curr_ret_stack < -1) {
260 current->curr_ret_stack += FTRACE_NOTRACE_DEPTH;
261 return ret;
265 * The trace should run after decrementing the ret counter
266 * in case an interrupt were to come in. We don't want to
267 * lose the interrupt if max_depth is set.
269 ftrace_graph_return(&trace);
271 if (unlikely(!ret)) {
272 ftrace_graph_stop();
273 WARN_ON(1);
274 /* Might as well panic. What else to do? */
275 ret = (unsigned long)panic;
278 return ret;
281 int __trace_graph_entry(struct trace_array *tr,
282 struct ftrace_graph_ent *trace,
283 unsigned long flags,
284 int pc)
286 struct trace_event_call *call = &event_funcgraph_entry;
287 struct ring_buffer_event *event;
288 struct ring_buffer *buffer = tr->trace_buffer.buffer;
289 struct ftrace_graph_ent_entry *entry;
291 event = trace_buffer_lock_reserve(buffer, TRACE_GRAPH_ENT,
292 sizeof(*entry), flags, pc);
293 if (!event)
294 return 0;
295 entry = ring_buffer_event_data(event);
296 entry->graph_ent = *trace;
297 if (!call_filter_check_discard(call, entry, buffer, event))
298 __buffer_unlock_commit(buffer, event);
300 return 1;
303 static inline int ftrace_graph_ignore_irqs(void)
305 if (!ftrace_graph_skip_irqs || trace_recursion_test(TRACE_IRQ_BIT))
306 return 0;
308 return in_irq();
311 int trace_graph_entry(struct ftrace_graph_ent *trace)
313 struct trace_array *tr = graph_array;
314 struct trace_array_cpu *data;
315 unsigned long flags;
316 long disabled;
317 int ret;
318 int cpu;
319 int pc;
321 if (!ftrace_trace_task(current))
322 return 0;
324 /* trace it when it is-nested-in or is a function enabled. */
325 if ((!(trace->depth || ftrace_graph_addr(trace->func)) ||
326 ftrace_graph_ignore_irqs()) || (trace->depth < 0) ||
327 (max_depth && trace->depth >= max_depth))
328 return 0;
331 * Do not trace a function if it's filtered by set_graph_notrace.
332 * Make the index of ret stack negative to indicate that it should
333 * ignore further functions. But it needs its own ret stack entry
334 * to recover the original index in order to continue tracing after
335 * returning from the function.
337 if (ftrace_graph_notrace_addr(trace->func))
338 return 1;
340 local_irq_save(flags);
341 cpu = raw_smp_processor_id();
342 data = per_cpu_ptr(tr->trace_buffer.data, cpu);
343 disabled = atomic_inc_return(&data->disabled);
344 if (likely(disabled == 1)) {
345 pc = preempt_count();
346 ret = __trace_graph_entry(tr, trace, flags, pc);
347 } else {
348 ret = 0;
351 atomic_dec(&data->disabled);
352 local_irq_restore(flags);
354 return ret;
357 static int trace_graph_thresh_entry(struct ftrace_graph_ent *trace)
359 if (tracing_thresh)
360 return 1;
361 else
362 return trace_graph_entry(trace);
365 static void
366 __trace_graph_function(struct trace_array *tr,
367 unsigned long ip, unsigned long flags, int pc)
369 u64 time = trace_clock_local();
370 struct ftrace_graph_ent ent = {
371 .func = ip,
372 .depth = 0,
374 struct ftrace_graph_ret ret = {
375 .func = ip,
376 .depth = 0,
377 .calltime = time,
378 .rettime = time,
381 __trace_graph_entry(tr, &ent, flags, pc);
382 __trace_graph_return(tr, &ret, flags, pc);
385 void
386 trace_graph_function(struct trace_array *tr,
387 unsigned long ip, unsigned long parent_ip,
388 unsigned long flags, int pc)
390 __trace_graph_function(tr, ip, flags, pc);
393 void __trace_graph_return(struct trace_array *tr,
394 struct ftrace_graph_ret *trace,
395 unsigned long flags,
396 int pc)
398 struct trace_event_call *call = &event_funcgraph_exit;
399 struct ring_buffer_event *event;
400 struct ring_buffer *buffer = tr->trace_buffer.buffer;
401 struct ftrace_graph_ret_entry *entry;
403 event = trace_buffer_lock_reserve(buffer, TRACE_GRAPH_RET,
404 sizeof(*entry), flags, pc);
405 if (!event)
406 return;
407 entry = ring_buffer_event_data(event);
408 entry->ret = *trace;
409 if (!call_filter_check_discard(call, entry, buffer, event))
410 __buffer_unlock_commit(buffer, event);
413 void trace_graph_return(struct ftrace_graph_ret *trace)
415 struct trace_array *tr = graph_array;
416 struct trace_array_cpu *data;
417 unsigned long flags;
418 long disabled;
419 int cpu;
420 int pc;
422 local_irq_save(flags);
423 cpu = raw_smp_processor_id();
424 data = per_cpu_ptr(tr->trace_buffer.data, cpu);
425 disabled = atomic_inc_return(&data->disabled);
426 if (likely(disabled == 1)) {
427 pc = preempt_count();
428 __trace_graph_return(tr, trace, flags, pc);
430 atomic_dec(&data->disabled);
431 local_irq_restore(flags);
434 void set_graph_array(struct trace_array *tr)
436 graph_array = tr;
438 /* Make graph_array visible before we start tracing */
440 smp_mb();
443 static void trace_graph_thresh_return(struct ftrace_graph_ret *trace)
445 if (tracing_thresh &&
446 (trace->rettime - trace->calltime < tracing_thresh))
447 return;
448 else
449 trace_graph_return(trace);
452 static int graph_trace_init(struct trace_array *tr)
454 int ret;
456 set_graph_array(tr);
457 if (tracing_thresh)
458 ret = register_ftrace_graph(&trace_graph_thresh_return,
459 &trace_graph_thresh_entry);
460 else
461 ret = register_ftrace_graph(&trace_graph_return,
462 &trace_graph_entry);
463 if (ret)
464 return ret;
465 tracing_start_cmdline_record();
467 return 0;
470 static void graph_trace_reset(struct trace_array *tr)
472 tracing_stop_cmdline_record();
473 unregister_ftrace_graph();
476 static int graph_trace_update_thresh(struct trace_array *tr)
478 graph_trace_reset(tr);
479 return graph_trace_init(tr);
482 static int max_bytes_for_cpu;
484 static void print_graph_cpu(struct trace_seq *s, int cpu)
487 * Start with a space character - to make it stand out
488 * to the right a bit when trace output is pasted into
489 * email:
491 trace_seq_printf(s, " %*d) ", max_bytes_for_cpu, cpu);
494 #define TRACE_GRAPH_PROCINFO_LENGTH 14
496 static void print_graph_proc(struct trace_seq *s, pid_t pid)
498 char comm[TASK_COMM_LEN];
499 /* sign + log10(MAX_INT) + '\0' */
500 char pid_str[11];
501 int spaces = 0;
502 int len;
503 int i;
505 trace_find_cmdline(pid, comm);
506 comm[7] = '\0';
507 sprintf(pid_str, "%d", pid);
509 /* 1 stands for the "-" character */
510 len = strlen(comm) + strlen(pid_str) + 1;
512 if (len < TRACE_GRAPH_PROCINFO_LENGTH)
513 spaces = TRACE_GRAPH_PROCINFO_LENGTH - len;
515 /* First spaces to align center */
516 for (i = 0; i < spaces / 2; i++)
517 trace_seq_putc(s, ' ');
519 trace_seq_printf(s, "%s-%s", comm, pid_str);
521 /* Last spaces to align center */
522 for (i = 0; i < spaces - (spaces / 2); i++)
523 trace_seq_putc(s, ' ');
527 static void print_graph_lat_fmt(struct trace_seq *s, struct trace_entry *entry)
529 trace_seq_putc(s, ' ');
530 trace_print_lat_fmt(s, entry);
533 /* If the pid changed since the last trace, output this event */
534 static void
535 verif_pid(struct trace_seq *s, pid_t pid, int cpu, struct fgraph_data *data)
537 pid_t prev_pid;
538 pid_t *last_pid;
540 if (!data)
541 return;
543 last_pid = &(per_cpu_ptr(data->cpu_data, cpu)->last_pid);
545 if (*last_pid == pid)
546 return;
548 prev_pid = *last_pid;
549 *last_pid = pid;
551 if (prev_pid == -1)
552 return;
554 * Context-switch trace line:
556 ------------------------------------------
557 | 1) migration/0--1 => sshd-1755
558 ------------------------------------------
561 trace_seq_puts(s, " ------------------------------------------\n");
562 print_graph_cpu(s, cpu);
563 print_graph_proc(s, prev_pid);
564 trace_seq_puts(s, " => ");
565 print_graph_proc(s, pid);
566 trace_seq_puts(s, "\n ------------------------------------------\n\n");
569 static struct ftrace_graph_ret_entry *
570 get_return_for_leaf(struct trace_iterator *iter,
571 struct ftrace_graph_ent_entry *curr)
573 struct fgraph_data *data = iter->private;
574 struct ring_buffer_iter *ring_iter = NULL;
575 struct ring_buffer_event *event;
576 struct ftrace_graph_ret_entry *next;
579 * If the previous output failed to write to the seq buffer,
580 * then we just reuse the data from before.
582 if (data && data->failed) {
583 curr = &data->ent;
584 next = &data->ret;
585 } else {
587 ring_iter = trace_buffer_iter(iter, iter->cpu);
589 /* First peek to compare current entry and the next one */
590 if (ring_iter)
591 event = ring_buffer_iter_peek(ring_iter, NULL);
592 else {
594 * We need to consume the current entry to see
595 * the next one.
597 ring_buffer_consume(iter->trace_buffer->buffer, iter->cpu,
598 NULL, NULL);
599 event = ring_buffer_peek(iter->trace_buffer->buffer, iter->cpu,
600 NULL, NULL);
603 if (!event)
604 return NULL;
606 next = ring_buffer_event_data(event);
608 if (data) {
610 * Save current and next entries for later reference
611 * if the output fails.
613 data->ent = *curr;
615 * If the next event is not a return type, then
616 * we only care about what type it is. Otherwise we can
617 * safely copy the entire event.
619 if (next->ent.type == TRACE_GRAPH_RET)
620 data->ret = *next;
621 else
622 data->ret.ent.type = next->ent.type;
626 if (next->ent.type != TRACE_GRAPH_RET)
627 return NULL;
629 if (curr->ent.pid != next->ent.pid ||
630 curr->graph_ent.func != next->ret.func)
631 return NULL;
633 /* this is a leaf, now advance the iterator */
634 if (ring_iter)
635 ring_buffer_read(ring_iter, NULL);
637 return next;
640 static void print_graph_abs_time(u64 t, struct trace_seq *s)
642 unsigned long usecs_rem;
644 usecs_rem = do_div(t, NSEC_PER_SEC);
645 usecs_rem /= 1000;
647 trace_seq_printf(s, "%5lu.%06lu | ",
648 (unsigned long)t, usecs_rem);
651 static void
652 print_graph_irq(struct trace_iterator *iter, unsigned long addr,
653 enum trace_type type, int cpu, pid_t pid, u32 flags)
655 struct trace_array *tr = iter->tr;
656 struct trace_seq *s = &iter->seq;
657 struct trace_entry *ent = iter->ent;
659 if (addr < (unsigned long)__irqentry_text_start ||
660 addr >= (unsigned long)__irqentry_text_end)
661 return;
663 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
664 /* Absolute time */
665 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
666 print_graph_abs_time(iter->ts, s);
668 /* Cpu */
669 if (flags & TRACE_GRAPH_PRINT_CPU)
670 print_graph_cpu(s, cpu);
672 /* Proc */
673 if (flags & TRACE_GRAPH_PRINT_PROC) {
674 print_graph_proc(s, pid);
675 trace_seq_puts(s, " | ");
678 /* Latency format */
679 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
680 print_graph_lat_fmt(s, ent);
683 /* No overhead */
684 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_START);
686 if (type == TRACE_GRAPH_ENT)
687 trace_seq_puts(s, "==========>");
688 else
689 trace_seq_puts(s, "<==========");
691 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_END);
692 trace_seq_putc(s, '\n');
695 void
696 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s)
698 unsigned long nsecs_rem = do_div(duration, 1000);
699 /* log10(ULONG_MAX) + '\0' */
700 char usecs_str[21];
701 char nsecs_str[5];
702 int len;
703 int i;
705 sprintf(usecs_str, "%lu", (unsigned long) duration);
707 /* Print msecs */
708 trace_seq_printf(s, "%s", usecs_str);
710 len = strlen(usecs_str);
712 /* Print nsecs (we don't want to exceed 7 numbers) */
713 if (len < 7) {
714 size_t slen = min_t(size_t, sizeof(nsecs_str), 8UL - len);
716 snprintf(nsecs_str, slen, "%03lu", nsecs_rem);
717 trace_seq_printf(s, ".%s", nsecs_str);
718 len += strlen(nsecs_str) + 1;
721 trace_seq_puts(s, " us ");
723 /* Print remaining spaces to fit the row's width */
724 for (i = len; i < 8; i++)
725 trace_seq_putc(s, ' ');
728 static void
729 print_graph_duration(struct trace_array *tr, unsigned long long duration,
730 struct trace_seq *s, u32 flags)
732 if (!(flags & TRACE_GRAPH_PRINT_DURATION) ||
733 !(tr->trace_flags & TRACE_ITER_CONTEXT_INFO))
734 return;
736 /* No real adata, just filling the column with spaces */
737 switch (flags & TRACE_GRAPH_PRINT_FILL_MASK) {
738 case FLAGS_FILL_FULL:
739 trace_seq_puts(s, " | ");
740 return;
741 case FLAGS_FILL_START:
742 trace_seq_puts(s, " ");
743 return;
744 case FLAGS_FILL_END:
745 trace_seq_puts(s, " |");
746 return;
749 /* Signal a overhead of time execution to the output */
750 if (flags & TRACE_GRAPH_PRINT_OVERHEAD)
751 trace_seq_printf(s, "%c ", trace_find_mark(duration));
752 else
753 trace_seq_puts(s, " ");
755 trace_print_graph_duration(duration, s);
756 trace_seq_puts(s, "| ");
759 /* Case of a leaf function on its call entry */
760 static enum print_line_t
761 print_graph_entry_leaf(struct trace_iterator *iter,
762 struct ftrace_graph_ent_entry *entry,
763 struct ftrace_graph_ret_entry *ret_entry,
764 struct trace_seq *s, u32 flags)
766 struct fgraph_data *data = iter->private;
767 struct trace_array *tr = iter->tr;
768 struct ftrace_graph_ret *graph_ret;
769 struct ftrace_graph_ent *call;
770 unsigned long long duration;
771 int cpu = iter->cpu;
772 int i;
774 graph_ret = &ret_entry->ret;
775 call = &entry->graph_ent;
776 duration = graph_ret->rettime - graph_ret->calltime;
778 if (data) {
779 struct fgraph_cpu_data *cpu_data;
781 cpu_data = per_cpu_ptr(data->cpu_data, cpu);
783 /* If a graph tracer ignored set_graph_notrace */
784 if (call->depth < -1)
785 call->depth += FTRACE_NOTRACE_DEPTH;
788 * Comments display at + 1 to depth. Since
789 * this is a leaf function, keep the comments
790 * equal to this depth.
792 cpu_data->depth = call->depth - 1;
794 /* No need to keep this function around for this depth */
795 if (call->depth < FTRACE_RETFUNC_DEPTH &&
796 !WARN_ON_ONCE(call->depth < 0))
797 cpu_data->enter_funcs[call->depth] = 0;
800 /* Overhead and duration */
801 print_graph_duration(tr, duration, s, flags);
803 /* Function */
804 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++)
805 trace_seq_putc(s, ' ');
807 trace_seq_printf(s, "%ps();\n", (void *)call->func);
809 print_graph_irq(iter, graph_ret->func, TRACE_GRAPH_RET,
810 cpu, iter->ent->pid, flags);
812 return trace_handle_return(s);
815 static enum print_line_t
816 print_graph_entry_nested(struct trace_iterator *iter,
817 struct ftrace_graph_ent_entry *entry,
818 struct trace_seq *s, int cpu, u32 flags)
820 struct ftrace_graph_ent *call = &entry->graph_ent;
821 struct fgraph_data *data = iter->private;
822 struct trace_array *tr = iter->tr;
823 int i;
825 if (data) {
826 struct fgraph_cpu_data *cpu_data;
827 int cpu = iter->cpu;
829 /* If a graph tracer ignored set_graph_notrace */
830 if (call->depth < -1)
831 call->depth += FTRACE_NOTRACE_DEPTH;
833 cpu_data = per_cpu_ptr(data->cpu_data, cpu);
834 cpu_data->depth = call->depth;
836 /* Save this function pointer to see if the exit matches */
837 if (call->depth < FTRACE_RETFUNC_DEPTH &&
838 !WARN_ON_ONCE(call->depth < 0))
839 cpu_data->enter_funcs[call->depth] = call->func;
842 /* No time */
843 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_FULL);
845 /* Function */
846 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++)
847 trace_seq_putc(s, ' ');
849 trace_seq_printf(s, "%ps() {\n", (void *)call->func);
851 if (trace_seq_has_overflowed(s))
852 return TRACE_TYPE_PARTIAL_LINE;
855 * we already consumed the current entry to check the next one
856 * and see if this is a leaf.
858 return TRACE_TYPE_NO_CONSUME;
861 static void
862 print_graph_prologue(struct trace_iterator *iter, struct trace_seq *s,
863 int type, unsigned long addr, u32 flags)
865 struct fgraph_data *data = iter->private;
866 struct trace_entry *ent = iter->ent;
867 struct trace_array *tr = iter->tr;
868 int cpu = iter->cpu;
870 /* Pid */
871 verif_pid(s, ent->pid, cpu, data);
873 if (type)
874 /* Interrupt */
875 print_graph_irq(iter, addr, type, cpu, ent->pid, flags);
877 if (!(tr->trace_flags & TRACE_ITER_CONTEXT_INFO))
878 return;
880 /* Absolute time */
881 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
882 print_graph_abs_time(iter->ts, s);
884 /* Cpu */
885 if (flags & TRACE_GRAPH_PRINT_CPU)
886 print_graph_cpu(s, cpu);
888 /* Proc */
889 if (flags & TRACE_GRAPH_PRINT_PROC) {
890 print_graph_proc(s, ent->pid);
891 trace_seq_puts(s, " | ");
894 /* Latency format */
895 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
896 print_graph_lat_fmt(s, ent);
898 return;
902 * Entry check for irq code
904 * returns 1 if
905 * - we are inside irq code
906 * - we just entered irq code
908 * retunns 0 if
909 * - funcgraph-interrupts option is set
910 * - we are not inside irq code
912 static int
913 check_irq_entry(struct trace_iterator *iter, u32 flags,
914 unsigned long addr, int depth)
916 int cpu = iter->cpu;
917 int *depth_irq;
918 struct fgraph_data *data = iter->private;
921 * If we are either displaying irqs, or we got called as
922 * a graph event and private data does not exist,
923 * then we bypass the irq check.
925 if ((flags & TRACE_GRAPH_PRINT_IRQS) ||
926 (!data))
927 return 0;
929 depth_irq = &(per_cpu_ptr(data->cpu_data, cpu)->depth_irq);
932 * We are inside the irq code
934 if (*depth_irq >= 0)
935 return 1;
937 if ((addr < (unsigned long)__irqentry_text_start) ||
938 (addr >= (unsigned long)__irqentry_text_end))
939 return 0;
942 * We are entering irq code.
944 *depth_irq = depth;
945 return 1;
949 * Return check for irq code
951 * returns 1 if
952 * - we are inside irq code
953 * - we just left irq code
955 * returns 0 if
956 * - funcgraph-interrupts option is set
957 * - we are not inside irq code
959 static int
960 check_irq_return(struct trace_iterator *iter, u32 flags, int depth)
962 int cpu = iter->cpu;
963 int *depth_irq;
964 struct fgraph_data *data = iter->private;
967 * If we are either displaying irqs, or we got called as
968 * a graph event and private data does not exist,
969 * then we bypass the irq check.
971 if ((flags & TRACE_GRAPH_PRINT_IRQS) ||
972 (!data))
973 return 0;
975 depth_irq = &(per_cpu_ptr(data->cpu_data, cpu)->depth_irq);
978 * We are not inside the irq code.
980 if (*depth_irq == -1)
981 return 0;
984 * We are inside the irq code, and this is returning entry.
985 * Let's not trace it and clear the entry depth, since
986 * we are out of irq code.
988 * This condition ensures that we 'leave the irq code' once
989 * we are out of the entry depth. Thus protecting us from
990 * the RETURN entry loss.
992 if (*depth_irq >= depth) {
993 *depth_irq = -1;
994 return 1;
998 * We are inside the irq code, and this is not the entry.
1000 return 1;
1003 static enum print_line_t
1004 print_graph_entry(struct ftrace_graph_ent_entry *field, struct trace_seq *s,
1005 struct trace_iterator *iter, u32 flags)
1007 struct fgraph_data *data = iter->private;
1008 struct ftrace_graph_ent *call = &field->graph_ent;
1009 struct ftrace_graph_ret_entry *leaf_ret;
1010 static enum print_line_t ret;
1011 int cpu = iter->cpu;
1013 if (check_irq_entry(iter, flags, call->func, call->depth))
1014 return TRACE_TYPE_HANDLED;
1016 print_graph_prologue(iter, s, TRACE_GRAPH_ENT, call->func, flags);
1018 leaf_ret = get_return_for_leaf(iter, field);
1019 if (leaf_ret)
1020 ret = print_graph_entry_leaf(iter, field, leaf_ret, s, flags);
1021 else
1022 ret = print_graph_entry_nested(iter, field, s, cpu, flags);
1024 if (data) {
1026 * If we failed to write our output, then we need to make
1027 * note of it. Because we already consumed our entry.
1029 if (s->full) {
1030 data->failed = 1;
1031 data->cpu = cpu;
1032 } else
1033 data->failed = 0;
1036 return ret;
1039 static enum print_line_t
1040 print_graph_return(struct ftrace_graph_ret *trace, struct trace_seq *s,
1041 struct trace_entry *ent, struct trace_iterator *iter,
1042 u32 flags)
1044 unsigned long long duration = trace->rettime - trace->calltime;
1045 struct fgraph_data *data = iter->private;
1046 struct trace_array *tr = iter->tr;
1047 pid_t pid = ent->pid;
1048 int cpu = iter->cpu;
1049 int func_match = 1;
1050 int i;
1052 if (check_irq_return(iter, flags, trace->depth))
1053 return TRACE_TYPE_HANDLED;
1055 if (data) {
1056 struct fgraph_cpu_data *cpu_data;
1057 int cpu = iter->cpu;
1059 cpu_data = per_cpu_ptr(data->cpu_data, cpu);
1062 * Comments display at + 1 to depth. This is the
1063 * return from a function, we now want the comments
1064 * to display at the same level of the bracket.
1066 cpu_data->depth = trace->depth - 1;
1068 if (trace->depth < FTRACE_RETFUNC_DEPTH &&
1069 !WARN_ON_ONCE(trace->depth < 0)) {
1070 if (cpu_data->enter_funcs[trace->depth] != trace->func)
1071 func_match = 0;
1072 cpu_data->enter_funcs[trace->depth] = 0;
1076 print_graph_prologue(iter, s, 0, 0, flags);
1078 /* Overhead and duration */
1079 print_graph_duration(tr, duration, s, flags);
1081 /* Closing brace */
1082 for (i = 0; i < trace->depth * TRACE_GRAPH_INDENT; i++)
1083 trace_seq_putc(s, ' ');
1086 * If the return function does not have a matching entry,
1087 * then the entry was lost. Instead of just printing
1088 * the '}' and letting the user guess what function this
1089 * belongs to, write out the function name. Always do
1090 * that if the funcgraph-tail option is enabled.
1092 if (func_match && !(flags & TRACE_GRAPH_PRINT_TAIL))
1093 trace_seq_puts(s, "}\n");
1094 else
1095 trace_seq_printf(s, "} /* %ps */\n", (void *)trace->func);
1097 /* Overrun */
1098 if (flags & TRACE_GRAPH_PRINT_OVERRUN)
1099 trace_seq_printf(s, " (Overruns: %lu)\n",
1100 trace->overrun);
1102 print_graph_irq(iter, trace->func, TRACE_GRAPH_RET,
1103 cpu, pid, flags);
1105 return trace_handle_return(s);
1108 static enum print_line_t
1109 print_graph_comment(struct trace_seq *s, struct trace_entry *ent,
1110 struct trace_iterator *iter, u32 flags)
1112 struct trace_array *tr = iter->tr;
1113 unsigned long sym_flags = (tr->trace_flags & TRACE_ITER_SYM_MASK);
1114 struct fgraph_data *data = iter->private;
1115 struct trace_event *event;
1116 int depth = 0;
1117 int ret;
1118 int i;
1120 if (data)
1121 depth = per_cpu_ptr(data->cpu_data, iter->cpu)->depth;
1123 print_graph_prologue(iter, s, 0, 0, flags);
1125 /* No time */
1126 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_FULL);
1128 /* Indentation */
1129 if (depth > 0)
1130 for (i = 0; i < (depth + 1) * TRACE_GRAPH_INDENT; i++)
1131 trace_seq_putc(s, ' ');
1133 /* The comment */
1134 trace_seq_puts(s, "/* ");
1136 switch (iter->ent->type) {
1137 case TRACE_BPRINT:
1138 ret = trace_print_bprintk_msg_only(iter);
1139 if (ret != TRACE_TYPE_HANDLED)
1140 return ret;
1141 break;
1142 case TRACE_PRINT:
1143 ret = trace_print_printk_msg_only(iter);
1144 if (ret != TRACE_TYPE_HANDLED)
1145 return ret;
1146 break;
1147 default:
1148 event = ftrace_find_event(ent->type);
1149 if (!event)
1150 return TRACE_TYPE_UNHANDLED;
1152 ret = event->funcs->trace(iter, sym_flags, event);
1153 if (ret != TRACE_TYPE_HANDLED)
1154 return ret;
1157 if (trace_seq_has_overflowed(s))
1158 goto out;
1160 /* Strip ending newline */
1161 if (s->buffer[s->seq.len - 1] == '\n') {
1162 s->buffer[s->seq.len - 1] = '\0';
1163 s->seq.len--;
1166 trace_seq_puts(s, " */\n");
1167 out:
1168 return trace_handle_return(s);
1172 enum print_line_t
1173 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
1175 struct ftrace_graph_ent_entry *field;
1176 struct fgraph_data *data = iter->private;
1177 struct trace_entry *entry = iter->ent;
1178 struct trace_seq *s = &iter->seq;
1179 int cpu = iter->cpu;
1180 int ret;
1182 if (data && per_cpu_ptr(data->cpu_data, cpu)->ignore) {
1183 per_cpu_ptr(data->cpu_data, cpu)->ignore = 0;
1184 return TRACE_TYPE_HANDLED;
1188 * If the last output failed, there's a possibility we need
1189 * to print out the missing entry which would never go out.
1191 if (data && data->failed) {
1192 field = &data->ent;
1193 iter->cpu = data->cpu;
1194 ret = print_graph_entry(field, s, iter, flags);
1195 if (ret == TRACE_TYPE_HANDLED && iter->cpu != cpu) {
1196 per_cpu_ptr(data->cpu_data, iter->cpu)->ignore = 1;
1197 ret = TRACE_TYPE_NO_CONSUME;
1199 iter->cpu = cpu;
1200 return ret;
1203 switch (entry->type) {
1204 case TRACE_GRAPH_ENT: {
1206 * print_graph_entry() may consume the current event,
1207 * thus @field may become invalid, so we need to save it.
1208 * sizeof(struct ftrace_graph_ent_entry) is very small,
1209 * it can be safely saved at the stack.
1211 struct ftrace_graph_ent_entry saved;
1212 trace_assign_type(field, entry);
1213 saved = *field;
1214 return print_graph_entry(&saved, s, iter, flags);
1216 case TRACE_GRAPH_RET: {
1217 struct ftrace_graph_ret_entry *field;
1218 trace_assign_type(field, entry);
1219 return print_graph_return(&field->ret, s, entry, iter, flags);
1221 case TRACE_STACK:
1222 case TRACE_FN:
1223 /* dont trace stack and functions as comments */
1224 return TRACE_TYPE_UNHANDLED;
1226 default:
1227 return print_graph_comment(s, entry, iter, flags);
1230 return TRACE_TYPE_HANDLED;
1233 static enum print_line_t
1234 print_graph_function(struct trace_iterator *iter)
1236 return print_graph_function_flags(iter, tracer_flags.val);
1239 static enum print_line_t
1240 print_graph_function_event(struct trace_iterator *iter, int flags,
1241 struct trace_event *event)
1243 return print_graph_function(iter);
1246 static void print_lat_header(struct seq_file *s, u32 flags)
1248 static const char spaces[] = " " /* 16 spaces */
1249 " " /* 4 spaces */
1250 " "; /* 17 spaces */
1251 int size = 0;
1253 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
1254 size += 16;
1255 if (flags & TRACE_GRAPH_PRINT_CPU)
1256 size += 4;
1257 if (flags & TRACE_GRAPH_PRINT_PROC)
1258 size += 17;
1260 seq_printf(s, "#%.*s _-----=> irqs-off \n", size, spaces);
1261 seq_printf(s, "#%.*s / _----=> need-resched \n", size, spaces);
1262 seq_printf(s, "#%.*s| / _---=> hardirq/softirq \n", size, spaces);
1263 seq_printf(s, "#%.*s|| / _--=> preempt-depth \n", size, spaces);
1264 seq_printf(s, "#%.*s||| / \n", size, spaces);
1267 static void __print_graph_headers_flags(struct trace_array *tr,
1268 struct seq_file *s, u32 flags)
1270 int lat = tr->trace_flags & TRACE_ITER_LATENCY_FMT;
1272 if (lat)
1273 print_lat_header(s, flags);
1275 /* 1st line */
1276 seq_putc(s, '#');
1277 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
1278 seq_puts(s, " TIME ");
1279 if (flags & TRACE_GRAPH_PRINT_CPU)
1280 seq_puts(s, " CPU");
1281 if (flags & TRACE_GRAPH_PRINT_PROC)
1282 seq_puts(s, " TASK/PID ");
1283 if (lat)
1284 seq_puts(s, "||||");
1285 if (flags & TRACE_GRAPH_PRINT_DURATION)
1286 seq_puts(s, " DURATION ");
1287 seq_puts(s, " FUNCTION CALLS\n");
1289 /* 2nd line */
1290 seq_putc(s, '#');
1291 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
1292 seq_puts(s, " | ");
1293 if (flags & TRACE_GRAPH_PRINT_CPU)
1294 seq_puts(s, " | ");
1295 if (flags & TRACE_GRAPH_PRINT_PROC)
1296 seq_puts(s, " | | ");
1297 if (lat)
1298 seq_puts(s, "||||");
1299 if (flags & TRACE_GRAPH_PRINT_DURATION)
1300 seq_puts(s, " | | ");
1301 seq_puts(s, " | | | |\n");
1304 static void print_graph_headers(struct seq_file *s)
1306 print_graph_headers_flags(s, tracer_flags.val);
1309 void print_graph_headers_flags(struct seq_file *s, u32 flags)
1311 struct trace_iterator *iter = s->private;
1312 struct trace_array *tr = iter->tr;
1314 if (!(tr->trace_flags & TRACE_ITER_CONTEXT_INFO))
1315 return;
1317 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT) {
1318 /* print nothing if the buffers are empty */
1319 if (trace_empty(iter))
1320 return;
1322 print_trace_header(s, iter);
1325 __print_graph_headers_flags(tr, s, flags);
1328 void graph_trace_open(struct trace_iterator *iter)
1330 /* pid and depth on the last trace processed */
1331 struct fgraph_data *data;
1332 gfp_t gfpflags;
1333 int cpu;
1335 iter->private = NULL;
1337 /* We can be called in atomic context via ftrace_dump() */
1338 gfpflags = (in_atomic() || irqs_disabled()) ? GFP_ATOMIC : GFP_KERNEL;
1340 data = kzalloc(sizeof(*data), gfpflags);
1341 if (!data)
1342 goto out_err;
1344 data->cpu_data = alloc_percpu_gfp(struct fgraph_cpu_data, gfpflags);
1345 if (!data->cpu_data)
1346 goto out_err_free;
1348 for_each_possible_cpu(cpu) {
1349 pid_t *pid = &(per_cpu_ptr(data->cpu_data, cpu)->last_pid);
1350 int *depth = &(per_cpu_ptr(data->cpu_data, cpu)->depth);
1351 int *ignore = &(per_cpu_ptr(data->cpu_data, cpu)->ignore);
1352 int *depth_irq = &(per_cpu_ptr(data->cpu_data, cpu)->depth_irq);
1354 *pid = -1;
1355 *depth = 0;
1356 *ignore = 0;
1357 *depth_irq = -1;
1360 iter->private = data;
1362 return;
1364 out_err_free:
1365 kfree(data);
1366 out_err:
1367 pr_warning("function graph tracer: not enough memory\n");
1370 void graph_trace_close(struct trace_iterator *iter)
1372 struct fgraph_data *data = iter->private;
1374 if (data) {
1375 free_percpu(data->cpu_data);
1376 kfree(data);
1380 static int
1381 func_graph_set_flag(struct trace_array *tr, u32 old_flags, u32 bit, int set)
1383 if (bit == TRACE_GRAPH_PRINT_IRQS)
1384 ftrace_graph_skip_irqs = !set;
1386 if (bit == TRACE_GRAPH_SLEEP_TIME)
1387 ftrace_graph_sleep_time_control(set);
1389 if (bit == TRACE_GRAPH_GRAPH_TIME)
1390 ftrace_graph_graph_time_control(set);
1392 return 0;
1395 static struct trace_event_functions graph_functions = {
1396 .trace = print_graph_function_event,
1399 static struct trace_event graph_trace_entry_event = {
1400 .type = TRACE_GRAPH_ENT,
1401 .funcs = &graph_functions,
1404 static struct trace_event graph_trace_ret_event = {
1405 .type = TRACE_GRAPH_RET,
1406 .funcs = &graph_functions
1409 static struct tracer graph_trace __tracer_data = {
1410 .name = "function_graph",
1411 .update_thresh = graph_trace_update_thresh,
1412 .open = graph_trace_open,
1413 .pipe_open = graph_trace_open,
1414 .close = graph_trace_close,
1415 .pipe_close = graph_trace_close,
1416 .init = graph_trace_init,
1417 .reset = graph_trace_reset,
1418 .print_line = print_graph_function,
1419 .print_header = print_graph_headers,
1420 .flags = &tracer_flags,
1421 .set_flag = func_graph_set_flag,
1422 #ifdef CONFIG_FTRACE_SELFTEST
1423 .selftest = trace_selftest_startup_function_graph,
1424 #endif
1428 static ssize_t
1429 graph_depth_write(struct file *filp, const char __user *ubuf, size_t cnt,
1430 loff_t *ppos)
1432 unsigned long val;
1433 int ret;
1435 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
1436 if (ret)
1437 return ret;
1439 max_depth = val;
1441 *ppos += cnt;
1443 return cnt;
1446 static ssize_t
1447 graph_depth_read(struct file *filp, char __user *ubuf, size_t cnt,
1448 loff_t *ppos)
1450 char buf[15]; /* More than enough to hold UINT_MAX + "\n"*/
1451 int n;
1453 n = sprintf(buf, "%d\n", max_depth);
1455 return simple_read_from_buffer(ubuf, cnt, ppos, buf, n);
1458 static const struct file_operations graph_depth_fops = {
1459 .open = tracing_open_generic,
1460 .write = graph_depth_write,
1461 .read = graph_depth_read,
1462 .llseek = generic_file_llseek,
1465 static __init int init_graph_tracefs(void)
1467 struct dentry *d_tracer;
1469 d_tracer = tracing_init_dentry();
1470 if (IS_ERR(d_tracer))
1471 return 0;
1473 trace_create_file("max_graph_depth", 0644, d_tracer,
1474 NULL, &graph_depth_fops);
1476 return 0;
1478 fs_initcall(init_graph_tracefs);
1480 static __init int init_graph_trace(void)
1482 max_bytes_for_cpu = snprintf(NULL, 0, "%d", nr_cpu_ids - 1);
1484 if (!register_trace_event(&graph_trace_entry_event)) {
1485 pr_warning("Warning: could not register graph trace events\n");
1486 return 1;
1489 if (!register_trace_event(&graph_trace_ret_event)) {
1490 pr_warning("Warning: could not register graph trace events\n");
1491 return 1;
1494 return register_tracer(&graph_trace);
1497 core_initcall(init_graph_trace);