1 // SPDX-License-Identifier: GPL-2.0-only
3 * Stack tracing support
5 * Copyright (C) 2012 ARM Ltd.
7 #include <linux/kernel.h>
8 #include <linux/export.h>
9 #include <linux/ftrace.h>
10 #include <linux/kprobes.h>
11 #include <linux/sched.h>
12 #include <linux/sched/debug.h>
13 #include <linux/sched/task_stack.h>
14 #include <linux/stacktrace.h>
17 #include <asm/pointer_auth.h>
18 #include <asm/stack_pointer.h>
19 #include <asm/stacktrace.h>
22 * AArch64 PCS assigns the frame pointer to x29.
24 * A simple function prologue looks like this:
29 * A simple function epilogue looks like this:
36 void start_backtrace(struct stackframe *frame, unsigned long fp,
41 #ifdef CONFIG_KRETPROBES
46 * Prime the first unwind.
48 * In unwind_frame() we'll check that the FP points to a valid stack,
49 * which can't be STACK_TYPE_UNKNOWN, and the first unwind will be
50 * treated as a transition to whichever stack that happens to be. The
51 * prev_fp value won't be used, but we set it to 0 such that it is
52 * definitely not an accessible stack address.
54 bitmap_zero(frame->stacks_done, __NR_STACK_TYPES);
56 frame->prev_type = STACK_TYPE_UNKNOWN;
60 * Unwind from one frame record (A) to the next frame record (B).
62 * We terminate early if the location of B indicates a malformed chain of frame
63 * records (e.g. a cycle), determined based on the location and fp value of A
64 * and the location (but not the fp value) of B.
66 int notrace unwind_frame(struct task_struct *tsk, struct stackframe *frame)
68 unsigned long fp = frame->fp;
69 struct stack_info info;
74 /* Final frame; nothing to unwind */
75 if (fp == (unsigned long)task_pt_regs(tsk)->stackframe)
81 if (!on_accessible_stack(tsk, fp, 16, &info))
84 if (test_bit(info.type, frame->stacks_done))
88 * As stacks grow downward, any valid record on the same stack must be
89 * at a strictly higher address than the prior record.
91 * Stacks can nest in several valid orders, e.g.
93 * TASK -> IRQ -> OVERFLOW -> SDEI_NORMAL
94 * TASK -> SDEI_NORMAL -> SDEI_CRITICAL -> OVERFLOW
96 * ... but the nesting itself is strict. Once we transition from one
97 * stack to another, it's never valid to unwind back to that first
100 if (info.type == frame->prev_type) {
101 if (fp <= frame->prev_fp)
104 set_bit(frame->prev_type, frame->stacks_done);
108 * Record this frame record's values and location. The prev_fp and
109 * prev_type are only meaningful to the next unwind_frame() invocation.
111 frame->fp = READ_ONCE_NOCHECK(*(unsigned long *)(fp));
112 frame->pc = READ_ONCE_NOCHECK(*(unsigned long *)(fp + 8));
114 frame->prev_type = info.type;
116 frame->pc = ptrauth_strip_insn_pac(frame->pc);
118 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
119 if (tsk->ret_stack &&
120 (frame->pc == (unsigned long)return_to_handler)) {
121 unsigned long orig_pc;
123 * This is a case where function graph tracer has
124 * modified a return address (LR) in a stack frame
125 * to hook a function return.
126 * So replace it to an original value.
128 orig_pc = ftrace_graph_ret_addr(tsk, NULL, frame->pc,
130 if (WARN_ON_ONCE(frame->pc == orig_pc))
134 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
135 #ifdef CONFIG_KRETPROBES
136 if (is_kretprobe_trampoline(frame->pc))
137 frame->pc = kretprobe_find_ret_addr(tsk, (void *)frame->fp, &frame->kr_cur);
142 NOKPROBE_SYMBOL(unwind_frame);
144 void notrace walk_stackframe(struct task_struct *tsk, struct stackframe *frame,
145 bool (*fn)(void *, unsigned long), void *data)
150 if (!fn(data, frame->pc))
152 ret = unwind_frame(tsk, frame);
157 NOKPROBE_SYMBOL(walk_stackframe);
159 static void dump_backtrace_entry(unsigned long where, const char *loglvl)
161 printk("%s %pSb\n", loglvl, (void *)where);
164 void dump_backtrace(struct pt_regs *regs, struct task_struct *tsk,
167 struct stackframe frame;
170 pr_debug("%s(regs = %p tsk = %p)\n", __func__, regs, tsk);
181 if (!try_get_task_stack(tsk))
184 if (tsk == current) {
185 start_backtrace(&frame,
186 (unsigned long)__builtin_frame_address(0),
187 (unsigned long)dump_backtrace);
190 * task blocked in __switch_to
192 start_backtrace(&frame,
193 thread_saved_fp(tsk),
194 thread_saved_pc(tsk));
197 printk("%sCall trace:\n", loglvl);
199 /* skip until specified stack frame */
201 dump_backtrace_entry(frame.pc, loglvl);
202 } else if (frame.fp == regs->regs[29]) {
205 * Mostly, this is the case where this function is
206 * called in panic/abort. As exception handler's
207 * stack frame does not contain the corresponding pc
208 * at which an exception has taken place, use regs->pc
211 dump_backtrace_entry(regs->pc, loglvl);
213 } while (!unwind_frame(tsk, &frame));
218 void show_stack(struct task_struct *tsk, unsigned long *sp, const char *loglvl)
220 dump_backtrace(NULL, tsk, loglvl);
224 noinline notrace void arch_stack_walk(stack_trace_consume_fn consume_entry,
225 void *cookie, struct task_struct *task,
226 struct pt_regs *regs)
228 struct stackframe frame;
231 start_backtrace(&frame, regs->regs[29], regs->pc);
232 else if (task == current)
233 start_backtrace(&frame,
234 (unsigned long)__builtin_frame_address(1),
235 (unsigned long)__builtin_return_address(0));
237 start_backtrace(&frame, thread_saved_fp(task),
238 thread_saved_pc(task));
240 walk_stackframe(task, &frame, consume_entry, cookie);