| /* |
| * Copyright (C) 2017 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| #ifndef _LIBUNWINDSTACK_UNWINDER_H |
| #define _LIBUNWINDSTACK_UNWINDER_H |
| |
| #include <stdint.h> |
| #include <sys/types.h> |
| |
| #include <memory> |
| #include <string> |
| #include <vector> |
| |
| #include <unwindstack/Error.h> |
| #include <unwindstack/Maps.h> |
| #include <unwindstack/Memory.h> |
| #include <unwindstack/Regs.h> |
| |
| namespace unwindstack { |
| |
| // Forward declarations. |
| class DexFiles; |
| class Elf; |
| class JitDebug; |
| enum ArchEnum : uint8_t; |
| |
| struct FrameData { |
| size_t num; |
| |
| uint64_t rel_pc; |
| uint64_t pc; |
| uint64_t sp; |
| std::unique_ptr<Regs> regs; |
| |
| std::string function_name; |
| uint64_t function_offset = 0; |
| |
| std::string map_name; |
| uint64_t map_offset = 0; |
| uint64_t map_start = 0; |
| uint64_t map_end = 0; |
| uint64_t map_load_bias = 0; |
| int map_flags = 0; |
| }; |
| |
| class Unwinder { |
| public: |
| Unwinder(size_t max_frames, Maps* maps, Regs* regs, std::shared_ptr<Memory> process_memory) |
| : Unwinder(max_frames, maps, regs, process_memory, false) {} |
| Unwinder(size_t max_frames, Maps* maps, Regs* regs, std::shared_ptr<Memory> process_memory, bool save_regs) |
| : max_frames_(max_frames), maps_(maps), regs_(regs), process_memory_(process_memory), save_regs_(save_regs) { |
| frames_.reserve(max_frames); |
| } |
| ~Unwinder() = default; |
| |
| void Unwind(const std::vector<std::string>* initial_map_names_to_skip = nullptr, |
| const std::vector<std::string>* map_suffixes_to_ignore = nullptr); |
| |
| size_t NumFrames() { return frames_.size(); } |
| |
| const std::vector<FrameData>& frames() { return frames_; } |
| |
| std::string FormatFrame(size_t frame_num); |
| static std::string FormatFrame(const FrameData& frame, bool is32bit); |
| |
| void SetJitDebug(JitDebug* jit_debug, ArchEnum arch); |
| |
| // Disabling the resolving of names results in the function name being |
| // set to an empty string and the function offset being set to zero. |
| void SetResolveNames(bool resolve) { resolve_names_ = resolve; } |
| |
| #if !defined(NO_LIBDEXFILE_SUPPORT) |
| void SetDexFiles(DexFiles* dex_files, ArchEnum arch); |
| #endif |
| |
| ErrorCode LastErrorCode() { return last_error_.code; } |
| uint64_t LastErrorAddress() { return last_error_.address; } |
| |
| private: |
| void FillInDexFrame(); |
| void FillInFrame(MapInfo* map_info, Elf* elf, uint64_t rel_pc, uint64_t func_pc, |
| uint64_t pc_adjustment); |
| |
| size_t max_frames_; |
| Maps* maps_; |
| Regs* regs_; |
| std::vector<FrameData> frames_; |
| std::shared_ptr<Memory> process_memory_; |
| JitDebug* jit_debug_ = nullptr; |
| bool save_regs_ = false; |
| #if !defined(NO_LIBDEXFILE_SUPPORT) |
| DexFiles* dex_files_ = nullptr; |
| #endif |
| bool resolve_names_ = true; |
| ErrorData last_error_; |
| }; |
| |
| } // namespace unwindstack |
| |
| #endif // _LIBUNWINDSTACK_UNWINDER_H |