From 0c873adc82a81b0bce317c3e2cb3139e990a0f9e Mon Sep 17 00:00:00 2001 From: Rui Ueyama Date: Fri, 27 Sep 2013 00:07:01 +0000 Subject: [PATCH] llvm-objdump: Dump COFF import table if -private-headers option is given. This is a patch to add capability to llvm-objdump to dump COFF Import Table entries, so that we can write tests for LLD checking Import Table contents. llvm-objdump did not print anything but just file name if the format is COFF and -private-headers option is given. This is a patch adds capability for dumping DLL Import Table, which is specific to the COFF format. In this patch I defined a new iterator to iterate over import table entries. Also added a few functions to COFFObjectFile.cpp to access fields of the entry. Differential Revision: http://llvm-reviews.chandlerc.com/D1719 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@191472 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/llvm/Object/COFF.h | 40 +++- lib/Object/COFFObjectFile.cpp | 196 +++++++++++++++--- .../llvm-objdump/Inputs/nop.exe.coff-i386 | Bin 0 -> 7680 bytes .../llvm-objdump/Inputs/trivial.obj.elf-i386 | Bin 0 -> 449 bytes .../Inputs/win64-unwind.exe.coff-x86_64 | Bin 0 -> 698 bytes .../Inputs/win64-unwind.exe.coff-x86_64.asm | 53 +++++ .../llvm-objdump/coff-private-headers.test | 9 + .../tools/llvm-objdump/disassembly-show-raw.s | 15 -- .../llvm-objdump/disassembly-show-raw.test | 14 ++ test/tools/llvm-objdump/lit.local.cfg | 4 - test/tools/llvm-objdump/win64-unwind-data.s | 106 ---------- .../tools/llvm-objdump/win64-unwind-data.test | 52 +++++ tools/llvm-objdump/COFFDump.cpp | 46 ++++ tools/llvm-objdump/llvm-objdump.cpp | 12 +- tools/llvm-objdump/llvm-objdump.h | 3 +- 15 files changed, 390 insertions(+), 160 deletions(-) create mode 100644 test/tools/llvm-objdump/Inputs/nop.exe.coff-i386 create mode 100644 test/tools/llvm-objdump/Inputs/trivial.obj.elf-i386 create mode 100644 test/tools/llvm-objdump/Inputs/win64-unwind.exe.coff-x86_64 create mode 100644 test/tools/llvm-objdump/Inputs/win64-unwind.exe.coff-x86_64.asm create mode 100644 test/tools/llvm-objdump/coff-private-headers.test delete mode 100644 test/tools/llvm-objdump/disassembly-show-raw.s create mode 100644 test/tools/llvm-objdump/disassembly-show-raw.test delete mode 100644 test/tools/llvm-objdump/lit.local.cfg delete mode 100644 test/tools/llvm-objdump/win64-unwind-data.s create mode 100644 test/tools/llvm-objdump/win64-unwind-data.test diff --git a/include/llvm/Object/COFF.h b/include/llvm/Object/COFF.h index cb464abeeba..e9ea547bec7 100644 --- a/include/llvm/Object/COFF.h +++ b/include/llvm/Object/COFF.h @@ -23,6 +23,8 @@ namespace llvm { class ArrayRef; namespace object { +class ImportDirectoryEntryRef; +typedef content_iterator import_directory_iterator; /// The DOS compatible header at the front of all PE/COFF executables. struct dos_header { @@ -202,6 +204,7 @@ struct coff_aux_section_definition { class COFFObjectFile : public ObjectFile { private: + friend class ImportDirectoryEntryRef; const coff_file_header *COFFHeader; const pe32_header *PE32Header; const data_directory *DataDirectory; @@ -209,6 +212,8 @@ private: const coff_symbol *SymbolTable; const char *StringTable; uint32_t StringTableSize; + const import_directory_table_entry *ImportDirectory; + uint32_t NumberOfImportDirectory; error_code getString(uint32_t offset, StringRef &Res) const; @@ -216,6 +221,9 @@ private: const coff_section *toSec(DataRefImpl Sec) const; const coff_relocation *toRel(DataRefImpl Rel) const; + error_code initSymbolTablePtr(); + error_code initImportTablePtr(); + protected: virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const; virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const; @@ -287,6 +295,9 @@ public: virtual unsigned getArch() const; virtual StringRef getLoadName() const; + import_directory_iterator getImportDirectoryBegin() const; + import_directory_iterator getImportDirectoryEnd() const; + error_code getHeader(const coff_file_header *&Res) const; error_code getCOFFHeader(const coff_file_header *&Res) const; error_code getPE32Header(const pe32_header *&Res) const; @@ -307,12 +318,37 @@ public: error_code getSectionContents(const coff_section *Sec, ArrayRef &Res) const; + error_code getRvaPtr(uint32_t Rva, uintptr_t &Res) const; + error_code getHintName(uint32_t Rva, uint16_t &Hint, StringRef &Name) const; + static inline bool classof(const Binary *v) { return v->isCOFF(); } }; -} -} +// The iterator for the import directory table. +class ImportDirectoryEntryRef { +public: + ImportDirectoryEntryRef() : OwningObject(0) {} + ImportDirectoryEntryRef(DataRefImpl ImportDirectory, + const COFFObjectFile *Owner) + : ImportDirectoryPimpl(ImportDirectory), OwningObject(Owner) {} + + bool operator==(const ImportDirectoryEntryRef &Other) const; + error_code getNext(ImportDirectoryEntryRef &Result) const; + error_code getName(StringRef &Result) const; + + error_code + getImportTableEntry(const import_directory_table_entry *&Result) const; + + error_code + getImportLookupEntry(const COFF::ImportLookupTableEntry32 *&Result) const; + +private: + DataRefImpl ImportDirectoryPimpl; + const COFFObjectFile *OwningObject; +}; +} // end namespace object +} // end namespace llvm #endif diff --git a/lib/Object/COFFObjectFile.cpp b/lib/Object/COFFObjectFile.cpp index f3f2532406a..14292418ff4 100644 --- a/lib/Object/COFFObjectFile.cpp +++ b/lib/Object/COFFObjectFile.cpp @@ -16,6 +16,8 @@ #include "llvm/ADT/SmallString.h" #include "llvm/ADT/StringSwitch.h" #include "llvm/ADT/Triple.h" +#include "llvm/Support/Debug.h" +#include "llvm/Support/raw_ostream.h" using namespace llvm; using namespace object; @@ -429,6 +431,94 @@ relocation_iterator COFFObjectFile::getSectionRelEnd(DataRefImpl Sec) const { return relocation_iterator(RelocationRef(ret, this)); } +// Initialize the pointer to the symbol table. +error_code COFFObjectFile::initSymbolTablePtr() { + if (error_code ec = getObject( + SymbolTable, Data, base() + COFFHeader->PointerToSymbolTable, + COFFHeader->NumberOfSymbols * sizeof(coff_symbol))) + return ec; + + // Find string table. The first four byte of the string table contains the + // total size of the string table, including the size field itself. If the + // string table is empty, the value of the first four byte would be 4. + const uint8_t *StringTableAddr = + base() + COFFHeader->PointerToSymbolTable + + COFFHeader->NumberOfSymbols * sizeof(coff_symbol); + const ulittle32_t *StringTableSizePtr; + if (error_code ec = getObject(StringTableSizePtr, Data, StringTableAddr)) + return ec; + StringTableSize = *StringTableSizePtr; + if (error_code ec = + getObject(StringTable, Data, StringTableAddr, StringTableSize)) + return ec; + + // Check that the string table is null terminated if has any in it. + if (StringTableSize < 4 || + (StringTableSize > 4 && StringTable[StringTableSize - 1] != 0)) + return object_error::parse_failed; + return object_error::success; +} + +// Returns the file offset for the given RVA. +error_code COFFObjectFile::getRvaPtr(uint32_t Rva, uintptr_t &Res) const { + error_code ec; + for (section_iterator i = begin_sections(), e = end_sections(); i != e; + i.increment(ec)) { + if (ec) + return ec; + const coff_section *Section = getCOFFSection(i); + uint32_t SectionStart = Section->VirtualAddress; + uint32_t SectionEnd = Section->VirtualAddress + Section->VirtualSize; + if (SectionStart <= Rva && Rva < SectionEnd) { + uint32_t Offset = Rva - SectionStart; + Res = uintptr_t(base()) + Section->PointerToRawData + Offset; + return object_error::success; + } + } + return object_error::parse_failed; +} + +// Returns hint and name fields, assuming \p Rva is pointing to a Hint/Name +// table entry. +error_code COFFObjectFile:: +getHintName(uint32_t Rva, uint16_t &Hint, StringRef &Name) const { + uintptr_t IntPtr = 0; + if (error_code ec = getRvaPtr(Rva, IntPtr)) + return ec; + const uint8_t *Ptr = reinterpret_cast(IntPtr); + Hint = *reinterpret_cast(Ptr); + Name = StringRef(reinterpret_cast(Ptr + 2)); + return object_error::success; +} + +// Find the import table. +error_code COFFObjectFile::initImportTablePtr() { + // First, we get the RVA of the import table. If the file lacks a pointer to + // the import table, do nothing. + const data_directory *DataEntry; + if (getDataDirectory(COFF::IMPORT_TABLE, DataEntry)) + return object_error::success; + + // Do nothing if the pointer to import table is NULL. + if (DataEntry->RelativeVirtualAddress == 0) + return object_error::success; + + uint32_t ImportTableRva = DataEntry->RelativeVirtualAddress; + NumberOfImportDirectory = DataEntry->Size / + sizeof(import_directory_table_entry); + + // Find the section that contains the RVA. This is needed because the RVA is + // the import table's memory address which is different from its file offset. + uintptr_t IntPtr = 0; + if (error_code ec = getRvaPtr(ImportTableRva, IntPtr)) + return ec; + ImportDirectory = reinterpret_cast< + const import_directory_table_entry *>(IntPtr); + + // It's an error if there's no section containing the Import Table RVA. + return object_error::parse_failed; +} + COFFObjectFile::COFFObjectFile(MemoryBuffer *Object, error_code &ec) : ObjectFile(Binary::ID_COFF, Object) , COFFHeader(0) @@ -437,7 +527,9 @@ COFFObjectFile::COFFObjectFile(MemoryBuffer *Object, error_code &ec) , SectionTable(0) , SymbolTable(0) , StringTable(0) - , StringTableSize(0) { + , StringTableSize(0) + , ImportDirectory(0) + , NumberOfImportDirectory(0) { // Check that we at least have enough room for a header. if (!checkSize(Data, ec, sizeof(coff_file_header))) return; @@ -488,45 +580,28 @@ COFFObjectFile::COFFObjectFile(MemoryBuffer *Object, error_code &ec) COFFHeader->NumberOfSections * sizeof(coff_section)))) return; - if (COFFHeader->PointerToSymbolTable != 0) { - if ((ec = getObject(SymbolTable, Data, - base() + COFFHeader->PointerToSymbolTable, - COFFHeader->NumberOfSymbols * sizeof(coff_symbol)))) + // Initialize the pointer to the symbol table. + if (COFFHeader->PointerToSymbolTable != 0) + if ((ec = initSymbolTablePtr())) return; - // Find string table. The first four byte of the string table contains the - // total size of the string table, including the size field itself. If the - // string table is empty, the value of the first four byte would be 4. - const uint8_t *StringTableAddr = base() + COFFHeader->PointerToSymbolTable - + COFFHeader->NumberOfSymbols * sizeof(coff_symbol); - const ulittle32_t *StringTableSizePtr; - if ((ec = getObject(StringTableSizePtr, Data, StringTableAddr))) - return; - StringTableSize = *StringTableSizePtr; - if ((ec = getObject(StringTable, Data, StringTableAddr, StringTableSize))) - return; - - // Check that the string table is null terminated if has any in it. - if (StringTableSize < 4 - || (StringTableSize > 4 && StringTable[StringTableSize - 1] != 0)) { - ec = object_error::parse_failed; - return; - } - } + // Initialize the pointer to the beginning of the import table. + if ((ec = initImportTablePtr())) + return; ec = object_error::success; } symbol_iterator COFFObjectFile::begin_symbols() const { DataRefImpl ret; - ret.p = reinterpret_cast(SymbolTable); + ret.p = reinterpret_cast(SymbolTable); return symbol_iterator(SymbolRef(ret, this)); } symbol_iterator COFFObjectFile::end_symbols() const { // The symbol table ends where the string table begins. DataRefImpl ret; - ret.p = reinterpret_cast(StringTable); + ret.p = reinterpret_cast(StringTable); return symbol_iterator(SymbolRef(ret, this)); } @@ -555,16 +630,32 @@ StringRef COFFObjectFile::getLoadName() const { return ""; } +import_directory_iterator COFFObjectFile::getImportDirectoryBegin() const { + DataRefImpl Imp; + Imp.p = reinterpret_cast(ImportDirectory); + return import_directory_iterator(ImportDirectoryEntryRef(Imp, this)); +} + +import_directory_iterator COFFObjectFile::getImportDirectoryEnd() const { + DataRefImpl Imp; + if (ImportDirectory) { + Imp.p = reinterpret_cast( + ImportDirectory + (NumberOfImportDirectory - 1)); + } else { + Imp.p = 0; + } + return import_directory_iterator(ImportDirectoryEntryRef(Imp, this)); +} section_iterator COFFObjectFile::begin_sections() const { DataRefImpl ret; - ret.p = reinterpret_cast(SectionTable); + ret.p = reinterpret_cast(SectionTable); return section_iterator(SectionRef(ret, this)); } section_iterator COFFObjectFile::end_sections() const { DataRefImpl ret; - ret.p = reinterpret_cast(SectionTable + COFFHeader->NumberOfSections); + ret.p = reinterpret_cast(SectionTable + COFFHeader->NumberOfSections); return section_iterator(SectionRef(ret, this)); } @@ -676,7 +767,7 @@ error_code COFFObjectFile::getSymbolName(const coff_symbol *symbol, ArrayRef COFFObjectFile::getSymbolAuxData( const coff_symbol *symbol) const { const uint8_t *aux = NULL; - + if ( symbol->NumberOfAuxSymbols > 0 ) { // AUX data comes immediately after the symbol in COFF aux = reinterpret_cast(symbol + 1); @@ -777,7 +868,6 @@ const coff_relocation *COFFObjectFile::getCOFFRelocation( return toRel(It->getRawDataRefImpl()); } - #define LLVM_COFF_SWITCH_RELOC_TYPE_NAME(enum) \ case COFF::enum: res = #enum; break; @@ -858,6 +948,52 @@ error_code COFFObjectFile::getLibraryPath(DataRefImpl LibData, report_fatal_error("getLibraryPath not implemented in COFFObjectFile"); } +bool ImportDirectoryEntryRef:: +operator==(const ImportDirectoryEntryRef &Other) const { + return ImportDirectoryPimpl == Other.ImportDirectoryPimpl; +} + +static const import_directory_table_entry *toImportEntry(DataRefImpl Imp) { + return reinterpret_cast(Imp.p); +} + +error_code +ImportDirectoryEntryRef::getNext(ImportDirectoryEntryRef &Result) const { + const import_directory_table_entry *Dir = toImportEntry(ImportDirectoryPimpl); + Dir += 1; + DataRefImpl Next; + Next.p = reinterpret_cast(Dir); + Result = ImportDirectoryEntryRef(Next, OwningObject); + return object_error::success; +} + +error_code ImportDirectoryEntryRef:: +getImportTableEntry(const import_directory_table_entry *&Result) const { + Result = toImportEntry(ImportDirectoryPimpl); + return object_error::success; +} + +error_code ImportDirectoryEntryRef::getName(StringRef &Result) const { + const import_directory_table_entry *Dir = toImportEntry(ImportDirectoryPimpl); + uintptr_t IntPtr = 0; + if (error_code ec = OwningObject->getRvaPtr(Dir->NameRVA, IntPtr)) + return ec; + const char *Ptr = reinterpret_cast(IntPtr); + Result = StringRef(Ptr); + return object_error::success; +} + +error_code ImportDirectoryEntryRef::getImportLookupEntry( + const COFF::ImportLookupTableEntry32 *&Result) const { + const import_directory_table_entry *Dir = toImportEntry(ImportDirectoryPimpl); + uintptr_t IntPtr = 0; + if (error_code ec = OwningObject->getRvaPtr( + Dir->ImportLookupTableRVA, IntPtr)) + return ec; + Result = reinterpret_cast(IntPtr); + return object_error::success; +} + namespace llvm { ObjectFile *ObjectFile::createCOFFObjectFile(MemoryBuffer *Object) { diff --git a/test/tools/llvm-objdump/Inputs/nop.exe.coff-i386 b/test/tools/llvm-objdump/Inputs/nop.exe.coff-i386 new file mode 100644 index 0000000000000000000000000000000000000000..68c9d3db0f8f93f1b9c3772d059e4b483d49ab53 GIT binary patch literal 7680 zcmeHM&ui0g6o1*=MC(RzpdbTNP?#PBq_$DcoDqV zgB}$X^dAr@o`$=4*zn|C@FIF2-s*e#rn5*Y2xG(X9=zY5@5?tILJzOk?>vTa0N97x z?*sJElW2+kyZMOi>ErLG;q8HqLQg7h6mB=2P;LkQN?^LOWqO_;$#q)}I-cx!a`9$G zcKwE}Oidj;k&ZsKw(!AyX>@;UrQ5>1`}s%LL%+H7Jjpkgo+aLJtR`XqyqR7CC`%LY z_43bKgWeYylX6lH;4oGWrPVxoQk8N|#A5)Hl%fngv@s!4P{u*Kp8)9`9Zvj~qauI~ zFejpHTTAgO!1-)MW_20o;*pV}M0Oluw~$9eO7EK98>2*IfSM9C%*X_Ig72CPB+QYd zy=62cL=iAprH=v&S%T$N#Sy^Q5+d-9Ky#0w4v9v%z;5{#z$2>HPzg7SIwTsv)uEKb z9b}+)8XxuwG!0&m(Z5Y#zE09VxvXmr+}U#@LI~obN%9{E6(DZ z*qB-SKC`eNX<58bweGFlb-ZfRckOD>aXQs{7%J^X9e2ts%)st5Fh{%lRGwl?|2JgG z!x8l?EY@b9DCF4e^JbzYcv|6K{!1ZlmATNH`C)J!ft8U9g9`YYC F@C*71LD>KR literal 0 HcmV?d00001 diff --git a/test/tools/llvm-objdump/Inputs/trivial.obj.elf-i386 b/test/tools/llvm-objdump/Inputs/trivial.obj.elf-i386 new file mode 100644 index 0000000000000000000000000000000000000000..fdc48743a886c7f99cd2352c589663a5dd1dfe79 GIT binary patch literal 449 zcmb<-^>JflWMpQ50!9XA21XbMNM}IVCSY2Fft`VcVIfRjuOzjigh4N%T}SradMB9WLq>(Rry*@Z}gNMuboYDkPE`c&XU zc=pPHClLRg8DMSF?Qhyn+nt7QlCtHC>u*7nB`uApJ&FvoIfs74&Wu%Z?i!=ekNi!b z1^j|$P>aQaHpyu=2LJOM_)n4Jo4hTP=Z@#LJBjLrR=#M}Z`{d``&qkn$1{66bzkR; zC6O{OFtf$d7@}#Wl$Ir#cXID&9wx{-qzY;(IWTs|Skse4E=jo}S4oNAeX49Do`OoM z;+s@dU(*pNp?vtzs#Xciy30-o*FIK6vDo=XZ|<4W`^#22V;i53!gP8RkM#g`{>mV(#EbF;9AsPo(p z6yPK9e){IB4o9@74C1%jgetImportDirectoryBegin(), + e = Obj->getImportDirectoryEnd(); + i != e; i = i.increment(ec)) { + if (ec) + return; + + const import_directory_table_entry *Dir; + StringRef Name; + if (i->getImportTableEntry(Dir)) return; + if (i->getName(Name)) return; + + outs() << format(" lookup %08x", Dir->ImportLookupTableRVA); + outs() << format(" time %08x", Dir->TimeDateStamp); + outs() << format(" fwd %08x", Dir->ForwarderChain); + outs() << format(" name %08x", Dir->NameRVA); + outs() << format(" addr %08x\n\n", Dir->ImportAddressTableRVA); + + outs() << " DLL Name: " << Name << "\n"; + outs() << " Hint/Ord Name\n"; + const COFF::ImportLookupTableEntry32 *entry; + if (i->getImportLookupEntry(entry)) + return; + for (; entry->data; ++entry) { + if (entry->isOrdinal()) { + outs() << format(" % 6d\n", entry->getOrdinal()); + continue; + } + uint16_t Hint; + StringRef Name; + if (Obj->getHintName(entry->getHintNameRVA(), Hint, Name)) + return; + outs() << format(" % 6d %s\n", Hint, Name); + } + outs() << "\n"; + } +} + void llvm::printCOFFUnwindInfo(const COFFObjectFile *Obj) { const coff_file_header *Header; if (error(Obj->getCOFFHeader(Header))) return; @@ -353,3 +395,7 @@ void llvm::printCOFFUnwindInfo(const COFFObjectFile *Obj) { } } } + +void llvm::printCOFFFileHeader(const object::ObjectFile *Obj) { + printImportTables(dyn_cast(Obj)); +} diff --git a/tools/llvm-objdump/llvm-objdump.cpp b/tools/llvm-objdump/llvm-objdump.cpp index 8065787945f..9bc092e1881 100644 --- a/tools/llvm-objdump/llvm-objdump.cpp +++ b/tools/llvm-objdump/llvm-objdump.cpp @@ -770,6 +770,14 @@ static void PrintUnwindInfo(const ObjectFile *o) { } } +static void printPrivateFileHeader(const ObjectFile *o) { + if (o->isELF()) { + printELFFileHeader(o); + } else if (o->isCOFF()) { + printCOFFFileHeader(o); + } +} + static void DumpObject(const ObjectFile *o) { outs() << '\n'; outs() << o->getFileName() @@ -787,8 +795,8 @@ static void DumpObject(const ObjectFile *o) { PrintSymbolTable(o); if (UnwindInfo) PrintUnwindInfo(o); - if (PrivateHeaders && o->isELF()) - printELFFileHeader(o); + if (PrivateHeaders) + printPrivateFileHeader(o); } /// @brief Dump each object file in \a a; diff --git a/tools/llvm-objdump/llvm-objdump.h b/tools/llvm-objdump/llvm-objdump.h index 87f19ba257b..b716a264c85 100644 --- a/tools/llvm-objdump/llvm-objdump.h +++ b/tools/llvm-objdump/llvm-objdump.h @@ -34,7 +34,8 @@ void DumpBytes(StringRef bytes); void DisassembleInputMachO(StringRef Filename); void printCOFFUnwindInfo(const object::COFFObjectFile* o); void printELFFileHeader(const object::ObjectFile *o); +void printCOFFFileHeader(const object::ObjectFile *o); -} +} // end namespace llvm #endif