xref: /optee_os/core/arch/arm/kernel/unwind_arm64.c (revision 77327d7a47019cf9f66972403d0de1c32fe4cdee)
1 // SPDX-License-Identifier: BSD-2-Clause
2 /*-
3  * Copyright (c) 2015 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 <arm.h>
33 #include <kernel/thread.h>
34 #include <kernel/unwind.h>
35 #include <kernel/tee_misc.h>
36 #include <string.h>
37 #include <tee/tee_svc.h>
38 #include <trace.h>
39 #include <util.h>
40 
41 #include "unwind_private.h"
42 
43 static bool copy_in_reg(uint64_t *reg, vaddr_t addr, bool kernel_data)
44 {
45 	if (!kernel_data)
46 		return !tee_svc_copy_from_user(reg, (void *)addr, sizeof(*reg));
47 
48 	memcpy(reg, (void *)addr, sizeof(*reg));
49 	return true;
50 }
51 
52 bool unwind_stack_arm64(struct unwind_state_arm64 *frame, bool kernel_stack,
53 			vaddr_t stack, size_t stack_size)
54 {
55 	vaddr_t fp = frame->fp;
56 
57 	if (!core_is_buffer_inside(fp, sizeof(uint64_t) * 3,
58 				   stack, stack_size))
59 		return false;
60 
61 	frame->sp = fp + 0x10;
62 	/* FP to previous frame (X29) */
63 	if (!copy_in_reg(&frame->fp, fp, kernel_stack))
64 		return false;
65 	/* LR (X30) */
66 	if (!copy_in_reg(&frame->pc, fp + 8, kernel_stack))
67 		return false;
68 	frame->pc -= 4;
69 
70 	return true;
71 }
72 
73 #if (TRACE_LEVEL > 0)
74 
75 void print_stack_arm64(int level, struct unwind_state_arm64 *state,
76 		       bool kernel_stack, vaddr_t stack, size_t stack_size)
77 {
78 	trace_printf_helper_raw(level, true, "Call stack:");
79 	do {
80 		trace_printf_helper_raw(level, true, " 0x%016" PRIx64,
81 					state->pc);
82 	} while (unwind_stack_arm64(state, kernel_stack, stack, stack_size));
83 }
84 
85 void print_kernel_stack(int level)
86 {
87 	struct unwind_state_arm64 state;
88 	uaddr_t stack = thread_stack_start();
89 	size_t stack_size = thread_stack_size();
90 
91 	memset(&state, 0, sizeof(state));
92 	state.pc = read_pc();
93 	state.fp = read_fp();
94 
95 	print_stack_arm64(level, &state,
96 			  true /*kernel_stack*/, stack, stack_size);
97 }
98 
99 #endif
100 
101 vaddr_t *unw_get_kernel_stack(void)
102 {
103 	size_t n = 0;
104 	size_t size = 0;
105 	vaddr_t *tmp = NULL;
106 	vaddr_t *addr = NULL;
107 	struct unwind_state_arm64 state = { 0 };
108 	uaddr_t stack = thread_stack_start();
109 	size_t stack_size = thread_stack_size();
110 
111 	state.pc = read_pc();
112 	state.fp = read_fp();
113 
114 	while (unwind_stack_arm64(&state, true /*kernel stack*/,
115 				  stack, stack_size)) {
116 		tmp = unw_grow(addr, &size, (n + 1) * sizeof(vaddr_t));
117 		if (!tmp)
118 			goto err;
119 		addr = tmp;
120 		addr[n] = state.pc;
121 		n++;
122 	}
123 
124 	if (addr) {
125 		tmp = unw_grow(addr, &size, (n + 1) * sizeof(vaddr_t));
126 		if (!tmp)
127 			goto err;
128 		addr = tmp;
129 		addr[n] = 0;
130 	}
131 
132 	return addr;
133 err:
134 	EMSG("Out of memory");
135 	free(addr);
136 	return NULL;
137 }
138