[yaml2obj] - Improve handling of the SHT_GROUP section.

[grimar]

Summary

Currently, when we do not specify "Info" field in a YAML description
for SHT_GROUP section, yaml2obj reports an error:
"error: unknown symbol referenced: '' by YAML section '.group1'"

Also, we do not link it with a symbol table by default,
though it is what we do for AddrsigSection, HashSection, RelocationSection.
(http://www.sco.com/developers/gabi/latest/ch4.sheader.html#sh_link)

The patch fixes the missings mentioned.

[grimar]

• Rebased.

[jhenderson]

LGTM, with two nits.

test/tools/yaml2obj/section-link.yaml

48 ↗

(On Diff #226629)

if it is exists -> if it exists

49 ↗

(On Diff #226629)

Delete "use". I'd also add "Also" to the start of this sentence: "Also, check we..."

llvm/include/llvm/ObjectYAML/ELFYAML.h

static bool classof(const Section *S) {
     return S->Kind == SectionKind::Verdef;
   }
 };
 
 struct Group : Section {
   // Members of a group contain a flag and a list of section indices
   // that are part of the group.
   std::vector<SectionOrType> Members;
-  StringRef Signature; /* Info */
+  Optional<StringRef> Signature; /* Info */
 
   Group() : Section(SectionKind::Group) {}
 
   static bool classof(const Section *S) {
     return S->Kind == SectionKind::Group;
   }
 };
 

llvm/lib/ObjectYAML/ELFEmitter.cpp

 
 template <class ELFT>
 void ELFState<ELFT>::writeSectionContent(Elf_Shdr &SHeader,
                                          const ELFYAML::Group &Section,
                                          ContiguousBlobAccumulator &CBA) {
   assert(Section.Type == llvm::ELF::SHT_GROUP &&
          "Section type is not SHT_GROUP");
 
+  unsigned Link = 0;
+  if (Section.Link.empty() && SN2I.lookup(".symtab", Link))
+    SHeader.sh_link = Link;
+
   SHeader.sh_entsize = 4;
   SHeader.sh_size = SHeader.sh_entsize * Section.Members.size();
+
+  if (Section.Signature)
     SHeader.sh_info =
-      toSymbolIndex(Section.Signature, Section.Name, /*IsDynamic=*/false);
+        toSymbolIndex(*Section.Signature, Section.Name, /*IsDynamic=*/false);
 
   raw_ostream &OS =
       CBA.getOSAndAlignedOffset(SHeader.sh_offset, SHeader.sh_addralign);
 
   for (const ELFYAML::SectionOrType &Member : Section.Members) {
     unsigned int SectionIndex = 0;
     if (Member.sectionNameOrType == "GRP_COMDAT")
       SectionIndex = llvm::ELF::GRP_COMDAT;

llvm/lib/ObjectYAML/ELFYAML.cpp

 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
   commonSectionMapping(IO, Section);
   IO.mapOptional("Info", Section.RelocatableSec, StringRef());
   IO.mapOptional("Relocations", Section.Relocations);
 }
 
 static void groupSectionMapping(IO &IO, ELFYAML::Group &Group) {
   commonSectionMapping(IO, Group);
-  IO.mapOptional("Info", Group.Signature, StringRef());
+  IO.mapOptional("Info", Group.Signature);
   IO.mapRequired("Members", Group.Members);
 }
 
 static void sectionMapping(IO &IO, ELFYAML::SymtabShndxSection &Section) {
   commonSectionMapping(IO, Section);
   IO.mapRequired("Entries", Section.Entries);
 }
 

llvm/test/tools/yaml2obj/duplicate-section-names.test

 FileHeader:
   Class:   ELFCLASS64
   Data:    ELFDATA2LSB
   Type:    ET_REL
   Machine: EM_X86_64
 Sections:
   - Name: .group
     Type: SHT_GROUP
-    Link: .symtab
     Info: foo
     Members:
       - SectionOrType: GRP_COMDAT
       - SectionOrType: .text.foo
   - Name: .text.foo
     Type: SHT_PROGBITS
   - Name: '.group [1]'
     Type: SHT_GROUP
-    Link: .symtab
     Info: 'foo [1]'
     Members:         
       - SectionOrType: GRP_COMDAT
       - SectionOrType: '.text.foo [1]'
   - Name: '.text.foo [1]'
     Type: SHT_PROGBITS
 Symbols:
   - Name:    foo
     Section: .text.foo
   - Name:    'foo [1]'
     Section: '.text.foo [1]'

llvm/test/tools/yaml2obj/elf-comdat-broken-info.yaml

 FileHeader:
   Class:   ELFCLASS64
   Data:    ELFDATA2LSB
   Type:    ET_REL
   Machine: EM_X86_64
 Sections:
   - Name: .group1
     Type: SHT_GROUP
-    Link: .symtab
     Info: foo
     Members:
       - SectionOrType: GRP_COMDAT
   - Name: .group2
     Type: SHT_GROUP
-    Link: .symtab
     Info: bar
     Members:
       - SectionOrType: GRP_COMDAT

llvm/test/tools/yaml2obj/elf-comdat-broken-members.yaml

 ## Check we report an error when SHT_GROUP references an unknown section in its member list.
 
 # RUN: not yaml2obj %s 2>&1 | FileCheck %s
 
 # CHECK: error: unknown section referenced: '.foo' by YAML section '.group'
 # CHECK: error: unknown section referenced: '.bar' by YAML section '.group'
 
 --- !ELF
 FileHeader:
   Class:   ELFCLASS64
   Data:    ELFDATA2LSB
   Type:    ET_REL
   Machine: EM_X86_64
 Sections:
   - Name: .group
     Type: SHT_GROUP
-    Link: .symtab
-    Info: 0
     Members:
       - SectionOrType: GRP_COMDAT
       - SectionOrType: .foo
       - SectionOrType: .bar

llvm/test/tools/yaml2obj/elf-comdat-broken.yaml

 # RUN: yaml2obj %s -o %t
 # RUN: llvm-readobj --sections --elf-section-groups %t | FileCheck %s
 
 --- !ELF
 FileHeader:
   Class:               ELFCLASS64
   Data:                ELFDATA2LSB
   Type:                ET_REL
   Machine:             EM_X86_64
 Sections:
   - Name:              .group
     Type:              SHT_GROUP
-    Link:              .symtab
     Info:              foo
     Members:
       - SectionOrType: 0xFF
       - SectionOrType: 3
 Symbols:
   - Name:    foo
   - Binding: STB_GLOBAL
 

llvm/test/tools/yaml2obj/elf-override-shname.yaml

Sections:
   - Name: .rela
     Type: SHT_RELA
     ShName: 0x000000004
   - Name: .nobits
     Type: SHT_NOBITS
     ShName: 0x000000005
   - Name: .group
     Type: SHT_GROUP
-    Info: 0
     ShName: 0x000000006
     Members:
   - Name: .gnu.version
     Type: SHT_GNU_versym
     Entries: [ ]
     ShName: 0x000000007
   - Name: .gnu.version_r
     Type: SHT_GNU_verneed

llvm/test/tools/yaml2obj/elf-override-shoffset.yaml

Sections:
   - Name: .rela
     Type: SHT_RELA
     ShOffset: 0x000000004
   - Name: .nobits
     Type: SHT_NOBITS
     ShOffset: 0x000000005
   - Name: .group
     Type: SHT_GROUP
-    Info: 0
     ShOffset: 0x000000006
     Members:
   - Name: .gnu.version
     Type: SHT_GNU_versym
     Entries: [ ]
     ShOffset: 0x000000007
   - Name: .gnu.version_r
     Type: SHT_GNU_verneed

llvm/test/tools/yaml2obj/elf-override-shsize.yaml

Sections:
   - Name: .rela
     Type: SHT_RELA
     ShSize: 0x000000004
   - Name: .nobits
     Type: SHT_NOBITS
     ShSize: 0x000000005
   - Name: .group
     Type: SHT_GROUP
-    Info: 0
     ShSize: 0x000000006
     Members:
   - Name: .gnu.version
     Type: SHT_GNU_versym
     Entries: [ ]
     ShSize: 0x000000007
   - Name: .gnu.version_r
     Type: SHT_GNU_verneed

llvm/test/tools/yaml2obj/section-link.yaml

FileHeader:
   Machine: EM_X86_64
 Sections:
   - Name: .foo
     Type: SHT_PROGBITS
     Link: .unknown1
   - Name: .bar
     Type: SHT_PROGBITS
     Link: .unknown2
+
+## Check we link SHT_GROUP to a symbol table by default if it exists.
+## Also, check we can set an arbitrary value for sh_link.
+
+# RUN: yaml2obj --docnum=3 %s -o %t3
+# RUN: llvm-readobj --sections %t3 | FileCheck %s --check-prefix=GROUP-LINK
+
+# GROUP-LINK:      Name: .group1
+# GROUP-LINK:      Link:
+# GROUP-LINK-SAME:       3
+
+# GROUP-LINK:      Name: .group2
+# GROUP-LINK:      Link:
+# GROUP-LINK-SAME:       255
+
+--- !ELF
+FileHeader:
+  Class:   ELFCLASS64
+  Data:    ELFDATA2LSB
+  Type:    ET_REL
+  Machine: EM_X86_64
+Sections:
+  - Name: .group1
+    Type: SHT_GROUP
+    Members:
+  - Name: .group2
+    Type: SHT_GROUP
+    Link: 0xFF
+    Members:
+Symbols: []
+
+## Check we set SHT_GROUP's link value to 0 when there is no symbol table.
+
+# RUN: yaml2obj --docnum=4 %s -o %t4
+# RUN: llvm-readobj --sections %t4 | FileCheck %s --check-prefix=GROUP-LINK-NOSYMTAB
+
+# GROUP-LINK-NOSYMTAB:      Name: .group
+# GROUP-LINK-NOSYMTAB:      Link:
+# GROUP-LINK-NOSYMTAB-SAME:       0
+
+--- !ELF
+FileHeader:
+  Class:   ELFCLASS64
+  Data:    ELFDATA2LSB
+  Type:    ET_REL
+  Machine: EM_X86_64
+Sections:
+  - Name: .group
+    Type: SHT_GROUP
+    Members: