blob: 7da69944183ec8163270a0c982d225c5a3fae5d8 [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
Christopher Ferrise4b3a6a2018-02-20 13:58:40 -080071 if (!resolve_names_) {
72 return;
73 }
74
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080075#if !defined(NO_LIBDEXFILE_SUPPORT)
Christopher Ferris7747b602018-01-31 19:05:19 -080076 if (dex_files_ == nullptr) {
77 return;
78 }
79
80 // dex_files_->GetMethodInformation(dex_pc - dex_offset, dex_offset, info, &frame->function_name,
81 dex_files_->GetMethodInformation(maps_, info, dex_pc, &frame->function_name,
David Srbeckyf9006ec2018-02-01 14:49:14 +000082 &frame->function_offset);
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080083#endif
84}
85
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -080086void Unwinder::FillInFrame(MapInfo* map_info, Elf* elf, uint64_t rel_pc, uint64_t func_pc,
87 uint64_t pc_adjustment) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070088 size_t frame_num = frames_.size();
89 frames_.resize(frame_num + 1);
90 FrameData* frame = &frames_.at(frame_num);
91 frame->num = frame_num;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070092 frame->sp = regs_->sp();
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -080093 frame->rel_pc = rel_pc - pc_adjustment;
94 frame->pc = regs_->pc() - pc_adjustment;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070095
96 if (map_info == nullptr) {
97 return;
98 }
99
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700100 frame->map_name = map_info->name;
Christopher Ferrisc5a3baa2017-10-17 18:42:03 -0700101 frame->map_offset = map_info->offset;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700102 frame->map_start = map_info->start;
103 frame->map_end = map_info->end;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700104 frame->map_flags = map_info->flags;
105 frame->map_load_bias = elf->GetLoadBias();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700106
Christopher Ferrise4b3a6a2018-02-20 13:58:40 -0800107 if (!resolve_names_ ||
108 !elf->GetFunctionName(func_pc, &frame->function_name, &frame->function_offset)) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700109 frame->function_name = "";
110 frame->function_offset = 0;
111 }
112}
113
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700114static bool ShouldStop(const std::vector<std::string>* map_suffixes_to_ignore,
115 std::string& map_name) {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700116 if (map_suffixes_to_ignore == nullptr) {
117 return false;
118 }
119 auto pos = map_name.find_last_of('.');
120 if (pos == std::string::npos) {
121 return false;
122 }
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700123
124 return std::find(map_suffixes_to_ignore->begin(), map_suffixes_to_ignore->end(),
125 map_name.substr(pos + 1)) != map_suffixes_to_ignore->end();
Christopher Ferrise69f4702017-10-19 16:08:58 -0700126}
127
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700128void Unwinder::Unwind(const std::vector<std::string>* initial_map_names_to_skip,
129 const std::vector<std::string>* map_suffixes_to_ignore) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700130 frames_.clear();
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800131 last_error_.code = ERROR_NONE;
132 last_error_.address = 0;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700133
134 bool return_address_attempt = false;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700135 bool adjust_pc = false;
Christopher Ferris150db122017-12-20 18:49:01 -0800136 std::unique_ptr<JitDebug> jit_debug;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700137 for (; frames_.size() < max_frames_;) {
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700138 uint64_t cur_pc = regs_->pc();
139 uint64_t cur_sp = regs_->sp();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700140
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700141 MapInfo* map_info = maps_->Find(regs_->pc());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700142 uint64_t rel_pc;
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800143 uint64_t pc_adjustment = 0;
144 uint64_t step_pc;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700145 Elf* elf;
146 if (map_info == nullptr) {
147 rel_pc = regs_->pc();
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800148 step_pc = rel_pc;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800149 last_error_.code = ERROR_INVALID_MAP;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700150 } else {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700151 if (ShouldStop(map_suffixes_to_ignore, map_info->name)) {
152 break;
153 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700154 elf = map_info->GetElf(process_memory_, true);
155 rel_pc = elf->GetRelPc(regs_->pc(), map_info);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800156 if (adjust_pc) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800157 pc_adjustment = regs_->GetPcAdjustment(rel_pc, elf);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800158 } else {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800159 pc_adjustment = 0;
Christopher Ferris150db122017-12-20 18:49:01 -0800160 }
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800161 step_pc = rel_pc - pc_adjustment;
Christopher Ferris150db122017-12-20 18:49:01 -0800162
163 // If the pc is in an invalid elf file, try and get an Elf object
164 // using the jit debug information.
165 if (!elf->valid() && jit_debug_ != nullptr) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800166 uint64_t adjusted_jit_pc = regs_->pc() - pc_adjustment;
Christopher Ferris150db122017-12-20 18:49:01 -0800167 Elf* jit_elf = jit_debug_->GetElf(maps_, adjusted_jit_pc);
168 if (jit_elf != nullptr) {
169 // The jit debug information requires a non relative adjusted pc.
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800170 step_pc = adjusted_jit_pc;
Christopher Ferris150db122017-12-20 18:49:01 -0800171 elf = jit_elf;
172 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800173 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700174 }
175
176 if (map_info == nullptr || initial_map_names_to_skip == nullptr ||
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700177 std::find(initial_map_names_to_skip->begin(), initial_map_names_to_skip->end(),
178 basename(map_info->name.c_str())) == initial_map_names_to_skip->end()) {
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800179 if (regs_->dex_pc() != 0) {
180 // Add a frame to represent the dex file.
181 FillInDexFrame();
Christopher Ferrisa8c39732018-02-12 08:46:19 -0800182 // Clear the dex pc so that we don't repeat this frame later.
183 regs_->set_dex_pc(0);
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800184 }
185
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800186 FillInFrame(map_info, elf, rel_pc, step_pc, pc_adjustment);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800187
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700188 // Once a frame is added, stop skipping frames.
189 initial_map_names_to_skip = nullptr;
190 }
191 adjust_pc = true;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700192
193 bool stepped;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700194 bool in_device_map = false;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700195 if (map_info == nullptr) {
196 stepped = false;
197 } else {
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700198 if (map_info->flags & MAPS_FLAGS_DEVICE_MAP) {
199 // Do not stop here, fall through in case we are
200 // in the speculative unwind path and need to remove
201 // some of the speculative frames.
202 stepped = false;
203 in_device_map = true;
204 } else {
205 MapInfo* sp_info = maps_->Find(regs_->sp());
206 if (sp_info != nullptr && sp_info->flags & MAPS_FLAGS_DEVICE_MAP) {
207 // Do not stop here, fall through in case we are
208 // in the speculative unwind path and need to remove
209 // some of the speculative frames.
210 stepped = false;
211 in_device_map = true;
212 } else {
213 bool finished;
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800214 stepped = elf->Step(rel_pc, step_pc, map_info->elf_offset, regs_, process_memory_.get(),
215 &finished);
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800216 elf->GetLastError(&last_error_);
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700217 if (stepped && finished) {
218 break;
219 }
220 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700221 }
222 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700223
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700224 if (!stepped) {
225 if (return_address_attempt) {
226 // Remove the speculative frame.
227 frames_.pop_back();
228 break;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700229 } else if (in_device_map) {
230 // Do not attempt any other unwinding, pc or sp is in a device
231 // map.
232 break;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700233 } else {
234 // Steping didn't work, try this secondary method.
235 if (!regs_->SetPcFromReturnAddress(process_memory_.get())) {
236 break;
237 }
238 return_address_attempt = true;
239 }
240 } else {
241 return_address_attempt = false;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800242 if (max_frames_ == frames_.size()) {
243 last_error_.code = ERROR_MAX_FRAMES_EXCEEDED;
244 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700245 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700246
247 // If the pc and sp didn't change, then consider everything stopped.
248 if (cur_pc == regs_->pc() && cur_sp == regs_->sp()) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800249 last_error_.code = ERROR_REPEATED_FRAME;
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700250 break;
251 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700252 }
253}
254
255std::string Unwinder::FormatFrame(size_t frame_num) {
256 if (frame_num >= frames_.size()) {
257 return "";
258 }
Christopher Ferris150db122017-12-20 18:49:01 -0800259 return FormatFrame(frames_[frame_num], regs_->Is32Bit());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700260}
261
Christopher Ferris150db122017-12-20 18:49:01 -0800262std::string Unwinder::FormatFrame(const FrameData& frame, bool is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700263 std::string data;
264
Christopher Ferris150db122017-12-20 18:49:01 -0800265 if (is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700266 data += android::base::StringPrintf(" #%02zu pc %08" PRIx64, frame.num, frame.rel_pc);
267 } else {
268 data += android::base::StringPrintf(" #%02zu pc %016" PRIx64, frame.num, frame.rel_pc);
269 }
270
271 if (frame.map_offset != 0) {
272 data += android::base::StringPrintf(" (offset 0x%" PRIx64 ")", frame.map_offset);
273 }
274
275 if (frame.map_start == frame.map_end) {
276 // No valid map associated with this frame.
277 data += " <unknown>";
278 } else if (!frame.map_name.empty()) {
279 data += " " + frame.map_name;
280 } else {
281 data += android::base::StringPrintf(" <anonymous:%" PRIx64 ">", frame.map_start);
282 }
283 if (!frame.function_name.empty()) {
284 data += " (" + frame.function_name;
285 if (frame.function_offset != 0) {
286 data += android::base::StringPrintf("+%" PRId64, frame.function_offset);
287 }
288 data += ')';
289 }
290 return data;
291}
292
Christopher Ferris150db122017-12-20 18:49:01 -0800293void Unwinder::SetJitDebug(JitDebug* jit_debug, ArchEnum arch) {
294 jit_debug->SetArch(arch);
295 jit_debug_ = jit_debug;
296}
297
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800298#if !defined(NO_LIBDEXFILE_SUPPORT)
299void Unwinder::SetDexFiles(DexFiles* dex_files, ArchEnum arch) {
300 dex_files->SetArch(arch);
301 dex_files_ = dex_files;
302}
303#endif
304
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700305} // namespace unwindstack