mirror of
https://github.com/lief-project/LIEF
synced 2026-06-08 15:30:44 +00:00
Romain Thomas
80 lines
2.1 KiB
C++
80 lines
2.1 KiB
C++
/* Copyright 2022 - 2026 R. Thomas
|
|
*
|
|
* 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 LIEF_DEBUGINFO_H
|
|
#define LIEF_DEBUGINFO_H
|
|
#include <memory>
|
|
#include <cstdint>
|
|
#include <string>
|
|
|
|
#include "LIEF/visibility.h"
|
|
#include "LIEF/optional.hpp"
|
|
namespace LIEF {
|
|
|
|
class Binary;
|
|
|
|
namespace details {
|
|
class DebugInfo;
|
|
}
|
|
|
|
/// This class provides a generic interface for accessing debug information
|
|
/// from different formats such as DWARF and PDB.
|
|
///
|
|
/// Users can use this interface to access high-level debug features like
|
|
/// resolving function addresses.
|
|
///
|
|
/// See: LIEF::pdb::DebugInfo, LIEF::dwarf::DebugInfo
|
|
class LIEF_API DebugInfo {
|
|
public:
|
|
friend class Binary;
|
|
enum class FORMAT {
|
|
UNKNOWN = 0,
|
|
DWARF, PDB,
|
|
};
|
|
DebugInfo(std::unique_ptr<details::DebugInfo> impl);
|
|
|
|
virtual ~DebugInfo();
|
|
|
|
virtual FORMAT format() const {
|
|
return FORMAT::UNKNOWN;
|
|
}
|
|
|
|
/// This function can be used to **down cast** a DebugInfo instance:
|
|
///
|
|
/// ```cpp
|
|
/// std::unique_ptr<LIEF::Instruction> dbg = bin->debug_info();
|
|
/// if (const auto* dwarf = inst->as<LIEF::dwarf::DebugInfo>()) {
|
|
/// dwarf->find_function("main");
|
|
/// }
|
|
/// ```
|
|
template<class T>
|
|
const T* as() const {
|
|
static_assert(std::is_base_of<DebugInfo, T>::value,
|
|
"Require Instruction inheritance");
|
|
if (T::classof(this)) {
|
|
return static_cast<const T*>(this);
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
/// Attempt to resolve the address of the function specified by `name`.
|
|
virtual optional<uint64_t> find_function_address(const std::string& name) const = 0;
|
|
|
|
protected:
|
|
std::unique_ptr<details::DebugInfo> impl_;
|
|
};
|
|
|
|
}
|
|
#endif
|