xref: /linux/arch/x86/kernel/unwind_frame.c (revision 5c99b692cfd62f6915ed7ee7ed3c38d65ba3feab)
1 #include <linux/sched.h>
2 #include <linux/sched/task.h>
3 #include <linux/sched/task_stack.h>
4 #include <linux/interrupt.h>
5 #include <asm/sections.h>
6 #include <asm/ptrace.h>
7 #include <asm/bitops.h>
8 #include <asm/stacktrace.h>
9 #include <asm/unwind.h>
10 
11 #define FRAME_HEADER_SIZE (sizeof(long) * 2)
12 
13 unsigned long unwind_get_return_address(struct unwind_state *state)
14 {
15 	if (unwind_done(state))
16 		return 0;
17 
18 	return __kernel_text_address(state->ip) ? state->ip : 0;
19 }
20 EXPORT_SYMBOL_GPL(unwind_get_return_address);
21 
22 unsigned long *unwind_get_return_address_ptr(struct unwind_state *state)
23 {
24 	if (unwind_done(state))
25 		return NULL;
26 
27 	return state->regs ? &state->regs->ip : state->bp + 1;
28 }
29 
30 static void unwind_dump(struct unwind_state *state)
31 {
32 	static bool dumped_before = false;
33 	bool prev_zero, zero = false;
34 	unsigned long word, *sp;
35 	struct stack_info stack_info = {0};
36 	unsigned long visit_mask = 0;
37 
38 	if (dumped_before)
39 		return;
40 
41 	dumped_before = true;
42 
43 	printk_deferred("unwind stack type:%d next_sp:%p mask:0x%lx graph_idx:%d\n",
44 			state->stack_info.type, state->stack_info.next_sp,
45 			state->stack_mask, state->graph_idx);
46 
47 	for (sp = state->orig_sp; sp; sp = PTR_ALIGN(stack_info.next_sp, sizeof(long))) {
48 		if (get_stack_info(sp, state->task, &stack_info, &visit_mask))
49 			break;
50 
51 		for (; sp < stack_info.end; sp++) {
52 
53 			word = READ_ONCE_NOCHECK(*sp);
54 
55 			prev_zero = zero;
56 			zero = word == 0;
57 
58 			if (zero) {
59 				if (!prev_zero)
60 					printk_deferred("%p: %0*x ...\n",
61 							sp, BITS_PER_LONG/4, 0);
62 				continue;
63 			}
64 
65 			printk_deferred("%p: %0*lx (%pB)\n",
66 					sp, BITS_PER_LONG/4, word, (void *)word);
67 		}
68 	}
69 }
70 
71 static size_t regs_size(struct pt_regs *regs)
72 {
73 	/* x86_32 regs from kernel mode are two words shorter: */
74 	if (IS_ENABLED(CONFIG_X86_32) && !user_mode(regs))
75 		return sizeof(*regs) - 2*sizeof(long);
76 
77 	return sizeof(*regs);
78 }
79 
80 static bool in_entry_code(unsigned long ip)
81 {
82 	char *addr = (char *)ip;
83 
84 	if (addr >= __entry_text_start && addr < __entry_text_end)
85 		return true;
86 
87 	if (addr >= __irqentry_text_start && addr < __irqentry_text_end)
88 		return true;
89 
90 	return false;
91 }
92 
93 static inline unsigned long *last_frame(struct unwind_state *state)
94 {
95 	return (unsigned long *)task_pt_regs(state->task) - 2;
96 }
97 
98 static bool is_last_frame(struct unwind_state *state)
99 {
100 	return state->bp == last_frame(state);
101 }
102 
103 #ifdef CONFIG_X86_32
104 #define GCC_REALIGN_WORDS 3
105 #else
106 #define GCC_REALIGN_WORDS 1
107 #endif
108 
109 static inline unsigned long *last_aligned_frame(struct unwind_state *state)
110 {
111 	return last_frame(state) - GCC_REALIGN_WORDS;
112 }
113 
114 static bool is_last_aligned_frame(struct unwind_state *state)
115 {
116 	unsigned long *last_bp = last_frame(state);
117 	unsigned long *aligned_bp = last_aligned_frame(state);
118 
119 	/*
120 	 * GCC can occasionally decide to realign the stack pointer and change
121 	 * the offset of the stack frame in the prologue of a function called
122 	 * by head/entry code.  Examples:
123 	 *
124 	 * <start_secondary>:
125 	 *      push   %edi
126 	 *      lea    0x8(%esp),%edi
127 	 *      and    $0xfffffff8,%esp
128 	 *      pushl  -0x4(%edi)
129 	 *      push   %ebp
130 	 *      mov    %esp,%ebp
131 	 *
132 	 * <x86_64_start_kernel>:
133 	 *      lea    0x8(%rsp),%r10
134 	 *      and    $0xfffffffffffffff0,%rsp
135 	 *      pushq  -0x8(%r10)
136 	 *      push   %rbp
137 	 *      mov    %rsp,%rbp
138 	 *
139 	 * After aligning the stack, it pushes a duplicate copy of the return
140 	 * address before pushing the frame pointer.
141 	 */
142 	return (state->bp == aligned_bp && *(aligned_bp + 1) == *(last_bp + 1));
143 }
144 
145 static bool is_last_ftrace_frame(struct unwind_state *state)
146 {
147 	unsigned long *last_bp = last_frame(state);
148 	unsigned long *last_ftrace_bp = last_bp - 3;
149 
150 	/*
151 	 * When unwinding from an ftrace handler of a function called by entry
152 	 * code, the stack layout of the last frame is:
153 	 *
154 	 *   bp
155 	 *   parent ret addr
156 	 *   bp
157 	 *   function ret addr
158 	 *   parent ret addr
159 	 *   pt_regs
160 	 *   -----------------
161 	 */
162 	return (state->bp == last_ftrace_bp &&
163 		*state->bp == *(state->bp + 2) &&
164 		*(state->bp + 1) == *(state->bp + 4));
165 }
166 
167 static bool is_last_task_frame(struct unwind_state *state)
168 {
169 	return is_last_frame(state) || is_last_aligned_frame(state) ||
170 	       is_last_ftrace_frame(state);
171 }
172 
173 /*
174  * This determines if the frame pointer actually contains an encoded pointer to
175  * pt_regs on the stack.  See ENCODE_FRAME_POINTER.
176  */
177 #ifdef CONFIG_X86_64
178 static struct pt_regs *decode_frame_pointer(unsigned long *bp)
179 {
180 	unsigned long regs = (unsigned long)bp;
181 
182 	if (!(regs & 0x1))
183 		return NULL;
184 
185 	return (struct pt_regs *)(regs & ~0x1);
186 }
187 #else
188 static struct pt_regs *decode_frame_pointer(unsigned long *bp)
189 {
190 	unsigned long regs = (unsigned long)bp;
191 
192 	if (regs & 0x80000000)
193 		return NULL;
194 
195 	return (struct pt_regs *)(regs | 0x80000000);
196 }
197 #endif
198 
199 #ifdef CONFIG_X86_32
200 #define KERNEL_REGS_SIZE (sizeof(struct pt_regs) - 2*sizeof(long))
201 #else
202 #define KERNEL_REGS_SIZE (sizeof(struct pt_regs))
203 #endif
204 
205 static bool update_stack_state(struct unwind_state *state,
206 			       unsigned long *next_bp)
207 {
208 	struct stack_info *info = &state->stack_info;
209 	enum stack_type prev_type = info->type;
210 	struct pt_regs *regs;
211 	unsigned long *frame, *prev_frame_end, *addr_p, addr;
212 	size_t len;
213 
214 	if (state->regs)
215 		prev_frame_end = (void *)state->regs + regs_size(state->regs);
216 	else
217 		prev_frame_end = (void *)state->bp + FRAME_HEADER_SIZE;
218 
219 	/* Is the next frame pointer an encoded pointer to pt_regs? */
220 	regs = decode_frame_pointer(next_bp);
221 	if (regs) {
222 		frame = (unsigned long *)regs;
223 		len = KERNEL_REGS_SIZE;
224 		state->got_irq = true;
225 	} else {
226 		frame = next_bp;
227 		len = FRAME_HEADER_SIZE;
228 	}
229 
230 	/*
231 	 * If the next bp isn't on the current stack, switch to the next one.
232 	 *
233 	 * We may have to traverse multiple stacks to deal with the possibility
234 	 * that info->next_sp could point to an empty stack and the next bp
235 	 * could be on a subsequent stack.
236 	 */
237 	while (!on_stack(info, frame, len))
238 		if (get_stack_info(info->next_sp, state->task, info,
239 				   &state->stack_mask))
240 			return false;
241 
242 	/* Make sure it only unwinds up and doesn't overlap the prev frame: */
243 	if (state->orig_sp && state->stack_info.type == prev_type &&
244 	    frame < prev_frame_end)
245 		return false;
246 
247 	/*
248 	 * On 32-bit with user mode regs, make sure the last two regs are safe
249 	 * to access:
250 	 */
251 	if (IS_ENABLED(CONFIG_X86_32) && regs && user_mode(regs) &&
252 	    !on_stack(info, frame, len + 2*sizeof(long)))
253 		return false;
254 
255 	/* Move state to the next frame: */
256 	if (regs) {
257 		state->regs = regs;
258 		state->bp = NULL;
259 	} else {
260 		state->bp = next_bp;
261 		state->regs = NULL;
262 	}
263 
264 	/* Save the return address: */
265 	if (state->regs && user_mode(state->regs))
266 		state->ip = 0;
267 	else {
268 		addr_p = unwind_get_return_address_ptr(state);
269 		addr = READ_ONCE_TASK_STACK(state->task, *addr_p);
270 		state->ip = ftrace_graph_ret_addr(state->task, &state->graph_idx,
271 						  addr, addr_p);
272 	}
273 
274 	/* Save the original stack pointer for unwind_dump(): */
275 	if (!state->orig_sp)
276 		state->orig_sp = frame;
277 
278 	return true;
279 }
280 
281 bool unwind_next_frame(struct unwind_state *state)
282 {
283 	struct pt_regs *regs;
284 	unsigned long *next_bp;
285 
286 	if (unwind_done(state))
287 		return false;
288 
289 	/* Have we reached the end? */
290 	if (state->regs && user_mode(state->regs))
291 		goto the_end;
292 
293 	if (is_last_task_frame(state)) {
294 		regs = task_pt_regs(state->task);
295 
296 		/*
297 		 * kthreads (other than the boot CPU's idle thread) have some
298 		 * partial regs at the end of their stack which were placed
299 		 * there by copy_thread_tls().  But the regs don't have any
300 		 * useful information, so we can skip them.
301 		 *
302 		 * This user_mode() check is slightly broader than a PF_KTHREAD
303 		 * check because it also catches the awkward situation where a
304 		 * newly forked kthread transitions into a user task by calling
305 		 * do_execve(), which eventually clears PF_KTHREAD.
306 		 */
307 		if (!user_mode(regs))
308 			goto the_end;
309 
310 		/*
311 		 * We're almost at the end, but not quite: there's still the
312 		 * syscall regs frame.  Entry code doesn't encode the regs
313 		 * pointer for syscalls, so we have to set it manually.
314 		 */
315 		state->regs = regs;
316 		state->bp = NULL;
317 		state->ip = 0;
318 		return true;
319 	}
320 
321 	/* Get the next frame pointer: */
322 	if (state->regs)
323 		next_bp = (unsigned long *)state->regs->bp;
324 	else
325 		next_bp = (unsigned long *)READ_ONCE_TASK_STACK(state->task, *state->bp);
326 
327 	/* Move to the next frame if it's safe: */
328 	if (!update_stack_state(state, next_bp))
329 		goto bad_address;
330 
331 	return true;
332 
333 bad_address:
334 	state->error = true;
335 
336 	/*
337 	 * When unwinding a non-current task, the task might actually be
338 	 * running on another CPU, in which case it could be modifying its
339 	 * stack while we're reading it.  This is generally not a problem and
340 	 * can be ignored as long as the caller understands that unwinding
341 	 * another task will not always succeed.
342 	 */
343 	if (state->task != current)
344 		goto the_end;
345 
346 	/*
347 	 * Don't warn if the unwinder got lost due to an interrupt in entry
348 	 * code or in the C handler before the first frame pointer got set up:
349 	 */
350 	if (state->got_irq && in_entry_code(state->ip))
351 		goto the_end;
352 	if (state->regs &&
353 	    state->regs->sp >= (unsigned long)last_aligned_frame(state) &&
354 	    state->regs->sp < (unsigned long)task_pt_regs(state->task))
355 		goto the_end;
356 
357 	if (state->regs) {
358 		printk_deferred_once(KERN_WARNING
359 			"WARNING: kernel stack regs at %p in %s:%d has bad 'bp' value %p\n",
360 			state->regs, state->task->comm,
361 			state->task->pid, next_bp);
362 		unwind_dump(state);
363 	} else {
364 		printk_deferred_once(KERN_WARNING
365 			"WARNING: kernel stack frame pointer at %p in %s:%d has bad value %p\n",
366 			state->bp, state->task->comm,
367 			state->task->pid, next_bp);
368 		unwind_dump(state);
369 	}
370 the_end:
371 	state->stack_info.type = STACK_TYPE_UNKNOWN;
372 	return false;
373 }
374 EXPORT_SYMBOL_GPL(unwind_next_frame);
375 
376 void __unwind_start(struct unwind_state *state, struct task_struct *task,
377 		    struct pt_regs *regs, unsigned long *first_frame)
378 {
379 	unsigned long *bp;
380 
381 	memset(state, 0, sizeof(*state));
382 	state->task = task;
383 	state->got_irq = (regs);
384 
385 	/* Don't even attempt to start from user mode regs: */
386 	if (regs && user_mode(regs)) {
387 		state->stack_info.type = STACK_TYPE_UNKNOWN;
388 		return;
389 	}
390 
391 	bp = get_frame_pointer(task, regs);
392 
393 	/* Initialize stack info and make sure the frame data is accessible: */
394 	get_stack_info(bp, state->task, &state->stack_info,
395 		       &state->stack_mask);
396 	update_stack_state(state, bp);
397 
398 	/*
399 	 * The caller can provide the address of the first frame directly
400 	 * (first_frame) or indirectly (regs->sp) to indicate which stack frame
401 	 * to start unwinding at.  Skip ahead until we reach it.
402 	 */
403 	while (!unwind_done(state) &&
404 	       (!on_stack(&state->stack_info, first_frame, sizeof(long)) ||
405 			state->bp < first_frame))
406 		unwind_next_frame(state);
407 }
408 EXPORT_SYMBOL_GPL(__unwind_start);
409