blob: f3d2b5e1cdb45ff0a5e150935c9e380ae14434c5 [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
Christopher Ferriseb0772f2018-12-05 15:57:02 -080029#include <demangle.h>
30
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070031#include <unwindstack/Elf.h>
Christopher Ferris150db122017-12-20 18:49:01 -080032#include <unwindstack/JitDebug.h>
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070033#include <unwindstack/MapInfo.h>
Yabin Cuid5b22c52018-02-22 17:11:31 -080034#include <unwindstack/Maps.h>
Christopher Ferriseb0772f2018-12-05 15:57:02 -080035#include <unwindstack/Memory.h>
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070036#include <unwindstack/Unwinder.h>
37
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080038#if !defined(NO_LIBDEXFILE_SUPPORT)
David Srbeckyb9cc4fb2019-04-05 18:23:32 +000039#include <unwindstack/DexFiles.h>
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080040#endif
41
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070042namespace unwindstack {
43
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080044// Inject extra 'virtual' frame that represents the dex pc data.
45// The dex pc is a magic register defined in the Mterp interpreter,
46// and thus it will be restored/observed in the frame after it.
47// Adding the dex frame first here will create something like:
48// #7 pc 0015fa20 core.vdex java.util.Arrays.binarySearch+8
49// #8 pc 006b1ba1 libartd.so ExecuteMterpImpl+14625
50// #9 pc 0039a1ef libartd.so art::interpreter::Execute+719
51void Unwinder::FillInDexFrame() {
52 size_t frame_num = frames_.size();
53 frames_.resize(frame_num + 1);
54 FrameData* frame = &frames_.at(frame_num);
Christopher Ferris559c7f22018-02-12 20:18:03 -080055 frame->num = frame_num;
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080056
57 uint64_t dex_pc = regs_->dex_pc();
58 frame->pc = dex_pc;
59 frame->sp = regs_->sp();
60
Christopher Ferris7747b602018-01-31 19:05:19 -080061 MapInfo* info = maps_->Find(dex_pc);
Christopher Ferrise762f1f2018-02-06 14:51:48 -080062 if (info != nullptr) {
63 frame->map_start = info->start;
64 frame->map_end = info->end;
Christopher Ferrisa09c4a62018-12-13 16:08:50 -080065 frame->map_elf_start_offset = info->elf_start_offset;
66 frame->map_exact_offset = info->offset;
Christopher Ferrise762f1f2018-02-06 14:51:48 -080067 frame->map_load_bias = info->load_bias;
68 frame->map_flags = info->flags;
David Srbeckye62f4c42018-03-16 18:44:04 +000069 if (resolve_names_) {
70 frame->map_name = info->name;
71 }
Christopher Ferrise762f1f2018-02-06 14:51:48 -080072 frame->rel_pc = dex_pc - info->start;
73 } else {
74 frame->rel_pc = dex_pc;
75 return;
76 }
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080077
Christopher Ferrise4b3a6a2018-02-20 13:58:40 -080078 if (!resolve_names_) {
79 return;
80 }
81
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080082#if !defined(NO_LIBDEXFILE_SUPPORT)
Christopher Ferris7747b602018-01-31 19:05:19 -080083 if (dex_files_ == nullptr) {
84 return;
85 }
86
David Srbeckyb9cc4fb2019-04-05 18:23:32 +000087 dex_files_->GetMethodInformation(maps_, info, dex_pc, &frame->function_name,
88 &frame->function_offset);
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080089#endif
90}
91
Christopher Ferrisd11ed862019-04-11 19:45:35 -070092FrameData* Unwinder::FillInFrame(MapInfo* map_info, Elf* elf, uint64_t rel_pc,
93 uint64_t pc_adjustment) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070094 size_t frame_num = frames_.size();
95 frames_.resize(frame_num + 1);
96 FrameData* frame = &frames_.at(frame_num);
97 frame->num = frame_num;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070098 frame->sp = regs_->sp();
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -080099 frame->rel_pc = rel_pc - pc_adjustment;
100 frame->pc = regs_->pc() - pc_adjustment;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700101
102 if (map_info == nullptr) {
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700103 // Nothing else to update.
104 return nullptr;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700105 }
106
David Srbeckye62f4c42018-03-16 18:44:04 +0000107 if (resolve_names_) {
108 frame->map_name = map_info->name;
Christopher Ferris02a6c442019-03-11 14:43:33 -0700109 if (embedded_soname_ && map_info->elf_start_offset != 0 && !frame->map_name.empty()) {
110 std::string soname = elf->GetSoname();
111 if (!soname.empty()) {
112 frame->map_name += '!' + soname;
113 }
114 }
David Srbeckye62f4c42018-03-16 18:44:04 +0000115 }
Christopher Ferrisa09c4a62018-12-13 16:08:50 -0800116 frame->map_elf_start_offset = map_info->elf_start_offset;
117 frame->map_exact_offset = map_info->offset;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700118 frame->map_start = map_info->start;
119 frame->map_end = map_info->end;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700120 frame->map_flags = map_info->flags;
121 frame->map_load_bias = elf->GetLoadBias();
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700122 return frame;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700123}
124
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700125static bool ShouldStop(const std::vector<std::string>* map_suffixes_to_ignore,
126 std::string& map_name) {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700127 if (map_suffixes_to_ignore == nullptr) {
128 return false;
129 }
130 auto pos = map_name.find_last_of('.');
131 if (pos == std::string::npos) {
132 return false;
133 }
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700134
135 return std::find(map_suffixes_to_ignore->begin(), map_suffixes_to_ignore->end(),
136 map_name.substr(pos + 1)) != map_suffixes_to_ignore->end();
Christopher Ferrise69f4702017-10-19 16:08:58 -0700137}
138
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700139void Unwinder::Unwind(const std::vector<std::string>* initial_map_names_to_skip,
140 const std::vector<std::string>* map_suffixes_to_ignore) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700141 frames_.clear();
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800142 last_error_.code = ERROR_NONE;
143 last_error_.address = 0;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700144
Christopher Ferris4568f4b2018-10-23 17:42:41 -0700145 ArchEnum arch = regs_->Arch();
146
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700147 bool return_address_attempt = false;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700148 bool adjust_pc = false;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700149 for (; frames_.size() < max_frames_;) {
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700150 uint64_t cur_pc = regs_->pc();
151 uint64_t cur_sp = regs_->sp();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700152
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700153 MapInfo* map_info = maps_->Find(regs_->pc());
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800154 uint64_t pc_adjustment = 0;
155 uint64_t step_pc;
Yabin Cuid5b22c52018-02-22 17:11:31 -0800156 uint64_t rel_pc;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700157 Elf* elf;
158 if (map_info == nullptr) {
Yabin Cuid5b22c52018-02-22 17:11:31 -0800159 step_pc = regs_->pc();
160 rel_pc = step_pc;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800161 last_error_.code = ERROR_INVALID_MAP;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700162 } else {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700163 if (ShouldStop(map_suffixes_to_ignore, map_info->name)) {
164 break;
165 }
Christopher Ferris4568f4b2018-10-23 17:42:41 -0700166 elf = map_info->GetElf(process_memory_, arch);
Yabin Cuid5b22c52018-02-22 17:11:31 -0800167 step_pc = regs_->pc();
168 rel_pc = elf->GetRelPc(step_pc, map_info);
169 // Everyone except elf data in gdb jit debug maps uses the relative pc.
170 if (!(map_info->flags & MAPS_FLAGS_JIT_SYMFILE_MAP)) {
171 step_pc = rel_pc;
172 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800173 if (adjust_pc) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800174 pc_adjustment = regs_->GetPcAdjustment(rel_pc, elf);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800175 } else {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800176 pc_adjustment = 0;
Christopher Ferris150db122017-12-20 18:49:01 -0800177 }
Yabin Cuid5b22c52018-02-22 17:11:31 -0800178 step_pc -= pc_adjustment;
Christopher Ferris150db122017-12-20 18:49:01 -0800179
180 // If the pc is in an invalid elf file, try and get an Elf object
181 // using the jit debug information.
182 if (!elf->valid() && jit_debug_ != nullptr) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800183 uint64_t adjusted_jit_pc = regs_->pc() - pc_adjustment;
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000184 Elf* jit_elf = jit_debug_->GetElf(maps_, adjusted_jit_pc);
Christopher Ferris150db122017-12-20 18:49:01 -0800185 if (jit_elf != nullptr) {
186 // The jit debug information requires a non relative adjusted pc.
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800187 step_pc = adjusted_jit_pc;
Christopher Ferris150db122017-12-20 18:49:01 -0800188 elf = jit_elf;
189 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800190 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700191 }
192
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700193 FrameData* frame = nullptr;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700194 if (map_info == nullptr || initial_map_names_to_skip == nullptr ||
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700195 std::find(initial_map_names_to_skip->begin(), initial_map_names_to_skip->end(),
196 basename(map_info->name.c_str())) == initial_map_names_to_skip->end()) {
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800197 if (regs_->dex_pc() != 0) {
198 // Add a frame to represent the dex file.
199 FillInDexFrame();
Christopher Ferrisa8c39732018-02-12 08:46:19 -0800200 // Clear the dex pc so that we don't repeat this frame later.
201 regs_->set_dex_pc(0);
Christopher Ferris9d0ad232018-10-12 16:33:42 -0700202
203 // Make sure there is enough room for the real frame.
204 if (frames_.size() == max_frames_) {
205 last_error_.code = ERROR_MAX_FRAMES_EXCEEDED;
206 break;
207 }
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800208 }
209
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700210 frame = FillInFrame(map_info, elf, rel_pc, pc_adjustment);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800211
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700212 // Once a frame is added, stop skipping frames.
213 initial_map_names_to_skip = nullptr;
214 }
215 adjust_pc = true;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700216
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700217 bool stepped = false;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700218 bool in_device_map = false;
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700219 bool finished = false;
220 if (map_info != nullptr) {
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700221 if (map_info->flags & MAPS_FLAGS_DEVICE_MAP) {
222 // Do not stop here, fall through in case we are
223 // in the speculative unwind path and need to remove
224 // some of the speculative frames.
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700225 in_device_map = true;
226 } else {
227 MapInfo* sp_info = maps_->Find(regs_->sp());
228 if (sp_info != nullptr && sp_info->flags & MAPS_FLAGS_DEVICE_MAP) {
229 // Do not stop here, fall through in case we are
230 // in the speculative unwind path and need to remove
231 // some of the speculative frames.
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700232 in_device_map = true;
233 } else {
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700234 if (elf->StepIfSignalHandler(rel_pc, regs_, process_memory_.get())) {
235 stepped = true;
236 if (frame != nullptr) {
237 // Need to adjust the relative pc because the signal handler
238 // pc should not be adjusted.
239 frame->rel_pc = rel_pc;
240 frame->pc += pc_adjustment;
241 step_pc = rel_pc;
242 }
243 } else if (elf->Step(step_pc, regs_, process_memory_.get(), &finished)) {
244 stepped = true;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700245 }
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700246 elf->GetLastError(&last_error_);
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700247 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700248 }
249 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700250
Christopher Ferrisd11ed862019-04-11 19:45:35 -0700251 if (frame != nullptr) {
252 if (!resolve_names_ ||
253 !elf->GetFunctionName(step_pc, &frame->function_name, &frame->function_offset)) {
254 frame->function_name = "";
255 frame->function_offset = 0;
256 }
257 }
258
259 if (finished) {
260 break;
261 }
262
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700263 if (!stepped) {
264 if (return_address_attempt) {
Christopher Ferris065f1562018-12-13 09:33:45 -0800265 // Only remove the speculative frame if there are more than two frames
266 // or the pc in the first frame is in a valid map.
267 // This allows for a case where the code jumps into the middle of
268 // nowhere, but there is no other unwind information after that.
Florian Mayerc479e4e2019-01-23 13:35:40 +0000269 if (frames_.size() > 2 || (frames_.size() > 0 && maps_->Find(frames_[0].pc) != nullptr)) {
Christopher Ferris065f1562018-12-13 09:33:45 -0800270 // Remove the speculative frame.
271 frames_.pop_back();
272 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700273 break;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700274 } else if (in_device_map) {
275 // Do not attempt any other unwinding, pc or sp is in a device
276 // map.
277 break;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700278 } else {
279 // Steping didn't work, try this secondary method.
280 if (!regs_->SetPcFromReturnAddress(process_memory_.get())) {
281 break;
282 }
283 return_address_attempt = true;
284 }
285 } else {
286 return_address_attempt = false;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800287 if (max_frames_ == frames_.size()) {
288 last_error_.code = ERROR_MAX_FRAMES_EXCEEDED;
289 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700290 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700291
292 // If the pc and sp didn't change, then consider everything stopped.
293 if (cur_pc == regs_->pc() && cur_sp == regs_->sp()) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800294 last_error_.code = ERROR_REPEATED_FRAME;
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700295 break;
296 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700297 }
298}
299
Christopher Ferris78133452019-03-14 13:44:38 -0700300std::string Unwinder::FormatFrame(const FrameData& frame) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700301 std::string data;
Christopher Ferris78133452019-03-14 13:44:38 -0700302 if (regs_->Is32Bit()) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700303 data += android::base::StringPrintf(" #%02zu pc %08" PRIx64, frame.num, frame.rel_pc);
304 } else {
305 data += android::base::StringPrintf(" #%02zu pc %016" PRIx64, frame.num, frame.rel_pc);
306 }
307
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700308 if (frame.map_start == frame.map_end) {
309 // No valid map associated with this frame.
310 data += " <unknown>";
311 } else if (!frame.map_name.empty()) {
312 data += " " + frame.map_name;
313 } else {
314 data += android::base::StringPrintf(" <anonymous:%" PRIx64 ">", frame.map_start);
315 }
Christopher Ferrisa09c4a62018-12-13 16:08:50 -0800316
317 if (frame.map_elf_start_offset != 0) {
318 data += android::base::StringPrintf(" (offset 0x%" PRIx64 ")", frame.map_elf_start_offset);
319 }
320
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700321 if (!frame.function_name.empty()) {
Christopher Ferriseb0772f2018-12-05 15:57:02 -0800322 data += " (" + demangle(frame.function_name.c_str());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700323 if (frame.function_offset != 0) {
324 data += android::base::StringPrintf("+%" PRId64, frame.function_offset);
325 }
326 data += ')';
327 }
Christopher Ferris78133452019-03-14 13:44:38 -0700328
329 MapInfo* map_info = maps_->Find(frame.map_start);
330 if (map_info != nullptr && display_build_id_) {
331 std::string build_id = map_info->GetPrintableBuildID();
332 if (!build_id.empty()) {
333 data += " (BuildId: " + build_id + ')';
334 }
335 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700336 return data;
337}
338
Christopher Ferris78133452019-03-14 13:44:38 -0700339std::string Unwinder::FormatFrame(size_t frame_num) {
340 if (frame_num >= frames_.size()) {
341 return "";
342 }
343 return FormatFrame(frames_[frame_num]);
344}
345
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000346void Unwinder::SetJitDebug(JitDebug* jit_debug, ArchEnum arch) {
347 jit_debug->SetArch(arch);
348 jit_debug_ = jit_debug;
349}
350
351#if !defined(NO_LIBDEXFILE_SUPPORT)
352void Unwinder::SetDexFiles(DexFiles* dex_files, ArchEnum arch) {
353 dex_files->SetArch(arch);
354 dex_files_ = dex_files;
355}
356#endif
357
358bool UnwinderFromPid::Init(ArchEnum arch) {
Christopher Ferriseb0772f2018-12-05 15:57:02 -0800359 if (pid_ == getpid()) {
360 maps_ptr_.reset(new LocalMaps());
361 } else {
362 maps_ptr_.reset(new RemoteMaps(pid_));
363 }
364 if (!maps_ptr_->Parse()) {
365 return false;
366 }
367 maps_ = maps_ptr_.get();
368
369 process_memory_ = Memory::CreateProcessMemoryCached(pid_);
370
David Srbeckyb9cc4fb2019-04-05 18:23:32 +0000371 jit_debug_ptr_.reset(new JitDebug(process_memory_));
372 jit_debug_ = jit_debug_ptr_.get();
373 SetJitDebug(jit_debug_, arch);
374#if !defined(NO_LIBDEXFILE_SUPPORT)
375 dex_files_ptr_.reset(new DexFiles(process_memory_));
376 dex_files_ = dex_files_ptr_.get();
377 SetDexFiles(dex_files_, arch);
378#endif
379
Christopher Ferriseb0772f2018-12-05 15:57:02 -0800380 return true;
381}
382
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700383} // namespace unwindstack