llvm-objdump: add --rpaths to macho support

[keith]

Summary

This prints the rpaths for the given binary

[keith]

Remove blank line

[keith]

Add --rpaths to docs

[kastiglione]

other than the clang-tidy note about the capitalization of rpath, lgtm

[keith]

Fix clang-tidy warnings

[jhenderson]

llvm/test/tools/llvm-objdump/MachO/rpaths.test

2

A quick summary comment at the start of the test describing the test purpose is usually a good idea, I think.

[keith]

Add comments to tests

[keith]

Add no --macho test

[jhenderson]

llvm/test/tools/llvm-objdump/MachO/rpaths.test

1

Nit: End comments with a '.'. Also, newer tests in the LLVM binutils tend to use '##' for comments, to help them stand out from lit and FileCheck directives.

Same applies to the other two comments below.

11

You should capture and use FileCheck to check what error message is reported here.

[keith]

Update test formatting

[MaskRay]

llvm/test/tools/llvm-objdump/MachO/rpaths.test

6

If you want to ensure there is no other string, you can use FileCheck %s --match-full-lines --strict-whitespace or add {{^}}...{{$}}

[keith]

llvm/test/tools/llvm-objdump/MachO/rpaths.test

6

In this case there's also the header, which I wasn't worried about showing up one way or the other (since I made sure below it still doesn't show up if you pass the flag to disable it)

[keith]

Rebase, add test for header

[jhenderson]

llvm/test/tools/llvm-objdump/MachO/rpaths.test

6

I think @MaskRay's point was that the current and previous patterns don't detect either of the following two cases:

Objc2.64bit.exe.macho-x86_64:
<some other rpath>
@executable_path/../Frameworks
<some other rpath>

Objc2.64bit.exe.macho-x86_64:
some nonsense @executable_path/../Frameworks garbagegarbage

By default, FileCheck looks for substrings anywhere in the output after the previous match, and succeeds if it finds them. It doesn't have to be the whole line, unless you use --match-full-lines. --strict-whitespace also ensures that the line is appropriately indented (or not) as desired, with no leading or trailing whitespace beyond what is checked-for explicitly on each CHECK line. Meanwhile, CHECK-NEXT and CHECK-EMPTY can be used to ensure the output is on the desired lines in relation to each other.

Finally, if you want to ensure there is no output anywhere other than what you check for explicitly, you could use --implicit-check-not={{.}}.

[keith]

Make test more strict

[jhenderson]

LGTM.

llvm/docs/CommandGuide/llvm-objdump.rst

 .. option:: --private-header
 
   Display only the first format specific file header.
 
 .. option:: --rebase
 
   Display rebasing information.
 
+.. option:: --rpaths
+
+  Display runtime search paths for the binary.
+
 .. option:: --universal-headers
 
   Display universal headers.
 
 .. option:: --weak-bind
 
   Display weak binding information.
 

llvm/test/tools/llvm-objdump/MachO/rpaths.test

+# Validate fetching rpaths from a binary results in the correct output
+# RUN: llvm-objdump --macho --rpaths --arch x86_64 %p/Inputs/Objc2.64bit.exe.macho-x86_64 | FileCheck %s
+# RUN: llvm-objdump --macho --rpaths %p/Inputs/Objc2.64bit.exe.macho-x86_64 | FileCheck %s
+
+# CHECK: @executable_path/../Frameworks
+
+# Validate binaries with no rpaths should print nothing
+# RUN: llvm-objdump --macho --no-leading-headers --rpaths %p/Inputs/hello.exe.macho-i386 | count 0
+
+# Validate passing --rpaths without --macho fails
+# RUN: not llvm-objdump --rpaths %p/Inputs/hello.exe.macho-i386

llvm/tools/llvm-objdump/MachODump.h

 extern bool FirstPrivateHeader;
 extern bool FunctionStarts;
 extern bool IndirectSymbols;
 extern bool InfoPlist;
 extern bool LazyBind;
 extern bool LinkOptHints;
 extern bool ObjcMetaData;
 extern bool Rebase;
+extern bool Rpaths;
 extern bool UniversalHeaders;
 extern bool WeakBind;
 
 Error getMachORelocationValueString(const object::MachOObjectFile *Obj,
                                     const object::RelocationRef &RelRef,
                                     llvm::SmallVectorImpl<char> &Result);
 
 void parseInputMachO(StringRef Filename);

llvm/tools/llvm-objdump/MachODump.cpp

 
 using namespace llvm;
 using namespace llvm::object;
 using namespace llvm::objdump;
 
 bool objdump::FirstPrivateHeader;
 bool objdump::ExportsTrie;
 bool objdump::Rebase;
+bool objdump::Rpaths;
 bool objdump::Bind;
 bool objdump::LazyBind;
 bool objdump::WeakBind;
 static bool UseDbg;
 static std::string DSYMFile;
 static bool FullLeadingAddr;
 static bool NoLeadingHeaders;
 bool objdump::UniversalHeaders;

 
 static bool ArchAll = false;
 static std::string ThumbTripleName;
 
 void objdump::parseMachOOptions(const llvm::opt::InputArgList &InputArgs) {
   FirstPrivateHeader = InputArgs.hasArg(OBJDUMP_private_header);
   ExportsTrie = InputArgs.hasArg(OBJDUMP_exports_trie);
   Rebase = InputArgs.hasArg(OBJDUMP_rebase);
+  Rpaths = InputArgs.hasArg(OBJDUMP_rpaths);
   Bind = InputArgs.hasArg(OBJDUMP_bind);
   LazyBind = InputArgs.hasArg(OBJDUMP_lazy_bind);
   WeakBind = InputArgs.hasArg(OBJDUMP_weak_bind);
   UseDbg = InputArgs.hasArg(OBJDUMP_g);
   DSYMFile = InputArgs.getLastArgValue(OBJDUMP_dsym_EQ).str();
   FullLeadingAddr = InputArgs.hasArg(OBJDUMP_full_leading_addr);
   NoLeadingHeaders = InputArgs.hasArg(OBJDUMP_no_leading_headers);
   UniversalHeaders = InputArgs.hasArg(OBJDUMP_universal_headers);
if ((JustId && Load.C.cmd == MachO::LC_ID_DYLIB) ||
         else
           outs() << "LC_??? ";
         outs() << "command " << Index++ << "\n";
       }
     }
   }
 }
 
+static void printRpaths(MachOObjectFile *O) {
+  for (const auto &Command : O->load_commands()) {
+    if (Command.C.cmd == MachO::LC_RPATH) {
+      auto Rpath = O->getRpathCommand(Command);
+      const char *P = (const char *)(Command.Ptr) + Rpath.path;
+      outs() << P << "\n";
+    }
+  }
+}
+
 typedef DenseMap<uint64_t, StringRef> SymbolAddressMap;
 
 static void CreateSymbolAddressMap(MachOObjectFile *O,
                                    SymbolAddressMap *AddrMap) {
   // Create a map of symbol addresses to symbol names.
   const StringRef FileName = O->getFileName();
   for (const SymbolRef &Symbol : O->symbols()) {
     SymbolRef::Type ST = unwrapOrError(Symbol.getType(), FileName);
static void ProcessMachO(StringRef Name, MachOObjectFile *MachOOF,
                          StringRef ArchiveMemberName = StringRef(),
                          StringRef ArchitectureName = StringRef()) {
   // If we are doing some processing here on the Mach-O file print the header
   // info.  And don't print it otherwise like in the case of printing the
   // UniversalHeaders or ArchiveHeaders.
   if (Disassemble || Relocations || PrivateHeaders || ExportsTrie || Rebase ||
       Bind || SymbolTable || LazyBind || WeakBind || IndirectSymbols ||
       DataInCode || FunctionStarts || LinkOptHints || DylibsUsed || DylibId ||
-      ObjcMetaData || (!FilterSections.empty())) {
+      Rpaths || ObjcMetaData || (!FilterSections.empty())) {
     if (!NoLeadingHeaders) {
       outs() << Name;
       if (!ArchiveMemberName.empty())
         outs() << '(' << ArchiveMemberName << ')';
       if (!ArchitectureName.empty())
         outs() << " (architecture " << ArchitectureName << ")";
       outs() << ":\n";
     }
static void ProcessMachO(StringRef Name, MachOObjectFile *MachOOF,
   if (FirstPrivateHeader)
     printMachOFileHeader(MachOOF);
   if (ObjcMetaData)
     printObjcMetaData(MachOOF, !NonVerbose);
   if (ExportsTrie)
     printExportsTrie(MachOOF);
   if (Rebase)
     printRebaseTable(MachOOF);
+  if (Rpaths)
+    printRpaths(MachOOF);
   if (Bind)
     printBindTable(MachOOF);
   if (LazyBind)
     printLazyBindTable(MachOOF);
   if (WeakBind)
     printWeakBindTable(MachOOF);
 
   if (DwarfDumpType != DIDT_Null) {

llvm/tools/llvm-objdump/ObjdumpOpts.td

HelpText<"Print the shared libraries used for linked "
            "Mach-O files (requires --macho)">,
   Group<grp_mach_o>;
 
 def dylib_id : Flag<["--"], "dylib-id">,
   HelpText<"Print the shared library's id for the "
            "dylib Mach-O file (requires --macho)">,
   Group<grp_mach_o>;
 
+def rpaths : Flag<["--"], "rpaths">,
+  HelpText<"Print the runtime search paths for the "
+           "Mach-O file (requires --macho)">,
+  Group<grp_mach_o>;
+
 def non_verbose : Flag<["--"], "non-verbose">,
   HelpText<"Print the info for Mach-O objects in non-verbose or "
            "numeric form (requires --macho)">,
   Group<grp_mach_o>;
 
 def objc_meta_data : Flag<["--"], "objc-meta-data">,
   HelpText<"Print the Objective-C runtime meta data "
            "for Mach-O files (requires --macho)">,

llvm/tools/llvm-objdump/llvm-objdump.cpp

int main(int argc, char **argv) {
 
   if (!ArchiveHeaders && !Disassemble && DwarfDumpType == DIDT_Null &&
       !DynamicRelocations && !FileHeaders && !PrivateHeaders && !RawClangAST &&
       !Relocations && !SectionHeaders && !SectionContents && !SymbolTable &&
       !DynamicSymbolTable && !UnwindInfo && !FaultMapSection &&
       !(MachOOpt &&
         (Bind || DataInCode || DylibId || DylibsUsed || ExportsTrie ||
          FirstPrivateHeader || FunctionStarts || IndirectSymbols || InfoPlist ||
-         LazyBind || LinkOptHints || ObjcMetaData || Rebase ||
+         LazyBind || LinkOptHints || ObjcMetaData || Rebase || Rpaths ||
          UniversalHeaders || WeakBind || !FilterSections.empty()))) {
     T.PrintObjdumpHelp(ToolName);
     return 2;
   }
 
   DisasmSymbolSet.insert(DisassembleSymbols.begin(), DisassembleSymbols.end());
 
   llvm::for_each(InputFilenames, dumpInput);
 
   warnOnNoMatchForSections();
 
   return EXIT_SUCCESS;
 }