llvm-objcopy: Add support for -g as an alias for --strip-debug

[dyung]

Summary

This change adds an option -g to llvm-objcopy which is an alias for the existing option --strip-debug.

I also modified the existing tests which use the --strip-debug option to exercise the -g option as well.

This fixes PR40003.

[alexander-shaposhnikov]

llvm/test/tools/llvm-objcopy/ELF/symtab-link.test

4

what is this second run for ? appears to be exactly the same as the line 2

[dyung]

llvm/test/tools/llvm-objcopy/ELF/symtab-link.test

4

Whoops, I don't know why I added those, it was unnecessary. I'll remove them. Thanks for catching that.

[dyung]

Removed extra test lines that were not needed.

[alexander-shaposhnikov]

test/tools/llvm-objcopy/COFF/only-section.test

13 ↗

(On Diff #183475)

i don't have a strong opinion regarding this, but generally when the output is expected to be exactly the same i wouldn't do text matching twice (it all contributes to the time it takes to run all the tests), i'd simply run cmp %t.combination.exe %t.combination_g.exe - it's much cheaper.

p.s. maybe there are other similar places, pls, have a look.

[rupprecht]

Code lgtm, just have nits on the testing. Thanks!

test/tools/llvm-objcopy/ELF/help-message.test

14 ↗

(On Diff #183475)

Not related to this patch really, but --strip-debug isn't needed for this test case -- the same error message should be printed with just llvm-strip (no args)

test/tools/llvm-objcopy/ELF/strip-debug.test

10 ↗

(On Diff #183475)

This test -- running cmp against -g and --strip-debug output -- is really all that's needed. Duplication in all the other tests is not providing any more coverage. I think it's safe to revert all the other test files and all other modifications in this file.

[dyung]

test/tools/llvm-objcopy/ELF/strip-debug.test

10 ↗

(On Diff #183475)

I agree. I'll remove the rest of the changes and update the diff.

[alexander-shaposhnikov]

I agree with Jordan regarding tests, otherwise this change looks good to me.

[dyung]

Remove redundant testing and leave in one check that -g and --strip-debug produce identical output.

llvm/test/tools/llvm-objcopy/COFF/only-section.test

 RUN: yaml2obj %p/Inputs/only-keep-sections.yaml > %t.in.exe
 
 RUN: llvm-objcopy --only-section .debug_discardable %t.in.exe %t.out.exe
 RUN: llvm-objdump --section-headers -t %t.out.exe | FileCheck %s --check-prefixes=SECTIONS,SECTIONS-DEBUG,SYMBOLS,SYMBOLS-DEBUG
 
 Adding another section stripping option makes it return the intersection of
 kept sections - in this case keeping only .text.
 
 RUN: llvm-objcopy --only-section .debug_discardable --only-section .text --strip-debug %t.in.exe %t.combination.exe
 RUN: llvm-objdump --section-headers -t %t.combination.exe | FileCheck %s --check-prefixes=SECTIONS,SECTIONS-TEXT,SYMBOLS,SYMBOLS-TEXT
 
+RUN: llvm-objcopy --only-section .debug_discardable --only-section .text -g %t.in.exe %t.combination_g.exe
+RUN: llvm-objdump --section-headers -t %t.combination_g.exe | FileCheck %s --check-prefixes=SECTIONS,SECTIONS-TEXT,SYMBOLS,SYMBOLS-TEXT
+
 SECTIONS:            Sections:
 SECTIONS-NEXT:       Idx Name
 SECTIONS-DEBUG-NEXT: .debug_discardable
 SECTIONS-TEXT-NEXT:  .text
 SECTIONS-EMPTY:
 
 SYMBOLS:            SYMBOL TABLE:
 SYMBOLS-DEBUG-NEXT: debug_discardable_sym
 SYMBOLS-TEXT-NEXT:  main
 SYMBOLS-EMPTY:

llvm/test/tools/llvm-objcopy/COFF/strip-debug.test

 # RUN: yaml2obj %s > %t.in.o
 #
 # RUN: llvm-objdump --section-headers %t.in.o | FileCheck %s --check-prefixes=SECTIONS,SECTIONS-PRE
 # RUN: llvm-objdump -t %t.in.o | FileCheck %s --check-prefixes=SYMBOLS,SYMBOLS-PRE
 #
 # RUN: llvm-objcopy --strip-debug %t.in.o %t.out.o
 # RUN: llvm-objdump --section-headers %t.out.o | FileCheck %s --check-prefixes=SECTIONS
 # RUN: llvm-objdump -t %t.out.o | FileCheck %s --check-prefixes=SYMBOLS
 #
+# RUN: llvm-objcopy -g %t.in.o %t.out_g.o
+# RUN: llvm-objdump --section-headers %t.out_g.o | FileCheck %s --check-prefixes=SECTIONS
+# RUN: llvm-objdump -t %t.out_g.o | FileCheck %s --check-prefixes=SYMBOLS
+#
 # Test that --strip-all, --strip-all-gnu, --discard-all and --strip-unneeded,
 # plus llvm-strip without arguments all produce a similiar set of sections
 # (while they remove symbols differently).
 #
 # RUN: llvm-objcopy --strip-all %t.in.o %t.strip-all.o
 # RUN: llvm-objdump --section-headers %t.strip-all.o | FileCheck %s --check-prefixes=SECTIONS
 #
 # RUN: llvm-objcopy --strip-all-gnu %t.in.o %t.strip-all-gnu.o

llvm/test/tools/llvm-objcopy/ELF/help-message.test

 # RUN: llvm-objcopy -help | FileCheck --check-prefix=OBJCOPY-USAGE %s
 # RUN: llvm-objcopy --help | FileCheck --check-prefix=OBJCOPY-USAGE %s
 # RUN: not llvm-objcopy 2>&1 | FileCheck --check-prefix=OBJCOPY-USAGE %s
 # RUN: not llvm-objcopy -abcabc 2>&1 | FileCheck --check-prefix=UNKNOWN-ARG %s
 # RUN: not llvm-objcopy --abcabc 2>&1 | FileCheck --check-prefix=UNKNOWN-ARG %s
 # RUN: not llvm-objcopy --strip-debug 2>&1 | FileCheck %s --check-prefix=NO-INPUT-FILES
+# RUN: not llvm-objcopy -g 2>&1 | FileCheck %s --check-prefix=NO-INPUT-FILES
 
 # RUN: llvm-strip -help | FileCheck --check-prefix=STRIP-USAGE %s
 # RUN: llvm-strip --help | FileCheck --check-prefix=STRIP-USAGE %s
 # RUN: not llvm-strip 2>&1 | FileCheck --check-prefix=STRIP-USAGE %s
 # RUN: not llvm-strip -abcabc 2>&1 | FileCheck --check-prefix=UNKNOWN-ARG %s
 # RUN: not llvm-strip --abcabc 2>&1 | FileCheck --check-prefix=UNKNOWN-ARG %s
 # RUN: not llvm-strip --strip-debug 2>&1 | FileCheck %s --check-prefix=NO-INPUT-FILES
 
 
 # OBJCOPY-USAGE:  USAGE: llvm-objcopy
 # STRIP-USAGE:    USAGE: llvm-strip
 # UNKNOWN-ARG:    unknown argument '{{-+}}abcabc'
 # NO-INPUT-FILES: No input file specified

llvm/test/tools/llvm-objcopy/ELF/strip-debug-and-remove.test

 # RUN: yaml2obj %s > %t
 # RUN: cp %t %t1
 
 # RUN: llvm-strip --strip-debug --remove-section=.text.bar %t
 # RUN: llvm-readobj --file-headers --sections --symbols %t | FileCheck %s
 
 # RUN: llvm-objcopy --strip-debug --remove-section=.text.bar %t1 %t1
 # RUN: cmp %t %t1
+# RUN: llvm-objcopy -g --remove-section=.text.bar %t %t2
+# RUN: cmp %t %t2
 
 !ELF
 FileHeader:
   Class:           ELFCLASS64
   Data:            ELFDATA2LSB
   Type:            ET_REL
   Machine:         EM_X86_64
 Sections:

llvm/test/tools/llvm-objcopy/ELF/strip-debug.test

 # RUN: yaml2obj %s > %t
 # RUN: cp %t %t3
 # RUN: llvm-objcopy --strip-debug %t %t2
 # RUN: llvm-readobj --file-headers --sections --symbols %t2 | FileCheck %s
 
 # Verify that the previous run of llvm-objcopy has not modified the input.
 # RUN: cmp %t %t3
 
+# RUN: llvm-objcopy -g %t %t2g
+# Verify that --strip-debug and -g produce the same output
+# RUN: cmp %t2 %t2g
+
 # RUN: llvm-strip --strip-debug %t3
 # RUN: cmp %t2 %t3
 
 # RUN: cp %t %t4
 # RUN: llvm-strip -d %t4
 # RUN: cmp %t2 %t4
 
 # RUN: cp %t %t5
 # RUN: llvm-strip -g %t5
 # RUN: cmp %t2 %t5
 
 # RUN: cp %t %t6
 # RUN: llvm-strip -S %t6
 # RUN: cmp %t2 %t6
 
 # RUN: rm -f %t.a
 # RUN: llvm-ar crs %t.a %t
+# RUN: llvm-objcopy --strip-debug %t.a %t2.a
+# RUN: llvm-objcopy -g %t.a %t3.a
+# Verify that --strip-debug and -g produce the same output
+# RUN: cmp %t2.a %t3.a
+
 # RUN: llvm-objcopy --strip-debug %t.a %t.a
 # RUN: llvm-ar p %t.a > %t7
 # RUN: cmp %t2 %t7
 
 # Verify that an archive with multiple object files is handled correctly.
 # RUN: cp %t %t.duplicate
 # RUN: cp %t2 %t.duplicate.stripped
 # RUN: rm -f %t.multiple-stripped-obj.a
 # RUN: llvm-ar crs %t.multiple-stripped-obj.a %t2 %t.duplicate.stripped
 # RUN: rm -f %t.multiple-obj.a
 # RUN: llvm-ar crs %t.multiple-obj.a %t %t.duplicate
+# RUN: llvm-objcopy --strip-debug %t.multiple-obj.a %t2.multiple-obj.stripped.a
+# RUN: llvm-objcopy -g %t.multiple-obj.a %t3.multiple-obj.stripped.a
+# Verify that --strip-debug and -g produce the same output
+# RUN: cmp %t2.multiple-obj.stripped.a %t3.multiple-obj.stripped.a
+
 # RUN: llvm-objcopy --strip-debug %t.multiple-obj.a %t.multiple-obj.stripped.a
 # RUN: llvm-ar p %t.multiple-stripped-obj.a > %t.multiple-stripped-obj.a.dump
 # RUN: llvm-ar p %t.multiple-obj.stripped.a > %t.multiple-obj.stripped.a.dump
 # RUN: cmp %t.multiple-stripped-obj.a.dump %t.multiple-obj.stripped.a.dump
 
 # We can not use %t inside the patterns passed to FileCheck,
 # thus we have to use "recognizable" file names.
 # RUN: cp %t %t1.o
 # RUN: cp %s %t2.txt
 # RUN: cp %t %t3.o
 # RUN: rm -f %t.non-object.a
 # RUN: llvm-ar cr %t.non-object.a %t1.o %t2.txt %t3.o
 # RUN: llvm-ar t %t.non-object.a | FileCheck %s --check-prefix=NON-OBJECT-ARCHIVE-MEMBERS
 
 # NON-OBJECT-ARCHIVE-MEMBERS: 1.o
 # NON-OBJECT-ARCHIVE-MEMBERS-NEXT: 2.txt
 # NON-OBJECT-ARCHIVE-MEMBERS-NEXT: 3.o
 
 # RUN: cp %t.non-object.a %t.non-object.copy.a
 # RUN: not llvm-objcopy --strip-debug %t.non-object.a %t2.non-object.a 2>&1 | FileCheck %s --check-prefix=BAD-FORMAT
+# RUN: not llvm-objcopy -g %t.non-object.a %t3.non-object.a 2>&1 | FileCheck %s --check-prefix=BAD-FORMAT
 
 # BAD-FORMAT: The file was not recognized as a valid object file
 
 # Verify that %t.non-object.a has not been modified.
 # RUN: cmp %t.non-object.a %t.non-object.copy.a
 
 # RUN: rm -f %t.thin.a
 # Copy %t to %t.thin.archive.member to avoid changing %t directly.
 # RUN: cp %t %t.thin.archive.member
 # RUN: llvm-ar crsT %t.thin.a %t.thin.archive.member
+# RUN: llvm-objcopy --strip-debug %t.thin.a %t3.thin.a
+# RUN: llvm-objcopy -g %t.thin.a %t4.thin.a
+# Verify that --strip-debug and -g produce the same output
+# RUN: cmp %t3.thin.a %t4.thin.a
+
 # RUN: llvm-objcopy --strip-debug %t.thin.a %t2.thin.a
 # RUN: cat %t.thin.a | FileCheck %s --check-prefix=VERIFY-THIN-ARCHIVE
 # RUN: cat %t2.thin.a | FileCheck %s --check-prefix=VERIFY-THIN-ARCHIVE
 
 # VERIFY-THIN-ARCHIVE: !<thin>
 
 # Verify that the member of a thin archive was properly modified.
 # RUN: cmp %t2 %t.thin.archive.member
 
 # RUN: rm -f %t.non-object.thin.a
 # RUN: llvm-ar crsT %t.non-object.thin.a %t1.o %t2.txt %t3.o
 # RUN: cp %t.non-object.thin.a %t.non-object.thin.copy.a
 # RUN: not llvm-objcopy --strip-debug %t.non-object.thin.a %t.non-object.thin.a 2>&1 | FileCheck %s --check-prefix=BAD-FORMAT
 
 # Verify that in the case of error thin archive and its memebers are not getting modified.
 # RUN: cmp %t.non-object.thin.a %t.non-object.thin.copy.a
 # RUN: cmp %t %t1.o
 # RUN: cmp %s %t2.txt
 # RUN: cmp %t %t3.o
 
+# RUN: not llvm-objcopy --strip-debug %t.non-object.thin.a %t.non-object.thin.a 2>&1 | FileCheck %s --check-prefix=BAD-FORMAT
+# RUN: not llvm-objcopy -g %t.non-object.thin.a %t.non-object.thin.a 2>&1 | FileCheck %s --check-prefix=BAD-FORMAT
+
 !ELF
 FileHeader:
   Class:           ELFCLASS64
   Data:            ELFDATA2LSB
   Type:            ET_REL
   Machine:         EM_X86_64
 Sections:
   - Name:            .debugfoo

llvm/test/tools/llvm-objcopy/ELF/symtab-link.test

 # RUN: yaml2obj %s > %t
 # RUN: llvm-objcopy %t %t2
 # RUN: llvm-readobj --sections %t2 | FileCheck %s
+# RUN: llvm-objcopy %t %t2g
+# RUN: llvm-readobj --sections %t2g | FileCheck %s
 # RUN: cp %t %t3
 # RUN: llvm-strip --strip-debug %t3
 # RUN: llvm-readobj --sections %t3 | FileCheck %s
 
 !ELF
 FileHeader:
   Class:           ELFCLASS64
   Data:            ELFDATA2LSB

llvm/tools/llvm-objcopy/ObjcopyOpts.td

def strip_all
     : Flag<["-", "--"], "strip-all">,
       HelpText<
           "Remove non-allocated sections other than .gnu.warning* sections">;
 def S : Flag<["-"], "S">, Alias<strip_all>;
 def strip_all_gnu : Flag<["-", "--"], "strip-all-gnu">,
                     HelpText<"Compatible with GNU objcopy's --strip-all">;
 def strip_debug : Flag<["-", "--"], "strip-debug">,
                   HelpText<"Remove all debug information">;
+def g : Flag<["-"], "g">, Alias<strip_debug>,
+        HelpText<"Alias for --strip-debug">;
 def strip_dwo : Flag<["-", "--"], "strip-dwo">,
                 HelpText<"Remove all DWARF .dwo sections from file">;
 def strip_sections : Flag<["-", "--"], "strip-sections">,
                      HelpText<"Remove all section headers">;
 def strip_non_alloc : Flag<["-", "--"], "strip-non-alloc">,
                       HelpText<"Remove all non-allocated sections">;
 def strip_unneeded : Flag<["-", "--"], "strip-unneeded">,
                      HelpText<"Remove all symbols not needed by relocations">;