blob: d52a0bf990939b9d2f7adfb0fc61fd640b1e3c47 [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
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080034#if !defined(NO_LIBDEXFILE_SUPPORT)
35#include <unwindstack/DexFiles.h>
36#endif
37
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070038namespace unwindstack {
39
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080040// Inject extra 'virtual' frame that represents the dex pc data.
41// The dex pc is a magic register defined in the Mterp interpreter,
42// and thus it will be restored/observed in the frame after it.
43// Adding the dex frame first here will create something like:
44// #7 pc 0015fa20 core.vdex java.util.Arrays.binarySearch+8
45// #8 pc 006b1ba1 libartd.so ExecuteMterpImpl+14625
46// #9 pc 0039a1ef libartd.so art::interpreter::Execute+719
47void Unwinder::FillInDexFrame() {
48 size_t frame_num = frames_.size();
49 frames_.resize(frame_num + 1);
50 FrameData* frame = &frames_.at(frame_num);
Christopher Ferris559c7f22018-02-12 20:18:03 -080051 frame->num = frame_num;
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080052
53 uint64_t dex_pc = regs_->dex_pc();
54 frame->pc = dex_pc;
55 frame->sp = regs_->sp();
56
Christopher Ferris7747b602018-01-31 19:05:19 -080057 MapInfo* info = maps_->Find(dex_pc);
Christopher Ferrise762f1f2018-02-06 14:51:48 -080058 if (info != nullptr) {
59 frame->map_start = info->start;
60 frame->map_end = info->end;
61 frame->map_offset = info->offset;
62 frame->map_load_bias = info->load_bias;
63 frame->map_flags = info->flags;
64 frame->map_name = info->name;
65 frame->rel_pc = dex_pc - info->start;
66 } else {
67 frame->rel_pc = dex_pc;
68 return;
69 }
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080070
71#if !defined(NO_LIBDEXFILE_SUPPORT)
Christopher Ferris7747b602018-01-31 19:05:19 -080072 if (dex_files_ == nullptr) {
73 return;
74 }
75
76 // dex_files_->GetMethodInformation(dex_pc - dex_offset, dex_offset, info, &frame->function_name,
77 dex_files_->GetMethodInformation(maps_, info, dex_pc, &frame->function_name,
David Srbeckyf9006ec2018-02-01 14:49:14 +000078 &frame->function_offset);
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080079#endif
80}
81
Christopher Ferris150db122017-12-20 18:49:01 -080082void Unwinder::FillInFrame(MapInfo* map_info, Elf* elf, uint64_t adjusted_rel_pc, uint64_t func_pc) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070083 size_t frame_num = frames_.size();
84 frames_.resize(frame_num + 1);
85 FrameData* frame = &frames_.at(frame_num);
86 frame->num = frame_num;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070087 frame->sp = regs_->sp();
Christopher Ferrisc3d79f72017-11-28 19:14:54 -080088 frame->rel_pc = adjusted_rel_pc;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070089
90 if (map_info == nullptr) {
Christopher Ferrisc3d79f72017-11-28 19:14:54 -080091 frame->pc = regs_->pc();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070092 return;
93 }
94
Christopher Ferrise4df5f52018-02-12 13:24:18 -080095 frame->pc = map_info->start + adjusted_rel_pc - elf->GetLoadBias() - map_info->elf_offset;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070096 frame->map_name = map_info->name;
Christopher Ferrisc5a3baa2017-10-17 18:42:03 -070097 frame->map_offset = map_info->offset;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070098 frame->map_start = map_info->start;
99 frame->map_end = map_info->end;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700100 frame->map_flags = map_info->flags;
101 frame->map_load_bias = elf->GetLoadBias();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700102
Christopher Ferris150db122017-12-20 18:49:01 -0800103 if (!elf->GetFunctionName(func_pc, &frame->function_name, &frame->function_offset)) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700104 frame->function_name = "";
105 frame->function_offset = 0;
106 }
107}
108
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700109static bool ShouldStop(const std::vector<std::string>* map_suffixes_to_ignore,
110 std::string& map_name) {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700111 if (map_suffixes_to_ignore == nullptr) {
112 return false;
113 }
114 auto pos = map_name.find_last_of('.');
115 if (pos == std::string::npos) {
116 return false;
117 }
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700118
119 return std::find(map_suffixes_to_ignore->begin(), map_suffixes_to_ignore->end(),
120 map_name.substr(pos + 1)) != map_suffixes_to_ignore->end();
Christopher Ferrise69f4702017-10-19 16:08:58 -0700121}
122
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700123void Unwinder::Unwind(const std::vector<std::string>* initial_map_names_to_skip,
124 const std::vector<std::string>* map_suffixes_to_ignore) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700125 frames_.clear();
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800126 last_error_.code = ERROR_NONE;
127 last_error_.address = 0;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700128
129 bool return_address_attempt = false;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700130 bool adjust_pc = false;
Christopher Ferris150db122017-12-20 18:49:01 -0800131 std::unique_ptr<JitDebug> jit_debug;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700132 for (; frames_.size() < max_frames_;) {
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700133 uint64_t cur_pc = regs_->pc();
134 uint64_t cur_sp = regs_->sp();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700135
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700136 MapInfo* map_info = maps_->Find(regs_->pc());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700137 uint64_t rel_pc;
Christopher Ferris150db122017-12-20 18:49:01 -0800138 uint64_t adjusted_pc;
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800139 uint64_t adjusted_rel_pc;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700140 Elf* elf;
141 if (map_info == nullptr) {
142 rel_pc = regs_->pc();
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800143 adjusted_rel_pc = rel_pc;
Christopher Ferris150db122017-12-20 18:49:01 -0800144 adjusted_pc = rel_pc;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800145 last_error_.code = ERROR_INVALID_MAP;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700146 } else {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700147 if (ShouldStop(map_suffixes_to_ignore, map_info->name)) {
148 break;
149 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700150 elf = map_info->GetElf(process_memory_, true);
151 rel_pc = elf->GetRelPc(regs_->pc(), map_info);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800152 if (adjust_pc) {
Christopher Ferris150db122017-12-20 18:49:01 -0800153 adjusted_pc = regs_->GetAdjustedPc(rel_pc, elf);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800154 } else {
Christopher Ferris150db122017-12-20 18:49:01 -0800155 adjusted_pc = rel_pc;
156 }
157 adjusted_rel_pc = adjusted_pc;
158
159 // If the pc is in an invalid elf file, try and get an Elf object
160 // using the jit debug information.
161 if (!elf->valid() && jit_debug_ != nullptr) {
162 uint64_t adjusted_jit_pc = regs_->pc() - (rel_pc - adjusted_pc);
163 Elf* jit_elf = jit_debug_->GetElf(maps_, adjusted_jit_pc);
164 if (jit_elf != nullptr) {
165 // The jit debug information requires a non relative adjusted pc.
166 adjusted_pc = adjusted_jit_pc;
167 adjusted_rel_pc = adjusted_pc - map_info->start;
168 elf = jit_elf;
169 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800170 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700171 }
172
173 if (map_info == nullptr || initial_map_names_to_skip == nullptr ||
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700174 std::find(initial_map_names_to_skip->begin(), initial_map_names_to_skip->end(),
175 basename(map_info->name.c_str())) == initial_map_names_to_skip->end()) {
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800176 if (regs_->dex_pc() != 0) {
177 // Add a frame to represent the dex file.
178 FillInDexFrame();
Christopher Ferrisa8c39732018-02-12 08:46:19 -0800179 // Clear the dex pc so that we don't repeat this frame later.
180 regs_->set_dex_pc(0);
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800181 }
182
Christopher Ferris150db122017-12-20 18:49:01 -0800183 FillInFrame(map_info, elf, adjusted_rel_pc, adjusted_pc);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800184
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700185 // Once a frame is added, stop skipping frames.
186 initial_map_names_to_skip = nullptr;
187 }
188 adjust_pc = true;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700189
190 bool stepped;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700191 bool in_device_map = false;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700192 if (map_info == nullptr) {
193 stepped = false;
194 } else {
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700195 if (map_info->flags & MAPS_FLAGS_DEVICE_MAP) {
196 // Do not stop here, fall through in case we are
197 // in the speculative unwind path and need to remove
198 // some of the speculative frames.
199 stepped = false;
200 in_device_map = true;
201 } else {
202 MapInfo* sp_info = maps_->Find(regs_->sp());
203 if (sp_info != nullptr && sp_info->flags & MAPS_FLAGS_DEVICE_MAP) {
204 // Do not stop here, fall through in case we are
205 // in the speculative unwind path and need to remove
206 // some of the speculative frames.
207 stepped = false;
208 in_device_map = true;
209 } else {
210 bool finished;
Christopher Ferris150db122017-12-20 18:49:01 -0800211 stepped = elf->Step(rel_pc, adjusted_pc, map_info->elf_offset, regs_,
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800212 process_memory_.get(), &finished);
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800213 elf->GetLastError(&last_error_);
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700214 if (stepped && finished) {
215 break;
216 }
217 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700218 }
219 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700220
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700221 if (!stepped) {
222 if (return_address_attempt) {
223 // Remove the speculative frame.
224 frames_.pop_back();
225 break;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700226 } else if (in_device_map) {
227 // Do not attempt any other unwinding, pc or sp is in a device
228 // map.
229 break;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700230 } else {
231 // Steping didn't work, try this secondary method.
232 if (!regs_->SetPcFromReturnAddress(process_memory_.get())) {
233 break;
234 }
235 return_address_attempt = true;
236 }
237 } else {
238 return_address_attempt = false;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800239 if (max_frames_ == frames_.size()) {
240 last_error_.code = ERROR_MAX_FRAMES_EXCEEDED;
241 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700242 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700243
244 // If the pc and sp didn't change, then consider everything stopped.
245 if (cur_pc == regs_->pc() && cur_sp == regs_->sp()) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800246 last_error_.code = ERROR_REPEATED_FRAME;
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700247 break;
248 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700249 }
250}
251
252std::string Unwinder::FormatFrame(size_t frame_num) {
253 if (frame_num >= frames_.size()) {
254 return "";
255 }
Christopher Ferris150db122017-12-20 18:49:01 -0800256 return FormatFrame(frames_[frame_num], regs_->Is32Bit());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700257}
258
Christopher Ferris150db122017-12-20 18:49:01 -0800259std::string Unwinder::FormatFrame(const FrameData& frame, bool is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700260 std::string data;
261
Christopher Ferris150db122017-12-20 18:49:01 -0800262 if (is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700263 data += android::base::StringPrintf(" #%02zu pc %08" PRIx64, frame.num, frame.rel_pc);
264 } else {
265 data += android::base::StringPrintf(" #%02zu pc %016" PRIx64, frame.num, frame.rel_pc);
266 }
267
268 if (frame.map_offset != 0) {
269 data += android::base::StringPrintf(" (offset 0x%" PRIx64 ")", frame.map_offset);
270 }
271
272 if (frame.map_start == frame.map_end) {
273 // No valid map associated with this frame.
274 data += " <unknown>";
275 } else if (!frame.map_name.empty()) {
276 data += " " + frame.map_name;
277 } else {
278 data += android::base::StringPrintf(" <anonymous:%" PRIx64 ">", frame.map_start);
279 }
280 if (!frame.function_name.empty()) {
281 data += " (" + frame.function_name;
282 if (frame.function_offset != 0) {
283 data += android::base::StringPrintf("+%" PRId64, frame.function_offset);
284 }
285 data += ')';
286 }
287 return data;
288}
289
Christopher Ferris150db122017-12-20 18:49:01 -0800290void Unwinder::SetJitDebug(JitDebug* jit_debug, ArchEnum arch) {
291 jit_debug->SetArch(arch);
292 jit_debug_ = jit_debug;
293}
294
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800295#if !defined(NO_LIBDEXFILE_SUPPORT)
296void Unwinder::SetDexFiles(DexFiles* dex_files, ArchEnum arch) {
297 dex_files->SetArch(arch);
298 dex_files_ = dex_files;
299}
300#endif
301
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700302} // namespace unwindstack