[llvm-objcopy] Change --only-keep to --only-sections

[jakehehrlich]

Summary

I just hard core goofed when I wrote this and created a different name for no good reason. I'm failry aware of most "fresh" users of llvm-objcopy (that is, users which are not using it as a drop in replacement for GNU objcopy) and can say that only "-j" is being used by such people so this patch should strictly increase compatibility and not remove it.

[rupprecht]

The GNU objcopy name is only-section, not only-sections (note singular vs plural)
But otherwise LGTM :)

[jakehehrlich]

Who put me in charge of this? I'm clearly unqualified.

[jhenderson]

In D52180#1237257, @jakehehrlich wrote:

Who put me in charge of this? I'm clearly unqualified.

Don't worry - I reviwed it (I think) and still missed it :/

[llvm-commits]

Alex - any update on this?

[jakehehrlich]

Rebased and used -only-section (no s at the end)

[rupprecht]

Thanks!

llvm/trunk/test/tools/llvm-objcopy/ELF/basic-only-keep.test

-# RUN: yaml2obj %s > %t
-# RUN: llvm-objcopy -only-keep=.test %t %t2
-# RUN: llvm-objcopy -j .test %t %t3
-# RUN: llvm-readobj -file-headers -sections %t2 | FileCheck %s
-# RUN: diff %t2 %t3
-
-!ELF
-FileHeader:
-  Class:           ELFCLASS64
-  Data:            ELFDATA2LSB
-  Type:            ET_REL
-  Machine:         EM_X86_64
-Sections:
-  - Name:            .test
-    Type:            SHT_PROGBITS
-    Flags:           [ ]
-
-# CHECK: SectionHeaderCount: 5
-
-# CHECK:     Name: .test
-# CHECK:     Name: .symtab
-# CHECK:     Name: .strtab
-# CHECK:     Name: .shstrtab

llvm/trunk/test/tools/llvm-objcopy/ELF/basic-only-section.test

+# RUN: yaml2obj %s > %t
+# RUN: llvm-objcopy -only-section=.test %t %t2
+# RUN: llvm-objcopy -j .test %t %t3
+# RUN: llvm-readobj -file-headers -sections %t2 | FileCheck %s
+# RUN: diff %t2 %t3
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_REL
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .test
+    Type:            SHT_PROGBITS
+    Flags:           [ ]
+
+# CHECK: SectionHeaderCount: 5
+
+# CHECK:     Name: .test
+# CHECK:     Name: .symtab
+# CHECK:     Name: .strtab
+# CHECK:     Name: .shstrtab

llvm/trunk/test/tools/llvm-objcopy/ELF/dump-section.test

 # RUN: yaml2obj %s > %t
 # RUN: llvm-objcopy -O binary -j .text %t %t2
-# RUN: llvm-objcopy -O binary -only-keep .text %t %t3
+# RUN: llvm-objcopy -O binary -only-section .text %t %t3
 # RUN: llvm-objcopy --dump-section .text=%t4 %t %t5
 # RUN: llvm-objcopy --dump-section .foo=%t6 %t %t7
 # RUN: not llvm-objcopy --dump-section .bar=%t8 %t %t9 2>&1 | FileCheck %s --check-prefix=NOBITS
 # RUN: od -t x1 %t2 | FileCheck %s
 # RUN: od -t x1 %t6 | FileCheck %s --check-prefix=NON-ALLOC
 # RUN: wc -c %t2 | FileCheck %s --check-prefix=SIZE
 # RUN: diff %t2 %t3
 # RUN: diff %t4 %t3

llvm/trunk/test/tools/llvm-objcopy/ELF/explicit-only-keep-remove.test

-# RUN: yaml2obj %s > %t
-# RUN: llvm-objcopy -R=.test -only-keep=.test %t %t2
-# RUN: llvm-readobj -file-headers -sections %t2 | FileCheck %s
-
-!ELF
-FileHeader:
-  Class:           ELFCLASS64
-  Data:            ELFDATA2LSB
-  Type:            ET_REL
-  Machine:         EM_X86_64
-Sections:
-  - Name:            .test
-    Type:            SHT_PROGBITS
-    Flags:           [ ]
-
-# CHECK: SectionHeaderCount: 5
-
-# CHECK:     Name: .test
-# CHECK:     Name: .symtab
-# CHECK:     Name: .strtab
-# CHECK:     Name: .shstrtab

llvm/trunk/test/tools/llvm-objcopy/ELF/explicit-only-section-remove.test

+# RUN: yaml2obj %s > %t
+# RUN: llvm-objcopy -R=.test -only-section=.test %t %t2
+# RUN: llvm-readobj -file-headers -sections %t2 | FileCheck %s
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_REL
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .test
+    Type:            SHT_PROGBITS
+    Flags:           [ ]
+
+# CHECK: SectionHeaderCount: 5
+
+# CHECK:     Name: .test
+# CHECK:     Name: .symtab
+# CHECK:     Name: .strtab
+# CHECK:     Name: .shstrtab

llvm/trunk/test/tools/llvm-objcopy/ELF/keep-only-keep.test

-# RUN: yaml2obj %s > %t
-# RUN: llvm-objcopy -keep-section=.test2 -only-keep=.test %t %t2
-# RUN: llvm-objcopy -j .test -keep-section=.test2 %t %t3
-# RUN: llvm-readobj -file-headers -sections %t2 | FileCheck %s
-# RUN: diff %t2 %t3
-
-!ELF
-FileHeader:
-  Class:           ELFCLASS64
-  Data:            ELFDATA2LSB
-  Type:            ET_REL
-  Machine:         EM_X86_64
-Sections:
-  - Name:            .test
-    Type:            SHT_PROGBITS
-  - Name:            .test2
-    Type:            SHT_PROGBITS
-  - Name:            .test3
-    Type:            SHT_PROGBITS
-
-# CHECK: SectionHeaderCount: 6
-
-# CHECK:     Name: .test
-# CHECK:     Name: .test2
-# CHECK:     Name: .symtab
-# CHECK:     Name: .strtab
-# CHECK:     Name: .shstrtab

llvm/trunk/test/tools/llvm-objcopy/ELF/keep-only-section.test

+# RUN: yaml2obj %s > %t
+# RUN: llvm-objcopy -keep-section=.test2 -only-section=.test %t %t2
+# RUN: llvm-objcopy -j .test -keep-section=.test2 %t %t3
+# RUN: llvm-readobj -file-headers -sections %t2 | FileCheck %s
+# RUN: diff %t2 %t3
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_REL
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .test
+    Type:            SHT_PROGBITS
+  - Name:            .test2
+    Type:            SHT_PROGBITS
+  - Name:            .test3
+    Type:            SHT_PROGBITS
+
+# CHECK: SectionHeaderCount: 6
+
+# CHECK:     Name: .test
+# CHECK:     Name: .test2
+# CHECK:     Name: .symtab
+# CHECK:     Name: .strtab
+# CHECK:     Name: .shstrtab

llvm/trunk/test/tools/llvm-objcopy/ELF/only-keep-many.test

-# RUN: yaml2obj %s > %t
-# RUN: llvm-objcopy -j .test1 -j .test2 %t %t2
-# RUN: llvm-readobj -file-headers -sections %t2 | FileCheck %s
-
-!ELF
-FileHeader:
-  Class:           ELFCLASS64
-  Data:            ELFDATA2LSB
-  Type:            ET_REL
-  Machine:         EM_X86_64
-Sections:
-  - Name:            .test1
-    Type:            SHT_PROGBITS
-    Flags:           [ ]
-  - Name:            .test2
-    Type:            SHT_PROGBITS
-    Flags:           [ ]
-  - Name:            .test3
-    Type:            SHT_PROGBITS
-    Flags:           [ ]
-
-# CHECK: SectionHeaderCount: 6
-
-# CHECK:     Name: .test1
-# CHECK:     Name: .test2
-# CHECK:     Name: .symtab
-# CHECK:     Name: .strtab
-# CHECK:     Name: .shstrtab

llvm/trunk/test/tools/llvm-objcopy/ELF/only-keep-remove-strtab.test

-# RUN: yaml2obj %s > %t
-# RUN: llvm-objcopy -R .symtab -R .strtab -only-keep=.test %t %t2
-# RUN: llvm-objcopy -j .test -R .strtab -R .symtab %t %t3
-# RUN: llvm-readobj -file-headers -sections %t2 | FileCheck %s
-# RUN: diff %t2 %t3
-
-!ELF
-FileHeader:
-  Class:           ELFCLASS64
-  Data:            ELFDATA2LSB
-  Type:            ET_REL
-  Machine:         EM_X86_64
-Sections:
-  - Name:            .test
-    Type:            SHT_PROGBITS
-    Flags:           [ ]
-
-# CHECK: SectionHeaderCount: 3
-
-# CHECK:     Name: .test
-# CHECK:     Name: .shstrtab

llvm/trunk/test/tools/llvm-objcopy/ELF/only-keep-strip-non-alloc.test

-# RUN: yaml2obj %s > %t
-# RUN: llvm-objcopy -strip-non-alloc -only-keep=.test %t %t2
-# RUN: llvm-readobj -file-headers -sections %t2 | FileCheck %s
-
-!ELF
-FileHeader:
-  Class:           ELFCLASS64
-  Data:            ELFDATA2LSB
-  Type:            ET_REL
-  Machine:         EM_X86_64
-Sections:
-  - Name:            .test
-    Type:            SHT_PROGBITS
-    Flags:           [ ]
-
-# CHECK: SectionHeaderCount: 3
-
-# CHECK:     Name: .test
-# CHECK:     Name: .shstrtab

llvm/trunk/test/tools/llvm-objcopy/ELF/only-section-many.test

+# RUN: yaml2obj %s > %t
+# RUN: llvm-objcopy -j .test1 -j .test2 %t %t2
+# RUN: llvm-readobj -file-headers -sections %t2 | FileCheck %s
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_REL
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .test1
+    Type:            SHT_PROGBITS
+    Flags:           [ ]
+  - Name:            .test2
+    Type:            SHT_PROGBITS
+    Flags:           [ ]
+  - Name:            .test3
+    Type:            SHT_PROGBITS
+    Flags:           [ ]
+
+# CHECK: SectionHeaderCount: 6
+
+# CHECK:     Name: .test1
+# CHECK:     Name: .test2
+# CHECK:     Name: .symtab
+# CHECK:     Name: .strtab
+# CHECK:     Name: .shstrtab

llvm/trunk/test/tools/llvm-objcopy/ELF/only-section-remove-strtab.test

+# RUN: yaml2obj %s > %t
+# RUN: llvm-objcopy -R .symtab -R .strtab -only-section=.test %t %t2
+# RUN: llvm-objcopy -j .test -R .strtab -R .symtab %t %t3
+# RUN: llvm-readobj -file-headers -sections %t2 | FileCheck %s
+# RUN: diff %t2 %t3
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_REL
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .test
+    Type:            SHT_PROGBITS
+    Flags:           [ ]
+
+# CHECK: SectionHeaderCount: 3
+
+# CHECK:     Name: .test
+# CHECK:     Name: .shstrtab

llvm/trunk/test/tools/llvm-objcopy/ELF/only-section-strip-non-alloc.test

+# RUN: yaml2obj %s > %t
+# RUN: llvm-objcopy -strip-non-alloc -only-section=.test %t %t2
+# RUN: llvm-readobj -file-headers -sections %t2 | FileCheck %s
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_REL
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .test
+    Type:            SHT_PROGBITS
+    Flags:           [ ]
+
+# CHECK: SectionHeaderCount: 3
+
+# CHECK:     Name: .test
+# CHECK:     Name: .shstrtab

llvm/trunk/test/tools/llvm-objcopy/ELF/strip-sections-only-keep.test

-# RUN: yaml2obj %s > %t
-# RUN: llvm-objcopy -strip-sections -only-keep=.test %t %t2
-# RUN: od -Ax -t x1 %t2 | FileCheck %s
-# RUN: od -Ax -t c  %t2 | FileCheck %s -check-prefix=TEXT
-
-!ELF
-FileHeader:
-  Class:           ELFCLASS64
-  Data:            ELFDATA2LSB
-  Type:            ET_REL
-  Machine:         EM_X86_64
-Sections:
-  - Name:            .test
-    Type:            SHT_PROGBITS
-    Flags:           [ ]
-    Content:        "DEADBEEF"
-
-# CHECK: de ad be ef
-
-# TEXT-NOT: t e s t

llvm/trunk/test/tools/llvm-objcopy/ELF/strip-sections-only-section.test

+# RUN: yaml2obj %s > %t
+# RUN: llvm-objcopy -strip-sections -only-section=.test %t %t2
+# RUN: od -Ax -t x1 %t2 | FileCheck %s
+# RUN: od -Ax -t c  %t2 | FileCheck %s -check-prefix=TEXT
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_REL
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .test
+    Type:            SHT_PROGBITS
+    Flags:           [ ]
+    Content:        "DEADBEEF"
+
+# CHECK: de ad be ef
+
+# TEXT-NOT: t e s t

llvm/trunk/tools/llvm-objcopy/CopyConfig.h

struct CopyConfig {
   Optional<StringRef> BuildIdLinkOutput;
   StringRef SplitDWO;
   StringRef SymbolsPrefix;
 
   // Repeated options
   std::vector<StringRef> AddSection;
   std::vector<StringRef> DumpSection;
   std::vector<StringRef> KeepSection;
-  std::vector<StringRef> OnlyKeep;
+  std::vector<StringRef> OnlySection;
   std::vector<StringRef> SymbolsToGlobalize;
   std::vector<StringRef> SymbolsToKeep;
   std::vector<StringRef> SymbolsToLocalize;
   std::vector<StringRef> SymbolsToRemove;
   std::vector<StringRef> SymbolsToWeaken;
   std::vector<StringRef> ToRemove;
   std::vector<std::string> SymbolsToKeepGlobal;
 

llvm/trunk/tools/llvm-objcopy/CopyConfig.cpp

for (auto Arg : InputArgs.filtered(OBJCOPY_rename_section)) {
     if (!Config.SectionsToRename.try_emplace(SR.OriginalName, SR).second)
       error("Multiple renames of section " + SR.OriginalName);
   }
 
   for (auto Arg : InputArgs.filtered(OBJCOPY_remove_section))
     Config.ToRemove.push_back(Arg->getValue());
   for (auto Arg : InputArgs.filtered(OBJCOPY_keep_section))
     Config.KeepSection.push_back(Arg->getValue());
-  for (auto Arg : InputArgs.filtered(OBJCOPY_only_keep))
-    Config.OnlyKeep.push_back(Arg->getValue());
+  for (auto Arg : InputArgs.filtered(OBJCOPY_only_section))
+    Config.OnlySection.push_back(Arg->getValue());
   for (auto Arg : InputArgs.filtered(OBJCOPY_add_section))
     Config.AddSection.push_back(Arg->getValue());
   for (auto Arg : InputArgs.filtered(OBJCOPY_dump_section))
     Config.DumpSection.push_back(Arg->getValue());
   Config.StripAll = InputArgs.hasArg(OBJCOPY_strip_all);
   Config.StripAllGNU = InputArgs.hasArg(OBJCOPY_strip_all_gnu);
   Config.StripDebug = InputArgs.hasArg(OBJCOPY_strip_debug);
   Config.StripDWO = InputArgs.hasArg(OBJCOPY_strip_dwo);

llvm/trunk/tools/llvm-objcopy/ELF/ELFObjcopy.cpp

RemovePred = [RemovePred, &Obj](const SectionBase &Sec) {
       if (&Sec == Obj.SectionNames)
         return false;
       if (StringRef(Sec.Name).startswith(".gnu.warning"))
         return false;
       return (Sec.Flags & SHF_ALLOC) == 0;
     };
 
   // Explicit copies:
-  if (!Config.OnlyKeep.empty()) {
+  if (!Config.OnlySection.empty()) {
     RemovePred = [&Config, RemovePred, &Obj](const SectionBase &Sec) {
       // Explicitly keep these sections regardless of previous removes.
-      if (is_contained(Config.OnlyKeep, Sec.Name))
+      if (is_contained(Config.OnlySection, Sec.Name))
         return false;
 
       // Allow all implicit removes.
       if (RemovePred(Sec))
         return true;
 
       // Keep special sections.
       if (Obj.SectionNames == &Sec)

llvm/trunk/tools/llvm-objcopy/ObjcopyOpts.td

: Eq<"rename-section",
          "Flags supported for GNU compatibility: alloc, load, noload, "
          "readonly, debug, code, data, rom, share, contents, merge, strings.">,
       MetaVarName<"old=new[,flag1,...]">;
 defm redefine_symbol
     : Eq<"redefine-sym", "Change the name of a symbol old to new">,
       MetaVarName<"old=new">;
 defm keep_section : Eq<"keep-section", "Keep <section>">,
                     MetaVarName<"section">;
-defm only_keep : Eq<"only-keep", "Remove all but <section>">,
+defm only_section : Eq<"only-section", "Remove all but <section>">,
                     MetaVarName<"section">;
-def j : JoinedOrSeparate<["-"], "j">, Alias<only_keep>;
+def j : JoinedOrSeparate<["-"], "j">, Alias<only_section>;
 defm add_section
     : Eq<"add-section",
          "Make a section named <section> with the contents of <file>.">,
       MetaVarName<"section=file">;
 
 def strip_all
     : Flag<["-", "--"], "strip-all">,
       HelpText<