blob: 9a6c6dfe23173e8cf6c6c632f088a1ef94b83fad [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>
Yabin Cuid5b22c52018-02-22 17:11:31 -080032#include <unwindstack/Maps.h>
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070033#include <unwindstack/Unwinder.h>
34
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080035#if !defined(NO_LIBDEXFILE_SUPPORT)
36#include <unwindstack/DexFiles.h>
37#endif
38
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070039namespace unwindstack {
40
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080041// Inject extra 'virtual' frame that represents the dex pc data.
42// The dex pc is a magic register defined in the Mterp interpreter,
43// and thus it will be restored/observed in the frame after it.
44// Adding the dex frame first here will create something like:
45// #7 pc 0015fa20 core.vdex java.util.Arrays.binarySearch+8
46// #8 pc 006b1ba1 libartd.so ExecuteMterpImpl+14625
47// #9 pc 0039a1ef libartd.so art::interpreter::Execute+719
48void Unwinder::FillInDexFrame() {
49 size_t frame_num = frames_.size();
50 frames_.resize(frame_num + 1);
51 FrameData* frame = &frames_.at(frame_num);
Christopher Ferris559c7f22018-02-12 20:18:03 -080052 frame->num = frame_num;
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080053
54 uint64_t dex_pc = regs_->dex_pc();
55 frame->pc = dex_pc;
56 frame->sp = regs_->sp();
57
Christopher Ferris7747b602018-01-31 19:05:19 -080058 MapInfo* info = maps_->Find(dex_pc);
Christopher Ferrise762f1f2018-02-06 14:51:48 -080059 if (info != nullptr) {
60 frame->map_start = info->start;
61 frame->map_end = info->end;
62 frame->map_offset = info->offset;
63 frame->map_load_bias = info->load_bias;
64 frame->map_flags = info->flags;
David Srbeckye62f4c42018-03-16 18:44:04 +000065 if (resolve_names_) {
66 frame->map_name = info->name;
67 }
Christopher Ferrise762f1f2018-02-06 14:51:48 -080068 frame->rel_pc = dex_pc - info->start;
69 } else {
70 frame->rel_pc = dex_pc;
71 return;
72 }
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080073
Christopher Ferrise4b3a6a2018-02-20 13:58:40 -080074 if (!resolve_names_) {
75 return;
76 }
77
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080078#if !defined(NO_LIBDEXFILE_SUPPORT)
Christopher Ferris7747b602018-01-31 19:05:19 -080079 if (dex_files_ == nullptr) {
80 return;
81 }
82
Christopher Ferris7747b602018-01-31 19:05:19 -080083 dex_files_->GetMethodInformation(maps_, info, dex_pc, &frame->function_name,
David Srbeckyf9006ec2018-02-01 14:49:14 +000084 &frame->function_offset);
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080085#endif
86}
87
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -080088void Unwinder::FillInFrame(MapInfo* map_info, Elf* elf, uint64_t rel_pc, uint64_t func_pc,
89 uint64_t pc_adjustment) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070090 size_t frame_num = frames_.size();
91 frames_.resize(frame_num + 1);
92 FrameData* frame = &frames_.at(frame_num);
93 frame->num = frame_num;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070094 frame->sp = regs_->sp();
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -080095 frame->rel_pc = rel_pc - pc_adjustment;
96 frame->pc = regs_->pc() - pc_adjustment;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070097
98 if (map_info == nullptr) {
99 return;
100 }
101
David Srbeckye62f4c42018-03-16 18:44:04 +0000102 if (resolve_names_) {
103 frame->map_name = map_info->name;
104 }
Christopher Ferrisc5a3baa2017-10-17 18:42:03 -0700105 frame->map_offset = map_info->offset;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700106 frame->map_start = map_info->start;
107 frame->map_end = map_info->end;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700108 frame->map_flags = map_info->flags;
109 frame->map_load_bias = elf->GetLoadBias();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700110
Christopher Ferrise4b3a6a2018-02-20 13:58:40 -0800111 if (!resolve_names_ ||
112 !elf->GetFunctionName(func_pc, &frame->function_name, &frame->function_offset)) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700113 frame->function_name = "";
114 frame->function_offset = 0;
115 }
116}
117
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700118static bool ShouldStop(const std::vector<std::string>* map_suffixes_to_ignore,
119 std::string& map_name) {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700120 if (map_suffixes_to_ignore == nullptr) {
121 return false;
122 }
123 auto pos = map_name.find_last_of('.');
124 if (pos == std::string::npos) {
125 return false;
126 }
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700127
128 return std::find(map_suffixes_to_ignore->begin(), map_suffixes_to_ignore->end(),
129 map_name.substr(pos + 1)) != map_suffixes_to_ignore->end();
Christopher Ferrise69f4702017-10-19 16:08:58 -0700130}
131
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700132void Unwinder::Unwind(const std::vector<std::string>* initial_map_names_to_skip,
133 const std::vector<std::string>* map_suffixes_to_ignore) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700134 frames_.clear();
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800135 last_error_.code = ERROR_NONE;
136 last_error_.address = 0;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700137
138 bool return_address_attempt = false;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700139 bool adjust_pc = false;
Christopher Ferris150db122017-12-20 18:49:01 -0800140 std::unique_ptr<JitDebug> jit_debug;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700141 for (; frames_.size() < max_frames_;) {
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700142 uint64_t cur_pc = regs_->pc();
143 uint64_t cur_sp = regs_->sp();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700144
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700145 MapInfo* map_info = maps_->Find(regs_->pc());
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800146 uint64_t pc_adjustment = 0;
147 uint64_t step_pc;
Yabin Cuid5b22c52018-02-22 17:11:31 -0800148 uint64_t rel_pc;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700149 Elf* elf;
150 if (map_info == nullptr) {
Yabin Cuid5b22c52018-02-22 17:11:31 -0800151 step_pc = regs_->pc();
152 rel_pc = step_pc;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800153 last_error_.code = ERROR_INVALID_MAP;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700154 } else {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700155 if (ShouldStop(map_suffixes_to_ignore, map_info->name)) {
156 break;
157 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700158 elf = map_info->GetElf(process_memory_, true);
Yabin Cuid5b22c52018-02-22 17:11:31 -0800159 step_pc = regs_->pc();
160 rel_pc = elf->GetRelPc(step_pc, map_info);
161 // Everyone except elf data in gdb jit debug maps uses the relative pc.
162 if (!(map_info->flags & MAPS_FLAGS_JIT_SYMFILE_MAP)) {
163 step_pc = rel_pc;
164 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800165 if (adjust_pc) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800166 pc_adjustment = regs_->GetPcAdjustment(rel_pc, elf);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800167 } else {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800168 pc_adjustment = 0;
Christopher Ferris150db122017-12-20 18:49:01 -0800169 }
Yabin Cuid5b22c52018-02-22 17:11:31 -0800170 step_pc -= pc_adjustment;
Christopher Ferris150db122017-12-20 18:49:01 -0800171
172 // If the pc is in an invalid elf file, try and get an Elf object
173 // using the jit debug information.
174 if (!elf->valid() && jit_debug_ != nullptr) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800175 uint64_t adjusted_jit_pc = regs_->pc() - pc_adjustment;
Christopher Ferris150db122017-12-20 18:49:01 -0800176 Elf* jit_elf = jit_debug_->GetElf(maps_, adjusted_jit_pc);
177 if (jit_elf != nullptr) {
178 // The jit debug information requires a non relative adjusted pc.
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800179 step_pc = adjusted_jit_pc;
Christopher Ferris150db122017-12-20 18:49:01 -0800180 elf = jit_elf;
181 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800182 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700183 }
184
185 if (map_info == nullptr || initial_map_names_to_skip == nullptr ||
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700186 std::find(initial_map_names_to_skip->begin(), initial_map_names_to_skip->end(),
187 basename(map_info->name.c_str())) == initial_map_names_to_skip->end()) {
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800188 if (regs_->dex_pc() != 0) {
189 // Add a frame to represent the dex file.
190 FillInDexFrame();
Christopher Ferrisa8c39732018-02-12 08:46:19 -0800191 // Clear the dex pc so that we don't repeat this frame later.
192 regs_->set_dex_pc(0);
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800193 }
194
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800195 FillInFrame(map_info, elf, rel_pc, step_pc, pc_adjustment);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800196
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700197 // Once a frame is added, stop skipping frames.
198 initial_map_names_to_skip = nullptr;
199 }
200 adjust_pc = true;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700201
202 bool stepped;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700203 bool in_device_map = false;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700204 if (map_info == nullptr) {
205 stepped = false;
206 } else {
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700207 if (map_info->flags & MAPS_FLAGS_DEVICE_MAP) {
208 // Do not stop here, fall through in case we are
209 // in the speculative unwind path and need to remove
210 // some of the speculative frames.
211 stepped = false;
212 in_device_map = true;
213 } else {
214 MapInfo* sp_info = maps_->Find(regs_->sp());
215 if (sp_info != nullptr && sp_info->flags & MAPS_FLAGS_DEVICE_MAP) {
216 // Do not stop here, fall through in case we are
217 // in the speculative unwind path and need to remove
218 // some of the speculative frames.
219 stepped = false;
220 in_device_map = true;
221 } else {
222 bool finished;
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800223 stepped = elf->Step(rel_pc, step_pc, map_info->elf_offset, regs_, process_memory_.get(),
224 &finished);
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800225 elf->GetLastError(&last_error_);
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700226 if (stepped && finished) {
227 break;
228 }
229 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700230 }
231 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700232
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700233 if (!stepped) {
234 if (return_address_attempt) {
235 // Remove the speculative frame.
236 frames_.pop_back();
237 break;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700238 } else if (in_device_map) {
239 // Do not attempt any other unwinding, pc or sp is in a device
240 // map.
241 break;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700242 } else {
243 // Steping didn't work, try this secondary method.
244 if (!regs_->SetPcFromReturnAddress(process_memory_.get())) {
245 break;
246 }
247 return_address_attempt = true;
248 }
249 } else {
250 return_address_attempt = false;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800251 if (max_frames_ == frames_.size()) {
252 last_error_.code = ERROR_MAX_FRAMES_EXCEEDED;
253 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700254 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700255
256 // If the pc and sp didn't change, then consider everything stopped.
257 if (cur_pc == regs_->pc() && cur_sp == regs_->sp()) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800258 last_error_.code = ERROR_REPEATED_FRAME;
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700259 break;
260 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700261 }
262}
263
264std::string Unwinder::FormatFrame(size_t frame_num) {
265 if (frame_num >= frames_.size()) {
266 return "";
267 }
Christopher Ferris150db122017-12-20 18:49:01 -0800268 return FormatFrame(frames_[frame_num], regs_->Is32Bit());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700269}
270
Christopher Ferris150db122017-12-20 18:49:01 -0800271std::string Unwinder::FormatFrame(const FrameData& frame, bool is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700272 std::string data;
273
Christopher Ferris150db122017-12-20 18:49:01 -0800274 if (is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700275 data += android::base::StringPrintf(" #%02zu pc %08" PRIx64, frame.num, frame.rel_pc);
276 } else {
277 data += android::base::StringPrintf(" #%02zu pc %016" PRIx64, frame.num, frame.rel_pc);
278 }
279
280 if (frame.map_offset != 0) {
281 data += android::base::StringPrintf(" (offset 0x%" PRIx64 ")", frame.map_offset);
282 }
283
284 if (frame.map_start == frame.map_end) {
285 // No valid map associated with this frame.
286 data += " <unknown>";
287 } else if (!frame.map_name.empty()) {
288 data += " " + frame.map_name;
289 } else {
290 data += android::base::StringPrintf(" <anonymous:%" PRIx64 ">", frame.map_start);
291 }
292 if (!frame.function_name.empty()) {
293 data += " (" + frame.function_name;
294 if (frame.function_offset != 0) {
295 data += android::base::StringPrintf("+%" PRId64, frame.function_offset);
296 }
297 data += ')';
298 }
299 return data;
300}
301
Christopher Ferris150db122017-12-20 18:49:01 -0800302void Unwinder::SetJitDebug(JitDebug* jit_debug, ArchEnum arch) {
303 jit_debug->SetArch(arch);
304 jit_debug_ = jit_debug;
305}
306
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800307#if !defined(NO_LIBDEXFILE_SUPPORT)
308void Unwinder::SetDexFiles(DexFiles* dex_files, ArchEnum arch) {
309 dex_files->SetArch(arch);
310 dex_files_ = dex_files;
311}
312#endif
313
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700314} // namespace unwindstack