LLVM  7.0.0svn
DWARFVerifier.cpp
Go to the documentation of this file.
1 //===- DWARFVerifier.cpp --------------------------------------------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
11 #include "llvm/ADT/SmallSet.h"
19 #include "llvm/Support/DJB.h"
21 #include "llvm/Support/WithColor.h"
23 #include <map>
24 #include <set>
25 #include <vector>
26 
27 using namespace llvm;
28 using namespace dwarf;
29 using namespace object;
30 
33  auto Begin = Ranges.begin();
34  auto End = Ranges.end();
35  auto Pos = std::lower_bound(Begin, End, R);
36 
37  if (Pos != End) {
38  if (Pos->intersects(R))
39  return Pos;
40  if (Pos != Begin) {
41  auto Iter = Pos - 1;
42  if (Iter->intersects(R))
43  return Iter;
44  }
45  }
46 
47  Ranges.insert(Pos, R);
48  return Ranges.end();
49 }
50 
53  auto End = Children.end();
54  auto Iter = Children.begin();
55  while (Iter != End) {
56  if (Iter->intersects(RI))
57  return Iter;
58  ++Iter;
59  }
60  Children.insert(RI);
61  return Children.end();
62 }
63 
65  // Both list of ranges are sorted so we can make this fast.
66 
67  if (Ranges.empty() || RHS.Ranges.empty())
68  return false;
69 
70  // Since the ranges are sorted we can advance where we start searching with
71  // this object's ranges as we traverse RHS.Ranges.
72  auto End = Ranges.end();
73  auto Iter = findRange(RHS.Ranges.front());
74 
75  // Now linearly walk the ranges in this object and see if they contain each
76  // ranges from RHS.Ranges.
77  for (const auto &R : RHS.Ranges) {
78  while (Iter != End) {
79  if (Iter->contains(R))
80  break;
81  ++Iter;
82  }
83  if (Iter == End)
84  return false;
85  }
86  return true;
87 }
88 
90  if (Ranges.empty() || RHS.Ranges.empty())
91  return false;
92 
93  auto End = Ranges.end();
94  auto Iter = findRange(RHS.Ranges.front());
95  for (const auto &R : RHS.Ranges) {
96  if(Iter == End)
97  return false;
98  if (R.HighPC <= Iter->LowPC)
99  continue;
100  while (Iter != End) {
101  if (Iter->intersects(R))
102  return true;
103  ++Iter;
104  }
105  }
106 
107  return false;
108 }
109 
110 bool DWARFVerifier::verifyUnitHeader(const DWARFDataExtractor DebugInfoData,
111  uint32_t *Offset, unsigned UnitIndex,
112  uint8_t &UnitType, bool &isUnitDWARF64) {
113  uint32_t AbbrOffset, Length;
114  uint8_t AddrSize = 0;
115  uint16_t Version;
116  bool Success = true;
117 
118  bool ValidLength = false;
119  bool ValidVersion = false;
120  bool ValidAddrSize = false;
121  bool ValidType = true;
122  bool ValidAbbrevOffset = true;
123 
124  uint32_t OffsetStart = *Offset;
125  Length = DebugInfoData.getU32(Offset);
126  if (Length == UINT32_MAX) {
127  isUnitDWARF64 = true;
128  OS << format(
129  "Unit[%d] is in 64-bit DWARF format; cannot verify from this point.\n",
130  UnitIndex);
131  return false;
132  }
133  Version = DebugInfoData.getU16(Offset);
134 
135  if (Version >= 5) {
136  UnitType = DebugInfoData.getU8(Offset);
137  AddrSize = DebugInfoData.getU8(Offset);
138  AbbrOffset = DebugInfoData.getU32(Offset);
139  ValidType = dwarf::isUnitType(UnitType);
140  } else {
141  UnitType = 0;
142  AbbrOffset = DebugInfoData.getU32(Offset);
143  AddrSize = DebugInfoData.getU8(Offset);
144  }
145 
146  if (!DCtx.getDebugAbbrev()->getAbbreviationDeclarationSet(AbbrOffset))
147  ValidAbbrevOffset = false;
148 
149  ValidLength = DebugInfoData.isValidOffset(OffsetStart + Length + 3);
150  ValidVersion = DWARFContext::isSupportedVersion(Version);
151  ValidAddrSize = AddrSize == 4 || AddrSize == 8;
152  if (!ValidLength || !ValidVersion || !ValidAddrSize || !ValidAbbrevOffset ||
153  !ValidType) {
154  Success = false;
155  error() << format("Units[%d] - start offset: 0x%08x \n", UnitIndex,
156  OffsetStart);
157  if (!ValidLength)
158  note() << "The length for this unit is too "
159  "large for the .debug_info provided.\n";
160  if (!ValidVersion)
161  note() << "The 16 bit unit header version is not valid.\n";
162  if (!ValidType)
163  note() << "The unit type encoding is not valid.\n";
164  if (!ValidAbbrevOffset)
165  note() << "The offset into the .debug_abbrev section is "
166  "not valid.\n";
167  if (!ValidAddrSize)
168  note() << "The address size is unsupported.\n";
169  }
170  *Offset = OffsetStart + Length + 4;
171  return Success;
172 }
173 
174 bool DWARFVerifier::verifyUnitContents(DWARFUnit Unit, uint8_t UnitType) {
175  uint32_t NumUnitErrors = 0;
176  unsigned NumDies = Unit.getNumDIEs();
177  for (unsigned I = 0; I < NumDies; ++I) {
178  auto Die = Unit.getDIEAtIndex(I);
179  if (Die.getTag() == DW_TAG_null)
180  continue;
181  for (auto AttrValue : Die.attributes()) {
182  NumUnitErrors += verifyDebugInfoAttribute(Die, AttrValue);
183  NumUnitErrors += verifyDebugInfoForm(Die, AttrValue);
184  }
185  }
186 
187  DWARFDie Die = Unit.getUnitDIE(/* ExtractUnitDIEOnly = */ false);
188  if (!Die) {
189  error() << "Compilation unit without DIE.\n";
190  NumUnitErrors++;
191  return NumUnitErrors == 0;
192  }
193 
194  if (!dwarf::isUnitType(Die.getTag())) {
195  error() << "Compilation unit root DIE is not a unit DIE: "
196  << dwarf::TagString(Die.getTag()) << ".\n";
197  NumUnitErrors++;
198  }
199 
200  if (UnitType != 0 &&
201  !DWARFUnit::isMatchingUnitTypeAndTag(UnitType, Die.getTag())) {
202  error() << "Compilation unit type (" << dwarf::UnitTypeString(UnitType)
203  << ") and root DIE (" << dwarf::TagString(Die.getTag())
204  << ") do not match.\n";
205  NumUnitErrors++;
206  }
207 
208  DieRangeInfo RI;
209  NumUnitErrors += verifyDieRanges(Die, RI);
210 
211  return NumUnitErrors == 0;
212 }
213 
214 unsigned DWARFVerifier::verifyAbbrevSection(const DWARFDebugAbbrev *Abbrev) {
215  unsigned NumErrors = 0;
216  if (Abbrev) {
217  const DWARFAbbreviationDeclarationSet *AbbrDecls =
219  for (auto AbbrDecl : *AbbrDecls) {
221  for (auto Attribute : AbbrDecl.attributes()) {
222  auto Result = AttributeSet.insert(Attribute.Attr);
223  if (!Result.second) {
224  error() << "Abbreviation declaration contains multiple "
225  << AttributeString(Attribute.Attr) << " attributes.\n";
226  AbbrDecl.dump(OS);
227  ++NumErrors;
228  }
229  }
230  }
231  }
232  return NumErrors;
233 }
234 
236  OS << "Verifying .debug_abbrev...\n";
237 
238  const DWARFObject &DObj = DCtx.getDWARFObj();
239  bool noDebugAbbrev = DObj.getAbbrevSection().empty();
240  bool noDebugAbbrevDWO = DObj.getAbbrevDWOSection().empty();
241 
242  if (noDebugAbbrev && noDebugAbbrevDWO) {
243  return true;
244  }
245 
246  unsigned NumErrors = 0;
247  if (!noDebugAbbrev)
248  NumErrors += verifyAbbrevSection(DCtx.getDebugAbbrev());
249 
250  if (!noDebugAbbrevDWO)
251  NumErrors += verifyAbbrevSection(DCtx.getDebugAbbrevDWO());
252  return NumErrors == 0;
253 }
254 
256  OS << "Verifying .debug_info Unit Header Chain...\n";
257 
258  const DWARFObject &DObj = DCtx.getDWARFObj();
259  DWARFDataExtractor DebugInfoData(DObj, DObj.getInfoSection(),
260  DCtx.isLittleEndian(), 0);
261  uint32_t NumDebugInfoErrors = 0;
262  uint32_t OffsetStart = 0, Offset = 0, UnitIdx = 0;
263  uint8_t UnitType = 0;
264  bool isUnitDWARF64 = false;
265  bool isHeaderChainValid = true;
266  bool hasDIE = DebugInfoData.isValidOffset(Offset);
269  while (hasDIE) {
270  OffsetStart = Offset;
271  if (!verifyUnitHeader(DebugInfoData, &Offset, UnitIdx, UnitType,
272  isUnitDWARF64)) {
273  isHeaderChainValid = false;
274  if (isUnitDWARF64)
275  break;
276  } else {
277  DWARFUnitHeader Header;
278  Header.extract(DCtx, DebugInfoData, &OffsetStart);
279  std::unique_ptr<DWARFUnit> Unit;
280  switch (UnitType) {
281  case dwarf::DW_UT_type:
282  case dwarf::DW_UT_split_type: {
283  Unit.reset(new DWARFTypeUnit(
284  DCtx, DObj.getInfoSection(), Header, DCtx.getDebugAbbrev(),
285  &DObj.getRangeSection(), DObj.getStringSection(),
287  DObj.getLineSection(), DCtx.isLittleEndian(), false, TUSection));
288  break;
289  }
290  case dwarf::DW_UT_skeleton:
291  case dwarf::DW_UT_split_compile:
292  case dwarf::DW_UT_compile:
293  case dwarf::DW_UT_partial:
294  // UnitType = 0 means that we are
295  // verifying a compile unit in DWARF v4.
296  case 0: {
297  Unit.reset(new DWARFCompileUnit(
298  DCtx, DObj.getInfoSection(), Header, DCtx.getDebugAbbrev(),
299  &DObj.getRangeSection(), DObj.getStringSection(),
301  DObj.getLineSection(), DCtx.isLittleEndian(), false, CUSection));
302  break;
303  }
304  default: { llvm_unreachable("Invalid UnitType."); }
305  }
306  if (!verifyUnitContents(*Unit, UnitType))
307  ++NumDebugInfoErrors;
308  }
309  hasDIE = DebugInfoData.isValidOffset(Offset);
310  ++UnitIdx;
311  }
312  if (UnitIdx == 0 && !hasDIE) {
313  warn() << ".debug_info is empty.\n";
314  isHeaderChainValid = true;
315  }
316  NumDebugInfoErrors += verifyDebugInfoReferences();
317  return (isHeaderChainValid && NumDebugInfoErrors == 0);
318 }
319 
320 unsigned DWARFVerifier::verifyDieRanges(const DWARFDie &Die,
321  DieRangeInfo &ParentRI) {
322  unsigned NumErrors = 0;
323 
324  if (!Die.isValid())
325  return NumErrors;
326 
328 
329  // Build RI for this DIE and check that ranges within this DIE do not
330  // overlap.
331  DieRangeInfo RI(Die);
332  for (auto Range : Ranges) {
333  if (!Range.valid()) {
334  ++NumErrors;
335  error() << "Invalid address range " << Range << "\n";
336  continue;
337  }
338 
339  // Verify that ranges don't intersect.
340  const auto IntersectingRange = RI.insert(Range);
341  if (IntersectingRange != RI.Ranges.end()) {
342  ++NumErrors;
343  error() << "DIE has overlapping address ranges: " << Range << " and "
344  << *IntersectingRange << "\n";
345  break;
346  }
347  }
348 
349  // Verify that children don't intersect.
350  const auto IntersectingChild = ParentRI.insert(RI);
351  if (IntersectingChild != ParentRI.Children.end()) {
352  ++NumErrors;
353  error() << "DIEs have overlapping address ranges:";
354  Die.dump(OS, 0);
355  IntersectingChild->Die.dump(OS, 0);
356  OS << "\n";
357  }
358 
359  // Verify that ranges are contained within their parent.
360  bool ShouldBeContained = !Ranges.empty() && !ParentRI.Ranges.empty() &&
361  !(Die.getTag() == DW_TAG_subprogram &&
362  ParentRI.Die.getTag() == DW_TAG_subprogram);
363  if (ShouldBeContained && !ParentRI.contains(RI)) {
364  ++NumErrors;
365  error() << "DIE address ranges are not contained in its parent's ranges:";
366  ParentRI.Die.dump(OS, 0);
367  Die.dump(OS, 2);
368  OS << "\n";
369  }
370 
371  // Recursively check children.
372  for (DWARFDie Child : Die)
373  NumErrors += verifyDieRanges(Child, RI);
374 
375  return NumErrors;
376 }
377 
378 unsigned DWARFVerifier::verifyDebugInfoAttribute(const DWARFDie &Die,
379  DWARFAttribute &AttrValue) {
380  unsigned NumErrors = 0;
381  auto ReportError = [&](const Twine &TitleMsg) {
382  ++NumErrors;
383  error() << TitleMsg << '\n';
384  Die.dump(OS, 0, DumpOpts);
385  OS << "\n";
386  };
387 
388  const DWARFObject &DObj = DCtx.getDWARFObj();
389  const auto Attr = AttrValue.Attr;
390  switch (Attr) {
391  case DW_AT_ranges:
392  // Make sure the offset in the DW_AT_ranges attribute is valid.
393  if (auto SectionOffset = AttrValue.Value.getAsSectionOffset()) {
394  if (*SectionOffset >= DObj.getRangeSection().Data.size())
395  ReportError("DW_AT_ranges offset is beyond .debug_ranges bounds:");
396  break;
397  }
398  ReportError("DIE has invalid DW_AT_ranges encoding:");
399  break;
400  case DW_AT_stmt_list:
401  // Make sure the offset in the DW_AT_stmt_list attribute is valid.
402  if (auto SectionOffset = AttrValue.Value.getAsSectionOffset()) {
403  if (*SectionOffset >= DObj.getLineSection().Data.size())
404  ReportError("DW_AT_stmt_list offset is beyond .debug_line bounds: " +
405  llvm::formatv("{0:x8}", *SectionOffset));
406  break;
407  }
408  ReportError("DIE has invalid DW_AT_stmt_list encoding:");
409  break;
410  case DW_AT_location: {
411  auto VerifyLocationExpr = [&](StringRef D) {
412  DWARFUnit *U = Die.getDwarfUnit();
413  DataExtractor Data(D, DCtx.isLittleEndian(), 0);
414  DWARFExpression Expression(Data, U->getVersion(),
415  U->getAddressByteSize());
416  bool Error = llvm::any_of(Expression, [](DWARFExpression::Operation &Op) {
417  return Op.isError();
418  });
419  if (Error)
420  ReportError("DIE contains invalid DWARF expression:");
421  };
422  if (Optional<ArrayRef<uint8_t>> Expr = AttrValue.Value.getAsBlock()) {
423  // Verify inlined location.
424  VerifyLocationExpr(llvm::toStringRef(*Expr));
425  } else if (auto LocOffset = AttrValue.Value.getAsSectionOffset()) {
426  // Verify location list.
427  if (auto DebugLoc = DCtx.getDebugLoc())
428  if (auto LocList = DebugLoc->getLocationListAtOffset(*LocOffset))
429  for (const auto &Entry : LocList->Entries)
430  VerifyLocationExpr({Entry.Loc.data(), Entry.Loc.size()});
431  }
432  break;
433  }
434 
435  default:
436  break;
437  }
438  return NumErrors;
439 }
440 
441 unsigned DWARFVerifier::verifyDebugInfoForm(const DWARFDie &Die,
442  DWARFAttribute &AttrValue) {
443  const DWARFObject &DObj = DCtx.getDWARFObj();
444  unsigned NumErrors = 0;
445  const auto Form = AttrValue.Value.getForm();
446  switch (Form) {
447  case DW_FORM_ref1:
448  case DW_FORM_ref2:
449  case DW_FORM_ref4:
450  case DW_FORM_ref8:
451  case DW_FORM_ref_udata: {
452  // Verify all CU relative references are valid CU offsets.
453  Optional<uint64_t> RefVal = AttrValue.Value.getAsReference();
454  assert(RefVal);
455  if (RefVal) {
456  auto DieCU = Die.getDwarfUnit();
457  auto CUSize = DieCU->getNextUnitOffset() - DieCU->getOffset();
458  auto CUOffset = AttrValue.Value.getRawUValue();
459  if (CUOffset >= CUSize) {
460  ++NumErrors;
461  error() << FormEncodingString(Form) << " CU offset "
462  << format("0x%08" PRIx64, CUOffset)
463  << " is invalid (must be less than CU size of "
464  << format("0x%08" PRIx32, CUSize) << "):\n";
465  Die.dump(OS, 0, DumpOpts);
466  OS << "\n";
467  } else {
468  // Valid reference, but we will verify it points to an actual
469  // DIE later.
470  ReferenceToDIEOffsets[*RefVal].insert(Die.getOffset());
471  }
472  }
473  break;
474  }
475  case DW_FORM_ref_addr: {
476  // Verify all absolute DIE references have valid offsets in the
477  // .debug_info section.
478  Optional<uint64_t> RefVal = AttrValue.Value.getAsReference();
479  assert(RefVal);
480  if (RefVal) {
481  if (*RefVal >= DObj.getInfoSection().Data.size()) {
482  ++NumErrors;
483  error() << "DW_FORM_ref_addr offset beyond .debug_info "
484  "bounds:\n";
485  Die.dump(OS, 0, DumpOpts);
486  OS << "\n";
487  } else {
488  // Valid reference, but we will verify it points to an actual
489  // DIE later.
490  ReferenceToDIEOffsets[*RefVal].insert(Die.getOffset());
491  }
492  }
493  break;
494  }
495  case DW_FORM_strp: {
496  auto SecOffset = AttrValue.Value.getAsSectionOffset();
497  assert(SecOffset); // DW_FORM_strp is a section offset.
498  if (SecOffset && *SecOffset >= DObj.getStringSection().size()) {
499  ++NumErrors;
500  error() << "DW_FORM_strp offset beyond .debug_str bounds:\n";
501  Die.dump(OS, 0, DumpOpts);
502  OS << "\n";
503  }
504  break;
505  }
506  default:
507  break;
508  }
509  return NumErrors;
510 }
511 
512 unsigned DWARFVerifier::verifyDebugInfoReferences() {
513  // Take all references and make sure they point to an actual DIE by
514  // getting the DIE by offset and emitting an error
515  OS << "Verifying .debug_info references...\n";
516  unsigned NumErrors = 0;
517  for (auto Pair : ReferenceToDIEOffsets) {
518  auto Die = DCtx.getDIEForOffset(Pair.first);
519  if (Die)
520  continue;
521  ++NumErrors;
522  error() << "invalid DIE reference " << format("0x%08" PRIx64, Pair.first)
523  << ". Offset is in between DIEs:\n";
524  for (auto Offset : Pair.second) {
525  auto ReferencingDie = DCtx.getDIEForOffset(Offset);
526  ReferencingDie.dump(OS, 0, DumpOpts);
527  OS << "\n";
528  }
529  OS << "\n";
530  }
531  return NumErrors;
532 }
533 
534 void DWARFVerifier::verifyDebugLineStmtOffsets() {
535  std::map<uint64_t, DWARFDie> StmtListToDie;
536  for (const auto &CU : DCtx.compile_units()) {
537  auto Die = CU->getUnitDIE();
538  // Get the attribute value as a section offset. No need to produce an
539  // error here if the encoding isn't correct because we validate this in
540  // the .debug_info verifier.
541  auto StmtSectionOffset = toSectionOffset(Die.find(DW_AT_stmt_list));
542  if (!StmtSectionOffset)
543  continue;
544  const uint32_t LineTableOffset = *StmtSectionOffset;
545  auto LineTable = DCtx.getLineTableForUnit(CU.get());
546  if (LineTableOffset < DCtx.getDWARFObj().getLineSection().Data.size()) {
547  if (!LineTable) {
548  ++NumDebugLineErrors;
549  error() << ".debug_line[" << format("0x%08" PRIx32, LineTableOffset)
550  << "] was not able to be parsed for CU:\n";
551  Die.dump(OS, 0, DumpOpts);
552  OS << '\n';
553  continue;
554  }
555  } else {
556  // Make sure we don't get a valid line table back if the offset is wrong.
557  assert(LineTable == nullptr);
558  // Skip this line table as it isn't valid. No need to create an error
559  // here because we validate this in the .debug_info verifier.
560  continue;
561  }
562  auto Iter = StmtListToDie.find(LineTableOffset);
563  if (Iter != StmtListToDie.end()) {
564  ++NumDebugLineErrors;
565  error() << "two compile unit DIEs, "
566  << format("0x%08" PRIx32, Iter->second.getOffset()) << " and "
567  << format("0x%08" PRIx32, Die.getOffset())
568  << ", have the same DW_AT_stmt_list section offset:\n";
569  Iter->second.dump(OS, 0, DumpOpts);
570  Die.dump(OS, 0, DumpOpts);
571  OS << '\n';
572  // Already verified this line table before, no need to do it again.
573  continue;
574  }
575  StmtListToDie[LineTableOffset] = Die;
576  }
577 }
578 
579 void DWARFVerifier::verifyDebugLineRows() {
580  for (const auto &CU : DCtx.compile_units()) {
581  auto Die = CU->getUnitDIE();
582  auto LineTable = DCtx.getLineTableForUnit(CU.get());
583  // If there is no line table we will have created an error in the
584  // .debug_info verifier or in verifyDebugLineStmtOffsets().
585  if (!LineTable)
586  continue;
587 
588  // Verify prologue.
589  uint32_t MaxFileIndex = LineTable->Prologue.FileNames.size();
590  uint32_t MaxDirIndex = LineTable->Prologue.IncludeDirectories.size();
591  uint32_t FileIndex = 1;
592  StringMap<uint16_t> FullPathMap;
593  for (const auto &FileName : LineTable->Prologue.FileNames) {
594  // Verify directory index.
595  if (FileName.DirIdx > MaxDirIndex) {
596  ++NumDebugLineErrors;
597  error() << ".debug_line["
598  << format("0x%08" PRIx64,
599  *toSectionOffset(Die.find(DW_AT_stmt_list)))
600  << "].prologue.file_names[" << FileIndex
601  << "].dir_idx contains an invalid index: " << FileName.DirIdx
602  << "\n";
603  }
604 
605  // Check file paths for duplicates.
606  std::string FullPath;
607  const bool HasFullPath = LineTable->getFileNameByIndex(
608  FileIndex, CU->getCompilationDir(),
610  assert(HasFullPath && "Invalid index?");
611  (void)HasFullPath;
612  auto It = FullPathMap.find(FullPath);
613  if (It == FullPathMap.end())
614  FullPathMap[FullPath] = FileIndex;
615  else if (It->second != FileIndex) {
616  warn() << ".debug_line["
617  << format("0x%08" PRIx64,
618  *toSectionOffset(Die.find(DW_AT_stmt_list)))
619  << "].prologue.file_names[" << FileIndex
620  << "] is a duplicate of file_names[" << It->second << "]\n";
621  }
622 
623  FileIndex++;
624  }
625 
626  // Verify rows.
627  uint64_t PrevAddress = 0;
628  uint32_t RowIndex = 0;
629  for (const auto &Row : LineTable->Rows) {
630  // Verify row address.
631  if (Row.Address < PrevAddress) {
632  ++NumDebugLineErrors;
633  error() << ".debug_line["
634  << format("0x%08" PRIx64,
635  *toSectionOffset(Die.find(DW_AT_stmt_list)))
636  << "] row[" << RowIndex
637  << "] decreases in address from previous row:\n";
638 
640  if (RowIndex > 0)
641  LineTable->Rows[RowIndex - 1].dump(OS);
642  Row.dump(OS);
643  OS << '\n';
644  }
645 
646  // Verify file index.
647  if (Row.File > MaxFileIndex) {
648  ++NumDebugLineErrors;
649  error() << ".debug_line["
650  << format("0x%08" PRIx64,
651  *toSectionOffset(Die.find(DW_AT_stmt_list)))
652  << "][" << RowIndex << "] has invalid file index " << Row.File
653  << " (valid values are [1," << MaxFileIndex << "]):\n";
655  Row.dump(OS);
656  OS << '\n';
657  }
658  if (Row.EndSequence)
659  PrevAddress = 0;
660  else
661  PrevAddress = Row.Address;
662  ++RowIndex;
663  }
664  }
665 }
666 
668  NumDebugLineErrors = 0;
669  OS << "Verifying .debug_line...\n";
670  verifyDebugLineStmtOffsets();
671  verifyDebugLineRows();
672  return NumDebugLineErrors == 0;
673 }
674 
675 unsigned DWARFVerifier::verifyAppleAccelTable(const DWARFSection *AccelSection,
676  DataExtractor *StrData,
677  const char *SectionName) {
678  unsigned NumErrors = 0;
679  DWARFDataExtractor AccelSectionData(DCtx.getDWARFObj(), *AccelSection,
680  DCtx.isLittleEndian(), 0);
681  AppleAcceleratorTable AccelTable(AccelSectionData, *StrData);
682 
683  OS << "Verifying " << SectionName << "...\n";
684 
685  // Verify that the fixed part of the header is not too short.
686  if (!AccelSectionData.isValidOffset(AccelTable.getSizeHdr())) {
687  error() << "Section is too small to fit a section header.\n";
688  return 1;
689  }
690 
691  // Verify that the section is not too short.
692  if (Error E = AccelTable.extract()) {
693  error() << toString(std::move(E)) << '\n';
694  return 1;
695  }
696 
697  // Verify that all buckets have a valid hash index or are empty.
698  uint32_t NumBuckets = AccelTable.getNumBuckets();
699  uint32_t NumHashes = AccelTable.getNumHashes();
700 
701  uint32_t BucketsOffset =
702  AccelTable.getSizeHdr() + AccelTable.getHeaderDataLength();
703  uint32_t HashesBase = BucketsOffset + NumBuckets * 4;
704  uint32_t OffsetsBase = HashesBase + NumHashes * 4;
705  for (uint32_t BucketIdx = 0; BucketIdx < NumBuckets; ++BucketIdx) {
706  uint32_t HashIdx = AccelSectionData.getU32(&BucketsOffset);
707  if (HashIdx >= NumHashes && HashIdx != UINT32_MAX) {
708  error() << format("Bucket[%d] has invalid hash index: %u.\n", BucketIdx,
709  HashIdx);
710  ++NumErrors;
711  }
712  }
713  uint32_t NumAtoms = AccelTable.getAtomsDesc().size();
714  if (NumAtoms == 0) {
715  error() << "No atoms: failed to read HashData.\n";
716  return 1;
717  }
718  if (!AccelTable.validateForms()) {
719  error() << "Unsupported form: failed to read HashData.\n";
720  return 1;
721  }
722 
723  for (uint32_t HashIdx = 0; HashIdx < NumHashes; ++HashIdx) {
724  uint32_t HashOffset = HashesBase + 4 * HashIdx;
725  uint32_t DataOffset = OffsetsBase + 4 * HashIdx;
726  uint32_t Hash = AccelSectionData.getU32(&HashOffset);
727  uint32_t HashDataOffset = AccelSectionData.getU32(&DataOffset);
728  if (!AccelSectionData.isValidOffsetForDataOfSize(HashDataOffset,
729  sizeof(uint64_t))) {
730  error() << format("Hash[%d] has invalid HashData offset: 0x%08x.\n",
731  HashIdx, HashDataOffset);
732  ++NumErrors;
733  }
734 
735  uint32_t StrpOffset;
736  uint32_t StringOffset;
737  uint32_t StringCount = 0;
738  unsigned Offset;
739  unsigned Tag;
740  while ((StrpOffset = AccelSectionData.getU32(&HashDataOffset)) != 0) {
741  const uint32_t NumHashDataObjects =
742  AccelSectionData.getU32(&HashDataOffset);
743  for (uint32_t HashDataIdx = 0; HashDataIdx < NumHashDataObjects;
744  ++HashDataIdx) {
745  std::tie(Offset, Tag) = AccelTable.readAtoms(HashDataOffset);
746  auto Die = DCtx.getDIEForOffset(Offset);
747  if (!Die) {
748  const uint32_t BucketIdx =
749  NumBuckets ? (Hash % NumBuckets) : UINT32_MAX;
750  StringOffset = StrpOffset;
751  const char *Name = StrData->getCStr(&StringOffset);
752  if (!Name)
753  Name = "<NULL>";
754 
755  error() << format(
756  "%s Bucket[%d] Hash[%d] = 0x%08x "
757  "Str[%u] = 0x%08x "
758  "DIE[%d] = 0x%08x is not a valid DIE offset for \"%s\".\n",
759  SectionName, BucketIdx, HashIdx, Hash, StringCount, StrpOffset,
760  HashDataIdx, Offset, Name);
761 
762  ++NumErrors;
763  continue;
764  }
765  if ((Tag != dwarf::DW_TAG_null) && (Die.getTag() != Tag)) {
766  error() << "Tag " << dwarf::TagString(Tag)
767  << " in accelerator table does not match Tag "
768  << dwarf::TagString(Die.getTag()) << " of DIE[" << HashDataIdx
769  << "].\n";
770  ++NumErrors;
771  }
772  }
773  ++StringCount;
774  }
775  }
776  return NumErrors;
777 }
778 
779 unsigned
780 DWARFVerifier::verifyDebugNamesCULists(const DWARFDebugNames &AccelTable) {
781  // A map from CU offset to the (first) Name Index offset which claims to index
782  // this CU.
784  const uint32_t NotIndexed = std::numeric_limits<uint32_t>::max();
785 
786  CUMap.reserve(DCtx.getNumCompileUnits());
787  for (const auto &CU : DCtx.compile_units())
788  CUMap[CU->getOffset()] = NotIndexed;
789 
790  unsigned NumErrors = 0;
791  for (const DWARFDebugNames::NameIndex &NI : AccelTable) {
792  if (NI.getCUCount() == 0) {
793  error() << formatv("Name Index @ {0:x} does not index any CU\n",
794  NI.getUnitOffset());
795  ++NumErrors;
796  continue;
797  }
798  for (uint32_t CU = 0, End = NI.getCUCount(); CU < End; ++CU) {
799  uint32_t Offset = NI.getCUOffset(CU);
800  auto Iter = CUMap.find(Offset);
801 
802  if (Iter == CUMap.end()) {
803  error() << formatv(
804  "Name Index @ {0:x} references a non-existing CU @ {1:x}\n",
805  NI.getUnitOffset(), Offset);
806  ++NumErrors;
807  continue;
808  }
809 
810  if (Iter->second != NotIndexed) {
811  error() << formatv("Name Index @ {0:x} references a CU @ {1:x}, but "
812  "this CU is already indexed by Name Index @ {2:x}\n",
813  NI.getUnitOffset(), Offset, Iter->second);
814  continue;
815  }
816  Iter->second = NI.getUnitOffset();
817  }
818  }
819 
820  for (const auto &KV : CUMap) {
821  if (KV.second == NotIndexed)
822  warn() << formatv("CU @ {0:x} not covered by any Name Index\n", KV.first);
823  }
824 
825  return NumErrors;
826 }
827 
828 unsigned
829 DWARFVerifier::verifyNameIndexBuckets(const DWARFDebugNames::NameIndex &NI,
830  const DataExtractor &StrData) {
831  struct BucketInfo {
832  uint32_t Bucket;
833  uint32_t Index;
834 
835  constexpr BucketInfo(uint32_t Bucket, uint32_t Index)
836  : Bucket(Bucket), Index(Index) {}
837  bool operator<(const BucketInfo &RHS) const { return Index < RHS.Index; };
838  };
839 
840  uint32_t NumErrors = 0;
841  if (NI.getBucketCount() == 0) {
842  warn() << formatv("Name Index @ {0:x} does not contain a hash table.\n",
843  NI.getUnitOffset());
844  return NumErrors;
845  }
846 
847  // Build up a list of (Bucket, Index) pairs. We use this later to verify that
848  // each Name is reachable from the appropriate bucket.
849  std::vector<BucketInfo> BucketStarts;
850  BucketStarts.reserve(NI.getBucketCount() + 1);
851  for (uint32_t Bucket = 0, End = NI.getBucketCount(); Bucket < End; ++Bucket) {
852  uint32_t Index = NI.getBucketArrayEntry(Bucket);
853  if (Index > NI.getNameCount()) {
854  error() << formatv("Bucket {0} of Name Index @ {1:x} contains invalid "
855  "value {2}. Valid range is [0, {3}].\n",
856  Bucket, NI.getUnitOffset(), Index, NI.getNameCount());
857  ++NumErrors;
858  continue;
859  }
860  if (Index > 0)
861  BucketStarts.emplace_back(Bucket, Index);
862  }
863 
864  // If there were any buckets with invalid values, skip further checks as they
865  // will likely produce many errors which will only confuse the actual root
866  // problem.
867  if (NumErrors > 0)
868  return NumErrors;
869 
870  // Sort the list in the order of increasing "Index" entries.
871  array_pod_sort(BucketStarts.begin(), BucketStarts.end());
872 
873  // Insert a sentinel entry at the end, so we can check that the end of the
874  // table is covered in the loop below.
875  BucketStarts.emplace_back(NI.getBucketCount(), NI.getNameCount() + 1);
876 
877  // Loop invariant: NextUncovered is the (1-based) index of the first Name
878  // which is not reachable by any of the buckets we processed so far (and
879  // hasn't been reported as uncovered).
880  uint32_t NextUncovered = 1;
881  for (const BucketInfo &B : BucketStarts) {
882  // Under normal circumstances B.Index be equal to NextUncovered, but it can
883  // be less if a bucket points to names which are already known to be in some
884  // bucket we processed earlier. In that case, we won't trigger this error,
885  // but report the mismatched hash value error instead. (We know the hash
886  // will not match because we have already verified that the name's hash
887  // puts it into the previous bucket.)
888  if (B.Index > NextUncovered) {
889  error() << formatv("Name Index @ {0:x}: Name table entries [{1}, {2}] "
890  "are not covered by the hash table.\n",
891  NI.getUnitOffset(), NextUncovered, B.Index - 1);
892  ++NumErrors;
893  }
894  uint32_t Idx = B.Index;
895 
896  // The rest of the checks apply only to non-sentinel entries.
897  if (B.Bucket == NI.getBucketCount())
898  break;
899 
900  // This triggers if a non-empty bucket points to a name with a mismatched
901  // hash. Clients are likely to interpret this as an empty bucket, because a
902  // mismatched hash signals the end of a bucket, but if this is indeed an
903  // empty bucket, the producer should have signalled this by marking the
904  // bucket as empty.
905  uint32_t FirstHash = NI.getHashArrayEntry(Idx);
906  if (FirstHash % NI.getBucketCount() != B.Bucket) {
907  error() << formatv(
908  "Name Index @ {0:x}: Bucket {1} is not empty but points to a "
909  "mismatched hash value {2:x} (belonging to bucket {3}).\n",
910  NI.getUnitOffset(), B.Bucket, FirstHash,
911  FirstHash % NI.getBucketCount());
912  ++NumErrors;
913  }
914 
915  // This find the end of this bucket and also verifies that all the hashes in
916  // this bucket are correct by comparing the stored hashes to the ones we
917  // compute ourselves.
918  while (Idx <= NI.getNameCount()) {
919  uint32_t Hash = NI.getHashArrayEntry(Idx);
920  if (Hash % NI.getBucketCount() != B.Bucket)
921  break;
922 
923  const char *Str = NI.getNameTableEntry(Idx).getString();
924  if (caseFoldingDjbHash(Str) != Hash) {
925  error() << formatv("Name Index @ {0:x}: String ({1}) at index {2} "
926  "hashes to {3:x}, but "
927  "the Name Index hash is {4:x}\n",
928  NI.getUnitOffset(), Str, Idx,
929  caseFoldingDjbHash(Str), Hash);
930  ++NumErrors;
931  }
932 
933  ++Idx;
934  }
935  NextUncovered = std::max(NextUncovered, Idx);
936  }
937  return NumErrors;
938 }
939 
940 unsigned DWARFVerifier::verifyNameIndexAttribute(
943  StringRef FormName = dwarf::FormEncodingString(AttrEnc.Form);
944  if (FormName.empty()) {
945  error() << formatv("NameIndex @ {0:x}: Abbreviation {1:x}: {2} uses an "
946  "unknown form: {3}.\n",
947  NI.getUnitOffset(), Abbr.Code, AttrEnc.Index,
948  AttrEnc.Form);
949  return 1;
950  }
951 
952  if (AttrEnc.Index == DW_IDX_type_hash) {
953  if (AttrEnc.Form != dwarf::DW_FORM_data8) {
954  error() << formatv(
955  "NameIndex @ {0:x}: Abbreviation {1:x}: DW_IDX_type_hash "
956  "uses an unexpected form {2} (should be {3}).\n",
957  NI.getUnitOffset(), Abbr.Code, AttrEnc.Form, dwarf::DW_FORM_data8);
958  return 1;
959  }
960  }
961 
962  // A list of known index attributes and their expected form classes.
963  // DW_IDX_type_hash is handled specially in the check above, as it has a
964  // specific form (not just a form class) we should expect.
965  struct FormClassTable {
968  StringLiteral ClassName;
969  };
970  static constexpr FormClassTable Table[] = {
971  {dwarf::DW_IDX_compile_unit, DWARFFormValue::FC_Constant, {"constant"}},
972  {dwarf::DW_IDX_type_unit, DWARFFormValue::FC_Constant, {"constant"}},
973  {dwarf::DW_IDX_die_offset, DWARFFormValue::FC_Reference, {"reference"}},
974  {dwarf::DW_IDX_parent, DWARFFormValue::FC_Constant, {"constant"}},
975  };
976 
978  auto Iter = find_if(TableRef, [AttrEnc](const FormClassTable &T) {
979  return T.Index == AttrEnc.Index;
980  });
981  if (Iter == TableRef.end()) {
982  warn() << formatv("NameIndex @ {0:x}: Abbreviation {1:x} contains an "
983  "unknown index attribute: {2}.\n",
984  NI.getUnitOffset(), Abbr.Code, AttrEnc.Index);
985  return 0;
986  }
987 
988  if (!DWARFFormValue(AttrEnc.Form).isFormClass(Iter->Class)) {
989  error() << formatv("NameIndex @ {0:x}: Abbreviation {1:x}: {2} uses an "
990  "unexpected form {3} (expected form class {4}).\n",
991  NI.getUnitOffset(), Abbr.Code, AttrEnc.Index,
992  AttrEnc.Form, Iter->ClassName);
993  return 1;
994  }
995  return 0;
996 }
997 
998 unsigned
999 DWARFVerifier::verifyNameIndexAbbrevs(const DWARFDebugNames::NameIndex &NI) {
1000  if (NI.getLocalTUCount() + NI.getForeignTUCount() > 0) {
1001  warn() << formatv("Name Index @ {0:x}: Verifying indexes of type units is "
1002  "not currently supported.\n",
1003  NI.getUnitOffset());
1004  return 0;
1005  }
1006 
1007  unsigned NumErrors = 0;
1008  for (const auto &Abbrev : NI.getAbbrevs()) {
1009  StringRef TagName = dwarf::TagString(Abbrev.Tag);
1010  if (TagName.empty()) {
1011  warn() << formatv("NameIndex @ {0:x}: Abbreviation {1:x} references an "
1012  "unknown tag: {2}.\n",
1013  NI.getUnitOffset(), Abbrev.Code, Abbrev.Tag);
1014  }
1015  SmallSet<unsigned, 5> Attributes;
1016  for (const auto &AttrEnc : Abbrev.Attributes) {
1017  if (!Attributes.insert(AttrEnc.Index).second) {
1018  error() << formatv("NameIndex @ {0:x}: Abbreviation {1:x} contains "
1019  "multiple {2} attributes.\n",
1020  NI.getUnitOffset(), Abbrev.Code, AttrEnc.Index);
1021  ++NumErrors;
1022  continue;
1023  }
1024  NumErrors += verifyNameIndexAttribute(NI, Abbrev, AttrEnc);
1025  }
1026 
1027  if (NI.getCUCount() > 1 && !Attributes.count(dwarf::DW_IDX_compile_unit)) {
1028  error() << formatv("NameIndex @ {0:x}: Indexing multiple compile units "
1029  "and abbreviation {1:x} has no {2} attribute.\n",
1030  NI.getUnitOffset(), Abbrev.Code,
1031  dwarf::DW_IDX_compile_unit);
1032  ++NumErrors;
1033  }
1034  if (!Attributes.count(dwarf::DW_IDX_die_offset)) {
1035  error() << formatv(
1036  "NameIndex @ {0:x}: Abbreviation {1:x} has no {2} attribute.\n",
1037  NI.getUnitOffset(), Abbrev.Code, dwarf::DW_IDX_die_offset);
1038  ++NumErrors;
1039  }
1040  }
1041  return NumErrors;
1042 }
1043 
1046  if (const char *Str = DIE.getName(DINameKind::ShortName))
1047  Result.emplace_back(Str);
1048  else if (DIE.getTag() == dwarf::DW_TAG_namespace)
1049  Result.emplace_back("(anonymous namespace)");
1050 
1051  if (const char *Str = DIE.getName(DINameKind::LinkageName)) {
1052  if (Result.empty() || Result[0] != Str)
1053  Result.emplace_back(Str);
1054  }
1055 
1056  return Result;
1057 }
1058 
1059 unsigned DWARFVerifier::verifyNameIndexEntries(
1060  const DWARFDebugNames::NameIndex &NI,
1061  const DWARFDebugNames::NameTableEntry &NTE) {
1062  // Verifying type unit indexes not supported.
1063  if (NI.getLocalTUCount() + NI.getForeignTUCount() > 0)
1064  return 0;
1065 
1066  const char *CStr = NTE.getString();
1067  if (!CStr) {
1068  error() << formatv(
1069  "Name Index @ {0:x}: Unable to get string associated with name {1}.\n",
1070  NI.getUnitOffset(), NTE.getIndex());
1071  return 1;
1072  }
1073  StringRef Str(CStr);
1074 
1075  unsigned NumErrors = 0;
1076  unsigned NumEntries = 0;
1077  uint32_t EntryID = NTE.getEntryOffset();
1078  uint32_t NextEntryID = EntryID;
1079  Expected<DWARFDebugNames::Entry> EntryOr = NI.getEntry(&NextEntryID);
1080  for (; EntryOr; ++NumEntries, EntryID = NextEntryID,
1081  EntryOr = NI.getEntry(&NextEntryID)) {
1082  uint32_t CUIndex = *EntryOr->getCUIndex();
1083  if (CUIndex > NI.getCUCount()) {
1084  error() << formatv("Name Index @ {0:x}: Entry @ {1:x} contains an "
1085  "invalid CU index ({2}).\n",
1086  NI.getUnitOffset(), EntryID, CUIndex);
1087  ++NumErrors;
1088  continue;
1089  }
1090  uint32_t CUOffset = NI.getCUOffset(CUIndex);
1091  uint64_t DIEOffset = CUOffset + *EntryOr->getDIEUnitOffset();
1092  DWARFDie DIE = DCtx.getDIEForOffset(DIEOffset);
1093  if (!DIE) {
1094  error() << formatv("Name Index @ {0:x}: Entry @ {1:x} references a "
1095  "non-existing DIE @ {2:x}.\n",
1096  NI.getUnitOffset(), EntryID, DIEOffset);
1097  ++NumErrors;
1098  continue;
1099  }
1100  if (DIE.getDwarfUnit()->getOffset() != CUOffset) {
1101  error() << formatv("Name Index @ {0:x}: Entry @ {1:x}: mismatched CU of "
1102  "DIE @ {2:x}: index - {3:x}; debug_info - {4:x}.\n",
1103  NI.getUnitOffset(), EntryID, DIEOffset, CUOffset,
1104  DIE.getDwarfUnit()->getOffset());
1105  ++NumErrors;
1106  }
1107  if (DIE.getTag() != EntryOr->tag()) {
1108  error() << formatv("Name Index @ {0:x}: Entry @ {1:x}: mismatched Tag of "
1109  "DIE @ {2:x}: index - {3}; debug_info - {4}.\n",
1110  NI.getUnitOffset(), EntryID, DIEOffset, EntryOr->tag(),
1111  DIE.getTag());
1112  ++NumErrors;
1113  }
1114 
1115  auto EntryNames = getNames(DIE);
1116  if (!is_contained(EntryNames, Str)) {
1117  error() << formatv("Name Index @ {0:x}: Entry @ {1:x}: mismatched Name "
1118  "of DIE @ {2:x}: index - {3}; debug_info - {4}.\n",
1119  NI.getUnitOffset(), EntryID, DIEOffset, Str,
1120  make_range(EntryNames.begin(), EntryNames.end()));
1121  ++NumErrors;
1122  }
1123  }
1124  handleAllErrors(EntryOr.takeError(),
1125  [&](const DWARFDebugNames::SentinelError &) {
1126  if (NumEntries > 0)
1127  return;
1128  error() << formatv("Name Index @ {0:x}: Name {1} ({2}) is "
1129  "not associated with any entries.\n",
1130  NI.getUnitOffset(), NTE.getIndex(), Str);
1131  ++NumErrors;
1132  },
1133  [&](const ErrorInfoBase &Info) {
1134  error()
1135  << formatv("Name Index @ {0:x}: Name {1} ({2}): {3}\n",
1136  NI.getUnitOffset(), NTE.getIndex(), Str,
1137  Info.message());
1138  ++NumErrors;
1139  });
1140  return NumErrors;
1141 }
1142 
1143 static bool isVariableIndexable(const DWARFDie &Die, DWARFContext &DCtx) {
1144  Optional<DWARFFormValue> Location = Die.findRecursively(DW_AT_location);
1145  if (!Location)
1146  return false;
1147 
1148  auto ContainsInterestingOperators = [&](StringRef D) {
1149  DWARFUnit *U = Die.getDwarfUnit();
1151  DWARFExpression Expression(Data, U->getVersion(), U->getAddressByteSize());
1152  return any_of(Expression, [](DWARFExpression::Operation &Op) {
1153  return !Op.isError() && (Op.getCode() == DW_OP_addr ||
1154  Op.getCode() == DW_OP_form_tls_address ||
1155  Op.getCode() == DW_OP_GNU_push_tls_address);
1156  });
1157  };
1158 
1159  if (Optional<ArrayRef<uint8_t>> Expr = Location->getAsBlock()) {
1160  // Inlined location.
1161  if (ContainsInterestingOperators(toStringRef(*Expr)))
1162  return true;
1163  } else if (Optional<uint64_t> Offset = Location->getAsSectionOffset()) {
1164  // Location list.
1165  if (const DWARFDebugLoc *DebugLoc = DCtx.getDebugLoc()) {
1166  if (const DWARFDebugLoc::LocationList *LocList =
1167  DebugLoc->getLocationListAtOffset(*Offset)) {
1168  if (any_of(LocList->Entries, [&](const DWARFDebugLoc::Entry &E) {
1169  return ContainsInterestingOperators({E.Loc.data(), E.Loc.size()});
1170  }))
1171  return true;
1172  }
1173  }
1174  }
1175  return false;
1176 }
1177 
1178 unsigned DWARFVerifier::verifyNameIndexCompleteness(
1179  const DWARFDie &Die, const DWARFDebugNames::NameIndex &NI) {
1180 
1181  // First check, if the Die should be indexed. The code follows the DWARF v5
1182  // wording as closely as possible.
1183 
1184  // "All non-defining declarations (that is, debugging information entries
1185  // with a DW_AT_declaration attribute) are excluded."
1186  if (Die.find(DW_AT_declaration))
1187  return 0;
1188 
1189  // "DW_TAG_namespace debugging information entries without a DW_AT_name
1190  // attribute are included with the name “(anonymous namespace)”.
1191  // All other debugging information entries without a DW_AT_name attribute
1192  // are excluded."
1193  // "If a subprogram or inlined subroutine is included, and has a
1194  // DW_AT_linkage_name attribute, there will be an additional index entry for
1195  // the linkage name."
1196  auto EntryNames = getNames(Die);
1197  if (EntryNames.empty())
1198  return 0;
1199 
1200  // We deviate from the specification here, which says:
1201  // "The name index must contain an entry for each debugging information entry
1202  // that defines a named subprogram, label, variable, type, or namespace,
1203  // subject to ..."
1204  // Instead whitelisting all TAGs representing a "type" or a "subprogram", to
1205  // make sure we catch any missing items, we instead blacklist all TAGs that we
1206  // know shouldn't be indexed.
1207  switch (Die.getTag()) {
1208  // Compile unit has a name but it shouldn't be indexed.
1209  case DW_TAG_compile_unit:
1210  return 0;
1211 
1212  // Function and template parameters are not globally visible, so we shouldn't
1213  // index them.
1214  case DW_TAG_formal_parameter:
1215  case DW_TAG_template_value_parameter:
1216  case DW_TAG_template_type_parameter:
1217  case DW_TAG_GNU_template_parameter_pack:
1218  case DW_TAG_GNU_template_template_param:
1219  return 0;
1220 
1221  // Object members aren't globally visible.
1222  case DW_TAG_member:
1223  return 0;
1224 
1225  // According to a strict reading of the specification, enumerators should not
1226  // be indexed (and LLVM currently does not do that). However, this causes
1227  // problems for the debuggers, so we may need to reconsider this.
1228  case DW_TAG_enumerator:
1229  return 0;
1230 
1231  // Imported declarations should not be indexed according to the specification
1232  // and LLVM currently does not do that.
1233  case DW_TAG_imported_declaration:
1234  return 0;
1235 
1236  // "DW_TAG_subprogram, DW_TAG_inlined_subroutine, and DW_TAG_label debugging
1237  // information entries without an address attribute (DW_AT_low_pc,
1238  // DW_AT_high_pc, DW_AT_ranges, or DW_AT_entry_pc) are excluded."
1239  case DW_TAG_subprogram:
1240  case DW_TAG_inlined_subroutine:
1241  case DW_TAG_label:
1242  if (Die.findRecursively(
1243  {DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_entry_pc}))
1244  break;
1245  return 0;
1246 
1247  // "DW_TAG_variable debugging information entries with a DW_AT_location
1248  // attribute that includes a DW_OP_addr or DW_OP_form_tls_address operator are
1249  // included; otherwise, they are excluded."
1250  //
1251  // LLVM extension: We also add DW_OP_GNU_push_tls_address to this list.
1252  case DW_TAG_variable:
1253  if (isVariableIndexable(Die, DCtx))
1254  break;
1255  return 0;
1256 
1257  default:
1258  break;
1259  }
1260 
1261  // Now we know that our Die should be present in the Index. Let's check if
1262  // that's the case.
1263  unsigned NumErrors = 0;
1264  uint64_t DieUnitOffset = Die.getOffset() - Die.getDwarfUnit()->getOffset();
1265  for (StringRef Name : EntryNames) {
1266  if (none_of(NI.equal_range(Name), [&](const DWARFDebugNames::Entry &E) {
1267  return E.getDIEUnitOffset() == DieUnitOffset;
1268  })) {
1269  error() << formatv("Name Index @ {0:x}: Entry for DIE @ {1:x} ({2}) with "
1270  "name {3} missing.\n",
1271  NI.getUnitOffset(), Die.getOffset(), Die.getTag(),
1272  Name);
1273  ++NumErrors;
1274  }
1275  }
1276  return NumErrors;
1277 }
1278 
1279 unsigned DWARFVerifier::verifyDebugNames(const DWARFSection &AccelSection,
1280  const DataExtractor &StrData) {
1281  unsigned NumErrors = 0;
1282  DWARFDataExtractor AccelSectionData(DCtx.getDWARFObj(), AccelSection,
1283  DCtx.isLittleEndian(), 0);
1284  DWARFDebugNames AccelTable(AccelSectionData, StrData);
1285 
1286  OS << "Verifying .debug_names...\n";
1287 
1288  // This verifies that we can read individual name indices and their
1289  // abbreviation tables.
1290  if (Error E = AccelTable.extract()) {
1291  error() << toString(std::move(E)) << '\n';
1292  return 1;
1293  }
1294 
1295  NumErrors += verifyDebugNamesCULists(AccelTable);
1296  for (const auto &NI : AccelTable)
1297  NumErrors += verifyNameIndexBuckets(NI, StrData);
1298  for (const auto &NI : AccelTable)
1299  NumErrors += verifyNameIndexAbbrevs(NI);
1300 
1301  // Don't attempt Entry validation if any of the previous checks found errors
1302  if (NumErrors > 0)
1303  return NumErrors;
1304  for (const auto &NI : AccelTable)
1305  for (DWARFDebugNames::NameTableEntry NTE : NI)
1306  NumErrors += verifyNameIndexEntries(NI, NTE);
1307 
1308  if (NumErrors > 0)
1309  return NumErrors;
1310 
1311  for (const std::unique_ptr<DWARFCompileUnit> &CU : DCtx.compile_units()) {
1312  if (const DWARFDebugNames::NameIndex *NI =
1313  AccelTable.getCUNameIndex(CU->getOffset())) {
1314  for (const DWARFDebugInfoEntry &Die : CU->dies())
1315  NumErrors += verifyNameIndexCompleteness(DWARFDie(CU.get(), &Die), *NI);
1316  }
1317  }
1318  return NumErrors;
1319 }
1320 
1322  const DWARFObject &D = DCtx.getDWARFObj();
1323  DataExtractor StrData(D.getStringSection(), DCtx.isLittleEndian(), 0);
1324  unsigned NumErrors = 0;
1325  if (!D.getAppleNamesSection().Data.empty())
1326  NumErrors +=
1327  verifyAppleAccelTable(&D.getAppleNamesSection(), &StrData, ".apple_names");
1328  if (!D.getAppleTypesSection().Data.empty())
1329  NumErrors +=
1330  verifyAppleAccelTable(&D.getAppleTypesSection(), &StrData, ".apple_types");
1332  NumErrors += verifyAppleAccelTable(&D.getAppleNamespacesSection(), &StrData,
1333  ".apple_namespaces");
1334  if (!D.getAppleObjCSection().Data.empty())
1335  NumErrors +=
1336  verifyAppleAccelTable(&D.getAppleObjCSection(), &StrData, ".apple_objc");
1337 
1338  if (!D.getDebugNamesSection().Data.empty())
1339  NumErrors += verifyDebugNames(D.getDebugNamesSection(), StrData);
1340  return NumErrors == 0;
1341 }
1342 
1343 raw_ostream &DWARFVerifier::error() const { return WithColor::error(OS); }
1344 
1345 raw_ostream &DWARFVerifier::warn() const { return WithColor::warning(OS); }
1346 
1347 raw_ostream &DWARFVerifier::note() const { return WithColor::note(OS); }
A list of locations that contain one variable.
Definition: DWARFDebugLoc.h:37
static bool isMatchingUnitTypeAndTag(uint8_t UnitType, dwarf::Tag Tag)
Definition: DWARFUnit.h:398
static SmallVector< StringRef, 2 > getNames(const DWARFDie &DIE)
DWARFUnit * getDwarfUnit() const
Definition: DWARFDie.h:54
uint32_t getEntryOffset() const
Returns the offset of the first Entry in the list.
GCNRegPressure max(const GCNRegPressure &P1, const GCNRegPressure &P2)
bool isValid() const
Definition: DWARFDie.h:51
dwarf::Attribute Attr
The attribute enumeration of this attribute.
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
const DWARFDebugLoc * getDebugLoc()
Get a pointer to the parsed DebugLoc object.
virtual StringRef getAbbrevSection() const
Definition: DWARFObject.h:39
bool isUnitType(uint8_t UnitType)
Definition: Dwarf.h:342
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE size_t size() const
size - Get the string size.
Definition: StringRef.h:138
static raw_ostream & error()
Convenience method for printing "error: " to stderr.
Definition: WithColor.cpp:63
This class holds an abstract representation of an Accelerator Table, consisting of a sequence of buck...
Definition: AccelTable.h:199
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
Definition: Format.h:124
bool handleDebugLine()
Verify the information in the .debug_line section.
iterator find(StringRef Key)
Definition: StringMap.h:333
auto formatv(const char *Fmt, Ts &&... Vals) -> formatv_object< decltype(std::make_tuple(detail::build_format_adapter(std::forward< Ts >(Vals))...))>
static raw_ostream & warning()
Convenience method for printing "warning: " to stderr.
Definition: WithColor.cpp:65
#define error(X)
A debug info location.
Definition: DebugLoc.h:34
This class represents an Operation in the Expression.
uint16_t getU16(uint32_t *offset_ptr) const
Extract a uint16_t value from *offset_ptr.
bool isFormClass(FormClass FC) const
Base class for error info classes.
Definition: Error.h:47
void dump(raw_ostream &OS, unsigned indent=0, DIDumpOptions DumpOpts=DIDumpOptions()) const
Dump the DIE and all of its attributes to the supplied stream.
Definition: DWARFDie.cpp:470
virtual StringRef getAbbrevDWOSection() const
Definition: DWARFObject.h:58
Abbreviation describing the encoding of Name Index entries.
virtual const DWARFSection & getAppleTypesSection() const
Definition: DWARFObject.h:69
bool handleDebugInfo()
Verify the information in the .debug_info section.
dwarf::Form getForm() const
DWARFFormValue Value
The form and value for this attribute.
uint32_t getNextUnitOffset() const
Definition: DWARFUnit.h:345
Optional< uint64_t > getAsReference() const
getAsFoo functions below return the extracted value as Foo if only DWARFFormValue has form class is s...
uint32_t getU32(uint32_t *offset_ptr) const
Extract a uint32_t value from *offset_ptr.
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
uint64_t getRawUValue() const
Optional< ArrayRef< uint8_t > > getAsBlock() const
StringRef FormEncodingString(unsigned Encoding)
Definition: Dwarf.cpp:105
static bool isVariableIndexable(const DWARFDie &Die, DWARFContext &DCtx)
bool none_of(R &&Range, UnaryPredicate P)
Provide wrappers to std::none_of which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:922
A single location within a location list.
Definition: DWARFDebugLoc.h:27
static raw_ostream & note()
Convenience method for printing "note: " to stderr.
Definition: WithColor.cpp:67
Tagged union holding either a T or a Error.
Definition: CachePruning.h:23
Index attribute and its encoding.
uint32_t getOffset() const
Get the absolute offset into the debug info or types section.
Definition: DWARFDie.h:67
uint8_t getAddressByteSize() const
Definition: DWARFUnit.h:338
std::set< DieRangeInfo > Children
Sorted DWARFAddressRangeInfo.
Definition: DWARFVerifier.h:45
unsigned getNumDIEs()
Returns the number of DIEs in the unit.
Definition: DWARFUnit.h:487
std::vector< DWARFAddressRange > Ranges
Sorted DWARFAddressRanges.
Definition: DWARFVerifier.h:42
Encapsulates a DWARF attribute value and all of the data required to describe the attribute value...
StringRef AttributeString(unsigned Attribute)
Definition: Dwarf.cpp:72
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:133
const DenseSet< Abbrev, AbbrevMapInfo > & getAbbrevs() const
auto lower_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range))
Provide wrappers to std::lower_bound which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:1004
Represents a single accelerator table within the Dwarf 5 .debug_names section.
uint32_t getBucketArrayEntry(uint32_t Bucket) const
Reads an entry in the Bucket Array for the given Bucket.
uint16_t getVersion() const
Definition: DWARFUnit.h:337
iterator find(const_arg_type_t< KeyT > Val)
Definition: DenseMap.h:146
Optional< uint64_t > toSectionOffset(const Optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract an section offset.
virtual const DWARFSection & getAppleObjCSection() const
Definition: DWARFObject.h:74
A wrapper around a string literal that serves as a proxy for constructing global tables of StringRefs...
Definition: StringRef.h:869
void array_pod_sort(IteratorTy Start, IteratorTy End)
array_pod_sort - This sorts an array with the specified start and end extent.
Definition: STLExtras.h:826
Utility class that carries the DWARF compile/type unit and the debug info entry in an object...
Definition: DWARFDie.h:43
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
DWARF v5-specific implementation of an Accelerator Entry.
This implements the Apple accelerator table format, a precursor of the DWARF 5 accelerator table form...
virtual const DWARFSection & getStringOffsetSection() const
Definition: DWARFObject.h:54
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
SmallSet - This maintains a set of unique values, optimizing for the case when the set is small (less...
Definition: SmallSet.h:36
A structured debug information entry.
Definition: DIE.h:662
Optional< DWARFFormValue > findRecursively(ArrayRef< dwarf::Attribute > Attrs) const
Extract the first value of any attribute in Attrs from this DIE and recurse into any DW_AT_specificat...
Definition: DWARFDie.cpp:311
bool handleDebugAbbrev()
Verify the information in any of the following sections, if available: .debug_abbrev, debug_abbrev.dwo.
NameTableEntry getNameTableEntry(uint32_t Index) const
Reads an entry in the Name Table for the given Index.
A class that keeps the address range information for a single DIE.
Definition: DWARFVerifier.h:38
const DWARFAbbreviationDeclarationSet * getAbbreviationDeclarationSet(uint64_t CUAbbrOffset) const
bool any_of(R &&Range, UnaryPredicate P)
Provide wrappers to std::any_of which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:915
uint32_t getHashArrayEntry(uint32_t Index) const
Reads an entry in the Hash Array for the given Index.
bool contains(const DieRangeInfo &RHS) const
Return true if ranges in this object contains all ranges within RHS.
static const unsigned End
uint8_t getU8(uint32_t *offset_ptr) const
Extract a uint8_t value from *offset_ptr.
virtual StringRef getStringSection() const
Definition: DWARFObject.h:46
void reserve(size_type NumEntries)
Grow the densemap so that it can contain at least NumEntries items before resizing again...
Definition: DenseMap.h:100
auto find_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range))
Provide wrappers to std::find_if which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:936
bool extract(DWARFContext &Context, const DWARFDataExtractor &debug_info, uint32_t *offset_ptr, DWARFSectionKind Kind=DW_SECT_INFO, const DWARFUnitIndex *Index=nullptr)
Parse a unit header from debug_info starting at offset_ptr.
Definition: DWARFUnit.cpp:96
Expected< Entry > getEntry(uint32_t *Offset) const
std::vector< DWARFAddressRange >::const_iterator address_range_iterator
Definition: DWARFVerifier.h:55
StringRef toStringRef(bool B)
Construct a string ref from a boolean.
Definition: StringExtras.h:53
Base class describing the header of any kind of "unit." Some information is specific to certain unit ...
Definition: DWARFUnit.h:47
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
UnitType
Constants for unit types in DWARF v5.
Definition: Dwarf.h:328
A DataExtractor (typically for an in-memory copy of an object-file section) plus a relocation map for...
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
const char * getString() const
Return the string referenced by this name table entry or nullptr if the string offset is not valid...
.debug_names section consists of one or more units.
void handleAllErrors(Error E, HandlerTs &&... Handlers)
Behaves the same as handleErrors, except that by contract all errors must be handled by the given han...
Definition: Error.h:889
DWARFDie getUnitDIE(bool ExtractUnitDIEOnly=true)
Definition: DWARFUnit.h:437
const char * getName(DINameKind Kind) const
Return the DIE name resolving DW_AT_sepcification or DW_AT_abstract_origin references if necessary...
Definition: DWARFDie.cpp:432
A single entry in the Name Table (Dwarf 5 sect.
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:861
uint32_t caseFoldingDjbHash(StringRef Buffer, uint32_t H=5381)
Computes the Bernstein hash after folding the input according to the Dwarf 5 standard case folding ru...
Definition: DJB.cpp:71
Concrete instance of DWARFUnitSection, specialized for one Unit type.
Definition: DWARFUnit.h:133
address_range_iterator insert(const DWARFAddressRange &R)
Inserts the address range.
iterator end() const
Definition: ArrayRef.h:138
DWARFContext This data structure is the top level entity that deals with dwarf debug information pars...
Definition: DWARFContext.h:59
uint32_t getIndex() const
Return the index of this name in the parent Name Index.
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static void dumpTableHeader(raw_ostream &OS)
Optional< const char * > toString(const Optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract a string value from it.
Implements a dense probed hash-table based set with some number of buckets stored inline...
Definition: DenseSet.h:239
StringMap - This is an unconventional map that is specialized for handling keys that are "strings"...
Definition: StringMap.h:220
StringRef UnitTypeString(unsigned)
Definition: Dwarf.cpp:480
Error returned by NameIndex::getEntry to report it has reached the end of the entry list...
virtual const DWARFSection & getAppleNamespacesSection() const
Definition: DWARFObject.h:70
#define Success
virtual const DWARFSection & getInfoSection() const
Definition: DWARFObject.h:36
virtual const DWARFSection & getLineSection() const
Definition: DWARFObject.h:44
bool intersects(const DieRangeInfo &RHS) const
Return true if any range in this object intersects with any range in RHS.
StringRef TagString(unsigned Tag)
Definition: Dwarf.cpp:21
virtual const DWARFSection & getDebugNamesSection() const
Definition: DWARFObject.h:73
static bool isSupportedVersion(unsigned version)
Definition: DWARFContext.h:301
DWARFDie getDIEAtIndex(unsigned Index)
Return the DIE object at the given index.
Definition: DWARFUnit.h:503
void emplace_back(ArgTypes &&... Args)
Definition: SmallVector.h:653
dwarf::Tag getTag() const
Definition: DWARFDie.h:72
LLVM_NODISCARD bool empty() const
Definition: SmallVector.h:62
bool handleAccelTables()
Verify the information in accelerator tables, if they exist.
#define I(x, y, z)
Definition: MD5.cpp:58
virtual const DWARFSection & getAppleNamesSection() const
Definition: DWARFObject.h:68
const char * getCStr(uint32_t *offset_ptr) const
Extract a C string from *offset_ptr.
iterator end()
Definition: DenseMap.h:79
uint32_t getOffset() const
Definition: DWARFUnit.h:333
std::set< DieRangeInfo >::const_iterator die_range_info_iterator
Definition: DWARFVerifier.h:56
bool isLittleEndian() const
Definition: DWARFContext.h:300
bool isValidOffset(uint32_t offset) const
Test the validity of offset.
virtual const DWARFSection & getRangeSection() const
Definition: DWARFObject.h:47
uint32_t Code
Abbreviation code.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
bool operator<(int64_t V1, const APSInt &V2)
Definition: APSInt.h:326
Optional< DWARFFormValue > find(dwarf::Attribute Attr) const
Extract the specified attribute from this DIE.
Definition: DWARFDie.cpp:287
std::vector< DWARFAddressRange > DWARFAddressRangesVector
DWARFAddressRangesVector - represents a set of absolute address ranges.
DWARFDebugInfoEntry - A DIE with only the minimum required data.
Lightweight error class with error context and mandatory checking.
Definition: Error.h:156
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:46
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
static void LLVM_ATTRIBUTE_NORETURN ReportError(uint32_t StartOffset, const char *ErrorMsg)
uint32_t getCUOffset(uint32_t CU) const
Reads offset of compilation unit CU. CU is 0-based.
iterator_range< ValueIterator > equal_range(StringRef Key) const
Look up all entries in this Name Index matching Key.
Optional< uint64_t > getAsSectionOffset() const
const uint64_t Version
Definition: InstrProf.h:895
iterator end()
Definition: StringMap.h:318
DWARFAddressRangesVector getAddressRanges() const
Get the address ranges for this DIE.
Definition: DWARFDie.cpp:388
bool is_contained(R &&Range, const E &Element)
Wrapper function around std::find to detect if an element exists in a container.
Definition: STLExtras.h:967