Add --dump-offload-bundle option to llvm-objcopy

llvm/docs/CommandGuide/llvm-objcopy.rst

@@ -62,6 +62,11 @@ multiple file formats.
  example, file and section symbols in ELF objects will not be discarded.
  Additionally, remove all debug sections.
 
+.. option:: --dump-offload-bundle=<URI>
+
+ Dump the HIP Offload Bundle entry specified by the URI syntax given, into a 
+ code object file.
+
 .. option:: --dump-section <section>=<file>
 
  Dump the contents of section ``<section>`` into the file ``<file>``. Can be

llvm/include/llvm/ObjCopy/CommonConfig.h

@@ -277,6 +277,8 @@ struct CommonConfig {
   bool StripUnneeded = false;
   bool Weaken = false;
   bool DecompressDebugSections = false;
+  bool DumpOffloadBundle = false;
+  bool NeedPositional = true;
 
   DebugCompressionType CompressionType = DebugCompressionType::None;
 

llvm/include/llvm/Object/OffloadBundle.h

@@ -132,6 +132,8 @@ struct OffloadBundleURI {
     switch (Type) {
     case FILE_URI:
       return createFileURI(Str);
+  //    if (Expected<std::unique_ptr<OffloadBundleURI>> URIOrErr = createFileURI(Str))
+//	      return URIOrErr.takeError();
       break;
     case MEMORY_URI:
       return createMemoryURI(Str);
@@ -161,7 +163,7 @@ struct OffloadBundleURI {
     OffsetStr.getAsInteger(10, O);
     Str = Str.drop_front(OffsetStr.size());
 
-    if (Str.consume_front("&size="))
+    if (!Str.consume_front("&size="))
       return createStringError(object_error::parse_failed,
                                "Reading 'size' in URI");
 

llvm/lib/ObjCopy/ELF/ELFObjcopy.cpp

@@ -210,6 +210,27 @@ static Error dumpSectionToFile(StringRef SecName, StringRef Filename,
                          "section '%s' not found", SecName.str().c_str());
 }
 
+static Error dumpRawDataURIToFile(StringRef Filename, int64_t Offset,
+                                  int64_t Size, ObjectFile &Obj) {
+  SmallString<2048> NameBuf;
+  raw_svector_ostream OutputFileName(NameBuf);
+  OutputFileName << Obj.getFileName().str() << "-offset" << Offset << "-size"
+                 << Size << ".co";
+
+  Expected<std::unique_ptr<FileOutputBuffer>> BufferOrErr =
+      FileOutputBuffer::create(OutputFileName.str(), Size);
+
+  if (!BufferOrErr)
+    return BufferOrErr.takeError();
+
+  MemoryBufferRef Input = Obj.getMemoryBufferRef();
+  std::unique_ptr<FileOutputBuffer> Buf = std::move(*BufferOrErr);
+  std::copy(Input.getBufferStart(), Input.getBufferStart() + Size,
+            Buf->getBufferStart());
+
+  return Buf->commit();
+}
+
 Error Object::compressOrDecompressSections(const CommonConfig &Config) {
   // Build a list of sections we are going to replace.
   // We can't call `addSection` while iterating over sections,

llvm/lib/Object/OffloadBundle.cpp

@@ -229,7 +229,6 @@ Error object::extractOffloadBundleByURI(StringRef URIstr) {
       OffloadBundleURI::createOffloadBundleURI(URIstr, FILE_URI));
   if (!UriOrErr)
     return UriOrErr.takeError();
-
   OffloadBundleURI &Uri = **UriOrErr;
   std::string OutputFile = Uri.FileName.str();
   OutputFile +=

llvm/tools/llvm-objcopy/ObjcopyOptions.cpp

@@ -16,6 +16,8 @@
 #include "llvm/ObjCopy/ConfigManager.h"
 #include "llvm/ObjCopy/MachO/MachOConfig.h"
 #include "llvm/Object/Binary.h"
+#include "llvm/Object/OffloadBinary.h"
+#include "llvm/Object/OffloadBundle.h"
 #include "llvm/Option/Arg.h"
 #include "llvm/Option/ArgList.h"
 #include "llvm/Support/CRC.h"
@@ -284,6 +286,15 @@ static Expected<uint8_t> parseVisibilityType(StringRef VisType) {
   return type;
 }
 
+//static void llvm::objcopy::parseDumpOffloadBundle(StringRef URI) {
+static Expected<StringRef> llvm::objcopy::parseDumpOffloadBundle(StringRef URI) {
+  if (Error Err = object::extractOffloadBundleByURI(URI))
+    //errs() << "Failed to extract from URI.";
+    return createStringError(errc::invalid_argument,"Failed to extract from URI");
+
+   return URI;
+}
+
 namespace {
 struct TargetInfo {
   FileFormat Format;
@@ -727,34 +738,47 @@ objcopy::parseObjcopyOptions(ArrayRef<const char *> ArgsArr,
 
   SmallVector<const char *, 2> Positional;
 
+  ConfigManager ConfigMgr;
+  CommonConfig &Config = ConfigMgr.Common;
+  COFFConfig &COFFConfig = ConfigMgr.COFF;
+  ELFConfig &ELFConfig = ConfigMgr.ELF;
+  MachOConfig &MachOConfig = ConfigMgr.MachO;
+
+  if (InputArgs.hasArg(OBJCOPY_dump_offload_bundle))
+    Config.NeedPositional = false;
+
   for (auto *Arg : InputArgs.filtered(OBJCOPY_UNKNOWN))
     return createStringError(errc::invalid_argument, "unknown argument '%s'",
                              Arg->getAsString(InputArgs).c_str());
 
   for (auto *Arg : InputArgs.filtered(OBJCOPY_INPUT))
     Positional.push_back(Arg->getValue());
 
-  if (Positional.empty())
+  if (Positional.empty() && Config.NeedPositional)
     return createStringError(errc::invalid_argument, "no input file specified");
 
-  if (Positional.size() > 2)
+  if (Positional.size() > 2 && Config.NeedPositional)
     return createStringError(errc::invalid_argument,
                              "too many positional arguments");
 
-  ConfigManager ConfigMgr;
-  CommonConfig &Config = ConfigMgr.Common;
-  COFFConfig &COFFConfig = ConfigMgr.COFF;
-  ELFConfig &ELFConfig = ConfigMgr.ELF;
-  MachOConfig &MachOConfig = ConfigMgr.MachO;
-  Config.InputFilename = Positional[0];
-  Config.OutputFilename = Positional[Positional.size() == 1 ? 0 : 1];
-  if (InputArgs.hasArg(OBJCOPY_target) &&
-      (InputArgs.hasArg(OBJCOPY_input_target) ||
-       InputArgs.hasArg(OBJCOPY_output_target)))
-    return createStringError(
-        errc::invalid_argument,
-        "--target cannot be used with --input-target or --output-target");
+  if (Arg *A = InputArgs.getLastArg(OBJCOPY_dump_offload_bundle)) {
+    for (StringRef URIStr : llvm::split(A->getValue(), ",")) {
+      Expected<StringRef> res = llvm::objcopy::parseDumpOffloadBundle(URIStr);
+      if (!res)
+        return res.takeError();
+    }
+  }
 
+  if (Config.NeedPositional) {
+    Config.InputFilename = Positional[0];
+    Config.OutputFilename = Positional[Positional.size() == 1 ? 0 : 1];
+    if (InputArgs.hasArg(OBJCOPY_target) &&
+        (InputArgs.hasArg(OBJCOPY_input_target) ||
+         InputArgs.hasArg(OBJCOPY_output_target)))
+      return createStringError(
+          errc::invalid_argument,
+          "--target cannot be used with --input-target or --output-target");
+  }
   if (InputArgs.hasArg(OBJCOPY_regex) && InputArgs.hasArg(OBJCOPY_wildcard))
     return createStringError(errc::invalid_argument,
                              "--regex and --wildcard are incompatible");
@@ -1417,12 +1441,13 @@ objcopy::parseInstallNameToolOptions(ArrayRef<const char *> ArgsArr) {
                              Arg->getAsString(InputArgs).c_str());
   for (auto *Arg : InputArgs.filtered(INSTALL_NAME_TOOL_INPUT))
     Positional.push_back(Arg->getValue());
-  if (Positional.empty())
+  if (Positional.empty() && Config.NeedPositional)
     return createStringError(errc::invalid_argument, "no input file specified");
-  if (Positional.size() > 1)
+  if (Positional.size() > 1 && Config.NeedPositional)
     return createStringError(
         errc::invalid_argument,
         "llvm-install-name-tool expects a single input file");
+
   Config.InputFilename = Positional[0];
   Config.OutputFilename = Positional[0];
 
@@ -1435,7 +1460,6 @@ objcopy::parseInstallNameToolOptions(ArrayRef<const char *> ArgsArr) {
     return createStringError(errc::invalid_argument,
                              "input file: %s is not a Mach-O file",
                              Config.InputFilename.str().c_str());
-
   DC.CopyConfigs.push_back(std::move(ConfigMgr));
   return std::move(DC);
 }
@@ -1477,8 +1501,9 @@ objcopy::parseBitcodeStripOptions(ArrayRef<const char *> ArgsArr,
   for (auto *Arg : InputArgs.filtered(BITCODE_STRIP_INPUT))
     Positional.push_back(Arg->getValue());
   if (Positional.size() > 1)
-    return createStringError(errc::invalid_argument,
-                             "llvm-bitcode-strip expects a single input file");
+    return createStringError(
+        errc::invalid_argument,
+        "llvm-bitcode-strip expects a single input file");
   assert(!Positional.empty());
   Config.InputFilename = Positional[0];
 
@@ -1542,6 +1567,11 @@ objcopy::parseStripOptions(ArrayRef<const char *> RawArgsArr,
     exit(0);
   }
 
+  ConfigManager ConfigMgr;
+  CommonConfig &Config = ConfigMgr.Common;
+  ELFConfig &ELFConfig = ConfigMgr.ELF;
+  MachOConfig &MachOConfig = ConfigMgr.MachO;
+
   SmallVector<StringRef, 2> Positional;
   for (auto *Arg : InputArgs.filtered(STRIP_UNKNOWN))
     return createStringError(errc::invalid_argument, "unknown argument '%s'",
@@ -1551,17 +1581,14 @@ objcopy::parseStripOptions(ArrayRef<const char *> RawArgsArr,
   std::copy(DashDash, RawArgsArr.end(), std::back_inserter(Positional));
 
   if (Positional.empty())
-    return createStringError(errc::invalid_argument, "no input file specified");
+    return createStringError(errc::invalid_argument,
+                             "no input file specified");
 
-  if (Positional.size() > 1 && InputArgs.hasArg(STRIP_output))
+  if (Positional.size() > 1 && InputArgs.hasArg(STRIP_output)) {
     return createStringError(
         errc::invalid_argument,
         "multiple input files cannot be used in combination with -o");
-
-  ConfigManager ConfigMgr;
-  CommonConfig &Config = ConfigMgr.Common;
-  ELFConfig &ELFConfig = ConfigMgr.ELF;
-  MachOConfig &MachOConfig = ConfigMgr.MachO;
+  }
 
   if (InputArgs.hasArg(STRIP_regex) && InputArgs.hasArg(STRIP_wildcard))
     return createStringError(errc::invalid_argument,

llvm/tools/llvm-objcopy/ObjcopyOptions.h

@@ -51,6 +51,11 @@ parseBitcodeStripOptions(ArrayRef<const char *> ArgsArr,
 Expected<DriverConfig>
 parseStripOptions(ArrayRef<const char *> ArgsArr,
                   llvm::function_ref<Error(Error)> ErrorCallback);
+
+// parseDumpOffloadBundle reads a URI as a string and extracts the raw memory into a
+// code object file named from the URI string given.
+static Expected<StringRef> parseDumpOffloadBundle(StringRef URI);
+
 } // namespace objcopy
 } // namespace llvm
 

llvm/tools/llvm-objcopy/ObjcopyOpts.td

@@ -235,10 +235,13 @@ defm skip_symbols
          "be repeated to read symbols from many files">,
       MetaVarName<"filename">;
 
+defm dump_offload_bundle : Eq<"dump-offload-bundle", "Dump the contents specified by URI">;
+
 defm dump_section
     : Eq<"dump-section",
          "Dump contents of section named <section> into file <file>">,
       MetaVarName<"section=file">;
+
 defm prefix_symbols
     : Eq<"prefix-symbols", "Add <prefix> to the start of every symbol name">,
       MetaVarName<"prefix">;