blob: 2734cf8d32520f85debb4fe83e71ca8f69c26e39 [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)
39#include <unwindstack/DexFiles.h>
40#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
Christopher Ferris7747b602018-01-31 19:05:19 -080087 dex_files_->GetMethodInformation(maps_, info, dex_pc, &frame->function_name,
David Srbeckyf9006ec2018-02-01 14:49:14 +000088 &frame->function_offset);
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080089#endif
90}
91
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -080092void Unwinder::FillInFrame(MapInfo* map_info, Elf* elf, uint64_t rel_pc, uint64_t func_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) {
103 return;
104 }
105
David Srbeckye62f4c42018-03-16 18:44:04 +0000106 if (resolve_names_) {
107 frame->map_name = map_info->name;
108 }
Christopher Ferrisa09c4a62018-12-13 16:08:50 -0800109 frame->map_elf_start_offset = map_info->elf_start_offset;
110 frame->map_exact_offset = map_info->offset;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700111 frame->map_start = map_info->start;
112 frame->map_end = map_info->end;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700113 frame->map_flags = map_info->flags;
114 frame->map_load_bias = elf->GetLoadBias();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700115
Christopher Ferrise4b3a6a2018-02-20 13:58:40 -0800116 if (!resolve_names_ ||
117 !elf->GetFunctionName(func_pc, &frame->function_name, &frame->function_offset)) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700118 frame->function_name = "";
119 frame->function_offset = 0;
120 }
121}
122
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700123static bool ShouldStop(const std::vector<std::string>* map_suffixes_to_ignore,
124 std::string& map_name) {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700125 if (map_suffixes_to_ignore == nullptr) {
126 return false;
127 }
128 auto pos = map_name.find_last_of('.');
129 if (pos == std::string::npos) {
130 return false;
131 }
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700132
133 return std::find(map_suffixes_to_ignore->begin(), map_suffixes_to_ignore->end(),
134 map_name.substr(pos + 1)) != map_suffixes_to_ignore->end();
Christopher Ferrise69f4702017-10-19 16:08:58 -0700135}
136
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700137void Unwinder::Unwind(const std::vector<std::string>* initial_map_names_to_skip,
138 const std::vector<std::string>* map_suffixes_to_ignore) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700139 frames_.clear();
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800140 last_error_.code = ERROR_NONE;
141 last_error_.address = 0;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700142
Christopher Ferris4568f4b2018-10-23 17:42:41 -0700143 ArchEnum arch = regs_->Arch();
144
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700145 bool return_address_attempt = false;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700146 bool adjust_pc = false;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700147 for (; frames_.size() < max_frames_;) {
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700148 uint64_t cur_pc = regs_->pc();
149 uint64_t cur_sp = regs_->sp();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700150
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700151 MapInfo* map_info = maps_->Find(regs_->pc());
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800152 uint64_t pc_adjustment = 0;
153 uint64_t step_pc;
Yabin Cuid5b22c52018-02-22 17:11:31 -0800154 uint64_t rel_pc;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700155 Elf* elf;
156 if (map_info == nullptr) {
Yabin Cuid5b22c52018-02-22 17:11:31 -0800157 step_pc = regs_->pc();
158 rel_pc = step_pc;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800159 last_error_.code = ERROR_INVALID_MAP;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700160 } else {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700161 if (ShouldStop(map_suffixes_to_ignore, map_info->name)) {
162 break;
163 }
Christopher Ferris4568f4b2018-10-23 17:42:41 -0700164 elf = map_info->GetElf(process_memory_, arch);
Yabin Cuid5b22c52018-02-22 17:11:31 -0800165 step_pc = regs_->pc();
166 rel_pc = elf->GetRelPc(step_pc, map_info);
167 // Everyone except elf data in gdb jit debug maps uses the relative pc.
168 if (!(map_info->flags & MAPS_FLAGS_JIT_SYMFILE_MAP)) {
169 step_pc = rel_pc;
170 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800171 if (adjust_pc) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800172 pc_adjustment = regs_->GetPcAdjustment(rel_pc, elf);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800173 } else {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800174 pc_adjustment = 0;
Christopher Ferris150db122017-12-20 18:49:01 -0800175 }
Yabin Cuid5b22c52018-02-22 17:11:31 -0800176 step_pc -= pc_adjustment;
Christopher Ferris150db122017-12-20 18:49:01 -0800177
178 // If the pc is in an invalid elf file, try and get an Elf object
179 // using the jit debug information.
180 if (!elf->valid() && jit_debug_ != nullptr) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800181 uint64_t adjusted_jit_pc = regs_->pc() - pc_adjustment;
Christopher Ferris150db122017-12-20 18:49:01 -0800182 Elf* jit_elf = jit_debug_->GetElf(maps_, adjusted_jit_pc);
183 if (jit_elf != nullptr) {
184 // The jit debug information requires a non relative adjusted pc.
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800185 step_pc = adjusted_jit_pc;
Christopher Ferris150db122017-12-20 18:49:01 -0800186 elf = jit_elf;
187 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800188 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700189 }
190
191 if (map_info == nullptr || initial_map_names_to_skip == nullptr ||
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700192 std::find(initial_map_names_to_skip->begin(), initial_map_names_to_skip->end(),
193 basename(map_info->name.c_str())) == initial_map_names_to_skip->end()) {
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800194 if (regs_->dex_pc() != 0) {
195 // Add a frame to represent the dex file.
196 FillInDexFrame();
Christopher Ferrisa8c39732018-02-12 08:46:19 -0800197 // Clear the dex pc so that we don't repeat this frame later.
198 regs_->set_dex_pc(0);
Christopher Ferris9d0ad232018-10-12 16:33:42 -0700199
200 // Make sure there is enough room for the real frame.
201 if (frames_.size() == max_frames_) {
202 last_error_.code = ERROR_MAX_FRAMES_EXCEEDED;
203 break;
204 }
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800205 }
206
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800207 FillInFrame(map_info, elf, rel_pc, step_pc, pc_adjustment);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800208
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700209 // Once a frame is added, stop skipping frames.
210 initial_map_names_to_skip = nullptr;
211 }
212 adjust_pc = true;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700213
214 bool stepped;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700215 bool in_device_map = false;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700216 if (map_info == nullptr) {
217 stepped = false;
218 } else {
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700219 if (map_info->flags & MAPS_FLAGS_DEVICE_MAP) {
220 // Do not stop here, fall through in case we are
221 // in the speculative unwind path and need to remove
222 // some of the speculative frames.
223 stepped = false;
224 in_device_map = true;
225 } else {
226 MapInfo* sp_info = maps_->Find(regs_->sp());
227 if (sp_info != nullptr && sp_info->flags & MAPS_FLAGS_DEVICE_MAP) {
228 // Do not stop here, fall through in case we are
229 // in the speculative unwind path and need to remove
230 // some of the speculative frames.
231 stepped = false;
232 in_device_map = true;
233 } else {
234 bool finished;
Christopher Ferris239425b2018-05-17 18:37:38 -0700235 stepped = elf->Step(rel_pc, step_pc, regs_, process_memory_.get(), &finished);
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800236 elf->GetLastError(&last_error_);
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700237 if (stepped && finished) {
238 break;
239 }
240 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700241 }
242 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700243
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700244 if (!stepped) {
245 if (return_address_attempt) {
Christopher Ferris065f1562018-12-13 09:33:45 -0800246 // Only remove the speculative frame if there are more than two frames
247 // or the pc in the first frame is in a valid map.
248 // This allows for a case where the code jumps into the middle of
249 // nowhere, but there is no other unwind information after that.
Florian Mayerc479e4e2019-01-23 13:35:40 +0000250 if (frames_.size() > 2 || (frames_.size() > 0 && maps_->Find(frames_[0].pc) != nullptr)) {
Christopher Ferris065f1562018-12-13 09:33:45 -0800251 // Remove the speculative frame.
252 frames_.pop_back();
253 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700254 break;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700255 } else if (in_device_map) {
256 // Do not attempt any other unwinding, pc or sp is in a device
257 // map.
258 break;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700259 } else {
260 // Steping didn't work, try this secondary method.
261 if (!regs_->SetPcFromReturnAddress(process_memory_.get())) {
262 break;
263 }
264 return_address_attempt = true;
265 }
266 } else {
267 return_address_attempt = false;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800268 if (max_frames_ == frames_.size()) {
269 last_error_.code = ERROR_MAX_FRAMES_EXCEEDED;
270 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700271 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700272
273 // If the pc and sp didn't change, then consider everything stopped.
274 if (cur_pc == regs_->pc() && cur_sp == regs_->sp()) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800275 last_error_.code = ERROR_REPEATED_FRAME;
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700276 break;
277 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700278 }
279}
280
281std::string Unwinder::FormatFrame(size_t frame_num) {
282 if (frame_num >= frames_.size()) {
283 return "";
284 }
Christopher Ferris150db122017-12-20 18:49:01 -0800285 return FormatFrame(frames_[frame_num], regs_->Is32Bit());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700286}
287
Christopher Ferris150db122017-12-20 18:49:01 -0800288std::string Unwinder::FormatFrame(const FrameData& frame, bool is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700289 std::string data;
290
Christopher Ferris150db122017-12-20 18:49:01 -0800291 if (is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700292 data += android::base::StringPrintf(" #%02zu pc %08" PRIx64, frame.num, frame.rel_pc);
293 } else {
294 data += android::base::StringPrintf(" #%02zu pc %016" PRIx64, frame.num, frame.rel_pc);
295 }
296
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700297 if (frame.map_start == frame.map_end) {
298 // No valid map associated with this frame.
299 data += " <unknown>";
300 } else if (!frame.map_name.empty()) {
301 data += " " + frame.map_name;
302 } else {
303 data += android::base::StringPrintf(" <anonymous:%" PRIx64 ">", frame.map_start);
304 }
Christopher Ferrisa09c4a62018-12-13 16:08:50 -0800305
306 if (frame.map_elf_start_offset != 0) {
307 data += android::base::StringPrintf(" (offset 0x%" PRIx64 ")", frame.map_elf_start_offset);
308 }
309
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700310 if (!frame.function_name.empty()) {
Christopher Ferriseb0772f2018-12-05 15:57:02 -0800311 data += " (" + demangle(frame.function_name.c_str());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700312 if (frame.function_offset != 0) {
313 data += android::base::StringPrintf("+%" PRId64, frame.function_offset);
314 }
315 data += ')';
316 }
317 return data;
318}
319
Christopher Ferris150db122017-12-20 18:49:01 -0800320void Unwinder::SetJitDebug(JitDebug* jit_debug, ArchEnum arch) {
321 jit_debug->SetArch(arch);
322 jit_debug_ = jit_debug;
323}
324
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800325#if !defined(NO_LIBDEXFILE_SUPPORT)
326void Unwinder::SetDexFiles(DexFiles* dex_files, ArchEnum arch) {
327 dex_files->SetArch(arch);
328 dex_files_ = dex_files;
329}
330#endif
331
Christopher Ferriseb0772f2018-12-05 15:57:02 -0800332bool UnwinderFromPid::Init(ArchEnum arch) {
333 if (pid_ == getpid()) {
334 maps_ptr_.reset(new LocalMaps());
335 } else {
336 maps_ptr_.reset(new RemoteMaps(pid_));
337 }
338 if (!maps_ptr_->Parse()) {
339 return false;
340 }
341 maps_ = maps_ptr_.get();
342
343 process_memory_ = Memory::CreateProcessMemoryCached(pid_);
344
345 jit_debug_ptr_.reset(new JitDebug(process_memory_));
346 jit_debug_ = jit_debug_ptr_.get();
347 SetJitDebug(jit_debug_, arch);
348#if !defined(NO_LIBDEXFILE_SUPPORT)
349 dex_files_ptr_.reset(new DexFiles(process_memory_));
350 dex_files_ = dex_files_ptr_.get();
351 SetDexFiles(dex_files_, arch);
352#endif
353
354 return true;
355}
356
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700357} // namespace unwindstack