[llvm-objdump --macho] Rename --dyld_info to --dyld-info

[thakis]

Summary

llvm-objdump takes foo-bar style flags, while llvm-otool takes foo_bar style
flags. dyld_info was the only exception to that.

[thakis]

update docs too

[aprantl]

I picked this option name to match the system tools on macOS, which also use this spelling (but I agree it's inconsistent).

[thakis]

Right, we have llvm-otool which matches the otool flags. None of the other objdump flags match the cctools's option spellings.

[jhenderson]

I've got nothing against this, although it probably deserves a release note, in case there are any existing users of that spelling and llvm-objdump.

[thakis]

add -dyld_info flag to llvm-otool

[thakis]

aprantl: I added -dyld_info to llvm-otool instead. Does that work for you?

jhenderson: The flag currently doesn't really do anything, it calls PrintDyldInfo which calls one more function which internally casts everything to (void). So I don't think there are any actual non-test users of this flag, and maybe we can get away without a release notes entry in this case?

[jhenderson]

In D131897#3725929, @thakis wrote:

jhenderson: The flag currently doesn't really do anything, it calls PrintDyldInfo which calls one more function which internally casts everything to (void). So I don't think there are any actual non-test users of this flag, and maybe we can get away without a release notes entry in this case?

Up to you - if you don't think it's needed, that's fine (I don't know anything about its usage or behaviour).

[aprantl]

Splitting it this way works for me (although it's still going to be confusing that we have two spellings).

[thakis]

Great, thanks!

llvm/docs/CommandGuide/llvm-objdump.rst

 .. option:: --dis-symname=<name>
 
   Disassemble just the specified symbol's instructions.
 
 .. option:: --chained-fixups
 
   Print chained fixup information.
 
-.. option:: --dyld_info
+.. option:: --dyld-info
 
   Print bind and rebase information used by dyld to resolve external
   references in a final linked binary.
 
 .. option:: --dylibs-used
 
   Display the shared libraries used for linked files.
 

llvm/docs/CommandGuide/llvm-otool.rst

 .. option:: -chained_fixups
 
  Print chained fixup information.
 
 .. option:: -C
 
  Print linker optimization hints.
 
+.. option:: -dyld_info
+
+  Print bind and rebase information.
+
 .. option:: -D
 
  Print shared library id.
 
 .. option:: -d
 
  Print data section.
 

llvm/test/Object/AArch64/chained-fixups-header.test

 REQUIRES: host-byteorder-little-endian
 RUN: cat %p/../Inputs/MachO/chained-fixups.yaml \
 RUN:   | sed 's/__LINKEDIT:      00000000/__LINKEDIT:      AB000000/' \
-RUN:   | yaml2obj | not llvm-objdump --macho --dyld_info - 2>&1 \
+RUN:   | yaml2obj | not llvm-objdump --macho --dyld-info - 2>&1 \
 RUN:   | FileCheck %s --check-prefix=HEADER1
 HEADER1: truncated or malformed object (bad chained fixups: unknown version: 171)
 
 RUN: cat %p/../Inputs/MachO/chained-fixups.yaml \
 RUN:   | sed 's/1000000010000000/1000000AB0000000/' \
-RUN:   | yaml2obj | not llvm-objdump --macho --dyld_info - 2>&1 \
+RUN:   | yaml2obj | not llvm-objdump --macho --dyld-info - 2>&1 \
 RUN:   | FileCheck %s --check-prefix=HEADER2
 HEADER2: truncated or malformed object (bad chained fixups: unknown imports format: 171)
 
 RUN: cat %p/../Inputs/MachO/chained-fixups.yaml \
 RUN:   | sed 's/20000000/01000000/' \
-RUN:   | yaml2obj | not llvm-objdump --macho --dyld_info - 2>&1 \
+RUN:   | yaml2obj | not llvm-objdump --macho --dyld-info - 2>&1 \
 RUN:   | FileCheck %s --check-prefix=HEADER3
 HEADER3: truncated or malformed object (bad chained fixups: image starts offset 1 overlaps with chained fixups header)
 
 RUN: cat %p/../Inputs/MachO/chained-fixups.yaml \
 RUN:   | sed 's/20000000/FF000000/' \
-RUN:   | yaml2obj | not llvm-objdump --macho --dyld_info - 2>&1 \
+RUN:   | yaml2obj | not llvm-objdump --macho --dyld-info - 2>&1 \
 RUN:   | FileCheck %s --check-prefix=HEADER4
 HEADER4: truncated or malformed object (bad chained fixups: image starts end 33031 extends past end 32856)

llvm/test/tools/llvm-objdump/MachO/dyld-info.test

+RUN: llvm-objdump --macho --dyld-info %p/Inputs/bind.macho-x86_64 \
+RUN:   | FileCheck %s --match-full-lines --strict-whitespace \
+RUN:     --implicit-check-not={{.}}
+RUN: llvm-otool -dyld_info %p/Inputs/bind.macho-x86_64 \
+RUN:   | FileCheck %s --match-full-lines --strict-whitespace \
+RUN:     --implicit-check-not={{.}}
+
+CHECK:{{.*}}bind.macho-x86_64:
+CHECK:dyld information:

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

-RUN: llvm-objdump --macho --dyld_info %p/Inputs/bind.macho-x86_64 \
-RUN:   | FileCheck %s --match-full-lines --strict-whitespace \
-RUN:     --implicit-check-not={{.}}
-
-CHECK:{{.*}}bind.macho-x86_64:
-CHECK:dyld information:

llvm/tools/llvm-objdump/ObjdumpOpts.td

def info_plist : Flag<["--"], "info-plist">,
   HelpText<"Print the info plist section as strings for "
            "Mach-O objects (requires --macho)">,
   Group<grp_mach_o>;
 
 def chained_fixups : Flag<["--"], "chained-fixups">,
   HelpText<"Print chained fixup information (requires --macho)">,
   Group<grp_mach_o>;
 
-def dyld_info : Flag<["--"], "dyld_info">,
+def dyld_info : Flag<["--"], "dyld-info">,
   HelpText<"Print bind and rebase information used by dyld to resolve "
            "external references in a final linked binary "
            "(requires --macho)">,
   Group<grp_mach_o>;
 
 def dylibs_used : Flag<["--"], "dylibs-used">,
   HelpText<"Print the shared libraries used for linked "
            "Mach-O files (requires --macho)">,

llvm/tools/llvm-objdump/OtoolOpts.td

def v : Flag<["-"], "v">,
   HelpText<"verbose output / disassemble when printing text sections">;
 def V : Flag<["-"], "V">,
   HelpText<"symbolize disassembled operands (implies -v)">;
 def x : Flag<["-"], "x">, HelpText<"print all text sections">;
 def X : Flag<["-"], "X">, HelpText<"omit leading addresses or headers">;
 
 def chained_fixups : Flag<["-"], "chained_fixups">,
   HelpText<"print chained fixup information">;
+def dyld_info : Flag<["-"], "dyld_info">,
+  HelpText<"print bind and rebase information">;
 
 // Not (yet?) implemented:
 // def a : Flag<["-"], "a">, HelpText<"print archive header">;
 // -c print argument strings of a core file
 // -m don't use archive(member) syntax
-// -dyld_info
 // -dyld_opcodes
 // -addr_slide=arg
 // -function_offsets
 
 // Obsolete and unsupported:
 def grp_obsolete : OptionGroup<"kind">,
   HelpText<"Obsolete and unsupported flags">;
 

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

static void parseOtoolOptions(const llvm::opt::InputArgList &InputArgs) {
   Verbose = InputArgs.hasArg(OTOOL_v) || InputArgs.hasArg(OTOOL_V) ||
             InputArgs.hasArg(OTOOL_o);
   SymbolicOperands = InputArgs.hasArg(OTOOL_V);
   if (InputArgs.hasArg(OTOOL_x))
     FilterSections.push_back(",__text");
   LeadingAddr = LeadingHeaders = !InputArgs.hasArg(OTOOL_X);
 
   ChainedFixups = InputArgs.hasArg(OTOOL_chained_fixups);
+  DyldInfo = InputArgs.hasArg(OTOOL_dyld_info);
 
   InputFilenames = InputArgs.getAllArgValues(OTOOL_INPUT);
   if (InputFilenames.empty())
     reportCmdLineError("no input file");
 
   for (const Arg *A : InputArgs) {
     const Option &O = A->getOption();
     if (O.getGroup().isValid() && O.getGroup().getID() == OTOOL_grp_obsolete) {