LLVM  15.0.0git
DWARFUnit.h
Go to the documentation of this file.
1 //===- DWARFUnit.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_DWARFUNIT_H
10 #define LLVM_DEBUGINFO_DWARF_DWARFUNIT_H
11 
12 #include "llvm/ADT/Optional.h"
13 #include "llvm/ADT/STLExtras.h"
14 #include "llvm/ADT/SmallVector.h"
15 #include "llvm/ADT/StringRef.h"
25 #include <cassert>
26 #include <cstddef>
27 #include <cstdint>
28 #include <map>
29 #include <memory>
30 #include <utility>
31 #include <vector>
32 
33 namespace llvm {
34 
35 class DWARFAbbreviationDeclarationSet;
36 class DWARFContext;
37 class DWARFDebugAbbrev;
38 class DWARFUnit;
39 class DWARFDebugRangeList;
40 class DWARFLocationTable;
41 class DWARFObject;
42 class raw_ostream;
43 struct DIDumpOptions;
44 struct DWARFSection;
45 
46 /// Base class describing the header of any kind of "unit." Some information
47 /// is specific to certain unit types. We separate this class out so we can
48 /// parse the header before deciding what specific kind of unit to construct.
50  // Offset within section.
51  uint64_t Offset = 0;
52  // Version, address size, and DWARF format.
53  dwarf::FormParams FormParams;
54  uint64_t Length = 0;
55  uint64_t AbbrOffset = 0;
56 
57  // For DWO units only.
58  const DWARFUnitIndex::Entry *IndexEntry = nullptr;
59 
60  // For type units only.
61  uint64_t TypeHash = 0;
62  uint64_t TypeOffset = 0;
63 
64  // For v5 split or skeleton compile units only.
65  Optional<uint64_t> DWOId;
66 
67  // Unit type as parsed, or derived from the section kind.
68  uint8_t UnitType = 0;
69 
70  // Size as parsed. uint8_t for compactness.
71  uint8_t Size = 0;
72 
73 public:
74  /// Parse a unit header from \p debug_info starting at \p offset_ptr.
75  /// Note that \p SectionKind is used as a hint to guess the unit type
76  /// for DWARF formats prior to DWARFv5. In DWARFv5 the unit type is
77  /// explicitly defined in the header and the hint is ignored.
78  bool extract(DWARFContext &Context, const DWARFDataExtractor &debug_info,
80  // For units in DWARF Package File, remember the index entry and update
81  // the abbreviation offset read by extract().
82  bool applyIndexEntry(const DWARFUnitIndex::Entry *Entry);
83  uint64_t getOffset() const { return Offset; }
84  const dwarf::FormParams &getFormParams() const { return FormParams; }
85  uint16_t getVersion() const { return FormParams.Version; }
86  dwarf::DwarfFormat getFormat() const { return FormParams.Format; }
87  uint8_t getAddressByteSize() const { return FormParams.AddrSize; }
88  uint8_t getRefAddrByteSize() const { return FormParams.getRefAddrByteSize(); }
89  uint8_t getDwarfOffsetByteSize() const {
90  return FormParams.getDwarfOffsetByteSize();
91  }
92  uint64_t getLength() const { return Length; }
93  uint64_t getAbbrOffset() const { return AbbrOffset; }
94  Optional<uint64_t> getDWOId() const { return DWOId; }
96  assert((!DWOId || *DWOId == Id) && "setting DWOId to a different value");
97  DWOId = Id;
98  }
99  const DWARFUnitIndex::Entry *getIndexEntry() const { return IndexEntry; }
100  uint64_t getTypeHash() const { return TypeHash; }
101  uint64_t getTypeOffset() const { return TypeOffset; }
102  uint8_t getUnitType() const { return UnitType; }
103  bool isTypeUnit() const {
104  return UnitType == dwarf::DW_UT_type || UnitType == dwarf::DW_UT_split_type;
105  }
106  uint8_t getSize() const { return Size; }
107  uint8_t getUnitLengthFieldByteSize() const {
108  return dwarf::getUnitLengthFieldByteSize(FormParams.Format);
109  }
111  return Offset + Length + getUnitLengthFieldByteSize();
112  }
113 };
114 
115 const DWARFUnitIndex &getDWARFUnitIndex(DWARFContext &Context,
117 
118 bool isCompileUnit(const std::unique_ptr<DWARFUnit> &U);
119 
120 /// Describe a collection of units. Intended to hold all units either from
121 /// .debug_info and .debug_types, or from .debug_info.dwo and .debug_types.dwo.
122 class DWARFUnitVector final : public SmallVector<std::unique_ptr<DWARFUnit>, 1> {
123  std::function<std::unique_ptr<DWARFUnit>(uint64_t, DWARFSectionKind,
124  const DWARFSection *,
125  const DWARFUnitIndex::Entry *)>
126  Parser;
127  int NumInfoUnits = -1;
128 
129 public:
131  using iterator = typename UnitVector::iterator;
133 
134  using compile_unit_range =
135  decltype(make_filter_range(std::declval<iterator_range>(), isCompileUnit));
136 
137  DWARFUnit *getUnitForOffset(uint64_t Offset) const;
139 
140  /// Read units from a .debug_info or .debug_types section. Calls made
141  /// before finishedInfoUnits() are assumed to be for .debug_info sections,
142  /// calls after finishedInfoUnits() are for .debug_types sections. Caller
143  /// must not mix calls to addUnitsForSection and addUnitsForDWOSection.
144  void addUnitsForSection(DWARFContext &C, const DWARFSection &Section,
146  /// Read units from a .debug_info.dwo or .debug_types.dwo section. Calls
147  /// made before finishedInfoUnits() are assumed to be for .debug_info.dwo
148  /// sections, calls after finishedInfoUnits() are for .debug_types.dwo
149  /// sections. Caller must not mix calls to addUnitsForSection and
150  /// addUnitsForDWOSection.
151  void addUnitsForDWOSection(DWARFContext &C, const DWARFSection &DWOSection,
152  DWARFSectionKind SectionKind, bool Lazy = false);
153 
154  /// Add an existing DWARFUnit to this UnitVector. This is used by the DWARF
155  /// verifier to process unit separately.
156  DWARFUnit *addUnit(std::unique_ptr<DWARFUnit> Unit);
157 
158  /// Returns number of all units held by this instance.
159  unsigned getNumUnits() const { return size(); }
160  /// Returns number of units from all .debug_info[.dwo] sections.
161  unsigned getNumInfoUnits() const {
162  return NumInfoUnits == -1 ? size() : NumInfoUnits;
163  }
164  /// Returns number of units from all .debug_types[.dwo] sections.
165  unsigned getNumTypesUnits() const { return size() - NumInfoUnits; }
166  /// Indicate that parsing .debug_info[.dwo] is done, and remaining units
167  /// will be from .debug_types[.dwo].
168  void finishedInfoUnits() { NumInfoUnits = size(); }
169 
170 private:
171  void addUnitsImpl(DWARFContext &Context, const DWARFObject &Obj,
172  const DWARFSection &Section, const DWARFDebugAbbrev *DA,
173  const DWARFSection *RS, const DWARFSection *LocSection,
174  StringRef SS, const DWARFSection &SOS,
175  const DWARFSection *AOS, const DWARFSection &LS, bool LE,
176  bool IsDWO, bool Lazy, DWARFSectionKind SectionKind);
177 };
178 
179 /// Represents base address of the CU.
180 /// Represents a unit's contribution to the string offsets table.
183  /// The contribution size not including the header.
185  /// Format and version.
187 
189  uint8_t Version, dwarf::DwarfFormat Format)
190  : Base(Base), Size(Size), FormParams({Version, 0, Format}) {}
192 
193  uint8_t getVersion() const { return FormParams.Version; }
195  uint8_t getDwarfOffsetByteSize() const {
197  }
198  /// Determine whether a contribution to the string offsets table is
199  /// consistent with the relevant section size and that its length is
200  /// a multiple of the size of one of its entries.
203 };
204 
205 class DWARFUnit {
206  DWARFContext &Context;
207  /// Section containing this DWARFUnit.
208  const DWARFSection &InfoSection;
209 
210  DWARFUnitHeader Header;
211  const DWARFDebugAbbrev *Abbrev;
212  const DWARFSection *RangeSection;
213  uint64_t RangeSectionBase;
214  uint64_t LocSectionBase;
215 
216  /// Location table of this unit.
217  std::unique_ptr<DWARFLocationTable> LocTable;
218 
219  const DWARFSection &LineSection;
220  StringRef StringSection;
221  const DWARFSection &StringOffsetSection;
222  const DWARFSection *AddrOffsetSection;
223  DWARFUnit *SU;
224  Optional<uint64_t> AddrOffsetSectionBase;
225  bool isLittleEndian;
226  bool IsDWO;
227  const DWARFUnitVector &UnitVector;
228 
229  /// Start, length, and DWARF format of the unit's contribution to the string
230  /// offsets table (DWARF v5).
231  Optional<StrOffsetsContributionDescriptor> StringOffsetsTableContribution;
232 
233  mutable const DWARFAbbreviationDeclarationSet *Abbrevs;
235  /// The compile unit debug information entry items.
236  std::vector<DWARFDebugInfoEntry> DieArray;
237 
238  /// Map from range's start address to end address and corresponding DIE.
239  /// IntervalMap does not support range removal, as a result, we use the
240  /// std::map::upper_bound for address range lookup.
241  std::map<uint64_t, std::pair<uint64_t, DWARFDie>> AddrDieMap;
242 
243  using die_iterator_range =
245 
246  std::shared_ptr<DWARFUnit> DWO;
247 
248  uint32_t getDIEIndex(const DWARFDebugInfoEntry *Die) {
249  auto First = DieArray.data();
250  assert(Die >= First && Die < First + DieArray.size());
251  return Die - First;
252  }
253 
254 protected:
255  const DWARFUnitHeader &getHeader() const { return Header; }
256 
257  /// Find the unit's contribution to the string offsets table and determine its
258  /// length and form. The given offset is expected to be derived from the unit
259  /// DIE's DW_AT_str_offsets_base attribute.
262 
263  /// Find the unit's contribution to the string offsets table and determine its
264  /// length and form. The given offset is expected to be 0 in a dwo file or,
265  /// in a dwp file, the start of the unit's contribution to the string offsets
266  /// table section (as determined by the index table).
269 
270 public:
271  DWARFUnit(DWARFContext &Context, const DWARFSection &Section,
272  const DWARFUnitHeader &Header, const DWARFDebugAbbrev *DA,
273  const DWARFSection *RS, const DWARFSection *LocSection,
274  StringRef SS, const DWARFSection &SOS, const DWARFSection *AOS,
275  const DWARFSection &LS, bool LE, bool IsDWO,
276  const DWARFUnitVector &UnitVector);
277 
278  virtual ~DWARFUnit();
279 
280  bool isDWOUnit() const { return IsDWO; }
281  DWARFContext& getContext() const { return Context; }
282  const DWARFSection &getInfoSection() const { return InfoSection; }
283  uint64_t getOffset() const { return Header.getOffset(); }
285  return Header.getFormParams();
286  }
287  uint16_t getVersion() const { return Header.getVersion(); }
288  uint8_t getAddressByteSize() const { return Header.getAddressByteSize(); }
289  uint8_t getRefAddrByteSize() const { return Header.getRefAddrByteSize(); }
290  uint8_t getDwarfOffsetByteSize() const {
291  return Header.getDwarfOffsetByteSize();
292  }
293  /// Size in bytes of the parsed unit header.
294  uint32_t getHeaderSize() const { return Header.getSize(); }
295  uint64_t getLength() const { return Header.getLength(); }
296  dwarf::DwarfFormat getFormat() const { return Header.getFormat(); }
297  uint8_t getUnitType() const { return Header.getUnitType(); }
298  bool isTypeUnit() const { return Header.isTypeUnit(); }
299  uint64_t getAbbrOffset() const { return Header.getAbbrOffset(); }
300  uint64_t getNextUnitOffset() const { return Header.getNextUnitOffset(); }
301  const DWARFSection &getLineSection() const { return LineSection; }
302  StringRef getStringSection() const { return StringSection; }
304  return StringOffsetSection;
305  }
306 
307  void setSkeletonUnit(DWARFUnit *SU) { this->SU = SU; }
308  // Returns itself if not using Split DWARF, or if the unit is a skeleton unit
309  // - otherwise returns the split full unit's corresponding skeleton, if
310  // available.
311  DWARFUnit *getLinkedUnit() { return IsDWO ? SU : this; }
312 
314  AddrOffsetSection = AOS;
315  AddrOffsetSectionBase = Base;
316  }
317 
319  return AddrOffsetSectionBase;
320  }
321 
322  /// Recursively update address to Die map.
323  void updateAddressDieMap(DWARFDie Die);
324 
326  RangeSection = RS;
327  RangeSectionBase = Base;
328  }
329 
331  return LocSectionBase;
332  }
333 
335  getAddrOffsetSectionItem(uint32_t Index) const;
337 
339 
341  return DataExtractor(StringSection, false, 0);
342  }
343 
344  const DWARFLocationTable &getLocationTable() { return *LocTable; }
345 
346  /// Extract the range list referenced by this compile unit from the
347  /// .debug_ranges section. If the extraction is unsuccessful, an error
348  /// is returned. Successful extraction requires that the compile unit
349  /// has already been extracted.
350  Error extractRangeList(uint64_t RangeListOffset,
351  DWARFDebugRangeList &RangeList) const;
352  void clear();
353 
356  return StringOffsetsTableContribution;
357  }
358 
360  assert(StringOffsetsTableContribution);
361  return StringOffsetsTableContribution->getDwarfOffsetByteSize();
362  }
363 
365  assert(StringOffsetsTableContribution);
366  return StringOffsetsTableContribution->Base;
367  }
368 
369  uint64_t getAbbreviationsOffset() const { return Header.getAbbrOffset(); }
370 
372 
373  static bool isMatchingUnitTypeAndTag(uint8_t UnitType, dwarf::Tag Tag) {
374  switch (UnitType) {
375  case dwarf::DW_UT_compile:
376  return Tag == dwarf::DW_TAG_compile_unit;
377  case dwarf::DW_UT_type:
378  return Tag == dwarf::DW_TAG_type_unit;
379  case dwarf::DW_UT_partial:
380  return Tag == dwarf::DW_TAG_partial_unit;
381  case dwarf::DW_UT_skeleton:
382  return Tag == dwarf::DW_TAG_skeleton_unit;
383  case dwarf::DW_UT_split_compile:
384  case dwarf::DW_UT_split_type:
385  return dwarf::isUnitType(Tag);
386  }
387  return false;
388  }
389 
391 
392  DWARFDie getUnitDIE(bool ExtractUnitDIEOnly = true) {
393  extractDIEsIfNeeded(ExtractUnitDIEOnly);
394  if (DieArray.empty())
395  return DWARFDie();
396  return DWARFDie(this, &DieArray[0]);
397  }
398 
399  DWARFDie getNonSkeletonUnitDIE(bool ExtractUnitDIEOnly = true) {
400  parseDWO();
401  if (DWO)
402  return DWO->getUnitDIE(ExtractUnitDIEOnly);
403  return getUnitDIE(ExtractUnitDIEOnly);
404  }
405 
406  const char *getCompilationDir();
408  extractDIEsIfNeeded(/*CUDieOnly*/ true);
409  return getHeader().getDWOId();
410  }
411  void setDWOId(uint64_t NewID) { Header.setDWOId(NewID); }
412 
413  /// Return a vector of address ranges resulting from a (possibly encoded)
414  /// range list starting at a given offset in the appropriate ranges section.
416 
417  /// Return a vector of address ranges retrieved from an encoded range
418  /// list whose offset is found via a table lookup given an index (DWARF v5
419  /// and later).
421 
422  /// Return a rangelist's offset based on an index. The index designates
423  /// an entry in the rangelist table's offset array and is supplied by
424  /// DW_FORM_rnglistx.
426 
428 
430 
433 
434  /// Returns subprogram DIE with address range encompassing the provided
435  /// address. The pointer is alive as long as parsed compile unit DIEs are not
436  /// cleared.
438 
439  /// getInlinedChainForAddress - fetches inlined chain for a given address.
440  /// Returns empty chain if there is no subprogram containing address. The
441  /// chain is valid as long as parsed compile unit DIEs are not cleared.
442  void getInlinedChainForAddress(uint64_t Address,
443  SmallVectorImpl<DWARFDie> &InlinedChain);
444 
445  /// Return the DWARFUnitVector containing this unit.
446  const DWARFUnitVector &getUnitVector() const { return UnitVector; }
447 
448  /// Returns the number of DIEs in the unit. Parses the unit
449  /// if necessary.
450  unsigned getNumDIEs() {
451  extractDIEsIfNeeded(false);
452  return DieArray.size();
453  }
454 
455  /// Return the index of a DIE inside the unit's DIE vector.
456  ///
457  /// It is illegal to call this method with a DIE that hasn't be
458  /// created by this unit. In other word, it's illegal to call this
459  /// method on a DIE that isn't accessible by following
460  /// children/sibling links starting from this unit's getUnitDIE().
462  return getDIEIndex(D.getDebugInfoEntry());
463  }
464 
465  /// Return the DIE object at the given index.
466  DWARFDie getDIEAtIndex(unsigned Index) {
467  assert(Index < DieArray.size());
468  return DWARFDie(this, &DieArray[Index]);
469  }
470 
476 
477  /// Return the DIE object for a given offset inside the
478  /// unit's DIE vector.
479  ///
480  /// The unit needs to have its DIEs extracted for this method to work.
482  extractDIEsIfNeeded(false);
483  auto It =
484  llvm::partition_point(DieArray, [=](const DWARFDebugInfoEntry &DIE) {
485  return DIE.getOffset() < Offset;
486  });
487  if (It != DieArray.end() && It->getOffset() == Offset)
488  return DWARFDie(this, &*It);
489  return DWARFDie();
490  }
491 
493  if (auto IndexEntry = Header.getIndexEntry())
494  if (const auto *Contrib = IndexEntry->getContribution(DW_SECT_LINE))
495  return Contrib->Offset;
496  return 0;
497  }
498 
500  extractDIEsIfNeeded(false);
501  return die_iterator_range(DieArray.begin(), DieArray.end());
502  }
503 
504  virtual void dump(raw_ostream &OS, DIDumpOptions DumpOpts) = 0;
505 
506  Error tryExtractDIEsIfNeeded(bool CUDieOnly);
507 
508 private:
509  /// Size in bytes of the .debug_info data associated with this compile unit.
510  size_t getDebugInfoSize() const {
511  return Header.getLength() + Header.getUnitLengthFieldByteSize() -
512  getHeaderSize();
513  }
514 
515  /// extractDIEsIfNeeded - Parses a compile unit and indexes its DIEs if it
516  /// hasn't already been done
517  void extractDIEsIfNeeded(bool CUDieOnly);
518 
519  /// extractDIEsToVector - Appends all parsed DIEs to a vector.
520  void extractDIEsToVector(bool AppendCUDie, bool AppendNonCUDIEs,
521  std::vector<DWARFDebugInfoEntry> &DIEs) const;
522 
523  /// clearDIEs - Clear parsed DIEs to keep memory usage low.
524  void clearDIEs(bool KeepCUDie);
525 
526  /// parseDWO - Parses .dwo file for current compile unit. Returns true if
527  /// it was actually constructed.
528  bool parseDWO();
529 };
530 
531 inline bool isCompileUnit(const std::unique_ptr<DWARFUnit> &U) {
532  return !U->isTypeUnit();
533 }
534 
535 } // end namespace llvm
536 
537 #endif // LLVM_DEBUGINFO_DWARF_DWARFUNIT_H
llvm::DWARFDebugRangeList
Definition: DWARFDebugRangeList.h:24
llvm::DWARFSection
Definition: DWARFSection.h:16
llvm::DWARFUnit::getAbbreviations
const DWARFAbbreviationDeclarationSet * getAbbreviations() const
Definition: DWARFUnit.cpp:879
llvm::DWARFUnit::findRnglistFromIndex
Expected< DWARFAddressRangesVector > findRnglistFromIndex(uint32_t Index)
Return a vector of address ranges retrieved from an encoded range list whose offset is found via a ta...
Definition: DWARFUnit.cpp:656
llvm::DWARFUnit::getFirstChild
DWARFDie getFirstChild(const DWARFDebugInfoEntry *Die)
Definition: DWARFUnit.cpp:835
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:17
llvm::DWARFUnitHeader::getLength
uint64_t getLength() const
Definition: DWARFUnit.h:92
llvm::DWARFUnit::getStringSection
StringRef getStringSection() const
Definition: DWARFUnit.h:302
Optional.h
llvm::DWARFUnit::getRnglistOffset
Optional< uint64_t > getRnglistOffset(uint32_t Index)
Return a rangelist's offset based on an index.
Definition: DWARFUnit.cpp:1024
StringRef.h
llvm::X86AS::SS
@ SS
Definition: X86.h:189
llvm::SmallVector
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1185
llvm::DWARFUnit::getStringExtractor
DataExtractor getStringExtractor() const
Definition: DWARFUnit.h:340
llvm::DWARFLocationTable
An abstract base class for various kinds of location tables (.debug_loc, .debug_loclists,...
Definition: DWARFDebugLoc.h:50
llvm::DWARFUnitVector::addUnitsForSection
void addUnitsForSection(DWARFContext &C, const DWARFSection &Section, DWARFSectionKind SectionKind)
Read units from a .debug_info or .debug_types section.
Definition: DWARFUnit.cpp:39
llvm::DWARFUnitVector::addUnitsForDWOSection
void addUnitsForDWOSection(DWARFContext &C, const DWARFSection &DWOSection, DWARFSectionKind SectionKind, bool Lazy=false)
Read units from a .debug_info.dwo or .debug_types.dwo section.
Definition: DWARFUnit.cpp:50
llvm::DWARFContext
DWARFContext This data structure is the top level entity that deals with dwarf debug information pars...
Definition: DWARFContext.h:47
llvm::StrOffsetsContributionDescriptor::validateContributionSize
Expected< StrOffsetsContributionDescriptor > validateContributionSize(DWARFDataExtractor &DA)
Determine whether a contribution to the string offsets table is consistent with the relevant section ...
Definition: DWARFUnit.cpp:896
llvm::StrOffsetsContributionDescriptor::Base
uint64_t Base
Definition: DWARFUnit.h:182
DWARFAddressRange.h
llvm::dwarf::FormParams::AddrSize
uint8_t AddrSize
Definition: Dwarf.h:655
llvm::DWARFUnitIndex::Entry
Definition: DWARFUnitIndex.h:111
llvm::Optional< uint64_t >
llvm::DIE
A structured debug information entry.
Definition: DIE.h:739
llvm::Expected
Tagged union holding either a T or a Error.
Definition: APFloat.h:41
llvm::StrOffsetsContributionDescriptor::getVersion
uint8_t getVersion() const
Definition: DWARFUnit.h:193
llvm::DWARFUnit::getUnitVector
const DWARFUnitVector & getUnitVector() const
Return the DWARFUnitVector containing this unit.
Definition: DWARFUnit.h:446
llvm::DWARFDebugInfoEntry
DWARFDebugInfoEntry - A DIE with only the minimum required data.
Definition: DWARFDebugInfoEntry.h:22
STLExtras.h
llvm::DWARFUnit::getFormParams
const dwarf::FormParams & getFormParams() const
Definition: DWARFUnit.h:284
llvm::DWARFUnit::getLength
uint64_t getLength() const
Definition: DWARFUnit.h:295
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::dwarf::Tag
Tag
Definition: Dwarf.h:105
llvm::DWARFUnitVector::getNumTypesUnits
unsigned getNumTypesUnits() const
Returns number of units from all .debug_types[.dwo] sections.
Definition: DWARFUnit.h:165
llvm::StrOffsetsContributionDescriptor::Size
uint64_t Size
The contribution size not including the header.
Definition: DWARFUnit.h:184
llvm::dwarf::FormParams::Format
DwarfFormat Format
Definition: Dwarf.h:656
llvm::dwarf::isUnitType
bool isUnitType(uint8_t UnitType)
Definition: Dwarf.h:479
llvm::DWARFUnit::isDWOUnit
bool isDWOUnit() const
Definition: DWARFUnit.h:280
llvm::DWARFUnitHeader::getFormat
dwarf::DwarfFormat getFormat() const
Definition: DWARFUnit.h:86
llvm::DWARFUnit::getAddrOffsetSectionItem
Optional< object::SectionedAddress > getAddrOffsetSectionItem(uint32_t Index) const
Definition: DWARFUnit.cpp:205
llvm::DWARFUnit::getAbbrOffset
uint64_t getAbbrOffset() const
Definition: DWARFUnit.h:299
llvm::DWARFUnit::getUnitType
uint8_t getUnitType() const
Definition: DWARFUnit.h:297
llvm::DWARFUnit::getLoclistOffset
Optional< uint64_t > getLoclistOffset(uint32_t Index)
Definition: DWARFUnit.cpp:1035
llvm::DWARFUnitHeader::getDwarfOffsetByteSize
uint8_t getDwarfOffsetByteSize() const
Definition: DWARFUnit.h:89
Context
LLVMContext & Context
Definition: NVVMIntrRange.cpp:66
llvm::DWARFUnit::getUnitDIE
DWARFDie getUnitDIE(bool ExtractUnitDIEOnly=true)
Definition: DWARFUnit.h:392
llvm::StrOffsetsContributionDescriptor::getFormat
dwarf::DwarfFormat getFormat() const
Definition: DWARFUnit.h:194
llvm::DWARFUnit::getNumDIEs
unsigned getNumDIEs()
Returns the number of DIEs in the unit.
Definition: DWARFUnit.h:450
llvm::DWARFUnit::getDWOId
Optional< uint64_t > getDWOId()
Definition: DWARFUnit.h:407
llvm::DWARFUnitHeader::getRefAddrByteSize
uint8_t getRefAddrByteSize() const
Definition: DWARFUnit.h:88
llvm::DWARFUnitVector::getNumInfoUnits
unsigned getNumInfoUnits() const
Returns number of units from all .debug_info[.dwo] sections.
Definition: DWARFUnit.h:161
E
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
llvm::DWARFUnit::determineStringOffsetsTableContribution
Expected< Optional< StrOffsetsContributionDescriptor > > determineStringOffsetsTableContribution(DWARFDataExtractor &DA)
Find the unit's contribution to the string offsets table and determine its length and form.
Definition: DWARFUnit.cpp:975
C
(vector float) vec_cmpeq(*A, *B) C
Definition: README_ALTIVEC.txt:86
llvm::DWARFDebugAbbrev
Definition: DWARFDebugAbbrev.h:56
llvm::StrOffsetsContributionDescriptor
Represents base address of the CU.
Definition: DWARFUnit.h:181
llvm::DWARFSectionKind
DWARFSectionKind
The enum of section identifiers to be used in internal interfaces.
Definition: DWARFUnitIndex.h:56
DWARFDie.h
First
into llvm powi allowing the code generator to produce balanced multiplication trees First
Definition: README.txt:54
llvm::DWARFUnitHeader::setDWOId
void setDWOId(uint64_t Id)
Definition: DWARFUnit.h:95
llvm::DWARFUnitHeader::isTypeUnit
bool isTypeUnit() const
Definition: DWARFUnit.h:103
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:54
llvm::DWARFUnit::setSkeletonUnit
void setSkeletonUnit(DWARFUnit *SU)
Definition: DWARFUnit.h:307
llvm::DWARFObject
Definition: DWARFObject.h:25
llvm::AArch64CC::LE
@ LE
Definition: AArch64BaseInfo.h:268
llvm::DWARFUnit::dump
virtual void dump(raw_ostream &OS, DIDumpOptions DumpOpts)=0
llvm::DWARFUnit::getLineTableOffset
uint32_t getLineTableOffset() const
Definition: DWARFUnit.h:492
llvm::DWARFUnit::getLineSection
const DWARFSection & getLineSection() const
Definition: DWARFUnit.h:301
llvm::dwarf::DwarfFormat
DwarfFormat
Constants that define the DWARF format as 32 or 64 bit.
Definition: Dwarf.h:93
llvm::lltok::Kind
Kind
Definition: LLToken.h:18
llvm::DWARFUnit::updateAddressDieMap
void updateAddressDieMap(DWARFDie Die)
Recursively update address to Die map.
Definition: DWARFUnit.cpp:704
llvm::DWARFUnit::getParent
DWARFDie getParent(const DWARFDebugInfoEntry *Die)
Definition: DWARFUnit.cpp:779
llvm::DWARFUnit::setDWOId
void setDWOId(uint64_t NewID)
Definition: DWARFUnit.h:411
llvm::DWARFUnit::getSubroutineForAddress
DWARFDie getSubroutineForAddress(uint64_t Address)
Returns subprogram DIE with address range encompassing the provided address.
Definition: DWARFUnit.cpp:735
llvm::DWARFAbbreviationDeclarationSet
Definition: DWARFDebugAbbrev.h:22
llvm::DWARFUnitVector::iterator
typename UnitVector::iterator iterator
Definition: DWARFUnit.h:131
llvm::DWARFUnit::~DWARFUnit
virtual ~DWARFUnit()
llvm::DWARFUnit::getDebugInfoExtractor
DWARFDataExtractor getDebugInfoExtractor() const
Definition: DWARFUnit.cpp:199
llvm::DWARFUnit::isMatchingUnitTypeAndTag
static bool isMatchingUnitTypeAndTag(uint8_t UnitType, dwarf::Tag Tag)
Definition: DWARFUnit.h:373
llvm::DWARFUnit::collectAddressRanges
Expected< DWARFAddressRangesVector > collectAddressRanges()
Definition: DWARFUnit.cpp:666
llvm::DWARFUnit::getStringOffsetsTableContribution
const Optional< StrOffsetsContributionDescriptor > & getStringOffsetsTableContribution() const
Definition: DWARFUnit.h:355
llvm::DWARFUnit::findLoclistFromOffset
Expected< DWARFLocationExpressionsVector > findLoclistFromOffset(uint64_t Offset)
Definition: DWARFUnit.cpp:681
llvm::DWARFUnit::getLinkedUnit
DWARFUnit * getLinkedUnit()
Definition: DWARFUnit.h:311
uint64_t
llvm::DWARFUnitHeader::getSize
uint8_t getSize() const
Definition: DWARFUnit.h:106
D
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
llvm::DWARFUnit::isTypeUnit
bool isTypeUnit() const
Definition: DWARFUnit.h:298
llvm::DWARFUnitHeader
Base class describing the header of any kind of "unit." Some information is specific to certain unit ...
Definition: DWARFUnit.h:49
llvm::DWARFUnit::getDIEIndex
uint32_t getDIEIndex(const DWARFDie &D)
Return the index of a DIE inside the unit's DIE vector.
Definition: DWARFUnit.h:461
llvm::dwarf::getUnitLengthFieldByteSize
uint8_t getUnitLengthFieldByteSize(DwarfFormat Format)
Get the byte size of the unit length field depending on the DWARF format.
Definition: Dwarf.h:679
llvm::DWARFUnit::getSibling
DWARFDie getSibling(const DWARFDebugInfoEntry *Die)
Definition: DWARFUnit.cpp:792
llvm::DWARFUnit::getDwarfStringOffsetsByteSize
uint8_t getDwarfStringOffsetsByteSize() const
Definition: DWARFUnit.h:359
llvm::dwarf::FormParams
A helper struct providing information about the byte size of DW_FORM values that vary in size dependi...
Definition: Dwarf.h:653
llvm::DWARFUnit::DWARFUnit
DWARFUnit(DWARFContext &Context, const DWARFSection &Section, const DWARFUnitHeader &Header, const DWARFDebugAbbrev *DA, const DWARFSection *RS, const DWARFSection *LocSection, StringRef SS, const DWARFSection &SOS, const DWARFSection *AOS, const DWARFSection &LS, bool LE, bool IsDWO, const DWARFUnitVector &UnitVector)
Definition: DWARFUnit.cpp:184
llvm::dwarf::UnitType
UnitType
Constants for unit types in DWARF v5.
Definition: Dwarf.h:465
assert
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
llvm::DWARFUnitHeader::getFormParams
const dwarf::FormParams & getFormParams() const
Definition: DWARFUnit.h:84
llvm::DWARFUnit::getRefAddrByteSize
uint8_t getRefAddrByteSize() const
Definition: DWARFUnit.h:289
llvm::DWARFUnit::getStringOffsetSection
const DWARFSection & getStringOffsetSection() const
Definition: DWARFUnit.h:303
llvm::DWARFUnitHeader::getTypeOffset
uint64_t getTypeOffset() const
Definition: DWARFUnit.h:101
llvm::DWARFUnit::getFormat
dwarf::DwarfFormat getFormat() const
Definition: DWARFUnit.h:296
iterator_range.h
llvm::dwarf::FormParams::getDwarfOffsetByteSize
uint8_t getDwarfOffsetByteSize() const
The size of a reference is determined by the DWARF 32/64-bit format.
Definition: Dwarf.h:671
llvm::DWARFUnitHeader::getIndexEntry
const DWARFUnitIndex::Entry * getIndexEntry() const
Definition: DWARFUnit.h:99
llvm::DWARFUnit::getNextUnitOffset
uint64_t getNextUnitOffset() const
Definition: DWARFUnit.h:300
llvm::DWARFUnit::clear
void clear()
Definition: DWARFUnit.cpp:372
llvm::DWARFUnit::getDIEAtIndex
DWARFDie getDIEAtIndex(unsigned Index)
Return the DIE object at the given index.
Definition: DWARFUnit.h:466
llvm::size
auto size(R &&Range, std::enable_if_t< std::is_base_of< std::random_access_iterator_tag, typename std::iterator_traits< decltype(Range.begin())>::iterator_category >::value, void > *=nullptr)
Get the size of a range.
Definition: STLExtras.h:1588
llvm::DWARFUnitVector::getUnitForIndexEntry
DWARFUnit * getUnitForIndexEntry(const DWARFUnitIndex::Entry &E)
Definition: DWARFUnit.cpp:155
llvm::DWARFUnit::getCompilationDir
const char * getCompilationDir()
Definition: DWARFUnit.cpp:383
llvm::DWARFUnit::getLocSectionBase
uint64_t getLocSectionBase() const
Definition: DWARFUnit.h:330
llvm::DWARFUnitVector::addUnit
DWARFUnit * addUnit(std::unique_ptr< DWARFUnit > Unit)
Add an existing DWARFUnit to this UnitVector.
Definition: DWARFUnit.cpp:133
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:58
Dwarf.h
llvm::DWARFUnit::getContext
DWARFContext & getContext() const
Definition: DWARFUnit.h:281
llvm::DWARFUnitHeader::getAddressByteSize
uint8_t getAddressByteSize() const
Definition: DWARFUnit.h:87
llvm::DWARFUnitVector::compile_unit_range
decltype(make_filter_range(std::declval< iterator_range >(), isCompileUnit)) compile_unit_range
Definition: DWARFUnit.h:135
llvm::DWARFUnitVector::getUnitForOffset
DWARFUnit * getUnitForOffset(uint64_t Offset) const
Definition: DWARFUnit.cpp:142
uint32_t
DWARFDebugInfoEntry.h
llvm::DWARFUnitHeader::extract
bool extract(DWARFContext &Context, const DWARFDataExtractor &debug_info, uint64_t *offset_ptr, DWARFSectionKind SectionKind)
Parse a unit header from debug_info starting at offset_ptr.
Definition: DWARFUnit.cpp:244
llvm::DWARFUnit::getDwarfOffsetByteSize
uint8_t getDwarfOffsetByteSize() const
Definition: DWARFUnit.h:290
llvm::DWARFUnitHeader::getAbbrOffset
uint64_t getAbbrOffset() const
Definition: DWARFUnit.h:93
llvm::DWARFUnitHeader::getNextUnitOffset
uint64_t getNextUnitOffset() const
Definition: DWARFUnit.h:110
llvm::DWARFUnit::dies
die_iterator_range dies()
Definition: DWARFUnit.h:499
DWARFLocationExpression.h
llvm::make_filter_range
iterator_range< filter_iterator< detail::IterOfRange< RangeT >, PredicateT > > make_filter_range(RangeT &&Range, PredicateT Pred)
Convenience function that takes a range of elements and a predicate, and return a new filter_iterator...
Definition: STLExtras.h:524
llvm::StrOffsetsContributionDescriptor::FormParams
dwarf::FormParams FormParams
Format and version.
Definition: DWARFUnit.h:186
llvm::DWARFUnit::getAddrOffsetSectionBase
Optional< uint64_t > getAddrOffsetSectionBase() const
Definition: DWARFUnit.h:318
llvm::DWARFUnit::getStringOffsetSectionItem
Expected< uint64_t > getStringOffsetSectionItem(uint32_t Index) const
Definition: DWARFUnit.cpp:228
llvm::DWARFUnit::getNonSkeletonUnitDIE
DWARFDie getNonSkeletonUnitDIE(bool ExtractUnitDIEOnly=true)
Definition: DWARFUnit.h:399
llvm::DWARFUnit::findRnglistFromOffset
Expected< DWARFAddressRangesVector > findRnglistFromOffset(uint64_t Offset)
Return a vector of address ranges resulting from a (possibly encoded) range list starting at a given ...
Definition: DWARFUnit.cpp:639
llvm::DWARFUnitHeader::getVersion
uint16_t getVersion() const
Definition: DWARFUnit.h:85
llvm::DWARFUnit::extractRangeList
Error extractRangeList(uint64_t RangeListOffset, DWARFDebugRangeList &RangeList) const
Extract the range list referenced by this compile unit from the .debug_ranges section.
Definition: DWARFUnit.cpp:362
llvm::DWARFUnitHeader::getDWOId
Optional< uint64_t > getDWOId() const
Definition: DWARFUnit.h:94
llvm::partition_point
auto partition_point(R &&Range, Predicate P)
Binary search for the first iterator in a range where a predicate is false.
Definition: STLExtras.h:1764
llvm::DWARFUnit::getAddressByteSize
uint8_t getAddressByteSize() const
Definition: DWARFUnit.h:288
llvm::DWARFUnit::getLastChild
DWARFDie getLastChild(const DWARFDebugInfoEntry *Die)
Definition: DWARFUnit.cpp:848
llvm::SectionKind
SectionKind - This is a simple POD value that classifies the properties of a section.
Definition: SectionKind.h:22
uint16_t
llvm::StrOffsetsContributionDescriptor::StrOffsetsContributionDescriptor
StrOffsetsContributionDescriptor()=default
llvm::DWARFUnit
Definition: DWARFUnit.h:205
llvm::DWARFUnit::setRangesSection
void setRangesSection(const DWARFSection *RS, uint64_t Base)
Definition: DWARFUnit.h:325
llvm::DWARFUnit::getHeaderSize
uint32_t getHeaderSize() const
Size in bytes of the parsed unit header.
Definition: DWARFUnit.h:294
llvm::DWARFUnit::getPreviousSibling
DWARFDie getPreviousSibling(const DWARFDebugInfoEntry *Die)
Definition: DWARFUnit.cpp:805
llvm::DWARFUnit::tryExtractDIEsIfNeeded
Error tryExtractDIEsIfNeeded(bool CUDieOnly)
Definition: DWARFUnit.cpp:480
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:155
llvm::DWARFUnitHeader::getOffset
uint64_t getOffset() const
Definition: DWARFUnit.h:83
llvm::AArch64CC::LS
@ LS
Definition: AArch64BaseInfo.h:264
DataExtractor.h
llvm::DWARFUnitVector::finishedInfoUnits
void finishedInfoUnits()
Indicate that parsing .debug_info[.dwo] is done, and remaining units will be from ....
Definition: DWARFUnit.h:168
llvm::DWARFUnit::getOffset
uint64_t getOffset() const
Definition: DWARFUnit.h:283
llvm::StrOffsetsContributionDescriptor::getDwarfOffsetByteSize
uint8_t getDwarfOffsetByteSize() const
Definition: DWARFUnit.h:195
llvm::M68kBeads::DA
@ DA
Definition: M68kBaseInfo.h:59
llvm::DWARFUnit::getInlinedChainForAddress
void getInlinedChainForAddress(uint64_t Address, SmallVectorImpl< DWARFDie > &InlinedChain)
getInlinedChainForAddress - fetches inlined chain for a given address.
Definition: DWARFUnit.cpp:750
llvm::DWARFUnit::getInfoSection
const DWARFSection & getInfoSection() const
Definition: DWARFUnit.h:282
DWARFUnitIndex.h
llvm::dwarf::FormParams::Version
uint16_t Version
Definition: Dwarf.h:654
llvm::DWARFUnit::getAbbreviationsOffset
uint64_t getAbbreviationsOffset() const
Definition: DWARFUnit.h:369
llvm::DataExtractor
Definition: DataExtractor.h:41
Version
uint64_t Version
Definition: RawMemProfReader.cpp:40
SmallVector.h
llvm::DWARFUnitHeader::getUnitLengthFieldByteSize
uint8_t getUnitLengthFieldByteSize() const
Definition: DWARFUnit.h:107
llvm::DWARFUnitHeader::applyIndexEntry
bool applyIndexEntry(const DWARFUnitIndex::Entry *Entry)
Definition: DWARFUnit.cpp:345
llvm::DWARFUnit::getBaseAddress
llvm::Optional< object::SectionedAddress > getBaseAddress()
Definition: DWARFUnit.cpp:885
llvm::SmallVectorImpl< std::unique_ptr< DWARFUnit > >::iterator
typename SuperClass::iterator iterator
Definition: SmallVector.h:558
llvm::iterator_range
A range adaptor for a pair of iterators.
Definition: iterator_range.h:30
llvm::isCompileUnit
bool isCompileUnit(const std::unique_ptr< DWARFUnit > &U)
Definition: DWARFUnit.h:531
llvm::DWARFUnit::setAddrOffsetSection
void setAddrOffsetSection(const DWARFSection *AOS, uint64_t Base)
Definition: DWARFUnit.h:313
llvm::SmallVectorImpl< std::unique_ptr< DWARFUnit > >
llvm::getDWARFUnitIndex
const DWARFUnitIndex & getDWARFUnitIndex(DWARFContext &Context, DWARFSectionKind Kind)
Definition: DWARFUnit.cpp:771
llvm::DWARFDie
Utility class that carries the DWARF compile/type unit and the debug info entry in an object.
Definition: DWARFDie.h:43
llvm::DWARFUnit::getDIEForOffset
DWARFDie getDIEForOffset(uint64_t Offset)
Return the DIE object for a given offset inside the unit's DIE vector.
Definition: DWARFUnit.h:481
llvm::DWARFUnitHeader::getUnitType
uint8_t getUnitType() const
Definition: DWARFUnit.h:102
llvm::DIE::getOffset
unsigned getOffset() const
Get the compile/type unit relative offset of this DIE.
Definition: DIE.h:777
llvm::AMDGPU::VGPRIndexMode::Id
Id
Definition: SIDefines.h:235
llvm::DWARFUnit::getLocationTable
const DWARFLocationTable & getLocationTable()
Definition: DWARFUnit.h:344
llvm::StrOffsetsContributionDescriptor::StrOffsetsContributionDescriptor
StrOffsetsContributionDescriptor(uint64_t Base, uint64_t Size, uint8_t Version, dwarf::DwarfFormat Format)
Definition: DWARFUnit.h:188
llvm::DWARFUnit::determineStringOffsetsTableContributionDWO
Expected< Optional< StrOffsetsContributionDescriptor > > determineStringOffsetsTableContributionDWO(DWARFDataExtractor &DA)
Find the unit's contribution to the string offsets table and determine its length and form.
Definition: DWARFUnit.cpp:988
llvm::DWARFUnit::getHeader
const DWARFUnitHeader & getHeader() const
Definition: DWARFUnit.h:255
llvm::DWARFUnit::getStringOffsetsBase
uint64_t getStringOffsetsBase() const
Definition: DWARFUnit.h:364
llvm::DWARFUnit::getVersion
uint16_t getVersion() const
Definition: DWARFUnit.h:287
llvm::dwarf::DWARF32
@ DWARF32
Definition: Dwarf.h:93
llvm::sampleprof::Base
@ Base
Definition: Discriminator.h:58
llvm::DWARFUnitHeader::getTypeHash
uint64_t getTypeHash() const
Definition: DWARFUnit.h:100
DWARFDataExtractor.h
llvm::dwarf::FormParams::getRefAddrByteSize
uint8_t getRefAddrByteSize() const
The definition of the size of form DW_FORM_ref_addr depends on the version.
Definition: Dwarf.h:664
llvm::DIDumpOptions
Container for dump options that control which debug information will be dumped.
Definition: DIContext.h:186
llvm::DWARFUnitVector
Describe a collection of units.
Definition: DWARFUnit.h:122
llvm::DWARFUnitVector::getNumUnits
unsigned getNumUnits() const
Returns number of all units held by this instance.
Definition: DWARFUnit.h:159