blob: b0a1c0c0bb0f5c15893934da23bfef0ea7657e58 [file] [log] [blame]
Christopher Ferrisb9de87f2017-09-20 13:37:24 -07001/*
2 * Copyright (C) 2017 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Christopher Ferrisf6f691b2017-09-25 19:23:07 -070017#define _GNU_SOURCE 1
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070018#include <elf.h>
19#include <inttypes.h>
20#include <stdint.h>
Christopher Ferrisf6f691b2017-09-25 19:23:07 -070021#include <string.h>
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070022#include <sys/types.h>
23#include <unistd.h>
24
Christopher Ferris1cb84ce2017-10-24 15:36:00 -070025#include <algorithm>
26
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070027#include <android-base/stringprintf.h>
28
29#include <unwindstack/Elf.h>
Christopher Ferris150db122017-12-20 18:49:01 -080030#include <unwindstack/JitDebug.h>
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070031#include <unwindstack/MapInfo.h>
32#include <unwindstack/Unwinder.h>
33
34namespace unwindstack {
35
Christopher Ferris150db122017-12-20 18:49:01 -080036void Unwinder::FillInFrame(MapInfo* map_info, Elf* elf, uint64_t adjusted_rel_pc, uint64_t func_pc) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070037 size_t frame_num = frames_.size();
38 frames_.resize(frame_num + 1);
39 FrameData* frame = &frames_.at(frame_num);
40 frame->num = frame_num;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070041 frame->sp = regs_->sp();
Christopher Ferrisc3d79f72017-11-28 19:14:54 -080042 frame->rel_pc = adjusted_rel_pc;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070043
44 if (map_info == nullptr) {
Christopher Ferrisc3d79f72017-11-28 19:14:54 -080045 frame->pc = regs_->pc();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070046 return;
47 }
48
Christopher Ferrisc3d79f72017-11-28 19:14:54 -080049 frame->pc = map_info->start + adjusted_rel_pc;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070050 frame->map_name = map_info->name;
Christopher Ferrisc5a3baa2017-10-17 18:42:03 -070051 frame->map_offset = map_info->offset;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070052 frame->map_start = map_info->start;
53 frame->map_end = map_info->end;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -070054 frame->map_flags = map_info->flags;
55 frame->map_load_bias = elf->GetLoadBias();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070056
Christopher Ferris150db122017-12-20 18:49:01 -080057 if (!elf->GetFunctionName(func_pc, &frame->function_name, &frame->function_offset)) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070058 frame->function_name = "";
59 frame->function_offset = 0;
60 }
61}
62
Christopher Ferris1cb84ce2017-10-24 15:36:00 -070063static bool ShouldStop(const std::vector<std::string>* map_suffixes_to_ignore,
64 std::string& map_name) {
Christopher Ferrise69f4702017-10-19 16:08:58 -070065 if (map_suffixes_to_ignore == nullptr) {
66 return false;
67 }
68 auto pos = map_name.find_last_of('.');
69 if (pos == std::string::npos) {
70 return false;
71 }
Christopher Ferris1cb84ce2017-10-24 15:36:00 -070072
73 return std::find(map_suffixes_to_ignore->begin(), map_suffixes_to_ignore->end(),
74 map_name.substr(pos + 1)) != map_suffixes_to_ignore->end();
Christopher Ferrise69f4702017-10-19 16:08:58 -070075}
76
Christopher Ferris1cb84ce2017-10-24 15:36:00 -070077void Unwinder::Unwind(const std::vector<std::string>* initial_map_names_to_skip,
78 const std::vector<std::string>* map_suffixes_to_ignore) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070079 frames_.clear();
80
81 bool return_address_attempt = false;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -070082 bool adjust_pc = false;
Christopher Ferris150db122017-12-20 18:49:01 -080083 std::unique_ptr<JitDebug> jit_debug;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070084 for (; frames_.size() < max_frames_;) {
Christopher Ferrisfda7edd2017-10-31 16:10:42 -070085 uint64_t cur_pc = regs_->pc();
86 uint64_t cur_sp = regs_->sp();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070087
Christopher Ferrisfda7edd2017-10-31 16:10:42 -070088 MapInfo* map_info = maps_->Find(regs_->pc());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070089 uint64_t rel_pc;
Christopher Ferris150db122017-12-20 18:49:01 -080090 uint64_t adjusted_pc;
Christopher Ferrisc3d79f72017-11-28 19:14:54 -080091 uint64_t adjusted_rel_pc;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -070092 Elf* elf;
93 if (map_info == nullptr) {
94 rel_pc = regs_->pc();
Christopher Ferrisc3d79f72017-11-28 19:14:54 -080095 adjusted_rel_pc = rel_pc;
Christopher Ferris150db122017-12-20 18:49:01 -080096 adjusted_pc = rel_pc;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -070097 } else {
Christopher Ferrise69f4702017-10-19 16:08:58 -070098 if (ShouldStop(map_suffixes_to_ignore, map_info->name)) {
99 break;
100 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700101 elf = map_info->GetElf(process_memory_, true);
102 rel_pc = elf->GetRelPc(regs_->pc(), map_info);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800103 if (adjust_pc) {
Christopher Ferris150db122017-12-20 18:49:01 -0800104 adjusted_pc = regs_->GetAdjustedPc(rel_pc, elf);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800105 } else {
Christopher Ferris150db122017-12-20 18:49:01 -0800106 adjusted_pc = rel_pc;
107 }
108 adjusted_rel_pc = adjusted_pc;
109
110 // If the pc is in an invalid elf file, try and get an Elf object
111 // using the jit debug information.
112 if (!elf->valid() && jit_debug_ != nullptr) {
113 uint64_t adjusted_jit_pc = regs_->pc() - (rel_pc - adjusted_pc);
114 Elf* jit_elf = jit_debug_->GetElf(maps_, adjusted_jit_pc);
115 if (jit_elf != nullptr) {
116 // The jit debug information requires a non relative adjusted pc.
117 adjusted_pc = adjusted_jit_pc;
118 adjusted_rel_pc = adjusted_pc - map_info->start;
119 elf = jit_elf;
120 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800121 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700122 }
123
124 if (map_info == nullptr || initial_map_names_to_skip == nullptr ||
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700125 std::find(initial_map_names_to_skip->begin(), initial_map_names_to_skip->end(),
126 basename(map_info->name.c_str())) == initial_map_names_to_skip->end()) {
Christopher Ferris150db122017-12-20 18:49:01 -0800127 FillInFrame(map_info, elf, adjusted_rel_pc, adjusted_pc);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800128
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700129 // Once a frame is added, stop skipping frames.
130 initial_map_names_to_skip = nullptr;
131 }
132 adjust_pc = true;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700133
134 bool stepped;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700135 bool in_device_map = false;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700136 if (map_info == nullptr) {
137 stepped = false;
138 } else {
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700139 if (map_info->flags & MAPS_FLAGS_DEVICE_MAP) {
140 // Do not stop here, fall through in case we are
141 // in the speculative unwind path and need to remove
142 // some of the speculative frames.
143 stepped = false;
144 in_device_map = true;
145 } else {
146 MapInfo* sp_info = maps_->Find(regs_->sp());
147 if (sp_info != nullptr && sp_info->flags & MAPS_FLAGS_DEVICE_MAP) {
148 // Do not stop here, fall through in case we are
149 // in the speculative unwind path and need to remove
150 // some of the speculative frames.
151 stepped = false;
152 in_device_map = true;
153 } else {
154 bool finished;
Christopher Ferris150db122017-12-20 18:49:01 -0800155 stepped = elf->Step(rel_pc, adjusted_pc, map_info->elf_offset, regs_,
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800156 process_memory_.get(), &finished);
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700157 if (stepped && finished) {
158 break;
159 }
160 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700161 }
162 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700163
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700164 if (!stepped) {
165 if (return_address_attempt) {
166 // Remove the speculative frame.
167 frames_.pop_back();
168 break;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700169 } else if (in_device_map) {
170 // Do not attempt any other unwinding, pc or sp is in a device
171 // map.
172 break;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700173 } else {
174 // Steping didn't work, try this secondary method.
175 if (!regs_->SetPcFromReturnAddress(process_memory_.get())) {
176 break;
177 }
178 return_address_attempt = true;
179 }
180 } else {
181 return_address_attempt = false;
182 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700183
184 // If the pc and sp didn't change, then consider everything stopped.
185 if (cur_pc == regs_->pc() && cur_sp == regs_->sp()) {
186 break;
187 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700188 }
189}
190
191std::string Unwinder::FormatFrame(size_t frame_num) {
192 if (frame_num >= frames_.size()) {
193 return "";
194 }
Christopher Ferris150db122017-12-20 18:49:01 -0800195 return FormatFrame(frames_[frame_num], regs_->Is32Bit());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700196}
197
Christopher Ferris150db122017-12-20 18:49:01 -0800198std::string Unwinder::FormatFrame(const FrameData& frame, bool is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700199 std::string data;
200
Christopher Ferris150db122017-12-20 18:49:01 -0800201 if (is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700202 data += android::base::StringPrintf(" #%02zu pc %08" PRIx64, frame.num, frame.rel_pc);
203 } else {
204 data += android::base::StringPrintf(" #%02zu pc %016" PRIx64, frame.num, frame.rel_pc);
205 }
206
207 if (frame.map_offset != 0) {
208 data += android::base::StringPrintf(" (offset 0x%" PRIx64 ")", frame.map_offset);
209 }
210
211 if (frame.map_start == frame.map_end) {
212 // No valid map associated with this frame.
213 data += " <unknown>";
214 } else if (!frame.map_name.empty()) {
215 data += " " + frame.map_name;
216 } else {
217 data += android::base::StringPrintf(" <anonymous:%" PRIx64 ">", frame.map_start);
218 }
219 if (!frame.function_name.empty()) {
220 data += " (" + frame.function_name;
221 if (frame.function_offset != 0) {
222 data += android::base::StringPrintf("+%" PRId64, frame.function_offset);
223 }
224 data += ')';
225 }
226 return data;
227}
228
Christopher Ferris150db122017-12-20 18:49:01 -0800229void Unwinder::SetJitDebug(JitDebug* jit_debug, ArchEnum arch) {
230 jit_debug->SetArch(arch);
231 jit_debug_ = jit_debug;
232}
233
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700234} // namespace unwindstack