10#include <unordered_set>
55 return Addr == UINT32_MAX;
75 if (GsymFileIdx != UINT32_MAX)
80 DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath, File))
104 if (Die.
getTag() == dwarf::DW_TAG_inlined_subroutine)
111 switch (ParentDie.
getTag()) {
112 case dwarf::DW_TAG_namespace:
113 case dwarf::DW_TAG_structure_type:
114 case dwarf::DW_TAG_union_type:
115 case dwarf::DW_TAG_class_type:
116 case dwarf::DW_TAG_subprogram:
118 case dwarf::DW_TAG_lexical_block:
134static std::optional<uint32_t>
148 if (!(Language == dwarf::DW_LANG_C_plus_plus ||
149 Language == dwarf::DW_LANG_C_plus_plus_03 ||
150 Language == dwarf::DW_LANG_C_plus_plus_11 ||
151 Language == dwarf::DW_LANG_C_plus_plus_14 ||
152 Language == dwarf::DW_LANG_ObjC_plus_plus ||
155 Language == dwarf::DW_LANG_C))
166 if (ParentDeclCtxDie) {
168 while (ParentDeclCtxDie) {
170 if (!ParentName.
empty()) {
174 if (ParentName.
front() ==
'<' && ParentName.
back() ==
'>')
190 bool CheckChildren =
true;
192 case dwarf::DW_TAG_subprogram:
194 CheckChildren =
Depth == 0;
196 case dwarf::DW_TAG_inlined_subroutine:
214 if (DwarfRange.LowPC < DwarfRange.HighPC)
215 Ranges.insert({DwarfRange.LowPC, DwarfRange.HighPC});
229 if (
Tag == dwarf::DW_TAG_inlined_subroutine) {
237 for (
const AddressRange &InlineRange : AllInlineRanges) {
240 if (InlineRange.empty()) {
244 II.Ranges.insert(InlineRange);
253 if (AllParentRanges.
contains(InlineRange)) {
256 Out.
Report(
"Function DIE has uncontained address range",
258 OS <<
"error: inlined function DIE at "
260 <<
HEX64(InlineRange.start()) <<
" - "
261 <<
HEX64(InlineRange.end())
262 <<
") that isn't contained in "
263 <<
"any parent address ranges, this inline range "
273 if (EmptyCount == AllInlineRanges.size())
276 if (
II.Ranges.empty())
280 II.Name = *NameIndex;
283 std::optional<uint32_t> OptGSymFileIdx =
285 if (OptGSymFileIdx) {
286 II.CallFile = OptGSymFileIdx.value();
291 AllInlineRanges, WarnIfEmpty);
295 "Inlined function die has invlaid file index in DW_AT_call_file",
298 <<
" has an invalid file index " << DwarfFileIdx
299 <<
" in its DW_AT_call_file attribute, this inline entry and "
301 <<
"children will be removed.\n";
305 if (
Tag == dwarf::DW_TAG_subprogram ||
Tag == dwarf::DW_TAG_lexical_block) {
309 AllParentRanges, WarnIfEmpty);
316 std::vector<uint32_t> RowVector;
319 const uint64_t RangeSize = EndAddress - StartAddress;
328 DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath);
329 if (FilePath.empty()) {
336 <<
" has an invalid file index " << DwarfFileIdx
337 <<
" in its DW_AT_decl_file attribute, unable to create a single "
338 <<
"line entry from the DW_AT_decl_file/DW_AT_decl_line "
354 for (
uint32_t RowIndex : RowVector) {
357 std::optional<uint32_t> OptFileIdx =
361 "Invalid file index in DWARF line table", [&](
raw_ostream &
OS) {
363 <<
"a line entry with invalid DWARF file index, this entry will "
365 Row.dumpTableHeader(
OS, 0);
371 const uint32_t FileIdx = OptFileIdx.value();
372 uint64_t RowAddress = Row.Address.Address;
381 Out.
Report(
"Start address lies between valid Row table entries",
383 OS <<
"error: DIE has a start address whose LowPC is "
386 << RowIndex <<
"] with address " <<
HEX64(RowAddress)
387 <<
" and the next one.\n";
396 LineEntry LE(RowAddress, FileIdx, Row.Line);
397 if (RowIndex != RowVector[0] && Row.Address < PrevRow.
Address) {
405 if (FirstLE && *FirstLE == LE)
408 OS <<
"warning: duplicate line table detected for DIE:\n";
412 Out.
Report(
"Non-monotonically increasing addresses",
414 OS <<
"error: line table has addresses that do not "
415 <<
"monotonically increase:\n";
416 for (
uint32_t RowIndex2 : RowVector)
425 if (LastLE && LastLE->File == FileIdx && LastLE->Line == Row.Line)
430 if (Row.EndSequence) {
450 case dwarf::DW_TAG_subprogram: {
452 if (!RangesOrError) {
463 <<
" has no name\n ";
498 if (
Range.LowPC != 0) {
501 Out.
Report(
"Address range starts outside executable section",
503 OS <<
"warning: DIE has an address range whose "
505 "is not in any executable sections ("
507 <<
") and will not be processed:\n";
517 FI.
Name = *NameIndex;
523 FI.
Inline->Name = *NameIndex;
525 bool WarnIfEmpty =
true;
527 AllSubprogramRanges, WarnIfEmpty);
537 if (FI.
Inline->Children.empty()) {
538 if (WarnIfEmpty && !Gsym.
isQuiet())
539 Out.
Report(
"DIE contains inline functions with no valid ranges",
541 OS <<
"warning: DIE contains inline function "
542 "information that has no valid ranges, removing "
543 "inline information:\n";
556 handleDie(Out, CUI, ChildDie);
567 "warning: Unable to retrieve DWO .debug_info section for some "
568 "object files. (Remove the --quiet flag for full output)",
572 {dwarf::DW_AT_dwo_name, dwarf::DW_AT_GNU_dwo_name}),
574 OS <<
"warning: Unable to retrieve DWO .debug_info section for "
583 if (NumThreads == 1) {
588 CUInfo CUI(DICtx, dyn_cast<DWARFCompileUnit>(
CU.get()));
589 handleDie(Out, CUI, Die);
600 CU->getAbbreviations();
606 pool.
async([&
CU]() {
CU->getUnitDIE(
false ); });
614 CUInfo CUI(DICtx, dyn_cast<DWARFCompileUnit>(
CU.get()));
615 pool.
async([
this, CUI, &LogMutex, &Out, Die]()
mutable {
619 handleDie(ThreadOut, CUI, Die);
621 std::lock_guard<std::mutex> guard(LogMutex);
626 Out.
Merge(ThreadOut);
633 Out <<
"Loaded " << FunctionsAddedCount <<
" functions from DWARF.\n";
639 Out <<
"Verifying GSYM file \"" << GsymPath <<
"\":\n";
643 return Gsym.takeError();
645 auto NumAddrs = Gsym->getNumAddresses();
647 DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath,
648 DILineInfoSpecifier::FunctionNameKind::LinkageName);
649 std::string gsymFilename;
651 auto FuncAddr = Gsym->getAddress(
I);
654 "failed to extract address[%i]",
I);
656 auto FI = Gsym->getFunctionInfo(*FuncAddr);
659 std::errc::invalid_argument,
660 "failed to extract function info for address 0x%" PRIu64, *FuncAddr);
665 auto LR = Gsym->lookup(
Addr);
667 return LR.takeError();
669 auto DwarfInlineInfos =
671 uint32_t NumDwarfInlineInfos = DwarfInlineInfos.getNumberOfFrames();
672 if (NumDwarfInlineInfos == 0) {
673 DwarfInlineInfos.addFrame(
678 if (NumDwarfInlineInfos == 1 &&
679 DwarfInlineInfos.getFrame(0).FileName ==
"<invalid>") {
681 NumDwarfInlineInfos = 0;
683 if (NumDwarfInlineInfos > 0 &&
684 NumDwarfInlineInfos != LR->Locations.size()) {
687 Log <<
"error: address " <<
HEX64(
Addr) <<
" has "
688 << NumDwarfInlineInfos <<
" DWARF inline frames and GSYM has "
689 << LR->Locations.size() <<
"\n";
690 Log <<
" " << NumDwarfInlineInfos <<
" DWARF frames:\n";
691 for (
size_t Idx = 0;
Idx < NumDwarfInlineInfos; ++
Idx) {
692 const auto &dii = DwarfInlineInfos.getFrame(
Idx);
693 Log <<
" [" <<
Idx <<
"]: " << dii.FunctionName <<
" @ "
694 << dii.FileName <<
':' << dii.Line <<
'\n';
696 Log <<
" " << LR->Locations.size() <<
" GSYM frames:\n";
699 const auto &gii = LR->Locations[
Idx];
700 Log <<
" [" <<
Idx <<
"]: " << gii.Name <<
" @ " << gii.Dir
701 <<
'/' << gii.Base <<
':' << gii.Line <<
'\n';
704 Gsym->dump(Log, *FI);
711 const auto &gii = LR->Locations[
Idx];
712 if (
Idx < NumDwarfInlineInfos) {
713 const auto &dii = DwarfInlineInfos.getFrame(
Idx);
714 gsymFilename = LR->getSourceFile(
Idx);
716 if (dii.FunctionName.find(gii.Name.str()) != 0)
717 Out <<
"error: address " <<
HEX64(
Addr) <<
" DWARF function \""
718 << dii.FunctionName.c_str()
719 <<
"\" doesn't match GSYM function \"" << gii.Name <<
"\"\n";
722 if (dii.FileName != gsymFilename)
723 Out <<
"error: address " <<
HEX64(
Addr) <<
" DWARF path \""
724 << dii.FileName.c_str() <<
"\" doesn't match GSYM path \""
725 << gsymFilename.c_str() <<
"\"\n";
727 if (dii.Line != gii.Line)
728 Out <<
"error: address " <<
HEX64(
Addr) <<
" DWARF line "
729 << dii.Line <<
" != GSYM line " << gii.Line <<
"\n";
Returns the sub type a function will return at a given Idx Should correspond to the result type of an ExtractValue instruction executed with just that one unsigned Idx
ConstantRange Range(APInt(BitWidth, Low), APInt(BitWidth, High))
uint64_t IntrinsicInst * II
A class that represents an address range.
bool contains(uint64_t Addr) const
bool contains(uint64_t Addr) const
The AddressRanges class helps normalize address range collections.
A format-neutral container for inlined code description.
DWARFContext This data structure is the top level entity that deals with dwarf debug information pars...
DIInliningInfo getInliningInfoForAddress(object::SectionedAddress Address, DILineInfoSpecifier Specifier=DILineInfoSpecifier()) override
DILineInfo getLineInfoForAddress(object::SectionedAddress Address, DILineInfoSpecifier Specifier=DILineInfoSpecifier()) override
compile_unit_range compile_units()
Get compile units in this context.
const DWARFDebugLine::LineTable * getLineTableForUnit(DWARFUnit *U)
Get a pointer to a parsed line table corresponding to a compile unit.
Utility class that carries the DWARF compile/type unit and the debug info entry in an object.
uint64_t getOffset() const
Get the absolute offset into the debug info or types section.
Expected< DWARFAddressRangesVector > getAddressRanges() const
Get the address ranges for this DIE.
iterator_range< iterator > children() const
DWARFDie getAttributeValueAsReferencedDie(dwarf::Attribute Attr) const
Extract the specified attribute from this DIE as the referenced DIE.
DWARFDie getParent() const
Get the parent of this DIE object.
std::optional< DWARFFormValue > find(dwarf::Attribute Attr) const
Extract the specified attribute from this DIE.
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...
const char * getName(DINameKind Kind) const
Return the DIE name resolving DW_AT_specification or DW_AT_abstract_origin references if necessary.
std::string getDeclFile(DILineInfoSpecifier::FileLineInfoKind Kind) const
dwarf::Tag getTag() const
const char * getLinkageName() const
Return the DIE linkage name resolving DW_AT_specification or DW_AT_abstract_origin references if nece...
void dump(raw_ostream &OS, unsigned indent=0, DIDumpOptions DumpOpts=DIDumpOptions()) const
Dump the DIE and all of its attributes to the supplied stream.
DWARFDie getUnitDIE(bool ExtractUnitDIEOnly=true)
This dwarf writer support class manages information associated with a source file.
Lightweight error class with error context and mandatory checking.
static ErrorSuccess success()
Create a success value.
Tagged union holding either a T or a Error.
Error takeError()
Take ownership of the stored error.
reference get()
Returns a reference to the stored T value.
A non-threaded implementation.
void wait() override
Blocking wait for all the tasks to execute first.
StringRef - Represent a constant reference to a string, i.e.
std::string str() const
str - Get the contents as an std::string.
constexpr StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
constexpr bool empty() const
empty - Check if the string is empty.
char back() const
back - Get the last character in the string.
constexpr size_t size() const
size - Get the string size.
char front() const
front - Get the first character in the string.
auto async(Function &&F, Args &&...ArgList)
Asynchronous submission of a task to the pool.
GsymCreator is used to emit GSYM data to a stand alone file or section within a file.
void addFunctionInfo(FunctionInfo &&FI)
Add a function info to this GSYM creator.
uint32_t insertString(StringRef S, bool Copy=true)
Insert a string into the GSYM string table.
const std::optional< AddressRanges > GetValidTextRanges() const
Get the valid text ranges.
bool isQuiet() const
Whether the transformation should be quiet, i.e. not output warnings.
uint32_t insertFile(StringRef Path, sys::path::Style Style=sys::path::Style::native)
Insert a file into this GSYM creator.
size_t getNumFunctionInfos() const
Get the current number of FunctionInfo objects contained in this object.
bool IsValidTextAddress(uint64_t Addr) const
Check if an address is a valid code address.
static llvm::Expected< GsymReader > openFile(StringRef Path)
Construct a GsymReader from a file on disk.
LineTable class contains deserialized versions of line tables for each function's address ranges.
void Report(StringRef s, std::function< void(raw_ostream &o)> detailCallback)
raw_ostream * GetOS() const
void Merge(const OutputAggregator &other)
This class implements an extremely fast bulk output stream that can only output to a stream.
A raw_ostream that writes to an std::string.
std::optional< const char * > toString(const std::optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract a string value from it.
std::optional< uint64_t > toUnsigned(const std::optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract an unsigned constant.
This is an optimization pass for GlobalISel generic memory operations.
ThreadPoolStrategy hardware_concurrency(unsigned ThreadCount=0)
Returns a default thread strategy where all available hardware resources are to be used,...
std::vector< DWARFAddressRange > DWARFAddressRangesVector
DWARFAddressRangesVector - represents a set of absolute address ranges.
Error createStringError(std::error_code EC, char const *Fmt, const Ts &... Vals)
Create formatted StringError object.
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...
std::function< Expected< AddStreamFn >(unsigned Task, StringRef Key, const Twine &ModuleName)> FileCache
This is the type of a file cache.
void consumeError(Error Err)
Consume a Error without doing anything.
static DIDumpOptions getForSingleDIE()
Return default option set for printing a single DIE without children.
Controls which fields of DILineInfo container should be filled with data.
bool lookupAddressRange(object::SectionedAddress Address, uint64_t Size, std::vector< uint32_t > &Result) const
Standard .debug_line state machine structure.
object::SectionedAddress Address
The program-counter value corresponding to a machine instruction generated by the compiler and sectio...
const DWARFDebugLine::LineTable * LineTable
std::optional< uint32_t > DWARFToGSYMFileIndex(GsymCreator &Gsym, uint32_t DwarfFileIdx)
Convert a DWARF compile unit file index into a GSYM global file index.
CUInfo(DWARFContext &DICtx, DWARFCompileUnit *CU)
bool isHighestAddress(uint64_t Addr) const
Return true if Addr is the highest address for a given compile unit.
std::vector< uint32_t > FileCache
Function information in GSYM files encodes information for one contiguous address range.
std::optional< InlineInfo > Inline
uint64_t startAddress() const
uint64_t endAddress() const
uint32_t Name
String table offset in the string table.
std::optional< LineTable > OptLineTable
Inline information stores the name of the inline function along with an array of address ranges.
std::vector< InlineInfo > Children
Line entries are used to encode the line tables in FunctionInfo objects.
static const uint64_t UndefSection