2 * Stack tracing support
4 * Copyright (C) 2012 ARM Ltd.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 #include <linux/kernel.h>
19 #include <linux/export.h>
20 #include <linux/ftrace.h>
21 #include <linux/kprobes.h>
22 #include <linux/sched.h>
23 #include <linux/sched/debug.h>
24 #include <linux/sched/task_stack.h>
25 #include <linux/stacktrace.h>
28 #include <asm/stack_pointer.h>
29 #include <asm/stacktrace.h>
32 * AArch64 PCS assigns the frame pointer to x29.
34 * A simple function prologue looks like this:
39 * A simple function epilogue looks like this:
44 int notrace unwind_frame(struct task_struct *tsk, struct stackframe *frame)
46 unsigned long fp = frame->fp;
54 if (!on_accessible_stack(tsk, fp))
57 frame->fp = READ_ONCE_NOCHECK(*(unsigned long *)(fp));
58 frame->pc = READ_ONCE_NOCHECK(*(unsigned long *)(fp + 8));
60 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
62 (frame->pc == (unsigned long)return_to_handler)) {
63 if (WARN_ON_ONCE(frame->graph == -1))
65 if (frame->graph < -1)
66 frame->graph += FTRACE_NOTRACE_DEPTH;
69 * This is a case where function graph tracer has
70 * modified a return address (LR) in a stack frame
71 * to hook a function return.
72 * So replace it to an original value.
74 frame->pc = tsk->ret_stack[frame->graph--].ret;
76 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
79 * Frames created upon entry from EL0 have NULL FP and PC values, so
80 * don't bother reporting these. Frames created by __noreturn functions
81 * might have a valid FP even if PC is bogus, so only terminate where
84 if (!frame->fp && !frame->pc)
89 NOKPROBE_SYMBOL(unwind_frame);
91 void notrace walk_stackframe(struct task_struct *tsk, struct stackframe *frame,
92 int (*fn)(struct stackframe *, void *), void *data)
99 ret = unwind_frame(tsk, frame);
104 NOKPROBE_SYMBOL(walk_stackframe);
106 #ifdef CONFIG_STACKTRACE
107 struct stack_trace_data {
108 struct stack_trace *trace;
109 unsigned int no_sched_functions;
113 static int save_trace(struct stackframe *frame, void *d)
115 struct stack_trace_data *data = d;
116 struct stack_trace *trace = data->trace;
117 unsigned long addr = frame->pc;
119 if (data->no_sched_functions && in_sched_functions(addr))
126 trace->entries[trace->nr_entries++] = addr;
128 return trace->nr_entries >= trace->max_entries;
131 void save_stack_trace_regs(struct pt_regs *regs, struct stack_trace *trace)
133 struct stack_trace_data data;
134 struct stackframe frame;
137 data.skip = trace->skip;
138 data.no_sched_functions = 0;
140 frame.fp = regs->regs[29];
142 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
143 frame.graph = current->curr_ret_stack;
146 walk_stackframe(current, &frame, save_trace, &data);
147 if (trace->nr_entries < trace->max_entries)
148 trace->entries[trace->nr_entries++] = ULONG_MAX;
151 static noinline void __save_stack_trace(struct task_struct *tsk,
152 struct stack_trace *trace, unsigned int nosched)
154 struct stack_trace_data data;
155 struct stackframe frame;
157 if (!try_get_task_stack(tsk))
161 data.skip = trace->skip;
162 data.no_sched_functions = nosched;
164 if (tsk != current) {
165 frame.fp = thread_saved_fp(tsk);
166 frame.pc = thread_saved_pc(tsk);
168 /* We don't want this function nor the caller */
170 frame.fp = (unsigned long)__builtin_frame_address(0);
171 frame.pc = (unsigned long)__save_stack_trace;
173 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
174 frame.graph = tsk->curr_ret_stack;
177 walk_stackframe(tsk, &frame, save_trace, &data);
178 if (trace->nr_entries < trace->max_entries)
179 trace->entries[trace->nr_entries++] = ULONG_MAX;
183 EXPORT_SYMBOL_GPL(save_stack_trace_tsk);
185 void save_stack_trace_tsk(struct task_struct *tsk, struct stack_trace *trace)
187 __save_stack_trace(tsk, trace, 1);
190 void save_stack_trace(struct stack_trace *trace)
192 __save_stack_trace(current, trace, 0);
195 EXPORT_SYMBOL_GPL(save_stack_trace);