Skip to content

Commit d58e383

Browse files
author
Georgii Rymar
committed
[obj2yaml] - Dump allocatable SHT_STRTAB, SHT_SYMTAB and SHT_DYNSYM sections.
Sometimes we need to dump an object and build it again from a YAML description produced. The problem is that obj2yaml does not dump some of sections, like string tables and symbol tables. Because of that yaml2obj implicitly creates them and sections created are not placed at their original locations. They are added to the end of a section list. That makes a preparing test cases task harder than it can be. This patch teaches obj2yaml to dump parts of allocatable SHT_STRTAB, SHT_SYMTAB and SHT_DYNSYM sections to print placeholders for them. This also allows to preserve usefull parameters, like virtual address. Differential revision: https://reviews.llvm.org/D74955
1 parent 9e1443e commit d58e383

File tree

4 files changed

+181
-10
lines changed

4 files changed

+181
-10
lines changed

‎llvm/test/tools/obj2yaml/duplicate-symbol-and-section-names.test

+1-7
Original file line numberDiff line numberDiff line change
@@ -125,13 +125,7 @@ Symbols:
125125
# RUN: yaml2obj --docnum=3 %s -o %t3
126126
# RUN: obj2yaml %t3 | FileCheck %s --check-prefix=CASE3
127127

128-
# CASE3: --- !ELF
129-
# CASE3-NEXT: FileHeader:
130-
# CASE3-NEXT: Class: ELFCLASS64
131-
# CASE3-NEXT: Data: ELFDATA2LSB
132-
# CASE3-NEXT: Type: ET_DYN
133-
# CASE3-NEXT: Machine: EM_X86_64
134-
# CASE3-NEXT: Symbols:
128+
# CASE3: Symbols:
135129
# CASE3-NEXT: - Name: foo
136130
# CASE3-NEXT: Binding: STB_GLOBAL
137131
# CASE3-NEXT: DynamicSymbols:

‎llvm/test/tools/obj2yaml/implicit-sections-order.yaml

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
## Check that obj2yaml dumps SHT_STRTAB/SHT_SYMTAB/SHT_DYNSYM sections
2+
## when they are allocatable.
3+
4+
## In the following test we check the normal case: when .dynsym (SHT_DYNSYM)
5+
## and .dynstr (SHT_STRTAB) are allocatable sections and .symtab (SHT_SYMTAB),
6+
## .strtab (SHT_STRTAB) and .shstrtab (SHT_STRTAB) are not.
7+
## Check we explicitly declare allocatable sections.
8+
9+
# RUN: yaml2obj %s -o %t1.so -D FLAG1=SHF_ALLOC -D FLAG2=""
10+
# RUN: llvm-readelf -S %t1.so | FileCheck %s --check-prefixes=RE,RE-1
11+
# RUN: obj2yaml %t1.so | FileCheck %s --check-prefix=OUTPUT
12+
13+
## Check the information about sections using an independent tool.
14+
15+
# RE: Section Headers:
16+
# RE-NEXT: [Nr] Name Type Address Off Size ES Flg Lk Inf Al
17+
# RE-NEXT: [ 0] NULL 0000000000000000 000000 000000 00 0 0 0
18+
# RE-NEXT: [ 1] .foo.1 PROGBITS 0000000000000000 000040 000000 00 0 0 0
19+
# RE-1-NEXT: [ 2] .dynsym DYNSYM 0000000000001000 000040 000030 18 A 4 2 0
20+
# RE-2-NEXT: [ 2] .dynsym DYNSYM 0000000000001000 000040 000030 18 4 2 0
21+
# RE-NEXT: [ 3] .foo.2 PROGBITS 0000000000000000 000070 000000 00 0 0 0
22+
# RE-1-NEXT: [ 4] .dynstr STRTAB 0000000000002000 000070 000005 00 A 0 0 0
23+
# RE-2-NEXT: [ 4] .dynstr STRTAB 0000000000002000 000070 000005 00 0 0 0
24+
# RE-NEXT: [ 5] .foo.3 PROGBITS 0000000000000000 000075 000000 00 0 0 0
25+
# RE-1-NEXT: [ 6] .symtab SYMTAB 0000000000003000 000075 000030 18 8 2 0
26+
# RE-2-NEXT: [ 6] .symtab SYMTAB 0000000000003000 000075 000030 18 A 8 2 0
27+
# RE-NEXT: [ 7] .foo.4 PROGBITS 0000000000000000 0000a5 000000 00 0 0 0
28+
# RE-1-NEXT: [ 8] .strtab STRTAB 0000000000004000 0000a5 000005 00 0 0 0
29+
# RE-2-NEXT: [ 8] .strtab STRTAB 0000000000004000 0000a5 000005 00 A 0 0 0
30+
# RE-NEXT: [ 9] .foo.5 PROGBITS 0000000000000000 0000aa 000000 00 0 0 0
31+
# RE-1-NEXT: [10] .shstrtab STRTAB 0000000000005000 0000aa 000055 00 0 0 0
32+
# RE-2-NEXT: [10] .shstrtab STRTAB 0000000000005000 0000aa 000055 00 A 0 0 0
33+
# RE-NEXT: [11] .foo.6 PROGBITS 0000000000000000 0000ff 000000 00 0 0 0
34+
35+
# OUTPUT: --- !ELF
36+
# OUTPUT-NEXT: FileHeader:
37+
# OUTPUT-NEXT: Class: ELFCLASS64
38+
# OUTPUT-NEXT: Data: ELFDATA2LSB
39+
# OUTPUT-NEXT: Type: ET_DYN
40+
# OUTPUT-NEXT: Machine: EM_X86_64
41+
# OUTPUT-NEXT: Sections:
42+
# OUTPUT-NEXT: - Name: .foo.1
43+
# OUTPUT-NEXT: Type: SHT_PROGBITS
44+
# OUTPUT-NEXT: - Name: .dynsym
45+
# OUTPUT-NEXT: Type: SHT_DYNSYM
46+
# OUTPUT-NEXT: Flags: [ SHF_ALLOC ]
47+
# OUTPUT-NEXT: Address: 0x0000000000001000
48+
# OUTPUT-NEXT: Link: .dynstr
49+
# OUTPUT-NEXT: EntSize: 0x0000000000000018
50+
# OUTPUT-NEXT: - Name: .foo.2
51+
# OUTPUT-NEXT: Type: SHT_PROGBITS
52+
# OUTPUT-NEXT: - Name: .dynstr
53+
# OUTPUT-NEXT: Type: SHT_STRTAB
54+
# OUTPUT-NEXT: Flags: [ SHF_ALLOC ]
55+
# OUTPUT-NEXT: Address: 0x0000000000002000
56+
# OUTPUT-NEXT: - Name: .foo.3
57+
# OUTPUT-NEXT: Type: SHT_PROGBITS
58+
# OUTPUT-NEXT: - Name: .foo.4
59+
# OUTPUT-NEXT: Type: SHT_PROGBITS
60+
# OUTPUT-NEXT: - Name: .foo.5
61+
# OUTPUT-NEXT: Type: SHT_PROGBITS
62+
# OUTPUT-NEXT: - Name: .foo.6
63+
# OUTPUT-NEXT: Type: SHT_PROGBITS
64+
# OUTPUT-NEXT: Symbols:
65+
# OUTPUT-NEXT: - Name: foo
66+
# OUTPUT-NEXT: DynamicSymbols:
67+
# OUTPUT-NEXT: - Name: bar
68+
# OUTPUT-NEXT: ...
69+
70+
--- !ELF
71+
FileHeader:
72+
Class: ELFCLASS64
73+
Data: ELFDATA2LSB
74+
Type: ET_DYN
75+
Machine: EM_X86_64
76+
Sections:
77+
- Name: .foo.1
78+
Type: SHT_PROGBITS
79+
- Name: .dynsym
80+
Type: SHT_DYNSYM
81+
Address: 0x1000
82+
Flags: [ [[FLAG1]] ]
83+
- Name: .foo.2
84+
Type: SHT_PROGBITS
85+
- Name: .dynstr
86+
Type: SHT_STRTAB
87+
Address: 0x2000
88+
Flags: [ [[FLAG1]] ]
89+
- Name: .foo.3
90+
Type: SHT_PROGBITS
91+
- Name: .symtab
92+
Type: SHT_SYMTAB
93+
Address: 0x3000
94+
Flags: [ [[FLAG2]] ]
95+
- Name: .foo.4
96+
Type: SHT_PROGBITS
97+
- Name: .strtab
98+
Type: SHT_STRTAB
99+
Address: 0x4000
100+
Flags: [ [[FLAG2]] ]
101+
- Name: .foo.5
102+
Type: SHT_PROGBITS
103+
- Name: .shstrtab
104+
Type: SHT_STRTAB
105+
Address: 0x5000
106+
Flags: [ [[FLAG2]] ]
107+
- Name: .foo.6
108+
Type: SHT_PROGBITS
109+
Symbols:
110+
- Name: foo
111+
DynamicSymbols:
112+
- Name: bar
113+
114+
## Now test the abnormal case: when .symtab (SHT_SYMTAB),
115+
## .strtab (SHT_STRTAB) and .shstrtab (SHT_STRTAB) are
116+
## allocatable sections, but .dynsym (SHT_DYNSYM) and
117+
## .dynstr (SHT_STRTAB) are not.
118+
## Check that only allocatable versions are explicitly declared.
119+
120+
# RUN: yaml2obj %s -o %t2.so -D FLAG1="" -D FLAG2=SHF_ALLOC
121+
# RUN: llvm-readelf -S %t2.so | FileCheck %s --check-prefixes=RE,RE-2
122+
# RUN: obj2yaml %t2.so | FileCheck %s --check-prefix=OUTPUT2
123+
124+
## Check we explicitly declare only allocatable
125+
## SHT_STRTAB/SHT_SYMTAB/SHT_DYNSYM sections.
126+
# OUTPUT2: --- !ELF
127+
# OUTPUT2-NEXT: FileHeader:
128+
# OUTPUT2-NEXT: Class: ELFCLASS64
129+
# OUTPUT2-NEXT: Data: ELFDATA2LSB
130+
# OUTPUT2-NEXT: Type: ET_DYN
131+
# OUTPUT2-NEXT: Machine: EM_X86_64
132+
# OUTPUT2-NEXT: Sections:
133+
# OUTPUT2-NEXT: - Name: .foo.1
134+
# OUTPUT2-NEXT: Type: SHT_PROGBITS
135+
# OUTPUT2-NEXT: - Name: .foo.2
136+
# OUTPUT2-NEXT: Type: SHT_PROGBITS
137+
# OUTPUT2-NEXT: - Name: .foo.3
138+
# OUTPUT2-NEXT: Type: SHT_PROGBITS
139+
# OUTPUT2-NEXT: - Name: .symtab
140+
# OUTPUT2-NEXT: Type: SHT_SYMTAB
141+
# OUTPUT2-NEXT: Flags: [ SHF_ALLOC ]
142+
# OUTPUT2-NEXT: Address: 0x0000000000003000
143+
# OUTPUT2-NEXT: Link: .strtab
144+
# OUTPUT2-NEXT: EntSize: 0x0000000000000018
145+
# OUTPUT2-NEXT: - Name: .foo.4
146+
# OUTPUT2-NEXT: Type: SHT_PROGBITS
147+
# OUTPUT2-NEXT: - Name: .strtab
148+
# OUTPUT2-NEXT: Type: SHT_STRTAB
149+
# OUTPUT2-NEXT: Flags: [ SHF_ALLOC ]
150+
# OUTPUT2-NEXT: Address: 0x0000000000004000
151+
# OUTPUT2-NEXT: - Name: .foo.5
152+
# OUTPUT2-NEXT: Type: SHT_PROGBITS
153+
# OUTPUT2-NEXT: - Name: .shstrtab
154+
# OUTPUT2-NEXT: Type: SHT_STRTAB
155+
# OUTPUT2-NEXT: Flags: [ SHF_ALLOC ]
156+
# OUTPUT2-NEXT: Address: 0x0000000000005000
157+
# OUTPUT2-NEXT: - Name: .foo.6
158+
# OUTPUT2-NEXT: Type: SHT_PROGBITS
159+
# OUTPUT2-NEXT: Symbols:
160+
# OUTPUT2-NEXT: - Name: foo
161+
# OUTPUT2-NEXT: DynamicSymbols:
162+
# OUTPUT2-NEXT: - Name: bar
163+
# OUTPUT2-NEXT: ...

‎llvm/test/tools/obj2yaml/versym-section.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
# CHECK-NEXT: AddressAlign: 0x0000000000000002
2020
# CHECK-NEXT: EntSize: 0x0000000000000002
2121
# CHECK-NEXT: Entries: [ 0, 3, 4 ]
22-
# CHECK-NEXT: DynamicSymbols:
22+
# CHECK-NEXT: - Name:
23+
# CHECK: DynamicSymbols:
2324
# CHECK-NEXT: - Name: f1
2425
# CHECK-NEXT: Binding: STB_GLOBAL
2526
# CHECK-NEXT: - Name: f2

‎llvm/tools/obj2yaml/elf2yaml.cpp

+15-2
Original file line numberDiff line numberDiff line change
@@ -254,9 +254,22 @@ ELFDumper<ELFT>::dumpSections() {
254254
}
255255
case ELF::SHT_STRTAB:
256256
case ELF::SHT_SYMTAB:
257-
case ELF::SHT_DYNSYM:
258-
// Do not dump these sections.
257+
case ELF::SHT_DYNSYM: {
258+
// The contents of these sections are described by other parts of the YAML
259+
// file. We still dump them so that their positions in the section header
260+
// table are correctly recorded. We only dump allocatable section because
261+
// their positions and addresses are important, e.g. for creating program
262+
// headers. Some sections, like .symtab or .strtab normally are not
263+
// allocatable and do not have virtual addresses. We want to avoid noise
264+
// in the YAML output and assume that they are placed at the end.
265+
if (Sec.sh_flags & ELF::SHF_ALLOC) {
266+
auto S = std::make_unique<ELFYAML::RawContentSection>();
267+
if (Error E = dumpCommonSection(&Sec, *S.get()))
268+
return std::move(E);
269+
Ret.emplace_back(std::move(S));
270+
}
259271
break;
272+
}
260273
case ELF::SHT_SYMTAB_SHNDX: {
261274
Expected<ELFYAML::SymtabShndxSection *> SecOrErr =
262275
dumpSymtabShndxSection(&Sec);

0 commit comments

Comments
 (0)