LLVM  15.0.0git
DWARFUnit.cpp
Go to the documentation of this file.
1 //===- DWARFUnit.cpp ------------------------------------------------------===//
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 
10 #include "llvm/ADT/SmallString.h"
11 #include "llvm/ADT/StringRef.h"
28 #include "llvm/Object/ObjectFile.h"
30 #include "llvm/Support/Errc.h"
31 #include "llvm/Support/Path.h"
32 #include <algorithm>
33 #include <cassert>
34 #include <cstddef>
35 #include <cstdint>
36 #include <utility>
37 #include <vector>
38 
39 using namespace llvm;
40 using namespace dwarf;
41 
43  const DWARFSection &Section,
45  const DWARFObject &D = C.getDWARFObj();
46  addUnitsImpl(C, D, Section, C.getDebugAbbrev(), &D.getRangesSection(),
47  &D.getLocSection(), D.getStrSection(),
48  D.getStrOffsetsSection(), &D.getAddrSection(),
49  D.getLineSection(), D.isLittleEndian(), false, false,
50  SectionKind);
51 }
52 
54  const DWARFSection &DWOSection,
56  bool Lazy) {
57  const DWARFObject &D = C.getDWARFObj();
58  addUnitsImpl(C, D, DWOSection, C.getDebugAbbrevDWO(), &D.getRangesDWOSection(),
59  &D.getLocDWOSection(), D.getStrDWOSection(),
60  D.getStrOffsetsDWOSection(), &D.getAddrSection(),
61  D.getLineDWOSection(), C.isLittleEndian(), true, Lazy,
62  SectionKind);
63 }
64 
65 void DWARFUnitVector::addUnitsImpl(
66  DWARFContext &Context, const DWARFObject &Obj, const DWARFSection &Section,
67  const DWARFDebugAbbrev *DA, const DWARFSection *RS,
68  const DWARFSection *LocSection, StringRef SS, const DWARFSection &SOS,
69  const DWARFSection *AOS, const DWARFSection &LS, bool LE, bool IsDWO,
70  bool Lazy, DWARFSectionKind SectionKind) {
71  DWARFDataExtractor Data(Obj, Section, LE, 0);
72  // Lazy initialization of Parser, now that we have all section info.
73  if (!Parser) {
74  Parser = [=, &Context, &Obj, &Section, &SOS,
76  const DWARFSection *CurSection,
77  const DWARFUnitIndex::Entry *IndexEntry)
78  -> std::unique_ptr<DWARFUnit> {
79  const DWARFSection &InfoSection = CurSection ? *CurSection : Section;
80  DWARFDataExtractor Data(Obj, InfoSection, LE, 0);
81  if (!Data.isValidOffset(Offset))
82  return nullptr;
83  DWARFUnitHeader Header;
84  if (!Header.extract(Context, Data, &Offset, SectionKind))
85  return nullptr;
86  if (!IndexEntry && IsDWO) {
88  Context, Header.isTypeUnit() ? DW_SECT_EXT_TYPES : DW_SECT_INFO);
89  if (Index) {
90  if (Header.isTypeUnit())
91  IndexEntry = Index.getFromHash(Header.getTypeHash());
92  else if (auto DWOId = Header.getDWOId())
93  IndexEntry = Index.getFromHash(*DWOId);
94  }
95  if (!IndexEntry)
96  IndexEntry = Index.getFromOffset(Header.getOffset());
97  }
98  if (IndexEntry && !Header.applyIndexEntry(IndexEntry))
99  return nullptr;
100  std::unique_ptr<DWARFUnit> U;
101  if (Header.isTypeUnit())
102  U = std::make_unique<DWARFTypeUnit>(Context, InfoSection, Header, DA,
103  RS, LocSection, SS, SOS, AOS, LS,
104  LE, IsDWO, *this);
105  else
106  U = std::make_unique<DWARFCompileUnit>(Context, InfoSection, Header,
107  DA, RS, LocSection, SS, SOS,
108  AOS, LS, LE, IsDWO, *this);
109  return U;
110  };
111  }
112  if (Lazy)
113  return;
114  // Find a reasonable insertion point within the vector. We skip over
115  // (a) units from a different section, (b) units from the same section
116  // but with lower offset-within-section. This keeps units in order
117  // within a section, although not necessarily within the object file,
118  // even if we do lazy parsing.
119  auto I = this->begin();
120  uint64_t Offset = 0;
121  while (Data.isValidOffset(Offset)) {
122  if (I != this->end() &&
123  (&(*I)->getInfoSection() != &Section || (*I)->getOffset() == Offset)) {
124  ++I;
125  continue;
126  }
127  auto U = Parser(Offset, SectionKind, &Section, nullptr);
128  // If parsing failed, we're done with this section.
129  if (!U)
130  break;
131  Offset = U->getNextUnitOffset();
132  I = std::next(this->insert(I, std::move(U)));
133  }
134 }
135 
136 DWARFUnit *DWARFUnitVector::addUnit(std::unique_ptr<DWARFUnit> Unit) {
137  auto I = std::upper_bound(begin(), end(), Unit,
138  [](const std::unique_ptr<DWARFUnit> &LHS,
139  const std::unique_ptr<DWARFUnit> &RHS) {
140  return LHS->getOffset() < RHS->getOffset();
141  });
142  return this->insert(I, std::move(Unit))->get();
143 }
144 
146  auto end = begin() + getNumInfoUnits();
147  auto *CU =
148  std::upper_bound(begin(), end, Offset,
149  [](uint64_t LHS, const std::unique_ptr<DWARFUnit> &RHS) {
150  return LHS < RHS->getNextUnitOffset();
151  });
152  if (CU != end && (*CU)->getOffset() <= Offset)
153  return CU->get();
154  return nullptr;
155 }
156 
157 DWARFUnit *
159  const auto *CUOff = E.getContribution(DW_SECT_INFO);
160  if (!CUOff)
161  return nullptr;
162 
163  auto Offset = CUOff->Offset;
164  auto end = begin() + getNumInfoUnits();
165 
166  auto *CU =
167  std::upper_bound(begin(), end, CUOff->Offset,
168  [](uint64_t LHS, const std::unique_ptr<DWARFUnit> &RHS) {
169  return LHS < RHS->getNextUnitOffset();
170  });
171  if (CU != end && (*CU)->getOffset() <= Offset)
172  return CU->get();
173 
174  if (!Parser)
175  return nullptr;
176 
177  auto U = Parser(Offset, DW_SECT_INFO, nullptr, &E);
178  if (!U)
179  U = nullptr;
180 
181  auto *NewCU = U.get();
182  this->insert(CU, std::move(U));
183  ++NumInfoUnits;
184  return NewCU;
185 }
186 
188  const DWARFUnitHeader &Header, const DWARFDebugAbbrev *DA,
189  const DWARFSection *RS, const DWARFSection *LocSection,
190  StringRef SS, const DWARFSection &SOS,
191  const DWARFSection *AOS, const DWARFSection &LS, bool LE,
192  bool IsDWO, const DWARFUnitVector &UnitVector)
193  : Context(DC), InfoSection(Section), Header(Header), Abbrev(DA),
194  RangeSection(RS), LineSection(LS), StringSection(SS),
195  StringOffsetSection(SOS), AddrOffsetSection(AOS), isLittleEndian(LE),
196  IsDWO(IsDWO), UnitVector(UnitVector) {
197  clear();
198 }
199 
200 DWARFUnit::~DWARFUnit() = default;
201 
203  return DWARFDataExtractor(Context.getDWARFObj(), InfoSection, isLittleEndian,
205 }
206 
209  if (!AddrOffsetSectionBase) {
210  auto R = Context.info_section_units();
211  // Surprising if a DWO file has more than one skeleton unit in it - this
212  // probably shouldn't be valid, but if a use case is found, here's where to
213  // support it (probably have to linearly search for the matching skeleton CU
214  // here)
215  if (IsDWO && hasSingleElement(R))
216  return (*R.begin())->getAddrOffsetSectionItem(Index);
217 
218  return None;
219  }
220 
221  uint64_t Offset = *AddrOffsetSectionBase + Index * getAddressByteSize();
222  if (AddrOffsetSection->Data.size() < Offset + getAddressByteSize())
223  return None;
224  DWARFDataExtractor DA(Context.getDWARFObj(), *AddrOffsetSection,
225  isLittleEndian, getAddressByteSize());
226  uint64_t Section;
227  uint64_t Address = DA.getRelocatedAddress(&Offset, &Section);
228  return {{Address, Section}};
229 }
230 
232  if (!StringOffsetsTableContribution)
233  return make_error<StringError>(
234  "DW_FORM_strx used without a valid string offsets table",
236  unsigned ItemSize = getDwarfStringOffsetsByteSize();
237  uint64_t Offset = getStringOffsetsBase() + Index * ItemSize;
238  if (StringOffsetSection.Data.size() < Offset + ItemSize)
239  return make_error<StringError>("DW_FORM_strx uses index " + Twine(Index) +
240  ", which is too large",
242  DWARFDataExtractor DA(Context.getDWARFObj(), StringOffsetSection,
243  isLittleEndian, 0);
244  return DA.getRelocatedValue(ItemSize, &Offset);
245 }
246 
248  const DWARFDataExtractor &debug_info,
249  uint64_t *offset_ptr,
251  Offset = *offset_ptr;
252  Error Err = Error::success();
253  IndexEntry = nullptr;
254  std::tie(Length, FormParams.Format) =
255  debug_info.getInitialLength(offset_ptr, &Err);
256  FormParams.Version = debug_info.getU16(offset_ptr, &Err);
257  if (FormParams.Version >= 5) {
258  UnitType = debug_info.getU8(offset_ptr, &Err);
259  FormParams.AddrSize = debug_info.getU8(offset_ptr, &Err);
260  AbbrOffset = debug_info.getRelocatedValue(
261  FormParams.getDwarfOffsetByteSize(), offset_ptr, nullptr, &Err);
262  } else {
263  AbbrOffset = debug_info.getRelocatedValue(
264  FormParams.getDwarfOffsetByteSize(), offset_ptr, nullptr, &Err);
265  FormParams.AddrSize = debug_info.getU8(offset_ptr, &Err);
266  // Fake a unit type based on the section type. This isn't perfect,
267  // but distinguishing compile and type units is generally enough.
269  UnitType = DW_UT_type;
270  else
271  UnitType = DW_UT_compile;
272  }
273  if (isTypeUnit()) {
274  TypeHash = debug_info.getU64(offset_ptr, &Err);
275  TypeOffset = debug_info.getUnsigned(
276  offset_ptr, FormParams.getDwarfOffsetByteSize(), &Err);
277  } else if (UnitType == DW_UT_split_compile || UnitType == DW_UT_skeleton)
278  DWOId = debug_info.getU64(offset_ptr, &Err);
279 
280  if (Err) {
281  Context.getWarningHandler()(joinErrors(
284  "DWARF unit at 0x%8.8" PRIx64 " cannot be parsed:", Offset),
285  std::move(Err)));
286  return false;
287  }
288 
289  // Header fields all parsed, capture the size of this unit header.
290  assert(*offset_ptr - Offset <= 255 && "unexpected header size");
291  Size = uint8_t(*offset_ptr - Offset);
292  uint64_t NextCUOffset = Offset + getUnitLengthFieldByteSize() + getLength();
293 
294  if (!debug_info.isValidOffset(getNextUnitOffset() - 1)) {
295  Context.getWarningHandler()(
297  "DWARF unit from offset 0x%8.8" PRIx64 " incl. "
298  "to offset 0x%8.8" PRIx64 " excl. "
299  "extends past section size 0x%8.8zx",
300  Offset, NextCUOffset, debug_info.size()));
301  return false;
302  }
303 
305  Context.getWarningHandler()(createStringError(
307  "DWARF unit at offset 0x%8.8" PRIx64 " "
308  "has unsupported version %" PRIu16 ", supported are 2-%u",
310  return false;
311  }
312 
313  // Type offset is unit-relative; should be after the header and before
314  // the end of the current unit.
315  if (isTypeUnit() && TypeOffset < Size) {
316  Context.getWarningHandler()(
318  "DWARF type unit at offset "
319  "0x%8.8" PRIx64 " "
320  "has its relocated type_offset 0x%8.8" PRIx64 " "
321  "pointing inside the header",
322  Offset, Offset + TypeOffset));
323  return false;
324  }
325  if (isTypeUnit() &&
326  TypeOffset >= getUnitLengthFieldByteSize() + getLength()) {
327  Context.getWarningHandler()(createStringError(
329  "DWARF type unit from offset 0x%8.8" PRIx64 " incl. "
330  "to offset 0x%8.8" PRIx64 " excl. has its "
331  "relocated type_offset 0x%8.8" PRIx64 " pointing past the unit end",
332  Offset, NextCUOffset, Offset + TypeOffset));
333  return false;
334  }
335 
338  "DWARF unit at offset 0x%8.8" PRIx64, Offset)) {
339  Context.getWarningHandler()(std::move(SizeErr));
340  return false;
341  }
342 
343  // Keep track of the highest DWARF version we encounter across all units.
344  Context.setMaxVersionIfGreater(getVersion());
345  return true;
346 }
347 
349  assert(Entry);
350  assert(!IndexEntry);
351  IndexEntry = Entry;
352  if (AbbrOffset)
353  return false;
354  auto *UnitContrib = IndexEntry->getContribution();
355  if (!UnitContrib ||
356  UnitContrib->Length != (getLength() + getUnitLengthFieldByteSize()))
357  return false;
358  auto *AbbrEntry = IndexEntry->getContribution(DW_SECT_ABBREV);
359  if (!AbbrEntry)
360  return false;
361  AbbrOffset = AbbrEntry->Offset;
362  return true;
363 }
364 
366  DWARFDebugRangeList &RangeList) const {
367  // Require that compile unit is extracted.
368  assert(!DieArray.empty());
369  DWARFDataExtractor RangesData(Context.getDWARFObj(), *RangeSection,
370  isLittleEndian, getAddressByteSize());
371  uint64_t ActualRangeListOffset = RangeSectionBase + RangeListOffset;
372  return RangeList.extract(RangesData, &ActualRangeListOffset);
373 }
374 
376  Abbrevs = nullptr;
377  BaseAddr.reset();
378  RangeSectionBase = 0;
379  LocSectionBase = 0;
380  AddrOffsetSectionBase = None;
381  SU = nullptr;
382  clearDIEs(false);
383  AddrDieMap.clear();
384  if (DWO)
385  DWO->clear();
386  DWO.reset();
387 }
388 
390  return dwarf::toString(getUnitDIE().find(DW_AT_comp_dir), nullptr);
391 }
392 
393 void DWARFUnit::extractDIEsToVector(
394  bool AppendCUDie, bool AppendNonCUDies,
395  std::vector<DWARFDebugInfoEntry> &Dies) const {
396  if (!AppendCUDie && !AppendNonCUDies)
397  return;
398 
399  // Set the offset to that of the first DIE and calculate the start of the
400  // next compilation unit header.
401  uint64_t DIEOffset = getOffset() + getHeaderSize();
402  uint64_t NextCUOffset = getNextUnitOffset();
404  DWARFDataExtractor DebugInfoData = getDebugInfoExtractor();
405  // The end offset has been already checked by DWARFUnitHeader::extract.
406  assert(DebugInfoData.isValidOffset(NextCUOffset - 1));
407  std::vector<uint32_t> Parents;
408  std::vector<uint32_t> PrevSiblings;
409  bool IsCUDie = true;
410 
411  assert(
412  ((AppendCUDie && Dies.empty()) || (!AppendCUDie && Dies.size() == 1)) &&
413  "Dies array is not empty");
414 
415  // Fill Parents and Siblings stacks with initial value.
416  Parents.push_back(UINT32_MAX);
417  if (!AppendCUDie)
418  Parents.push_back(0);
419  PrevSiblings.push_back(0);
420 
421  // Start to extract dies.
422  do {
423  assert(Parents.size() > 0 && "Empty parents stack");
424  assert((Parents.back() == UINT32_MAX || Parents.back() <= Dies.size()) &&
425  "Wrong parent index");
426 
427  // Extract die. Stop if any error occurred.
428  if (!DIE.extractFast(*this, &DIEOffset, DebugInfoData, NextCUOffset,
429  Parents.back()))
430  break;
431 
432  // If previous sibling is remembered then update it`s SiblingIdx field.
433  if (PrevSiblings.back() > 0) {
434  assert(PrevSiblings.back() < Dies.size() &&
435  "Previous sibling index is out of Dies boundaries");
436  Dies[PrevSiblings.back()].setSiblingIdx(Dies.size());
437  }
438 
439  // Store die into the Dies vector.
440  if (IsCUDie) {
441  if (AppendCUDie)
442  Dies.push_back(DIE);
443  if (!AppendNonCUDies)
444  break;
445  // The average bytes per DIE entry has been seen to be
446  // around 14-20 so let's pre-reserve the needed memory for
447  // our DIE entries accordingly.
448  Dies.reserve(Dies.size() + getDebugInfoSize() / 14);
449  } else {
450  // Remember last previous sibling.
451  PrevSiblings.back() = Dies.size();
452 
453  Dies.push_back(DIE);
454  }
455 
456  // Check for new children scope.
457  if (const DWARFAbbreviationDeclaration *AbbrDecl =
458  DIE.getAbbreviationDeclarationPtr()) {
459  if (AbbrDecl->hasChildren()) {
460  if (AppendCUDie || !IsCUDie) {
461  assert(Dies.size() > 0 && "Dies does not contain any die");
462  Parents.push_back(Dies.size() - 1);
463  PrevSiblings.push_back(0);
464  }
465  } else if (IsCUDie)
466  // Stop if we have single compile unit die w/o children.
467  break;
468  } else {
469  // NULL DIE: finishes current children scope.
470  Parents.pop_back();
471  PrevSiblings.pop_back();
472  }
473 
474  if (IsCUDie)
475  IsCUDie = false;
476 
477  // Stop when compile unit die is removed from the parents stack.
478  } while (Parents.size() > 1);
479 }
480 
481 void DWARFUnit::extractDIEsIfNeeded(bool CUDieOnly) {
482  if (Error e = tryExtractDIEsIfNeeded(CUDieOnly))
483  Context.getRecoverableErrorHandler()(std::move(e));
484 }
485 
487  if ((CUDieOnly && !DieArray.empty()) ||
488  DieArray.size() > 1)
489  return Error::success(); // Already parsed.
490 
491  bool HasCUDie = !DieArray.empty();
492  extractDIEsToVector(!HasCUDie, !CUDieOnly, DieArray);
493 
494  if (DieArray.empty())
495  return Error::success();
496 
497  // If CU DIE was just parsed, copy several attribute values from it.
498  if (HasCUDie)
499  return Error::success();
500 
501  DWARFDie UnitDie(this, &DieArray[0]);
502  if (Optional<uint64_t> DWOId = toUnsigned(UnitDie.find(DW_AT_GNU_dwo_id)))
503  Header.setDWOId(*DWOId);
504  if (!IsDWO) {
505  assert(AddrOffsetSectionBase == None);
506  assert(RangeSectionBase == 0);
507  assert(LocSectionBase == 0);
508  AddrOffsetSectionBase = toSectionOffset(UnitDie.find(DW_AT_addr_base));
509  if (!AddrOffsetSectionBase)
510  AddrOffsetSectionBase =
511  toSectionOffset(UnitDie.find(DW_AT_GNU_addr_base));
512  RangeSectionBase = toSectionOffset(UnitDie.find(DW_AT_rnglists_base), 0);
513  LocSectionBase = toSectionOffset(UnitDie.find(DW_AT_loclists_base), 0);
514  }
515 
516  // In general, in DWARF v5 and beyond we derive the start of the unit's
517  // contribution to the string offsets table from the unit DIE's
518  // DW_AT_str_offsets_base attribute. Split DWARF units do not use this
519  // attribute, so we assume that there is a contribution to the string
520  // offsets table starting at offset 0 of the debug_str_offsets.dwo section.
521  // In both cases we need to determine the format of the contribution,
522  // which may differ from the unit's format.
523  DWARFDataExtractor DA(Context.getDWARFObj(), StringOffsetSection,
524  isLittleEndian, 0);
525  if (IsDWO || getVersion() >= 5) {
526  auto StringOffsetOrError =
529  if (!StringOffsetOrError)
531  "invalid reference to or invalid content in "
532  ".debug_str_offsets[.dwo]: " +
533  toString(StringOffsetOrError.takeError()));
534 
535  StringOffsetsTableContribution = *StringOffsetOrError;
536  }
537 
538  // DWARF v5 uses the .debug_rnglists and .debug_rnglists.dwo sections to
539  // describe address ranges.
540  if (getVersion() >= 5) {
541  // In case of DWP, the base offset from the index has to be added.
542  if (IsDWO) {
543  uint64_t ContributionBaseOffset = 0;
544  if (auto *IndexEntry = Header.getIndexEntry())
545  if (auto *Contrib = IndexEntry->getContribution(DW_SECT_RNGLISTS))
546  ContributionBaseOffset = Contrib->Offset;
548  &Context.getDWARFObj().getRnglistsDWOSection(),
549  ContributionBaseOffset +
551  } else
552  setRangesSection(&Context.getDWARFObj().getRnglistsSection(),
553  toSectionOffset(UnitDie.find(DW_AT_rnglists_base),
555  Header.getFormat())));
556  }
557 
558  if (IsDWO) {
559  // If we are reading a package file, we need to adjust the location list
560  // data based on the index entries.
561  StringRef Data = Header.getVersion() >= 5
562  ? Context.getDWARFObj().getLoclistsDWOSection().Data
563  : Context.getDWARFObj().getLocDWOSection().Data;
564  if (auto *IndexEntry = Header.getIndexEntry())
565  if (const auto *C = IndexEntry->getContribution(
566  Header.getVersion() >= 5 ? DW_SECT_LOCLISTS : DW_SECT_EXT_LOC))
567  Data = Data.substr(C->Offset, C->Length);
568 
569  DWARFDataExtractor DWARFData(Data, isLittleEndian, getAddressByteSize());
570  LocTable =
571  std::make_unique<DWARFDebugLoclists>(DWARFData, Header.getVersion());
572  LocSectionBase = DWARFListTableHeader::getHeaderSize(Header.getFormat());
573  } else if (getVersion() >= 5) {
574  LocTable = std::make_unique<DWARFDebugLoclists>(
575  DWARFDataExtractor(Context.getDWARFObj(),
576  Context.getDWARFObj().getLoclistsSection(),
577  isLittleEndian, getAddressByteSize()),
578  getVersion());
579  } else {
580  LocTable = std::make_unique<DWARFDebugLoc>(DWARFDataExtractor(
581  Context.getDWARFObj(), Context.getDWARFObj().getLocSection(),
582  isLittleEndian, getAddressByteSize()));
583  }
584 
585  // Don't fall back to DW_AT_GNU_ranges_base: it should be ignored for
586  // skeleton CU DIE, so that DWARF users not aware of it are not broken.
587  return Error::success();
588 }
589 
590 bool DWARFUnit::parseDWO() {
591  if (IsDWO)
592  return false;
593  if (DWO.get())
594  return false;
595  DWARFDie UnitDie = getUnitDIE();
596  if (!UnitDie)
597  return false;
598  auto DWOFileName = getVersion() >= 5
599  ? dwarf::toString(UnitDie.find(DW_AT_dwo_name))
600  : dwarf::toString(UnitDie.find(DW_AT_GNU_dwo_name));
601  if (!DWOFileName)
602  return false;
603  auto CompilationDir = dwarf::toString(UnitDie.find(DW_AT_comp_dir));
604  SmallString<16> AbsolutePath;
605  if (sys::path::is_relative(*DWOFileName) && CompilationDir &&
606  *CompilationDir) {
607  sys::path::append(AbsolutePath, *CompilationDir);
608  }
609  sys::path::append(AbsolutePath, *DWOFileName);
610  auto DWOId = getDWOId();
611  if (!DWOId)
612  return false;
613  auto DWOContext = Context.getDWOContext(AbsolutePath);
614  if (!DWOContext)
615  return false;
616 
617  DWARFCompileUnit *DWOCU = DWOContext->getDWOCompileUnitForHash(*DWOId);
618  if (!DWOCU)
619  return false;
620  DWO = std::shared_ptr<DWARFCompileUnit>(std::move(DWOContext), DWOCU);
621  DWO->setSkeletonUnit(this);
622  // Share .debug_addr and .debug_ranges section with compile unit in .dwo
623  if (AddrOffsetSectionBase)
624  DWO->setAddrOffsetSection(AddrOffsetSection, *AddrOffsetSectionBase);
625  if (getVersion() == 4) {
626  auto DWORangesBase = UnitDie.getRangesBaseAttribute();
627  DWO->setRangesSection(RangeSection, DWORangesBase.value_or(0));
628  }
629 
630  return true;
631 }
632 
633 void DWARFUnit::clearDIEs(bool KeepCUDie) {
634  // Do not use resize() + shrink_to_fit() to free memory occupied by dies.
635  // shrink_to_fit() is a *non-binding* request to reduce capacity() to size().
636  // It depends on the implementation whether the request is fulfilled.
637  // Create a new vector with a small capacity and assign it to the DieArray to
638  // have previous contents freed.
639  DieArray = (KeepCUDie && !DieArray.empty())
640  ? std::vector<DWARFDebugInfoEntry>({DieArray[0]})
641  : std::vector<DWARFDebugInfoEntry>();
642 }
643 
646  if (getVersion() <= 4) {
647  DWARFDebugRangeList RangeList;
648  if (Error E = extractRangeList(Offset, RangeList))
649  return std::move(E);
650  return RangeList.getAbsoluteRanges(getBaseAddress());
651  }
652  DWARFDataExtractor RangesData(Context.getDWARFObj(), *RangeSection,
653  isLittleEndian, Header.getAddressByteSize());
654  DWARFDebugRnglistTable RnglistTable;
655  auto RangeListOrError = RnglistTable.findList(RangesData, Offset);
656  if (RangeListOrError)
657  return RangeListOrError.get().getAbsoluteRanges(getBaseAddress(), *this);
658  return RangeListOrError.takeError();
659 }
660 
663  if (auto Offset = getRnglistOffset(Index))
664  return findRnglistFromOffset(*Offset);
665 
667  "invalid range list table index %d (possibly "
668  "missing the entire range list table)",
669  Index);
670 }
671 
673  DWARFDie UnitDie = getUnitDIE();
674  if (!UnitDie)
675  return createStringError(errc::invalid_argument, "No unit DIE");
676 
677  // First, check if unit DIE describes address ranges for the whole unit.
678  auto CUDIERangesOrError = UnitDie.getAddressRanges();
679  if (!CUDIERangesOrError)
681  "decoding address ranges: %s",
682  toString(CUDIERangesOrError.takeError()).c_str());
683  return *CUDIERangesOrError;
684 }
685 
689 
690  Error InterpretationError = Error::success();
691 
693  Offset, getBaseAddress(),
694  [this](uint32_t Index) { return getAddrOffsetSectionItem(Index); },
696  if (L)
697  Result.push_back(std::move(*L));
698  else
699  InterpretationError =
700  joinErrors(L.takeError(), std::move(InterpretationError));
701  return !InterpretationError;
702  });
703 
704  if (ParseError || InterpretationError)
705  return joinErrors(std::move(ParseError), std::move(InterpretationError));
706 
707  return Result;
708 }
709 
711  if (Die.isSubroutineDIE()) {
712  auto DIERangesOrError = Die.getAddressRanges();
713  if (DIERangesOrError) {
714  for (const auto &R : DIERangesOrError.get()) {
715  // Ignore 0-sized ranges.
716  if (R.LowPC == R.HighPC)
717  continue;
718  auto B = AddrDieMap.upper_bound(R.LowPC);
719  if (B != AddrDieMap.begin() && R.LowPC < (--B)->second.first) {
720  // The range is a sub-range of existing ranges, we need to split the
721  // existing range.
722  if (R.HighPC < B->second.first)
723  AddrDieMap[R.HighPC] = B->second;
724  if (R.LowPC > B->first)
725  AddrDieMap[B->first].first = R.LowPC;
726  }
727  AddrDieMap[R.LowPC] = std::make_pair(R.HighPC, Die);
728  }
729  } else
730  llvm::consumeError(DIERangesOrError.takeError());
731  }
732  // Parent DIEs are added to the AddrDieMap prior to the Children DIEs to
733  // simplify the logic to update AddrDieMap. The child's range will always
734  // be equal or smaller than the parent's range. With this assumption, when
735  // adding one range into the map, it will at most split a range into 3
736  // sub-ranges.
737  for (DWARFDie Child = Die.getFirstChild(); Child; Child = Child.getSibling())
738  updateAddressDieMap(Child);
739 }
740 
742  extractDIEsIfNeeded(false);
743  if (AddrDieMap.empty())
745  auto R = AddrDieMap.upper_bound(Address);
746  if (R == AddrDieMap.begin())
747  return DWARFDie();
748  // upper_bound's previous item contains Address.
749  --R;
750  if (Address >= R->second.first)
751  return DWARFDie();
752  return R->second.second;
753 }
754 
756  for (DWARFDie Child : Die) {
757  if (isType(Child.getTag()))
758  continue;
759  updateVariableDieMap(Child);
760  }
761 
762  if (Die.getTag() != DW_TAG_variable)
763  return;
764 
766  Die.getLocations(DW_AT_location);
767  if (!Locations) {
768  // Missing DW_AT_location is fine here.
769  consumeError(Locations.takeError());
770  return;
771  }
772 
773  uint64_t Address = UINT64_MAX;
774 
775  for (const DWARFLocationExpression &Location : *Locations) {
776  uint8_t AddressSize = getAddressByteSize();
777  DataExtractor Data(Location.Expr, /*IsLittleEndian=*/true, AddressSize);
778  DWARFExpression Expr(Data, AddressSize);
779  auto It = Expr.begin();
780  if (It == Expr.end())
781  continue;
782 
783  // Match exactly the main sequence used to describe global variables:
784  // `DW_OP_addr[x] [+ DW_OP_plus_uconst]`. Currently, this is the sequence
785  // that LLVM produces for DILocalVariables and DIGlobalVariables. If, in
786  // future, the DWARF producer (`DwarfCompileUnit::addLocationAttribute()` is
787  // a good starting point) is extended to use further expressions, this code
788  // needs to be updated.
789  uint64_t LocationAddr;
790  if (It->getCode() == dwarf::DW_OP_addr) {
791  LocationAddr = It->getRawOperand(0);
792  } else if (It->getCode() == dwarf::DW_OP_addrx) {
793  uint64_t DebugAddrOffset = It->getRawOperand(0);
794  if (auto Pointer = getAddrOffsetSectionItem(DebugAddrOffset)) {
795  LocationAddr = Pointer->Address;
796  }
797  } else {
798  continue;
799  }
800 
801  // Read the optional 2nd operand, a DW_OP_plus_uconst.
802  if (++It != Expr.end()) {
803  if (It->getCode() != dwarf::DW_OP_plus_uconst)
804  continue;
805 
806  LocationAddr += It->getRawOperand(0);
807 
808  // Probe for a 3rd operand, if it exists, bail.
809  if (++It != Expr.end())
810  continue;
811  }
812 
813  Address = LocationAddr;
814  break;
815  }
816 
817  // Get the size of the global variable. If all else fails (i.e. the global has
818  // no type), then we use a size of one to still allow symbolization of the
819  // exact address.
820  uint64_t GVSize = 1;
821  if (DWARFDie BaseType = Die.getAttributeValueAsReferencedDie(DW_AT_type))
822  if (Optional<uint64_t> Size = Die.getTypeSize(getAddressByteSize()))
823  GVSize = *Size;
824 
825  if (Address != UINT64_MAX)
826  VariableDieMap[Address] = {Address + GVSize, Die};
827 }
828 
830  extractDIEsIfNeeded(false);
831 
832  auto RootDie = getUnitDIE();
833 
834  auto RootLookup = RootsParsedForVariables.insert(RootDie.getOffset());
835  if (RootLookup.second)
836  updateVariableDieMap(RootDie);
837 
838  auto R = VariableDieMap.upper_bound(Address);
839  if (R == VariableDieMap.begin())
840  return DWARFDie();
841 
842  // upper_bound's previous item contains Address.
843  --R;
844  if (Address >= R->second.first)
845  return DWARFDie();
846  return R->second.second;
847 }
848 
849 void
851  SmallVectorImpl<DWARFDie> &InlinedChain) {
852  assert(InlinedChain.empty());
853  // Try to look for subprogram DIEs in the DWO file.
854  parseDWO();
855  // First, find the subroutine that contains the given address (the leaf
856  // of inlined chain).
857  DWARFDie SubroutineDIE =
858  (DWO ? *DWO : *this).getSubroutineForAddress(Address);
859 
860  while (SubroutineDIE) {
861  if (SubroutineDIE.isSubprogramDIE()) {
862  InlinedChain.push_back(SubroutineDIE);
863  return;
864  }
865  if (SubroutineDIE.getTag() == DW_TAG_inlined_subroutine)
866  InlinedChain.push_back(SubroutineDIE);
867  SubroutineDIE = SubroutineDIE.getParent();
868  }
869 }
870 
873  if (Kind == DW_SECT_INFO)
874  return Context.getCUIndex();
876  return Context.getTUIndex();
877 }
878 
880  if (!Die)
881  return DWARFDie();
882 
883  if (Optional<uint32_t> ParentIdx = Die->getParentIdx()) {
884  assert(*ParentIdx < DieArray.size() &&
885  "ParentIdx is out of DieArray boundaries");
886  return DWARFDie(this, &DieArray[*ParentIdx]);
887  }
888 
889  return DWARFDie();
890 }
891 
893  if (!Die)
894  return DWARFDie();
895 
896  if (Optional<uint32_t> SiblingIdx = Die->getSiblingIdx()) {
897  assert(*SiblingIdx < DieArray.size() &&
898  "SiblingIdx is out of DieArray boundaries");
899  return DWARFDie(this, &DieArray[*SiblingIdx]);
900  }
901 
902  return DWARFDie();
903 }
904 
906  if (!Die)
907  return DWARFDie();
908 
909  Optional<uint32_t> ParentIdx = Die->getParentIdx();
910  if (!ParentIdx)
911  // Die is a root die, there is no previous sibling.
912  return DWARFDie();
913 
914  assert(*ParentIdx < DieArray.size() &&
915  "ParentIdx is out of DieArray boundaries");
916  assert(getDIEIndex(Die) > 0 && "Die is a root die");
917 
918  uint32_t PrevDieIdx = getDIEIndex(Die) - 1;
919  if (PrevDieIdx == *ParentIdx)
920  // Immediately previous node is parent, there is no previous sibling.
921  return DWARFDie();
922 
923  while (DieArray[PrevDieIdx].getParentIdx() != *ParentIdx) {
924  PrevDieIdx = *DieArray[PrevDieIdx].getParentIdx();
925 
926  assert(PrevDieIdx < DieArray.size() &&
927  "PrevDieIdx is out of DieArray boundaries");
928  assert(PrevDieIdx >= *ParentIdx &&
929  "PrevDieIdx is not a child of parent of Die");
930  }
931 
932  return DWARFDie(this, &DieArray[PrevDieIdx]);
933 }
934 
936  if (!Die->hasChildren())
937  return DWARFDie();
938 
939  // TODO: Instead of checking here for invalid die we might reject
940  // invalid dies at parsing stage(DWARFUnit::extractDIEsToVector).
941  // We do not want access out of bounds when parsing corrupted debug data.
942  size_t I = getDIEIndex(Die) + 1;
943  if (I >= DieArray.size())
944  return DWARFDie();
945  return DWARFDie(this, &DieArray[I]);
946 }
947 
949  if (!Die->hasChildren())
950  return DWARFDie();
951 
952  if (Optional<uint32_t> SiblingIdx = Die->getSiblingIdx()) {
953  assert(*SiblingIdx < DieArray.size() &&
954  "SiblingIdx is out of DieArray boundaries");
955  assert(DieArray[*SiblingIdx - 1].getTag() == dwarf::DW_TAG_null &&
956  "Bad end of children marker");
957  return DWARFDie(this, &DieArray[*SiblingIdx - 1]);
958  }
959 
960  // If SiblingIdx is set for non-root dies we could be sure that DWARF is
961  // correct and "end of children marker" must be found. For root die we do not
962  // have such a guarantee(parsing root die might be stopped if "end of children
963  // marker" is missing, SiblingIdx is always zero for root die). That is why we
964  // do not use assertion for checking for "end of children marker" for root
965  // die.
966 
967  // TODO: Instead of checking here for invalid die we might reject
968  // invalid dies at parsing stage(DWARFUnit::extractDIEsToVector).
969  if (getDIEIndex(Die) == 0 && DieArray.size() > 1 &&
970  DieArray.back().getTag() == dwarf::DW_TAG_null) {
971  // For the unit die we might take last item from DieArray.
972  assert(getDIEIndex(Die) == getDIEIndex(getUnitDIE()) && "Bad unit die");
973  return DWARFDie(this, &DieArray.back());
974  }
975 
976  return DWARFDie();
977 }
978 
980  if (!Abbrevs)
982  return Abbrevs;
983 }
984 
986  if (BaseAddr)
987  return BaseAddr;
988 
989  DWARFDie UnitDie = getUnitDIE();
990  Optional<DWARFFormValue> PC = UnitDie.find({DW_AT_low_pc, DW_AT_entry_pc});
991  BaseAddr = toSectionedAddress(PC);
992  return BaseAddr;
993 }
994 
998  uint8_t EntrySize = getDwarfOffsetByteSize();
999  // In order to ensure that we don't read a partial record at the end of
1000  // the section we validate for a multiple of the entry size.
1001  uint64_t ValidationSize = alignTo(Size, EntrySize);
1002  // Guard against overflow.
1003  if (ValidationSize >= Size)
1004  if (DA.isValidOffsetForDataOfSize((uint32_t)Base, ValidationSize))
1005  return *this;
1006  return createStringError(errc::invalid_argument, "length exceeds section size");
1007 }
1008 
1009 // Look for a DWARF64-formatted contribution to the string offsets table
1010 // starting at a given offset and record it in a descriptor.
1013  if (!DA.isValidOffsetForDataOfSize(Offset, 16))
1014  return createStringError(errc::invalid_argument, "section offset exceeds section size");
1015 
1016  if (DA.getU32(&Offset) != dwarf::DW_LENGTH_DWARF64)
1017  return createStringError(errc::invalid_argument, "32 bit contribution referenced from a 64 bit unit");
1018 
1019  uint64_t Size = DA.getU64(&Offset);
1020  uint8_t Version = DA.getU16(&Offset);
1021  (void)DA.getU16(&Offset); // padding
1022  // The encoded length includes the 2-byte version field and the 2-byte
1023  // padding, so we need to subtract them out when we populate the descriptor.
1024  return StrOffsetsContributionDescriptor(Offset, Size - 4, Version, DWARF64);
1025 }
1026 
1027 // Look for a DWARF32-formatted contribution to the string offsets table
1028 // starting at a given offset and record it in a descriptor.
1031  if (!DA.isValidOffsetForDataOfSize(Offset, 8))
1032  return createStringError(errc::invalid_argument, "section offset exceeds section size");
1033 
1034  uint32_t ContributionSize = DA.getU32(&Offset);
1035  if (ContributionSize >= dwarf::DW_LENGTH_lo_reserved)
1036  return createStringError(errc::invalid_argument, "invalid length");
1037 
1038  uint8_t Version = DA.getU16(&Offset);
1039  (void)DA.getU16(&Offset); // padding
1040  // The encoded length includes the 2-byte version field and the 2-byte
1041  // padding, so we need to subtract them out when we populate the descriptor.
1042  return StrOffsetsContributionDescriptor(Offset, ContributionSize - 4, Version,
1043  DWARF32);
1044 }
1045 
1048  llvm::dwarf::DwarfFormat Format,
1049  uint64_t Offset) {
1051  switch (Format) {
1053  if (Offset < 16)
1054  return createStringError(errc::invalid_argument, "insufficient space for 64 bit header prefix");
1055  auto DescOrError = parseDWARF64StringOffsetsTableHeader(DA, Offset - 16);
1056  if (!DescOrError)
1057  return DescOrError.takeError();
1058  Desc = *DescOrError;
1059  break;
1060  }
1062  if (Offset < 8)
1063  return createStringError(errc::invalid_argument, "insufficient space for 32 bit header prefix");
1064  auto DescOrError = parseDWARF32StringOffsetsTableHeader(DA, Offset - 8);
1065  if (!DescOrError)
1066  return DescOrError.takeError();
1067  Desc = *DescOrError;
1068  break;
1069  }
1070  }
1071  return Desc.validateContributionSize(DA);
1072 }
1073 
1076  assert(!IsDWO);
1077  auto OptOffset = toSectionOffset(getUnitDIE().find(DW_AT_str_offsets_base));
1078  if (!OptOffset)
1079  return None;
1080  auto DescOrError =
1081  parseDWARFStringOffsetsTableHeader(DA, Header.getFormat(), *OptOffset);
1082  if (!DescOrError)
1083  return DescOrError.takeError();
1084  return *DescOrError;
1085 }
1086 
1089  assert(IsDWO);
1090  uint64_t Offset = 0;
1091  auto IndexEntry = Header.getIndexEntry();
1092  const auto *C =
1093  IndexEntry ? IndexEntry->getContribution(DW_SECT_STR_OFFSETS) : nullptr;
1094  if (C)
1095  Offset = C->Offset;
1096  if (getVersion() >= 5) {
1097  if (DA.getData().data() == nullptr)
1098  return None;
1099  Offset += Header.getFormat() == dwarf::DwarfFormat::DWARF32 ? 8 : 16;
1100  // Look for a valid contribution at the given offset.
1101  auto DescOrError = parseDWARFStringOffsetsTableHeader(DA, Header.getFormat(), Offset);
1102  if (!DescOrError)
1103  return DescOrError.takeError();
1104  return *DescOrError;
1105  }
1106  // Prior to DWARF v5, we derive the contribution size from the
1107  // index table (in a package file). In a .dwo file it is simply
1108  // the length of the string offsets section.
1110  if (C)
1111  Desc = StrOffsetsContributionDescriptor(C->Offset, C->Length, 4,
1112  Header.getFormat());
1113  else if (!IndexEntry && !StringOffsetSection.Data.empty())
1114  Desc = StrOffsetsContributionDescriptor(0, StringOffsetSection.Data.size(),
1115  4, Header.getFormat());
1116  else
1117  return None;
1118  auto DescOrError = Desc.validateContributionSize(DA);
1119  if (!DescOrError)
1120  return DescOrError.takeError();
1121  return *DescOrError;
1122 }
1123 
1125  DataExtractor RangesData(RangeSection->Data, isLittleEndian,
1126  getAddressByteSize());
1127  DWARFDataExtractor RangesDA(Context.getDWARFObj(), *RangeSection,
1128  isLittleEndian, 0);
1130  RangesData, RangeSectionBase, getFormat(), Index))
1131  return *Off + RangeSectionBase;
1132  return None;
1133 }
1134 
1137  LocTable->getData(), LocSectionBase, getFormat(), Index))
1138  return *Off + LocSectionBase;
1139  return None;
1140 }
llvm::DWARFLocationExpressionsVector
std::vector< DWARFLocationExpression > DWARFLocationExpressionsVector
Represents a set of absolute location expressions.
Definition: DWARFLocationExpression.h:45
llvm::DWARFDebugRangeList
Definition: DWARFDebugRangeList.h:24
llvm::alignTo
uint64_t alignTo(uint64_t Size, Align A)
Returns a multiple of A needed to store Size bytes.
Definition: Alignment.h:156
llvm::DWARFSection
Definition: DWARFSection.h:16
DWARFFormValue.h
llvm::DWARFUnit::getAbbreviations
const DWARFAbbreviationDeclarationSet * getAbbreviations() const
Definition: DWARFUnit.cpp:979
llvm::errc::invalid_argument
@ invalid_argument
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:662
llvm::DWARFUnit::getFirstChild
DWARFDie getFirstChild(const DWARFDebugInfoEntry *Die)
Definition: DWARFUnit.cpp:935
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:94
llvm::DWARFDie::getRangesBaseAttribute
Optional< uint64_t > getRangesBaseAttribute() const
Extract the range base attribute from this DIE as absolute section offset.
Definition: DWARFDie.cpp:333
llvm::upper_bound
auto upper_bound(R &&Range, T &&Value)
Provide wrappers to std::upper_bound which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:1749
DWARFCompileUnit.h
llvm::DWARFUnit::getRnglistOffset
Optional< uint64_t > getRnglistOffset(uint32_t Index)
Return a rangelist's offset based on an index.
Definition: DWARFUnit.cpp:1124
StringRef.h
DWARFObject.h
parseDWARF64StringOffsetsTableHeader
static Expected< StrOffsetsContributionDescriptor > parseDWARF64StringOffsetsTableHeader(DWARFDataExtractor &DA, uint64_t Offset)
Definition: DWARFUnit.cpp:1012
Path.h
llvm::Error::success
static ErrorSuccess success()
Create a success value.
Definition: Error.h:329
DWARFContext.h
llvm::dwarf::toSectionedAddress
Optional< object::SectionedAddress > toSectionedAddress(const Optional< DWARFFormValue > &V)
Definition: DWARFFormValue.h:297
llvm::dwarf::DW_LENGTH_DWARF64
@ DW_LENGTH_DWARF64
Indicator of 64-bit DWARF format.
Definition: Dwarf.h:57
Errc.h
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:42
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:53
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:996
llvm::StrOffsetsContributionDescriptor::Base
uint64_t Base
Definition: DWARFUnit.h:184
llvm::sys::path::end
const_iterator end(StringRef path)
Get end iterator over path.
Definition: Path.cpp:235
llvm::dwarf::FormParams::AddrSize
uint8_t AddrSize
Definition: Dwarf.h:655
llvm::DWARFUnitIndex::Entry
Definition: DWARFUnitIndex.h:111
llvm::sys::path::begin
const_iterator begin(StringRef path, Style style=Style::native)
Get begin iterator over path.
Definition: Path.cpp:226
llvm::DWARFLocationExpression
Represents a single DWARF expression, whose value is location-dependent.
Definition: DWARFLocationExpression.h:22
llvm::Optional
Definition: APInt.h:33
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::DWARFDebugInfoEntry
DWARFDebugInfoEntry - A DIE with only the minimum required data.
Definition: DWARFDebugInfoEntry.h:22
RHS
Value * RHS
Definition: X86PartialReduction.cpp:76
llvm::DataExtractor::getU64
uint64_t getU64(uint64_t *offset_ptr, Error *Err=nullptr) const
Extract a uint64_t value from *offset_ptr.
Definition: DataExtractor.cpp:116
llvm::DWARFDataExtractor
A DataExtractor (typically for an in-memory copy of an object-file section) plus a relocation map for...
Definition: DWARFDataExtractor.h:21
BaseType
llvm::detail::DenseSetImpl::insert
std::pair< iterator, bool > insert(const ValueT &V)
Definition: DenseSet.h:206
llvm::StrOffsetsContributionDescriptor::Size
uint64_t Size
The contribution size not including the header.
Definition: DWARFUnit.h:186
llvm::dwarf::FormParams::Format
DwarfFormat Format
Definition: Dwarf.h:656
getTag
static Optional< unsigned > getTag(const TargetRegisterInfo *TRI, const MachineInstr &MI, const LoadInfo &LI)
Definition: AArch64FalkorHWPFFix.cpp:659
llvm::consumeError
void consumeError(Error Err)
Consume a Error without doing anything.
Definition: Error.h:1043
llvm::Data
@ Data
Definition: SIMachineScheduler.h:55
llvm::DWARFUnitHeader::getFormat
dwarf::DwarfFormat getFormat() const
Definition: DWARFUnit.h:88
llvm::DWARFUnit::getAddrOffsetSectionItem
Optional< object::SectionedAddress > getAddrOffsetSectionItem(uint32_t Index) const
Definition: DWARFUnit.cpp:208
llvm::DWARFUnit::getLoclistOffset
Optional< uint64_t > getLoclistOffset(uint32_t Index)
Definition: DWARFUnit.cpp:1135
llvm::sys::path::append
void append(SmallVectorImpl< char > &path, const Twine &a, const Twine &b="", const Twine &c="", const Twine &d="")
Append to path.
Definition: Path.cpp:456
Context
LLVMContext & Context
Definition: NVVMIntrRange.cpp:66
llvm::DWARFUnit::getUnitDIE
DWARFDie getUnitDIE(bool ExtractUnitDIEOnly=true)
Definition: DWARFUnit.h:402
LHS
Value * LHS
Definition: X86PartialReduction.cpp:75
llvm::DWARFUnit::getDWOId
Optional< uint64_t > getDWOId()
Definition: DWARFUnit.h:417
isType
static bool isType(const Metadata *MD)
Definition: Verifier.cpp:978
DWARFDebugRangeList.h
llvm::DWARFDataExtractor::getRelocatedValue
uint64_t getRelocatedValue(uint32_t Size, uint64_t *Off, uint64_t *SectionIndex=nullptr, Error *Err=nullptr) const
Extracts a value and applies a relocation to the result if one exists for the given offset.
Definition: DWARFDataExtractor.cpp:48
SmallString.h
E
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
llvm::DWARFDie::isSubroutineDIE
bool isSubroutineDIE() const
Returns true if DIE represents a subprogram or an inlined subroutine.
Definition: DWARFDie.cpp:240
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:1075
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:183
llvm::DWARFSectionKind
DWARFSectionKind
The enum of section identifiers to be used in internal interfaces.
Definition: DWARFUnitIndex.h:56
llvm::DWARFUnitIndex
Definition: DWARFUnitIndex.h:99
DWARFSection.h
UINT64_MAX
#define UINT64_MAX
Definition: DataTypes.h:77
DWARFDie.h
llvm::M68kBeads::DA
@ DA
Definition: M68kBaseInfo.h:59
llvm::dwarf::Index
Index
Definition: Dwarf.h:472
DWARFDebugLoc.h
B
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
llvm::DWARFUnitHeader::setDWOId
void setDWOId(uint64_t Id)
Definition: DWARFUnit.h:97
llvm::DWARFUnitHeader::isTypeUnit
bool isTypeUnit() const
Definition: DWARFUnit.h:105
llvm::DWARFUnit::getVariableForAddress
DWARFDie getVariableForAddress(uint64_t Address)
Returns variable DIE for the address provided.
Definition: DWARFUnit.cpp:829
llvm::dwarf::toSectionOffset
Optional< uint64_t > toSectionOffset(const Optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract an section offset.
Definition: DWARFFormValue.h:318
llvm::DWARFExpression::begin
iterator begin() const
Definition: DWARFExpression.h:148
llvm::dwarf::DW_LENGTH_lo_reserved
@ DW_LENGTH_lo_reserved
Special values for an initial length field.
Definition: Dwarf.h:56
llvm::DWARFContext::checkAddressSizeSupported
static Error checkAddressSizeSupported(unsigned AddressSize, std::error_code EC, char const *Fmt, const Ts &...Vals)
Definition: DWARFContext.h:392
llvm::DW_SECT_EXT_TYPES
@ DW_SECT_EXT_TYPES
Definition: DWARFUnitIndex.h:62
llvm::DWARFObject
Definition: DWARFObject.h:25
llvm::AArch64CC::LE
@ LE
Definition: AArch64BaseInfo.h:268
DWARFListTable.h
llvm::IndexedInstrProf::Version
const uint64_t Version
Definition: InstrProf.h:1027
llvm::dwarf::DwarfFormat
DwarfFormat
Constants that define the DWARF format as 32 or 64 bit.
Definition: Dwarf.h:93
llvm::None
const NoneType None
Definition: None.h:24
llvm::lltok::Kind
Kind
Definition: LLToken.h:18
llvm::DWARFUnit::updateAddressDieMap
void updateAddressDieMap(DWARFDie Die)
Recursively update address to Die map.
Definition: DWARFUnit.cpp:710
llvm::DWARFUnit::getParent
DWARFDie getParent(const DWARFDebugInfoEntry *Die)
Definition: DWARFUnit.cpp:879
llvm::SmallString< 16 >
llvm::DWARFCompileUnit
Definition: DWARFCompileUnit.h:22
llvm::DWARFUnit::getSubroutineForAddress
DWARFDie getSubroutineForAddress(uint64_t Address)
Returns subprogram DIE with address range encompassing the provided address.
Definition: DWARFUnit.cpp:741
llvm::DWARFDebugRangeList::extract
Error extract(const DWARFDataExtractor &data, uint64_t *offset_ptr)
Definition: DWARFDebugRangeList.cpp:31
llvm::DataExtractor::size
size_t size() const
Return the number of bytes in the underlying buffer.
Definition: DataExtractor.h:688
llvm::DWARFAbbreviationDeclarationSet
Definition: DWARFDebugAbbrev.h:22
llvm::X86AS::SS
@ SS
Definition: X86.h:193
llvm::DWARFUnit::~DWARFUnit
virtual ~DWARFUnit()
llvm::DWARFUnit::getDebugInfoExtractor
DWARFDataExtractor getDebugInfoExtractor() const
Definition: DWARFUnit.cpp:202
llvm::DWARFUnit::collectAddressRanges
Expected< DWARFAddressRangesVector > collectAddressRanges()
Definition: DWARFUnit.cpp:672
llvm::DWARFUnit::findLoclistFromOffset
Expected< DWARFLocationExpressionsVector > findLoclistFromOffset(uint64_t Offset)
Definition: DWARFUnit.cpp:687
llvm::AMDGPU::Hwreg::Offset
Offset
Definition: SIDefines.h:413
llvm::StringRef::empty
constexpr LLVM_NODISCARD bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:153
llvm::DWARFListTableHeader::getHeaderSize
static uint8_t getHeaderSize(dwarf::DwarfFormat Format)
Return the size of the table header including the length but not including the offsets.
Definition: DWARFListTable.h:103
llvm::DWARFLocationTable::visitAbsoluteLocationList
Error visitAbsoluteLocationList(uint64_t Offset, Optional< object::SectionedAddress > BaseAddr, std::function< Optional< object::SectionedAddress >(uint32_t)> LookupAddr, function_ref< bool(Expected< DWARFLocationExpression >)> Callback) const
Definition: DWARFDebugLoc.cpp:172
llvm::DWARFDebugRnglistTable
Definition: DWARFDebugRnglists.h:63
uint64_t
D
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
llvm::find
auto find(R &&Range, const T &Val)
Provide wrappers to std::find which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1637
llvm::DWARFUnitHeader
Base class describing the header of any kind of "unit." Some information is specific to certain unit ...
Definition: DWARFUnit.h:51
llvm::DW_SECT_EXT_LOC
@ DW_SECT_EXT_LOC
Definition: DWARFUnitIndex.h:63
llvm::DWARFDie::getAddressRanges
Expected< DWARFAddressRangesVector > getAddressRanges() const
Get the address ranges for this DIE.
Definition: DWARFDie.cpp:373
llvm::DWARFListTableHeader::getOffsetEntry
Optional< uint64_t > getOffsetEntry(DataExtractor Data, uint32_t Index) const
Definition: DWARFListTable.h:115
move
compiles ldr LCPI1_0 ldr ldr mov lsr tst moveq r1 ldr LCPI1_1 and r0 bx lr It would be better to do something like to fold the shift into the conditional move
Definition: README.txt:546
llvm::numbers::e
constexpr double e
Definition: MathExtras.h:57
llvm::DWARFUnitIndex::Entry::getContribution
const SectionContribution * getContribution(DWARFSectionKind Sec) const
Definition: DWARFUnitIndex.cpp:248
I
#define I(x, y, z)
Definition: MD5.cpp:58
DWARFUnit.h
llvm::DWARFUnit::getSibling
DWARFDie getSibling(const DWARFDebugInfoEntry *Die)
Definition: DWARFUnit.cpp:892
llvm::DWARFDie::find
Optional< DWARFFormValue > find(dwarf::Attribute Attr) const
Extract the specified attribute from this DIE.
Definition: DWARFDie.cpp:245
llvm::DWARFUnit::getDwarfStringOffsetsByteSize
uint8_t getDwarfStringOffsetsByteSize() const
Definition: DWARFUnit.h:369
llvm::joinErrors
Error joinErrors(Error E1, Error E2)
Concatenate errors.
Definition: Error.h:426
llvm::DWARFExpression
Definition: DWARFExpression.h:24
DWARFDebugRnglists.h
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:187
llvm::dwarf::UnitType
UnitType
Constants for unit types in DWARF v5.
Definition: Dwarf.h:465
llvm::DataExtractor::getUnsigned
uint64_t getUnsigned(uint64_t *offset_ptr, uint32_t byte_size, Error *Err=nullptr) const
Extract an unsigned integer of size byte_size from *offset_ptr.
Definition: DataExtractor.cpp:125
llvm::DataExtractor::isValidOffset
bool isValidOffset(uint64_t offset) const
Test the validity of offset.
Definition: DataExtractor.h:665
DWARFAbbreviationDeclaration.h
llvm::DWARFExpression::end
iterator end() const
Definition: DWARFExpression.h:149
assert
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
llvm::DWARFDataExtractor::getInitialLength
std::pair< uint64_t, dwarf::DwarfFormat > getInitialLength(uint64_t *Off, Error *Err=nullptr) const
Extracts the DWARF "initial length" field, which can either be a 32-bit value smaller than 0xfffffff0...
Definition: DWARFDataExtractor.cpp:17
ObjectFile.h
llvm::DWARFUnit::getFormat
dwarf::DwarfFormat getFormat() const
Definition: DWARFUnit.h:303
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:101
llvm::DWARFUnit::getNextUnitOffset
uint64_t getNextUnitOffset() const
Definition: DWARFUnit.h:307
llvm::DWARFUnit::clear
void clear()
Definition: DWARFUnit.cpp:375
llvm::DWARFDebugAbbrev::getAbbreviationDeclarationSet
const DWARFAbbreviationDeclarationSet * getAbbreviationDeclarationSet(uint64_t CUAbbrOffset) const
Definition: DWARFDebugAbbrev.cpp:143
llvm::dwarf::toString
Optional< const char * > toString(const Optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract a string value from it.
Definition: DWARFFormValue.h:177
llvm::DWARFUnitVector::getUnitForIndexEntry
DWARFUnit * getUnitForIndexEntry(const DWARFUnitIndex::Entry &E)
Definition: DWARFUnit.cpp:158
llvm::DWARFDebugInfoEntry::getParentIdx
Optional< uint32_t > getParentIdx() const
Returns index of the parent die.
Definition: DWARFDebugInfoEntry.h:48
llvm::hasSingleElement
bool hasSingleElement(ContainerTy &&C)
Returns true if the given container only contains a single element.
Definition: STLExtras.h:273
llvm::DWARFUnit::getCompilationDir
const char * getCompilationDir()
Definition: DWARFUnit.cpp:389
llvm::DWARFUnitVector::addUnit
DWARFUnit * addUnit(std::unique_ptr< DWARFUnit > Unit)
Add an existing DWARFUnit to this UnitVector.
Definition: DWARFUnit.cpp:136
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:58
Dwarf.h
llvm::DWARFDebugRangeList::getAbsoluteRanges
DWARFAddressRangesVector getAbsoluteRanges(llvm::Optional< object::SectionedAddress > BaseAddr) const
getAbsoluteRanges - Returns absolute address ranges defined by this range list.
Definition: DWARFDebugRangeList.cpp:87
llvm::DWARFUnitHeader::getAddressByteSize
uint8_t getAddressByteSize() const
Definition: DWARFUnit.h:89
llvm::DWARFUnitVector::getUnitForOffset
DWARFUnit * getUnitForOffset(uint64_t Offset) const
Definition: DWARFUnit.cpp:145
uint32_t
DWARFDebugInfoEntry.h
DC
static ManagedStatic< DebugCounter > DC
Definition: DebugCounter.cpp:69
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:247
llvm::DWARFDie::getSibling
DWARFDie getSibling() const
Get the sibling of this DIE object.
Definition: DWARFDie.cpp:626
llvm::DWARFUnitHeader::getNextUnitOffset
uint64_t getNextUnitOffset() const
Definition: DWARFUnit.h:112
llvm::DWARFDebugInfoEntry::getSiblingIdx
Optional< uint32_t > getSiblingIdx() const
Returns index of the sibling die.
Definition: DWARFDebugInfoEntry.h:56
llvm::DataExtractor::getU8
uint8_t getU8(uint64_t *offset_ptr, Error *Err=nullptr) const
Extract a uint8_t value from *offset_ptr.
Definition: DataExtractor.cpp:79
llvm::DWARFUnit::getStringOffsetSectionItem
Expected< uint64_t > getStringOffsetSectionItem(uint32_t Index) const
Definition: DWARFUnit.cpp:231
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:645
llvm::DWARFUnitHeader::getVersion
uint16_t getVersion() const
Definition: DWARFUnit.h:87
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:365
llvm::DWARFUnitHeader::getDWOId
Optional< uint64_t > getDWOId() const
Definition: DWARFUnit.h:96
llvm::StringRef::size
constexpr LLVM_NODISCARD size_t size() const
size - Get the string size.
Definition: StringRef.h:157
parseDWARFStringOffsetsTableHeader
static Expected< StrOffsetsContributionDescriptor > parseDWARFStringOffsetsTableHeader(DWARFDataExtractor &DA, llvm::dwarf::DwarfFormat Format, uint64_t Offset)
Definition: DWARFUnit.cpp:1047
llvm::Twine
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:83
llvm::DWARFDie::getParent
DWARFDie getParent() const
Get the parent of this DIE object.
Definition: DWARFDie.cpp:620
llvm::DWARFUnit::getAddressByteSize
uint8_t getAddressByteSize() const
Definition: DWARFUnit.h:295
llvm::DWARFUnit::getLastChild
DWARFDie getLastChild(const DWARFDebugInfoEntry *Die)
Definition: DWARFUnit.cpp:948
llvm::createStringError
Error createStringError(std::error_code EC, char const *Fmt, const Ts &... Vals)
Create formatted StringError object.
Definition: Error.h:1239
llvm::SectionKind
SectionKind - This is a simple POD value that classifies the properties of a section.
Definition: SectionKind.h:22
llvm::inconvertibleErrorCode
std::error_code inconvertibleErrorCode()
The value returned by this function can be returned from convertToErrorCode for Error values where no...
Definition: Error.cpp:77
DWARFDebugAbbrev.h
llvm::toString
const char * toString(DWARFSectionKind Kind)
Definition: DWARFUnitIndex.h:67
llvm::DWARFAbbreviationDeclaration
Definition: DWARFAbbreviationDeclaration.h:27
llvm::DWARFUnit
Definition: DWARFUnit.h:207
llvm::DWARFUnit::setRangesSection
void setRangesSection(const DWARFSection *RS, uint64_t Base)
Definition: DWARFUnit.h:335
llvm::DWARFUnit::getHeaderSize
uint32_t getHeaderSize() const
Size in bytes of the parsed unit header.
Definition: DWARFUnit.h:301
llvm::DWARFUnit::getPreviousSibling
DWARFDie getPreviousSibling(const DWARFDebugInfoEntry *Die)
Definition: DWARFUnit.cpp:905
llvm::DWARFUnit::tryExtractDIEsIfNeeded
Error tryExtractDIEsIfNeeded(bool CUDieOnly)
Definition: DWARFUnit.cpp:486
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:85
llvm::AArch64CC::LS
@ LS
Definition: AArch64BaseInfo.h:264
DataExtractor.h
llvm::DWARFListTableBase::findList
Expected< DWARFListType > findList(DWARFDataExtractor Data, uint64_t Offset) const
Look up a list based on a given offset.
Definition: DWARFListTable.h:279
llvm::DWARFUnit::getOffset
uint64_t getOffset() const
Definition: DWARFUnit.h:290
DWARFExpression.h
DWARFTypeUnit.h
llvm::StrOffsetsContributionDescriptor::getDwarfOffsetByteSize
uint8_t getDwarfOffsetByteSize() const
Definition: DWARFUnit.h:197
llvm::DWARFUnit::getInlinedChainForAddress
void getInlinedChainForAddress(uint64_t Address, SmallVectorImpl< DWARFDie > &InlinedChain)
getInlinedChainForAddress - fetches inlined chain for a given address.
Definition: DWARFUnit.cpp:850
llvm::dwarf::toUnsigned
Optional< uint64_t > toUnsigned(const Optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract an unsigned constant.
Definition: DWARFFormValue.h:225
parseDWARF32StringOffsetsTableHeader
static Expected< StrOffsetsContributionDescriptor > parseDWARF32StringOffsetsTableHeader(DWARFDataExtractor &DA, uint64_t Offset)
Definition: DWARFUnit.cpp:1030
llvm::dwarf::FormParams::Version
uint16_t Version
Definition: Dwarf.h:654
llvm::DWARFUnit::getAbbreviationsOffset
uint64_t getAbbreviationsOffset() const
Definition: DWARFUnit.h:379
llvm::DataExtractor
Definition: DataExtractor.h:41
llvm::DWARFDie::getTag
dwarf::Tag getTag() const
Definition: DWARFDie.h:72
llvm::DWARFUnitHeader::getUnitLengthFieldByteSize
uint8_t getUnitLengthFieldByteSize() const
Definition: DWARFUnit.h:109
llvm::DWARFUnitHeader::applyIndexEntry
bool applyIndexEntry(const DWARFUnitIndex::Entry *Entry)
Definition: DWARFUnit.cpp:348
llvm::DWARFUnit::getBaseAddress
llvm::Optional< object::SectionedAddress > getBaseAddress()
Definition: DWARFUnit.cpp:985
llvm::SmallVectorImpl
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: APFloat.h:42
llvm::getDWARFUnitIndex
const DWARFUnitIndex & getDWARFUnitIndex(DWARFContext &Context, DWARFSectionKind Kind)
Definition: DWARFUnit.cpp:871
llvm::dwarf::DWARF64
@ DWARF64
Definition: Dwarf.h:93
llvm::DWARFDie
Utility class that carries the DWARF compile/type unit and the debug info entry in an object.
Definition: DWARFDie.h:43
llvm::DWARFDie::isSubprogramDIE
bool isSubprogramDIE() const
Returns true if DIE represents a subprogram (not inlined).
Definition: DWARFDie.cpp:238
llvm::DWARFDebugInfoEntry::hasChildren
bool hasChildren() const
Definition: DWARFDebugInfoEntry.h:70
llvm::DWARFUnit::getLocationTable
const DWARFLocationTable & getLocationTable()
Definition: DWARFUnit.h:354
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:1088
llvm::DWARFContext::isSupportedVersion
static bool isSupportedVersion(unsigned version)
Definition: DWARFContext.h:381
llvm::DWARFSection::Data
StringRef Data
Definition: DWARFSection.h:17
llvm::sys::path::is_relative
bool is_relative(const Twine &path, Style style=Style::native)
Is path relative?
Definition: Path.cpp:699
CU
Definition: AArch64AsmBackend.cpp:504
llvm::DWARFUnit::getStringOffsetsBase
uint64_t getStringOffsetsBase() const
Definition: DWARFUnit.h:374
llvm::DWARFUnit::updateVariableDieMap
void updateVariableDieMap(DWARFDie Die)
Recursively update address to variable Die map.
Definition: DWARFUnit.cpp:755
llvm::DWARFUnit::getVersion
uint16_t getVersion() const
Definition: DWARFUnit.h:294
llvm::DWARFDie::getFirstChild
DWARFDie getFirstChild() const
Get the first child of this DIE object.
Definition: DWARFDie.cpp:638
llvm::DWARFContext::getMaxSupportedVersion
static unsigned getMaxSupportedVersion()
Definition: DWARFContext.h:380
llvm::dwarf::DWARF32
@ DWARF32
Definition: Dwarf.h:93
llvm::DWARFUnitHeader::getTypeHash
uint64_t getTypeHash() const
Definition: DWARFUnit.h:102
llvm::DataExtractor::getU16
uint16_t getU16(uint64_t *offset_ptr, Error *Err=nullptr) const
Extract a uint16_t value from *offset_ptr.
Definition: DataExtractor.cpp:92
llvm::DWARFUnitVector
Describe a collection of units.
Definition: DWARFUnit.h:124