diff options
Diffstat (limited to 'llvm/tools/llvm-objdump')
-rw-r--r-- | llvm/tools/llvm-objdump/ObjdumpOpts.td | 16 | ||||
-rw-r--r-- | llvm/tools/llvm-objdump/SourcePrinter.cpp | 238 | ||||
-rw-r--r-- | llvm/tools/llvm-objdump/SourcePrinter.h | 102 | ||||
-rw-r--r-- | llvm/tools/llvm-objdump/llvm-objdump.cpp | 144 | ||||
-rw-r--r-- | llvm/tools/llvm-objdump/llvm-objdump.h | 7 |
5 files changed, 352 insertions, 155 deletions
diff --git a/llvm/tools/llvm-objdump/ObjdumpOpts.td b/llvm/tools/llvm-objdump/ObjdumpOpts.td index c3764c6..c97e06f 100644 --- a/llvm/tools/llvm-objdump/ObjdumpOpts.td +++ b/llvm/tools/llvm-objdump/ObjdumpOpts.td @@ -241,17 +241,23 @@ defm prefix_strip "paths. No effect without --prefix">, MetaVarName<"prefix">; +def debug_indent_EQ : Joined<["--"], "debug-indent=">, + HelpText<"Distance to indent the source-level variable and inlined function display, " + "relative to the start of the disassembly">; + +def debug_inlined_funcs_EQ : Joined<["--"], "debug-inlined-funcs=">, + HelpText<"Print the locations of inlined functions alongside disassembly. " + "Supported formats: ascii, limits-only, and unicode (default)">, + Values<"ascii,limits-only,unicode">; +def : Flag<["--"], "debug-inlined-funcs">, Alias<debug_inlined_funcs_EQ>, AliasArgs<["unicode"]>; + def debug_vars_EQ : Joined<["--"], "debug-vars=">, HelpText<"Print the locations (in registers or memory) of " "source-level variables alongside disassembly. " "Supported formats: ascii, unicode (default)">, - Values<"unicode,ascii">; + Values<"ascii,unicode">; def : Flag<["--"], "debug-vars">, Alias<debug_vars_EQ>, AliasArgs<["unicode"]>; -def debug_vars_indent_EQ : Joined<["--"], "debug-vars-indent=">, - HelpText<"Distance to indent the source-level variable display, " - "relative to the start of the disassembly">; - def x86_asm_syntax_att : Flag<["--"], "x86-asm-syntax=att">, HelpText<"Emit AT&T-style disassembly">; diff --git a/llvm/tools/llvm-objdump/SourcePrinter.cpp b/llvm/tools/llvm-objdump/SourcePrinter.cpp index 3630502..b0ff89d 100644 --- a/llvm/tools/llvm-objdump/SourcePrinter.cpp +++ b/llvm/tools/llvm-objdump/SourcePrinter.cpp @@ -6,9 +6,9 @@ // //===----------------------------------------------------------------------===// // -// This file implements the LiveVariablePrinter and SourcePrinter classes to +// This file implements the LiveElementPrinter and SourcePrinter classes to // keep track of DWARF info as the current address is updated, and print out the -// source file line and variable liveness as needed. +// source file line and variable or inlined function liveness as needed. // //===----------------------------------------------------------------------===// @@ -17,6 +17,7 @@ #include "llvm/ADT/SmallSet.h" #include "llvm/DebugInfo/DWARF/DWARFExpressionPrinter.h" #include "llvm/DebugInfo/DWARF/LowLevel/DWARFExpression.h" +#include "llvm/Demangle/Demangle.h" #include "llvm/Support/FormatVariadic.h" #define DEBUG_TYPE "objdump" @@ -24,7 +25,70 @@ namespace llvm { namespace objdump { -bool LiveVariable::liveAtAddress(object::SectionedAddress Addr) { +bool InlinedFunction::liveAtAddress(object::SectionedAddress Addr) const { + if (!Range.valid()) + return false; + + return Range.LowPC <= Addr.Address && Range.HighPC > Addr.Address; +} + +void InlinedFunction::print(raw_ostream &OS, const MCRegisterInfo &MRI) const { + const char *MangledCallerName = FuncDie.getName(DINameKind::LinkageName); + if (!MangledCallerName) + return; + + if (Demangle) + OS << "inlined into " << demangle(MangledCallerName); + else + OS << "inlined into " << MangledCallerName; +} + +void InlinedFunction::dump(raw_ostream &OS) const { + OS << Name << " @ " << Range << ": "; +} + +void InlinedFunction::printElementLine(raw_ostream &OS, + object::SectionedAddress Addr, + bool IsEnd) const { + bool LiveIn = !IsEnd && Range.LowPC == Addr.Address; + bool LiveOut = IsEnd && Range.HighPC == Addr.Address; + if (!(LiveIn || LiveOut)) + return; + + uint32_t CallFile, CallLine, CallColumn, CallDiscriminator; + InlinedFuncDie.getCallerFrame(CallFile, CallLine, CallColumn, + CallDiscriminator); + const DWARFDebugLine::LineTable *LineTable = + Unit->getContext().getLineTableForUnit(Unit); + std::string FileName; + if (!LineTable->hasFileAtIndex(CallFile)) + return; + if (!LineTable->getFileNameByIndex( + CallFile, Unit->getCompilationDir(), + DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath, FileName)) + return; + + if (FileName.empty()) + return; + + const char *MangledCallerName = FuncDie.getName(DINameKind::LinkageName); + if (!MangledCallerName) + return; + + std::string CallerName = MangledCallerName; + std::string CalleeName = Name; + if (Demangle) { + CallerName = demangle(MangledCallerName); + CalleeName = demangle(Name); + } + + OS << "; " << FileName << ":" << CallLine << ":" << CallColumn << ": "; + if (IsEnd) + OS << "end of "; + OS << CalleeName << " inlined into " << CallerName << "\n"; +} + +bool LiveVariable::liveAtAddress(object::SectionedAddress Addr) const { if (LocExpr.Range == std::nullopt) return false; return LocExpr.Range->SectionIndex == Addr.SectionIndex && @@ -49,7 +113,24 @@ void LiveVariable::print(raw_ostream &OS, const MCRegisterInfo &MRI) const { printDwarfExpressionCompact(&Expression, OS, GetRegName); } -void LiveVariablePrinter::addVariable(DWARFDie FuncDie, DWARFDie VarDie) { +void LiveVariable::dump(raw_ostream &OS) const { + OS << Name << " @ " << LocExpr.Range << ": "; +} + +void LiveElementPrinter::addInlinedFunction(DWARFDie FuncDie, + DWARFDie InlinedFuncDie) { + uint64_t FuncLowPC, FuncHighPC, SectionIndex; + if (!InlinedFuncDie.getLowAndHighPC(FuncLowPC, FuncHighPC, SectionIndex)) + return; + + DWARFUnit *U = InlinedFuncDie.getDwarfUnit(); + const char *InlinedFuncName = InlinedFuncDie.getName(DINameKind::LinkageName); + DWARFAddressRange Range{FuncLowPC, FuncHighPC, SectionIndex}; + LiveElements.emplace_back(std::make_unique<InlinedFunction>( + InlinedFuncName, U, FuncDie, InlinedFuncDie, Range)); +} + +void LiveElementPrinter::addVariable(DWARFDie FuncDie, DWARFDie VarDie) { uint64_t FuncLowPC, FuncHighPC, SectionIndex; FuncDie.getLowAndHighPC(FuncLowPC, FuncHighPC, SectionIndex); const char *VarName = VarDie.getName(DINameKind::ShortName); @@ -67,7 +148,8 @@ void LiveVariablePrinter::addVariable(DWARFDie FuncDie, DWARFDie VarDie) { for (const DWARFLocationExpression &LocExpr : *Locs) { if (LocExpr.Range) { - LiveVariables.emplace_back(LocExpr, VarName, U, FuncDie); + LiveElements.emplace_back( + std::make_unique<LiveVariable>(LocExpr, VarName, U, FuncDie)); } else { // If the LocExpr does not have an associated range, it is valid for // the whole of the function. @@ -75,24 +157,30 @@ void LiveVariablePrinter::addVariable(DWARFDie FuncDie, DWARFDie VarDie) { // LocExpr, does that happen in reality? DWARFLocationExpression WholeFuncExpr{ DWARFAddressRange(FuncLowPC, FuncHighPC, SectionIndex), LocExpr.Expr}; - LiveVariables.emplace_back(WholeFuncExpr, VarName, U, FuncDie); + LiveElements.emplace_back( + std::make_unique<LiveVariable>(WholeFuncExpr, VarName, U, FuncDie)); } } } -void LiveVariablePrinter::addFunction(DWARFDie D) { +void LiveElementPrinter::addFunction(DWARFDie D) { for (const DWARFDie &Child : D.children()) { - if (Child.getTag() == dwarf::DW_TAG_variable || - Child.getTag() == dwarf::DW_TAG_formal_parameter) + if (DbgVariables != DFDisabled && + (Child.getTag() == dwarf::DW_TAG_variable || + Child.getTag() == dwarf::DW_TAG_formal_parameter)) { addVariable(D, Child); - else + } else if (DbgInlinedFunctions != DFDisabled && + Child.getTag() == dwarf::DW_TAG_inlined_subroutine) { + addInlinedFunction(D, Child); + addFunction(Child); + } else addFunction(Child); } } -// Get the column number (in characters) at which the first live variable +// Get the column number (in characters) at which the first live element // line should be printed. -unsigned LiveVariablePrinter::getIndentLevel() const { +unsigned LiveElementPrinter::getIndentLevel() const { return DbgIndent + getInstStartColumn(STI); } @@ -100,8 +188,8 @@ unsigned LiveVariablePrinter::getIndentLevel() const { // printed line, and return the index of that column. // TODO: formatted_raw_ostream uses "column" to mean a number of characters // since the last \n, and we use it to mean the number of slots in which we -// put live variable lines. Pick a less overloaded word. -unsigned LiveVariablePrinter::moveToFirstVarColumn(formatted_raw_ostream &OS) { +// put live element lines. Pick a less overloaded word. +unsigned LiveElementPrinter::moveToFirstVarColumn(formatted_raw_ostream &OS) { // Logical column number: column zero is the first column we print in, each // logical column is 2 physical columns wide. unsigned FirstUnprintedLogicalColumn = @@ -117,7 +205,7 @@ unsigned LiveVariablePrinter::moveToFirstVarColumn(formatted_raw_ostream &OS) { return FirstUnprintedLogicalColumn; } -unsigned LiveVariablePrinter::findFreeColumn() { +unsigned LiveElementPrinter::findFreeColumn() { for (unsigned ColIdx = 0; ColIdx < ActiveCols.size(); ++ColIdx) if (!ActiveCols[ColIdx].isActive()) return ColIdx; @@ -127,15 +215,15 @@ unsigned LiveVariablePrinter::findFreeColumn() { return OldSize; } -void LiveVariablePrinter::dump() const { - for (const LiveVariable &LV : LiveVariables) { - dbgs() << LV.VarName << " @ " << LV.LocExpr.Range << ": "; - LV.print(dbgs(), MRI); +void LiveElementPrinter::dump() const { + for (const std::unique_ptr<LiveElement> &LE : LiveElements) { + LE->dump(dbgs()); + LE->print(dbgs(), MRI); dbgs() << "\n"; } } -void LiveVariablePrinter::addCompileUnit(DWARFDie D) { +void LiveElementPrinter::addCompileUnit(DWARFDie D) { if (D.getTag() == dwarf::DW_TAG_subprogram) addFunction(D); else @@ -148,47 +236,57 @@ void LiveVariablePrinter::addCompileUnit(DWARFDie D) { /// live-in to the instruction, and any live range active at NextAddr is /// live-out of the instruction. If IncludeDefinedVars is false, then live /// ranges starting at NextAddr will be ignored. -void LiveVariablePrinter::update(object::SectionedAddress ThisAddr, - object::SectionedAddress NextAddr, - bool IncludeDefinedVars) { +void LiveElementPrinter::update(object::SectionedAddress ThisAddr, + object::SectionedAddress NextAddr, + bool IncludeDefinedVars) { + // Do not create live ranges when debug-inlined-funcs option is provided with + // line format option. + if (DbgInlinedFunctions == DFLimitsOnly) + return; + // First, check variables which have already been assigned a column, so // that we don't change their order. - SmallSet<unsigned, 8> CheckedVarIdxs; + SmallSet<unsigned, 8> CheckedElementIdxs; for (unsigned ColIdx = 0, End = ActiveCols.size(); ColIdx < End; ++ColIdx) { if (!ActiveCols[ColIdx].isActive()) continue; - CheckedVarIdxs.insert(ActiveCols[ColIdx].VarIdx); - LiveVariable &LV = LiveVariables[ActiveCols[ColIdx].VarIdx]; - ActiveCols[ColIdx].LiveIn = LV.liveAtAddress(ThisAddr); - ActiveCols[ColIdx].LiveOut = LV.liveAtAddress(NextAddr); + + CheckedElementIdxs.insert(ActiveCols[ColIdx].ElementIdx); + const std::unique_ptr<LiveElement> &LE = + LiveElements[ActiveCols[ColIdx].ElementIdx]; + ActiveCols[ColIdx].LiveIn = LE->liveAtAddress(ThisAddr); + ActiveCols[ColIdx].LiveOut = LE->liveAtAddress(NextAddr); + std::string Name = Demangle ? demangle(LE->getName()) : LE->getName(); LLVM_DEBUG(dbgs() << "pass 1, " << ThisAddr.Address << "-" - << NextAddr.Address << ", " << LV.VarName << ", Col " - << ColIdx << ": LiveIn=" << ActiveCols[ColIdx].LiveIn + << NextAddr.Address << ", " << Name << ", Col " << ColIdx + << ": LiveIn=" << ActiveCols[ColIdx].LiveIn << ", LiveOut=" << ActiveCols[ColIdx].LiveOut << "\n"); if (!ActiveCols[ColIdx].LiveIn && !ActiveCols[ColIdx].LiveOut) - ActiveCols[ColIdx].VarIdx = Column::NullVarIdx; + ActiveCols[ColIdx].ElementIdx = Column::NullElementIdx; } // Next, look for variables which don't already have a column, but which // are now live. if (IncludeDefinedVars) { - for (unsigned VarIdx = 0, End = LiveVariables.size(); VarIdx < End; - ++VarIdx) { - if (CheckedVarIdxs.count(VarIdx)) + for (unsigned ElementIdx = 0, End = LiveElements.size(); ElementIdx < End; + ++ElementIdx) { + if (CheckedElementIdxs.count(ElementIdx)) continue; - LiveVariable &LV = LiveVariables[VarIdx]; - bool LiveIn = LV.liveAtAddress(ThisAddr); - bool LiveOut = LV.liveAtAddress(NextAddr); + + const std::unique_ptr<LiveElement> &LE = LiveElements[ElementIdx]; + bool LiveIn = LE->liveAtAddress(ThisAddr); + bool LiveOut = LE->liveAtAddress(NextAddr); if (!LiveIn && !LiveOut) continue; unsigned ColIdx = findFreeColumn(); + std::string Name = Demangle ? demangle(LE->getName()) : LE->getName(); LLVM_DEBUG(dbgs() << "pass 2, " << ThisAddr.Address << "-" - << NextAddr.Address << ", " << LV.VarName << ", Col " + << NextAddr.Address << ", " << Name << ", Col " << ColIdx << ": LiveIn=" << LiveIn << ", LiveOut=" << LiveOut << "\n"); - ActiveCols[ColIdx].VarIdx = VarIdx; + ActiveCols[ColIdx].ElementIdx = ElementIdx; ActiveCols[ColIdx].LiveIn = LiveIn; ActiveCols[ColIdx].LiveOut = LiveOut; ActiveCols[ColIdx].MustDrawLabel = true; @@ -205,8 +303,8 @@ enum class LineChar { LabelCornerActive, LabelHoriz, }; -const char *LiveVariablePrinter::getLineChar(LineChar C) const { - bool IsASCII = DbgVariables == DVASCII; +const char *LiveElementPrinter::getLineChar(LineChar C) const { + bool IsASCII = DbgVariables == DFASCII || DbgInlinedFunctions == DFASCII; switch (C) { case LineChar::RangeStart: return IsASCII ? "^" : (const char *)u8"\u2548"; @@ -231,8 +329,8 @@ const char *LiveVariablePrinter::getLineChar(LineChar C) const { /// we only need to print active ranges or empty columns. If AfterInst is /// true, this is being printed after the last instruction fed to update(), /// otherwise this is being printed before it. -void LiveVariablePrinter::printAfterOtherLine(formatted_raw_ostream &OS, - bool AfterInst) { +void LiveElementPrinter::printAfterOtherLine(formatted_raw_ostream &OS, + bool AfterInst) { if (ActiveCols.size()) { unsigned FirstUnprintedColumn = moveToFirstVarColumn(OS); for (size_t ColIdx = FirstUnprintedColumn, End = ActiveCols.size(); @@ -252,15 +350,15 @@ void LiveVariablePrinter::printAfterOtherLine(formatted_raw_ostream &OS, OS << "\n"; } -/// Print any live variable range info needed to the right of a -/// non-instruction line of disassembly. This is where we print the variable +/// Print any live element range info needed to the right of a +/// non-instruction line of disassembly. This is where we print the element /// names and expressions, with thin line-drawing characters connecting them /// to the live range which starts at the next instruction. If MustPrint is /// true, we have to print at least one line (with the continuation of any /// already-active live ranges) because something has already been printed /// earlier on this line. -void LiveVariablePrinter::printBetweenInsts(formatted_raw_ostream &OS, - bool MustPrint) { +void LiveElementPrinter::printBetweenInsts(formatted_raw_ostream &OS, + bool MustPrint) { bool PrintedSomething = false; for (unsigned ColIdx = 0, End = ActiveCols.size(); ColIdx < End; ++ColIdx) { if (ActiveCols[ColIdx].isActive() && ActiveCols[ColIdx].MustDrawLabel) { @@ -277,17 +375,20 @@ void LiveVariablePrinter::printBetweenInsts(formatted_raw_ostream &OS, OS << " "; } + const std::unique_ptr<LiveElement> &LE = + LiveElements[ActiveCols[ColIdx].ElementIdx]; // Then print the variable name and location of the new live range, // with box drawing characters joining it to the live range line. OS << getLineChar(ActiveCols[ColIdx].LiveIn ? LineChar::LabelCornerActive : LineChar::LabelCornerNew) << getLineChar(LineChar::LabelHoriz) << " "; - WithColor(OS, raw_ostream::GREEN) - << LiveVariables[ActiveCols[ColIdx].VarIdx].VarName; + + std::string Name = Demangle ? demangle(LE->getName()) : LE->getName(); + WithColor(OS, raw_ostream::GREEN) << Name; OS << " = "; { WithColor ExprColor(OS, raw_ostream::CYAN); - LiveVariables[ActiveCols[ColIdx].VarIdx].print(OS, MRI); + LE->print(OS, MRI); } // If there are any columns to the right of the expression we just @@ -317,8 +418,8 @@ void LiveVariablePrinter::printBetweenInsts(formatted_raw_ostream &OS, printAfterOtherLine(OS, false); } -/// Print the live variable ranges to the right of a disassembled instruction. -void LiveVariablePrinter::printAfterInst(formatted_raw_ostream &OS) { +/// Print the live element ranges to the right of a disassembled instruction. +void LiveElementPrinter::printAfterInst(formatted_raw_ostream &OS) { if (!ActiveCols.size()) return; unsigned FirstUnprintedColumn = moveToFirstVarColumn(OS); @@ -337,6 +438,24 @@ void LiveVariablePrinter::printAfterInst(formatted_raw_ostream &OS) { } } +void LiveElementPrinter::printStartLine(formatted_raw_ostream &OS, + object::SectionedAddress Addr) { + // Print a line to idenfity the start of an inlined function if line format + // is specified. + if (DbgInlinedFunctions == DFLimitsOnly) + for (const std::unique_ptr<LiveElement> &LE : LiveElements) + LE->printElementLine(OS, Addr, false); +} + +void LiveElementPrinter::printEndLine(formatted_raw_ostream &OS, + object::SectionedAddress Addr) { + // Print a line to idenfity the end of an inlined function if line format is + // specified. + if (DbgInlinedFunctions == DFLimitsOnly) + for (const std::unique_ptr<LiveElement> &LE : LiveElements) + LE->printElementLine(OS, Addr, true); +} + bool SourcePrinter::cacheSource(const DILineInfo &LineInfo) { std::unique_ptr<MemoryBuffer> Buffer; if (LineInfo.Source) { @@ -371,7 +490,7 @@ bool SourcePrinter::cacheSource(const DILineInfo &LineInfo) { void SourcePrinter::printSourceLine(formatted_raw_ostream &OS, object::SectionedAddress Address, StringRef ObjectFilename, - LiveVariablePrinter &LVP, + LiveElementPrinter &LEP, StringRef Delimiter) { if (!Symbolizer) return; @@ -419,15 +538,16 @@ void SourcePrinter::printSourceLine(formatted_raw_ostream &OS, } if (PrintLines) - printLines(OS, LineInfo, Delimiter, LVP); + printLines(OS, Address, LineInfo, Delimiter, LEP); if (PrintSource) - printSources(OS, LineInfo, ObjectFilename, Delimiter, LVP); + printSources(OS, LineInfo, ObjectFilename, Delimiter, LEP); OldLineInfo = LineInfo; } void SourcePrinter::printLines(formatted_raw_ostream &OS, + object::SectionedAddress Address, const DILineInfo &LineInfo, StringRef Delimiter, - LiveVariablePrinter &LVP) { + LiveElementPrinter &LEP) { bool PrintFunctionName = LineInfo.FunctionName != DILineInfo::BadString && LineInfo.FunctionName != OldLineInfo.FunctionName; if (PrintFunctionName) { @@ -442,7 +562,7 @@ void SourcePrinter::printLines(formatted_raw_ostream &OS, (OldLineInfo.Line != LineInfo.Line || OldLineInfo.FileName != LineInfo.FileName || PrintFunctionName)) { OS << Delimiter << LineInfo.FileName << ":" << LineInfo.Line; - LVP.printBetweenInsts(OS, true); + LEP.printBetweenInsts(OS, true); } } @@ -477,7 +597,7 @@ StringRef SourcePrinter::getLine(const DILineInfo &LineInfo, void SourcePrinter::printSources(formatted_raw_ostream &OS, const DILineInfo &LineInfo, StringRef ObjectFilename, StringRef Delimiter, - LiveVariablePrinter &LVP) { + LiveElementPrinter &LEP) { if (LineInfo.FileName == DILineInfo::BadString || LineInfo.Line == 0 || (OldLineInfo.Line == LineInfo.Line && OldLineInfo.FileName == LineInfo.FileName)) @@ -486,7 +606,7 @@ void SourcePrinter::printSources(formatted_raw_ostream &OS, StringRef Line = getLine(LineInfo, ObjectFilename); if (!Line.empty()) { OS << Delimiter << Line; - LVP.printBetweenInsts(OS, true); + LEP.printBetweenInsts(OS, true); } } diff --git a/llvm/tools/llvm-objdump/SourcePrinter.h b/llvm/tools/llvm-objdump/SourcePrinter.h index fc67fc6..5c131a0 100644 --- a/llvm/tools/llvm-objdump/SourcePrinter.h +++ b/llvm/tools/llvm-objdump/SourcePrinter.h @@ -22,40 +22,83 @@ namespace llvm { namespace objdump { +/// Base class for representing the location of a source-level variable or +/// an inlined function. +class LiveElement { +protected: + const char *Name; + DWARFUnit *Unit; + const DWARFDie FuncDie; + +public: + LiveElement(const char *Name, DWARFUnit *Unit, const DWARFDie FuncDie) + : Name(Name), Unit(Unit), FuncDie(FuncDie) {} + + virtual ~LiveElement() {}; + const char *getName() const { return Name; } + + virtual bool liveAtAddress(object::SectionedAddress Addr) const = 0; + virtual void print(raw_ostream &OS, const MCRegisterInfo &MRI) const = 0; + virtual void dump(raw_ostream &OS) const = 0; + virtual void printElementLine(raw_ostream &OS, + object::SectionedAddress Address, + bool IsEnd) const {} +}; + +class InlinedFunction : public LiveElement { +private: + DWARFDie InlinedFuncDie; + DWARFAddressRange Range; + +public: + InlinedFunction(const char *FunctionName, DWARFUnit *Unit, + const DWARFDie FuncDie, const DWARFDie InlinedFuncDie, + DWARFAddressRange &Range) + : LiveElement(FunctionName, Unit, FuncDie), + InlinedFuncDie(InlinedFuncDie), Range(Range) {} + + bool liveAtAddress(object::SectionedAddress Addr) const override; + void print(raw_ostream &OS, const MCRegisterInfo &MRI) const override; + void dump(raw_ostream &OS) const override; + void printElementLine(raw_ostream &OS, object::SectionedAddress Address, + bool IsEnd) const override; +}; + /// Stores a single expression representing the location of a source-level /// variable, along with the PC range for which that expression is valid. -struct LiveVariable { +class LiveVariable : public LiveElement { +private: DWARFLocationExpression LocExpr; - const char *VarName; - DWARFUnit *Unit; - const DWARFDie FuncDie; +public: LiveVariable(const DWARFLocationExpression &LocExpr, const char *VarName, DWARFUnit *Unit, const DWARFDie FuncDie) - : LocExpr(LocExpr), VarName(VarName), Unit(Unit), FuncDie(FuncDie) {} + : LiveElement(VarName, Unit, FuncDie), LocExpr(LocExpr) {} - bool liveAtAddress(object::SectionedAddress Addr); - - void print(raw_ostream &OS, const MCRegisterInfo &MRI) const; + bool liveAtAddress(object::SectionedAddress Addr) const override; + void print(raw_ostream &OS, const MCRegisterInfo &MRI) const override; + void dump(raw_ostream &OS) const override; }; -/// Helper class for printing source variable locations alongside disassembly. -class LiveVariablePrinter { - // Information we want to track about one column in which we are printing a - // variable live range. +/// Helper class for printing source locations for variables and inlined +/// subroutines alongside disassembly. +class LiveElementPrinter { + // Information we want to track about one column in which we are printing an + // element live range. struct Column { - unsigned VarIdx = NullVarIdx; + unsigned ElementIdx = NullElementIdx; bool LiveIn = false; bool LiveOut = false; bool MustDrawLabel = false; - bool isActive() const { return VarIdx != NullVarIdx; } + bool isActive() const { return ElementIdx != NullElementIdx; } - static constexpr unsigned NullVarIdx = std::numeric_limits<unsigned>::max(); + static constexpr unsigned NullElementIdx = + std::numeric_limits<unsigned>::max(); }; - // All live variables we know about in the object/image file. - std::vector<LiveVariable> LiveVariables; + // All live elements we know about in the object/image file. + std::vector<std::unique_ptr<LiveElement>> LiveElements; // The columns we are currently drawing. IndexedMap<Column> ActiveCols; @@ -63,11 +106,12 @@ class LiveVariablePrinter { const MCRegisterInfo &MRI; const MCSubtargetInfo &STI; + void addInlinedFunction(DWARFDie FuncDie, DWARFDie InlinedFuncDie); void addVariable(DWARFDie FuncDie, DWARFDie VarDie); void addFunction(DWARFDie D); - // Get the column number (in characters) at which the first live variable + // Get the column number (in characters) at which the first live element // line should be printed. unsigned getIndentLevel() const; @@ -75,13 +119,13 @@ class LiveVariablePrinter { // printed line, and return the index of that column. // TODO: formatted_raw_ostream uses "column" to mean a number of characters // since the last \n, and we use it to mean the number of slots in which we - // put live variable lines. Pick a less overloaded word. + // put live element lines. Pick a less overloaded word. unsigned moveToFirstVarColumn(formatted_raw_ostream &OS); unsigned findFreeColumn(); public: - LiveVariablePrinter(const MCRegisterInfo &MRI, const MCSubtargetInfo &STI) + LiveElementPrinter(const MCRegisterInfo &MRI, const MCSubtargetInfo &STI) : ActiveCols(Column()), MRI(MRI), STI(STI) {} void dump() const; @@ -114,7 +158,7 @@ public: /// otherwise this is being printed before it. void printAfterOtherLine(formatted_raw_ostream &OS, bool AfterInst); - /// Print any live variable range info needed to the right of a + /// Print any live element range info needed to the right of a /// non-instruction line of disassembly. This is where we print the variable /// names and expressions, with thin line-drawing characters connecting them /// to the live range which starts at the next instruction. If MustPrint is @@ -123,8 +167,13 @@ public: /// earlier on this line. void printBetweenInsts(formatted_raw_ostream &OS, bool MustPrint); - /// Print the live variable ranges to the right of a disassembled instruction. + /// Print the live element ranges to the right of a disassembled instruction. void printAfterInst(formatted_raw_ostream &OS); + + /// Print a line to idenfity the start of a live element. + void printStartLine(formatted_raw_ostream &OS, object::SectionedAddress Addr); + /// Print a line to idenfity the end of a live element. + void printEndLine(formatted_raw_ostream &OS, object::SectionedAddress Addr); }; class SourcePrinter { @@ -144,12 +193,13 @@ protected: private: bool cacheSource(const DILineInfo &LineInfoFile); - void printLines(formatted_raw_ostream &OS, const DILineInfo &LineInfo, - StringRef Delimiter, LiveVariablePrinter &LVP); + void printLines(formatted_raw_ostream &OS, object::SectionedAddress Address, + const DILineInfo &LineInfo, StringRef Delimiter, + LiveElementPrinter &LEP); void printSources(formatted_raw_ostream &OS, const DILineInfo &LineInfo, StringRef ObjectFilename, StringRef Delimiter, - LiveVariablePrinter &LVP); + LiveElementPrinter &LEP); // Returns line source code corresponding to `LineInfo`. // Returns empty string if source code cannot be found. @@ -162,7 +212,7 @@ public: virtual void printSourceLine(formatted_raw_ostream &OS, object::SectionedAddress Address, StringRef ObjectFilename, - LiveVariablePrinter &LVP, + LiveElementPrinter &LEP, StringRef Delimiter = "; "); }; diff --git a/llvm/tools/llvm-objdump/llvm-objdump.cpp b/llvm/tools/llvm-objdump/llvm-objdump.cpp index 74eb903..0316c4b 100644 --- a/llvm/tools/llvm-objdump/llvm-objdump.cpp +++ b/llvm/tools/llvm-objdump/llvm-objdump.cpp @@ -348,7 +348,8 @@ static bool Wide; std::string objdump::Prefix; uint32_t objdump::PrefixStrip; -DebugVarsFormat objdump::DbgVariables = DVDisabled; +DebugFormat objdump::DbgVariables = DFDisabled; +DebugFormat objdump::DbgInlinedFunctions = DFDisabled; int objdump::DbgIndent = 52; @@ -523,8 +524,8 @@ static const Target *getTarget(const ObjectFile *Obj) { // Get the target specific parser. std::string Error; - const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple, - Error); + const Target *TheTarget = + TargetRegistry::lookupTarget(ArchName, TheTriple, Error); if (!TheTarget) reportError(Obj->getFileName(), "can't find target: " + Error); @@ -633,7 +634,7 @@ static bool isCSKYElf(const ObjectFile &Obj) { } static bool hasMappingSymbols(const ObjectFile &Obj) { - return isArmElf(Obj) || isAArch64Elf(Obj) || isCSKYElf(Obj) ; + return isArmElf(Obj) || isAArch64Elf(Obj) || isCSKYElf(Obj); } static void printRelocation(formatted_raw_ostream &OS, StringRef FileName, @@ -653,7 +654,7 @@ static void printRelocation(formatted_raw_ostream &OS, StringRef FileName, static void printBTFRelocation(formatted_raw_ostream &FOS, llvm::BTFParser &BTF, object::SectionedAddress Address, - LiveVariablePrinter &LVP) { + LiveElementPrinter &LEP) { const llvm::BTF::BPFFieldReloc *Reloc = BTF.findFieldReloc(Address); if (!Reloc) return; @@ -664,7 +665,7 @@ static void printBTFRelocation(formatted_raw_ostream &FOS, llvm::BTFParser &BTF, if (LeadingAddr) FOS << format("%016" PRIx64 ": ", Address.Address + AdjustVMA); FOS << "CO-RE " << Val; - LVP.printAfterOtherLine(FOS, true); + LEP.printAfterOtherLine(FOS, true); } class PrettyPrinter { @@ -675,10 +676,11 @@ public: object::SectionedAddress Address, formatted_raw_ostream &OS, StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP, StringRef ObjectFilename, std::vector<RelocationRef> *Rels, - LiveVariablePrinter &LVP) { + LiveElementPrinter &LEP) { if (SP && (PrintSource || PrintLines)) - SP->printSourceLine(OS, Address, ObjectFilename, LVP); - LVP.printBetweenInsts(OS, false); + SP->printSourceLine(OS, Address, ObjectFilename, LEP); + LEP.printStartLine(OS, Address); + LEP.printBetweenInsts(OS, false); printRawData(Bytes, Address.Address, OS, STI); @@ -698,7 +700,7 @@ public: const MCAsmInfo &MAI, const MCSubtargetInfo &STI, StringRef Comments, - LiveVariablePrinter &LVP) { + LiveElementPrinter &LEP) { do { if (!Comments.empty()) { // Emit a line of comments. @@ -712,7 +714,7 @@ public: FOS.PadToColumn(CommentColumn); FOS << MAI.getCommentString() << ' ' << Comment; } - LVP.printAfterInst(FOS); + LEP.printAfterInst(FOS); FOS << "\n"; } while (!Comments.empty()); FOS.flush(); @@ -757,10 +759,10 @@ public: void emitPostInstructionInfo(formatted_raw_ostream &FOS, const MCAsmInfo &MAI, const MCSubtargetInfo &STI, StringRef Comments, - LiveVariablePrinter &LVP) override { + LiveElementPrinter &LEP) override { // Hexagon does not write anything to the comment stream, so we can just // print the separator. - LVP.printAfterInst(FOS); + LEP.printAfterInst(FOS); FOS << getInstructionSeparator(); FOS.flush(); if (ShouldClosePacket) @@ -771,9 +773,9 @@ public: object::SectionedAddress Address, formatted_raw_ostream &OS, StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP, StringRef ObjectFilename, std::vector<RelocationRef> *Rels, - LiveVariablePrinter &LVP) override { + LiveElementPrinter &LEP) override { if (SP && (PrintSource || PrintLines)) - SP->printSourceLine(OS, Address, ObjectFilename, LVP, ""); + SP->printSourceLine(OS, Address, ObjectFilename, LEP, ""); if (!MI) { printLead(Bytes, Address.Address, OS); OS << " <unknown>"; @@ -784,7 +786,7 @@ public: StringRef Preamble = IsStartOfBundle ? " { " : " "; if (SP && (PrintSource || PrintLines)) - SP->printSourceLine(OS, Address, ObjectFilename, LVP, ""); + SP->printSourceLine(OS, Address, ObjectFilename, LEP, ""); printLead(Bytes, Address.Address, OS); OS << Preamble; std::string Buf; @@ -845,9 +847,9 @@ public: object::SectionedAddress Address, formatted_raw_ostream &OS, StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP, StringRef ObjectFilename, std::vector<RelocationRef> *Rels, - LiveVariablePrinter &LVP) override { + LiveElementPrinter &LEP) override { if (SP && (PrintSource || PrintLines)) - SP->printSourceLine(OS, Address, ObjectFilename, LVP); + SP->printSourceLine(OS, Address, ObjectFilename, LEP); if (MI) { SmallString<40> InstStr; @@ -866,10 +868,10 @@ public: support::endian::read32<llvm::endianness::little>(Bytes.data())); OS.indent(42); } else { - OS << format("\t.byte 0x%02" PRIx8, Bytes[0]); - for (unsigned int i = 1; i < Bytes.size(); i++) - OS << format(", 0x%02" PRIx8, Bytes[i]); - OS.indent(55 - (6 * Bytes.size())); + OS << format("\t.byte 0x%02" PRIx8, Bytes[0]); + for (unsigned int i = 1; i < Bytes.size(); i++) + OS << format(", 0x%02" PRIx8, Bytes[i]); + OS.indent(55 - (6 * Bytes.size())); } } @@ -880,7 +882,7 @@ public: for (uint32_t D : ArrayRef(reinterpret_cast<const support::little32_t *>(Bytes.data()), Bytes.size() / 4)) - OS << format(" %08" PRIX32, D); + OS << format(" %08" PRIX32, D); } else { for (unsigned char B : Bytes) OS << format(" %02" PRIX8, B); @@ -898,9 +900,9 @@ public: object::SectionedAddress Address, formatted_raw_ostream &OS, StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP, StringRef ObjectFilename, std::vector<RelocationRef> *Rels, - LiveVariablePrinter &LVP) override { + LiveElementPrinter &LEP) override { if (SP && (PrintSource || PrintLines)) - SP->printSourceLine(OS, Address, ObjectFilename, LVP); + SP->printSourceLine(OS, Address, ObjectFilename, LEP); if (LeadingAddr) OS << format("%8" PRId64 ":", Address.Address / 8); if (ShowRawInsn) { @@ -921,10 +923,11 @@ public: object::SectionedAddress Address, formatted_raw_ostream &OS, StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP, StringRef ObjectFilename, std::vector<RelocationRef> *Rels, - LiveVariablePrinter &LVP) override { + LiveElementPrinter &LEP) override { if (SP && (PrintSource || PrintLines)) - SP->printSourceLine(OS, Address, ObjectFilename, LVP); - LVP.printBetweenInsts(OS, false); + SP->printSourceLine(OS, Address, ObjectFilename, LEP); + LEP.printStartLine(OS, Address); + LEP.printBetweenInsts(OS, false); size_t Start = OS.tell(); if (LeadingAddr) @@ -975,10 +978,11 @@ public: object::SectionedAddress Address, formatted_raw_ostream &OS, StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP, StringRef ObjectFilename, std::vector<RelocationRef> *Rels, - LiveVariablePrinter &LVP) override { + LiveElementPrinter &LEP) override { if (SP && (PrintSource || PrintLines)) - SP->printSourceLine(OS, Address, ObjectFilename, LVP); - LVP.printBetweenInsts(OS, false); + SP->printSourceLine(OS, Address, ObjectFilename, LEP); + LEP.printStartLine(OS, Address); + LEP.printBetweenInsts(OS, false); size_t Start = OS.tell(); if (LeadingAddr) @@ -1013,10 +1017,11 @@ public: object::SectionedAddress Address, formatted_raw_ostream &OS, StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP, StringRef ObjectFilename, std::vector<RelocationRef> *Rels, - LiveVariablePrinter &LVP) override { + LiveElementPrinter &LEP) override { if (SP && (PrintSource || PrintLines)) - SP->printSourceLine(OS, Address, ObjectFilename, LVP); - LVP.printBetweenInsts(OS, false); + SP->printSourceLine(OS, Address, ObjectFilename, LEP); + LEP.printStartLine(OS, Address); + LEP.printBetweenInsts(OS, false); size_t Start = OS.tell(); if (LeadingAddr) @@ -1057,7 +1062,7 @@ public: RISCVPrettyPrinter RISCVPrettyPrinterInst; PrettyPrinter &selectPrettyPrinter(Triple const &Triple) { - switch(Triple.getArch()) { + switch (Triple.getArch()) { default: return PrettyPrinterInst; case Triple::hexagon: @@ -1108,8 +1113,7 @@ private: DisassemblerTarget::DisassemblerTarget(const Target *TheTarget, ObjectFile &Obj, StringRef TripleName, StringRef MCPU, SubtargetFeatures &Features) - : TheTarget(TheTarget), - Printer(&selectPrettyPrinter(Triple(TripleName))), + : TheTarget(TheTarget), Printer(&selectPrettyPrinter(Triple(TripleName))), RegisterInfo(TheTarget->createMCRegInfo(TripleName)) { if (!RegisterInfo) reportError(Obj.getFileName(), "no register info for target " + TripleName); @@ -1388,7 +1392,6 @@ static bool shouldAdjustVA(const SectionRef &Section) { return false; } - typedef std::pair<uint64_t, char> MappingSymbolPair; static char getMappingSymbolKind(ArrayRef<MappingSymbolPair> MappingSymbols, uint64_t Address) { @@ -1416,8 +1419,7 @@ static uint64_t dumpARMELFData(uint64_t SectionAddr, uint64_t Index, dumpBytes(Bytes.slice(Index, 4), OS); AlignToInstStartColumn(Start, STI, OS); OS << "\t.word\t" - << format_hex(support::endian::read32(Bytes.data() + Index, Endian), - 10); + << format_hex(support::endian::read32(Bytes.data() + Index, Endian), 10); return 4; } if (Index + 2 <= End) { @@ -1791,9 +1793,9 @@ disassembleObject(ObjectFile &Obj, const ObjectFile &DbgObj, // STAB symbol's section field refers to a valid section index. Otherwise // the symbol may error trying to load a section that does not exist. DataRefImpl SymDRI = Symbol.getRawDataRefImpl(); - uint8_t NType = (MachO->is64Bit() ? - MachO->getSymbol64TableEntry(SymDRI).n_type: - MachO->getSymbolTableEntry(SymDRI).n_type); + uint8_t NType = + (MachO->is64Bit() ? MachO->getSymbol64TableEntry(SymDRI).n_type + : MachO->getSymbolTableEntry(SymDRI).n_type); if (NType & MachO::N_STAB) continue; } @@ -1892,15 +1894,15 @@ disassembleObject(ObjectFile &Obj, const ObjectFile &DbgObj, llvm::stable_sort(AbsoluteSymbols); std::unique_ptr<DWARFContext> DICtx; - LiveVariablePrinter LVP(*DT->Context->getRegisterInfo(), *DT->SubtargetInfo); + LiveElementPrinter LEP(*DT->Context->getRegisterInfo(), *DT->SubtargetInfo); - if (DbgVariables != DVDisabled) { + if (DbgVariables != DFDisabled || DbgInlinedFunctions != DFDisabled) { DICtx = DWARFContext::create(DbgObj); for (const std::unique_ptr<DWARFUnit> &CU : DICtx->compile_units()) - LVP.addCompileUnit(CU->getUnitDIE(false)); + LEP.addCompileUnit(CU->getUnitDIE(false)); } - LLVM_DEBUG(LVP.dump()); + LLVM_DEBUG(LEP.dump()); BBAddrMapInfo FullAddrMap; auto ReadBBAddrMap = [&](std::optional<unsigned> SectionIndex = @@ -2368,8 +2370,9 @@ disassembleObject(ObjectFile &Obj, const ObjectFile &DbgObj, ThisBytes.size(), DT->DisAsm->suggestBytesToSkip(ThisBytes, ThisAddr)); - LVP.update({Index, Section.getIndex()}, - {Index + Size, Section.getIndex()}, Index + Size != End); + LEP.update({ThisAddr, Section.getIndex()}, + {ThisAddr + Size, Section.getIndex()}, + Index + Size != End); DT->InstPrinter->setCommentStream(CommentStream); @@ -2377,7 +2380,7 @@ disassembleObject(ObjectFile &Obj, const ObjectFile &DbgObj, *DT->InstPrinter, Disassembled ? &Inst : nullptr, Bytes.slice(Index, Size), {SectionAddr + Index + VMAAdjustment, Section.getIndex()}, FOS, - "", *DT->SubtargetInfo, &SP, Obj.getFileName(), &Rels, LVP); + "", *DT->SubtargetInfo, &SP, Obj.getFileName(), &Rels, LEP); DT->InstPrinter->setCommentStream(llvm::nulls()); @@ -2562,22 +2565,26 @@ disassembleObject(ObjectFile &Obj, const ObjectFile &DbgObj, assert(DT->Context->getAsmInfo()); DT->Printer->emitPostInstructionInfo(FOS, *DT->Context->getAsmInfo(), *DT->SubtargetInfo, - CommentStream.str(), LVP); + CommentStream.str(), LEP); Comments.clear(); if (BTF) - printBTFRelocation(FOS, *BTF, {Index, Section.getIndex()}, LVP); + printBTFRelocation(FOS, *BTF, {Index, Section.getIndex()}, LEP); if (InlineRelocs) { while (findRel()) { // When --adjust-vma is used, update the address printed. printRelocation(FOS, Obj.getFileName(), *RelCur, SectionAddr + RelOffset + VMAAdjustment, Is64Bits); - LVP.printAfterOtherLine(FOS, true); + LEP.printAfterOtherLine(FOS, true); ++RelCur; } } + object::SectionedAddress NextAddr = { + SectionAddr + Index + VMAAdjustment + Size, Section.getIndex()}; + LEP.printEndLine(FOS, NextAddr); + Index += Size; } } @@ -2869,7 +2876,8 @@ void objdump::printSectionContents(const ObjectFile *Obj) { continue; } - StringRef Contents = unwrapOrError(Section.getContents(), Obj->getFileName()); + StringRef Contents = + unwrapOrError(Section.getContents(), Obj->getFileName()); // Dump out the content as hex and printable ascii characters. for (std::size_t Addr = 0, End = Contents.size(); Addr < End; Addr += 16) { @@ -3293,8 +3301,8 @@ static bool shouldWarnForInvalidStartStopAddress(ObjectFile *Obj) { return false; } -static void checkForInvalidStartStopAddress(ObjectFile *Obj, - uint64_t Start, uint64_t Stop) { +static void checkForInvalidStartStopAddress(ObjectFile *Obj, uint64_t Start, + uint64_t Stop) { if (!shouldWarnForInvalidStartStopAddress(Obj)) return; @@ -3617,13 +3625,25 @@ static void parseObjdumpOptions(const llvm::opt::InputArgList &InputArgs) { Prefix = InputArgs.getLastArgValue(OBJDUMP_prefix).str(); parseIntArg(InputArgs, OBJDUMP_prefix_strip, PrefixStrip); if (const opt::Arg *A = InputArgs.getLastArg(OBJDUMP_debug_vars_EQ)) { - DbgVariables = StringSwitch<DebugVarsFormat>(A->getValue()) - .Case("ascii", DVASCII) - .Case("unicode", DVUnicode) - .Default(DVInvalid); - if (DbgVariables == DVInvalid) + DbgVariables = StringSwitch<DebugFormat>(A->getValue()) + .Case("ascii", DFASCII) + .Case("unicode", DFUnicode) + .Default(DFInvalid); + if (DbgVariables == DFInvalid) + invalidArgValue(A); + } + + if (const opt::Arg *A = + InputArgs.getLastArg(OBJDUMP_debug_inlined_funcs_EQ)) { + DbgInlinedFunctions = StringSwitch<DebugFormat>(A->getValue()) + .Case("ascii", DFASCII) + .Case("limits-only", DFLimitsOnly) + .Case("unicode", DFUnicode) + .Default(DFInvalid); + if (DbgInlinedFunctions == DFInvalid) invalidArgValue(A); } + if (const opt::Arg *A = InputArgs.getLastArg(OBJDUMP_disassembler_color_EQ)) { DisassemblyColor = StringSwitch<ColorOutput>(A->getValue()) .Case("on", ColorOutput::Enable) @@ -3634,7 +3654,7 @@ static void parseObjdumpOptions(const llvm::opt::InputArgList &InputArgs) { invalidArgValue(A); } - parseIntArg(InputArgs, OBJDUMP_debug_vars_indent_EQ, DbgIndent); + parseIntArg(InputArgs, OBJDUMP_debug_indent_EQ, DbgIndent); parseMachOOptions(InputArgs); diff --git a/llvm/tools/llvm-objdump/llvm-objdump.h b/llvm/tools/llvm-objdump/llvm-objdump.h index 25d9c1e..ce06429 100644 --- a/llvm/tools/llvm-objdump/llvm-objdump.h +++ b/llvm/tools/llvm-objdump/llvm-objdump.h @@ -40,11 +40,12 @@ class XCOFFObjectFile; namespace objdump { -enum DebugVarsFormat { DVDisabled, DVUnicode, DVASCII, DVInvalid }; +enum DebugFormat { DFASCII, DFDisabled, DFInvalid, DFLimitsOnly, DFUnicode }; extern bool ArchiveHeaders; extern int DbgIndent; -extern DebugVarsFormat DbgVariables; +extern DebugFormat DbgVariables; +extern DebugFormat DbgInlinedFunctions; extern bool Demangle; extern bool Disassemble; extern bool DisassembleAll; @@ -126,7 +127,7 @@ void printSectionContents(const object::ObjectFile *O); void reportWarning(const Twine &Message, StringRef File); template <typename T, typename... Ts> -T unwrapOrError(Expected<T> EO, Ts &&... Args) { +T unwrapOrError(Expected<T> EO, Ts &&...Args) { if (EO) return std::move(*EO); reportError(EO.takeError(), std::forward<Ts>(Args)...); |