1 // SPDX-License-Identifier: BSD-2-Clause
2 /*-
3  * Copyright (c) 2015-2019 Linaro Limited
4  * Copyright (c) 2015 The FreeBSD Foundation
5  * All rights reserved.
6  *
7  * This software was developed by Semihalf under
8  * the sponsorship of the FreeBSD Foundation.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #include <compiler.h>
33 #include <memtag.h>
34 #include <string.h>
35 #include <trace.h>
36 #include <types_ext.h>
37 #include <unw/unwind.h>
38 #include <util.h>
39 
ftrace_map_lr(uint64_t * lr __unused)40 void __weak ftrace_map_lr(uint64_t *lr __unused)
41 {}
42 
pauth_strip_pac(uint64_t * lr __unused)43 void __weak pauth_strip_pac(uint64_t *lr __unused)
44 {}
45 
copy_in_reg(uint64_t * reg,vaddr_t addr)46 static bool copy_in_reg(uint64_t *reg, vaddr_t addr)
47 {
48 	memcpy(reg, (void *)addr, sizeof(*reg));
49 	return true;
50 }
51 
unwind_stack_arm64(struct unwind_state_arm64 * frame,vaddr_t stack,size_t stack_size)52 bool unwind_stack_arm64(struct unwind_state_arm64 *frame,
53 			vaddr_t stack, size_t stack_size)
54 {
55 	vaddr_t fp = frame->fp;
56 
57 	if (fp < stack)
58 		return false;
59 	if (fp + sizeof(uint64_t) * 3 > stack + stack_size)
60 		return false;
61 
62 	frame->sp = fp + 0x10;
63 	/* FP to previous frame (X29) */
64 	if (!copy_in_reg(&frame->fp, fp))
65 		return false;
66 	if (!frame->fp)
67 		return false;
68 	/* LR (X30) */
69 	if (!copy_in_reg(&frame->pc, fp + 8))
70 		return false;
71 
72 	pauth_strip_pac(&frame->pc);
73 
74 	ftrace_map_lr(&frame->pc);
75 
76 	frame->pc -= 4;
77 
78 	return true;
79 }
80 
print_stack_arm64(struct unwind_state_arm64 * state,vaddr_t stack,size_t stack_size)81 void print_stack_arm64(struct unwind_state_arm64 *state,
82 		       vaddr_t stack, size_t stack_size)
83 {
84 	vaddr_t va = 0;
85 	int width = 8;
86 
87 	trace_printf_helper_raw(TRACE_ERROR, true, "Call stack:");
88 
89 	ftrace_map_lr(&state->pc);
90 	do {
91 		va = memtag_strip_tag_vaddr((void *)state->pc);
92 		trace_printf_helper_raw(TRACE_ERROR, true, " 0x%0*"PRIxVA,
93 					width, va);
94 	} while (unwind_stack_arm64(state, stack, stack_size));
95 }
96