Extend llvm-objdump to support clang offload fat bins

  add option --offload-fatbin

Change-Id: Ibc865f80e30aa1a6e5495ecfe617be68a5e15fcf

Author: dsalinas

llvm/lib/Object/ObjectFile.cpp

@@ -212,7 +212,6 @@ ObjectFile::createObjectFile(StringRef ObjectPath) {
   if (std::error_code EC = FileOrErr.getError())
     return errorCodeToError(EC);
   std::unique_ptr<MemoryBuffer> Buffer = std::move(FileOrErr.get());
-
   Expected<std::unique_ptr<ObjectFile>> ObjOrErr =
       createObjectFile(Buffer->getMemBufferRef());
   if (Error Err = ObjOrErr.takeError())

llvm/test/tools/llvm-objdump/Offloading/fatbin.test

@@ -108,6 +108,9 @@ def fault_map_section : Flag<["--"], "fault-map-section">,
 def offloading : Flag<["--"], "offloading">,
   HelpText<"Display the content of the offloading section">;
 
+def offload_fatbin : Flag<["--"], "offload-fatbin">,
+  HelpText<"Display the content of the offload FatBin section">;
+
 def file_headers : Flag<["--"], "file-headers">,
   HelpText<"Display the contents of the overall file header">;
 def : Flag<["-"], "f">, Alias<file_headers>,

llvm/tools/llvm-objdump/ObjdumpOpts.td

@@ -14,12 +14,15 @@
 #include "OffloadDump.h"
 #include "llvm-objdump.h"
 #include "llvm/Object/ELFObjectFile.h"
+#include "llvm/Object/OffloadBinary.h"
 #include "llvm/Support/Alignment.h"
 
 using namespace llvm;
 using namespace llvm::object;
 using namespace llvm::objdump;
 
+void disassembleObject(llvm::object::ObjectFile *, bool InlineRelocs);
+
 /// Get the printable name of the image kind.
 static StringRef getImageName(const OffloadBinary &OB) {
   switch (OB.getImageKind()) {
@@ -66,6 +69,55 @@ void llvm::dumpOffloadBinary(const ObjectFile &O) {
     printBinary(*Binaries[I].getBinary(), I);
 }
 
+// Given an Object file, collect all Bundles of FatBin Binaries
+// and dump them into Code Object files
+// if -d is specified, disassemble the Code Object Files
+// if -arch=-name is specified, only dump the Entries that match the target arch
+void llvm::dumpOffloadBundleFatBinary(const ObjectFile &O, std::string ArchName,
+                                      bool Disassemble) {
+  assert((O.isELF() || O.isCOFF()) && "Invalid file type");
+  // Collect all Bundles and their Entries ....
+  SmallVector<llvm::object::OffloadBundleFatBin> FoundBundles;
+  SmallVector<OffloadBundleEntry> FoundEntries;
+
+  if (Error Err = llvm::object::extractOffloadBundleFatBinary(O, FoundBundles))
+    reportError(O.getFileName(), "while extracting offload FatBin bundles: " +
+                                     toString(std::move(Err)));
+
+  // Now filter based on if arch-name is specified
+  SmallVectorImpl<llvm::object::OffloadBundleFatBin>::iterator BundleIter =
+      FoundBundles.begin();
+  for (uint64_t bundle_num = 0; bundle_num < FoundBundles.size();
+       bundle_num++) {
+    if (!ArchName.empty())
+      FoundEntries = BundleIter->EntryIDContains(StringRef(ArchName));
+    else
+      FoundEntries = BundleIter->getEntries();
+
+    // now we have a list of Found Entries .... dump them
+    SmallVectorImpl<OffloadBundleEntry>::iterator FoundIter =
+        FoundEntries.begin();
+    for (int64_t entry_num = 0; entry_num < FoundEntries.size(); entry_num++) {
+      // create file name for this object file:  <source-filename>:<Bundle
+      // Number>.<EntryID>
+      std::string str = BundleIter->getFileName().str() + ":" +
+                        itostr(bundle_num) + "." + FoundIter->ID.str();
+      StringRef OutputFilename = StringRef(str);
+      if (Error Err = object::extractCodeObject(
+              O, FoundIter->Offset, FoundIter->Size, OutputFilename))
+        reportError(O.getFileName(),
+                    "while extracting offload Bundle Entries: " +
+                        toString(std::move(Err)));
+
+      // TODO: If -d was specified, disasseble the Code Object too
+
+      ++FoundIter;
+    } // end of for found_entries loop
+
+    ++BundleIter;
+  } // end of for Bundles loop
+}
+
 /// Print the contents of an offload binary file \p OB. This may contain
 /// multiple binaries stored in the same buffer.
 void llvm::dumpOffloadSections(const OffloadBinary &OB) {

llvm/tools/llvm-objdump/OffloadDump.cpp

@@ -17,6 +17,9 @@ namespace llvm {
 void dumpOffloadSections(const object::OffloadBinary &OB);
 void dumpOffloadBinary(const object::ObjectFile &O);
 
+/// Dump fat binary in binary clang-offload-bundler format
+void dumpOffloadBundleFatBinary(const object::ObjectFile &O,
+                                std::string ArchName, bool Disassemble);
 } // namespace llvm
 
 #endif

llvm/tools/llvm-objdump/OffloadDump.h

@@ -324,6 +324,7 @@ std::vector<std::string> objdump::MAttrs;
 bool objdump::ShowRawInsn;
 bool objdump::LeadingAddr;
 static bool Offloading;
+static bool OffloadFatBin;
 static bool RawClangAST;
 bool objdump::Relocations;
 bool objdump::PrintImmHex;
@@ -3315,6 +3316,8 @@ static void dumpObject(ObjectFile *O, const Archive *A = nullptr,
     D.printDynamicRelocations();
   if (SectionContents)
     printSectionContents(O);
+  if (OffloadFatBin)
+    dumpOffloadBundleFatBinary(*O, ArchName, Disassemble);
   if (Disassemble)
     disassembleObject(O, Relocations);
   if (UnwindInfo)
@@ -3521,6 +3524,7 @@ static void parseObjdumpOptions(const llvm::opt::InputArgList &InputArgs) {
   DynamicRelocations = InputArgs.hasArg(OBJDUMP_dynamic_reloc);
   FaultMapSection = InputArgs.hasArg(OBJDUMP_fault_map_section);
   Offloading = InputArgs.hasArg(OBJDUMP_offloading);
+  OffloadFatBin = InputArgs.hasArg(OBJDUMP_offload_fatbin);
   FileHeaders = InputArgs.hasArg(OBJDUMP_file_headers);
   SectionContents = InputArgs.hasArg(OBJDUMP_full_contents);
   PrintLines = InputArgs.hasArg(OBJDUMP_line_numbers);
@@ -3732,6 +3736,7 @@ int llvm_objdump_main(int argc, char **argv, const llvm::ToolContext &) {
       !DynamicRelocations && !FileHeaders && !PrivateHeaders && !RawClangAST &&
       !Relocations && !SectionHeaders && !SectionContents && !SymbolTable &&
       !DynamicSymbolTable && !UnwindInfo && !FaultMapSection && !Offloading &&
+      !OffloadFatBin &&
       !(MachOOpt &&
         (Bind || DataInCode || ChainedFixups || DyldInfo || DylibId ||
          DylibsUsed || ExportsTrie || FirstPrivateHeader ||