android_system_core/libunwindstack/include/unwindstack/Elf.h
Christopher Ferris 2fcf4cf13e Add error propagation into Unwinder/Elf objects.
The backtrace offline code uses these error codes to diagnose errors.
In addtion, I've had cases where seeing these errors would help diagnose
failures.

This also allows us to add a few features to indicate why an unwind
terminated (such as max frames exceeded).

Bug: 65682279

Test: Updated unit tests pass.
Change-Id: If82b5092698e8a194016d670efff1320f9b44d50
2018-01-24 17:50:46 -08:00

116 lines
2.8 KiB
C++

/*
* Copyright (C) 2016 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_ELF_H
#define _LIBUNWINDSTACK_ELF_H
#include <stddef.h>
#include <memory>
#include <mutex>
#include <string>
#include <unwindstack/ElfInterface.h>
#include <unwindstack/Memory.h>
#if !defined(EM_AARCH64)
#define EM_AARCH64 183
#endif
namespace unwindstack {
// Forward declaration.
struct MapInfo;
class Regs;
enum ArchEnum : uint8_t {
ARCH_UNKNOWN = 0,
ARCH_ARM,
ARCH_ARM64,
ARCH_X86,
ARCH_X86_64,
ARCH_MIPS,
ARCH_MIPS64,
};
class Elf {
public:
Elf(Memory* memory) : memory_(memory) {}
virtual ~Elf() = default;
bool Init(bool init_gnu_debugdata);
void InitGnuDebugdata();
bool GetSoname(std::string* name);
bool GetFunctionName(uint64_t addr, std::string* name, uint64_t* func_offset);
bool GetGlobalVariable(const std::string& name, uint64_t* memory_address);
uint64_t GetRelPc(uint64_t pc, const MapInfo* map_info);
bool Step(uint64_t rel_pc, uint64_t adjusted_rel_pc, uint64_t elf_offset, Regs* regs,
Memory* process_memory, bool* finished);
ElfInterface* CreateInterfaceFromMemory(Memory* memory);
uint64_t GetLoadBias() { return load_bias_; }
bool IsValidPc(uint64_t pc);
void GetLastError(ErrorData* data);
ErrorCode GetLastErrorCode();
uint64_t GetLastErrorAddress();
bool valid() { return valid_; }
uint32_t machine_type() { return machine_type_; }
uint8_t class_type() { return class_type_; }
ArchEnum arch() { return arch_; }
Memory* memory() { return memory_.get(); }
ElfInterface* interface() { return interface_.get(); }
ElfInterface* gnu_debugdata_interface() { return gnu_debugdata_interface_.get(); }
static bool IsValidElf(Memory* memory);
static void GetInfo(Memory* memory, bool* valid, uint64_t* size);
static uint64_t GetLoadBias(Memory* memory);
protected:
bool valid_ = false;
uint64_t load_bias_ = 0;
std::unique_ptr<ElfInterface> interface_;
std::unique_ptr<Memory> memory_;
uint32_t machine_type_;
uint8_t class_type_;
ArchEnum arch_;
// Protect calls that can modify internal state of the interface object.
std::mutex lock_;
std::unique_ptr<Memory> gnu_debugdata_memory_;
std::unique_ptr<ElfInterface> gnu_debugdata_interface_;
};
} // namespace unwindstack
#endif // _LIBUNWINDSTACK_ELF_H