blob: 6c82bbfe74f7b95eebd6ccf1540f5c68df9a55c0 [file] [log] [blame]
//===- DWARFDebugPubTable.h -------------------------------------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/STLFunctionalExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/BinaryFormat/Dwarf.h"
#include <cstdint>
#include <vector>
namespace llvm {
class raw_ostream;
class DWARFDataExtractor;
class Error;
/// Represents structure for holding and parsing .debug_pub* tables.
class DWARFDebugPubTable {
struct Entry {
/// Section offset from the beginning of the compilation unit.
uint64_t SecOffset;
/// An entry of the various gnu_pub* debug sections.
dwarf::PubIndexEntryDescriptor Descriptor;
/// The name of the object as given by the DW_AT_name attribute of the
/// referenced DIE.
StringRef Name;
/// Each table consists of sets of variable length entries. Each set describes
/// the names of global objects and functions, or global types, respectively,
/// whose definitions are represented by debugging information entries owned
/// by a single compilation unit.
struct Set {
/// The total length of the entries for that set, not including the length
/// field itself.
uint64_t Length;
/// The DWARF format of the set.
dwarf::DwarfFormat Format;
/// This number is specific to the name lookup table and is independent of
/// the DWARF version number.
uint16_t Version;
/// The offset from the beginning of the .debug_info section of the
/// compilation unit header referenced by the set.
uint64_t Offset;
/// The size in bytes of the contents of the .debug_info section generated
/// to represent that compilation unit.
uint64_t Size;
std::vector<Entry> Entries;
std::vector<Set> Sets;
/// gnu styled tables contains additional information.
/// This flag determines whether or not section we parse is debug_gnu* table.
bool GnuStyle = false;
DWARFDebugPubTable() = default;
void extract(DWARFDataExtractor Data, bool GnuStyle,
function_ref<void(Error)> RecoverableErrorHandler);
void dump(raw_ostream &OS) const;
ArrayRef<Set> getData() { return Sets; }
} // end namespace llvm