1 /*
2 * Copyright (C) 2012 The Android Open Source Project
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
12 * the documentation and/or other materials provided with the
13 * distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29 #include <cxxabi.h>
30 #include <dlfcn.h>
31 #include <errno.h>
32 #include <inttypes.h>
33 #include <malloc.h>
34 #include <pthread.h>
35 #include <string.h>
36 #include <sys/types.h>
37 #include <unistd.h>
38 #include <unwind.h>
39
40 #include "MapData.h"
41 #include "backtrace.h"
42 #include "debug_log.h"
43
44 #if defined(__LP64__)
45 #define PAD_PTR "016" PRIxPTR
46 #else
47 #define PAD_PTR "08" PRIxPTR
48 #endif
49
50 typedef struct _Unwind_Context __unwind_context;
51
52 static MapData g_map_data;
53 static const MapEntry* g_current_code_map = nullptr;
54
find_current_map(__unwind_context * context,void *)55 static _Unwind_Reason_Code find_current_map(__unwind_context* context, void*) {
56 uintptr_t ip = _Unwind_GetIP(context);
57
58 if (ip == 0) {
59 return _URC_END_OF_STACK;
60 }
61 g_current_code_map = g_map_data.find(ip);
62 return _URC_END_OF_STACK;
63 }
64
backtrace_startup()65 void backtrace_startup() {
66 _Unwind_Backtrace(find_current_map, nullptr);
67 }
68
backtrace_shutdown()69 void backtrace_shutdown() {}
70
71 struct stack_crawl_state_t {
72 uintptr_t* frames;
73 size_t frame_count;
74 size_t cur_frame = 0;
75
stack_crawl_state_tstack_crawl_state_t76 stack_crawl_state_t(uintptr_t* frames, size_t frame_count)
77 : frames(frames), frame_count(frame_count) {}
78 };
79
trace_function(__unwind_context * context,void * arg)80 static _Unwind_Reason_Code trace_function(__unwind_context* context, void* arg) {
81 stack_crawl_state_t* state = static_cast<stack_crawl_state_t*>(arg);
82
83 uintptr_t ip = _Unwind_GetIP(context);
84
85 // `ip` is the address of the instruction *after* the call site in
86 // `context`, so we want to back up by one instruction. This is hard for
87 // every architecture except arm64, so we just make sure we're *inside*
88 // that instruction, not necessarily at the start of it. (If the value
89 // is too low to be valid, we just leave it alone.)
90 if (ip >= 4096) {
91 #if defined(__aarch64__)
92 ip -= 4; // Exactly.
93 #elif defined(__arm__) || defined(__riscv)
94 ip -= 2; // At least.
95 #elif defined(__i386__) || defined(__x86_64__)
96 ip -= 1; // At least.
97 #endif
98 }
99
100 // Do not record the frames that fall in our own shared library.
101 if (g_current_code_map && (ip >= g_current_code_map->start) && ip < g_current_code_map->end) {
102 return _URC_NO_REASON;
103 }
104
105 state->frames[state->cur_frame++] = ip;
106 return (state->cur_frame >= state->frame_count) ? _URC_END_OF_STACK : _URC_NO_REASON;
107 }
108
backtrace_get(uintptr_t * frames,size_t frame_count)109 size_t backtrace_get(uintptr_t* frames, size_t frame_count) {
110 stack_crawl_state_t state(frames, frame_count);
111 _Unwind_Backtrace(trace_function, &state);
112 return state.cur_frame;
113 }
114
backtrace_string(const uintptr_t * frames,size_t frame_count)115 std::string backtrace_string(const uintptr_t* frames, size_t frame_count) {
116 std::string str;
117
118 for (size_t frame_num = 0; frame_num < frame_count; frame_num++) {
119 uintptr_t offset = 0;
120 const char* symbol = nullptr;
121
122 Dl_info info;
123 if (dladdr(reinterpret_cast<void*>(frames[frame_num]), &info) != 0) {
124 offset = reinterpret_cast<uintptr_t>(info.dli_saddr);
125 symbol = info.dli_sname;
126 } else {
127 info.dli_fname = nullptr;
128 }
129
130 uintptr_t rel_pc = offset;
131 const MapEntry* entry = g_map_data.find(frames[frame_num], &rel_pc);
132
133 const char* soname = (entry != nullptr) ? entry->name.c_str() : info.dli_fname;
134 if (soname == nullptr) {
135 soname = "<unknown>";
136 }
137
138 char offset_buf[128];
139 if (entry != nullptr && entry->elf_start_offset != 0) {
140 snprintf(offset_buf, sizeof(offset_buf), " (offset 0x%" PRIxPTR ")", entry->elf_start_offset);
141 } else {
142 offset_buf[0] = '\0';
143 }
144
145 char buf[1024];
146 if (symbol != nullptr) {
147 char* demangled_name = abi::__cxa_demangle(symbol, nullptr, nullptr, nullptr);
148 const char* name;
149 if (demangled_name != nullptr) {
150 name = demangled_name;
151 } else {
152 name = symbol;
153 }
154 async_safe_format_buffer(buf, sizeof(buf),
155 " #%02zd pc %" PAD_PTR " %s%s (%s+%" PRIuPTR ")\n",
156 frame_num, rel_pc, soname, offset_buf, name,
157 frames[frame_num] - offset);
158 free(demangled_name);
159 } else {
160 async_safe_format_buffer(buf, sizeof(buf), " #%02zd pc %" PAD_PTR " %s%s\n",
161 frame_num, rel_pc, soname, offset_buf);
162 }
163 str += buf;
164 }
165
166 return str;
167 }
168
backtrace_log(const uintptr_t * frames,size_t frame_count)169 void backtrace_log(const uintptr_t* frames, size_t frame_count) {
170 error_log_string(backtrace_string(frames, frame_count).c_str());
171 }
172