diff --git a/llvm/include/llvm/MC/MCDisassembler/MCDisassembler.h b/llvm/include/llvm/MC/MCDisassembler/MCDisassembler.h --- a/llvm/include/llvm/MC/MCDisassembler/MCDisassembler.h +++ b/llvm/include/llvm/MC/MCDisassembler/MCDisassembler.h @@ -20,20 +20,25 @@ struct SymbolInfoTy { uint64_t Addr; StringRef Name; - uint8_t Type; + int16_t TypeOrSmc; ///< For Elf, it stores the symbol type. + ///< for XCOFF, it store storage mapping class of + ///< symbol if there is,other wise it store -1. + int64_t Index; + bool ShowSymDesc; - SymbolInfoTy(uint64_t Addr, StringRef Name, uint8_t Type) - : Addr(Addr), Name(Name), Type(Type){}; + SymbolInfoTy(uint64_t Addr, StringRef Name, uint8_t TypeOrSmc, + int64_t Idx, bool Show) + : Addr(Addr), Name(Name), TypeOrSmc(TypeOrSmc), Index(Idx), + ShowSymDesc(Show){}; friend bool operator<(const SymbolInfoTy &P1, const SymbolInfoTy &P2) { - return std::tie(P1.Addr, P1.Name, P1.Type) < - std::tie(P2.Addr, P2.Name, P2.Type); + return std::tie(P1.Addr, P1.Name, P1.TypeOrSmc) < + std::tie(P2.Addr, P2.Name, P2.TypeOrSmc); } }; using SectionSymbolsTy = std::vector; - template class ArrayRef; class MCContext; class MCInst; diff --git a/llvm/include/llvm/Object/XCOFFObjectFile.h b/llvm/include/llvm/Object/XCOFFObjectFile.h --- a/llvm/include/llvm/Object/XCOFFObjectFile.h +++ b/llvm/include/llvm/Object/XCOFFObjectFile.h @@ -128,6 +128,12 @@ }; struct XCOFFCsectAuxEnt32 { + enum { + SymbolTypeMask = 0x07, + SymbolAlignmentMask = 0xF8, + SymbolAlignmentBitOffset = 3 + }; + support::ubig32_t SectionOrLength; // If the symbol type is XTY_SD or XTY_CM, the csect // length. @@ -140,6 +146,16 @@ XCOFF::StorageMappingClass StorageMappingClass; support::ubig32_t StabInfoIndex; support::ubig16_t StabSectNum; + uint16_t getAlignmentLog2() const { + return (SymbolAlignmentAndType & SymbolAlignmentMask) >> + SymbolAlignmentBitOffset; + }; + + uint8_t getSymbolType() const { + return SymbolAlignmentAndType & SymbolTypeMask; + }; + + bool isLabel() const { return getSymbolType() == XCOFF::XTY_LD; } }; struct XCOFFFileAuxEnt { diff --git a/llvm/lib/BinaryFormat/XCOFF.cpp b/llvm/lib/BinaryFormat/XCOFF.cpp --- a/llvm/lib/BinaryFormat/XCOFF.cpp +++ b/llvm/lib/BinaryFormat/XCOFF.cpp @@ -10,24 +10,33 @@ using namespace llvm; +#define SMC_CASE(A) \ + case XCOFF::XMC_##A: \ + return #A; StringRef XCOFF::getMappingClassString(XCOFF::StorageMappingClass SMC) { switch (SMC) { - case XCOFF::XMC_DS: - return "DS"; - case XCOFF::XMC_RW: - return "RW"; - case XCOFF::XMC_PR: - return "PR"; - case XCOFF::XMC_TC0: - return "TC0"; - case XCOFF::XMC_BS: - return "BS"; - case XCOFF::XMC_RO: - return "RO"; - case XCOFF::XMC_UA: - return "UA"; - case XCOFF::XMC_TC: - return "TC"; + SMC_CASE(PR) + SMC_CASE(RO) + SMC_CASE(DB) + SMC_CASE(GL) + SMC_CASE(XO) + SMC_CASE(SV) + SMC_CASE(SV64) + SMC_CASE(SV3264) + SMC_CASE(TI) + SMC_CASE(TB) + SMC_CASE(RW) + SMC_CASE(TC0) + SMC_CASE(TC) + SMC_CASE(TD) + SMC_CASE(DS) + SMC_CASE(UA) + SMC_CASE(BS) + SMC_CASE(UC) + SMC_CASE(TL) + SMC_CASE(UL) + SMC_CASE(TE) +#undef SMC_CASE default: report_fatal_error("Unhandled storage-mapping class."); } diff --git a/llvm/lib/Target/AMDGPU/Disassembler/AMDGPUDisassembler.cpp b/llvm/lib/Target/AMDGPU/Disassembler/AMDGPUDisassembler.cpp --- a/llvm/lib/Target/AMDGPU/Disassembler/AMDGPUDisassembler.cpp +++ b/llvm/lib/Target/AMDGPU/Disassembler/AMDGPUDisassembler.cpp @@ -1210,11 +1210,11 @@ if (!Symbols) return false; - auto Result = std::find_if(Symbols->begin(), Symbols->end(), - [Value](const SymbolInfoTy& Val) { - return Val.Addr == static_cast(Value) - && Val.Type == ELF::STT_NOTYPE; - }); + auto Result = std::find_if( + Symbols->begin(), Symbols->end(), [Value](const SymbolInfoTy &Val) { + return Val.Addr == static_cast(Value) && + Val.TypeOrSmc == ELF::STT_NOTYPE; + }); if (Result != Symbols->end()) { auto *Sym = Ctx.getOrCreateSymbol(Result->Name); const auto *Add = MCSymbolRefExpr::create(Sym, Ctx); diff --git a/llvm/test/tools/llvm-objdump/xcoff-disassemble-all.test b/llvm/test/tools/llvm-objdump/xcoff-disassemble-all.test --- a/llvm/test/tools/llvm-objdump/xcoff-disassemble-all.test +++ b/llvm/test/tools/llvm-objdump/xcoff-disassemble-all.test @@ -1,4 +1,7 @@ -# RUN: llvm-objdump -D %p/Inputs/xcoff-section-headers.o | \ +# RUN: llvm-objdump -D -E %p/Inputs/xcoff-section-headers.o | \ +# RUN: FileCheck %s + +# RUN: llvm-objdump -D --symbol_description %p/Inputs/xcoff-section-headers.o | \ # RUN: FileCheck %s # xcoff-section-headers.o Compiled with IBM XL C/C++ for AIX, V16.1.0 @@ -15,7 +18,7 @@ ; REQUIRES: powerpc-registered-target CHECK: Inputs/xcoff-section-headers.o: file format aixcoff-rs6000 CHECK: Disassembly of section .text: -CHECK: 00000000 .text: +CHECK: 00000000 (idx: 4) .text: CHECK-NEXT: 0: 80 62 00 04 lwz 3, 4(2) CHECK-NEXT: 4: 80 63 00 00 lwz 3, 0(3) CHECK-NEXT: 8: 4e 80 00 20 blr @@ -27,29 +30,29 @@ CHECK-NEXT: 20: 6e 63 00 00 xoris 3, 19, 0 CHECK-NEXT: ... CHECK: Disassembly of section .data: -CHECK: 00000080 func: +CHECK: 00000080 (idx: 22) func[TC]: CHECK-NEXT: 80: 00 00 00 94 -CHECK: 00000084 a: +CHECK: 00000084 (idx: 26) a[TC]: CHECK-NEXT: 84: 00 00 00 a4 -CHECK: 00000088 b: +CHECK: 00000088 (idx: 30) b[TC]: CHECK-NEXT: 88: 00 00 00 a0 -CHECK: 0000008c c: +CHECK: 0000008c (idx: 34) c[TC]: CHECK-NEXT: 8c: 00 00 00 08 -CHECK: 00000090 d: +CHECK: 00000090 (idx: 38) d[TC]: CHECK-NEXT: 90: 00 00 00 00 -CHECK: 00000094 func: +CHECK: 00000094 (idx: 20) func[DS]: CHECK-NEXT: 94: 00 00 00 00 CHECK-NEXT: 98: 00 00 00 80 CHECK-NEXT: 9c: 00 00 00 00 -CHECK: 000000a0 b: +CHECK: 000000a0 (idx: 28) b[RW]: CHECK-NEXT: a0: 00 00 30 39 CHECK: Disassembly of section .bss: -CHECK: 000000a4 a: +CHECK: 000000a4 (idx: 24) a[RW]: CHECK-NEXT: ... CHECK: Disassembly of section .tdata: -CHECK: 00000000 d: +CHECK: 00000000 (idx: 36) d[TL]: CHECK-NEXT: 0: 40 09 21 f9 bdnzfl 9, .+8696 CHECK-NEXT: 4: f0 1b 86 6e CHECK: Disassembly of section .tbss: -CHECK: 00000008 c: +CHECK: 00000008 (idx: 32) c[UL]: CHECK-NEXT: ... diff --git a/llvm/tools/llvm-objdump/CMakeLists.txt b/llvm/tools/llvm-objdump/CMakeLists.txt --- a/llvm/tools/llvm-objdump/CMakeLists.txt +++ b/llvm/tools/llvm-objdump/CMakeLists.txt @@ -20,6 +20,7 @@ ELFDump.cpp MachODump.cpp WasmDump.cpp + XCOFFDump.cpp ) if(HAVE_LIBXAR) diff --git a/llvm/tools/llvm-objdump/XCOFFDump.cpp b/llvm/tools/llvm-objdump/XCOFFDump.cpp new file mode 100644 --- /dev/null +++ b/llvm/tools/llvm-objdump/XCOFFDump.cpp @@ -0,0 +1,24 @@ +#include "llvm-objdump.h" +#include "llvm/Object/XCOFFObjectFile.h" + +using namespace llvm::object; + +#define SymDoNotHasSmc -1 + +int16_t llvm::getXCoffSymbolCsectSMC(const ObjectFile *Obj, + const SymbolRef &Sym) { + assert(Obj->isXCOFF() && "Not XCOFF object file."); + DataRefImpl SymbolDRI = Sym.getRawDataRefImpl(); + + XCOFFSymbolRef SymRef(SymbolDRI, static_cast(Obj)); + + if (SymRef.hasCsectAuxEnt()) { + assert(SymRef.getNumberOfAuxEntries() && + "No CSECT Auxiliary Entry is found."); + + const XCOFFCsectAuxEnt32 *AuxEntPtr = SymRef.getXCOFFCsectAuxEnt32(); + return AuxEntPtr->StorageMappingClass; + } + + return SymDoNotHasSmc; +} diff --git a/llvm/tools/llvm-objdump/llvm-objdump.h b/llvm/tools/llvm-objdump/llvm-objdump.h --- a/llvm/tools/llvm-objdump/llvm-objdump.h +++ b/llvm/tools/llvm-objdump/llvm-objdump.h @@ -139,6 +139,10 @@ void printSectionContents(const object::ObjectFile *O); void printSymbolTable(const object::ObjectFile *O, StringRef ArchiveName, StringRef ArchitectureName = StringRef()); + +int16_t getXCoffSymbolCsectSMC(const object::ObjectFile *Obj, + const object::SymbolRef &Sym); + LLVM_ATTRIBUTE_NORETURN void reportError(StringRef File, Twine Message); LLVM_ATTRIBUTE_NORETURN void reportError(Error E, StringRef FileName, StringRef ArchiveName = "", diff --git a/llvm/tools/llvm-objdump/llvm-objdump.cpp b/llvm/tools/llvm-objdump/llvm-objdump.cpp --- a/llvm/tools/llvm-objdump/llvm-objdump.cpp +++ b/llvm/tools/llvm-objdump/llvm-objdump.cpp @@ -46,6 +46,7 @@ #include "llvm/Object/MachOUniversal.h" #include "llvm/Object/ObjectFile.h" #include "llvm/Object/Wasm.h" +#include "llvm/Object/XCOFFObjectFile.h" #include "llvm/Support/Casting.h" #include "llvm/Support/CommandLine.h" #include "llvm/Support/Debug.h" @@ -143,6 +144,14 @@ cl::NotHidden, cl::Grouping, cl::aliasopt(DisassembleAll)); +cl::opt + SymbolDescription("symbol_description", + cl::desc("Add symbol description for dissembly"), + cl::init(false), cl::cat(ObjdumpCat)); +static cl::alias SymbolDescriptionShort( + "E", cl::desc("Alias for --Add Symbol Description for dissembly"), + cl::NotHidden, cl::Grouping, cl::aliasopt(SymbolDescription)); + static cl::list DisassembleFunctions("disassemble-functions", cl::CommaSeparated, cl::desc("List of functions to disassemble. " @@ -898,6 +907,37 @@ llvm_unreachable("Unsupported binary format"); } +#define NO_SYMINDEX -1 + +static int64_t getSymbolIndex(const ObjectFile *Obj, const SymbolRef &Sym) { + if (!Obj->isXCOFF()) + return NO_SYMINDEX; + + const auto *XCOFFObj = dyn_cast(Obj); + DataRefImpl SymbolDRI = Sym.getRawDataRefImpl(); + return XCOFFObj->getSymbolIndex(SymbolDRI.p); +} + +static bool isSymbolDescriptionDisplay(const ObjectFile *Obj, + const SymbolRef &Sym) { + if (!Obj->isXCOFF()) + return false; + + DataRefImpl SymbolDRI = Sym.getRawDataRefImpl(); + + XCOFFSymbolRef SymRef(SymbolDRI, static_cast(Obj)); + + if (SymRef.hasCsectAuxEnt()) { + assert(SymRef.getNumberOfAuxEntries() && + "No CSECT Auxiliary Entry is found."); + + const XCOFFCsectAuxEnt32 *AuxEntPtr = SymRef.getXCOFFCsectAuxEnt32(); + return !AuxEntPtr->isLabel(); + } + + return false; +} + template static void addDynamicElfSymbols(const ELFObjectFile *Obj, std::map &AllSymbols) { @@ -921,7 +961,9 @@ if (SecI == Obj->section_end()) continue; - AllSymbols[*SecI].emplace_back(Address, Name, SymbolType); + AllSymbols[*SecI].emplace_back(Address, Name, SymbolType, + getSymbolIndex(Obj, Symbol), + isSymbolDescriptionDisplay(Obj, Symbol)); } } @@ -963,8 +1005,10 @@ StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName()); if (!Name.empty()) - AllSymbols[*Plt].emplace_back( - PltEntry.second, Saver.save((Name + "@plt").str()), SymbolType); + AllSymbols[*Plt].emplace_back(PltEntry.second, + Saver.save((Name + "@plt").str()), + SymbolType, getSymbolIndex(Obj, Symbol), + isSymbolDescriptionDisplay(Obj, Symbol)); } } } @@ -1108,6 +1152,23 @@ } } +static void printXCOFFSymbolDescription(SymbolInfoTy &SymbolInfo, + std::string SymbolName) { + int16_t Smc = SymbolInfo.TypeOrSmc; + int64_t SymIndex = SymbolInfo.Index; + + if (SymIndex >= 0) + outs() << "(idx: " << SymIndex << ") "; + + outs() << SymbolName; + + if (SymIndex >= 0 && Smc >= 0 && SymbolInfo.ShowSymDesc) + outs() + << "[" + << XCOFF::getMappingClassString((XCOFF::StorageMappingClass)Smc).str() + << "]"; +} + static void disassembleObject(const Target *TheTarget, const ObjectFile *Obj, MCContext &Ctx, MCDisassembler *PrimaryDisAsm, MCDisassembler *SecondaryDisAsm, @@ -1140,17 +1201,22 @@ if (Name.empty()) continue; - uint8_t SymbolType = ELF::STT_NOTYPE; + int16_t SymbolType = ELF::STT_NOTYPE; + const int64_t SymbolIndex = getSymbolIndex(Obj, Symbol); + const bool SymbolDescriptionDisplay = + isSymbolDescriptionDisplay(Obj, Symbol); + if (Obj->isELF()) { SymbolType = getElfSymbolType(Obj, Symbol); if (SymbolType == ELF::STT_SECTION) continue; - } + } else if (Obj->isXCOFF()) + SymbolType = getXCoffSymbolCsectSMC(Obj, Symbol); // Don't ask a Mach-O STAB symbol for its section unless you know that // 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. - if (MachO) { + else if (MachO) { DataRefImpl SymDRI = Symbol.getRawDataRefImpl(); uint8_t NType = (MachO->is64Bit() ? MachO->getSymbol64TableEntry(SymDRI).n_type: @@ -1161,9 +1227,11 @@ section_iterator SecI = unwrapOrError(Symbol.getSection(), FileName); if (SecI != Obj->section_end()) - AllSymbols[*SecI].emplace_back(Address, Name, SymbolType); + AllSymbols[*SecI].emplace_back(Address, Name, SymbolType, SymbolIndex, + SymbolDescriptionDisplay); else - AbsoluteSymbols.emplace_back(Address, Name, SymbolType); + AbsoluteSymbols.emplace_back(Address, Name, SymbolType, SymbolIndex, + SymbolDescriptionDisplay); } if (AllSymbols.empty() && Obj->isELF()) addDynamicElfSymbols(Obj, AllSymbols); @@ -1199,9 +1267,11 @@ }); if (Sec != SectionAddresses.begin()) { --Sec; - AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE); + AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE, + NO_SYMINDEX, false); } else - AbsoluteSymbols.emplace_back(VA, Name, ELF::STT_NOTYPE); + AbsoluteSymbols.emplace_back(VA, Name, ELF::STT_NOTYPE, NO_SYMINDEX, + false); } } @@ -1265,8 +1335,9 @@ if (Symbols.empty() || Symbols[0].Addr != 0) { Symbols.insert( Symbols.begin(), - SymbolInfoTy(SectionAddr, SectionName, - Section.isText() ? ELF::STT_FUNC : ELF::STT_OBJECT)); + SymbolInfoTy(SectionAddr, SectionName, + Section.isText() ? ELF::STT_FUNC : ELF::STT_OBJECT, + NO_SYMINDEX, false)); } SmallString<40> Comments; @@ -1321,12 +1392,12 @@ } if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) { - if (Symbols[SI].Type == ELF::STT_AMDGPU_HSA_KERNEL) { + if (Symbols[SI].TypeOrSmc == ELF::STT_AMDGPU_HSA_KERNEL) { // skip amd_kernel_code_t at the begining of kernel symbol (256 bytes) Start += 256; } if (SI == SE - 1 || - Symbols[SI + 1].Type == ELF::STT_AMDGPU_HSA_KERNEL) { + Symbols[SI + 1].TypeOrSmc == ELF::STT_AMDGPU_HSA_KERNEL) { // cut trailing zeroes at the end of kernel // cut up to 256 bytes const uint64_t EndAlign = 256; @@ -1341,8 +1412,11 @@ if (!NoLeadingAddr) outs() << format(Is64Bits ? "%016" PRIx64 " " : "%08" PRIx64 " ", SectionAddr + Start + VMAAdjustment); - - outs() << SymbolName << ":\n"; + if (Obj->isXCOFF() && SymbolDescription) { + printXCOFFSymbolDescription(Symbols[SI], SymbolName); + outs() << ":\n"; + } else + outs() << SymbolName << ":\n"; // Don't print raw contents of a virtual section. A virtual section // doesn't have any contents in the file. @@ -1365,7 +1439,7 @@ // only disassembling text (applicable all architectures), we are in a // situation where we must print the data and not disassemble it. if (Obj->isELF() && !DisassembleAll && Section.isText()) { - uint8_t SymTy = Symbols[SI].Type; + uint8_t SymTy = Symbols[SI].TypeOrSmc; if (SymTy == ELF::STT_OBJECT || SymTy == ELF::STT_COMMON) { dumpELFData(SectionAddr, Index, End, Bytes); Index = End; @@ -1373,7 +1447,7 @@ } bool CheckARMELFData = hasMappingSymbols(Obj) && - Symbols[SI].Type != ELF::STT_OBJECT && + Symbols[SI].TypeOrSmc != ELF::STT_OBJECT && !DisassembleAll; while (Index < End) { // ARM and AArch64 ELF binaries can interleave data and text in the diff --git a/llvm/tools/llvm-readobj/XCOFFDumper.cpp b/llvm/tools/llvm-readobj/XCOFFDumper.cpp --- a/llvm/tools/llvm-readobj/XCOFFDumper.cpp +++ b/llvm/tools/llvm-readobj/XCOFFDumper.cpp @@ -22,11 +22,6 @@ namespace { class XCOFFDumper : public ObjDumper { - enum { - SymbolTypeMask = 0x07, - SymbolAlignmentMask = 0xF8, - SymbolAlignmentBitOffset = 3 - }; public: XCOFFDumper(const XCOFFObjectFile &Obj, ScopedPrinter &Writer) @@ -211,17 +206,15 @@ DictScope SymDs(W, "CSECT Auxiliary Entry"); W.printNumber("Index", Obj.getSymbolIndex(reinterpret_cast(AuxEntPtr))); - if ((AuxEntPtr->SymbolAlignmentAndType & SymbolTypeMask) == XCOFF::XTY_LD) + if (AuxEntPtr->isLabel()) W.printNumber("ContainingCsectSymbolIndex", AuxEntPtr->SectionOrLength); else W.printNumber("SectionLen", AuxEntPtr->SectionOrLength); W.printHex("ParameterHashIndex", AuxEntPtr->ParameterHashIndex); W.printHex("TypeChkSectNum", AuxEntPtr->TypeChkSectNum); // Print out symbol alignment and type. - W.printNumber("SymbolAlignmentLog2", - (AuxEntPtr->SymbolAlignmentAndType & SymbolAlignmentMask) >> - SymbolAlignmentBitOffset); - W.printEnum("SymbolType", AuxEntPtr->SymbolAlignmentAndType & SymbolTypeMask, + W.printNumber("SymbolAlignmentLog2", AuxEntPtr->getAlignmentLog2()); + W.printEnum("SymbolType", AuxEntPtr->getSymbolType(), makeArrayRef(CsectSymbolTypeClass)); W.printEnum("StorageMappingClass", static_cast(AuxEntPtr->StorageMappingClass),