blob: 813363905d37cac73c4ddb9187ce7fb0458beda9 [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;
Christopher Ferrisa09c4a62018-12-13 16:08:50 -080062 frame->map_elf_start_offset = info->elf_start_offset;
63 frame->map_exact_offset = info->offset;
Christopher Ferrise762f1f2018-02-06 14:51:48 -080064 frame->map_load_bias = info->load_bias;
65 frame->map_flags = info->flags;
David Srbeckye62f4c42018-03-16 18:44:04 +000066 if (resolve_names_) {
67 frame->map_name = info->name;
68 }
Christopher Ferrise762f1f2018-02-06 14:51:48 -080069 frame->rel_pc = dex_pc - info->start;
70 } else {
71 frame->rel_pc = dex_pc;
72 return;
73 }
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080074
Christopher Ferrise4b3a6a2018-02-20 13:58:40 -080075 if (!resolve_names_) {
76 return;
77 }
78
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080079#if !defined(NO_LIBDEXFILE_SUPPORT)
Christopher Ferris7747b602018-01-31 19:05:19 -080080 if (dex_files_ == nullptr) {
81 return;
82 }
83
Christopher Ferris7747b602018-01-31 19:05:19 -080084 dex_files_->GetMethodInformation(maps_, info, dex_pc, &frame->function_name,
David Srbeckyf9006ec2018-02-01 14:49:14 +000085 &frame->function_offset);
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -080086#endif
87}
88
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -080089void Unwinder::FillInFrame(MapInfo* map_info, Elf* elf, uint64_t rel_pc, uint64_t func_pc,
90 uint64_t pc_adjustment) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070091 size_t frame_num = frames_.size();
92 frames_.resize(frame_num + 1);
93 FrameData* frame = &frames_.at(frame_num);
94 frame->num = frame_num;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070095 frame->sp = regs_->sp();
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -080096 frame->rel_pc = rel_pc - pc_adjustment;
97 frame->pc = regs_->pc() - pc_adjustment;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -070098
99 if (map_info == nullptr) {
100 return;
101 }
102
David Srbeckye62f4c42018-03-16 18:44:04 +0000103 if (resolve_names_) {
104 frame->map_name = map_info->name;
105 }
Christopher Ferrisa09c4a62018-12-13 16:08:50 -0800106 frame->map_elf_start_offset = map_info->elf_start_offset;
107 frame->map_exact_offset = map_info->offset;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700108 frame->map_start = map_info->start;
109 frame->map_end = map_info->end;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700110 frame->map_flags = map_info->flags;
111 frame->map_load_bias = elf->GetLoadBias();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700112
Christopher Ferrise4b3a6a2018-02-20 13:58:40 -0800113 if (!resolve_names_ ||
114 !elf->GetFunctionName(func_pc, &frame->function_name, &frame->function_offset)) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700115 frame->function_name = "";
116 frame->function_offset = 0;
117 }
118}
119
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700120static bool ShouldStop(const std::vector<std::string>* map_suffixes_to_ignore,
121 std::string& map_name) {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700122 if (map_suffixes_to_ignore == nullptr) {
123 return false;
124 }
125 auto pos = map_name.find_last_of('.');
126 if (pos == std::string::npos) {
127 return false;
128 }
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700129
130 return std::find(map_suffixes_to_ignore->begin(), map_suffixes_to_ignore->end(),
131 map_name.substr(pos + 1)) != map_suffixes_to_ignore->end();
Christopher Ferrise69f4702017-10-19 16:08:58 -0700132}
133
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700134void Unwinder::Unwind(const std::vector<std::string>* initial_map_names_to_skip,
135 const std::vector<std::string>* map_suffixes_to_ignore) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700136 frames_.clear();
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800137 last_error_.code = ERROR_NONE;
138 last_error_.address = 0;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700139
Christopher Ferris4568f4b2018-10-23 17:42:41 -0700140 ArchEnum arch = regs_->Arch();
141
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700142 bool return_address_attempt = false;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700143 bool adjust_pc = false;
Christopher Ferris150db122017-12-20 18:49:01 -0800144 std::unique_ptr<JitDebug> jit_debug;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700145 for (; frames_.size() < max_frames_;) {
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700146 uint64_t cur_pc = regs_->pc();
147 uint64_t cur_sp = regs_->sp();
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700148
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700149 MapInfo* map_info = maps_->Find(regs_->pc());
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800150 uint64_t pc_adjustment = 0;
151 uint64_t step_pc;
Yabin Cuid5b22c52018-02-22 17:11:31 -0800152 uint64_t rel_pc;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700153 Elf* elf;
154 if (map_info == nullptr) {
Yabin Cuid5b22c52018-02-22 17:11:31 -0800155 step_pc = regs_->pc();
156 rel_pc = step_pc;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800157 last_error_.code = ERROR_INVALID_MAP;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700158 } else {
Christopher Ferrise69f4702017-10-19 16:08:58 -0700159 if (ShouldStop(map_suffixes_to_ignore, map_info->name)) {
160 break;
161 }
Christopher Ferris4568f4b2018-10-23 17:42:41 -0700162 elf = map_info->GetElf(process_memory_, arch);
Yabin Cuid5b22c52018-02-22 17:11:31 -0800163 step_pc = regs_->pc();
164 rel_pc = elf->GetRelPc(step_pc, map_info);
165 // Everyone except elf data in gdb jit debug maps uses the relative pc.
166 if (!(map_info->flags & MAPS_FLAGS_JIT_SYMFILE_MAP)) {
167 step_pc = rel_pc;
168 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800169 if (adjust_pc) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800170 pc_adjustment = regs_->GetPcAdjustment(rel_pc, elf);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800171 } else {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800172 pc_adjustment = 0;
Christopher Ferris150db122017-12-20 18:49:01 -0800173 }
Yabin Cuid5b22c52018-02-22 17:11:31 -0800174 step_pc -= pc_adjustment;
Christopher Ferris150db122017-12-20 18:49:01 -0800175
176 // If the pc is in an invalid elf file, try and get an Elf object
177 // using the jit debug information.
178 if (!elf->valid() && jit_debug_ != nullptr) {
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800179 uint64_t adjusted_jit_pc = regs_->pc() - pc_adjustment;
Christopher Ferris150db122017-12-20 18:49:01 -0800180 Elf* jit_elf = jit_debug_->GetElf(maps_, adjusted_jit_pc);
181 if (jit_elf != nullptr) {
182 // The jit debug information requires a non relative adjusted pc.
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800183 step_pc = adjusted_jit_pc;
Christopher Ferris150db122017-12-20 18:49:01 -0800184 elf = jit_elf;
185 }
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800186 }
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700187 }
188
189 if (map_info == nullptr || initial_map_names_to_skip == nullptr ||
Christopher Ferris1cb84ce2017-10-24 15:36:00 -0700190 std::find(initial_map_names_to_skip->begin(), initial_map_names_to_skip->end(),
191 basename(map_info->name.c_str())) == initial_map_names_to_skip->end()) {
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800192 if (regs_->dex_pc() != 0) {
193 // Add a frame to represent the dex file.
194 FillInDexFrame();
Christopher Ferrisa8c39732018-02-12 08:46:19 -0800195 // Clear the dex pc so that we don't repeat this frame later.
196 regs_->set_dex_pc(0);
Christopher Ferris9d0ad232018-10-12 16:33:42 -0700197
198 // Make sure there is enough room for the real frame.
199 if (frames_.size() == max_frames_) {
200 last_error_.code = ERROR_MAX_FRAMES_EXCEEDED;
201 break;
202 }
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800203 }
204
Christopher Ferrisa2ec50b2018-02-21 15:39:07 -0800205 FillInFrame(map_info, elf, rel_pc, step_pc, pc_adjustment);
Christopher Ferrisc3d79f72017-11-28 19:14:54 -0800206
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700207 // Once a frame is added, stop skipping frames.
208 initial_map_names_to_skip = nullptr;
209 }
210 adjust_pc = true;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700211
212 bool stepped;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700213 bool in_device_map = false;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700214 if (map_info == nullptr) {
215 stepped = false;
216 } else {
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700217 if (map_info->flags & MAPS_FLAGS_DEVICE_MAP) {
218 // Do not stop here, fall through in case we are
219 // in the speculative unwind path and need to remove
220 // some of the speculative frames.
221 stepped = false;
222 in_device_map = true;
223 } else {
224 MapInfo* sp_info = maps_->Find(regs_->sp());
225 if (sp_info != nullptr && sp_info->flags & MAPS_FLAGS_DEVICE_MAP) {
226 // Do not stop here, fall through in case we are
227 // in the speculative unwind path and need to remove
228 // some of the speculative frames.
229 stepped = false;
230 in_device_map = true;
231 } else {
232 bool finished;
Christopher Ferris239425b2018-05-17 18:37:38 -0700233 stepped = elf->Step(rel_pc, step_pc, regs_, process_memory_.get(), &finished);
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800234 elf->GetLastError(&last_error_);
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700235 if (stepped && finished) {
236 break;
237 }
238 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700239 }
240 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700241
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700242 if (!stepped) {
243 if (return_address_attempt) {
Christopher Ferris065f1562018-12-13 09:33:45 -0800244 // Only remove the speculative frame if there are more than two frames
245 // or the pc in the first frame is in a valid map.
246 // This allows for a case where the code jumps into the middle of
247 // nowhere, but there is no other unwind information after that.
248 if (frames_.size() != 2 || maps_->Find(frames_[0].pc) != nullptr) {
249 // Remove the speculative frame.
250 frames_.pop_back();
251 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700252 break;
Christopher Ferrisf6f691b2017-09-25 19:23:07 -0700253 } else if (in_device_map) {
254 // Do not attempt any other unwinding, pc or sp is in a device
255 // map.
256 break;
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700257 } else {
258 // Steping didn't work, try this secondary method.
259 if (!regs_->SetPcFromReturnAddress(process_memory_.get())) {
260 break;
261 }
262 return_address_attempt = true;
263 }
264 } else {
265 return_address_attempt = false;
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800266 if (max_frames_ == frames_.size()) {
267 last_error_.code = ERROR_MAX_FRAMES_EXCEEDED;
268 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700269 }
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700270
271 // If the pc and sp didn't change, then consider everything stopped.
272 if (cur_pc == regs_->pc() && cur_sp == regs_->sp()) {
Christopher Ferris2fcf4cf2018-01-23 17:52:23 -0800273 last_error_.code = ERROR_REPEATED_FRAME;
Christopher Ferrisfda7edd2017-10-31 16:10:42 -0700274 break;
275 }
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700276 }
277}
278
279std::string Unwinder::FormatFrame(size_t frame_num) {
280 if (frame_num >= frames_.size()) {
281 return "";
282 }
Christopher Ferris150db122017-12-20 18:49:01 -0800283 return FormatFrame(frames_[frame_num], regs_->Is32Bit());
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700284}
285
Christopher Ferris150db122017-12-20 18:49:01 -0800286std::string Unwinder::FormatFrame(const FrameData& frame, bool is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700287 std::string data;
288
Christopher Ferris150db122017-12-20 18:49:01 -0800289 if (is32bit) {
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700290 data += android::base::StringPrintf(" #%02zu pc %08" PRIx64, frame.num, frame.rel_pc);
291 } else {
292 data += android::base::StringPrintf(" #%02zu pc %016" PRIx64, frame.num, frame.rel_pc);
293 }
294
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700295 if (frame.map_start == frame.map_end) {
296 // No valid map associated with this frame.
297 data += " <unknown>";
298 } else if (!frame.map_name.empty()) {
299 data += " " + frame.map_name;
300 } else {
301 data += android::base::StringPrintf(" <anonymous:%" PRIx64 ">", frame.map_start);
302 }
Christopher Ferrisa09c4a62018-12-13 16:08:50 -0800303
304 if (frame.map_elf_start_offset != 0) {
305 data += android::base::StringPrintf(" (offset 0x%" PRIx64 ")", frame.map_elf_start_offset);
306 }
307
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700308 if (!frame.function_name.empty()) {
309 data += " (" + frame.function_name;
310 if (frame.function_offset != 0) {
311 data += android::base::StringPrintf("+%" PRId64, frame.function_offset);
312 }
313 data += ')';
314 }
315 return data;
316}
317
Christopher Ferris150db122017-12-20 18:49:01 -0800318void Unwinder::SetJitDebug(JitDebug* jit_debug, ArchEnum arch) {
319 jit_debug->SetArch(arch);
320 jit_debug_ = jit_debug;
321}
322
Christopher Ferrisd70ea5e2018-01-30 19:47:24 -0800323#if !defined(NO_LIBDEXFILE_SUPPORT)
324void Unwinder::SetDexFiles(DexFiles* dex_files, ArchEnum arch) {
325 dex_files->SetArch(arch);
326 dex_files_ = dex_files;
327}
328#endif
329
Christopher Ferrisb9de87f2017-09-20 13:37:24 -0700330} // namespace unwindstack