blob: 27262bd5b961c466139a7ffc26808b949483d20a [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;
David Srbeckye62f4c42018-03-16 18:44:04 +000064 if (resolve_names_) {
65 frame->map_name = info->name;
66 }
Christopher Ferrise762f1f2018-02-06 14:51:48 -080067 frame->rel_pc = dex_pc - info->start;
68 } else {
69 frame->rel_pc = dex_pc;
70 return;
71 }
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080072
Christopher Ferrise4b3a6a2018-02-20 13:58:40 -080073 if (!resolve_names_) {
74 return;
75 }
76
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080077#if !defined(NO_LIBDEXFILE_SUPPORT)
Christopher Ferris7747b602018-01-31 19:05:19 -080078 if (dex_files_ == nullptr) {
79 return;
80 }
81
Christopher Ferris7747b602018-01-31 19:05:19 -080082 dex_files_->GetMethodInformation(maps_, info, dex_pc, &frame->function_name,
David Srbeckyf9006ec2018-02-01 14:49:14 +000083 &frame->function_offset);
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080084#endif
85}
86
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -080087void Unwinder::FillInFrame(MapInfo* map_info, Elf* elf, uint64_t rel_pc, uint64_t func_pc,
88 uint64_t pc_adjustment) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070089 size_t frame_num = frames_.size();
90 frames_.resize(frame_num + 1);
91 FrameData* frame = &frames_.at(frame_num);
92 frame->num = frame_num;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070093 frame->sp = regs_->sp();
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -080094 frame->rel_pc = rel_pc - pc_adjustment;
95 frame->pc = regs_->pc() - pc_adjustment;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070096
97 if (map_info == nullptr) {
98 return;
99 }
100
David Srbeckye62f4c42018-03-16 18:44:04 +0000101 if (resolve_names_) {
102 frame->map_name = map_info->name;
103 }
Christopher Ferrisc5a3baa2017-10-17 18:42:03 -0700104 frame->map_offset = map_info->offset;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700105 frame->map_start = map_info->start;
106 frame->map_end = map_info->end;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700107 frame->map_flags = map_info->flags;
108 frame->map_load_bias = elf->GetLoadBias();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700109
Christopher Ferrise4b3a6a2018-02-20 13:58:40 -0800110 if (!resolve_names_ ||
111 !elf->GetFunctionName(func_pc, &frame->function_name, &frame->function_offset)) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700112 frame->function_name = "";
113 frame->function_offset = 0;
114 }
115}
116
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700117static bool ShouldStop(const std::vector<std::string>* map_suffixes_to_ignore,
118 std::string& map_name) {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700119 if (map_suffixes_to_ignore == nullptr) {
120 return false;
121 }
122 auto pos = map_name.find_last_of('.');
123 if (pos == std::string::npos) {
124 return false;
125 }
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700126
127 return std::find(map_suffixes_to_ignore->begin(), map_suffixes_to_ignore->end(),
128 map_name.substr(pos + 1)) != map_suffixes_to_ignore->end();
Christopher Ferrise69f4702017-10-19 16:08:58 -0700129}
130
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700131void Unwinder::Unwind(const std::vector<std::string>* initial_map_names_to_skip,
132 const std::vector<std::string>* map_suffixes_to_ignore) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700133 frames_.clear();
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800134 last_error_.code = ERROR_NONE;
135 last_error_.address = 0;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700136
137 bool return_address_attempt = false;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700138 bool adjust_pc = false;
Christopher Ferris150db122017-12-20 18:49:01 -0800139 std::unique_ptr<JitDebug> jit_debug;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700140 for (; frames_.size() < max_frames_;) {
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700141 uint64_t cur_pc = regs_->pc();
142 uint64_t cur_sp = regs_->sp();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700143
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700144 MapInfo* map_info = maps_->Find(regs_->pc());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700145 uint64_t rel_pc;
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800146 uint64_t pc_adjustment = 0;
147 uint64_t step_pc;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700148 Elf* elf;
149 if (map_info == nullptr) {
150 rel_pc = regs_->pc();
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800151 step_pc = rel_pc;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800152 last_error_.code = ERROR_INVALID_MAP;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700153 } else {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700154 if (ShouldStop(map_suffixes_to_ignore, map_info->name)) {
155 break;
156 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700157 elf = map_info->GetElf(process_memory_, true);
158 rel_pc = elf->GetRelPc(regs_->pc(), map_info);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800159 if (adjust_pc) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800160 pc_adjustment = regs_->GetPcAdjustment(rel_pc, elf);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800161 } else {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800162 pc_adjustment = 0;
Christopher Ferris150db122017-12-20 18:49:01 -0800163 }
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800164 step_pc = rel_pc - pc_adjustment;
Christopher Ferris150db122017-12-20 18:49:01 -0800165
166 // If the pc is in an invalid elf file, try and get an Elf object
167 // using the jit debug information.
168 if (!elf->valid() && jit_debug_ != nullptr) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800169 uint64_t adjusted_jit_pc = regs_->pc() - pc_adjustment;
Christopher Ferris150db122017-12-20 18:49:01 -0800170 Elf* jit_elf = jit_debug_->GetElf(maps_, adjusted_jit_pc);
171 if (jit_elf != nullptr) {
172 // The jit debug information requires a non relative adjusted pc.
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800173 step_pc = adjusted_jit_pc;
Christopher Ferris150db122017-12-20 18:49:01 -0800174 elf = jit_elf;
175 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800176 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700177 }
178
179 if (map_info == nullptr || initial_map_names_to_skip == nullptr ||
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700180 std::find(initial_map_names_to_skip->begin(), initial_map_names_to_skip->end(),
181 basename(map_info->name.c_str())) == initial_map_names_to_skip->end()) {
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800182 if (regs_->dex_pc() != 0) {
183 // Add a frame to represent the dex file.
184 FillInDexFrame();
Christopher Ferrisa8c39732018-02-12 08:46:19 -0800185 // Clear the dex pc so that we don't repeat this frame later.
186 regs_->set_dex_pc(0);
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800187 }
188
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800189 FillInFrame(map_info, elf, rel_pc, step_pc, pc_adjustment);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800190
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700191 // Once a frame is added, stop skipping frames.
192 initial_map_names_to_skip = nullptr;
193 }
194 adjust_pc = true;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700195
196 bool stepped;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700197 bool in_device_map = false;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700198 if (map_info == nullptr) {
199 stepped = false;
200 } else {
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700201 if (map_info->flags & MAPS_FLAGS_DEVICE_MAP) {
202 // Do not stop here, fall through in case we are
203 // in the speculative unwind path and need to remove
204 // some of the speculative frames.
205 stepped = false;
206 in_device_map = true;
207 } else {
208 MapInfo* sp_info = maps_->Find(regs_->sp());
209 if (sp_info != nullptr && sp_info->flags & MAPS_FLAGS_DEVICE_MAP) {
210 // Do not stop here, fall through in case we are
211 // in the speculative unwind path and need to remove
212 // some of the speculative frames.
213 stepped = false;
214 in_device_map = true;
215 } else {
216 bool finished;
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800217 stepped = elf->Step(rel_pc, step_pc, map_info->elf_offset, regs_, process_memory_.get(),
218 &finished);
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800219 elf->GetLastError(&last_error_);
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700220 if (stepped && finished) {
221 break;
222 }
223 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700224 }
225 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700226
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700227 if (!stepped) {
228 if (return_address_attempt) {
229 // Remove the speculative frame.
230 frames_.pop_back();
231 break;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700232 } else if (in_device_map) {
233 // Do not attempt any other unwinding, pc or sp is in a device
234 // map.
235 break;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700236 } else {
237 // Steping didn't work, try this secondary method.
238 if (!regs_->SetPcFromReturnAddress(process_memory_.get())) {
239 break;
240 }
241 return_address_attempt = true;
242 }
243 } else {
244 return_address_attempt = false;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800245 if (max_frames_ == frames_.size()) {
246 last_error_.code = ERROR_MAX_FRAMES_EXCEEDED;
247 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700248 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700249
250 // If the pc and sp didn't change, then consider everything stopped.
251 if (cur_pc == regs_->pc() && cur_sp == regs_->sp()) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800252 last_error_.code = ERROR_REPEATED_FRAME;
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700253 break;
254 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700255 }
256}
257
258std::string Unwinder::FormatFrame(size_t frame_num) {
259 if (frame_num >= frames_.size()) {
260 return "";
261 }
Christopher Ferris150db122017-12-20 18:49:01 -0800262 return FormatFrame(frames_[frame_num], regs_->Is32Bit());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700263}
264
Christopher Ferris150db122017-12-20 18:49:01 -0800265std::string Unwinder::FormatFrame(const FrameData& frame, bool is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700266 std::string data;
267
Christopher Ferris150db122017-12-20 18:49:01 -0800268 if (is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700269 data += android::base::StringPrintf(" #%02zu pc %08" PRIx64, frame.num, frame.rel_pc);
270 } else {
271 data += android::base::StringPrintf(" #%02zu pc %016" PRIx64, frame.num, frame.rel_pc);
272 }
273
274 if (frame.map_offset != 0) {
275 data += android::base::StringPrintf(" (offset 0x%" PRIx64 ")", frame.map_offset);
276 }
277
278 if (frame.map_start == frame.map_end) {
279 // No valid map associated with this frame.
280 data += " <unknown>";
281 } else if (!frame.map_name.empty()) {
282 data += " " + frame.map_name;
283 } else {
284 data += android::base::StringPrintf(" <anonymous:%" PRIx64 ">", frame.map_start);
285 }
286 if (!frame.function_name.empty()) {
287 data += " (" + frame.function_name;
288 if (frame.function_offset != 0) {
289 data += android::base::StringPrintf("+%" PRId64, frame.function_offset);
290 }
291 data += ')';
292 }
293 return data;
294}
295
Christopher Ferris150db122017-12-20 18:49:01 -0800296void Unwinder::SetJitDebug(JitDebug* jit_debug, ArchEnum arch) {
297 jit_debug->SetArch(arch);
298 jit_debug_ = jit_debug;
299}
300
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800301#if !defined(NO_LIBDEXFILE_SUPPORT)
302void Unwinder::SetDexFiles(DexFiles* dex_files, ArchEnum arch) {
303 dex_files->SetArch(arch);
304 dex_files_ = dex_files;
305}
306#endif
307
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700308} // namespace unwindstack