blob: 37323dc16053d4c288c325ec44e3c87645c006d4 [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>
Christopher Ferris98aaf4c2019-05-03 11:13:17 -070028#include <android-base/strings.h>
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070029
Christopher Ferriseb0772f2018-12-05 15:57:02 -080030#include <demangle.h>
31
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070032#include <unwindstack/Elf.h>
Christopher Ferris150db122017-12-20 18:49:01 -080033#include <unwindstack/JitDebug.h>
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070034#include <unwindstack/MapInfo.h>
Yabin Cuid5b22c52018-02-22 17:11:31 -080035#include <unwindstack/Maps.h>
Christopher Ferriseb0772f2018-12-05 15:57:02 -080036#include <unwindstack/Memory.h>
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070037#include <unwindstack/Unwinder.h>
38
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080039#if !defined(NO_LIBDEXFILE_SUPPORT)
David Srbeckyb9cc4fb2019-04-05 18:23:32 +000040#include <unwindstack/DexFiles.h>
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080041#endif
42
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070043namespace unwindstack {
44
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080045// Inject extra 'virtual' frame that represents the dex pc data.
46// The dex pc is a magic register defined in the Mterp interpreter,
47// and thus it will be restored/observed in the frame after it.
48// Adding the dex frame first here will create something like:
49// #7 pc 0015fa20 core.vdex java.util.Arrays.binarySearch+8
50// #8 pc 006b1ba1 libartd.so ExecuteMterpImpl+14625
51// #9 pc 0039a1ef libartd.so art::interpreter::Execute+719
52void Unwinder::FillInDexFrame() {
53 size_t frame_num = frames_.size();
54 frames_.resize(frame_num + 1);
55 FrameData* frame = &frames_.at(frame_num);
Christopher Ferris559c7f22018-02-12 20:18:03 -080056 frame->num = frame_num;
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080057
58 uint64_t dex_pc = regs_->dex_pc();
59 frame->pc = dex_pc;
60 frame->sp = regs_->sp();
61
Christopher Ferris7747b602018-01-31 19:05:19 -080062 MapInfo* info = maps_->Find(dex_pc);
Christopher Ferrise762f1f2018-02-06 14:51:48 -080063 if (info != nullptr) {
64 frame->map_start = info->start;
65 frame->map_end = info->end;
Christopher Ferrisa09c4a62018-12-13 16:08:50 -080066 frame->map_elf_start_offset = info->elf_start_offset;
67 frame->map_exact_offset = info->offset;
Christopher Ferrise762f1f2018-02-06 14:51:48 -080068 frame->map_load_bias = info->load_bias;
69 frame->map_flags = info->flags;
David Srbeckye62f4c42018-03-16 18:44:04 +000070 if (resolve_names_) {
71 frame->map_name = info->name;
72 }
Christopher Ferrise762f1f2018-02-06 14:51:48 -080073 frame->rel_pc = dex_pc - info->start;
74 } else {
75 frame->rel_pc = dex_pc;
76 return;
77 }
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080078
Christopher Ferrise4b3a6a2018-02-20 13:58:40 -080079 if (!resolve_names_) {
80 return;
81 }
82
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080083#if !defined(NO_LIBDEXFILE_SUPPORT)
Christopher Ferris7747b602018-01-31 19:05:19 -080084 if (dex_files_ == nullptr) {
85 return;
86 }
87
David Srbeckyb9cc4fb2019-04-05 18:23:32 +000088 dex_files_->GetMethodInformation(maps_, info, dex_pc, &frame->function_name,
89 &frame->function_offset);
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080090#endif
91}
92
Christopher Ferrisd11ed862019-04-11 19:45:35 -070093FrameData* Unwinder::FillInFrame(MapInfo* map_info, Elf* elf, uint64_t rel_pc,
94 uint64_t pc_adjustment) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070095 size_t frame_num = frames_.size();
96 frames_.resize(frame_num + 1);
97 FrameData* frame = &frames_.at(frame_num);
98 frame->num = frame_num;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070099 frame->sp = regs_->sp();
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800100 frame->rel_pc = rel_pc - pc_adjustment;
101 frame->pc = regs_->pc() - pc_adjustment;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700102
103 if (map_info == nullptr) {
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700104 // Nothing else to update.
105 return nullptr;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700106 }
107
David Srbeckye62f4c42018-03-16 18:44:04 +0000108 if (resolve_names_) {
109 frame->map_name = map_info->name;
Christopher Ferris02a6c442019-03-11 14:43:33 -0700110 if (embedded_soname_ && map_info->elf_start_offset != 0 && !frame->map_name.empty()) {
111 std::string soname = elf->GetSoname();
112 if (!soname.empty()) {
113 frame->map_name += '!' + soname;
114 }
115 }
David Srbeckye62f4c42018-03-16 18:44:04 +0000116 }
Christopher Ferrisa09c4a62018-12-13 16:08:50 -0800117 frame->map_elf_start_offset = map_info->elf_start_offset;
118 frame->map_exact_offset = map_info->offset;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700119 frame->map_start = map_info->start;
120 frame->map_end = map_info->end;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700121 frame->map_flags = map_info->flags;
122 frame->map_load_bias = elf->GetLoadBias();
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700123 return frame;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700124}
125
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700126static bool ShouldStop(const std::vector<std::string>* map_suffixes_to_ignore,
127 std::string& map_name) {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700128 if (map_suffixes_to_ignore == nullptr) {
129 return false;
130 }
131 auto pos = map_name.find_last_of('.');
132 if (pos == std::string::npos) {
133 return false;
134 }
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700135
136 return std::find(map_suffixes_to_ignore->begin(), map_suffixes_to_ignore->end(),
137 map_name.substr(pos + 1)) != map_suffixes_to_ignore->end();
Christopher Ferrise69f4702017-10-19 16:08:58 -0700138}
139
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700140void Unwinder::Unwind(const std::vector<std::string>* initial_map_names_to_skip,
141 const std::vector<std::string>* map_suffixes_to_ignore) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700142 frames_.clear();
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800143 last_error_.code = ERROR_NONE;
144 last_error_.address = 0;
Christopher Ferris4ae266c2019-04-03 09:27:12 -0700145 elf_from_memory_not_file_ = false;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700146
Christopher Ferris4568f4b2018-10-23 17:42:41 -0700147 ArchEnum arch = regs_->Arch();
148
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700149 bool return_address_attempt = false;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700150 bool adjust_pc = false;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700151 for (; frames_.size() < max_frames_;) {
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700152 uint64_t cur_pc = regs_->pc();
153 uint64_t cur_sp = regs_->sp();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700154
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700155 MapInfo* map_info = maps_->Find(regs_->pc());
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800156 uint64_t pc_adjustment = 0;
157 uint64_t step_pc;
Yabin Cuid5b22c52018-02-22 17:11:31 -0800158 uint64_t rel_pc;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700159 Elf* elf;
160 if (map_info == nullptr) {
Yabin Cuid5b22c52018-02-22 17:11:31 -0800161 step_pc = regs_->pc();
162 rel_pc = step_pc;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800163 last_error_.code = ERROR_INVALID_MAP;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700164 } else {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700165 if (ShouldStop(map_suffixes_to_ignore, map_info->name)) {
166 break;
167 }
Christopher Ferris4568f4b2018-10-23 17:42:41 -0700168 elf = map_info->GetElf(process_memory_, arch);
Christopher Ferris4ae266c2019-04-03 09:27:12 -0700169 // If this elf is memory backed, and there is a valid file, then set
170 // an indicator that we couldn't open the file.
171 if (!elf_from_memory_not_file_ && map_info->memory_backed_elf && !map_info->name.empty() &&
Christopher Ferris98aaf4c2019-05-03 11:13:17 -0700172 map_info->name[0] != '[' && !android::base::StartsWith(map_info->name, "/memfd:")) {
Christopher Ferris4ae266c2019-04-03 09:27:12 -0700173 elf_from_memory_not_file_ = true;
174 }
Yabin Cuid5b22c52018-02-22 17:11:31 -0800175 step_pc = regs_->pc();
176 rel_pc = elf->GetRelPc(step_pc, map_info);
177 // Everyone except elf data in gdb jit debug maps uses the relative pc.
178 if (!(map_info->flags & MAPS_FLAGS_JIT_SYMFILE_MAP)) {
179 step_pc = rel_pc;
180 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800181 if (adjust_pc) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800182 pc_adjustment = regs_->GetPcAdjustment(rel_pc, elf);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800183 } else {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800184 pc_adjustment = 0;
Christopher Ferris150db122017-12-20 18:49:01 -0800185 }
Yabin Cuid5b22c52018-02-22 17:11:31 -0800186 step_pc -= pc_adjustment;
Christopher Ferris150db122017-12-20 18:49:01 -0800187
188 // If the pc is in an invalid elf file, try and get an Elf object
189 // using the jit debug information.
190 if (!elf->valid() && jit_debug_ != nullptr) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800191 uint64_t adjusted_jit_pc = regs_->pc() - pc_adjustment;
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000192 Elf* jit_elf = jit_debug_->GetElf(maps_, adjusted_jit_pc);
Christopher Ferris150db122017-12-20 18:49:01 -0800193 if (jit_elf != nullptr) {
194 // The jit debug information requires a non relative adjusted pc.
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800195 step_pc = adjusted_jit_pc;
Christopher Ferris150db122017-12-20 18:49:01 -0800196 elf = jit_elf;
197 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800198 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700199 }
200
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700201 FrameData* frame = nullptr;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700202 if (map_info == nullptr || initial_map_names_to_skip == nullptr ||
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700203 std::find(initial_map_names_to_skip->begin(), initial_map_names_to_skip->end(),
204 basename(map_info->name.c_str())) == initial_map_names_to_skip->end()) {
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800205 if (regs_->dex_pc() != 0) {
206 // Add a frame to represent the dex file.
207 FillInDexFrame();
Christopher Ferrisa8c39732018-02-12 08:46:19 -0800208 // Clear the dex pc so that we don't repeat this frame later.
209 regs_->set_dex_pc(0);
Christopher Ferris9d0ad232018-10-12 16:33:42 -0700210
211 // Make sure there is enough room for the real frame.
212 if (frames_.size() == max_frames_) {
213 last_error_.code = ERROR_MAX_FRAMES_EXCEEDED;
214 break;
215 }
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800216 }
217
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700218 frame = FillInFrame(map_info, elf, rel_pc, pc_adjustment);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800219
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700220 // Once a frame is added, stop skipping frames.
221 initial_map_names_to_skip = nullptr;
222 }
223 adjust_pc = true;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700224
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700225 bool stepped = false;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700226 bool in_device_map = false;
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700227 bool finished = false;
228 if (map_info != nullptr) {
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700229 if (map_info->flags & MAPS_FLAGS_DEVICE_MAP) {
230 // Do not stop here, fall through in case we are
231 // in the speculative unwind path and need to remove
232 // some of the speculative frames.
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700233 in_device_map = true;
234 } else {
235 MapInfo* sp_info = maps_->Find(regs_->sp());
236 if (sp_info != nullptr && sp_info->flags & MAPS_FLAGS_DEVICE_MAP) {
237 // Do not stop here, fall through in case we are
238 // in the speculative unwind path and need to remove
239 // some of the speculative frames.
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700240 in_device_map = true;
241 } else {
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700242 if (elf->StepIfSignalHandler(rel_pc, regs_, process_memory_.get())) {
243 stepped = true;
244 if (frame != nullptr) {
245 // Need to adjust the relative pc because the signal handler
246 // pc should not be adjusted.
247 frame->rel_pc = rel_pc;
248 frame->pc += pc_adjustment;
249 step_pc = rel_pc;
250 }
251 } else if (elf->Step(step_pc, regs_, process_memory_.get(), &finished)) {
252 stepped = true;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700253 }
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700254 elf->GetLastError(&last_error_);
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700255 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700256 }
257 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700258
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700259 if (frame != nullptr) {
260 if (!resolve_names_ ||
261 !elf->GetFunctionName(step_pc, &frame->function_name, &frame->function_offset)) {
262 frame->function_name = "";
263 frame->function_offset = 0;
264 }
265 }
266
267 if (finished) {
268 break;
269 }
270
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700271 if (!stepped) {
272 if (return_address_attempt) {
Christopher Ferris065f1562018-12-13 09:33:45 -0800273 // Only remove the speculative frame if there are more than two frames
274 // or the pc in the first frame is in a valid map.
275 // This allows for a case where the code jumps into the middle of
276 // nowhere, but there is no other unwind information after that.
Florian Mayerc479e4e2019-01-23 13:35:40 +0000277 if (frames_.size() > 2 || (frames_.size() > 0 && maps_->Find(frames_[0].pc) != nullptr)) {
Christopher Ferris065f1562018-12-13 09:33:45 -0800278 // Remove the speculative frame.
279 frames_.pop_back();
280 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700281 break;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700282 } else if (in_device_map) {
283 // Do not attempt any other unwinding, pc or sp is in a device
284 // map.
285 break;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700286 } else {
287 // Steping didn't work, try this secondary method.
288 if (!regs_->SetPcFromReturnAddress(process_memory_.get())) {
289 break;
290 }
291 return_address_attempt = true;
292 }
293 } else {
294 return_address_attempt = false;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800295 if (max_frames_ == frames_.size()) {
296 last_error_.code = ERROR_MAX_FRAMES_EXCEEDED;
297 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700298 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700299
300 // If the pc and sp didn't change, then consider everything stopped.
301 if (cur_pc == regs_->pc() && cur_sp == regs_->sp()) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800302 last_error_.code = ERROR_REPEATED_FRAME;
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700303 break;
304 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700305 }
306}
307
Christopher Ferris78133452019-03-14 13:44:38 -0700308std::string Unwinder::FormatFrame(const FrameData& frame) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700309 std::string data;
Christopher Ferris78133452019-03-14 13:44:38 -0700310 if (regs_->Is32Bit()) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700311 data += android::base::StringPrintf(" #%02zu pc %08" PRIx64, frame.num, frame.rel_pc);
312 } else {
313 data += android::base::StringPrintf(" #%02zu pc %016" PRIx64, frame.num, frame.rel_pc);
314 }
315
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700316 if (frame.map_start == frame.map_end) {
317 // No valid map associated with this frame.
318 data += " <unknown>";
319 } else if (!frame.map_name.empty()) {
320 data += " " + frame.map_name;
321 } else {
322 data += android::base::StringPrintf(" <anonymous:%" PRIx64 ">", frame.map_start);
323 }
Christopher Ferrisa09c4a62018-12-13 16:08:50 -0800324
325 if (frame.map_elf_start_offset != 0) {
326 data += android::base::StringPrintf(" (offset 0x%" PRIx64 ")", frame.map_elf_start_offset);
327 }
328
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700329 if (!frame.function_name.empty()) {
Christopher Ferriseb0772f2018-12-05 15:57:02 -0800330 data += " (" + demangle(frame.function_name.c_str());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700331 if (frame.function_offset != 0) {
332 data += android::base::StringPrintf("+%" PRId64, frame.function_offset);
333 }
334 data += ')';
335 }
Christopher Ferris78133452019-03-14 13:44:38 -0700336
337 MapInfo* map_info = maps_->Find(frame.map_start);
338 if (map_info != nullptr && display_build_id_) {
339 std::string build_id = map_info->GetPrintableBuildID();
340 if (!build_id.empty()) {
341 data += " (BuildId: " + build_id + ')';
342 }
343 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700344 return data;
345}
346
Christopher Ferris78133452019-03-14 13:44:38 -0700347std::string Unwinder::FormatFrame(size_t frame_num) {
348 if (frame_num >= frames_.size()) {
349 return "";
350 }
351 return FormatFrame(frames_[frame_num]);
352}
353
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000354void Unwinder::SetJitDebug(JitDebug* jit_debug, ArchEnum arch) {
355 jit_debug->SetArch(arch);
356 jit_debug_ = jit_debug;
357}
358
359#if !defined(NO_LIBDEXFILE_SUPPORT)
360void Unwinder::SetDexFiles(DexFiles* dex_files, ArchEnum arch) {
361 dex_files->SetArch(arch);
362 dex_files_ = dex_files;
363}
364#endif
365
366bool UnwinderFromPid::Init(ArchEnum arch) {
Christopher Ferriseb0772f2018-12-05 15:57:02 -0800367 if (pid_ == getpid()) {
368 maps_ptr_.reset(new LocalMaps());
369 } else {
370 maps_ptr_.reset(new RemoteMaps(pid_));
371 }
372 if (!maps_ptr_->Parse()) {
373 return false;
374 }
375 maps_ = maps_ptr_.get();
376
377 process_memory_ = Memory::CreateProcessMemoryCached(pid_);
378
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000379 jit_debug_ptr_.reset(new JitDebug(process_memory_));
380 jit_debug_ = jit_debug_ptr_.get();
381 SetJitDebug(jit_debug_, arch);
382#if !defined(NO_LIBDEXFILE_SUPPORT)
383 dex_files_ptr_.reset(new DexFiles(process_memory_));
384 dex_files_ = dex_files_ptr_.get();
385 SetDexFiles(dex_files_, arch);
386#endif
387
Christopher Ferriseb0772f2018-12-05 15:57:02 -0800388 return true;
389}
390
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700391} // namespace unwindstack