LLVM  13.0.0git
DWARFDebugPubTable.h
Go to the documentation of this file.
1 //===- DWARFDebugPubTable.h -------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_DEBUGINFO_DWARF_DWARFDEBUGPUBTABLE_H
10 #define LLVM_DEBUGINFO_DWARF_DWARFDEBUGPUBTABLE_H
11 
12 #include "llvm/ADT/ArrayRef.h"
13 #include "llvm/ADT/StringRef.h"
17 #include <cstdint>
18 #include <vector>
19 
20 namespace llvm {
21 
22 class raw_ostream;
23 
24 /// Represents structure for holding and parsing .debug_pub* tables.
26 public:
27  struct Entry {
28  /// Section offset from the beginning of the compilation unit.
29  uint64_t SecOffset;
30 
31  /// An entry of the various gnu_pub* debug sections.
33 
34  /// The name of the object as given by the DW_AT_name attribute of the
35  /// referenced DIE.
37  };
38 
39  /// Each table consists of sets of variable length entries. Each set describes
40  /// the names of global objects and functions, or global types, respectively,
41  /// whose definitions are represented by debugging information entries owned
42  /// by a single compilation unit.
43  struct Set {
44  /// The total length of the entries for that set, not including the length
45  /// field itself.
46  uint64_t Length;
47 
48  /// The DWARF format of the set.
50 
51  /// This number is specific to the name lookup table and is independent of
52  /// the DWARF version number.
54 
55  /// The offset from the beginning of the .debug_info section of the
56  /// compilation unit header referenced by the set.
57  uint64_t Offset;
58 
59  /// The size in bytes of the contents of the .debug_info section generated
60  /// to represent that compilation unit.
61  uint64_t Size;
62 
63  std::vector<Entry> Entries;
64  };
65 
66 private:
67  std::vector<Set> Sets;
68 
69  /// gnu styled tables contains additional information.
70  /// This flag determines whether or not section we parse is debug_gnu* table.
71  bool GnuStyle = false;
72 
73 public:
74  DWARFDebugPubTable() = default;
75 
76  void extract(DWARFDataExtractor Data, bool GnuStyle,
77  function_ref<void(Error)> RecoverableErrorHandler);
78 
79  void dump(raw_ostream &OS) const;
80 
81  ArrayRef<Set> getData() { return Sets; }
82 };
83 
84 } // end namespace llvm
85 
86 #endif // LLVM_DEBUGINFO_DWARF_DWARFDEBUGPUBTABLE_H
llvm
Definition: AllocatorList.h:23
llvm::DWARFDebugPubTable::Set
Each table consists of sets of variable length entries.
Definition: DWARFDebugPubTable.h:43
llvm::DWARFDebugPubTable::Set::Entries
std::vector< Entry > Entries
Definition: DWARFDebugPubTable.h:63
llvm::DWARFDebugPubTable::dump
void dump(raw_ostream &OS) const
Definition: DWARFDebugPubTable.cpp:93
StringRef.h
DWARFObject.h
llvm::DWARFDebugPubTable::Entry::Descriptor
dwarf::PubIndexEntryDescriptor Descriptor
An entry of the various gnu_pub* debug sections.
Definition: DWARFDebugPubTable.h:32
llvm::DWARFDebugPubTable::Entry
Definition: DWARFDebugPubTable.h:27
llvm::DWARFDataExtractor
A DataExtractor (typically for an in-memory copy of an object-file section) plus a relocation map for...
Definition: DWARFDataExtractor.h:21
llvm::Data
@ Data
Definition: SIMachineScheduler.h:56
llvm::DWARFDebugPubTable::Set::Offset
uint64_t Offset
The offset from the beginning of the .debug_info section of the compilation unit header referenced by...
Definition: DWARFDebugPubTable.h:57
llvm::DWARFDebugPubTable::DWARFDebugPubTable
DWARFDebugPubTable()=default
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:50
llvm::DWARFDebugPubTable::getData
ArrayRef< Set > getData()
Definition: DWARFDebugPubTable.h:81
llvm::dwarf::DwarfFormat
DwarfFormat
Constants that define the DWARF format as 32 or 64 bit.
Definition: Dwarf.h:92
llvm::DWARFDebugPubTable::Set::Length
uint64_t Length
The total length of the entries for that set, not including the length field itself.
Definition: DWARFDebugPubTable.h:46
llvm::function_ref
An efficient, type-erasing, non-owning reference to a callable.
Definition: STLExtras.h:168
llvm::DWARFDebugPubTable::Entry::Name
StringRef Name
The name of the object as given by the DW_AT_name attribute of the referenced DIE.
Definition: DWARFDebugPubTable.h:36
ArrayRef.h
llvm::DWARFDebugPubTable::Set::Size
uint64_t Size
The size in bytes of the contents of the .debug_info section generated to represent that compilation ...
Definition: DWARFDebugPubTable.h:61
llvm::ArrayRef
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: APInt.h:32
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:57
Dwarf.h
llvm::DWARFDebugPubTable::Entry::SecOffset
uint64_t SecOffset
Section offset from the beginning of the compilation unit.
Definition: DWARFDebugPubTable.h:29
llvm::DWARFDebugPubTable
Represents structure for holding and parsing .debug_pub* tables.
Definition: DWARFDebugPubTable.h:25
uint16_t
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
llvm::DWARFDebugPubTable::extract
void extract(DWARFDataExtractor Data, bool GnuStyle, function_ref< void(Error)> RecoverableErrorHandler)
Definition: DWARFDebugPubTable.cpp:22
llvm::dwarf::PubIndexEntryDescriptor
Describes an entry of the various gnu_pub* debug sections.
Definition: Dwarf.h:715
llvm::DWARFDebugPubTable::Set::Version
uint16_t Version
This number is specific to the name lookup table and is independent of the DWARF version number.
Definition: DWARFDebugPubTable.h:53
llvm::DWARFDebugPubTable::Set::Format
dwarf::DwarfFormat Format
The DWARF format of the set.
Definition: DWARFDebugPubTable.h:49
DWARFDataExtractor.h