llvm-project/llvm/test/tools/yaml2obj/ELF/section-headers.yaml
Georgii Rymar 68195b15a3 [yaml2obj] - Allow empty SectionHeaderTable definitions.
Currently we don't allow the following definition:

```
Sections:
  - Type: SectionHeaderTable
  - Name: .foo
    Type: SHT_PROGBITS
```

We report an error: "SectionHeaderTable can't be empty. Use 'NoHeaders' key to drop the section header table".

It was implemented in this way earlier, when `SectionHeaderTable`
was a dedicated key outside of the `Sections` list. And we did not
allow to select where the table is written.

Currently it makes sense to allow it, because a user might
want to place the default section header table at an arbitrary position,
e.g. before other sections. In this case it is not convenient and error prone
to require specifying all sections:

```
Sections:
  - Type: SectionHeaderTable
    Sections:
      - Name: .foo
      - Name: .strtab
      - Name: .shstrtab
  - Name: .foo
    Type: SHT_PROGBITS
```

This patch allows empty SectionHeaderTable definitions.

Differential revision: https://reviews.llvm.org/D95341
2021-01-28 10:51:52 +03:00

421 lines
16 KiB
YAML

## Check we can use "SectionHeaderTable" tag to reorder section header entries.
## This is a general test that has sections with unique prefixes, a fill and a
## section without the unique prefix. The section header table describes sections
## in the same order they are listed in the YAML.
# RUN: yaml2obj %s --docnum=1 -o %t1 -DSEC1=".section (1)" -DSEC2=".section (2)" -DSEC3=".section.foo"
# RUN: llvm-readelf --section-headers %t1 | FileCheck %s --check-prefix=NO-OP
# NO-OP: Section Headers:
# NO-OP-NEXT: [Nr] Name Type Address Off Size ES Flg Lk Inf Al
# NO-OP-NEXT: [ 0] NULL 0000000000000000 000000 000000 00 0 0 0
# NO-OP-NEXT: [ 1] .section PROGBITS 0000000000000000 000040 000010 00 0 0 0
# NO-OP-NEXT: [ 2] .section PROGBITS 0000000000000000 000050 000020 00 0 0 0
# NO-OP-NEXT: [ 3] .section.foo PROGBITS 0000000000000000 0000a0 000040 00 0 0 0
# NO-OP-NEXT: [ 4] .strtab STRTAB 0000000000000000 0000e0 000001 00 0 0 1
# NO-OP-NEXT: [ 5] .shstrtab STRTAB 0000000000000000 0000e1 000029 00 0 0 1
--- !ELF
FileHeader:
Class: ELFCLASS64
Data: ELFDATA2LSB
Type: ET_REL
Sections:
- Name: .section (1)
Type: SHT_PROGBITS
Size: 0x10
- Name: .section (2)
Type: SHT_PROGBITS
Size: 0x20
- Type: Fill
Name: .filler
Size: 0x30
Pattern: ""
- Name: .section.foo
Type: SHT_PROGBITS
Size: 0x40
- Type: SectionHeaderTable
Sections:
- Name: [[SEC1]]
- Name: [[SEC2]]
- Name: [[SEC3]]
- Name: .strtab
- Name: .shstrtab
## Show we are able to reorder sections.
# RUN: yaml2obj %s -o %t2 -DSEC3=".section (1)" -DSEC2=".section (2)" -DSEC1=".section.foo"
# RUN: llvm-readelf --section-headers %t2 | FileCheck %s --check-prefix=REORDERED
# REORDERED: Section Headers:
# REORDERED-NEXT: [Nr] Name Type Address Off Size ES Flg Lk Inf Al
# REORDERED-NEXT: [ 0] NULL 0000000000000000 000000 000000 00 0 0 0
# REORDERED-NEXT: [ 1] .section.foo PROGBITS 0000000000000000 0000a0 000040 00 0 0 0
# REORDERED-NEXT: [ 2] .section PROGBITS 0000000000000000 000050 000020 00 0 0 0
# REORDERED-NEXT: [ 3] .section PROGBITS 0000000000000000 000040 000010 00 0 0 0
# REORDERED-NEXT: [ 4] .strtab STRTAB 0000000000000000 0000e0 000001 00 0 0 1
# REORDERED-NEXT: [ 5] .shstrtab STRTAB 0000000000000000 0000e1 000029 00 0 0 1
## Show we report proper errors when the section header description:
## a) contains a repeated section name.
## b) omits any section that exists.
## c) contains a non-existent section.
# RUN: not yaml2obj %s -o /dev/null -DSEC1=".section.foo" -DSEC2="unknown" -DSEC3=".section.foo" 2>&1 | \
# RUN: FileCheck %s --check-prefix=ERR1
# d) contains a repeated implicit section name.
# e) contains a fill name.
# RUN: not yaml2obj %s -o /dev/null -DSEC1=".strtab" -DSEC2=".shstrtab" -DSEC3=".filler" 2>&1 | \
# RUN: FileCheck %s --check-prefix=ERR2
# ERR1: error: repeated section name: '.section.foo' in the section header description
# ERR1-NEXT: error: section '.section (1)' should be present in the 'Sections' or 'Excluded' lists
# ERR1-NEXT: error: section '.section (2)' should be present in the 'Sections' or 'Excluded' lists
# ERR1-NEXT: error: section header contains undefined section 'unknown'
# ERR2: error: repeated section name: '.strtab' in the section header description
# ERR2-NEXT: error: repeated section name: '.shstrtab' in the section header description
# ERR2-NEXT: error: section '.section (1)' should be present in the 'Sections' or 'Excluded' lists
# ERR2-NEXT: error: section '.section (2)' should be present in the 'Sections' or 'Excluded' lists
# ERR2-NEXT: error: section '.section.foo' should be present in the 'Sections' or 'Excluded' lists
# ERR2-NEXT: error: section header contains undefined section '.filler'
## Check that when the an empty "Sections" list is used, we do not create an empty section header table.
# RUN: not yaml2obj %s --docnum=2 -o /dev/null 2>&1 | FileCheck %s --check-prefix=EMPTY-SECTIONS
# EMPTY-SECTIONS: error: section '.foo' should be present in the 'Sections' or 'Excluded' lists
# EMPTY-SECTIONS-NEXT: error: section '.strtab' should be present in the 'Sections' or 'Excluded' lists
# EMPTY-SECTIONS-NEXT: error: section '.shstrtab' should be present in the 'Sections' or 'Excluded' lists
--- !ELF
FileHeader:
Class: ELFCLASS64
Data: ELFDATA2LSB
Type: ET_REL
Sections:
- Name: .foo
Type: SHT_PROGBITS
- Type: SectionHeaderTable
Sections: []
## Test that we are able to use "NoHeaders" property to produce an empty section header table.
# 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-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
Sections:
- Name: .foo
Type: SHT_PROGBITS
- Type: SectionHeaderTable
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 --sections %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: 4
# NO-HEADERS-FALSE: Section header string table index: 3
# NO-HEADERS-FALSE: Section Headers:
# NO-HEADERS-FALSE-NEXT: [Nr] Name Type Address Off Size ES Flg Lk Inf Al
# NO-HEADERS-FALSE-NEXT: [ 0] NULL 0000000000000000 000000 000000 00 0 0 0
# NO-HEADERS-FALSE-NEXT: [ 1] .foo PROGBITS 0000000000000000 000040 000000 00 0 0 0
# NO-HEADERS-FALSE-NEXT: [ 2] .strtab STRTAB 0000000000000000 000040 000001 00 0 0 1
# NO-HEADERS-FALSE-NEXT: [ 3] .shstrtab STRTAB 0000000000000000 000041 000018 00 0 0 1
## Check we do not allow using "Sections" together with "NoHeaders".
# 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 Offset/Sections/Excluded
--- !ELF
FileHeader:
Class: ELFCLASS64
Data: ELFDATA2LSB
Type: ET_REL
Sections:
- Name: .foo
Type: SHT_PROGBITS
- Type: SectionHeaderTable
Sections: []
NoHeaders: [[NOHEADERS]]
## Check that we allow using an empty SectionHeaderTable definition.
## It can be used to emit the default section header table at an arbitrary position.
# RUN: yaml2obj %s --docnum=5 -o %t5.novalues
# RUN: llvm-readelf --sections %t5.novalues | \
# RUN: FileCheck %s --check-prefix=NO-VALUES
## Check we placed the section header table before the .foo section.
# NO-VALUES: There are 4 section headers, starting at offset 0x40:
# NO-VALUES: [Nr] Name Type Address Off Size
# NO-VALUES: [ 1] .foo PROGBITS 0000000000000000 000140 000000
--- !ELF
FileHeader:
Class: ELFCLASS64
Data: ELFDATA2LSB
Type: ET_REL
Sections:
- Type: SectionHeaderTable
- Name: .foo
Type: SHT_PROGBITS
## Test that we are still able to override e_shoff, e_shnum and e_shstrndx
## fields even when we do not produce section headers.
# RUN: yaml2obj %s --docnum=6 -o %t4
# RUN: not llvm-readelf --file-headers %t4 | FileCheck %s --check-prefix=NO-HEADERS-OVERRIDE
# NO-HEADERS-OVERRIDE: Start of section headers: 2 (bytes into file)
# NO-HEADERS-OVERRIDE: Number of section headers: 3
# NO-HEADERS-OVERRIDE: Section header string table index: 4
--- !ELF
FileHeader:
Class: ELFCLASS64
Data: ELFDATA2LSB
Type: ET_REL
EShOff: 0x2
EShNum: 0x3
EShStrNdx: 0x4
Sections:
- Type: SectionHeaderTable
NoHeaders: true
## Check that section indices are updated properly in other places when we
## reorder sections in the section header table.
# RUN: yaml2obj %s --docnum=7 -o %t5 -DSEC1=".foo" -DSEC2=".bar"
# RUN: llvm-readelf --section-headers --symbols %t5 | FileCheck %s --check-prefix=INDICES-A
# RUN: yaml2obj %s --docnum=7 -o %t6 -DSEC2=".foo" -DSEC1=".bar"
# RUN: llvm-readelf --section-headers --symbols %t6 | FileCheck %s --check-prefix=INDICES-B
# INDICES-A: [Nr] Name Type Address Off Size ES Flg Lk
# INDICES-A: [ 1] .foo PROGBITS 0000000000000000 000040 000000 00 0
# INDICES-A-NEXT: [ 2] .bar PROGBITS 0000000000000000 000040 000000 00 0
# INDICES-A-NEXT: [ 3] .another.1 PROGBITS 0000000000000000 000040 000000 00 1
# INDICES-A-NEXT: [ 4] .another.2 PROGBITS 0000000000000000 000040 000000 00 2
# INDICES-A: Num: Value Size Type Bind Vis Ndx Name
# INDICES-A: 1: 0000000000000000 0 NOTYPE LOCAL DEFAULT 1 foo
# INDICES-A-NEXT: 2: 0000000000000000 0 NOTYPE LOCAL DEFAULT 2 bar
# INDICES-B: [ 1] .bar PROGBITS 0000000000000000 000040 000000 00 0
# INDICES-B-NEXT: [ 2] .foo PROGBITS 0000000000000000 000040 000000 00 0
# INDICES-B-NEXT: [ 3] .another.1 PROGBITS 0000000000000000 000040 000000 00 2
# INDICES-B-NEXT: [ 4] .another.2 PROGBITS 0000000000000000 000040 000000 00 1
# INDICES-B: Num: Value Size Type Bind Vis Ndx Name
# INDICES-B: 1: 0000000000000000 0 NOTYPE LOCAL DEFAULT 2 foo
# INDICES-B-NEXT: 2: 0000000000000000 0 NOTYPE LOCAL DEFAULT 1 bar
--- !ELF
FileHeader:
Class: ELFCLASS64
Data: ELFDATA2LSB
Type: ET_REL
Sections:
- Name: .foo
Type: SHT_PROGBITS
- Name: .bar
Type: SHT_PROGBITS
- Name: .another.1
Link: .foo
Type: SHT_PROGBITS
- Name: .another.2
Link: .bar
Type: SHT_PROGBITS
- Type: SectionHeaderTable
Sections:
- Name: [[SEC1]]
- Name: [[SEC2]]
- Name: .another.1
- Name: .another.2
- Name: .symtab
- Name: .strtab
- Name: .shstrtab
Symbols:
- Name: foo
Section: .foo
- Name: bar
Section: .bar
## Check that when "NoHeaders" is set to "true" then we don't emit
## the .shstrtab section implicitly and don't write the data of the
## section header table to the file.
# RUN: yaml2obj %s --docnum=8 -o %t8
# RUN: wc -c < %t8 | FileCheck %s --check-prefix=SIZE
# SIZE: 511{{$}}
--- !ELF
FileHeader:
Class: ELFCLASS64
Data: ELFDATA2LSB
Type: ET_REL
Sections:
## We don't want any implicit sections to be added after the .foo section,
## so add them here explicitly.
- Name: .strtab
Type: SHT_STRTAB
## Nothing should be emitted after the following section.
## So we know that the expected file size is 0x100 + 0xFF == 0x1FF == 511.
- Name: .foo
Type: SHT_PROGBITS
## Unaligned size. Used to make sure that we don't try to align the file offset
## for writing the section header table.
Size: 0xFF
Offset: 0x100
- Type: SectionHeaderTable
NoHeaders: true
## Check we do not allow using "Offset" together with "NoHeaders".
# RUN: not yaml2obj %s --docnum=9 -DNOHEADERS=true -o /dev/null 2>&1 | FileCheck %s --check-prefix=NO-HEADERS-OFFSET
# RUN: not yaml2obj %s --docnum=9 -DNOHEADERS=false -o /dev/null 2>&1 | FileCheck %s --check-prefix=NO-HEADERS-OFFSET
# NO-HEADERS-OFFSET: error: NoHeaders can't be used together with Offset/Sections/Excluded
--- !ELF
FileHeader:
Class: ELFCLASS64
Data: ELFDATA2LSB
Type: ET_REL
Sections:
- Name: .foo
Type: SHT_PROGBITS
- Type: SectionHeaderTable
Offset: 0x1000
NoHeaders: [[NOHEADERS]]
## Check we can place the section header table before other sections.
# RUN: yaml2obj %s --docnum=10 -o %t10
# RUN: llvm-readelf --file-headers --sections %t10 | FileCheck %s --check-prefix=PLACE-BEFORE
# PLACE-BEFORE: Start of section headers: 64 (bytes into file)
# PLACE-BEFORE: Size of section headers: 64 (bytes)
# PLACE-BEFORE: Number of section headers: 4
# PLACE-BEFORE: Section Headers:
# PLACE-BEFORE: [Nr] Name Type Address Off Size
## 0x140 == Start of section headers (64) + Size of section headers (64) * Number of section headers (4);
# PLACE-BEFORE: [ 1] .foo PROGBITS 0000000000000000 000140 000000
--- !ELF
FileHeader:
Class: ELFCLASS64
Data: ELFDATA2LSB
Type: ET_REL
Sections:
- Type: SectionHeaderTable
Offset: [[OFFSET=<none>]]
Sections:
- Name: .foo
- Name: .strtab
- Name: .shstrtab
- Name: .foo
Type: SHT_PROGBITS
## Check we can use the Offset key to place the section header table at a different location.
# RUN: yaml2obj %s --docnum=10 -DOFFSET=0x1000 -o %t10.offset
# RUN: llvm-readelf --file-headers --sections %t10.offset | \
# RUN: FileCheck %s --check-prefix=PLACE-BEFORE-OFFSET
# PLACE-BEFORE-OFFSET: Start of section headers: 4096 (bytes into file)
# PLACE-BEFORE-OFFSET: Size of section headers: 64 (bytes)
# PLACE-BEFORE-OFFSET: Number of section headers: 4
# PLACE-BEFORE-OFFSET: Section Headers:
# PLACE-BEFORE-OFFSET: [Nr] Name Type Address Off Size
## 0x1100 == Start of section headers (0x1000) + Size of section headers (64) * Number of section headers (4);
# PLACE-BEFORE-OFFSET: [ 1] .foo PROGBITS 0000000000000000 001100 000000
## Check we can place the section header table somewhere in the middle of the sections list.
# RUN: yaml2obj %s --docnum=11 -o %t11
# RUN: llvm-readelf --sections %t11 | FileCheck %s --check-prefix=PLACE-AT-MIDDLE
# PLACE-AT-MIDDLE: There are 5 section headers, starting at offset 0x140:
# PLACE-AT-MIDDLE: [Nr] Name Type Address Off Size
# PLACE-AT-MIDDLE: [ 1] .foo PROGBITS 0000000000000000 000040 000100
## The section header table is placed here, at 0x40 + 0x100 == 0x140.
## The size of the table is 5 * 64 == 320 == 0x140.
## 0x140 + 0x140 == offset of the .bar section.
# PLACE-AT-MIDDLE-NEXT: [ 2] .bar PROGBITS 0000000000000000 000280 000200
# PLACE-AT-MIDDLE-NEXT: [ 3] .strtab STRTAB 0000000000000000 000480 000001
# PLACE-AT-MIDDLE-NEXT: [ 4] .shstrtab STRTAB 0000000000000000 000481 00001d
--- !ELF
FileHeader:
Class: ELFCLASS64
Data: ELFDATA2LSB
Type: ET_REL
Sections:
- Name: .foo
Type: SHT_PROGBITS
Size: 0x100
- Type: SectionHeaderTable
Sections:
- Name: .foo
- Name: .bar
- Name: .strtab
- Name: .shstrtab
- Name: .bar
Type: SHT_PROGBITS
Size: 0x200
## Check we don`t allow having multiple SectionHeaderTable chunks.
# RUN: not yaml2obj %s --docnum=12 -o /dev/null 2>&1 | FileCheck %s --check-prefix=MULTIPLE
# MULTIPLE: error: multiple section header tables are not allowed
--- !ELF
FileHeader:
Class: ELFCLASS64
Data: ELFDATA2LSB
Type: ET_REL
Sections:
- Type: SectionHeaderTable
Sections: []
- Type: SectionHeaderTable
Sections: []
## Check that we place implicit sections before the section header table
## when it is placed at the end explicitly.
# RUN: yaml2obj %s --docnum=13 -o %t13
# RUN: llvm-readelf --sections %t13 | FileCheck %s --check-prefix=IMPLICIT
# IMPLICIT: There are 3 section headers, starting at offset 0x58:
# IMPLICIT: [Nr] Name Type Address Off Size
# IMPLICIT: [ 1] .strtab STRTAB 0000000000000000 000040 000001
# IMPLICIT-NEXT: [ 2] .shstrtab STRTAB 0000000000000000 000041 000013
## The section header table is placed here, at 0x58.
## alignTo(8, 0x41 + 0x13) == 0x58.
--- !ELF
FileHeader:
Class: ELFCLASS64
Data: ELFDATA2LSB
Type: ET_REL
Sections:
- Type: SectionHeaderTable
Sections:
- Name: .strtab
- Name: .shstrtab