LLVM  13.0.0git
DWARFUnitIndex.h
Go to the documentation of this file.
1 //===- DWARFUnitIndex.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_DWARFUNITINDEX_H
10 #define LLVM_DEBUGINFO_DWARF_DWARFUNITINDEX_H
11 
12 #include "llvm/ADT/ArrayRef.h"
13 #include "llvm/ADT/StringRef.h"
15 #include <cstdint>
16 #include <memory>
17 
18 namespace llvm {
19 
20 class raw_ostream;
21 
22 /// The enum of section identifiers to be used in internal interfaces.
23 ///
24 /// Pre-standard implementation of package files defined a number of section
25 /// identifiers with values that clash definitions in the DWARFv5 standard.
26 /// See https://gcc.gnu.org/wiki/DebugFissionDWP and Section 7.3.5.3 in DWARFv5.
27 ///
28 /// The following identifiers are the same in the proposal and in DWARFv5:
29 /// - DW_SECT_INFO = 1 (.debug_info.dwo)
30 /// - DW_SECT_ABBREV = 3 (.debug_abbrev.dwo)
31 /// - DW_SECT_LINE = 4 (.debug_line.dwo)
32 /// - DW_SECT_STR_OFFSETS = 6 (.debug_str_offsets.dwo)
33 ///
34 /// The following identifiers are defined only in DWARFv5:
35 /// - DW_SECT_LOCLISTS = 5 (.debug_loclists.dwo)
36 /// - DW_SECT_RNGLISTS = 8 (.debug_rnglists.dwo)
37 ///
38 /// The following identifiers are defined only in the GNU proposal:
39 /// - DW_SECT_TYPES = 2 (.debug_types.dwo)
40 /// - DW_SECT_LOC = 5 (.debug_loc.dwo)
41 /// - DW_SECT_MACINFO = 7 (.debug_macinfo.dwo)
42 ///
43 /// DW_SECT_MACRO for the .debug_macro.dwo section is defined in both standards,
44 /// but with different values, 8 in GNU and 7 in DWARFv5.
45 ///
46 /// This enum defines constants to represent the identifiers of both sets.
47 /// For DWARFv5 ones, the values are the same as defined in the standard.
48 /// For pre-standard ones that correspond to sections being deprecated in
49 /// DWARFv5, the values are chosen arbitrary and a tag "_EXT_" is added to
50 /// the names.
51 ///
52 /// The enum is for internal use only. The user should not expect the values
53 /// to correspond to any input/output constants. Special conversion functions,
54 /// serializeSectionKind() and deserializeSectionKind(), should be used for
55 /// the translation.
57  /// Denotes a value read from an index section that does not correspond
58  /// to any of the supported standards.
60 #define HANDLE_DW_SECT(ID, NAME) DW_SECT_##NAME = ID,
61 #include "llvm/BinaryFormat/Dwarf.def"
65 };
66 
67 /// Convert the internal value for a section kind to an on-disk value.
68 ///
69 /// The conversion depends on the version of the index section.
70 /// IndexVersion is expected to be either 2 for pre-standard GNU proposal
71 /// or 5 for DWARFv5 package file.
72 uint32_t serializeSectionKind(DWARFSectionKind Kind, unsigned IndexVersion);
73 
74 /// Convert a value read from an index section to the internal representation.
75 ///
76 /// The conversion depends on the index section version, which is expected
77 /// to be either 2 for pre-standard GNU proposal or 5 for DWARFv5 package file.
79 
81  struct Header {
83  uint32_t NumColumns;
84  uint32_t NumUnits;
85  uint32_t NumBuckets = 0;
86 
87  bool parse(DataExtractor IndexData, uint64_t *OffsetPtr);
88  void dump(raw_ostream &OS) const;
89  };
90 
91 public:
92  class Entry {
93  public:
97  };
98 
99  private:
100  const DWARFUnitIndex *Index;
101  uint64_t Signature;
102  std::unique_ptr<SectionContribution[]> Contributions;
103  friend class DWARFUnitIndex;
104 
105  public:
107  const SectionContribution *getContribution() const;
108 
110  return Contributions.get();
111  }
112 
113  uint64_t getSignature() const { return Signature; }
114  };
115 
116 private:
117  struct Header Header;
118 
119  DWARFSectionKind InfoColumnKind;
120  int InfoColumn = -1;
121  std::unique_ptr<DWARFSectionKind[]> ColumnKinds;
122  // This is a parallel array of section identifiers as they read from the input
123  // file. The mapping from raw values to DWARFSectionKind is not revertable in
124  // case of unknown identifiers, so we keep them here.
125  std::unique_ptr<uint32_t[]> RawSectionIds;
126  std::unique_ptr<Entry[]> Rows;
127  mutable std::vector<Entry *> OffsetLookup;
128 
129  static StringRef getColumnHeader(DWARFSectionKind DS);
130 
131  bool parseImpl(DataExtractor IndexData);
132 
133 public:
135  : InfoColumnKind(InfoColumnKind) {}
136 
137  explicit operator bool() const { return Header.NumBuckets; }
138 
139  bool parse(DataExtractor IndexData);
140  void dump(raw_ostream &OS) const;
141 
142  uint32_t getVersion() const { return Header.Version; }
143 
144  const Entry *getFromOffset(uint32_t Offset) const;
145  const Entry *getFromHash(uint64_t Offset) const;
146 
148  return makeArrayRef(ColumnKinds.get(), Header.NumColumns);
149  }
150 
152  return makeArrayRef(Rows.get(), Header.NumBuckets);
153  }
154 };
155 
156 } // end namespace llvm
157 
158 #endif // LLVM_DEBUGINFO_DWARF_DWARFUNITINDEX_H
llvm
Definition: AllocatorList.h:23
llvm::DWARFUnitIndex::DWARFUnitIndex
DWARFUnitIndex(DWARFSectionKind InfoColumnKind)
Definition: DWARFUnitIndex.h:134
StringRef.h
llvm::DWARFUnitIndex::Entry::SectionContribution
Definition: DWARFUnitIndex.h:94
llvm::DW_SECT_EXT_unknown
@ DW_SECT_EXT_unknown
Denotes a value read from an index section that does not correspond to any of the supported standards...
Definition: DWARFUnitIndex.h:59
llvm::DWARFUnitIndex::Entry
Definition: DWARFUnitIndex.h:92
Offset
uint64_t Offset
Definition: ELFObjHandler.cpp:81
llvm::DWARFUnitIndex::dump
void dump(raw_ostream &OS) const
Definition: DWARFUnitIndex.cpp:214
llvm::serializeSectionKind
uint32_t serializeSectionKind(DWARFSectionKind Kind, unsigned IndexVersion)
Convert the internal value for a section kind to an on-disk value.
Definition: DWARFUnitIndex.cpp:41
llvm::DWARFUnitIndex::getFromHash
const Entry * getFromHash(uint64_t Offset) const
Definition: DWARFUnitIndex.cpp:284
llvm::DWARFSectionKind
DWARFSectionKind
The enum of section identifiers to be used in internal interfaces.
Definition: DWARFUnitIndex.h:56
llvm::DWARFUnitIndex
Definition: DWARFUnitIndex.h:80
llvm::DWARFUnitIndex::parse
bool parse(DataExtractor IndexData)
Definition: DWARFUnitIndex.cpp:118
llvm::DW_SECT_EXT_TYPES
@ DW_SECT_EXT_TYPES
Definition: DWARFUnitIndex.h:62
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::DWARFUnitIndex::getFromOffset
const Entry * getFromOffset(uint32_t Offset) const
Definition: DWARFUnitIndex.cpp:261
llvm::IndexedInstrProf::Version
const uint64_t Version
Definition: InstrProf.h:991
llvm::SIInstrFlags::DS
@ DS
Definition: SIDefines.h:52
llvm::lltok::Kind
Kind
Definition: LLToken.h:18
llvm::DW_SECT_EXT_LOC
@ DW_SECT_EXT_LOC
Definition: DWARFUnitIndex.h:63
ArrayRef.h
llvm::DWARFUnitIndex::Entry::SectionContribution::Length
uint32_t Length
Definition: DWARFUnitIndex.h:96
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
llvm::DWARFUnitIndex::Entry::getSignature
uint64_t getSignature() const
Definition: DWARFUnitIndex.h:113
uint32_t
llvm::DW_SECT_EXT_MACINFO
@ DW_SECT_EXT_MACINFO
Definition: DWARFUnitIndex.h:64
llvm::deserializeSectionKind
DWARFSectionKind deserializeSectionKind(uint32_t Value, unsigned IndexVersion)
Convert a value read from an index section to the internal representation.
Definition: DWARFUnitIndex.cpp:67
DataExtractor.h
llvm::TargetStackID::Value
Value
Definition: TargetFrameLowering.h:27
llvm::DWARFUnitIndex::getColumnKinds
ArrayRef< DWARFSectionKind > getColumnKinds() const
Definition: DWARFUnitIndex.h:147
llvm::DWARFUnitIndex::Entry::SectionContribution::Offset
uint32_t Offset
Definition: DWARFUnitIndex.h:95
llvm::makeArrayRef
ArrayRef< T > makeArrayRef(const T &OneElt)
Construct an ArrayRef from a single element.
Definition: ArrayRef.h:474
llvm::DWARFUnitIndex::Entry::getContributions
const SectionContribution * getContributions() const
Definition: DWARFUnitIndex.h:109
llvm::DWARFUnitIndex::getRows
ArrayRef< Entry > getRows() const
Definition: DWARFUnitIndex.h:151
llvm::DataExtractor
Definition: DataExtractor.h:41
llvm::DWARFUnitIndex::getVersion
uint32_t getVersion() const
Definition: DWARFUnitIndex.h:142
llvm::DWARFUnitIndex::Entry::getContribution
const SectionContribution * getContribution() const
Definition: DWARFUnitIndex.cpp:256