[yaml2obj] - Refine handling of the NoHeaders key.

[grimar]

Summary

Imagine we have an YAML description for some object and we want to
produce 2 outputs: with and without the section header.
A natural way to do it would look like:

--- !ELF
FileHeader:
  Class:   ELFCLASS64
  Data:    ELFDATA2LSB
  Type:    ET_REL
  Machine: EM_X86_64
Sections:
...
SectionHeaderTable:
  NoHeaders: [[NOHEADERS]]

But currently, we do not distinguish between no NoHeaders key case
and NoHeaders == false. Because of this we can't simply specify
NOHEADERS = false, as tool starts to complain.

With this patch the behavior changed. When we have:

SectionHeaderTable:
  NoHeaders: false

it is the same as we have no SectionHeaderTable at all.
(NoHeaders key still can't be used with Sections/Excluded keys)

[MaskRay]

llvm/include/llvm/ObjectYAML/ELFYAML.h

101

Does bool NoHeaders = false; work? If absence is equal to false.

[jhenderson]

llvm/test/tools/yaml2obj/ELF/section-headers.yaml

122–123

produce -> produces
like when there is -> as if there were

[grimar]

• Addressed review comments.

llvm/include/llvm/ObjectYAML/ELFYAML.h

101

No. This is the same what we implicitly already have:

IO.mapOptional("NoHeaders", SectionHeader.NoHeaders, false);

When there is no NoHeaders or just NoHeaders = false in an YAML, and nothing else, then we have an error currently:

YAML:11:3: error: SectionHeaderTable can't be empty. Use 'NoHeaders' key to drop the section header table
  NoHeaders: false

This is what this patch solves.

[jhenderson]

LGTM.

llvm/include/llvm/ObjectYAML/ELFYAML.h

 
 struct SectionHeader {
   StringRef Name;
 };
 
 struct SectionHeaderTable {
   Optional<std::vector<SectionHeader>> Sections;
   Optional<std::vector<SectionHeader>> Excluded;
-  bool NoHeaders;
+  Optional<bool> NoHeaders;
 };
 
 struct SectionName {
   StringRef Section;
 };
 
 struct Symbol {
   StringRef Name;

llvm/lib/ObjectYAML/ELFEmitter.cpp

void ELFState<ELFT>::writeELFHeader(raw_ostream &OS, uint64_t SHOff) {
   else if (!Doc.ProgramHeaders.empty())
     Header.e_phnum = Doc.ProgramHeaders.size();
   else
     Header.e_phnum = 0;
 
   Header.e_shentsize =
       Doc.Header.SHEntSize ? (uint16_t)*Doc.Header.SHEntSize : sizeof(Elf_Shdr);
 
-  const bool NoShdrs = Doc.SectionHeaders && Doc.SectionHeaders->NoHeaders;
+  const bool NoShdrs =
+      Doc.SectionHeaders && Doc.SectionHeaders->NoHeaders.getValueOr(false);
 
   if (Doc.Header.SHOff)
     Header.e_shoff = *Doc.Header.SHOff;
   else if (NoShdrs)
     Header.e_shoff = 0;
   else
     Header.e_shoff = SHOff;
 
if (!LocSym.empty())
       reportError("unknown section referenced: '" + S + "' by YAML symbol '" +
                   LocSym + "'");
     else
       reportError("unknown section referenced: '" + S + "' by YAML section '" +
                   LocSec + "'");
     return 0;
   }
 
-  if (!Doc.SectionHeaders ||
-      (!Doc.SectionHeaders->NoHeaders && !Doc.SectionHeaders->Excluded))
+  if (!Doc.SectionHeaders || (Doc.SectionHeaders->NoHeaders &&
+                              !Doc.SectionHeaders->NoHeaders.getValue()))
     return Index;
 
-  assert(!Doc.SectionHeaders->NoHeaders || !Doc.SectionHeaders->Sections);
+  assert(!Doc.SectionHeaders->NoHeaders.getValueOr(false) ||
+         !Doc.SectionHeaders->Sections);
   size_t FirstExcluded =
       Doc.SectionHeaders->Sections ? Doc.SectionHeaders->Sections->size() : 0;
   if (Index >= FirstExcluded) {
     if (LocSym.empty())
       reportError("unable to link '" + LocSec + "' to excluded section '" + S +
                   "'");
     else
       reportError("excluded section referenced: '" + S + "'  by symbol '" +
template <class ELFT> void ELFState<ELFT>::buildSectionIndex() {
   // Build excluded section headers map.
   std::vector<ELFYAML::Section *> Sections = Doc.getSections();
   if (Doc.SectionHeaders) {
     if (Doc.SectionHeaders->Excluded)
       for (const ELFYAML::SectionHeader &Hdr : *Doc.SectionHeaders->Excluded)
         if (!ExcludedSectionHeaders.insert(Hdr.Name).second)
           llvm_unreachable("buildSectionIndex() failed");
 
-    if (Doc.SectionHeaders->NoHeaders)
+    if (Doc.SectionHeaders->NoHeaders.getValueOr(false))
       for (const ELFYAML::Section *S : Sections)
         if (!ExcludedSectionHeaders.insert(S->Name).second)
           llvm_unreachable("buildSectionIndex() failed");
   }
 
   size_t SecNdx = -1;
   for (const ELFYAML::Section *S : Sections) {
     ++SecNdx;

llvm/lib/ObjectYAML/ELFYAML.cpp

void MappingTraits<ELFYAML::SectionHeader>::mapping(
     IO &IO, ELFYAML::SectionHeader &SHdr) {
   IO.mapRequired("Name", SHdr.Name);
 }
 
 void MappingTraits<ELFYAML::SectionHeaderTable>::mapping(
     IO &IO, ELFYAML::SectionHeaderTable &SectionHeader) {
   IO.mapOptional("Sections", SectionHeader.Sections);
   IO.mapOptional("Excluded", SectionHeader.Excluded);
-  IO.mapOptional("NoHeaders", SectionHeader.NoHeaders, false);
+  IO.mapOptional("NoHeaders", SectionHeader.NoHeaders);
 }
 
 StringRef MappingTraits<ELFYAML::SectionHeaderTable>::validate(
     IO &IO, ELFYAML::SectionHeaderTable &SecHdrTable) {
   if (SecHdrTable.NoHeaders && (SecHdrTable.Sections || SecHdrTable.Excluded))
     return "NoHeaders can't be used together with Sections/Excluded";
   if (!SecHdrTable.NoHeaders && !SecHdrTable.Sections && !SecHdrTable.Excluded)
     return "SectionHeaderTable can't be empty. Use 'NoHeaders' key to drop the "

llvm/test/tools/yaml2obj/ELF/section-headers-exclude.yaml

FileHeader:
   Machine: EM_X86_64
 SectionHeaderTable:
   Sections:
     - Name: .strtab
   Excluded:
     - Name: .shstrtab
 
 ## Check we do not allow using "Excluded" together with "NoHeaders".
-# RUN: not yaml2obj %s --docnum=19 -o /dev/null 2>&1 | FileCheck %s --check-prefix=NOHEADERS
+# RUN: not yaml2obj %s --docnum=19 -DNOHEADERS=true -o /dev/null 2>&1 | FileCheck %s --check-prefix=NOHEADERS
+# RUN: not yaml2obj %s --docnum=19 -DNOHEADERS=false -o /dev/null 2>&1 | FileCheck %s --check-prefix=NOHEADERS
 # NOHEADERS: NoHeaders can't be used together with Sections/Excluded
 
 --- !ELF
 FileHeader:
   Class:   ELFCLASS64
   Data:    ELFDATA2LSB
   Type:    ET_REL
   Machine: EM_X86_64
 SectionHeaderTable:
-  NoHeaders: true
+  NoHeaders: [[NOHEADERS]]
   Excluded:  []

llvm/test/tools/yaml2obj/ELF/section-headers.yaml

FileHeader:
   Machine: EM_X86_64
 Sections:
   - Name: .foo
     Type: SHT_PROGBITS
 SectionHeaderTable:
   Sections: []
 
 ## Test that we are able to use "NoHeaders" property to produce an empty section header table.
-# RUN: yaml2obj %s --docnum=3 -o %t3
-# RUN: llvm-readelf --file-headers %t3 | FileCheck %s --check-prefix=NO-HEADERS
+# RUN: yaml2obj %s --docnum=3 -DNOHEADERS=true -o %t3.1
+# RUN: llvm-readelf --file-headers %t3.1 | FileCheck %s --check-prefix=NO-HEADERS-TRUE
 
-# NO-HEADERS: Start of section headers:          0  (bytes into file)
-# NO-HEADERS: Size of section headers:           64 (bytes)
-# NO-HEADERS: Number of section headers:         0
-# NO-HEADERS: Section header string table index: 0
+# NO-HEADERS-TRUE: Start of section headers:          0  (bytes into file)
+# NO-HEADERS-TRUE: Size of section headers:           64 (bytes)
+# NO-HEADERS-TRUE: Number of section headers:         0
+# NO-HEADERS-TRUE: Section header string table index: 0
 
 --- !ELF
 FileHeader:
   Class:   ELFCLASS64
   Data:    ELFDATA2LSB
   Type:    ET_REL
   Machine: EM_X86_64
 Sections:
   - Name: .foo
     Type: SHT_PROGBITS
 SectionHeaderTable:
-  NoHeaders: true
+  NoHeaders: [[NOHEADERS]]
+
+## Test that we are able to set NoHeaders to false. In this case the tool produces an output
+## as if there were no `SectionHeaderTable` key at all.
+# RUN: yaml2obj %s --docnum=3 -DNOHEADERS=false -o %t3.2
+# RUN: llvm-readelf --file-headers %t3.2 | FileCheck %s --check-prefix=NO-HEADERS-FALSE
+
+# NO-HEADERS-FALSE: Start of section headers:          96 (bytes into file)
+# NO-HEADERS-FALSE: Size of section headers:           64 (bytes)
+# NO-HEADERS-FALSE: Number of section headers:         1
+# NO-HEADERS-FALSE: Section header string table index: 3
 
 ## Check we do not allow using "Sections" together with "NoHeaders".
-# RUN: not yaml2obj %s --docnum=4 -o /dev/null 2>&1 | FileCheck %s --check-prefix=SECTIONS-NO-HEADERS
+# RUN: not yaml2obj %s --docnum=4 -DNOHEADERS=true -o /dev/null 2>&1 | FileCheck %s --check-prefix=SECTIONS-NO-HEADERS
+# RUN: not yaml2obj %s --docnum=4 -DNOHEADERS=false -o /dev/null 2>&1 | FileCheck %s --check-prefix=SECTIONS-NO-HEADERS
 
 # SECTIONS-NO-HEADERS: error: NoHeaders can't be used together with Sections/Excluded
 
 --- !ELF
 FileHeader:
   Class:   ELFCLASS64
   Data:    ELFDATA2LSB
   Type:    ET_REL
   Machine: EM_X86_64
 Sections:
   - Name: .foo
     Type: SHT_PROGBITS
 SectionHeaderTable:
   Sections:  []
-  NoHeaders: true
+  NoHeaders: [[NOHEADERS]]
 
 ## Check that we do not allow an empty SectionHeaderTable tag and suggest to use an explicit syntax instead.
 # RUN: not yaml2obj %s --docnum=5 -DVAL="" -o /dev/null 2>&1 | FileCheck %s --check-prefix=NO-VALUE
 
 # NO-VALUE: SectionHeaderTable can't be empty. Use 'NoHeaders' key to drop the section header table
 
 --- !ELF
 FileHeader: