Loading...
1/*
2 *
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>
7 *
8 */
9#include <linux/uaccess.h>
10#include <linux/ftrace.h>
11#include <linux/interrupt.h>
12#include <linux/slab.h>
13#include <linux/fs.h>
14
15#include "trace.h"
16#include "trace_output.h"
17
18static bool kill_ftrace_graph;
19
20/**
21 * ftrace_graph_is_dead - returns true if ftrace_graph_stop() was called
22 *
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.
26 */
27bool ftrace_graph_is_dead(void)
28{
29 return kill_ftrace_graph;
30}
31
32/**
33 * ftrace_graph_stop - set to permanently disable function graph tracincg
34 *
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.
39 */
40void ftrace_graph_stop(void)
41{
42 kill_ftrace_graph = true;
43}
44
45/* When set, irq functions will be ignored */
46static int ftrace_graph_skip_irqs;
47
48struct fgraph_cpu_data {
49 pid_t last_pid;
50 int depth;
51 int depth_irq;
52 int ignore;
53 unsigned long enter_funcs[FTRACE_RETFUNC_DEPTH];
54};
55
56struct fgraph_data {
57 struct fgraph_cpu_data __percpu *cpu_data;
58
59 /* Place to preserve last processed entry. */
60 struct ftrace_graph_ent_entry ent;
61 struct ftrace_graph_ret_entry ret;
62 int failed;
63 int cpu;
64};
65
66#define TRACE_GRAPH_INDENT 2
67
68static unsigned int max_depth;
69
70static struct tracer_opt trace_opts[] = {
71 /* Display overruns? (for self-debug purpose) */
72 { TRACER_OPT(funcgraph-overrun, TRACE_GRAPH_PRINT_OVERRUN) },
73 /* Display CPU ? */
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) },
91 { } /* Empty entry */
92};
93
94static 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,
99 .opts = trace_opts
100};
101
102static struct trace_array *graph_array;
103
104/*
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.
108 */
109enum {
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,
113};
114
115static void
116print_graph_duration(struct trace_array *tr, unsigned long long duration,
117 struct trace_seq *s, u32 flags);
118
119/* Add a function return address to the trace stack on thread info.*/
120int
121ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
122 unsigned long frame_pointer)
123{
124 unsigned long long calltime;
125 int index;
126
127 if (unlikely(ftrace_graph_is_dead()))
128 return -EBUSY;
129
130 if (!current->ret_stack)
131 return -EBUSY;
132
133 /*
134 * We must make sure the ret_stack is tested before we read
135 * anything else.
136 */
137 smp_rmb();
138
139 /* The return trace stack is full */
140 if (current->curr_ret_stack == FTRACE_RETFUNC_DEPTH - 1) {
141 atomic_inc(¤t->trace_overrun);
142 return -EBUSY;
143 }
144
145 /*
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.
155 *
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.
160 */
161 if (current->curr_ret_stack < -1)
162 return -EBUSY;
163
164 calltime = trace_clock_local();
165
166 index = ++current->curr_ret_stack;
167 if (ftrace_graph_notrace_addr(func))
168 current->curr_ret_stack -= FTRACE_NOTRACE_DEPTH;
169 barrier();
170 current->ret_stack[index].ret = ret;
171 current->ret_stack[index].func = func;
172 current->ret_stack[index].calltime = calltime;
173 current->ret_stack[index].subtime = 0;
174 current->ret_stack[index].fp = frame_pointer;
175 *depth = current->curr_ret_stack;
176
177 return 0;
178}
179
180/* Retrieve a function return address to the trace stack on thread info.*/
181static void
182ftrace_pop_return_trace(struct ftrace_graph_ret *trace, unsigned long *ret,
183 unsigned long frame_pointer)
184{
185 int index;
186
187 index = current->curr_ret_stack;
188
189 /*
190 * A negative index here means that it's just returned from a
191 * notrace'd function. Recover index to get an original
192 * return address. See ftrace_push_return_trace().
193 *
194 * TODO: Need to check whether the stack gets corrupted.
195 */
196 if (index < 0)
197 index += FTRACE_NOTRACE_DEPTH;
198
199 if (unlikely(index < 0 || index >= FTRACE_RETFUNC_DEPTH)) {
200 ftrace_graph_stop();
201 WARN_ON(1);
202 /* Might as well panic, otherwise we have no where to go */
203 *ret = (unsigned long)panic;
204 return;
205 }
206
207#if defined(CONFIG_HAVE_FUNCTION_GRAPH_FP_TEST) && !defined(CC_USING_FENTRY)
208 /*
209 * The arch may choose to record the frame pointer used
210 * and check it here to make sure that it is what we expect it
211 * to be. If gcc does not set the place holder of the return
212 * address in the frame pointer, and does a copy instead, then
213 * the function graph trace will fail. This test detects this
214 * case.
215 *
216 * Currently, x86_32 with optimize for size (-Os) makes the latest
217 * gcc do the above.
218 *
219 * Note, -mfentry does not use frame pointers, and this test
220 * is not needed if CC_USING_FENTRY is set.
221 */
222 if (unlikely(current->ret_stack[index].fp != frame_pointer)) {
223 ftrace_graph_stop();
224 WARN(1, "Bad frame pointer: expected %lx, received %lx\n"
225 " from func %ps return to %lx\n",
226 current->ret_stack[index].fp,
227 frame_pointer,
228 (void *)current->ret_stack[index].func,
229 current->ret_stack[index].ret);
230 *ret = (unsigned long)panic;
231 return;
232 }
233#endif
234
235 *ret = current->ret_stack[index].ret;
236 trace->func = current->ret_stack[index].func;
237 trace->calltime = current->ret_stack[index].calltime;
238 trace->overrun = atomic_read(¤t->trace_overrun);
239 trace->depth = index;
240}
241
242/*
243 * Send the trace to the ring-buffer.
244 * @return the original return address.
245 */
246unsigned long ftrace_return_to_handler(unsigned long frame_pointer)
247{
248 struct ftrace_graph_ret trace;
249 unsigned long ret;
250
251 ftrace_pop_return_trace(&trace, &ret, frame_pointer);
252 trace.rettime = trace_clock_local();
253 barrier();
254 current->curr_ret_stack--;
255 /*
256 * The curr_ret_stack can be less than -1 only if it was
257 * filtered out and it's about to return from the function.
258 * Recover the index and continue to trace normal functions.
259 */
260 if (current->curr_ret_stack < -1) {
261 current->curr_ret_stack += FTRACE_NOTRACE_DEPTH;
262 return ret;
263 }
264
265 /*
266 * The trace should run after decrementing the ret counter
267 * in case an interrupt were to come in. We don't want to
268 * lose the interrupt if max_depth is set.
269 */
270 ftrace_graph_return(&trace);
271
272 if (unlikely(!ret)) {
273 ftrace_graph_stop();
274 WARN_ON(1);
275 /* Might as well panic. What else to do? */
276 ret = (unsigned long)panic;
277 }
278
279 return ret;
280}
281
282int __trace_graph_entry(struct trace_array *tr,
283 struct ftrace_graph_ent *trace,
284 unsigned long flags,
285 int pc)
286{
287 struct trace_event_call *call = &event_funcgraph_entry;
288 struct ring_buffer_event *event;
289 struct ring_buffer *buffer = tr->trace_buffer.buffer;
290 struct ftrace_graph_ent_entry *entry;
291
292 event = trace_buffer_lock_reserve(buffer, TRACE_GRAPH_ENT,
293 sizeof(*entry), flags, pc);
294 if (!event)
295 return 0;
296 entry = ring_buffer_event_data(event);
297 entry->graph_ent = *trace;
298 if (!call_filter_check_discard(call, entry, buffer, event))
299 __buffer_unlock_commit(buffer, event);
300
301 return 1;
302}
303
304static inline int ftrace_graph_ignore_irqs(void)
305{
306 if (!ftrace_graph_skip_irqs || trace_recursion_test(TRACE_IRQ_BIT))
307 return 0;
308
309 return in_irq();
310}
311
312int trace_graph_entry(struct ftrace_graph_ent *trace)
313{
314 struct trace_array *tr = graph_array;
315 struct trace_array_cpu *data;
316 unsigned long flags;
317 long disabled;
318 int ret;
319 int cpu;
320 int pc;
321
322 if (!ftrace_trace_task(current))
323 return 0;
324
325 /* trace it when it is-nested-in or is a function enabled. */
326 if ((!(trace->depth || ftrace_graph_addr(trace->func)) ||
327 ftrace_graph_ignore_irqs()) || (trace->depth < 0) ||
328 (max_depth && trace->depth >= max_depth))
329 return 0;
330
331 /*
332 * Do not trace a function if it's filtered by set_graph_notrace.
333 * Make the index of ret stack negative to indicate that it should
334 * ignore further functions. But it needs its own ret stack entry
335 * to recover the original index in order to continue tracing after
336 * returning from the function.
337 */
338 if (ftrace_graph_notrace_addr(trace->func))
339 return 1;
340
341 local_irq_save(flags);
342 cpu = raw_smp_processor_id();
343 data = per_cpu_ptr(tr->trace_buffer.data, cpu);
344 disabled = atomic_inc_return(&data->disabled);
345 if (likely(disabled == 1)) {
346 pc = preempt_count();
347 ret = __trace_graph_entry(tr, trace, flags, pc);
348 } else {
349 ret = 0;
350 }
351
352 atomic_dec(&data->disabled);
353 local_irq_restore(flags);
354
355 return ret;
356}
357
358static int trace_graph_thresh_entry(struct ftrace_graph_ent *trace)
359{
360 if (tracing_thresh)
361 return 1;
362 else
363 return trace_graph_entry(trace);
364}
365
366static void
367__trace_graph_function(struct trace_array *tr,
368 unsigned long ip, unsigned long flags, int pc)
369{
370 u64 time = trace_clock_local();
371 struct ftrace_graph_ent ent = {
372 .func = ip,
373 .depth = 0,
374 };
375 struct ftrace_graph_ret ret = {
376 .func = ip,
377 .depth = 0,
378 .calltime = time,
379 .rettime = time,
380 };
381
382 __trace_graph_entry(tr, &ent, flags, pc);
383 __trace_graph_return(tr, &ret, flags, pc);
384}
385
386void
387trace_graph_function(struct trace_array *tr,
388 unsigned long ip, unsigned long parent_ip,
389 unsigned long flags, int pc)
390{
391 __trace_graph_function(tr, ip, flags, pc);
392}
393
394void __trace_graph_return(struct trace_array *tr,
395 struct ftrace_graph_ret *trace,
396 unsigned long flags,
397 int pc)
398{
399 struct trace_event_call *call = &event_funcgraph_exit;
400 struct ring_buffer_event *event;
401 struct ring_buffer *buffer = tr->trace_buffer.buffer;
402 struct ftrace_graph_ret_entry *entry;
403
404 event = trace_buffer_lock_reserve(buffer, TRACE_GRAPH_RET,
405 sizeof(*entry), flags, pc);
406 if (!event)
407 return;
408 entry = ring_buffer_event_data(event);
409 entry->ret = *trace;
410 if (!call_filter_check_discard(call, entry, buffer, event))
411 __buffer_unlock_commit(buffer, event);
412}
413
414void trace_graph_return(struct ftrace_graph_ret *trace)
415{
416 struct trace_array *tr = graph_array;
417 struct trace_array_cpu *data;
418 unsigned long flags;
419 long disabled;
420 int cpu;
421 int pc;
422
423 local_irq_save(flags);
424 cpu = raw_smp_processor_id();
425 data = per_cpu_ptr(tr->trace_buffer.data, cpu);
426 disabled = atomic_inc_return(&data->disabled);
427 if (likely(disabled == 1)) {
428 pc = preempt_count();
429 __trace_graph_return(tr, trace, flags, pc);
430 }
431 atomic_dec(&data->disabled);
432 local_irq_restore(flags);
433}
434
435void set_graph_array(struct trace_array *tr)
436{
437 graph_array = tr;
438
439 /* Make graph_array visible before we start tracing */
440
441 smp_mb();
442}
443
444static void trace_graph_thresh_return(struct ftrace_graph_ret *trace)
445{
446 if (tracing_thresh &&
447 (trace->rettime - trace->calltime < tracing_thresh))
448 return;
449 else
450 trace_graph_return(trace);
451}
452
453static int graph_trace_init(struct trace_array *tr)
454{
455 int ret;
456
457 set_graph_array(tr);
458 if (tracing_thresh)
459 ret = register_ftrace_graph(&trace_graph_thresh_return,
460 &trace_graph_thresh_entry);
461 else
462 ret = register_ftrace_graph(&trace_graph_return,
463 &trace_graph_entry);
464 if (ret)
465 return ret;
466 tracing_start_cmdline_record();
467
468 return 0;
469}
470
471static void graph_trace_reset(struct trace_array *tr)
472{
473 tracing_stop_cmdline_record();
474 unregister_ftrace_graph();
475}
476
477static int graph_trace_update_thresh(struct trace_array *tr)
478{
479 graph_trace_reset(tr);
480 return graph_trace_init(tr);
481}
482
483static int max_bytes_for_cpu;
484
485static void print_graph_cpu(struct trace_seq *s, int cpu)
486{
487 /*
488 * Start with a space character - to make it stand out
489 * to the right a bit when trace output is pasted into
490 * email:
491 */
492 trace_seq_printf(s, " %*d) ", max_bytes_for_cpu, cpu);
493}
494
495#define TRACE_GRAPH_PROCINFO_LENGTH 14
496
497static void print_graph_proc(struct trace_seq *s, pid_t pid)
498{
499 char comm[TASK_COMM_LEN];
500 /* sign + log10(MAX_INT) + '\0' */
501 char pid_str[11];
502 int spaces = 0;
503 int len;
504 int i;
505
506 trace_find_cmdline(pid, comm);
507 comm[7] = '\0';
508 sprintf(pid_str, "%d", pid);
509
510 /* 1 stands for the "-" character */
511 len = strlen(comm) + strlen(pid_str) + 1;
512
513 if (len < TRACE_GRAPH_PROCINFO_LENGTH)
514 spaces = TRACE_GRAPH_PROCINFO_LENGTH - len;
515
516 /* First spaces to align center */
517 for (i = 0; i < spaces / 2; i++)
518 trace_seq_putc(s, ' ');
519
520 trace_seq_printf(s, "%s-%s", comm, pid_str);
521
522 /* Last spaces to align center */
523 for (i = 0; i < spaces - (spaces / 2); i++)
524 trace_seq_putc(s, ' ');
525}
526
527
528static void print_graph_lat_fmt(struct trace_seq *s, struct trace_entry *entry)
529{
530 trace_seq_putc(s, ' ');
531 trace_print_lat_fmt(s, entry);
532}
533
534/* If the pid changed since the last trace, output this event */
535static void
536verif_pid(struct trace_seq *s, pid_t pid, int cpu, struct fgraph_data *data)
537{
538 pid_t prev_pid;
539 pid_t *last_pid;
540
541 if (!data)
542 return;
543
544 last_pid = &(per_cpu_ptr(data->cpu_data, cpu)->last_pid);
545
546 if (*last_pid == pid)
547 return;
548
549 prev_pid = *last_pid;
550 *last_pid = pid;
551
552 if (prev_pid == -1)
553 return;
554/*
555 * Context-switch trace line:
556
557 ------------------------------------------
558 | 1) migration/0--1 => sshd-1755
559 ------------------------------------------
560
561 */
562 trace_seq_puts(s, " ------------------------------------------\n");
563 print_graph_cpu(s, cpu);
564 print_graph_proc(s, prev_pid);
565 trace_seq_puts(s, " => ");
566 print_graph_proc(s, pid);
567 trace_seq_puts(s, "\n ------------------------------------------\n\n");
568}
569
570static struct ftrace_graph_ret_entry *
571get_return_for_leaf(struct trace_iterator *iter,
572 struct ftrace_graph_ent_entry *curr)
573{
574 struct fgraph_data *data = iter->private;
575 struct ring_buffer_iter *ring_iter = NULL;
576 struct ring_buffer_event *event;
577 struct ftrace_graph_ret_entry *next;
578
579 /*
580 * If the previous output failed to write to the seq buffer,
581 * then we just reuse the data from before.
582 */
583 if (data && data->failed) {
584 curr = &data->ent;
585 next = &data->ret;
586 } else {
587
588 ring_iter = trace_buffer_iter(iter, iter->cpu);
589
590 /* First peek to compare current entry and the next one */
591 if (ring_iter)
592 event = ring_buffer_iter_peek(ring_iter, NULL);
593 else {
594 /*
595 * We need to consume the current entry to see
596 * the next one.
597 */
598 ring_buffer_consume(iter->trace_buffer->buffer, iter->cpu,
599 NULL, NULL);
600 event = ring_buffer_peek(iter->trace_buffer->buffer, iter->cpu,
601 NULL, NULL);
602 }
603
604 if (!event)
605 return NULL;
606
607 next = ring_buffer_event_data(event);
608
609 if (data) {
610 /*
611 * Save current and next entries for later reference
612 * if the output fails.
613 */
614 data->ent = *curr;
615 /*
616 * If the next event is not a return type, then
617 * we only care about what type it is. Otherwise we can
618 * safely copy the entire event.
619 */
620 if (next->ent.type == TRACE_GRAPH_RET)
621 data->ret = *next;
622 else
623 data->ret.ent.type = next->ent.type;
624 }
625 }
626
627 if (next->ent.type != TRACE_GRAPH_RET)
628 return NULL;
629
630 if (curr->ent.pid != next->ent.pid ||
631 curr->graph_ent.func != next->ret.func)
632 return NULL;
633
634 /* this is a leaf, now advance the iterator */
635 if (ring_iter)
636 ring_buffer_read(ring_iter, NULL);
637
638 return next;
639}
640
641static void print_graph_abs_time(u64 t, struct trace_seq *s)
642{
643 unsigned long usecs_rem;
644
645 usecs_rem = do_div(t, NSEC_PER_SEC);
646 usecs_rem /= 1000;
647
648 trace_seq_printf(s, "%5lu.%06lu | ",
649 (unsigned long)t, usecs_rem);
650}
651
652static void
653print_graph_irq(struct trace_iterator *iter, unsigned long addr,
654 enum trace_type type, int cpu, pid_t pid, u32 flags)
655{
656 struct trace_array *tr = iter->tr;
657 struct trace_seq *s = &iter->seq;
658 struct trace_entry *ent = iter->ent;
659
660 if (addr < (unsigned long)__irqentry_text_start ||
661 addr >= (unsigned long)__irqentry_text_end)
662 return;
663
664 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
665 /* Absolute time */
666 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
667 print_graph_abs_time(iter->ts, s);
668
669 /* Cpu */
670 if (flags & TRACE_GRAPH_PRINT_CPU)
671 print_graph_cpu(s, cpu);
672
673 /* Proc */
674 if (flags & TRACE_GRAPH_PRINT_PROC) {
675 print_graph_proc(s, pid);
676 trace_seq_puts(s, " | ");
677 }
678
679 /* Latency format */
680 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
681 print_graph_lat_fmt(s, ent);
682 }
683
684 /* No overhead */
685 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_START);
686
687 if (type == TRACE_GRAPH_ENT)
688 trace_seq_puts(s, "==========>");
689 else
690 trace_seq_puts(s, "<==========");
691
692 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_END);
693 trace_seq_putc(s, '\n');
694}
695
696void
697trace_print_graph_duration(unsigned long long duration, struct trace_seq *s)
698{
699 unsigned long nsecs_rem = do_div(duration, 1000);
700 /* log10(ULONG_MAX) + '\0' */
701 char usecs_str[21];
702 char nsecs_str[5];
703 int len;
704 int i;
705
706 sprintf(usecs_str, "%lu", (unsigned long) duration);
707
708 /* Print msecs */
709 trace_seq_printf(s, "%s", usecs_str);
710
711 len = strlen(usecs_str);
712
713 /* Print nsecs (we don't want to exceed 7 numbers) */
714 if (len < 7) {
715 size_t slen = min_t(size_t, sizeof(nsecs_str), 8UL - len);
716
717 snprintf(nsecs_str, slen, "%03lu", nsecs_rem);
718 trace_seq_printf(s, ".%s", nsecs_str);
719 len += strlen(nsecs_str) + 1;
720 }
721
722 trace_seq_puts(s, " us ");
723
724 /* Print remaining spaces to fit the row's width */
725 for (i = len; i < 8; i++)
726 trace_seq_putc(s, ' ');
727}
728
729static void
730print_graph_duration(struct trace_array *tr, unsigned long long duration,
731 struct trace_seq *s, u32 flags)
732{
733 if (!(flags & TRACE_GRAPH_PRINT_DURATION) ||
734 !(tr->trace_flags & TRACE_ITER_CONTEXT_INFO))
735 return;
736
737 /* No real adata, just filling the column with spaces */
738 switch (flags & TRACE_GRAPH_PRINT_FILL_MASK) {
739 case FLAGS_FILL_FULL:
740 trace_seq_puts(s, " | ");
741 return;
742 case FLAGS_FILL_START:
743 trace_seq_puts(s, " ");
744 return;
745 case FLAGS_FILL_END:
746 trace_seq_puts(s, " |");
747 return;
748 }
749
750 /* Signal a overhead of time execution to the output */
751 if (flags & TRACE_GRAPH_PRINT_OVERHEAD)
752 trace_seq_printf(s, "%c ", trace_find_mark(duration));
753 else
754 trace_seq_puts(s, " ");
755
756 trace_print_graph_duration(duration, s);
757 trace_seq_puts(s, "| ");
758}
759
760/* Case of a leaf function on its call entry */
761static enum print_line_t
762print_graph_entry_leaf(struct trace_iterator *iter,
763 struct ftrace_graph_ent_entry *entry,
764 struct ftrace_graph_ret_entry *ret_entry,
765 struct trace_seq *s, u32 flags)
766{
767 struct fgraph_data *data = iter->private;
768 struct trace_array *tr = iter->tr;
769 struct ftrace_graph_ret *graph_ret;
770 struct ftrace_graph_ent *call;
771 unsigned long long duration;
772 int i;
773
774 graph_ret = &ret_entry->ret;
775 call = &entry->graph_ent;
776 duration = graph_ret->rettime - graph_ret->calltime;
777
778 if (data) {
779 struct fgraph_cpu_data *cpu_data;
780 int cpu = iter->cpu;
781
782 cpu_data = per_cpu_ptr(data->cpu_data, cpu);
783
784 /*
785 * Comments display at + 1 to depth. Since
786 * this is a leaf function, keep the comments
787 * equal to this depth.
788 */
789 cpu_data->depth = call->depth - 1;
790
791 /* No need to keep this function around for this depth */
792 if (call->depth < FTRACE_RETFUNC_DEPTH)
793 cpu_data->enter_funcs[call->depth] = 0;
794 }
795
796 /* Overhead and duration */
797 print_graph_duration(tr, duration, s, flags);
798
799 /* Function */
800 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++)
801 trace_seq_putc(s, ' ');
802
803 trace_seq_printf(s, "%ps();\n", (void *)call->func);
804
805 return trace_handle_return(s);
806}
807
808static enum print_line_t
809print_graph_entry_nested(struct trace_iterator *iter,
810 struct ftrace_graph_ent_entry *entry,
811 struct trace_seq *s, int cpu, u32 flags)
812{
813 struct ftrace_graph_ent *call = &entry->graph_ent;
814 struct fgraph_data *data = iter->private;
815 struct trace_array *tr = iter->tr;
816 int i;
817
818 if (data) {
819 struct fgraph_cpu_data *cpu_data;
820 int cpu = iter->cpu;
821
822 cpu_data = per_cpu_ptr(data->cpu_data, cpu);
823 cpu_data->depth = call->depth;
824
825 /* Save this function pointer to see if the exit matches */
826 if (call->depth < FTRACE_RETFUNC_DEPTH)
827 cpu_data->enter_funcs[call->depth] = call->func;
828 }
829
830 /* No time */
831 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_FULL);
832
833 /* Function */
834 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++)
835 trace_seq_putc(s, ' ');
836
837 trace_seq_printf(s, "%ps() {\n", (void *)call->func);
838
839 if (trace_seq_has_overflowed(s))
840 return TRACE_TYPE_PARTIAL_LINE;
841
842 /*
843 * we already consumed the current entry to check the next one
844 * and see if this is a leaf.
845 */
846 return TRACE_TYPE_NO_CONSUME;
847}
848
849static void
850print_graph_prologue(struct trace_iterator *iter, struct trace_seq *s,
851 int type, unsigned long addr, u32 flags)
852{
853 struct fgraph_data *data = iter->private;
854 struct trace_entry *ent = iter->ent;
855 struct trace_array *tr = iter->tr;
856 int cpu = iter->cpu;
857
858 /* Pid */
859 verif_pid(s, ent->pid, cpu, data);
860
861 if (type)
862 /* Interrupt */
863 print_graph_irq(iter, addr, type, cpu, ent->pid, flags);
864
865 if (!(tr->trace_flags & TRACE_ITER_CONTEXT_INFO))
866 return;
867
868 /* Absolute time */
869 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
870 print_graph_abs_time(iter->ts, s);
871
872 /* Cpu */
873 if (flags & TRACE_GRAPH_PRINT_CPU)
874 print_graph_cpu(s, cpu);
875
876 /* Proc */
877 if (flags & TRACE_GRAPH_PRINT_PROC) {
878 print_graph_proc(s, ent->pid);
879 trace_seq_puts(s, " | ");
880 }
881
882 /* Latency format */
883 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
884 print_graph_lat_fmt(s, ent);
885
886 return;
887}
888
889/*
890 * Entry check for irq code
891 *
892 * returns 1 if
893 * - we are inside irq code
894 * - we just entered irq code
895 *
896 * retunns 0 if
897 * - funcgraph-interrupts option is set
898 * - we are not inside irq code
899 */
900static int
901check_irq_entry(struct trace_iterator *iter, u32 flags,
902 unsigned long addr, int depth)
903{
904 int cpu = iter->cpu;
905 int *depth_irq;
906 struct fgraph_data *data = iter->private;
907
908 /*
909 * If we are either displaying irqs, or we got called as
910 * a graph event and private data does not exist,
911 * then we bypass the irq check.
912 */
913 if ((flags & TRACE_GRAPH_PRINT_IRQS) ||
914 (!data))
915 return 0;
916
917 depth_irq = &(per_cpu_ptr(data->cpu_data, cpu)->depth_irq);
918
919 /*
920 * We are inside the irq code
921 */
922 if (*depth_irq >= 0)
923 return 1;
924
925 if ((addr < (unsigned long)__irqentry_text_start) ||
926 (addr >= (unsigned long)__irqentry_text_end))
927 return 0;
928
929 /*
930 * We are entering irq code.
931 */
932 *depth_irq = depth;
933 return 1;
934}
935
936/*
937 * Return check for irq code
938 *
939 * returns 1 if
940 * - we are inside irq code
941 * - we just left irq code
942 *
943 * returns 0 if
944 * - funcgraph-interrupts option is set
945 * - we are not inside irq code
946 */
947static int
948check_irq_return(struct trace_iterator *iter, u32 flags, int depth)
949{
950 int cpu = iter->cpu;
951 int *depth_irq;
952 struct fgraph_data *data = iter->private;
953
954 /*
955 * If we are either displaying irqs, or we got called as
956 * a graph event and private data does not exist,
957 * then we bypass the irq check.
958 */
959 if ((flags & TRACE_GRAPH_PRINT_IRQS) ||
960 (!data))
961 return 0;
962
963 depth_irq = &(per_cpu_ptr(data->cpu_data, cpu)->depth_irq);
964
965 /*
966 * We are not inside the irq code.
967 */
968 if (*depth_irq == -1)
969 return 0;
970
971 /*
972 * We are inside the irq code, and this is returning entry.
973 * Let's not trace it and clear the entry depth, since
974 * we are out of irq code.
975 *
976 * This condition ensures that we 'leave the irq code' once
977 * we are out of the entry depth. Thus protecting us from
978 * the RETURN entry loss.
979 */
980 if (*depth_irq >= depth) {
981 *depth_irq = -1;
982 return 1;
983 }
984
985 /*
986 * We are inside the irq code, and this is not the entry.
987 */
988 return 1;
989}
990
991static enum print_line_t
992print_graph_entry(struct ftrace_graph_ent_entry *field, struct trace_seq *s,
993 struct trace_iterator *iter, u32 flags)
994{
995 struct fgraph_data *data = iter->private;
996 struct ftrace_graph_ent *call = &field->graph_ent;
997 struct ftrace_graph_ret_entry *leaf_ret;
998 static enum print_line_t ret;
999 int cpu = iter->cpu;
1000
1001 if (check_irq_entry(iter, flags, call->func, call->depth))
1002 return TRACE_TYPE_HANDLED;
1003
1004 print_graph_prologue(iter, s, TRACE_GRAPH_ENT, call->func, flags);
1005
1006 leaf_ret = get_return_for_leaf(iter, field);
1007 if (leaf_ret)
1008 ret = print_graph_entry_leaf(iter, field, leaf_ret, s, flags);
1009 else
1010 ret = print_graph_entry_nested(iter, field, s, cpu, flags);
1011
1012 if (data) {
1013 /*
1014 * If we failed to write our output, then we need to make
1015 * note of it. Because we already consumed our entry.
1016 */
1017 if (s->full) {
1018 data->failed = 1;
1019 data->cpu = cpu;
1020 } else
1021 data->failed = 0;
1022 }
1023
1024 return ret;
1025}
1026
1027static enum print_line_t
1028print_graph_return(struct ftrace_graph_ret *trace, struct trace_seq *s,
1029 struct trace_entry *ent, struct trace_iterator *iter,
1030 u32 flags)
1031{
1032 unsigned long long duration = trace->rettime - trace->calltime;
1033 struct fgraph_data *data = iter->private;
1034 struct trace_array *tr = iter->tr;
1035 pid_t pid = ent->pid;
1036 int cpu = iter->cpu;
1037 int func_match = 1;
1038 int i;
1039
1040 if (check_irq_return(iter, flags, trace->depth))
1041 return TRACE_TYPE_HANDLED;
1042
1043 if (data) {
1044 struct fgraph_cpu_data *cpu_data;
1045 int cpu = iter->cpu;
1046
1047 cpu_data = per_cpu_ptr(data->cpu_data, cpu);
1048
1049 /*
1050 * Comments display at + 1 to depth. This is the
1051 * return from a function, we now want the comments
1052 * to display at the same level of the bracket.
1053 */
1054 cpu_data->depth = trace->depth - 1;
1055
1056 if (trace->depth < FTRACE_RETFUNC_DEPTH) {
1057 if (cpu_data->enter_funcs[trace->depth] != trace->func)
1058 func_match = 0;
1059 cpu_data->enter_funcs[trace->depth] = 0;
1060 }
1061 }
1062
1063 print_graph_prologue(iter, s, 0, 0, flags);
1064
1065 /* Overhead and duration */
1066 print_graph_duration(tr, duration, s, flags);
1067
1068 /* Closing brace */
1069 for (i = 0; i < trace->depth * TRACE_GRAPH_INDENT; i++)
1070 trace_seq_putc(s, ' ');
1071
1072 /*
1073 * If the return function does not have a matching entry,
1074 * then the entry was lost. Instead of just printing
1075 * the '}' and letting the user guess what function this
1076 * belongs to, write out the function name. Always do
1077 * that if the funcgraph-tail option is enabled.
1078 */
1079 if (func_match && !(flags & TRACE_GRAPH_PRINT_TAIL))
1080 trace_seq_puts(s, "}\n");
1081 else
1082 trace_seq_printf(s, "} /* %ps */\n", (void *)trace->func);
1083
1084 /* Overrun */
1085 if (flags & TRACE_GRAPH_PRINT_OVERRUN)
1086 trace_seq_printf(s, " (Overruns: %lu)\n",
1087 trace->overrun);
1088
1089 print_graph_irq(iter, trace->func, TRACE_GRAPH_RET,
1090 cpu, pid, flags);
1091
1092 return trace_handle_return(s);
1093}
1094
1095static enum print_line_t
1096print_graph_comment(struct trace_seq *s, struct trace_entry *ent,
1097 struct trace_iterator *iter, u32 flags)
1098{
1099 struct trace_array *tr = iter->tr;
1100 unsigned long sym_flags = (tr->trace_flags & TRACE_ITER_SYM_MASK);
1101 struct fgraph_data *data = iter->private;
1102 struct trace_event *event;
1103 int depth = 0;
1104 int ret;
1105 int i;
1106
1107 if (data)
1108 depth = per_cpu_ptr(data->cpu_data, iter->cpu)->depth;
1109
1110 print_graph_prologue(iter, s, 0, 0, flags);
1111
1112 /* No time */
1113 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_FULL);
1114
1115 /* Indentation */
1116 if (depth > 0)
1117 for (i = 0; i < (depth + 1) * TRACE_GRAPH_INDENT; i++)
1118 trace_seq_putc(s, ' ');
1119
1120 /* The comment */
1121 trace_seq_puts(s, "/* ");
1122
1123 switch (iter->ent->type) {
1124 case TRACE_BPRINT:
1125 ret = trace_print_bprintk_msg_only(iter);
1126 if (ret != TRACE_TYPE_HANDLED)
1127 return ret;
1128 break;
1129 case TRACE_PRINT:
1130 ret = trace_print_printk_msg_only(iter);
1131 if (ret != TRACE_TYPE_HANDLED)
1132 return ret;
1133 break;
1134 default:
1135 event = ftrace_find_event(ent->type);
1136 if (!event)
1137 return TRACE_TYPE_UNHANDLED;
1138
1139 ret = event->funcs->trace(iter, sym_flags, event);
1140 if (ret != TRACE_TYPE_HANDLED)
1141 return ret;
1142 }
1143
1144 if (trace_seq_has_overflowed(s))
1145 goto out;
1146
1147 /* Strip ending newline */
1148 if (s->buffer[s->seq.len - 1] == '\n') {
1149 s->buffer[s->seq.len - 1] = '\0';
1150 s->seq.len--;
1151 }
1152
1153 trace_seq_puts(s, " */\n");
1154 out:
1155 return trace_handle_return(s);
1156}
1157
1158
1159enum print_line_t
1160print_graph_function_flags(struct trace_iterator *iter, u32 flags)
1161{
1162 struct ftrace_graph_ent_entry *field;
1163 struct fgraph_data *data = iter->private;
1164 struct trace_entry *entry = iter->ent;
1165 struct trace_seq *s = &iter->seq;
1166 int cpu = iter->cpu;
1167 int ret;
1168
1169 if (data && per_cpu_ptr(data->cpu_data, cpu)->ignore) {
1170 per_cpu_ptr(data->cpu_data, cpu)->ignore = 0;
1171 return TRACE_TYPE_HANDLED;
1172 }
1173
1174 /*
1175 * If the last output failed, there's a possibility we need
1176 * to print out the missing entry which would never go out.
1177 */
1178 if (data && data->failed) {
1179 field = &data->ent;
1180 iter->cpu = data->cpu;
1181 ret = print_graph_entry(field, s, iter, flags);
1182 if (ret == TRACE_TYPE_HANDLED && iter->cpu != cpu) {
1183 per_cpu_ptr(data->cpu_data, iter->cpu)->ignore = 1;
1184 ret = TRACE_TYPE_NO_CONSUME;
1185 }
1186 iter->cpu = cpu;
1187 return ret;
1188 }
1189
1190 switch (entry->type) {
1191 case TRACE_GRAPH_ENT: {
1192 /*
1193 * print_graph_entry() may consume the current event,
1194 * thus @field may become invalid, so we need to save it.
1195 * sizeof(struct ftrace_graph_ent_entry) is very small,
1196 * it can be safely saved at the stack.
1197 */
1198 struct ftrace_graph_ent_entry saved;
1199 trace_assign_type(field, entry);
1200 saved = *field;
1201 return print_graph_entry(&saved, s, iter, flags);
1202 }
1203 case TRACE_GRAPH_RET: {
1204 struct ftrace_graph_ret_entry *field;
1205 trace_assign_type(field, entry);
1206 return print_graph_return(&field->ret, s, entry, iter, flags);
1207 }
1208 case TRACE_STACK:
1209 case TRACE_FN:
1210 /* dont trace stack and functions as comments */
1211 return TRACE_TYPE_UNHANDLED;
1212
1213 default:
1214 return print_graph_comment(s, entry, iter, flags);
1215 }
1216
1217 return TRACE_TYPE_HANDLED;
1218}
1219
1220static enum print_line_t
1221print_graph_function(struct trace_iterator *iter)
1222{
1223 return print_graph_function_flags(iter, tracer_flags.val);
1224}
1225
1226static enum print_line_t
1227print_graph_function_event(struct trace_iterator *iter, int flags,
1228 struct trace_event *event)
1229{
1230 return print_graph_function(iter);
1231}
1232
1233static void print_lat_header(struct seq_file *s, u32 flags)
1234{
1235 static const char spaces[] = " " /* 16 spaces */
1236 " " /* 4 spaces */
1237 " "; /* 17 spaces */
1238 int size = 0;
1239
1240 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
1241 size += 16;
1242 if (flags & TRACE_GRAPH_PRINT_CPU)
1243 size += 4;
1244 if (flags & TRACE_GRAPH_PRINT_PROC)
1245 size += 17;
1246
1247 seq_printf(s, "#%.*s _-----=> irqs-off \n", size, spaces);
1248 seq_printf(s, "#%.*s / _----=> need-resched \n", size, spaces);
1249 seq_printf(s, "#%.*s| / _---=> hardirq/softirq \n", size, spaces);
1250 seq_printf(s, "#%.*s|| / _--=> preempt-depth \n", size, spaces);
1251 seq_printf(s, "#%.*s||| / \n", size, spaces);
1252}
1253
1254static void __print_graph_headers_flags(struct trace_array *tr,
1255 struct seq_file *s, u32 flags)
1256{
1257 int lat = tr->trace_flags & TRACE_ITER_LATENCY_FMT;
1258
1259 if (lat)
1260 print_lat_header(s, flags);
1261
1262 /* 1st line */
1263 seq_putc(s, '#');
1264 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
1265 seq_puts(s, " TIME ");
1266 if (flags & TRACE_GRAPH_PRINT_CPU)
1267 seq_puts(s, " CPU");
1268 if (flags & TRACE_GRAPH_PRINT_PROC)
1269 seq_puts(s, " TASK/PID ");
1270 if (lat)
1271 seq_puts(s, "||||");
1272 if (flags & TRACE_GRAPH_PRINT_DURATION)
1273 seq_puts(s, " DURATION ");
1274 seq_puts(s, " FUNCTION CALLS\n");
1275
1276 /* 2nd line */
1277 seq_putc(s, '#');
1278 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
1279 seq_puts(s, " | ");
1280 if (flags & TRACE_GRAPH_PRINT_CPU)
1281 seq_puts(s, " | ");
1282 if (flags & TRACE_GRAPH_PRINT_PROC)
1283 seq_puts(s, " | | ");
1284 if (lat)
1285 seq_puts(s, "||||");
1286 if (flags & TRACE_GRAPH_PRINT_DURATION)
1287 seq_puts(s, " | | ");
1288 seq_puts(s, " | | | |\n");
1289}
1290
1291static void print_graph_headers(struct seq_file *s)
1292{
1293 print_graph_headers_flags(s, tracer_flags.val);
1294}
1295
1296void print_graph_headers_flags(struct seq_file *s, u32 flags)
1297{
1298 struct trace_iterator *iter = s->private;
1299 struct trace_array *tr = iter->tr;
1300
1301 if (!(tr->trace_flags & TRACE_ITER_CONTEXT_INFO))
1302 return;
1303
1304 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT) {
1305 /* print nothing if the buffers are empty */
1306 if (trace_empty(iter))
1307 return;
1308
1309 print_trace_header(s, iter);
1310 }
1311
1312 __print_graph_headers_flags(tr, s, flags);
1313}
1314
1315void graph_trace_open(struct trace_iterator *iter)
1316{
1317 /* pid and depth on the last trace processed */
1318 struct fgraph_data *data;
1319 gfp_t gfpflags;
1320 int cpu;
1321
1322 iter->private = NULL;
1323
1324 /* We can be called in atomic context via ftrace_dump() */
1325 gfpflags = (in_atomic() || irqs_disabled()) ? GFP_ATOMIC : GFP_KERNEL;
1326
1327 data = kzalloc(sizeof(*data), gfpflags);
1328 if (!data)
1329 goto out_err;
1330
1331 data->cpu_data = alloc_percpu_gfp(struct fgraph_cpu_data, gfpflags);
1332 if (!data->cpu_data)
1333 goto out_err_free;
1334
1335 for_each_possible_cpu(cpu) {
1336 pid_t *pid = &(per_cpu_ptr(data->cpu_data, cpu)->last_pid);
1337 int *depth = &(per_cpu_ptr(data->cpu_data, cpu)->depth);
1338 int *ignore = &(per_cpu_ptr(data->cpu_data, cpu)->ignore);
1339 int *depth_irq = &(per_cpu_ptr(data->cpu_data, cpu)->depth_irq);
1340
1341 *pid = -1;
1342 *depth = 0;
1343 *ignore = 0;
1344 *depth_irq = -1;
1345 }
1346
1347 iter->private = data;
1348
1349 return;
1350
1351 out_err_free:
1352 kfree(data);
1353 out_err:
1354 pr_warn("function graph tracer: not enough memory\n");
1355}
1356
1357void graph_trace_close(struct trace_iterator *iter)
1358{
1359 struct fgraph_data *data = iter->private;
1360
1361 if (data) {
1362 free_percpu(data->cpu_data);
1363 kfree(data);
1364 }
1365}
1366
1367static int
1368func_graph_set_flag(struct trace_array *tr, u32 old_flags, u32 bit, int set)
1369{
1370 if (bit == TRACE_GRAPH_PRINT_IRQS)
1371 ftrace_graph_skip_irqs = !set;
1372
1373 if (bit == TRACE_GRAPH_SLEEP_TIME)
1374 ftrace_graph_sleep_time_control(set);
1375
1376 if (bit == TRACE_GRAPH_GRAPH_TIME)
1377 ftrace_graph_graph_time_control(set);
1378
1379 return 0;
1380}
1381
1382static struct trace_event_functions graph_functions = {
1383 .trace = print_graph_function_event,
1384};
1385
1386static struct trace_event graph_trace_entry_event = {
1387 .type = TRACE_GRAPH_ENT,
1388 .funcs = &graph_functions,
1389};
1390
1391static struct trace_event graph_trace_ret_event = {
1392 .type = TRACE_GRAPH_RET,
1393 .funcs = &graph_functions
1394};
1395
1396static struct tracer graph_trace __tracer_data = {
1397 .name = "function_graph",
1398 .update_thresh = graph_trace_update_thresh,
1399 .open = graph_trace_open,
1400 .pipe_open = graph_trace_open,
1401 .close = graph_trace_close,
1402 .pipe_close = graph_trace_close,
1403 .init = graph_trace_init,
1404 .reset = graph_trace_reset,
1405 .print_line = print_graph_function,
1406 .print_header = print_graph_headers,
1407 .flags = &tracer_flags,
1408 .set_flag = func_graph_set_flag,
1409#ifdef CONFIG_FTRACE_SELFTEST
1410 .selftest = trace_selftest_startup_function_graph,
1411#endif
1412};
1413
1414
1415static ssize_t
1416graph_depth_write(struct file *filp, const char __user *ubuf, size_t cnt,
1417 loff_t *ppos)
1418{
1419 unsigned long val;
1420 int ret;
1421
1422 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
1423 if (ret)
1424 return ret;
1425
1426 max_depth = val;
1427
1428 *ppos += cnt;
1429
1430 return cnt;
1431}
1432
1433static ssize_t
1434graph_depth_read(struct file *filp, char __user *ubuf, size_t cnt,
1435 loff_t *ppos)
1436{
1437 char buf[15]; /* More than enough to hold UINT_MAX + "\n"*/
1438 int n;
1439
1440 n = sprintf(buf, "%d\n", max_depth);
1441
1442 return simple_read_from_buffer(ubuf, cnt, ppos, buf, n);
1443}
1444
1445static const struct file_operations graph_depth_fops = {
1446 .open = tracing_open_generic,
1447 .write = graph_depth_write,
1448 .read = graph_depth_read,
1449 .llseek = generic_file_llseek,
1450};
1451
1452static __init int init_graph_tracefs(void)
1453{
1454 struct dentry *d_tracer;
1455
1456 d_tracer = tracing_init_dentry();
1457 if (IS_ERR(d_tracer))
1458 return 0;
1459
1460 trace_create_file("max_graph_depth", 0644, d_tracer,
1461 NULL, &graph_depth_fops);
1462
1463 return 0;
1464}
1465fs_initcall(init_graph_tracefs);
1466
1467static __init int init_graph_trace(void)
1468{
1469 max_bytes_for_cpu = snprintf(NULL, 0, "%d", nr_cpu_ids - 1);
1470
1471 if (!register_trace_event(&graph_trace_entry_event)) {
1472 pr_warn("Warning: could not register graph trace events\n");
1473 return 1;
1474 }
1475
1476 if (!register_trace_event(&graph_trace_ret_event)) {
1477 pr_warn("Warning: could not register graph trace events\n");
1478 return 1;
1479 }
1480
1481 return register_tracer(&graph_trace);
1482}
1483
1484core_initcall(init_graph_trace);
1// SPDX-License-Identifier: GPL-2.0
2/*
3 *
4 * Function graph tracer.
5 * Copyright (c) 2008-2009 Frederic Weisbecker <fweisbec@gmail.com>
6 * Mostly borrowed from function tracer which
7 * is Copyright (c) Steven Rostedt <srostedt@redhat.com>
8 *
9 */
10#include <linux/uaccess.h>
11#include <linux/ftrace.h>
12#include <linux/interrupt.h>
13#include <linux/slab.h>
14#include <linux/fs.h>
15
16#include "trace.h"
17#include "trace_output.h"
18
19/* When set, irq functions will be ignored */
20static int ftrace_graph_skip_irqs;
21
22struct fgraph_cpu_data {
23 pid_t last_pid;
24 int depth;
25 int depth_irq;
26 int ignore;
27 unsigned long enter_funcs[FTRACE_RETFUNC_DEPTH];
28};
29
30struct fgraph_data {
31 struct fgraph_cpu_data __percpu *cpu_data;
32
33 /* Place to preserve last processed entry. */
34 struct ftrace_graph_ent_entry ent;
35 struct ftrace_graph_ret_entry ret;
36 int failed;
37 int cpu;
38};
39
40#define TRACE_GRAPH_INDENT 2
41
42unsigned int fgraph_max_depth;
43
44static struct tracer_opt trace_opts[] = {
45 /* Display overruns? (for self-debug purpose) */
46 { TRACER_OPT(funcgraph-overrun, TRACE_GRAPH_PRINT_OVERRUN) },
47 /* Display CPU ? */
48 { TRACER_OPT(funcgraph-cpu, TRACE_GRAPH_PRINT_CPU) },
49 /* Display Overhead ? */
50 { TRACER_OPT(funcgraph-overhead, TRACE_GRAPH_PRINT_OVERHEAD) },
51 /* Display proc name/pid */
52 { TRACER_OPT(funcgraph-proc, TRACE_GRAPH_PRINT_PROC) },
53 /* Display duration of execution */
54 { TRACER_OPT(funcgraph-duration, TRACE_GRAPH_PRINT_DURATION) },
55 /* Display absolute time of an entry */
56 { TRACER_OPT(funcgraph-abstime, TRACE_GRAPH_PRINT_ABS_TIME) },
57 /* Display interrupts */
58 { TRACER_OPT(funcgraph-irqs, TRACE_GRAPH_PRINT_IRQS) },
59 /* Display function name after trailing } */
60 { TRACER_OPT(funcgraph-tail, TRACE_GRAPH_PRINT_TAIL) },
61#ifdef CONFIG_FUNCTION_GRAPH_RETVAL
62 /* Display function return value ? */
63 { TRACER_OPT(funcgraph-retval, TRACE_GRAPH_PRINT_RETVAL) },
64 /* Display function return value in hexadecimal format ? */
65 { TRACER_OPT(funcgraph-retval-hex, TRACE_GRAPH_PRINT_RETVAL_HEX) },
66#endif
67 /* Include sleep time (scheduled out) between entry and return */
68 { TRACER_OPT(sleep-time, TRACE_GRAPH_SLEEP_TIME) },
69
70#ifdef CONFIG_FUNCTION_PROFILER
71 /* Include time within nested functions */
72 { TRACER_OPT(graph-time, TRACE_GRAPH_GRAPH_TIME) },
73#endif
74
75 { } /* Empty entry */
76};
77
78static struct tracer_flags tracer_flags = {
79 /* Don't display overruns, proc, or tail by default */
80 .val = TRACE_GRAPH_PRINT_CPU | TRACE_GRAPH_PRINT_OVERHEAD |
81 TRACE_GRAPH_PRINT_DURATION | TRACE_GRAPH_PRINT_IRQS |
82 TRACE_GRAPH_SLEEP_TIME | TRACE_GRAPH_GRAPH_TIME,
83 .opts = trace_opts
84};
85
86static struct trace_array *graph_array;
87
88/*
89 * DURATION column is being also used to display IRQ signs,
90 * following values are used by print_graph_irq and others
91 * to fill in space into DURATION column.
92 */
93enum {
94 FLAGS_FILL_FULL = 1 << TRACE_GRAPH_PRINT_FILL_SHIFT,
95 FLAGS_FILL_START = 2 << TRACE_GRAPH_PRINT_FILL_SHIFT,
96 FLAGS_FILL_END = 3 << TRACE_GRAPH_PRINT_FILL_SHIFT,
97};
98
99static void
100print_graph_duration(struct trace_array *tr, unsigned long long duration,
101 struct trace_seq *s, u32 flags);
102
103int __trace_graph_entry(struct trace_array *tr,
104 struct ftrace_graph_ent *trace,
105 unsigned int trace_ctx)
106{
107 struct trace_event_call *call = &event_funcgraph_entry;
108 struct ring_buffer_event *event;
109 struct trace_buffer *buffer = tr->array_buffer.buffer;
110 struct ftrace_graph_ent_entry *entry;
111
112 event = trace_buffer_lock_reserve(buffer, TRACE_GRAPH_ENT,
113 sizeof(*entry), trace_ctx);
114 if (!event)
115 return 0;
116 entry = ring_buffer_event_data(event);
117 entry->graph_ent = *trace;
118 if (!call_filter_check_discard(call, entry, buffer, event))
119 trace_buffer_unlock_commit_nostack(buffer, event);
120
121 return 1;
122}
123
124static inline int ftrace_graph_ignore_irqs(void)
125{
126 if (!ftrace_graph_skip_irqs || trace_recursion_test(TRACE_IRQ_BIT))
127 return 0;
128
129 return in_hardirq();
130}
131
132int trace_graph_entry(struct ftrace_graph_ent *trace)
133{
134 struct trace_array *tr = graph_array;
135 struct trace_array_cpu *data;
136 unsigned long flags;
137 unsigned int trace_ctx;
138 long disabled;
139 int ret;
140 int cpu;
141
142 if (trace_recursion_test(TRACE_GRAPH_NOTRACE_BIT))
143 return 0;
144
145 /*
146 * Do not trace a function if it's filtered by set_graph_notrace.
147 * Make the index of ret stack negative to indicate that it should
148 * ignore further functions. But it needs its own ret stack entry
149 * to recover the original index in order to continue tracing after
150 * returning from the function.
151 */
152 if (ftrace_graph_notrace_addr(trace->func)) {
153 trace_recursion_set(TRACE_GRAPH_NOTRACE_BIT);
154 /*
155 * Need to return 1 to have the return called
156 * that will clear the NOTRACE bit.
157 */
158 return 1;
159 }
160
161 if (!ftrace_trace_task(tr))
162 return 0;
163
164 if (ftrace_graph_ignore_func(trace))
165 return 0;
166
167 if (ftrace_graph_ignore_irqs())
168 return 0;
169
170 /*
171 * Stop here if tracing_threshold is set. We only write function return
172 * events to the ring buffer.
173 */
174 if (tracing_thresh)
175 return 1;
176
177 local_irq_save(flags);
178 cpu = raw_smp_processor_id();
179 data = per_cpu_ptr(tr->array_buffer.data, cpu);
180 disabled = atomic_inc_return(&data->disabled);
181 if (likely(disabled == 1)) {
182 trace_ctx = tracing_gen_ctx_flags(flags);
183 ret = __trace_graph_entry(tr, trace, trace_ctx);
184 } else {
185 ret = 0;
186 }
187
188 atomic_dec(&data->disabled);
189 local_irq_restore(flags);
190
191 return ret;
192}
193
194static void
195__trace_graph_function(struct trace_array *tr,
196 unsigned long ip, unsigned int trace_ctx)
197{
198 u64 time = trace_clock_local();
199 struct ftrace_graph_ent ent = {
200 .func = ip,
201 .depth = 0,
202 };
203 struct ftrace_graph_ret ret = {
204 .func = ip,
205 .depth = 0,
206 .calltime = time,
207 .rettime = time,
208 };
209
210 __trace_graph_entry(tr, &ent, trace_ctx);
211 __trace_graph_return(tr, &ret, trace_ctx);
212}
213
214void
215trace_graph_function(struct trace_array *tr,
216 unsigned long ip, unsigned long parent_ip,
217 unsigned int trace_ctx)
218{
219 __trace_graph_function(tr, ip, trace_ctx);
220}
221
222void __trace_graph_return(struct trace_array *tr,
223 struct ftrace_graph_ret *trace,
224 unsigned int trace_ctx)
225{
226 struct trace_event_call *call = &event_funcgraph_exit;
227 struct ring_buffer_event *event;
228 struct trace_buffer *buffer = tr->array_buffer.buffer;
229 struct ftrace_graph_ret_entry *entry;
230
231 event = trace_buffer_lock_reserve(buffer, TRACE_GRAPH_RET,
232 sizeof(*entry), trace_ctx);
233 if (!event)
234 return;
235 entry = ring_buffer_event_data(event);
236 entry->ret = *trace;
237 if (!call_filter_check_discard(call, entry, buffer, event))
238 trace_buffer_unlock_commit_nostack(buffer, event);
239}
240
241void trace_graph_return(struct ftrace_graph_ret *trace)
242{
243 struct trace_array *tr = graph_array;
244 struct trace_array_cpu *data;
245 unsigned long flags;
246 unsigned int trace_ctx;
247 long disabled;
248 int cpu;
249
250 ftrace_graph_addr_finish(trace);
251
252 if (trace_recursion_test(TRACE_GRAPH_NOTRACE_BIT)) {
253 trace_recursion_clear(TRACE_GRAPH_NOTRACE_BIT);
254 return;
255 }
256
257 local_irq_save(flags);
258 cpu = raw_smp_processor_id();
259 data = per_cpu_ptr(tr->array_buffer.data, cpu);
260 disabled = atomic_inc_return(&data->disabled);
261 if (likely(disabled == 1)) {
262 trace_ctx = tracing_gen_ctx_flags(flags);
263 __trace_graph_return(tr, trace, trace_ctx);
264 }
265 atomic_dec(&data->disabled);
266 local_irq_restore(flags);
267}
268
269void set_graph_array(struct trace_array *tr)
270{
271 graph_array = tr;
272
273 /* Make graph_array visible before we start tracing */
274
275 smp_mb();
276}
277
278static void trace_graph_thresh_return(struct ftrace_graph_ret *trace)
279{
280 ftrace_graph_addr_finish(trace);
281
282 if (trace_recursion_test(TRACE_GRAPH_NOTRACE_BIT)) {
283 trace_recursion_clear(TRACE_GRAPH_NOTRACE_BIT);
284 return;
285 }
286
287 if (tracing_thresh &&
288 (trace->rettime - trace->calltime < tracing_thresh))
289 return;
290 else
291 trace_graph_return(trace);
292}
293
294static struct fgraph_ops funcgraph_thresh_ops = {
295 .entryfunc = &trace_graph_entry,
296 .retfunc = &trace_graph_thresh_return,
297};
298
299static struct fgraph_ops funcgraph_ops = {
300 .entryfunc = &trace_graph_entry,
301 .retfunc = &trace_graph_return,
302};
303
304static int graph_trace_init(struct trace_array *tr)
305{
306 int ret;
307
308 set_graph_array(tr);
309 if (tracing_thresh)
310 ret = register_ftrace_graph(&funcgraph_thresh_ops);
311 else
312 ret = register_ftrace_graph(&funcgraph_ops);
313 if (ret)
314 return ret;
315 tracing_start_cmdline_record();
316
317 return 0;
318}
319
320static void graph_trace_reset(struct trace_array *tr)
321{
322 tracing_stop_cmdline_record();
323 if (tracing_thresh)
324 unregister_ftrace_graph(&funcgraph_thresh_ops);
325 else
326 unregister_ftrace_graph(&funcgraph_ops);
327}
328
329static int graph_trace_update_thresh(struct trace_array *tr)
330{
331 graph_trace_reset(tr);
332 return graph_trace_init(tr);
333}
334
335static int max_bytes_for_cpu;
336
337static void print_graph_cpu(struct trace_seq *s, int cpu)
338{
339 /*
340 * Start with a space character - to make it stand out
341 * to the right a bit when trace output is pasted into
342 * email:
343 */
344 trace_seq_printf(s, " %*d) ", max_bytes_for_cpu, cpu);
345}
346
347#define TRACE_GRAPH_PROCINFO_LENGTH 14
348
349static void print_graph_proc(struct trace_seq *s, pid_t pid)
350{
351 char comm[TASK_COMM_LEN];
352 /* sign + log10(MAX_INT) + '\0' */
353 char pid_str[11];
354 int spaces = 0;
355 int len;
356 int i;
357
358 trace_find_cmdline(pid, comm);
359 comm[7] = '\0';
360 sprintf(pid_str, "%d", pid);
361
362 /* 1 stands for the "-" character */
363 len = strlen(comm) + strlen(pid_str) + 1;
364
365 if (len < TRACE_GRAPH_PROCINFO_LENGTH)
366 spaces = TRACE_GRAPH_PROCINFO_LENGTH - len;
367
368 /* First spaces to align center */
369 for (i = 0; i < spaces / 2; i++)
370 trace_seq_putc(s, ' ');
371
372 trace_seq_printf(s, "%s-%s", comm, pid_str);
373
374 /* Last spaces to align center */
375 for (i = 0; i < spaces - (spaces / 2); i++)
376 trace_seq_putc(s, ' ');
377}
378
379
380static void print_graph_lat_fmt(struct trace_seq *s, struct trace_entry *entry)
381{
382 trace_seq_putc(s, ' ');
383 trace_print_lat_fmt(s, entry);
384 trace_seq_puts(s, " | ");
385}
386
387/* If the pid changed since the last trace, output this event */
388static void
389verif_pid(struct trace_seq *s, pid_t pid, int cpu, struct fgraph_data *data)
390{
391 pid_t prev_pid;
392 pid_t *last_pid;
393
394 if (!data)
395 return;
396
397 last_pid = &(per_cpu_ptr(data->cpu_data, cpu)->last_pid);
398
399 if (*last_pid == pid)
400 return;
401
402 prev_pid = *last_pid;
403 *last_pid = pid;
404
405 if (prev_pid == -1)
406 return;
407/*
408 * Context-switch trace line:
409
410 ------------------------------------------
411 | 1) migration/0--1 => sshd-1755
412 ------------------------------------------
413
414 */
415 trace_seq_puts(s, " ------------------------------------------\n");
416 print_graph_cpu(s, cpu);
417 print_graph_proc(s, prev_pid);
418 trace_seq_puts(s, " => ");
419 print_graph_proc(s, pid);
420 trace_seq_puts(s, "\n ------------------------------------------\n\n");
421}
422
423static struct ftrace_graph_ret_entry *
424get_return_for_leaf(struct trace_iterator *iter,
425 struct ftrace_graph_ent_entry *curr)
426{
427 struct fgraph_data *data = iter->private;
428 struct ring_buffer_iter *ring_iter = NULL;
429 struct ring_buffer_event *event;
430 struct ftrace_graph_ret_entry *next;
431
432 /*
433 * If the previous output failed to write to the seq buffer,
434 * then we just reuse the data from before.
435 */
436 if (data && data->failed) {
437 curr = &data->ent;
438 next = &data->ret;
439 } else {
440
441 ring_iter = trace_buffer_iter(iter, iter->cpu);
442
443 /* First peek to compare current entry and the next one */
444 if (ring_iter)
445 event = ring_buffer_iter_peek(ring_iter, NULL);
446 else {
447 /*
448 * We need to consume the current entry to see
449 * the next one.
450 */
451 ring_buffer_consume(iter->array_buffer->buffer, iter->cpu,
452 NULL, NULL);
453 event = ring_buffer_peek(iter->array_buffer->buffer, iter->cpu,
454 NULL, NULL);
455 }
456
457 if (!event)
458 return NULL;
459
460 next = ring_buffer_event_data(event);
461
462 if (data) {
463 /*
464 * Save current and next entries for later reference
465 * if the output fails.
466 */
467 data->ent = *curr;
468 /*
469 * If the next event is not a return type, then
470 * we only care about what type it is. Otherwise we can
471 * safely copy the entire event.
472 */
473 if (next->ent.type == TRACE_GRAPH_RET)
474 data->ret = *next;
475 else
476 data->ret.ent.type = next->ent.type;
477 }
478 }
479
480 if (next->ent.type != TRACE_GRAPH_RET)
481 return NULL;
482
483 if (curr->ent.pid != next->ent.pid ||
484 curr->graph_ent.func != next->ret.func)
485 return NULL;
486
487 /* this is a leaf, now advance the iterator */
488 if (ring_iter)
489 ring_buffer_iter_advance(ring_iter);
490
491 return next;
492}
493
494static void print_graph_abs_time(u64 t, struct trace_seq *s)
495{
496 unsigned long usecs_rem;
497
498 usecs_rem = do_div(t, NSEC_PER_SEC);
499 usecs_rem /= 1000;
500
501 trace_seq_printf(s, "%5lu.%06lu | ",
502 (unsigned long)t, usecs_rem);
503}
504
505static void
506print_graph_rel_time(struct trace_iterator *iter, struct trace_seq *s)
507{
508 unsigned long long usecs;
509
510 usecs = iter->ts - iter->array_buffer->time_start;
511 do_div(usecs, NSEC_PER_USEC);
512
513 trace_seq_printf(s, "%9llu us | ", usecs);
514}
515
516static void
517print_graph_irq(struct trace_iterator *iter, unsigned long addr,
518 enum trace_type type, int cpu, pid_t pid, u32 flags)
519{
520 struct trace_array *tr = iter->tr;
521 struct trace_seq *s = &iter->seq;
522 struct trace_entry *ent = iter->ent;
523
524 if (addr < (unsigned long)__irqentry_text_start ||
525 addr >= (unsigned long)__irqentry_text_end)
526 return;
527
528 if (tr->trace_flags & TRACE_ITER_CONTEXT_INFO) {
529 /* Absolute time */
530 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
531 print_graph_abs_time(iter->ts, s);
532
533 /* Relative time */
534 if (flags & TRACE_GRAPH_PRINT_REL_TIME)
535 print_graph_rel_time(iter, s);
536
537 /* Cpu */
538 if (flags & TRACE_GRAPH_PRINT_CPU)
539 print_graph_cpu(s, cpu);
540
541 /* Proc */
542 if (flags & TRACE_GRAPH_PRINT_PROC) {
543 print_graph_proc(s, pid);
544 trace_seq_puts(s, " | ");
545 }
546
547 /* Latency format */
548 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
549 print_graph_lat_fmt(s, ent);
550 }
551
552 /* No overhead */
553 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_START);
554
555 if (type == TRACE_GRAPH_ENT)
556 trace_seq_puts(s, "==========>");
557 else
558 trace_seq_puts(s, "<==========");
559
560 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_END);
561 trace_seq_putc(s, '\n');
562}
563
564void
565trace_print_graph_duration(unsigned long long duration, struct trace_seq *s)
566{
567 unsigned long nsecs_rem = do_div(duration, 1000);
568 /* log10(ULONG_MAX) + '\0' */
569 char usecs_str[21];
570 char nsecs_str[5];
571 int len;
572 int i;
573
574 sprintf(usecs_str, "%lu", (unsigned long) duration);
575
576 /* Print msecs */
577 trace_seq_printf(s, "%s", usecs_str);
578
579 len = strlen(usecs_str);
580
581 /* Print nsecs (we don't want to exceed 7 numbers) */
582 if (len < 7) {
583 size_t slen = min_t(size_t, sizeof(nsecs_str), 8UL - len);
584
585 snprintf(nsecs_str, slen, "%03lu", nsecs_rem);
586 trace_seq_printf(s, ".%s", nsecs_str);
587 len += strlen(nsecs_str) + 1;
588 }
589
590 trace_seq_puts(s, " us ");
591
592 /* Print remaining spaces to fit the row's width */
593 for (i = len; i < 8; i++)
594 trace_seq_putc(s, ' ');
595}
596
597static void
598print_graph_duration(struct trace_array *tr, unsigned long long duration,
599 struct trace_seq *s, u32 flags)
600{
601 if (!(flags & TRACE_GRAPH_PRINT_DURATION) ||
602 !(tr->trace_flags & TRACE_ITER_CONTEXT_INFO))
603 return;
604
605 /* No real adata, just filling the column with spaces */
606 switch (flags & TRACE_GRAPH_PRINT_FILL_MASK) {
607 case FLAGS_FILL_FULL:
608 trace_seq_puts(s, " | ");
609 return;
610 case FLAGS_FILL_START:
611 trace_seq_puts(s, " ");
612 return;
613 case FLAGS_FILL_END:
614 trace_seq_puts(s, " |");
615 return;
616 }
617
618 /* Signal a overhead of time execution to the output */
619 if (flags & TRACE_GRAPH_PRINT_OVERHEAD)
620 trace_seq_printf(s, "%c ", trace_find_mark(duration));
621 else
622 trace_seq_puts(s, " ");
623
624 trace_print_graph_duration(duration, s);
625 trace_seq_puts(s, "| ");
626}
627
628#ifdef CONFIG_FUNCTION_GRAPH_RETVAL
629
630#define __TRACE_GRAPH_PRINT_RETVAL TRACE_GRAPH_PRINT_RETVAL
631
632static void print_graph_retval(struct trace_seq *s, unsigned long retval,
633 bool leaf, void *func, bool hex_format)
634{
635 unsigned long err_code = 0;
636
637 if (retval == 0 || hex_format)
638 goto done;
639
640 /* Check if the return value matches the negative format */
641 if (IS_ENABLED(CONFIG_64BIT) && (retval & BIT(31)) &&
642 (((u64)retval) >> 32) == 0) {
643 /* sign extension */
644 err_code = (unsigned long)(s32)retval;
645 } else {
646 err_code = retval;
647 }
648
649 if (!IS_ERR_VALUE(err_code))
650 err_code = 0;
651
652done:
653 if (leaf) {
654 if (hex_format || (err_code == 0))
655 trace_seq_printf(s, "%ps(); /* = 0x%lx */\n",
656 func, retval);
657 else
658 trace_seq_printf(s, "%ps(); /* = %ld */\n",
659 func, err_code);
660 } else {
661 if (hex_format || (err_code == 0))
662 trace_seq_printf(s, "} /* %ps = 0x%lx */\n",
663 func, retval);
664 else
665 trace_seq_printf(s, "} /* %ps = %ld */\n",
666 func, err_code);
667 }
668}
669
670#else
671
672#define __TRACE_GRAPH_PRINT_RETVAL 0
673
674#define print_graph_retval(_seq, _retval, _leaf, _func, _format) do {} while (0)
675
676#endif
677
678/* Case of a leaf function on its call entry */
679static enum print_line_t
680print_graph_entry_leaf(struct trace_iterator *iter,
681 struct ftrace_graph_ent_entry *entry,
682 struct ftrace_graph_ret_entry *ret_entry,
683 struct trace_seq *s, u32 flags)
684{
685 struct fgraph_data *data = iter->private;
686 struct trace_array *tr = iter->tr;
687 struct ftrace_graph_ret *graph_ret;
688 struct ftrace_graph_ent *call;
689 unsigned long long duration;
690 int cpu = iter->cpu;
691 int i;
692
693 graph_ret = &ret_entry->ret;
694 call = &entry->graph_ent;
695 duration = graph_ret->rettime - graph_ret->calltime;
696
697 if (data) {
698 struct fgraph_cpu_data *cpu_data;
699
700 cpu_data = per_cpu_ptr(data->cpu_data, cpu);
701
702 /*
703 * Comments display at + 1 to depth. Since
704 * this is a leaf function, keep the comments
705 * equal to this depth.
706 */
707 cpu_data->depth = call->depth - 1;
708
709 /* No need to keep this function around for this depth */
710 if (call->depth < FTRACE_RETFUNC_DEPTH &&
711 !WARN_ON_ONCE(call->depth < 0))
712 cpu_data->enter_funcs[call->depth] = 0;
713 }
714
715 /* Overhead and duration */
716 print_graph_duration(tr, duration, s, flags);
717
718 /* Function */
719 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++)
720 trace_seq_putc(s, ' ');
721
722 /*
723 * Write out the function return value if the option function-retval is
724 * enabled.
725 */
726 if (flags & __TRACE_GRAPH_PRINT_RETVAL)
727 print_graph_retval(s, graph_ret->retval, true, (void *)call->func,
728 !!(flags & TRACE_GRAPH_PRINT_RETVAL_HEX));
729 else
730 trace_seq_printf(s, "%ps();\n", (void *)call->func);
731
732 print_graph_irq(iter, graph_ret->func, TRACE_GRAPH_RET,
733 cpu, iter->ent->pid, flags);
734
735 return trace_handle_return(s);
736}
737
738static enum print_line_t
739print_graph_entry_nested(struct trace_iterator *iter,
740 struct ftrace_graph_ent_entry *entry,
741 struct trace_seq *s, int cpu, u32 flags)
742{
743 struct ftrace_graph_ent *call = &entry->graph_ent;
744 struct fgraph_data *data = iter->private;
745 struct trace_array *tr = iter->tr;
746 int i;
747
748 if (data) {
749 struct fgraph_cpu_data *cpu_data;
750 int cpu = iter->cpu;
751
752 cpu_data = per_cpu_ptr(data->cpu_data, cpu);
753 cpu_data->depth = call->depth;
754
755 /* Save this function pointer to see if the exit matches */
756 if (call->depth < FTRACE_RETFUNC_DEPTH &&
757 !WARN_ON_ONCE(call->depth < 0))
758 cpu_data->enter_funcs[call->depth] = call->func;
759 }
760
761 /* No time */
762 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_FULL);
763
764 /* Function */
765 for (i = 0; i < call->depth * TRACE_GRAPH_INDENT; i++)
766 trace_seq_putc(s, ' ');
767
768 trace_seq_printf(s, "%ps() {\n", (void *)call->func);
769
770 if (trace_seq_has_overflowed(s))
771 return TRACE_TYPE_PARTIAL_LINE;
772
773 /*
774 * we already consumed the current entry to check the next one
775 * and see if this is a leaf.
776 */
777 return TRACE_TYPE_NO_CONSUME;
778}
779
780static void
781print_graph_prologue(struct trace_iterator *iter, struct trace_seq *s,
782 int type, unsigned long addr, u32 flags)
783{
784 struct fgraph_data *data = iter->private;
785 struct trace_entry *ent = iter->ent;
786 struct trace_array *tr = iter->tr;
787 int cpu = iter->cpu;
788
789 /* Pid */
790 verif_pid(s, ent->pid, cpu, data);
791
792 if (type)
793 /* Interrupt */
794 print_graph_irq(iter, addr, type, cpu, ent->pid, flags);
795
796 if (!(tr->trace_flags & TRACE_ITER_CONTEXT_INFO))
797 return;
798
799 /* Absolute time */
800 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
801 print_graph_abs_time(iter->ts, s);
802
803 /* Relative time */
804 if (flags & TRACE_GRAPH_PRINT_REL_TIME)
805 print_graph_rel_time(iter, s);
806
807 /* Cpu */
808 if (flags & TRACE_GRAPH_PRINT_CPU)
809 print_graph_cpu(s, cpu);
810
811 /* Proc */
812 if (flags & TRACE_GRAPH_PRINT_PROC) {
813 print_graph_proc(s, ent->pid);
814 trace_seq_puts(s, " | ");
815 }
816
817 /* Latency format */
818 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT)
819 print_graph_lat_fmt(s, ent);
820
821 return;
822}
823
824/*
825 * Entry check for irq code
826 *
827 * returns 1 if
828 * - we are inside irq code
829 * - we just entered irq code
830 *
831 * returns 0 if
832 * - funcgraph-interrupts option is set
833 * - we are not inside irq code
834 */
835static int
836check_irq_entry(struct trace_iterator *iter, u32 flags,
837 unsigned long addr, int depth)
838{
839 int cpu = iter->cpu;
840 int *depth_irq;
841 struct fgraph_data *data = iter->private;
842
843 /*
844 * If we are either displaying irqs, or we got called as
845 * a graph event and private data does not exist,
846 * then we bypass the irq check.
847 */
848 if ((flags & TRACE_GRAPH_PRINT_IRQS) ||
849 (!data))
850 return 0;
851
852 depth_irq = &(per_cpu_ptr(data->cpu_data, cpu)->depth_irq);
853
854 /*
855 * We are inside the irq code
856 */
857 if (*depth_irq >= 0)
858 return 1;
859
860 if ((addr < (unsigned long)__irqentry_text_start) ||
861 (addr >= (unsigned long)__irqentry_text_end))
862 return 0;
863
864 /*
865 * We are entering irq code.
866 */
867 *depth_irq = depth;
868 return 1;
869}
870
871/*
872 * Return check for irq code
873 *
874 * returns 1 if
875 * - we are inside irq code
876 * - we just left irq code
877 *
878 * returns 0 if
879 * - funcgraph-interrupts option is set
880 * - we are not inside irq code
881 */
882static int
883check_irq_return(struct trace_iterator *iter, u32 flags, int depth)
884{
885 int cpu = iter->cpu;
886 int *depth_irq;
887 struct fgraph_data *data = iter->private;
888
889 /*
890 * If we are either displaying irqs, or we got called as
891 * a graph event and private data does not exist,
892 * then we bypass the irq check.
893 */
894 if ((flags & TRACE_GRAPH_PRINT_IRQS) ||
895 (!data))
896 return 0;
897
898 depth_irq = &(per_cpu_ptr(data->cpu_data, cpu)->depth_irq);
899
900 /*
901 * We are not inside the irq code.
902 */
903 if (*depth_irq == -1)
904 return 0;
905
906 /*
907 * We are inside the irq code, and this is returning entry.
908 * Let's not trace it and clear the entry depth, since
909 * we are out of irq code.
910 *
911 * This condition ensures that we 'leave the irq code' once
912 * we are out of the entry depth. Thus protecting us from
913 * the RETURN entry loss.
914 */
915 if (*depth_irq >= depth) {
916 *depth_irq = -1;
917 return 1;
918 }
919
920 /*
921 * We are inside the irq code, and this is not the entry.
922 */
923 return 1;
924}
925
926static enum print_line_t
927print_graph_entry(struct ftrace_graph_ent_entry *field, struct trace_seq *s,
928 struct trace_iterator *iter, u32 flags)
929{
930 struct fgraph_data *data = iter->private;
931 struct ftrace_graph_ent *call = &field->graph_ent;
932 struct ftrace_graph_ret_entry *leaf_ret;
933 static enum print_line_t ret;
934 int cpu = iter->cpu;
935
936 if (check_irq_entry(iter, flags, call->func, call->depth))
937 return TRACE_TYPE_HANDLED;
938
939 print_graph_prologue(iter, s, TRACE_GRAPH_ENT, call->func, flags);
940
941 leaf_ret = get_return_for_leaf(iter, field);
942 if (leaf_ret)
943 ret = print_graph_entry_leaf(iter, field, leaf_ret, s, flags);
944 else
945 ret = print_graph_entry_nested(iter, field, s, cpu, flags);
946
947 if (data) {
948 /*
949 * If we failed to write our output, then we need to make
950 * note of it. Because we already consumed our entry.
951 */
952 if (s->full) {
953 data->failed = 1;
954 data->cpu = cpu;
955 } else
956 data->failed = 0;
957 }
958
959 return ret;
960}
961
962static enum print_line_t
963print_graph_return(struct ftrace_graph_ret *trace, struct trace_seq *s,
964 struct trace_entry *ent, struct trace_iterator *iter,
965 u32 flags)
966{
967 unsigned long long duration = trace->rettime - trace->calltime;
968 struct fgraph_data *data = iter->private;
969 struct trace_array *tr = iter->tr;
970 pid_t pid = ent->pid;
971 int cpu = iter->cpu;
972 int func_match = 1;
973 int i;
974
975 if (check_irq_return(iter, flags, trace->depth))
976 return TRACE_TYPE_HANDLED;
977
978 if (data) {
979 struct fgraph_cpu_data *cpu_data;
980 int cpu = iter->cpu;
981
982 cpu_data = per_cpu_ptr(data->cpu_data, cpu);
983
984 /*
985 * Comments display at + 1 to depth. This is the
986 * return from a function, we now want the comments
987 * to display at the same level of the bracket.
988 */
989 cpu_data->depth = trace->depth - 1;
990
991 if (trace->depth < FTRACE_RETFUNC_DEPTH &&
992 !WARN_ON_ONCE(trace->depth < 0)) {
993 if (cpu_data->enter_funcs[trace->depth] != trace->func)
994 func_match = 0;
995 cpu_data->enter_funcs[trace->depth] = 0;
996 }
997 }
998
999 print_graph_prologue(iter, s, 0, 0, flags);
1000
1001 /* Overhead and duration */
1002 print_graph_duration(tr, duration, s, flags);
1003
1004 /* Closing brace */
1005 for (i = 0; i < trace->depth * TRACE_GRAPH_INDENT; i++)
1006 trace_seq_putc(s, ' ');
1007
1008 /*
1009 * Always write out the function name and its return value if the
1010 * function-retval option is enabled.
1011 */
1012 if (flags & __TRACE_GRAPH_PRINT_RETVAL) {
1013 print_graph_retval(s, trace->retval, false, (void *)trace->func,
1014 !!(flags & TRACE_GRAPH_PRINT_RETVAL_HEX));
1015 } else {
1016 /*
1017 * If the return function does not have a matching entry,
1018 * then the entry was lost. Instead of just printing
1019 * the '}' and letting the user guess what function this
1020 * belongs to, write out the function name. Always do
1021 * that if the funcgraph-tail option is enabled.
1022 */
1023 if (func_match && !(flags & TRACE_GRAPH_PRINT_TAIL))
1024 trace_seq_puts(s, "}\n");
1025 else
1026 trace_seq_printf(s, "} /* %ps */\n", (void *)trace->func);
1027 }
1028
1029 /* Overrun */
1030 if (flags & TRACE_GRAPH_PRINT_OVERRUN)
1031 trace_seq_printf(s, " (Overruns: %u)\n",
1032 trace->overrun);
1033
1034 print_graph_irq(iter, trace->func, TRACE_GRAPH_RET,
1035 cpu, pid, flags);
1036
1037 return trace_handle_return(s);
1038}
1039
1040static enum print_line_t
1041print_graph_comment(struct trace_seq *s, struct trace_entry *ent,
1042 struct trace_iterator *iter, u32 flags)
1043{
1044 struct trace_array *tr = iter->tr;
1045 unsigned long sym_flags = (tr->trace_flags & TRACE_ITER_SYM_MASK);
1046 struct fgraph_data *data = iter->private;
1047 struct trace_event *event;
1048 int depth = 0;
1049 int ret;
1050 int i;
1051
1052 if (data)
1053 depth = per_cpu_ptr(data->cpu_data, iter->cpu)->depth;
1054
1055 print_graph_prologue(iter, s, 0, 0, flags);
1056
1057 /* No time */
1058 print_graph_duration(tr, 0, s, flags | FLAGS_FILL_FULL);
1059
1060 /* Indentation */
1061 if (depth > 0)
1062 for (i = 0; i < (depth + 1) * TRACE_GRAPH_INDENT; i++)
1063 trace_seq_putc(s, ' ');
1064
1065 /* The comment */
1066 trace_seq_puts(s, "/* ");
1067
1068 switch (iter->ent->type) {
1069 case TRACE_BPUTS:
1070 ret = trace_print_bputs_msg_only(iter);
1071 if (ret != TRACE_TYPE_HANDLED)
1072 return ret;
1073 break;
1074 case TRACE_BPRINT:
1075 ret = trace_print_bprintk_msg_only(iter);
1076 if (ret != TRACE_TYPE_HANDLED)
1077 return ret;
1078 break;
1079 case TRACE_PRINT:
1080 ret = trace_print_printk_msg_only(iter);
1081 if (ret != TRACE_TYPE_HANDLED)
1082 return ret;
1083 break;
1084 default:
1085 event = ftrace_find_event(ent->type);
1086 if (!event)
1087 return TRACE_TYPE_UNHANDLED;
1088
1089 ret = event->funcs->trace(iter, sym_flags, event);
1090 if (ret != TRACE_TYPE_HANDLED)
1091 return ret;
1092 }
1093
1094 if (trace_seq_has_overflowed(s))
1095 goto out;
1096
1097 /* Strip ending newline */
1098 if (s->buffer[s->seq.len - 1] == '\n') {
1099 s->buffer[s->seq.len - 1] = '\0';
1100 s->seq.len--;
1101 }
1102
1103 trace_seq_puts(s, " */\n");
1104 out:
1105 return trace_handle_return(s);
1106}
1107
1108
1109enum print_line_t
1110print_graph_function_flags(struct trace_iterator *iter, u32 flags)
1111{
1112 struct ftrace_graph_ent_entry *field;
1113 struct fgraph_data *data = iter->private;
1114 struct trace_entry *entry = iter->ent;
1115 struct trace_seq *s = &iter->seq;
1116 int cpu = iter->cpu;
1117 int ret;
1118
1119 if (data && per_cpu_ptr(data->cpu_data, cpu)->ignore) {
1120 per_cpu_ptr(data->cpu_data, cpu)->ignore = 0;
1121 return TRACE_TYPE_HANDLED;
1122 }
1123
1124 /*
1125 * If the last output failed, there's a possibility we need
1126 * to print out the missing entry which would never go out.
1127 */
1128 if (data && data->failed) {
1129 field = &data->ent;
1130 iter->cpu = data->cpu;
1131 ret = print_graph_entry(field, s, iter, flags);
1132 if (ret == TRACE_TYPE_HANDLED && iter->cpu != cpu) {
1133 per_cpu_ptr(data->cpu_data, iter->cpu)->ignore = 1;
1134 ret = TRACE_TYPE_NO_CONSUME;
1135 }
1136 iter->cpu = cpu;
1137 return ret;
1138 }
1139
1140 switch (entry->type) {
1141 case TRACE_GRAPH_ENT: {
1142 /*
1143 * print_graph_entry() may consume the current event,
1144 * thus @field may become invalid, so we need to save it.
1145 * sizeof(struct ftrace_graph_ent_entry) is very small,
1146 * it can be safely saved at the stack.
1147 */
1148 struct ftrace_graph_ent_entry saved;
1149 trace_assign_type(field, entry);
1150 saved = *field;
1151 return print_graph_entry(&saved, s, iter, flags);
1152 }
1153 case TRACE_GRAPH_RET: {
1154 struct ftrace_graph_ret_entry *field;
1155 trace_assign_type(field, entry);
1156 return print_graph_return(&field->ret, s, entry, iter, flags);
1157 }
1158 case TRACE_STACK:
1159 case TRACE_FN:
1160 /* dont trace stack and functions as comments */
1161 return TRACE_TYPE_UNHANDLED;
1162
1163 default:
1164 return print_graph_comment(s, entry, iter, flags);
1165 }
1166
1167 return TRACE_TYPE_HANDLED;
1168}
1169
1170static enum print_line_t
1171print_graph_function(struct trace_iterator *iter)
1172{
1173 return print_graph_function_flags(iter, tracer_flags.val);
1174}
1175
1176static enum print_line_t
1177print_graph_function_event(struct trace_iterator *iter, int flags,
1178 struct trace_event *event)
1179{
1180 return print_graph_function(iter);
1181}
1182
1183static void print_lat_header(struct seq_file *s, u32 flags)
1184{
1185 static const char spaces[] = " " /* 16 spaces */
1186 " " /* 4 spaces */
1187 " "; /* 17 spaces */
1188 int size = 0;
1189
1190 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
1191 size += 16;
1192 if (flags & TRACE_GRAPH_PRINT_REL_TIME)
1193 size += 16;
1194 if (flags & TRACE_GRAPH_PRINT_CPU)
1195 size += 4;
1196 if (flags & TRACE_GRAPH_PRINT_PROC)
1197 size += 17;
1198
1199 seq_printf(s, "#%.*s _-----=> irqs-off \n", size, spaces);
1200 seq_printf(s, "#%.*s / _----=> need-resched \n", size, spaces);
1201 seq_printf(s, "#%.*s| / _---=> hardirq/softirq \n", size, spaces);
1202 seq_printf(s, "#%.*s|| / _--=> preempt-depth \n", size, spaces);
1203 seq_printf(s, "#%.*s||| / \n", size, spaces);
1204}
1205
1206static void __print_graph_headers_flags(struct trace_array *tr,
1207 struct seq_file *s, u32 flags)
1208{
1209 int lat = tr->trace_flags & TRACE_ITER_LATENCY_FMT;
1210
1211 if (lat)
1212 print_lat_header(s, flags);
1213
1214 /* 1st line */
1215 seq_putc(s, '#');
1216 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
1217 seq_puts(s, " TIME ");
1218 if (flags & TRACE_GRAPH_PRINT_REL_TIME)
1219 seq_puts(s, " REL TIME ");
1220 if (flags & TRACE_GRAPH_PRINT_CPU)
1221 seq_puts(s, " CPU");
1222 if (flags & TRACE_GRAPH_PRINT_PROC)
1223 seq_puts(s, " TASK/PID ");
1224 if (lat)
1225 seq_puts(s, "|||| ");
1226 if (flags & TRACE_GRAPH_PRINT_DURATION)
1227 seq_puts(s, " DURATION ");
1228 seq_puts(s, " FUNCTION CALLS\n");
1229
1230 /* 2nd line */
1231 seq_putc(s, '#');
1232 if (flags & TRACE_GRAPH_PRINT_ABS_TIME)
1233 seq_puts(s, " | ");
1234 if (flags & TRACE_GRAPH_PRINT_REL_TIME)
1235 seq_puts(s, " | ");
1236 if (flags & TRACE_GRAPH_PRINT_CPU)
1237 seq_puts(s, " | ");
1238 if (flags & TRACE_GRAPH_PRINT_PROC)
1239 seq_puts(s, " | | ");
1240 if (lat)
1241 seq_puts(s, "|||| ");
1242 if (flags & TRACE_GRAPH_PRINT_DURATION)
1243 seq_puts(s, " | | ");
1244 seq_puts(s, " | | | |\n");
1245}
1246
1247static void print_graph_headers(struct seq_file *s)
1248{
1249 print_graph_headers_flags(s, tracer_flags.val);
1250}
1251
1252void print_graph_headers_flags(struct seq_file *s, u32 flags)
1253{
1254 struct trace_iterator *iter = s->private;
1255 struct trace_array *tr = iter->tr;
1256
1257 if (!(tr->trace_flags & TRACE_ITER_CONTEXT_INFO))
1258 return;
1259
1260 if (tr->trace_flags & TRACE_ITER_LATENCY_FMT) {
1261 /* print nothing if the buffers are empty */
1262 if (trace_empty(iter))
1263 return;
1264
1265 print_trace_header(s, iter);
1266 }
1267
1268 __print_graph_headers_flags(tr, s, flags);
1269}
1270
1271void graph_trace_open(struct trace_iterator *iter)
1272{
1273 /* pid and depth on the last trace processed */
1274 struct fgraph_data *data;
1275 gfp_t gfpflags;
1276 int cpu;
1277
1278 iter->private = NULL;
1279
1280 /* We can be called in atomic context via ftrace_dump() */
1281 gfpflags = (in_atomic() || irqs_disabled()) ? GFP_ATOMIC : GFP_KERNEL;
1282
1283 data = kzalloc(sizeof(*data), gfpflags);
1284 if (!data)
1285 goto out_err;
1286
1287 data->cpu_data = alloc_percpu_gfp(struct fgraph_cpu_data, gfpflags);
1288 if (!data->cpu_data)
1289 goto out_err_free;
1290
1291 for_each_possible_cpu(cpu) {
1292 pid_t *pid = &(per_cpu_ptr(data->cpu_data, cpu)->last_pid);
1293 int *depth = &(per_cpu_ptr(data->cpu_data, cpu)->depth);
1294 int *ignore = &(per_cpu_ptr(data->cpu_data, cpu)->ignore);
1295 int *depth_irq = &(per_cpu_ptr(data->cpu_data, cpu)->depth_irq);
1296
1297 *pid = -1;
1298 *depth = 0;
1299 *ignore = 0;
1300 *depth_irq = -1;
1301 }
1302
1303 iter->private = data;
1304
1305 return;
1306
1307 out_err_free:
1308 kfree(data);
1309 out_err:
1310 pr_warn("function graph tracer: not enough memory\n");
1311}
1312
1313void graph_trace_close(struct trace_iterator *iter)
1314{
1315 struct fgraph_data *data = iter->private;
1316
1317 if (data) {
1318 free_percpu(data->cpu_data);
1319 kfree(data);
1320 }
1321}
1322
1323static int
1324func_graph_set_flag(struct trace_array *tr, u32 old_flags, u32 bit, int set)
1325{
1326 if (bit == TRACE_GRAPH_PRINT_IRQS)
1327 ftrace_graph_skip_irqs = !set;
1328
1329 if (bit == TRACE_GRAPH_SLEEP_TIME)
1330 ftrace_graph_sleep_time_control(set);
1331
1332 if (bit == TRACE_GRAPH_GRAPH_TIME)
1333 ftrace_graph_graph_time_control(set);
1334
1335 return 0;
1336}
1337
1338static struct trace_event_functions graph_functions = {
1339 .trace = print_graph_function_event,
1340};
1341
1342static struct trace_event graph_trace_entry_event = {
1343 .type = TRACE_GRAPH_ENT,
1344 .funcs = &graph_functions,
1345};
1346
1347static struct trace_event graph_trace_ret_event = {
1348 .type = TRACE_GRAPH_RET,
1349 .funcs = &graph_functions
1350};
1351
1352static struct tracer graph_trace __tracer_data = {
1353 .name = "function_graph",
1354 .update_thresh = graph_trace_update_thresh,
1355 .open = graph_trace_open,
1356 .pipe_open = graph_trace_open,
1357 .close = graph_trace_close,
1358 .pipe_close = graph_trace_close,
1359 .init = graph_trace_init,
1360 .reset = graph_trace_reset,
1361 .print_line = print_graph_function,
1362 .print_header = print_graph_headers,
1363 .flags = &tracer_flags,
1364 .set_flag = func_graph_set_flag,
1365#ifdef CONFIG_FTRACE_SELFTEST
1366 .selftest = trace_selftest_startup_function_graph,
1367#endif
1368};
1369
1370
1371static ssize_t
1372graph_depth_write(struct file *filp, const char __user *ubuf, size_t cnt,
1373 loff_t *ppos)
1374{
1375 unsigned long val;
1376 int ret;
1377
1378 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
1379 if (ret)
1380 return ret;
1381
1382 fgraph_max_depth = val;
1383
1384 *ppos += cnt;
1385
1386 return cnt;
1387}
1388
1389static ssize_t
1390graph_depth_read(struct file *filp, char __user *ubuf, size_t cnt,
1391 loff_t *ppos)
1392{
1393 char buf[15]; /* More than enough to hold UINT_MAX + "\n"*/
1394 int n;
1395
1396 n = sprintf(buf, "%d\n", fgraph_max_depth);
1397
1398 return simple_read_from_buffer(ubuf, cnt, ppos, buf, n);
1399}
1400
1401static const struct file_operations graph_depth_fops = {
1402 .open = tracing_open_generic,
1403 .write = graph_depth_write,
1404 .read = graph_depth_read,
1405 .llseek = generic_file_llseek,
1406};
1407
1408static __init int init_graph_tracefs(void)
1409{
1410 int ret;
1411
1412 ret = tracing_init_dentry();
1413 if (ret)
1414 return 0;
1415
1416 trace_create_file("max_graph_depth", TRACE_MODE_WRITE, NULL,
1417 NULL, &graph_depth_fops);
1418
1419 return 0;
1420}
1421fs_initcall(init_graph_tracefs);
1422
1423static __init int init_graph_trace(void)
1424{
1425 max_bytes_for_cpu = snprintf(NULL, 0, "%u", nr_cpu_ids - 1);
1426
1427 if (!register_trace_event(&graph_trace_entry_event)) {
1428 pr_warn("Warning: could not register graph trace events\n");
1429 return 1;
1430 }
1431
1432 if (!register_trace_event(&graph_trace_ret_event)) {
1433 pr_warn("Warning: could not register graph trace events\n");
1434 return 1;
1435 }
1436
1437 return register_tracer(&graph_trace);
1438}
1439
1440core_initcall(init_graph_trace);