LLVM  16.0.0git
DwarfTransformer.cpp
Go to the documentation of this file.
1 //===- DwarfTransformer.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 
9 #include <thread>
10 #include <unordered_set>
11 
15 #include "llvm/Support/Error.h"
18 
24 #include <optional>
25 
26 using namespace llvm;
27 using namespace gsym;
28 
31  const char *CompDir;
32  std::vector<uint32_t> FileCache;
34  uint8_t AddrSize = 0;
35 
38  CompDir = CU->getCompilationDir();
39  FileCache.clear();
40  if (LineTable)
41  FileCache.assign(LineTable->Prologue.FileNames.size() + 1, UINT32_MAX);
42  DWARFDie Die = CU->getUnitDIE();
43  Language = dwarf::toUnsigned(Die.find(dwarf::DW_AT_language), 0);
44  AddrSize = CU->getAddressByteSize();
45  }
46 
47  /// Return true if Addr is the highest address for a given compile unit. The
48  /// highest address is encoded as -1, of all ones in the address. These high
49  /// addresses are used by some linkers to indicate that a function has been
50  /// dead stripped or didn't end up in the linked executable.
52  if (AddrSize == 4)
53  return Addr == UINT32_MAX;
54  else if (AddrSize == 8)
55  return Addr == UINT64_MAX;
56  return false;
57  }
58 
59  /// Convert a DWARF compile unit file index into a GSYM global file index.
60  ///
61  /// Each compile unit in DWARF has its own file table in the line table
62  /// prologue. GSYM has a single large file table that applies to all files
63  /// from all of the info in a GSYM file. This function converts between the
64  /// two and caches and DWARF CU file index that has already been converted so
65  /// the first client that asks for a compile unit file index will end up
66  /// doing the conversion, and subsequent clients will get the cached GSYM
67  /// index.
69  if (!LineTable)
70  return 0;
71  assert(DwarfFileIdx < FileCache.size());
72  uint32_t &GsymFileIdx = FileCache[DwarfFileIdx];
73  if (GsymFileIdx != UINT32_MAX)
74  return GsymFileIdx;
75  std::string File;
76  if (LineTable->getFileNameByIndex(
77  DwarfFileIdx, CompDir,
79  GsymFileIdx = Gsym.insertFile(File);
80  else
81  GsymFileIdx = 0;
82  return GsymFileIdx;
83  }
84 };
85 
86 
88  if (DWARFDie SpecDie =
89  Die.getAttributeValueAsReferencedDie(dwarf::DW_AT_specification)) {
90  if (DWARFDie SpecParent = GetParentDeclContextDIE(SpecDie))
91  return SpecParent;
92  }
93  if (DWARFDie AbstDie =
94  Die.getAttributeValueAsReferencedDie(dwarf::DW_AT_abstract_origin)) {
95  if (DWARFDie AbstParent = GetParentDeclContextDIE(AbstDie))
96  return AbstParent;
97  }
98 
99  // We never want to follow parent for inlined subroutine - that would
100  // give us information about where the function is inlined, not what
101  // function is inlined
102  if (Die.getTag() == dwarf::DW_TAG_inlined_subroutine)
103  return DWARFDie();
104 
105  DWARFDie ParentDie = Die.getParent();
106  if (!ParentDie)
107  return DWARFDie();
108 
109  switch (ParentDie.getTag()) {
110  case dwarf::DW_TAG_namespace:
111  case dwarf::DW_TAG_structure_type:
112  case dwarf::DW_TAG_union_type:
113  case dwarf::DW_TAG_class_type:
114  case dwarf::DW_TAG_subprogram:
115  return ParentDie; // Found parent decl context DIE
116  case dwarf::DW_TAG_lexical_block:
117  return GetParentDeclContextDIE(ParentDie);
118  default:
119  break;
120  }
121 
122  return DWARFDie();
123 }
124 
125 /// Get the GsymCreator string table offset for the qualified name for the
126 /// DIE passed in. This function will avoid making copies of any strings in
127 /// the GsymCreator when possible. We don't need to copy a string when the
128 /// string comes from our .debug_str section or is an inlined string in the
129 /// .debug_info. If we create a qualified name string in this function by
130 /// combining multiple strings in the DWARF string table or info, we will make
131 /// a copy of the string when we add it to the string table.
132 static std::optional<uint32_t>
134  // If the dwarf has mangled name, use mangled name
135  if (auto LinkageName =
136  dwarf::toString(Die.findRecursively({dwarf::DW_AT_MIPS_linkage_name,
137  dwarf::DW_AT_linkage_name}),
138  nullptr))
139  return Gsym.insertString(LinkageName, /* Copy */ false);
140 
142  if (ShortName.empty())
143  return std::nullopt;
144 
145  // For C++ and ObjC, prepend names of all parent declaration contexts
146  if (!(Language == dwarf::DW_LANG_C_plus_plus ||
147  Language == dwarf::DW_LANG_C_plus_plus_03 ||
148  Language == dwarf::DW_LANG_C_plus_plus_11 ||
149  Language == dwarf::DW_LANG_C_plus_plus_14 ||
150  Language == dwarf::DW_LANG_ObjC_plus_plus ||
151  // This should not be needed for C, but we see C++ code marked as C
152  // in some binaries. This should hurt, so let's do it for C as well
153  Language == dwarf::DW_LANG_C))
154  return Gsym.insertString(ShortName, /* Copy */ false);
155 
156  // Some GCC optimizations create functions with names ending with .isra.<num>
157  // or .part.<num> and those names are just DW_AT_name, not DW_AT_linkage_name
158  // If it looks like it could be the case, don't add any prefix
159  if (ShortName.startswith("_Z") &&
160  (ShortName.contains(".isra.") || ShortName.contains(".part.")))
161  return Gsym.insertString(ShortName, /* Copy */ false);
162 
163  DWARFDie ParentDeclCtxDie = GetParentDeclContextDIE(Die);
164  if (ParentDeclCtxDie) {
165  std::string Name = ShortName.str();
166  while (ParentDeclCtxDie) {
167  StringRef ParentName(ParentDeclCtxDie.getName(DINameKind::ShortName));
168  if (!ParentName.empty()) {
169  // "lambda" names are wrapped in < >. Replace with { }
170  // to be consistent with demangled names and not to confuse with
171  // templates
172  if (ParentName.front() == '<' && ParentName.back() == '>')
173  Name = "{" + ParentName.substr(1, ParentName.size() - 2).str() + "}" +
174  "::" + Name;
175  else
176  Name = ParentName.str() + "::" + Name;
177  }
178  ParentDeclCtxDie = GetParentDeclContextDIE(ParentDeclCtxDie);
179  }
180  // Copy the name since we created a new name in a std::string.
181  return Gsym.insertString(Name, /* Copy */ true);
182  }
183  // Don't copy the name since it exists in the DWARF object file.
184  return Gsym.insertString(ShortName, /* Copy */ false);
185 }
186 
188  bool CheckChildren = true;
189  switch (Die.getTag()) {
190  case dwarf::DW_TAG_subprogram:
191  // Don't look into functions within functions.
192  CheckChildren = Depth == 0;
193  break;
194  case dwarf::DW_TAG_inlined_subroutine:
195  return true;
196  default:
197  break;
198  }
199  if (!CheckChildren)
200  return false;
201  for (DWARFDie ChildDie : Die.children()) {
202  if (hasInlineInfo(ChildDie, Depth + 1))
203  return true;
204  }
205  return false;
206 }
207 
208 static void parseInlineInfo(GsymCreator &Gsym, CUInfo &CUI, DWARFDie Die,
210  InlineInfo &parent) {
211  if (!hasInlineInfo(Die, Depth))
212  return;
213 
214  dwarf::Tag Tag = Die.getTag();
215  if (Tag == dwarf::DW_TAG_inlined_subroutine) {
216  // create new InlineInfo and append to parent.children
217  InlineInfo II;
218  DWARFAddressRange FuncRange =
221  if (RangesOrError) {
222  for (const DWARFAddressRange &Range : RangesOrError.get()) {
223  // Check that the inlined function is within the range of the function
224  // info, it might not be in case of split functions
225  if (FuncRange.LowPC <= Range.LowPC && Range.HighPC <= FuncRange.HighPC)
226  II.Ranges.insert(AddressRange(Range.LowPC, Range.HighPC));
227  }
228  }
229  if (II.Ranges.empty())
230  return;
231 
232  if (auto NameIndex = getQualifiedNameIndex(Die, CUI.Language, Gsym))
233  II.Name = *NameIndex;
235  Gsym, dwarf::toUnsigned(Die.find(dwarf::DW_AT_call_file), 0));
236  II.CallLine = dwarf::toUnsigned(Die.find(dwarf::DW_AT_call_line), 0);
237  // parse all children and append to parent
238  for (DWARFDie ChildDie : Die.children())
239  parseInlineInfo(Gsym, CUI, ChildDie, Depth + 1, FI, II);
240  parent.Children.emplace_back(std::move(II));
241  return;
242  }
243  if (Tag == dwarf::DW_TAG_subprogram || Tag == dwarf::DW_TAG_lexical_block) {
244  // skip this Die and just recurse down
245  for (DWARFDie ChildDie : Die.children())
246  parseInlineInfo(Gsym, CUI, ChildDie, Depth + 1, FI, parent);
247  }
248 }
249 
251  DWARFDie Die, GsymCreator &Gsym,
252  FunctionInfo &FI) {
253  std::vector<uint32_t> RowVector;
254  const uint64_t StartAddress = FI.startAddress();
255  const uint64_t EndAddress = FI.endAddress();
256  const uint64_t RangeSize = EndAddress - StartAddress;
257  const object::SectionedAddress SecAddress{
259 
260 
261  if (!CUI.LineTable->lookupAddressRange(SecAddress, RangeSize, RowVector)) {
262  // If we have a DW_TAG_subprogram but no line entries, fall back to using
263  // the DW_AT_decl_file an d DW_AT_decl_line if we have both attributes.
264  std::string FilePath = Die.getDeclFile(
266  if (FilePath.empty())
267  return;
268  if (auto Line =
269  dwarf::toUnsigned(Die.findRecursively({dwarf::DW_AT_decl_line}))) {
270  LineEntry LE(StartAddress, Gsym.insertFile(FilePath), *Line);
271  FI.OptLineTable = LineTable();
272  FI.OptLineTable->push(LE);
273  }
274  return;
275  }
276 
277  FI.OptLineTable = LineTable();
278  DWARFDebugLine::Row PrevRow;
279  for (uint32_t RowIndex : RowVector) {
280  // Take file number and line/column from the row.
281  const DWARFDebugLine::Row &Row = CUI.LineTable->Rows[RowIndex];
282  const uint32_t FileIdx = CUI.DWARFToGSYMFileIndex(Gsym, Row.File);
283  uint64_t RowAddress = Row.Address.Address;
284  // Watch out for a RowAddress that is in the middle of a line table entry
285  // in the DWARF. If we pass an address in between two line table entries
286  // we will get a RowIndex for the previous valid line table row which won't
287  // be contained in our function. This is usually a bug in the DWARF due to
288  // linker problems or LTO or other DWARF re-linking so it is worth emitting
289  // an error, but not worth stopping the creation of the GSYM.
290  if (!FI.Range.contains(RowAddress)) {
291  if (RowAddress < FI.Range.start()) {
292  Log << "error: DIE has a start address whose LowPC is between the "
293  "line table Row[" << RowIndex << "] with address "
294  << HEX64(RowAddress) << " and the next one.\n";
295  Die.dump(Log, 0, DIDumpOptions::getForSingleDIE());
296  RowAddress = FI.Range.start();
297  } else {
298  continue;
299  }
300  }
301 
302  LineEntry LE(RowAddress, FileIdx, Row.Line);
303  if (RowIndex != RowVector[0] && Row.Address < PrevRow.Address) {
304  // We have seen full duplicate line tables for functions in some
305  // DWARF files. Watch for those here by checking the the last
306  // row was the function's end address (HighPC) and that the
307  // current line table entry's address is the same as the first
308  // line entry we already have in our "function_info.Lines". If
309  // so break out after printing a warning.
310  auto FirstLE = FI.OptLineTable->first();
311  if (FirstLE && *FirstLE == LE) {
312  if (!Gsym.isQuiet()) {
313  Log << "warning: duplicate line table detected for DIE:\n";
314  Die.dump(Log, 0, DIDumpOptions::getForSingleDIE());
315  }
316  } else {
317  // Print out (ignore if os == nulls as this is expensive)
318  Log << "error: line table has addresses that do not "
319  << "monotonically increase:\n";
320  for (uint32_t RowIndex2 : RowVector) {
321  CUI.LineTable->Rows[RowIndex2].dump(Log);
322  }
323  Die.dump(Log, 0, DIDumpOptions::getForSingleDIE());
324  }
325  break;
326  }
327 
328  // Skip multiple line entries for the same file and line.
329  auto LastLE = FI.OptLineTable->last();
330  if (LastLE && LastLE->File == FileIdx && LastLE->Line == Row.Line)
331  continue;
332  // Only push a row if it isn't an end sequence. End sequence markers are
333  // included for the last address in a function or the last contiguous
334  // address in a sequence.
335  if (Row.EndSequence) {
336  // End sequence means that the next line entry could have a lower address
337  // that the previous entries. So we clear the previous row so we don't
338  // trigger the line table error about address that do not monotonically
339  // increase.
340  PrevRow = DWARFDebugLine::Row();
341  } else {
342  FI.OptLineTable->push(LE);
343  PrevRow = Row;
344  }
345  }
346  // If not line table rows were added, clear the line table so we don't encode
347  // on in the GSYM file.
348  if (FI.OptLineTable->empty())
349  FI.OptLineTable = std::nullopt;
350 }
351 
352 void DwarfTransformer::handleDie(raw_ostream &OS, CUInfo &CUI, DWARFDie Die) {
353  switch (Die.getTag()) {
354  case dwarf::DW_TAG_subprogram: {
356  if (!RangesOrError) {
357  consumeError(RangesOrError.takeError());
358  break;
359  }
360  const DWARFAddressRangesVector &Ranges = RangesOrError.get();
361  if (Ranges.empty())
362  break;
363  auto NameIndex = getQualifiedNameIndex(Die, CUI.Language, Gsym);
364  if (!NameIndex) {
365  OS << "error: function at " << HEX64(Die.getOffset())
366  << " has no name\n ";
367  Die.dump(OS, 0, DIDumpOptions::getForSingleDIE());
368  break;
369  }
370 
371  // Create a function_info for each range
372  for (const DWARFAddressRange &Range : Ranges) {
373  // The low PC must be less than the high PC. Many linkers don't remove
374  // DWARF for functions that don't get linked into the final executable.
375  // If both the high and low pc have relocations, linkers will often set
376  // the address values for both to the same value to indicate the function
377  // has been remove. Other linkers have been known to set the one or both
378  // PC values to a UINT32_MAX for 4 byte addresses and UINT64_MAX for 8
379  // byte addresses to indicate the function isn't valid. The check below
380  // tries to watch for these cases and abort if it runs into them.
381  if (Range.LowPC >= Range.HighPC || CUI.isHighestAddress(Range.LowPC))
382  break;
383 
384  // Many linkers can't remove DWARF and might set the LowPC to zero. Since
385  // high PC can be an offset from the low PC in more recent DWARF versions
386  // we need to watch for a zero'ed low pc which we do using
387  // ValidTextRanges below.
388  if (!Gsym.IsValidTextAddress(Range.LowPC)) {
389  // We expect zero and -1 to be invalid addresses in DWARF depending
390  // on the linker of the DWARF. This indicates a function was stripped
391  // and the debug info wasn't able to be stripped from the DWARF. If
392  // the LowPC isn't zero or -1, then we should emit an error.
393  if (Range.LowPC != 0) {
394  if (!Gsym.isQuiet()) {
395  // Unexpected invalid address, emit a warning
396  OS << "warning: DIE has an address range whose start address is "
397  "not in any executable sections ("
398  << *Gsym.GetValidTextRanges()
399  << ") and will not be processed:\n";
400  Die.dump(OS, 0, DIDumpOptions::getForSingleDIE());
401  }
402  }
403  break;
404  }
405 
406  FunctionInfo FI;
407  FI.Range = {Range.LowPC, Range.HighPC};
408  FI.Name = *NameIndex;
409  if (CUI.LineTable) {
410  convertFunctionLineTable(OS, CUI, Die, Gsym, FI);
411  }
412  if (hasInlineInfo(Die, 0)) {
413  FI.Inline = InlineInfo();
414  FI.Inline->Name = *NameIndex;
415  FI.Inline->Ranges.insert(FI.Range);
416  parseInlineInfo(Gsym, CUI, Die, 0, FI, *FI.Inline);
417  }
418  Gsym.addFunctionInfo(std::move(FI));
419  }
420  } break;
421  default:
422  break;
423  }
424  for (DWARFDie ChildDie : Die.children())
425  handleDie(OS, CUI, ChildDie);
426 }
427 
429  size_t NumBefore = Gsym.getNumFunctionInfos();
430  auto getDie = [&](DWARFUnit &DwarfUnit) -> DWARFDie {
431  DWARFDie ReturnDie = DwarfUnit.getUnitDIE(false);
432  if (std::optional<uint64_t> DWOId = DwarfUnit.getDWOId()) {
433  DWARFUnit *DWOCU = DwarfUnit.getNonSkeletonUnitDIE(false).getDwarfUnit();
434  if (!DWOCU->isDWOUnit()) {
435  std::string DWOName = dwarf::toString(
436  DwarfUnit.getUnitDIE().find(
437  {dwarf::DW_AT_dwo_name, dwarf::DW_AT_GNU_dwo_name}),
438  "");
439  Log << "warning: Unable to retrieve DWO .debug_info section for "
440  << DWOName << "\n";
441  } else {
442  ReturnDie = DWOCU->getUnitDIE(false);
443  }
444  }
445  return ReturnDie;
446  };
447  if (NumThreads == 1) {
448  // Parse all DWARF data from this thread, use the same string/file table
449  // for everything
450  for (const auto &CU : DICtx.compile_units()) {
451  DWARFDie Die = getDie(*CU);
452  CUInfo CUI(DICtx, dyn_cast<DWARFCompileUnit>(CU.get()));
453  handleDie(Log, CUI, Die);
454  }
455  } else {
456  // LLVM Dwarf parser is not thread-safe and we need to parse all DWARF up
457  // front before we start accessing any DIEs since there might be
458  // cross compile unit references in the DWARF. If we don't do this we can
459  // end up crashing.
460 
461  // We need to call getAbbreviations sequentially first so that getUnitDIE()
462  // only works with its local data.
463  for (const auto &CU : DICtx.compile_units())
464  CU->getAbbreviations();
465 
466  // Now parse all DIEs in case we have cross compile unit references in a
467  // thread pool.
468  ThreadPool pool(hardware_concurrency(NumThreads));
469  for (const auto &CU : DICtx.compile_units())
470  pool.async([&CU]() { CU->getUnitDIE(false /*CUDieOnly*/); });
471  pool.wait();
472 
473  // Now convert all DWARF to GSYM in a thread pool.
474  std::mutex LogMutex;
475  for (const auto &CU : DICtx.compile_units()) {
476  DWARFDie Die = getDie(*CU);
477  if (Die) {
478  CUInfo CUI(DICtx, dyn_cast<DWARFCompileUnit>(CU.get()));
479  pool.async([this, CUI, &LogMutex, Die]() mutable {
480  std::string ThreadLogStorage;
481  raw_string_ostream ThreadOS(ThreadLogStorage);
482  handleDie(ThreadOS, CUI, Die);
483  ThreadOS.flush();
484  if (!ThreadLogStorage.empty()) {
485  // Print ThreadLogStorage lines into an actual stream under a lock
486  std::lock_guard<std::mutex> guard(LogMutex);
487  Log << ThreadLogStorage;
488  }
489  });
490  }
491  }
492  pool.wait();
493  }
494  size_t FunctionsAddedCount = Gsym.getNumFunctionInfos() - NumBefore;
495  Log << "Loaded " << FunctionsAddedCount << " functions from DWARF.\n";
496  return Error::success();
497 }
498 
500  Log << "Verifying GSYM file \"" << GsymPath << "\":\n";
501 
502  auto Gsym = GsymReader::openFile(GsymPath);
503  if (!Gsym)
504  return Gsym.takeError();
505 
506  auto NumAddrs = Gsym->getNumAddresses();
507  DILineInfoSpecifier DLIS(
510  std::string gsymFilename;
511  for (uint32_t I = 0; I < NumAddrs; ++I) {
512  auto FuncAddr = Gsym->getAddress(I);
513  if (!FuncAddr)
514  return createStringError(std::errc::invalid_argument,
515  "failed to extract address[%i]", I);
516 
517  auto FI = Gsym->getFunctionInfo(*FuncAddr);
518  if (!FI)
519  return createStringError(std::errc::invalid_argument,
520  "failed to extract function info for address 0x%"
521  PRIu64, *FuncAddr);
522 
523  for (auto Addr = *FuncAddr; Addr < *FuncAddr + FI->size(); ++Addr) {
524  const object::SectionedAddress SectAddr{
526  auto LR = Gsym->lookup(Addr);
527  if (!LR)
528  return LR.takeError();
529 
530  auto DwarfInlineInfos =
531  DICtx.getInliningInfoForAddress(SectAddr, DLIS);
532  uint32_t NumDwarfInlineInfos = DwarfInlineInfos.getNumberOfFrames();
533  if (NumDwarfInlineInfos == 0) {
534  DwarfInlineInfos.addFrame(
535  DICtx.getLineInfoForAddress(SectAddr, DLIS));
536  }
537 
538  // Check for 1 entry that has no file and line info
539  if (NumDwarfInlineInfos == 1 &&
540  DwarfInlineInfos.getFrame(0).FileName == "<invalid>") {
541  DwarfInlineInfos = DIInliningInfo();
542  NumDwarfInlineInfos = 0;
543  }
544  if (NumDwarfInlineInfos > 0 &&
545  NumDwarfInlineInfos != LR->Locations.size()) {
546  Log << "error: address " << HEX64(Addr) << " has "
547  << NumDwarfInlineInfos << " DWARF inline frames and GSYM has "
548  << LR->Locations.size() << "\n";
549  Log << " " << NumDwarfInlineInfos << " DWARF frames:\n";
550  for (size_t Idx = 0; Idx < NumDwarfInlineInfos; ++Idx) {
551  const auto &dii = DwarfInlineInfos.getFrame(Idx);
552  Log << " [" << Idx << "]: " << dii.FunctionName << " @ "
553  << dii.FileName << ':' << dii.Line << '\n';
554  }
555  Log << " " << LR->Locations.size() << " GSYM frames:\n";
556  for (size_t Idx = 0, count = LR->Locations.size();
557  Idx < count; ++Idx) {
558  const auto &gii = LR->Locations[Idx];
559  Log << " [" << Idx << "]: " << gii.Name << " @ " << gii.Dir
560  << '/' << gii.Base << ':' << gii.Line << '\n';
561  }
562  DwarfInlineInfos = DICtx.getInliningInfoForAddress(SectAddr, DLIS);
563  Gsym->dump(Log, *FI);
564  continue;
565  }
566 
567  for (size_t Idx = 0, count = LR->Locations.size(); Idx < count;
568  ++Idx) {
569  const auto &gii = LR->Locations[Idx];
570  if (Idx < NumDwarfInlineInfos) {
571  const auto &dii = DwarfInlineInfos.getFrame(Idx);
572  gsymFilename = LR->getSourceFile(Idx);
573  // Verify function name
574  if (dii.FunctionName.find(gii.Name.str()) != 0)
575  Log << "error: address " << HEX64(Addr) << " DWARF function \""
576  << dii.FunctionName.c_str()
577  << "\" doesn't match GSYM function \"" << gii.Name << "\"\n";
578  // Verify source file path
579  if (dii.FileName != gsymFilename)
580  Log << "error: address " << HEX64(Addr) << " DWARF path \""
581  << dii.FileName.c_str() << "\" doesn't match GSYM path \""
582  << gsymFilename.c_str() << "\"\n";
583  // Verify source file line
584  if (dii.Line != gii.Line)
585  Log << "error: address " << HEX64(Addr) << " DWARF line "
586  << dii.Line << " != GSYM line " << gii.Line << "\n";
587  }
588  }
589  }
590  }
591  return Error::success();
592 }
llvm::DWARFContext::getLineTableForUnit
const DWARFDebugLine::LineTable * getLineTableForUnit(DWARFUnit *U)
Get a pointer to a parsed line table corresponding to a compile unit.
Definition: DWARFContext.cpp:968
llvm::hardware_concurrency
ThreadPoolStrategy hardware_concurrency(unsigned ThreadCount=0)
Returns a default thread strategy where all available hardware resources are to be used,...
Definition: Threading.h:185
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
llvm::gsym::FunctionInfo::size
uint64_t size() const
Definition: FunctionInfo.h:172
InlineInfo.h
DWARFCompileUnit.h
llvm::gsym::FunctionInfo::Name
uint32_t Name
String table offset in the string table.
Definition: FunctionInfo.h:90
parseInlineInfo
static void parseInlineInfo(GsymCreator &Gsym, CUInfo &CUI, DWARFDie Die, uint32_t Depth, FunctionInfo &FI, InlineInfo &parent)
Definition: DwarfTransformer.cpp:208
llvm::gsym::FunctionInfo::OptLineTable
std::optional< LineTable > OptLineTable
Definition: FunctionInfo.h:91
llvm::gsym::GsymReader::openFile
static llvm::Expected< GsymReader > openFile(StringRef Path)
Construct a GsymReader from a file on disk.
Definition: GsymReader.cpp:34
llvm::gsym::CUInfo::DWARFToGSYMFileIndex
uint32_t DWARFToGSYMFileIndex(GsymCreator &Gsym, uint32_t DwarfFileIdx)
Convert a DWARF compile unit file index into a GSYM global file index.
Definition: DwarfTransformer.cpp:68
llvm::ThreadPool
A ThreadPool for asynchronous parallel execution on a defined number of threads.
Definition: ThreadPool.h:52
llvm::gsym::FunctionInfo::Inline
std::optional< InlineInfo > Inline
Definition: FunctionInfo.h:92
llvm::StringRef::front
char front() const
front - Get the first character in the string.
Definition: StringRef.h:140
llvm::gsym::GsymCreator
GsymCreator is used to emit GSYM data to a stand alone file or section within a file.
Definition: GsymCreator.h:133
llvm::DIInliningInfo
A format-neutral container for inlined code description.
Definition: DIContext.h:88
DwarfTransformer.h
llvm::DILineInfoSpecifier
Controls which fields of DILineInfo container should be filled with data.
Definition: DIContext.h:140
llvm::raw_string_ostream
A raw_ostream that writes to an std::string.
Definition: raw_ostream.h:628
llvm::gsym::LineTable::size
size_t size() const
Definition: LineTable.h:193
llvm::dwarf::toUnsigned
std::optional< uint64_t > toUnsigned(const std::optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract an unsigned constant.
Definition: DWARFFormValue.h:226
llvm::gsym::LineEntry
Line entries are used to encode the line tables in FunctionInfo objects.
Definition: LineEntry.h:22
llvm::Error::success
static ErrorSuccess success()
Create a success value.
Definition: Error.h:329
pool
Implement PPCInstrInfo::isLoadFromStackSlot isStoreToStackSlot for vector to generate better spill code The first should be a single lvx from the constant pool
Definition: README_ALTIVEC.txt:8
DWARFContext.h
Error.h
llvm::Depth
@ Depth
Definition: SIMachineScheduler.h:36
llvm::DWARFContext
DWARFContext This data structure is the top level entity that deals with dwarf debug information pars...
Definition: DWARFContext.h:47
hasInlineInfo
static bool hasInlineInfo(DWARFDie Die, uint32_t Depth)
Definition: DwarfTransformer.cpp:187
llvm::gsym::CUInfo::FileCache
std::vector< uint32_t > FileCache
Definition: DwarfTransformer.cpp:32
llvm::gsym::GsymCreator::IsValidTextAddress
bool IsValidTextAddress(uint64_t Addr) const
Check if an address is a valid code address.
Definition: GsymCreator.cpp:353
llvm::StringRef::substr
StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
Definition: StringRef.h:564
llvm::Expected
Tagged union holding either a T or a Error.
Definition: APFloat.h:41
llvm::DWARFDie::find
std::optional< DWARFFormValue > find(dwarf::Attribute Attr) const
Extract the specified attribute from this DIE.
Definition: DWARFDie.cpp:252
FunctionInfo.h
llvm::gsym::InlineInfo::CallFile
uint32_t CallFile
1 based file index in the file table.
Definition: InlineInfo.h:62
llvm::dwarf::Tag
Tag
Definition: Dwarf.h:105
llvm::DINameKind::LinkageName
@ LinkageName
llvm::DWARFDie::children
iterator_range< iterator > children() const
Definition: DWARFDie.h:395
llvm::DWARFAddressRange::LowPC
uint64_t LowPC
Definition: DWARFAddressRange.h:26
llvm::DWARFUnit::isDWOUnit
bool isDWOUnit() const
Definition: DWARFUnit.h:311
llvm::gsym::InlineInfo
Inline information stores the name of the inline function along with an array of address ranges.
Definition: InlineInfo.h:59
llvm::consumeError
void consumeError(Error Err)
Consume a Error without doing anything.
Definition: Error.h:1042
llvm::gsym::CUInfo
Definition: DwarfTransformer.cpp:29
llvm::DWARFContext::getInliningInfoForAddress
DIInliningInfo getInliningInfoForAddress(object::SectionedAddress Address, DILineInfoSpecifier Specifier=DILineInfoSpecifier()) override
Definition: DWARFContext.cpp:1334
llvm::DWARFUnit::getUnitDIE
DWARFDie getUnitDIE(bool ExtractUnitDIEOnly=true)
Definition: DWARFUnit.h:426
llvm::gsym::CUInfo::CUInfo
CUInfo(DWARFContext &DICtx, DWARFCompileUnit *CU)
Definition: DwarfTransformer.cpp:36
llvm::gsym::InlineInfo::CallLine
uint32_t CallLine
Source line number.
Definition: InlineInfo.h:63
llvm::DWARFDebugLine::Row
Standard .debug_line state machine structure.
Definition: DWARFDebugLine.h:132
llvm::DIDumpOptions::getForSingleDIE
static DIDumpOptions getForSingleDIE()
Return default option set for printing a single DIE without children.
Definition: DIContext.h:204
llvm::AMDGPU::HSAMD::Kernel::Key::Language
constexpr char Language[]
Key for Kernel::Metadata::mLanguage.
Definition: AMDGPUMetadata.h:388
llvm::AddressRanges::empty
bool empty() const
Definition: AddressRanges.h:61
getQualifiedNameIndex
static std::optional< uint32_t > getQualifiedNameIndex(DWARFDie &Die, uint64_t Language, GsymCreator &Gsym)
Get the GsymCreator string table offset for the qualified name for the DIE passed in.
Definition: DwarfTransformer.cpp:133
UINT64_MAX
#define UINT64_MAX
Definition: DataTypes.h:77
llvm::gsym::FunctionInfo::startAddress
uint64_t startAddress() const
Definition: FunctionInfo.h:170
llvm::DWARFDie::getDeclFile
std::string getDeclFile(DILineInfoSpecifier::FileLineInfoKind Kind) const
Definition: DWARFDie.cpp:479
llvm::dwarf::toString
std::optional< const char * > toString(const std::optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract a string value from it.
Definition: DWARFFormValue.h:177
llvm::DWARFDebugLine::LineTable::Rows
RowVector Rows
Definition: DWARFDebugLine.h:290
HEX64
#define HEX64(v)
Definition: ExtractRanges.h:21
InlineInfo
@ InlineInfo
Definition: FunctionInfo.cpp:25
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
llvm::AArch64CC::LE
@ LE
Definition: AArch64BaseInfo.h:268
llvm::raw_ostream::flush
void flush()
Definition: raw_ostream.h:185
llvm::gsym::FunctionInfo::Range
AddressRange Range
Definition: FunctionInfo.h:89
llvm::gsym::LineTable
LineTable class contains deserialized versions of line tables for each function's address ranges.
Definition: LineTable.h:118
llvm::DWARFDebugLine::LineTable::lookupAddressRange
bool lookupAddressRange(object::SectionedAddress Address, uint64_t Size, std::vector< uint32_t > &Result) const
Definition: DWARFDebugLine.cpp:1271
llvm::DWARFContext::compile_units
compile_unit_range compile_units()
Get compile units in this context.
Definition: DWARFContext.h:168
llvm::gsym::FunctionInfo
Function information in GSYM files encodes information for one contiguous address range.
Definition: FunctionInfo.h:88
llvm::DWARFDie::dump
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:567
llvm::DWARFCompileUnit
Definition: DWARFCompileUnit.h:22
llvm::StringRef::empty
constexpr bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:134
ThreadPool.h
llvm::AddressRange
A class that represents an address range.
Definition: AddressRanges.h:22
llvm::DINameKind::ShortName
@ ShortName
llvm::gsym::InlineInfo::Name
uint32_t Name
String table offset in the string table.
Definition: InlineInfo.h:61
llvm::DWARFAddressRange::HighPC
uint64_t HighPC
Definition: DWARFAddressRange.h:27
llvm::count
auto count(R &&Range, const E &Element)
Wrapper function around std::count to count the number of times an element Element occurs in the give...
Definition: STLExtras.h:1895
llvm::gsym::CUInfo::Language
uint64_t Language
Definition: DwarfTransformer.cpp:33
uint64_t
Addr
uint64_t Addr
Definition: ELFObjHandler.cpp:79
llvm::DWARFDie::getAddressRanges
Expected< DWARFAddressRangesVector > getAddressRanges() const
Get the address ranges for this DIE.
Definition: DWARFDie.cpp:380
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::object::SectionedAddress::UndefSection
const static uint64_t UndefSection
Definition: ObjectFile.h:145
llvm::gsym::DwarfTransformer::convert
llvm::Error convert(uint32_t NumThreads)
Extract the DWARF from the supplied object file and convert it into the Gsym format in the GsymCreato...
Definition: DwarfTransformer.cpp:428
I
#define I(x, y, z)
Definition: MD5.cpp:58
llvm::DWARFDie::getOffset
uint64_t getOffset() const
Get the absolute offset into the debug info or types section.
Definition: DWARFDie.h:66
llvm::gsym::CUInfo::AddrSize
uint8_t AddrSize
Definition: DwarfTransformer.cpp:34
llvm::gsym::FunctionInfo::endAddress
uint64_t endAddress() const
Definition: FunctionInfo.h:171
assert
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
llvm::gsym::DwarfTransformer::verify
llvm::Error verify(StringRef GsymPath)
Definition: DwarfTransformer.cpp:499
llvm::gsym::GsymCreator::getNumFunctionInfos
size_t getNumFunctionInfos() const
Get the current number of FunctionInfo objects contained in this object.
Definition: GsymCreator.cpp:348
llvm::logicalview::LVAttributeKind::Range
@ Range
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
llvm::gsym::GsymCreator::GetValidTextRanges
const std::optional< AddressRanges > GetValidTextRanges() const
Get the valid text ranges.
Definition: GsymCreator.h:252
llvm::gsym::GsymCreator::addFunctionInfo
void addFunctionInfo(FunctionInfo &&FI)
Add a function info to this GSYM creator.
Definition: GsymCreator.cpp:324
llvm::Expected::get
reference get()
Returns a reference to the stored T value.
Definition: Error.h:566
llvm::DWARFDie::findRecursively
std::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:276
uint32_t
llvm::DWARFDie::getName
const char * getName(DINameKind Kind) const
Return the DIE name resolving DW_AT_specification or DW_AT_abstract_origin references if necessary.
Definition: DWARFDie.cpp:447
llvm::gsym::CUInfo::CompDir
const char * CompDir
Definition: DwarfTransformer.cpp:31
llvm::gsym::GsymCreator::insertString
uint32_t insertString(StringRef S, bool Copy=true)
Insert a string into the GSYM string table.
Definition: GsymCreator.cpp:303
GsymReader.h
llvm::DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath
@ AbsoluteFilePath
llvm::DWARFContext::getLineInfoForAddress
DILineInfo getLineInfoForAddress(object::SectionedAddress Address, DILineInfoSpecifier Specifier=DILineInfoSpecifier()) override
Definition: DWARFContext.cpp:1243
llvm::StringRef::size
constexpr size_t size() const
size - Get the string size.
Definition: StringRef.h:137
llvm::DWARFDie::getParent
DWARFDie getParent() const
Get the parent of this DIE object.
Definition: DWARFDie.cpp:627
DIContext.h
llvm::gsym::CUInfo::LineTable
const DWARFDebugLine::LineTable * LineTable
Definition: DwarfTransformer.cpp:30
llvm::createStringError
Error createStringError(std::error_code EC, char const *Fmt, const Ts &... Vals)
Create formatted StringError object.
Definition: Error.h:1238
llvm::DWARFAddressRangesVector
std::vector< DWARFAddressRange > DWARFAddressRangesVector
DWARFAddressRangesVector - represents a set of absolute address ranges.
Definition: DWARFAddressRange.h:88
llvm::AddressRanges::insert
Collection::const_iterator insert(AddressRange Range)
Definition: AddressRanges.cpp:16
llvm::DWARFUnit
Definition: DWARFUnit.h:206
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:155
llvm::gsym::CUInfo::isHighestAddress
bool isHighestAddress(uint64_t Addr) const
Return true if Addr is the highest address for a given compile unit.
Definition: DwarfTransformer.cpp:51
llvm::DWARFDebugLine::Row::Address
object::SectionedAddress Address
The program-counter value corresponding to a machine instruction generated by the compiler and sectio...
Definition: DWARFDebugLine.h:152
llvm::gsym::GsymCreator::insertFile
uint32_t insertFile(StringRef Path, sys::path::Style Style=sys::path::Style::native)
Insert a file into this GSYM creator.
Definition: GsymCreator.cpp:28
llvm::Expected::takeError
Error takeError()
Take ownership of the stored error.
Definition: Error.h:596
llvm::gsym::GsymCreator::isQuiet
bool isQuiet() const
Whether the transformation should be quiet, i.e. not output warnings.
Definition: GsymCreator.h:293
llvm::DWARFDie::getAttributeValueAsReferencedDie
DWARFDie getAttributeValueAsReferencedDie(dwarf::Attribute Attr) const
Extract the specified attribute from this DIE as the referenced DIE.
Definition: DWARFDie.cpp:309
llvm::FileCache
std::function< Expected< AddStreamFn >(unsigned Task, StringRef Key, const Twine &ModuleName)> FileCache
This is the type of a file cache.
Definition: Caching.h:58
llvm::gsym::InlineInfo::Ranges
AddressRanges Ranges
Definition: InlineInfo.h:64
llvm::DWARFDie::getTag
dwarf::Tag getTag() const
Definition: DWARFDie.h:71
llvm::object::SectionedAddress
Definition: ObjectFile.h:144
convertFunctionLineTable
static void convertFunctionLineTable(raw_ostream &Log, CUInfo &CUI, DWARFDie Die, GsymCreator &Gsym, FunctionInfo &FI)
Definition: DwarfTransformer.cpp:250
llvm::StringRef::back
char back() const
back - Get the last character in the string.
Definition: StringRef.h:146
llvm::DWARFDebugLine::LineTable
Definition: DWARFDebugLine.h:225
llvm::logicalview::LVWarningKind::Ranges
@ Ranges
llvm::StringRef::str
std::string str() const
str - Get the contents as an std::string.
Definition: StringRef.h:221
llvm::DWARFDie
Utility class that carries the DWARF compile/type unit and the debug info entry in an object.
Definition: DWARFDie.h:42
llvm::DwarfUnit
This dwarf writer support class manages information associated with a source file.
Definition: DwarfUnit.h:35
llvm::DWARFAddressRange
Definition: DWARFAddressRange.h:25
raw_ostream.h
llvm::AddressRange::start
uint64_t start() const
Definition: AddressRanges.h:28
GsymCreator.h
CU
Definition: AArch64AsmBackend.cpp:505
llvm::gsym::InlineInfo::Children
std::vector< InlineInfo > Children
Definition: InlineInfo.h:65
GetParentDeclContextDIE
static DWARFDie GetParentDeclContextDIE(DWARFDie &Die)
Definition: DwarfTransformer.cpp:87
llvm::AddressRange::contains
bool contains(uint64_t Addr) const
Definition: AddressRanges.h:31