You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
215 lines
7.3 KiB
215 lines
7.3 KiB
/*
|
|
* 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/Arch.h>
|
|
#include <unwindstack/DexFiles.h>
|
|
#include <unwindstack/Error.h>
|
|
#include <unwindstack/JitDebug.h>
|
|
#include <unwindstack/Maps.h>
|
|
#include <unwindstack/Memory.h>
|
|
#include <unwindstack/Regs.h>
|
|
#include <unwindstack/SharedString.h>
|
|
|
|
namespace unwindstack {
|
|
|
|
// Forward declarations.
|
|
class Elf;
|
|
class ThreadEntry;
|
|
|
|
struct FrameData {
|
|
size_t num;
|
|
|
|
uint64_t rel_pc;
|
|
uint64_t pc;
|
|
uint64_t sp;
|
|
|
|
SharedString function_name;
|
|
uint64_t function_offset = 0;
|
|
|
|
SharedString map_name;
|
|
// The offset from the first map representing the frame. When there are
|
|
// two maps (read-only and read-execute) this will be the offset from
|
|
// the read-only map. When there is only one map, this will be the
|
|
// same as the actual offset of the map and match map_exact_offset.
|
|
uint64_t map_elf_start_offset = 0;
|
|
// The actual offset from the map where the pc lies.
|
|
uint64_t map_exact_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)
|
|
: max_frames_(max_frames),
|
|
maps_(maps),
|
|
regs_(regs),
|
|
process_memory_(process_memory),
|
|
arch_(regs->Arch()) {}
|
|
Unwinder(size_t max_frames, Maps* maps, std::shared_ptr<Memory> process_memory)
|
|
: max_frames_(max_frames), maps_(maps), process_memory_(process_memory) {}
|
|
|
|
virtual ~Unwinder() = default;
|
|
|
|
virtual 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() const { return frames_.size(); }
|
|
|
|
// Returns frames after unwinding.
|
|
// Intentionally mutable (which can be used to swap in reserved memory before unwinding).
|
|
std::vector<FrameData>& frames() { return frames_; }
|
|
|
|
std::vector<FrameData> ConsumeFrames() {
|
|
std::vector<FrameData> frames = std::move(frames_);
|
|
frames_.clear();
|
|
return frames;
|
|
}
|
|
|
|
std::string FormatFrame(size_t frame_num) const;
|
|
std::string FormatFrame(const FrameData& frame) const;
|
|
|
|
void SetArch(ArchEnum arch) { arch_ = arch; };
|
|
|
|
void SetJitDebug(JitDebug* jit_debug);
|
|
|
|
void SetRegs(Regs* regs) {
|
|
regs_ = regs;
|
|
arch_ = regs_ != nullptr ? regs->Arch() : ARCH_UNKNOWN;
|
|
}
|
|
Maps* GetMaps() { return maps_; }
|
|
std::shared_ptr<Memory>& GetProcessMemory() { return process_memory_; }
|
|
|
|
// 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; }
|
|
|
|
// Enable/disable soname printing the soname for a map name if the elf is
|
|
// embedded in a file. This is enabled by default.
|
|
// NOTE: This does nothing unless resolving names is enabled.
|
|
void SetEmbeddedSoname(bool embedded_soname) { embedded_soname_ = embedded_soname; }
|
|
|
|
void SetDisplayBuildID(bool display_build_id) { display_build_id_ = display_build_id; }
|
|
|
|
void SetDexFiles(DexFiles* dex_files);
|
|
|
|
bool elf_from_memory_not_file() { return elf_from_memory_not_file_; }
|
|
|
|
ErrorCode LastErrorCode() { return last_error_.code; }
|
|
const char* LastErrorCodeString() { return GetErrorCodeString(last_error_.code); }
|
|
uint64_t LastErrorAddress() { return last_error_.address; }
|
|
uint64_t warnings() { return warnings_; }
|
|
|
|
// Builds a frame for symbolization using the maps from this unwinder. The
|
|
// constructed frame contains just enough information to be used to symbolize
|
|
// frames collected by frame-pointer unwinding that's done outside of
|
|
// libunwindstack. This is used by tombstoned to symbolize frame pointer-based
|
|
// stack traces that are collected by tools such as GWP-ASan and MTE.
|
|
static FrameData BuildFrameFromPcOnly(uint64_t pc, ArchEnum arch, Maps* maps, JitDebug* jit_debug,
|
|
std::shared_ptr<Memory> process_memory, bool resolve_names);
|
|
FrameData BuildFrameFromPcOnly(uint64_t pc);
|
|
|
|
protected:
|
|
Unwinder(size_t max_frames, Maps* maps = nullptr) : max_frames_(max_frames), maps_(maps) {}
|
|
Unwinder(size_t max_frames, ArchEnum arch, Maps* maps = nullptr)
|
|
: max_frames_(max_frames), maps_(maps), arch_(arch) {}
|
|
|
|
void ClearErrors() {
|
|
warnings_ = WARNING_NONE;
|
|
last_error_.code = ERROR_NONE;
|
|
last_error_.address = 0;
|
|
}
|
|
|
|
void FillInDexFrame();
|
|
FrameData* FillInFrame(MapInfo* map_info, Elf* elf, uint64_t rel_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;
|
|
DexFiles* dex_files_ = nullptr;
|
|
bool resolve_names_ = true;
|
|
bool embedded_soname_ = true;
|
|
bool display_build_id_ = false;
|
|
// True if at least one elf file is coming from memory and not the related
|
|
// file. This is only true if there is an actual file backing up the elf.
|
|
bool elf_from_memory_not_file_ = false;
|
|
ErrorData last_error_;
|
|
uint64_t warnings_;
|
|
ArchEnum arch_ = ARCH_UNKNOWN;
|
|
};
|
|
|
|
class UnwinderFromPid : public Unwinder {
|
|
public:
|
|
UnwinderFromPid(size_t max_frames, pid_t pid, Maps* maps = nullptr)
|
|
: Unwinder(max_frames, maps), pid_(pid) {}
|
|
UnwinderFromPid(size_t max_frames, pid_t pid, ArchEnum arch, Maps* maps = nullptr)
|
|
: Unwinder(max_frames, arch, maps), pid_(pid) {}
|
|
virtual ~UnwinderFromPid() = default;
|
|
|
|
void SetProcessMemory(std::shared_ptr<Memory>& process_memory) {
|
|
process_memory_ = process_memory;
|
|
}
|
|
|
|
bool Init();
|
|
|
|
void Unwind(const std::vector<std::string>* initial_map_names_to_skip = nullptr,
|
|
const std::vector<std::string>* map_suffixes_to_ignore = nullptr) override;
|
|
|
|
protected:
|
|
pid_t pid_;
|
|
std::unique_ptr<Maps> maps_ptr_;
|
|
std::unique_ptr<JitDebug> jit_debug_ptr_;
|
|
std::unique_ptr<DexFiles> dex_files_ptr_;
|
|
bool initted_ = false;
|
|
};
|
|
|
|
class ThreadUnwinder : public UnwinderFromPid {
|
|
public:
|
|
ThreadUnwinder(size_t max_frames, Maps* maps = nullptr);
|
|
ThreadUnwinder(size_t max_frames, const ThreadUnwinder* unwinder);
|
|
virtual ~ThreadUnwinder() = default;
|
|
|
|
void SetObjects(ThreadUnwinder* unwinder);
|
|
|
|
void Unwind(const std::vector<std::string>*, const std::vector<std::string>*) override {}
|
|
|
|
void UnwindWithSignal(int signal, pid_t tid,
|
|
const std::vector<std::string>* initial_map_names_to_skip = nullptr,
|
|
const std::vector<std::string>* map_suffixes_to_ignore = nullptr);
|
|
|
|
protected:
|
|
ThreadEntry* SendSignalToThread(int signal, pid_t tid);
|
|
};
|
|
|
|
} // namespace unwindstack
|
|
|
|
#endif // _LIBUNWINDSTACK_UNWINDER_H
|