1 //===- ELFYAML.cpp - ELF YAMLIO implementation ----------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines classes for handling the YAML representation of ELF.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/ObjectYAML/ELFYAML.h"
14 #include "llvm/ADT/MapVector.h"
15 #include "llvm/ADT/StringRef.h"
16 #include "llvm/BinaryFormat/ELF.h"
17 #include "llvm/Support/Casting.h"
18 #include "llvm/Support/ErrorHandling.h"
19 #include "llvm/Support/MipsABIFlags.h"
20 #include "llvm/Support/YAMLTraits.h"
21 #include "llvm/Support/WithColor.h"
22 #include <cassert>
23 #include <cstdint>
24 
25 namespace llvm {
26 
27 ELFYAML::Chunk::~Chunk() = default;
28 
29 namespace ELFYAML {
30 unsigned Object::getMachine() const {
31   if (Header.Machine)
32     return *Header.Machine;
33   return llvm::ELF::EM_NONE;
34 }
35 } // namespace ELFYAML
36 
37 namespace yaml {
38 
39 void ScalarEnumerationTraits<ELFYAML::ELF_ET>::enumeration(
40     IO &IO, ELFYAML::ELF_ET &Value) {
41 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
42   ECase(ET_NONE);
43   ECase(ET_REL);
44   ECase(ET_EXEC);
45   ECase(ET_DYN);
46   ECase(ET_CORE);
47 #undef ECase
48   IO.enumFallback<Hex16>(Value);
49 }
50 
51 void ScalarEnumerationTraits<ELFYAML::ELF_PT>::enumeration(
52     IO &IO, ELFYAML::ELF_PT &Value) {
53 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
54   ECase(PT_NULL);
55   ECase(PT_LOAD);
56   ECase(PT_DYNAMIC);
57   ECase(PT_INTERP);
58   ECase(PT_NOTE);
59   ECase(PT_SHLIB);
60   ECase(PT_PHDR);
61   ECase(PT_TLS);
62   ECase(PT_GNU_EH_FRAME);
63   ECase(PT_GNU_STACK);
64   ECase(PT_GNU_RELRO);
65   ECase(PT_GNU_PROPERTY);
66 #undef ECase
67   IO.enumFallback<Hex32>(Value);
68 }
69 
70 void ScalarEnumerationTraits<ELFYAML::ELF_EM>::enumeration(
71     IO &IO, ELFYAML::ELF_EM &Value) {
72 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
73   ECase(EM_NONE);
74   ECase(EM_M32);
75   ECase(EM_SPARC);
76   ECase(EM_386);
77   ECase(EM_68K);
78   ECase(EM_88K);
79   ECase(EM_IAMCU);
80   ECase(EM_860);
81   ECase(EM_MIPS);
82   ECase(EM_S370);
83   ECase(EM_MIPS_RS3_LE);
84   ECase(EM_PARISC);
85   ECase(EM_VPP500);
86   ECase(EM_SPARC32PLUS);
87   ECase(EM_960);
88   ECase(EM_PPC);
89   ECase(EM_PPC64);
90   ECase(EM_S390);
91   ECase(EM_SPU);
92   ECase(EM_V800);
93   ECase(EM_FR20);
94   ECase(EM_RH32);
95   ECase(EM_RCE);
96   ECase(EM_ARM);
97   ECase(EM_ALPHA);
98   ECase(EM_SH);
99   ECase(EM_SPARCV9);
100   ECase(EM_TRICORE);
101   ECase(EM_ARC);
102   ECase(EM_H8_300);
103   ECase(EM_H8_300H);
104   ECase(EM_H8S);
105   ECase(EM_H8_500);
106   ECase(EM_IA_64);
107   ECase(EM_MIPS_X);
108   ECase(EM_COLDFIRE);
109   ECase(EM_68HC12);
110   ECase(EM_MMA);
111   ECase(EM_PCP);
112   ECase(EM_NCPU);
113   ECase(EM_NDR1);
114   ECase(EM_STARCORE);
115   ECase(EM_ME16);
116   ECase(EM_ST100);
117   ECase(EM_TINYJ);
118   ECase(EM_X86_64);
119   ECase(EM_PDSP);
120   ECase(EM_PDP10);
121   ECase(EM_PDP11);
122   ECase(EM_FX66);
123   ECase(EM_ST9PLUS);
124   ECase(EM_ST7);
125   ECase(EM_68HC16);
126   ECase(EM_68HC11);
127   ECase(EM_68HC08);
128   ECase(EM_68HC05);
129   ECase(EM_SVX);
130   ECase(EM_ST19);
131   ECase(EM_VAX);
132   ECase(EM_CRIS);
133   ECase(EM_JAVELIN);
134   ECase(EM_FIREPATH);
135   ECase(EM_ZSP);
136   ECase(EM_MMIX);
137   ECase(EM_HUANY);
138   ECase(EM_PRISM);
139   ECase(EM_AVR);
140   ECase(EM_FR30);
141   ECase(EM_D10V);
142   ECase(EM_D30V);
143   ECase(EM_V850);
144   ECase(EM_M32R);
145   ECase(EM_MN10300);
146   ECase(EM_MN10200);
147   ECase(EM_PJ);
148   ECase(EM_OPENRISC);
149   ECase(EM_ARC_COMPACT);
150   ECase(EM_XTENSA);
151   ECase(EM_VIDEOCORE);
152   ECase(EM_TMM_GPP);
153   ECase(EM_NS32K);
154   ECase(EM_TPC);
155   ECase(EM_SNP1K);
156   ECase(EM_ST200);
157   ECase(EM_IP2K);
158   ECase(EM_MAX);
159   ECase(EM_CR);
160   ECase(EM_F2MC16);
161   ECase(EM_MSP430);
162   ECase(EM_BLACKFIN);
163   ECase(EM_SE_C33);
164   ECase(EM_SEP);
165   ECase(EM_ARCA);
166   ECase(EM_UNICORE);
167   ECase(EM_EXCESS);
168   ECase(EM_DXP);
169   ECase(EM_ALTERA_NIOS2);
170   ECase(EM_CRX);
171   ECase(EM_XGATE);
172   ECase(EM_C166);
173   ECase(EM_M16C);
174   ECase(EM_DSPIC30F);
175   ECase(EM_CE);
176   ECase(EM_M32C);
177   ECase(EM_TSK3000);
178   ECase(EM_RS08);
179   ECase(EM_SHARC);
180   ECase(EM_ECOG2);
181   ECase(EM_SCORE7);
182   ECase(EM_DSP24);
183   ECase(EM_VIDEOCORE3);
184   ECase(EM_LATTICEMICO32);
185   ECase(EM_SE_C17);
186   ECase(EM_TI_C6000);
187   ECase(EM_TI_C2000);
188   ECase(EM_TI_C5500);
189   ECase(EM_MMDSP_PLUS);
190   ECase(EM_CYPRESS_M8C);
191   ECase(EM_R32C);
192   ECase(EM_TRIMEDIA);
193   ECase(EM_HEXAGON);
194   ECase(EM_8051);
195   ECase(EM_STXP7X);
196   ECase(EM_NDS32);
197   ECase(EM_ECOG1);
198   ECase(EM_ECOG1X);
199   ECase(EM_MAXQ30);
200   ECase(EM_XIMO16);
201   ECase(EM_MANIK);
202   ECase(EM_CRAYNV2);
203   ECase(EM_RX);
204   ECase(EM_METAG);
205   ECase(EM_MCST_ELBRUS);
206   ECase(EM_ECOG16);
207   ECase(EM_CR16);
208   ECase(EM_ETPU);
209   ECase(EM_SLE9X);
210   ECase(EM_L10M);
211   ECase(EM_K10M);
212   ECase(EM_AARCH64);
213   ECase(EM_AVR32);
214   ECase(EM_STM8);
215   ECase(EM_TILE64);
216   ECase(EM_TILEPRO);
217   ECase(EM_CUDA);
218   ECase(EM_TILEGX);
219   ECase(EM_CLOUDSHIELD);
220   ECase(EM_COREA_1ST);
221   ECase(EM_COREA_2ND);
222   ECase(EM_ARC_COMPACT2);
223   ECase(EM_OPEN8);
224   ECase(EM_RL78);
225   ECase(EM_VIDEOCORE5);
226   ECase(EM_78KOR);
227   ECase(EM_56800EX);
228   ECase(EM_AMDGPU);
229   ECase(EM_RISCV);
230   ECase(EM_LANAI);
231   ECase(EM_BPF);
232   ECase(EM_VE);
233   ECase(EM_CSKY);
234 #undef ECase
235   IO.enumFallback<Hex16>(Value);
236 }
237 
238 void ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS>::enumeration(
239     IO &IO, ELFYAML::ELF_ELFCLASS &Value) {
240 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
241   // Since the semantics of ELFCLASSNONE is "invalid", just don't accept it
242   // here.
243   ECase(ELFCLASS32);
244   ECase(ELFCLASS64);
245 #undef ECase
246 }
247 
248 void ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA>::enumeration(
249     IO &IO, ELFYAML::ELF_ELFDATA &Value) {
250 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
251   // ELFDATANONE is an invalid data encoding, but we accept it because
252   // we want to be able to produce invalid binaries for the tests.
253   ECase(ELFDATANONE);
254   ECase(ELFDATA2LSB);
255   ECase(ELFDATA2MSB);
256 #undef ECase
257 }
258 
259 void ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI>::enumeration(
260     IO &IO, ELFYAML::ELF_ELFOSABI &Value) {
261 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
262   ECase(ELFOSABI_NONE);
263   ECase(ELFOSABI_HPUX);
264   ECase(ELFOSABI_NETBSD);
265   ECase(ELFOSABI_GNU);
266   ECase(ELFOSABI_LINUX);
267   ECase(ELFOSABI_HURD);
268   ECase(ELFOSABI_SOLARIS);
269   ECase(ELFOSABI_AIX);
270   ECase(ELFOSABI_IRIX);
271   ECase(ELFOSABI_FREEBSD);
272   ECase(ELFOSABI_TRU64);
273   ECase(ELFOSABI_MODESTO);
274   ECase(ELFOSABI_OPENBSD);
275   ECase(ELFOSABI_OPENVMS);
276   ECase(ELFOSABI_NSK);
277   ECase(ELFOSABI_AROS);
278   ECase(ELFOSABI_FENIXOS);
279   ECase(ELFOSABI_CLOUDABI);
280   ECase(ELFOSABI_AMDGPU_HSA);
281   ECase(ELFOSABI_AMDGPU_PAL);
282   ECase(ELFOSABI_AMDGPU_MESA3D);
283   ECase(ELFOSABI_ARM);
284   ECase(ELFOSABI_C6000_ELFABI);
285   ECase(ELFOSABI_C6000_LINUX);
286   ECase(ELFOSABI_STANDALONE);
287 #undef ECase
288   IO.enumFallback<Hex8>(Value);
289 }
290 
291 void ScalarBitSetTraits<ELFYAML::ELF_EF>::bitset(IO &IO,
292                                                  ELFYAML::ELF_EF &Value) {
293   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
294   assert(Object && "The IO context is not initialized");
295 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
296 #define BCaseMask(X, M) IO.maskedBitSetCase(Value, #X, ELF::X, ELF::M)
297   switch (Object->getMachine()) {
298   case ELF::EM_ARM:
299     BCase(EF_ARM_SOFT_FLOAT);
300     BCase(EF_ARM_VFP_FLOAT);
301     BCaseMask(EF_ARM_EABI_UNKNOWN, EF_ARM_EABIMASK);
302     BCaseMask(EF_ARM_EABI_VER1, EF_ARM_EABIMASK);
303     BCaseMask(EF_ARM_EABI_VER2, EF_ARM_EABIMASK);
304     BCaseMask(EF_ARM_EABI_VER3, EF_ARM_EABIMASK);
305     BCaseMask(EF_ARM_EABI_VER4, EF_ARM_EABIMASK);
306     BCaseMask(EF_ARM_EABI_VER5, EF_ARM_EABIMASK);
307     break;
308   case ELF::EM_MIPS:
309     BCase(EF_MIPS_NOREORDER);
310     BCase(EF_MIPS_PIC);
311     BCase(EF_MIPS_CPIC);
312     BCase(EF_MIPS_ABI2);
313     BCase(EF_MIPS_32BITMODE);
314     BCase(EF_MIPS_FP64);
315     BCase(EF_MIPS_NAN2008);
316     BCase(EF_MIPS_MICROMIPS);
317     BCase(EF_MIPS_ARCH_ASE_M16);
318     BCase(EF_MIPS_ARCH_ASE_MDMX);
319     BCaseMask(EF_MIPS_ABI_O32, EF_MIPS_ABI);
320     BCaseMask(EF_MIPS_ABI_O64, EF_MIPS_ABI);
321     BCaseMask(EF_MIPS_ABI_EABI32, EF_MIPS_ABI);
322     BCaseMask(EF_MIPS_ABI_EABI64, EF_MIPS_ABI);
323     BCaseMask(EF_MIPS_MACH_3900, EF_MIPS_MACH);
324     BCaseMask(EF_MIPS_MACH_4010, EF_MIPS_MACH);
325     BCaseMask(EF_MIPS_MACH_4100, EF_MIPS_MACH);
326     BCaseMask(EF_MIPS_MACH_4650, EF_MIPS_MACH);
327     BCaseMask(EF_MIPS_MACH_4120, EF_MIPS_MACH);
328     BCaseMask(EF_MIPS_MACH_4111, EF_MIPS_MACH);
329     BCaseMask(EF_MIPS_MACH_SB1, EF_MIPS_MACH);
330     BCaseMask(EF_MIPS_MACH_OCTEON, EF_MIPS_MACH);
331     BCaseMask(EF_MIPS_MACH_XLR, EF_MIPS_MACH);
332     BCaseMask(EF_MIPS_MACH_OCTEON2, EF_MIPS_MACH);
333     BCaseMask(EF_MIPS_MACH_OCTEON3, EF_MIPS_MACH);
334     BCaseMask(EF_MIPS_MACH_5400, EF_MIPS_MACH);
335     BCaseMask(EF_MIPS_MACH_5900, EF_MIPS_MACH);
336     BCaseMask(EF_MIPS_MACH_5500, EF_MIPS_MACH);
337     BCaseMask(EF_MIPS_MACH_9000, EF_MIPS_MACH);
338     BCaseMask(EF_MIPS_MACH_LS2E, EF_MIPS_MACH);
339     BCaseMask(EF_MIPS_MACH_LS2F, EF_MIPS_MACH);
340     BCaseMask(EF_MIPS_MACH_LS3A, EF_MIPS_MACH);
341     BCaseMask(EF_MIPS_ARCH_1, EF_MIPS_ARCH);
342     BCaseMask(EF_MIPS_ARCH_2, EF_MIPS_ARCH);
343     BCaseMask(EF_MIPS_ARCH_3, EF_MIPS_ARCH);
344     BCaseMask(EF_MIPS_ARCH_4, EF_MIPS_ARCH);
345     BCaseMask(EF_MIPS_ARCH_5, EF_MIPS_ARCH);
346     BCaseMask(EF_MIPS_ARCH_32, EF_MIPS_ARCH);
347     BCaseMask(EF_MIPS_ARCH_64, EF_MIPS_ARCH);
348     BCaseMask(EF_MIPS_ARCH_32R2, EF_MIPS_ARCH);
349     BCaseMask(EF_MIPS_ARCH_64R2, EF_MIPS_ARCH);
350     BCaseMask(EF_MIPS_ARCH_32R6, EF_MIPS_ARCH);
351     BCaseMask(EF_MIPS_ARCH_64R6, EF_MIPS_ARCH);
352     break;
353   case ELF::EM_HEXAGON:
354     BCase(EF_HEXAGON_MACH_V2);
355     BCase(EF_HEXAGON_MACH_V3);
356     BCase(EF_HEXAGON_MACH_V4);
357     BCase(EF_HEXAGON_MACH_V5);
358     BCase(EF_HEXAGON_MACH_V55);
359     BCase(EF_HEXAGON_MACH_V60);
360     BCase(EF_HEXAGON_MACH_V62);
361     BCase(EF_HEXAGON_MACH_V65);
362     BCase(EF_HEXAGON_MACH_V66);
363     BCase(EF_HEXAGON_MACH_V67);
364     BCase(EF_HEXAGON_MACH_V67T);
365     BCase(EF_HEXAGON_ISA_V2);
366     BCase(EF_HEXAGON_ISA_V3);
367     BCase(EF_HEXAGON_ISA_V4);
368     BCase(EF_HEXAGON_ISA_V5);
369     BCase(EF_HEXAGON_ISA_V55);
370     BCase(EF_HEXAGON_ISA_V60);
371     BCase(EF_HEXAGON_ISA_V62);
372     BCase(EF_HEXAGON_ISA_V65);
373     BCase(EF_HEXAGON_ISA_V66);
374     BCase(EF_HEXAGON_ISA_V67);
375     break;
376   case ELF::EM_AVR:
377     BCase(EF_AVR_ARCH_AVR1);
378     BCase(EF_AVR_ARCH_AVR2);
379     BCase(EF_AVR_ARCH_AVR25);
380     BCase(EF_AVR_ARCH_AVR3);
381     BCase(EF_AVR_ARCH_AVR31);
382     BCase(EF_AVR_ARCH_AVR35);
383     BCase(EF_AVR_ARCH_AVR4);
384     BCase(EF_AVR_ARCH_AVR51);
385     BCase(EF_AVR_ARCH_AVR6);
386     BCase(EF_AVR_ARCH_AVRTINY);
387     BCase(EF_AVR_ARCH_XMEGA1);
388     BCase(EF_AVR_ARCH_XMEGA2);
389     BCase(EF_AVR_ARCH_XMEGA3);
390     BCase(EF_AVR_ARCH_XMEGA4);
391     BCase(EF_AVR_ARCH_XMEGA5);
392     BCase(EF_AVR_ARCH_XMEGA6);
393     BCase(EF_AVR_ARCH_XMEGA7);
394     break;
395   case ELF::EM_RISCV:
396     BCase(EF_RISCV_RVC);
397     BCaseMask(EF_RISCV_FLOAT_ABI_SOFT, EF_RISCV_FLOAT_ABI);
398     BCaseMask(EF_RISCV_FLOAT_ABI_SINGLE, EF_RISCV_FLOAT_ABI);
399     BCaseMask(EF_RISCV_FLOAT_ABI_DOUBLE, EF_RISCV_FLOAT_ABI);
400     BCaseMask(EF_RISCV_FLOAT_ABI_QUAD, EF_RISCV_FLOAT_ABI);
401     BCase(EF_RISCV_RVE);
402     break;
403   case ELF::EM_AMDGPU:
404     BCaseMask(EF_AMDGPU_MACH_NONE, EF_AMDGPU_MACH);
405     BCaseMask(EF_AMDGPU_MACH_R600_R600, EF_AMDGPU_MACH);
406     BCaseMask(EF_AMDGPU_MACH_R600_R630, EF_AMDGPU_MACH);
407     BCaseMask(EF_AMDGPU_MACH_R600_RS880, EF_AMDGPU_MACH);
408     BCaseMask(EF_AMDGPU_MACH_R600_RV670, EF_AMDGPU_MACH);
409     BCaseMask(EF_AMDGPU_MACH_R600_RV710, EF_AMDGPU_MACH);
410     BCaseMask(EF_AMDGPU_MACH_R600_RV730, EF_AMDGPU_MACH);
411     BCaseMask(EF_AMDGPU_MACH_R600_RV770, EF_AMDGPU_MACH);
412     BCaseMask(EF_AMDGPU_MACH_R600_CEDAR, EF_AMDGPU_MACH);
413     BCaseMask(EF_AMDGPU_MACH_R600_CYPRESS, EF_AMDGPU_MACH);
414     BCaseMask(EF_AMDGPU_MACH_R600_JUNIPER, EF_AMDGPU_MACH);
415     BCaseMask(EF_AMDGPU_MACH_R600_REDWOOD, EF_AMDGPU_MACH);
416     BCaseMask(EF_AMDGPU_MACH_R600_SUMO, EF_AMDGPU_MACH);
417     BCaseMask(EF_AMDGPU_MACH_R600_BARTS, EF_AMDGPU_MACH);
418     BCaseMask(EF_AMDGPU_MACH_R600_CAICOS, EF_AMDGPU_MACH);
419     BCaseMask(EF_AMDGPU_MACH_R600_CAYMAN, EF_AMDGPU_MACH);
420     BCaseMask(EF_AMDGPU_MACH_R600_TURKS, EF_AMDGPU_MACH);
421     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX600, EF_AMDGPU_MACH);
422     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX601, EF_AMDGPU_MACH);
423     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX700, EF_AMDGPU_MACH);
424     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX701, EF_AMDGPU_MACH);
425     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX702, EF_AMDGPU_MACH);
426     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX703, EF_AMDGPU_MACH);
427     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX704, EF_AMDGPU_MACH);
428     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX801, EF_AMDGPU_MACH);
429     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX802, EF_AMDGPU_MACH);
430     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX803, EF_AMDGPU_MACH);
431     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX810, EF_AMDGPU_MACH);
432     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX900, EF_AMDGPU_MACH);
433     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX902, EF_AMDGPU_MACH);
434     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX904, EF_AMDGPU_MACH);
435     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX906, EF_AMDGPU_MACH);
436     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX908, EF_AMDGPU_MACH);
437     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX909, EF_AMDGPU_MACH);
438     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1010, EF_AMDGPU_MACH);
439     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1011, EF_AMDGPU_MACH);
440     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1012, EF_AMDGPU_MACH);
441     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1030, EF_AMDGPU_MACH);
442     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1031, EF_AMDGPU_MACH);
443     BCase(EF_AMDGPU_XNACK);
444     BCase(EF_AMDGPU_SRAM_ECC);
445     break;
446   default:
447     break;
448   }
449 #undef BCase
450 #undef BCaseMask
451 }
452 
453 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
454     IO &IO, ELFYAML::ELF_SHT &Value) {
455   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
456   assert(Object && "The IO context is not initialized");
457 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
458   ECase(SHT_NULL);
459   ECase(SHT_PROGBITS);
460   ECase(SHT_SYMTAB);
461   // FIXME: Issue a diagnostic with this information.
462   ECase(SHT_STRTAB);
463   ECase(SHT_RELA);
464   ECase(SHT_HASH);
465   ECase(SHT_DYNAMIC);
466   ECase(SHT_NOTE);
467   ECase(SHT_NOBITS);
468   ECase(SHT_REL);
469   ECase(SHT_SHLIB);
470   ECase(SHT_DYNSYM);
471   ECase(SHT_INIT_ARRAY);
472   ECase(SHT_FINI_ARRAY);
473   ECase(SHT_PREINIT_ARRAY);
474   ECase(SHT_GROUP);
475   ECase(SHT_SYMTAB_SHNDX);
476   ECase(SHT_RELR);
477   ECase(SHT_ANDROID_REL);
478   ECase(SHT_ANDROID_RELA);
479   ECase(SHT_ANDROID_RELR);
480   ECase(SHT_LLVM_ODRTAB);
481   ECase(SHT_LLVM_LINKER_OPTIONS);
482   ECase(SHT_LLVM_CALL_GRAPH_PROFILE);
483   ECase(SHT_LLVM_ADDRSIG);
484   ECase(SHT_LLVM_DEPENDENT_LIBRARIES);
485   ECase(SHT_LLVM_SYMPART);
486   ECase(SHT_LLVM_PART_EHDR);
487   ECase(SHT_LLVM_PART_PHDR);
488   ECase(SHT_GNU_ATTRIBUTES);
489   ECase(SHT_GNU_HASH);
490   ECase(SHT_GNU_verdef);
491   ECase(SHT_GNU_verneed);
492   ECase(SHT_GNU_versym);
493   switch (Object->getMachine()) {
494   case ELF::EM_ARM:
495     ECase(SHT_ARM_EXIDX);
496     ECase(SHT_ARM_PREEMPTMAP);
497     ECase(SHT_ARM_ATTRIBUTES);
498     ECase(SHT_ARM_DEBUGOVERLAY);
499     ECase(SHT_ARM_OVERLAYSECTION);
500     break;
501   case ELF::EM_HEXAGON:
502     ECase(SHT_HEX_ORDERED);
503     break;
504   case ELF::EM_X86_64:
505     ECase(SHT_X86_64_UNWIND);
506     break;
507   case ELF::EM_MIPS:
508     ECase(SHT_MIPS_REGINFO);
509     ECase(SHT_MIPS_OPTIONS);
510     ECase(SHT_MIPS_DWARF);
511     ECase(SHT_MIPS_ABIFLAGS);
512     break;
513   case ELF::EM_RISCV:
514     ECase(SHT_RISCV_ATTRIBUTES);
515     break;
516   default:
517     // Nothing to do.
518     break;
519   }
520 #undef ECase
521   IO.enumFallback<Hex32>(Value);
522 }
523 
524 void ScalarBitSetTraits<ELFYAML::ELF_PF>::bitset(IO &IO,
525                                                  ELFYAML::ELF_PF &Value) {
526 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
527   BCase(PF_X);
528   BCase(PF_W);
529   BCase(PF_R);
530 }
531 
532 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
533                                                   ELFYAML::ELF_SHF &Value) {
534   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
535 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
536   BCase(SHF_WRITE);
537   BCase(SHF_ALLOC);
538   BCase(SHF_EXCLUDE);
539   BCase(SHF_EXECINSTR);
540   BCase(SHF_MERGE);
541   BCase(SHF_STRINGS);
542   BCase(SHF_INFO_LINK);
543   BCase(SHF_LINK_ORDER);
544   BCase(SHF_OS_NONCONFORMING);
545   BCase(SHF_GROUP);
546   BCase(SHF_TLS);
547   BCase(SHF_COMPRESSED);
548   switch (Object->getMachine()) {
549   case ELF::EM_ARM:
550     BCase(SHF_ARM_PURECODE);
551     break;
552   case ELF::EM_HEXAGON:
553     BCase(SHF_HEX_GPREL);
554     break;
555   case ELF::EM_MIPS:
556     BCase(SHF_MIPS_NODUPES);
557     BCase(SHF_MIPS_NAMES);
558     BCase(SHF_MIPS_LOCAL);
559     BCase(SHF_MIPS_NOSTRIP);
560     BCase(SHF_MIPS_GPREL);
561     BCase(SHF_MIPS_MERGE);
562     BCase(SHF_MIPS_ADDR);
563     BCase(SHF_MIPS_STRING);
564     break;
565   case ELF::EM_X86_64:
566     BCase(SHF_X86_64_LARGE);
567     break;
568   default:
569     // Nothing to do.
570     break;
571   }
572 #undef BCase
573 }
574 
575 void ScalarEnumerationTraits<ELFYAML::ELF_SHN>::enumeration(
576     IO &IO, ELFYAML::ELF_SHN &Value) {
577 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
578   ECase(SHN_UNDEF);
579   ECase(SHN_LORESERVE);
580   ECase(SHN_LOPROC);
581   ECase(SHN_HIPROC);
582   ECase(SHN_LOOS);
583   ECase(SHN_HIOS);
584   ECase(SHN_ABS);
585   ECase(SHN_COMMON);
586   ECase(SHN_XINDEX);
587   ECase(SHN_HIRESERVE);
588   ECase(SHN_AMDGPU_LDS);
589   ECase(SHN_HEXAGON_SCOMMON);
590   ECase(SHN_HEXAGON_SCOMMON_1);
591   ECase(SHN_HEXAGON_SCOMMON_2);
592   ECase(SHN_HEXAGON_SCOMMON_4);
593   ECase(SHN_HEXAGON_SCOMMON_8);
594 #undef ECase
595   IO.enumFallback<Hex16>(Value);
596 }
597 
598 void ScalarEnumerationTraits<ELFYAML::ELF_STB>::enumeration(
599     IO &IO, ELFYAML::ELF_STB &Value) {
600 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
601   ECase(STB_LOCAL);
602   ECase(STB_GLOBAL);
603   ECase(STB_WEAK);
604   ECase(STB_GNU_UNIQUE);
605 #undef ECase
606   IO.enumFallback<Hex8>(Value);
607 }
608 
609 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
610     IO &IO, ELFYAML::ELF_STT &Value) {
611 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
612   ECase(STT_NOTYPE);
613   ECase(STT_OBJECT);
614   ECase(STT_FUNC);
615   ECase(STT_SECTION);
616   ECase(STT_FILE);
617   ECase(STT_COMMON);
618   ECase(STT_TLS);
619   ECase(STT_GNU_IFUNC);
620 #undef ECase
621   IO.enumFallback<Hex8>(Value);
622 }
623 
624 
625 void ScalarEnumerationTraits<ELFYAML::ELF_RSS>::enumeration(
626     IO &IO, ELFYAML::ELF_RSS &Value) {
627 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
628   ECase(RSS_UNDEF);
629   ECase(RSS_GP);
630   ECase(RSS_GP0);
631   ECase(RSS_LOC);
632 #undef ECase
633 }
634 
635 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
636     IO &IO, ELFYAML::ELF_REL &Value) {
637   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
638   assert(Object && "The IO context is not initialized");
639 #define ELF_RELOC(X, Y) IO.enumCase(Value, #X, ELF::X);
640   switch (Object->getMachine()) {
641   case ELF::EM_X86_64:
642 #include "llvm/BinaryFormat/ELFRelocs/x86_64.def"
643     break;
644   case ELF::EM_MIPS:
645 #include "llvm/BinaryFormat/ELFRelocs/Mips.def"
646     break;
647   case ELF::EM_HEXAGON:
648 #include "llvm/BinaryFormat/ELFRelocs/Hexagon.def"
649     break;
650   case ELF::EM_386:
651   case ELF::EM_IAMCU:
652 #include "llvm/BinaryFormat/ELFRelocs/i386.def"
653     break;
654   case ELF::EM_AARCH64:
655 #include "llvm/BinaryFormat/ELFRelocs/AArch64.def"
656     break;
657   case ELF::EM_ARM:
658 #include "llvm/BinaryFormat/ELFRelocs/ARM.def"
659     break;
660   case ELF::EM_ARC:
661 #include "llvm/BinaryFormat/ELFRelocs/ARC.def"
662     break;
663   case ELF::EM_RISCV:
664 #include "llvm/BinaryFormat/ELFRelocs/RISCV.def"
665     break;
666   case ELF::EM_LANAI:
667 #include "llvm/BinaryFormat/ELFRelocs/Lanai.def"
668     break;
669   case ELF::EM_AMDGPU:
670 #include "llvm/BinaryFormat/ELFRelocs/AMDGPU.def"
671     break;
672   case ELF::EM_BPF:
673 #include "llvm/BinaryFormat/ELFRelocs/BPF.def"
674     break;
675   case ELF::EM_VE:
676 #include "llvm/BinaryFormat/ELFRelocs/VE.def"
677     break;
678   case ELF::EM_CSKY:
679 #include "llvm/BinaryFormat/ELFRelocs/CSKY.def"
680     break;
681   case ELF::EM_PPC64:
682 #include "llvm/BinaryFormat/ELFRelocs/PowerPC64.def"
683     break;
684   default:
685     // Nothing to do.
686     break;
687   }
688 #undef ELF_RELOC
689   IO.enumFallback<Hex32>(Value);
690 }
691 
692 void ScalarEnumerationTraits<ELFYAML::ELF_DYNTAG>::enumeration(
693     IO &IO, ELFYAML::ELF_DYNTAG &Value) {
694   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
695   assert(Object && "The IO context is not initialized");
696 
697 // Disable architecture specific tags by default. We might enable them below.
698 #define AARCH64_DYNAMIC_TAG(name, value)
699 #define MIPS_DYNAMIC_TAG(name, value)
700 #define HEXAGON_DYNAMIC_TAG(name, value)
701 #define PPC_DYNAMIC_TAG(name, value)
702 #define PPC64_DYNAMIC_TAG(name, value)
703 // Ignore marker tags such as DT_HIOS (maps to DT_VERNEEDNUM), etc.
704 #define DYNAMIC_TAG_MARKER(name, value)
705 
706 #define STRINGIFY(X) (#X)
707 #define DYNAMIC_TAG(X, Y) IO.enumCase(Value, STRINGIFY(DT_##X), ELF::DT_##X);
708   switch (Object->getMachine()) {
709   case ELF::EM_AARCH64:
710 #undef AARCH64_DYNAMIC_TAG
711 #define AARCH64_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
712 #include "llvm/BinaryFormat/DynamicTags.def"
713 #undef AARCH64_DYNAMIC_TAG
714 #define AARCH64_DYNAMIC_TAG(name, value)
715     break;
716   case ELF::EM_MIPS:
717 #undef MIPS_DYNAMIC_TAG
718 #define MIPS_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
719 #include "llvm/BinaryFormat/DynamicTags.def"
720 #undef MIPS_DYNAMIC_TAG
721 #define MIPS_DYNAMIC_TAG(name, value)
722     break;
723   case ELF::EM_HEXAGON:
724 #undef HEXAGON_DYNAMIC_TAG
725 #define HEXAGON_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
726 #include "llvm/BinaryFormat/DynamicTags.def"
727 #undef HEXAGON_DYNAMIC_TAG
728 #define HEXAGON_DYNAMIC_TAG(name, value)
729     break;
730   case ELF::EM_PPC:
731 #undef PPC_DYNAMIC_TAG
732 #define PPC_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
733 #include "llvm/BinaryFormat/DynamicTags.def"
734 #undef PPC_DYNAMIC_TAG
735 #define PPC_DYNAMIC_TAG(name, value)
736     break;
737   case ELF::EM_PPC64:
738 #undef PPC64_DYNAMIC_TAG
739 #define PPC64_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
740 #include "llvm/BinaryFormat/DynamicTags.def"
741 #undef PPC64_DYNAMIC_TAG
742 #define PPC64_DYNAMIC_TAG(name, value)
743     break;
744   default:
745 #include "llvm/BinaryFormat/DynamicTags.def"
746     break;
747   }
748 #undef AARCH64_DYNAMIC_TAG
749 #undef MIPS_DYNAMIC_TAG
750 #undef HEXAGON_DYNAMIC_TAG
751 #undef PPC_DYNAMIC_TAG
752 #undef PPC64_DYNAMIC_TAG
753 #undef DYNAMIC_TAG_MARKER
754 #undef STRINGIFY
755 #undef DYNAMIC_TAG
756 
757   IO.enumFallback<Hex64>(Value);
758 }
759 
760 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_REG>::enumeration(
761     IO &IO, ELFYAML::MIPS_AFL_REG &Value) {
762 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
763   ECase(REG_NONE);
764   ECase(REG_32);
765   ECase(REG_64);
766   ECase(REG_128);
767 #undef ECase
768 }
769 
770 void ScalarEnumerationTraits<ELFYAML::MIPS_ABI_FP>::enumeration(
771     IO &IO, ELFYAML::MIPS_ABI_FP &Value) {
772 #define ECase(X) IO.enumCase(Value, #X, Mips::Val_GNU_MIPS_ABI_##X)
773   ECase(FP_ANY);
774   ECase(FP_DOUBLE);
775   ECase(FP_SINGLE);
776   ECase(FP_SOFT);
777   ECase(FP_OLD_64);
778   ECase(FP_XX);
779   ECase(FP_64);
780   ECase(FP_64A);
781 #undef ECase
782 }
783 
784 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_EXT>::enumeration(
785     IO &IO, ELFYAML::MIPS_AFL_EXT &Value) {
786 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
787   ECase(EXT_NONE);
788   ECase(EXT_XLR);
789   ECase(EXT_OCTEON2);
790   ECase(EXT_OCTEONP);
791   ECase(EXT_LOONGSON_3A);
792   ECase(EXT_OCTEON);
793   ECase(EXT_5900);
794   ECase(EXT_4650);
795   ECase(EXT_4010);
796   ECase(EXT_4100);
797   ECase(EXT_3900);
798   ECase(EXT_10000);
799   ECase(EXT_SB1);
800   ECase(EXT_4111);
801   ECase(EXT_4120);
802   ECase(EXT_5400);
803   ECase(EXT_5500);
804   ECase(EXT_LOONGSON_2E);
805   ECase(EXT_LOONGSON_2F);
806   ECase(EXT_OCTEON3);
807 #undef ECase
808 }
809 
810 void ScalarEnumerationTraits<ELFYAML::MIPS_ISA>::enumeration(
811     IO &IO, ELFYAML::MIPS_ISA &Value) {
812   IO.enumCase(Value, "MIPS1", 1);
813   IO.enumCase(Value, "MIPS2", 2);
814   IO.enumCase(Value, "MIPS3", 3);
815   IO.enumCase(Value, "MIPS4", 4);
816   IO.enumCase(Value, "MIPS5", 5);
817   IO.enumCase(Value, "MIPS32", 32);
818   IO.enumCase(Value, "MIPS64", 64);
819 }
820 
821 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_ASE>::bitset(
822     IO &IO, ELFYAML::MIPS_AFL_ASE &Value) {
823 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_ASE_##X)
824   BCase(DSP);
825   BCase(DSPR2);
826   BCase(EVA);
827   BCase(MCU);
828   BCase(MDMX);
829   BCase(MIPS3D);
830   BCase(MT);
831   BCase(SMARTMIPS);
832   BCase(VIRT);
833   BCase(MSA);
834   BCase(MIPS16);
835   BCase(MICROMIPS);
836   BCase(XPA);
837   BCase(CRC);
838   BCase(GINV);
839 #undef BCase
840 }
841 
842 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_FLAGS1>::bitset(
843     IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value) {
844 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_FLAGS1_##X)
845   BCase(ODDSPREG);
846 #undef BCase
847 }
848 
849 void MappingTraits<ELFYAML::SectionHeader>::mapping(
850     IO &IO, ELFYAML::SectionHeader &SHdr) {
851   IO.mapRequired("Name", SHdr.Name);
852 }
853 
854 void MappingTraits<ELFYAML::SectionHeaderTable>::mapping(
855     IO &IO, ELFYAML::SectionHeaderTable &SectionHeader) {
856   IO.mapOptional("Sections", SectionHeader.Sections);
857   IO.mapOptional("Excluded", SectionHeader.Excluded);
858   IO.mapOptional("NoHeaders", SectionHeader.NoHeaders);
859 }
860 
861 StringRef MappingTraits<ELFYAML::SectionHeaderTable>::validate(
862     IO &IO, ELFYAML::SectionHeaderTable &SecHdrTable) {
863   if (SecHdrTable.NoHeaders && (SecHdrTable.Sections || SecHdrTable.Excluded))
864     return "NoHeaders can't be used together with Sections/Excluded";
865   if (!SecHdrTable.NoHeaders && !SecHdrTable.Sections && !SecHdrTable.Excluded)
866     return "SectionHeaderTable can't be empty. Use 'NoHeaders' key to drop the "
867            "section header table";
868   return StringRef();
869 }
870 
871 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
872                                                  ELFYAML::FileHeader &FileHdr) {
873   IO.mapRequired("Class", FileHdr.Class);
874   IO.mapRequired("Data", FileHdr.Data);
875   IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
876   IO.mapOptional("ABIVersion", FileHdr.ABIVersion, Hex8(0));
877   IO.mapRequired("Type", FileHdr.Type);
878   IO.mapOptional("Machine", FileHdr.Machine);
879   IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
880   IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
881 
882   // obj2yaml does not dump these fields.
883   assert(!IO.outputting() ||
884          (!FileHdr.EPhOff && !FileHdr.EPhEntSize && !FileHdr.EPhNum));
885   IO.mapOptional("EPhOff", FileHdr.EPhOff);
886   IO.mapOptional("EPhEntSize", FileHdr.EPhEntSize);
887   IO.mapOptional("EPhNum", FileHdr.EPhNum);
888   IO.mapOptional("EShEntSize", FileHdr.EShEntSize);
889   IO.mapOptional("EShOff", FileHdr.EShOff);
890   IO.mapOptional("EShNum", FileHdr.EShNum);
891   IO.mapOptional("EShStrNdx", FileHdr.EShStrNdx);
892 }
893 
894 void MappingTraits<ELFYAML::ProgramHeader>::mapping(
895     IO &IO, ELFYAML::ProgramHeader &Phdr) {
896   IO.mapRequired("Type", Phdr.Type);
897   IO.mapOptional("Flags", Phdr.Flags, ELFYAML::ELF_PF(0));
898   IO.mapOptional("Sections", Phdr.Sections);
899   IO.mapOptional("VAddr", Phdr.VAddr, Hex64(0));
900   IO.mapOptional("PAddr", Phdr.PAddr, Phdr.VAddr);
901   IO.mapOptional("Align", Phdr.Align);
902   IO.mapOptional("FileSize", Phdr.FileSize);
903   IO.mapOptional("MemSize", Phdr.MemSize);
904   IO.mapOptional("Offset", Phdr.Offset);
905 }
906 
907 LLVM_YAML_STRONG_TYPEDEF(StringRef, StOtherPiece)
908 
909 template <> struct ScalarTraits<StOtherPiece> {
910   static void output(const StOtherPiece &Val, void *, raw_ostream &Out) {
911     Out << Val;
912   }
913   static StringRef input(StringRef Scalar, void *, StOtherPiece &Val) {
914     Val = Scalar;
915     return {};
916   }
917   static QuotingType mustQuote(StringRef) { return QuotingType::None; }
918 };
919 template <> struct SequenceElementTraits<StOtherPiece> {
920   static const bool flow = true;
921 };
922 
923 template <> struct ScalarTraits<ELFYAML::YAMLFlowString> {
924   static void output(const ELFYAML::YAMLFlowString &Val, void *,
925                      raw_ostream &Out) {
926     Out << Val;
927   }
928   static StringRef input(StringRef Scalar, void *,
929                          ELFYAML::YAMLFlowString &Val) {
930     Val = Scalar;
931     return {};
932   }
933   static QuotingType mustQuote(StringRef S) {
934     return ScalarTraits<StringRef>::mustQuote(S);
935   }
936 };
937 template <> struct SequenceElementTraits<ELFYAML::YAMLFlowString> {
938   static const bool flow = true;
939 };
940 
941 namespace {
942 
943 struct NormalizedOther {
944   NormalizedOther(IO &IO) : YamlIO(IO) {}
945   NormalizedOther(IO &IO, Optional<uint8_t> Original) : YamlIO(IO) {
946     assert(Original && "This constructor is only used for outputting YAML and "
947                        "assumes a non-empty Original");
948     std::vector<StOtherPiece> Ret;
949     const auto *Object = static_cast<ELFYAML::Object *>(YamlIO.getContext());
950     for (std::pair<StringRef, uint8_t> &P :
951          getFlags(Object->getMachine()).takeVector()) {
952       uint8_t FlagValue = P.second;
953       if ((*Original & FlagValue) != FlagValue)
954         continue;
955       *Original &= ~FlagValue;
956       Ret.push_back({P.first});
957     }
958 
959     if (*Original != 0) {
960       UnknownFlagsHolder = std::to_string(*Original);
961       Ret.push_back({UnknownFlagsHolder});
962     }
963 
964     if (!Ret.empty())
965       Other = std::move(Ret);
966   }
967 
968   uint8_t toValue(StringRef Name) {
969     const auto *Object = static_cast<ELFYAML::Object *>(YamlIO.getContext());
970     MapVector<StringRef, uint8_t> Flags = getFlags(Object->getMachine());
971 
972     auto It = Flags.find(Name);
973     if (It != Flags.end())
974       return It->second;
975 
976     uint8_t Val;
977     if (to_integer(Name, Val))
978       return Val;
979 
980     YamlIO.setError("an unknown value is used for symbol's 'Other' field: " +
981                     Name);
982     return 0;
983   }
984 
985   Optional<uint8_t> denormalize(IO &) {
986     if (!Other)
987       return None;
988     uint8_t Ret = 0;
989     for (StOtherPiece &Val : *Other)
990       Ret |= toValue(Val);
991     return Ret;
992   }
993 
994   // st_other field is used to encode symbol visibility and platform-dependent
995   // flags and values. This method returns a name to value map that is used for
996   // parsing and encoding this field.
997   MapVector<StringRef, uint8_t> getFlags(unsigned EMachine) {
998     MapVector<StringRef, uint8_t> Map;
999     // STV_* values are just enumeration values. We add them in a reversed order
1000     // because when we convert the st_other to named constants when printing
1001     // YAML we want to use a maximum number of bits on each step:
1002     // when we have st_other == 3, we want to print it as STV_PROTECTED (3), but
1003     // not as STV_HIDDEN (2) + STV_INTERNAL (1).
1004     Map["STV_PROTECTED"] = ELF::STV_PROTECTED;
1005     Map["STV_HIDDEN"] = ELF::STV_HIDDEN;
1006     Map["STV_INTERNAL"] = ELF::STV_INTERNAL;
1007     // STV_DEFAULT is used to represent the default visibility and has a value
1008     // 0. We want to be able to read it from YAML documents, but there is no
1009     // reason to print it.
1010     if (!YamlIO.outputting())
1011       Map["STV_DEFAULT"] = ELF::STV_DEFAULT;
1012 
1013     // MIPS is not consistent. All of the STO_MIPS_* values are bit flags,
1014     // except STO_MIPS_MIPS16 which overlaps them. It should be checked and
1015     // consumed first when we print the output, because we do not want to print
1016     // any other flags that have the same bits instead.
1017     if (EMachine == ELF::EM_MIPS) {
1018       Map["STO_MIPS_MIPS16"] = ELF::STO_MIPS_MIPS16;
1019       Map["STO_MIPS_MICROMIPS"] = ELF::STO_MIPS_MICROMIPS;
1020       Map["STO_MIPS_PIC"] = ELF::STO_MIPS_PIC;
1021       Map["STO_MIPS_PLT"] = ELF::STO_MIPS_PLT;
1022       Map["STO_MIPS_OPTIONAL"] = ELF::STO_MIPS_OPTIONAL;
1023     }
1024     return Map;
1025   }
1026 
1027   IO &YamlIO;
1028   Optional<std::vector<StOtherPiece>> Other;
1029   std::string UnknownFlagsHolder;
1030 };
1031 
1032 } // end anonymous namespace
1033 
1034 void ScalarTraits<ELFYAML::YAMLIntUInt>::output(const ELFYAML::YAMLIntUInt &Val,
1035                                                 void *Ctx, raw_ostream &Out) {
1036   Out << Val;
1037 }
1038 
1039 StringRef ScalarTraits<ELFYAML::YAMLIntUInt>::input(StringRef Scalar, void *Ctx,
1040                                                     ELFYAML::YAMLIntUInt &Val) {
1041   const bool Is64 = static_cast<ELFYAML::Object *>(Ctx)->Header.Class ==
1042                     ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64);
1043   StringRef ErrMsg = "invalid number";
1044   // We do not accept negative hex numbers because their meaning is ambiguous.
1045   // For example, would -0xfffffffff mean 1 or INT32_MIN?
1046   if (Scalar.empty() || Scalar.startswith("-0x"))
1047     return ErrMsg;
1048 
1049   if (Scalar.startswith("-")) {
1050     const int64_t MinVal = Is64 ? INT64_MIN : INT32_MIN;
1051     long long Int;
1052     if (getAsSignedInteger(Scalar, /*Radix=*/0, Int) || (Int < MinVal))
1053       return ErrMsg;
1054     Val = Int;
1055     return "";
1056   }
1057 
1058   const uint64_t MaxVal = Is64 ? UINT64_MAX : UINT32_MAX;
1059   unsigned long long UInt;
1060   if (getAsUnsignedInteger(Scalar, /*Radix=*/0, UInt) || (UInt > MaxVal))
1061     return ErrMsg;
1062   Val = UInt;
1063   return "";
1064 }
1065 
1066 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
1067   IO.mapOptional("Name", Symbol.Name, StringRef());
1068   IO.mapOptional("StName", Symbol.StName);
1069   IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
1070   IO.mapOptional("Section", Symbol.Section, StringRef());
1071   IO.mapOptional("Index", Symbol.Index);
1072   IO.mapOptional("Binding", Symbol.Binding, ELFYAML::ELF_STB(0));
1073   IO.mapOptional("Value", Symbol.Value, Hex64(0));
1074   IO.mapOptional("Size", Symbol.Size, Hex64(0));
1075 
1076   // Symbol's Other field is a bit special. It is usually a field that
1077   // represents st_other and holds the symbol visibility. However, on some
1078   // platforms, it can contain bit fields and regular values, or even sometimes a
1079   // crazy mix of them (see comments for NormalizedOther). Because of this, we
1080   // need special handling.
1081   MappingNormalization<NormalizedOther, Optional<uint8_t>> Keys(IO,
1082                                                                 Symbol.Other);
1083   IO.mapOptional("Other", Keys->Other);
1084 }
1085 
1086 StringRef MappingTraits<ELFYAML::Symbol>::validate(IO &IO,
1087                                                    ELFYAML::Symbol &Symbol) {
1088   if (Symbol.Index && Symbol.Section.data())
1089     return "Index and Section cannot both be specified for Symbol";
1090   return StringRef();
1091 }
1092 
1093 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
1094   IO.mapOptional("Name", Section.Name, StringRef());
1095   IO.mapRequired("Type", Section.Type);
1096   IO.mapOptional("Flags", Section.Flags);
1097   IO.mapOptional("Address", Section.Address);
1098   IO.mapOptional("Link", Section.Link, StringRef());
1099   IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
1100   IO.mapOptional("EntSize", Section.EntSize);
1101   IO.mapOptional("Offset", Section.Offset);
1102 
1103   // obj2yaml does not dump these fields. They are expected to be empty when we
1104   // are producing YAML, because yaml2obj sets appropriate values for them
1105   // automatically when they are not explicitly defined.
1106   assert(!IO.outputting() ||
1107          (!Section.ShOffset.hasValue() && !Section.ShSize.hasValue() &&
1108           !Section.ShName.hasValue() && !Section.ShFlags.hasValue() &&
1109           !Section.ShType.hasValue()));
1110   IO.mapOptional("ShName", Section.ShName);
1111   IO.mapOptional("ShOffset", Section.ShOffset);
1112   IO.mapOptional("ShSize", Section.ShSize);
1113   IO.mapOptional("ShFlags", Section.ShFlags);
1114   IO.mapOptional("ShType", Section.ShType);
1115 }
1116 
1117 static void sectionMapping(IO &IO, ELFYAML::DynamicSection &Section) {
1118   commonSectionMapping(IO, Section);
1119   IO.mapOptional("Entries", Section.Entries);
1120   IO.mapOptional("Content", Section.Content);
1121 }
1122 
1123 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
1124   commonSectionMapping(IO, Section);
1125   IO.mapOptional("Content", Section.Content);
1126 
1127   // We also support reading a content as array of bytes using the ContentArray
1128   // key. obj2yaml never prints this field.
1129   assert(!IO.outputting() || !Section.ContentBuf.hasValue());
1130   IO.mapOptional("ContentArray", Section.ContentBuf);
1131   if (Section.ContentBuf) {
1132     if (Section.Content)
1133       IO.setError("Content and ContentArray can't be used together");
1134     Section.Content = yaml::BinaryRef(*Section.ContentBuf);
1135   }
1136 
1137   IO.mapOptional("Size", Section.Size);
1138   IO.mapOptional("Info", Section.Info);
1139 }
1140 
1141 static void sectionMapping(IO &IO, ELFYAML::StackSizesSection &Section) {
1142   commonSectionMapping(IO, Section);
1143   IO.mapOptional("Content", Section.Content);
1144   IO.mapOptional("Size", Section.Size);
1145   IO.mapOptional("Entries", Section.Entries);
1146 }
1147 
1148 static void sectionMapping(IO &IO, ELFYAML::HashSection &Section) {
1149   commonSectionMapping(IO, Section);
1150   IO.mapOptional("Content", Section.Content);
1151   IO.mapOptional("Bucket", Section.Bucket);
1152   IO.mapOptional("Chain", Section.Chain);
1153   IO.mapOptional("Size", Section.Size);
1154 
1155   // obj2yaml does not dump these fields. They can be used to override nchain
1156   // and nbucket values for creating broken sections.
1157   assert(!IO.outputting() ||
1158          (!Section.NBucket.hasValue() && !Section.NChain.hasValue()));
1159   IO.mapOptional("NChain", Section.NChain);
1160   IO.mapOptional("NBucket", Section.NBucket);
1161 }
1162 
1163 static void sectionMapping(IO &IO, ELFYAML::NoteSection &Section) {
1164   commonSectionMapping(IO, Section);
1165   IO.mapOptional("Content", Section.Content);
1166   IO.mapOptional("Size", Section.Size);
1167   IO.mapOptional("Notes", Section.Notes);
1168 }
1169 
1170 
1171 static void sectionMapping(IO &IO, ELFYAML::GnuHashSection &Section) {
1172   commonSectionMapping(IO, Section);
1173   IO.mapOptional("Content", Section.Content);
1174   IO.mapOptional("Header", Section.Header);
1175   IO.mapOptional("BloomFilter", Section.BloomFilter);
1176   IO.mapOptional("HashBuckets", Section.HashBuckets);
1177   IO.mapOptional("HashValues", Section.HashValues);
1178 }
1179 static void sectionMapping(IO &IO, ELFYAML::NoBitsSection &Section) {
1180   commonSectionMapping(IO, Section);
1181   IO.mapOptional("Size", Section.Size, Hex64(0));
1182 }
1183 
1184 static void sectionMapping(IO &IO, ELFYAML::VerdefSection &Section) {
1185   commonSectionMapping(IO, Section);
1186   IO.mapRequired("Info", Section.Info);
1187   IO.mapOptional("Entries", Section.Entries);
1188   IO.mapOptional("Content", Section.Content);
1189 }
1190 
1191 static void sectionMapping(IO &IO, ELFYAML::SymverSection &Section) {
1192   commonSectionMapping(IO, Section);
1193   IO.mapRequired("Entries", Section.Entries);
1194 }
1195 
1196 static void sectionMapping(IO &IO, ELFYAML::VerneedSection &Section) {
1197   commonSectionMapping(IO, Section);
1198   IO.mapRequired("Info", Section.Info);
1199   IO.mapOptional("Dependencies", Section.VerneedV);
1200   IO.mapOptional("Content", Section.Content);
1201 }
1202 
1203 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
1204   commonSectionMapping(IO, Section);
1205   IO.mapOptional("Info", Section.RelocatableSec, StringRef());
1206   IO.mapOptional("Relocations", Section.Relocations);
1207 }
1208 
1209 static void sectionMapping(IO &IO, ELFYAML::RelrSection &Section) {
1210   commonSectionMapping(IO, Section);
1211   IO.mapOptional("Entries", Section.Entries);
1212   IO.mapOptional("Content", Section.Content);
1213 }
1214 
1215 static void groupSectionMapping(IO &IO, ELFYAML::Group &Group) {
1216   commonSectionMapping(IO, Group);
1217   IO.mapOptional("Info", Group.Signature);
1218   IO.mapRequired("Members", Group.Members);
1219 }
1220 
1221 static void sectionMapping(IO &IO, ELFYAML::SymtabShndxSection &Section) {
1222   commonSectionMapping(IO, Section);
1223   IO.mapRequired("Entries", Section.Entries);
1224 }
1225 
1226 static void sectionMapping(IO &IO, ELFYAML::AddrsigSection &Section) {
1227   commonSectionMapping(IO, Section);
1228   IO.mapOptional("Content", Section.Content);
1229   IO.mapOptional("Size", Section.Size);
1230   IO.mapOptional("Symbols", Section.Symbols);
1231 }
1232 
1233 static void fillMapping(IO &IO, ELFYAML::Fill &Fill) {
1234   IO.mapOptional("Name", Fill.Name, StringRef());
1235   IO.mapOptional("Pattern", Fill.Pattern);
1236   IO.mapOptional("Offset", Fill.Offset);
1237   IO.mapRequired("Size", Fill.Size);
1238 }
1239 
1240 static void sectionMapping(IO &IO, ELFYAML::LinkerOptionsSection &Section) {
1241   commonSectionMapping(IO, Section);
1242   IO.mapOptional("Options", Section.Options);
1243   IO.mapOptional("Content", Section.Content);
1244 }
1245 
1246 static void sectionMapping(IO &IO,
1247                            ELFYAML::DependentLibrariesSection &Section) {
1248   commonSectionMapping(IO, Section);
1249   IO.mapOptional("Libraries", Section.Libs);
1250   IO.mapOptional("Content", Section.Content);
1251 }
1252 
1253 static void sectionMapping(IO &IO, ELFYAML::CallGraphProfileSection &Section) {
1254   commonSectionMapping(IO, Section);
1255   IO.mapOptional("Entries", Section.Entries);
1256   IO.mapOptional("Content", Section.Content);
1257 }
1258 
1259 void MappingTraits<ELFYAML::SectionOrType>::mapping(
1260     IO &IO, ELFYAML::SectionOrType &sectionOrType) {
1261   IO.mapRequired("SectionOrType", sectionOrType.sectionNameOrType);
1262 }
1263 
1264 void MappingTraits<ELFYAML::SectionName>::mapping(
1265     IO &IO, ELFYAML::SectionName &sectionName) {
1266   IO.mapRequired("Section", sectionName.Section);
1267 }
1268 
1269 static void sectionMapping(IO &IO, ELFYAML::MipsABIFlags &Section) {
1270   commonSectionMapping(IO, Section);
1271   IO.mapOptional("Version", Section.Version, Hex16(0));
1272   IO.mapRequired("ISA", Section.ISALevel);
1273   IO.mapOptional("ISARevision", Section.ISARevision, Hex8(0));
1274   IO.mapOptional("ISAExtension", Section.ISAExtension,
1275                  ELFYAML::MIPS_AFL_EXT(Mips::AFL_EXT_NONE));
1276   IO.mapOptional("ASEs", Section.ASEs, ELFYAML::MIPS_AFL_ASE(0));
1277   IO.mapOptional("FpABI", Section.FpABI,
1278                  ELFYAML::MIPS_ABI_FP(Mips::Val_GNU_MIPS_ABI_FP_ANY));
1279   IO.mapOptional("GPRSize", Section.GPRSize,
1280                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1281   IO.mapOptional("CPR1Size", Section.CPR1Size,
1282                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1283   IO.mapOptional("CPR2Size", Section.CPR2Size,
1284                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1285   IO.mapOptional("Flags1", Section.Flags1, ELFYAML::MIPS_AFL_FLAGS1(0));
1286   IO.mapOptional("Flags2", Section.Flags2, Hex32(0));
1287 }
1288 
1289 void MappingTraits<std::unique_ptr<ELFYAML::Chunk>>::mapping(
1290     IO &IO, std::unique_ptr<ELFYAML::Chunk> &Section) {
1291   ELFYAML::ELF_SHT Type;
1292   if (IO.outputting()) {
1293     Type = cast<ELFYAML::Section>(Section.get())->Type;
1294   } else {
1295     // When the Type string does not have a "SHT_" prefix, we know it is not a
1296     // description of a regular ELF output section. Currently, we have one
1297     // special type named "Fill". See comments for Fill.
1298     StringRef StrType;
1299     IO.mapRequired("Type", StrType);
1300     if (StrType == "Fill") {
1301       Section.reset(new ELFYAML::Fill());
1302       fillMapping(IO, *cast<ELFYAML::Fill>(Section.get()));
1303       return;
1304     }
1305 
1306     IO.mapRequired("Type", Type);
1307   }
1308 
1309   switch (Type) {
1310   case ELF::SHT_DYNAMIC:
1311     if (!IO.outputting())
1312       Section.reset(new ELFYAML::DynamicSection());
1313     sectionMapping(IO, *cast<ELFYAML::DynamicSection>(Section.get()));
1314     break;
1315   case ELF::SHT_REL:
1316   case ELF::SHT_RELA:
1317     if (!IO.outputting())
1318       Section.reset(new ELFYAML::RelocationSection());
1319     sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
1320     break;
1321   case ELF::SHT_RELR:
1322     if (!IO.outputting())
1323       Section.reset(new ELFYAML::RelrSection());
1324     sectionMapping(IO, *cast<ELFYAML::RelrSection>(Section.get()));
1325     break;
1326   case ELF::SHT_GROUP:
1327     if (!IO.outputting())
1328       Section.reset(new ELFYAML::Group());
1329     groupSectionMapping(IO, *cast<ELFYAML::Group>(Section.get()));
1330     break;
1331   case ELF::SHT_NOBITS:
1332     if (!IO.outputting())
1333       Section.reset(new ELFYAML::NoBitsSection());
1334     sectionMapping(IO, *cast<ELFYAML::NoBitsSection>(Section.get()));
1335     break;
1336   case ELF::SHT_HASH:
1337     if (!IO.outputting())
1338       Section.reset(new ELFYAML::HashSection());
1339     sectionMapping(IO, *cast<ELFYAML::HashSection>(Section.get()));
1340     break;
1341   case ELF::SHT_NOTE:
1342     if (!IO.outputting())
1343       Section.reset(new ELFYAML::NoteSection());
1344     sectionMapping(IO, *cast<ELFYAML::NoteSection>(Section.get()));
1345     break;
1346  case ELF::SHT_GNU_HASH:
1347     if (!IO.outputting())
1348       Section.reset(new ELFYAML::GnuHashSection());
1349     sectionMapping(IO, *cast<ELFYAML::GnuHashSection>(Section.get()));
1350     break;
1351   case ELF::SHT_MIPS_ABIFLAGS:
1352     if (!IO.outputting())
1353       Section.reset(new ELFYAML::MipsABIFlags());
1354     sectionMapping(IO, *cast<ELFYAML::MipsABIFlags>(Section.get()));
1355     break;
1356   case ELF::SHT_GNU_verdef:
1357     if (!IO.outputting())
1358       Section.reset(new ELFYAML::VerdefSection());
1359     sectionMapping(IO, *cast<ELFYAML::VerdefSection>(Section.get()));
1360     break;
1361   case ELF::SHT_GNU_versym:
1362     if (!IO.outputting())
1363       Section.reset(new ELFYAML::SymverSection());
1364     sectionMapping(IO, *cast<ELFYAML::SymverSection>(Section.get()));
1365     break;
1366   case ELF::SHT_GNU_verneed:
1367     if (!IO.outputting())
1368       Section.reset(new ELFYAML::VerneedSection());
1369     sectionMapping(IO, *cast<ELFYAML::VerneedSection>(Section.get()));
1370     break;
1371   case ELF::SHT_SYMTAB_SHNDX:
1372     if (!IO.outputting())
1373       Section.reset(new ELFYAML::SymtabShndxSection());
1374     sectionMapping(IO, *cast<ELFYAML::SymtabShndxSection>(Section.get()));
1375     break;
1376   case ELF::SHT_LLVM_ADDRSIG:
1377     if (!IO.outputting())
1378       Section.reset(new ELFYAML::AddrsigSection());
1379     sectionMapping(IO, *cast<ELFYAML::AddrsigSection>(Section.get()));
1380     break;
1381   case ELF::SHT_LLVM_LINKER_OPTIONS:
1382     if (!IO.outputting())
1383       Section.reset(new ELFYAML::LinkerOptionsSection());
1384     sectionMapping(IO, *cast<ELFYAML::LinkerOptionsSection>(Section.get()));
1385     break;
1386   case ELF::SHT_LLVM_DEPENDENT_LIBRARIES:
1387     if (!IO.outputting())
1388       Section.reset(new ELFYAML::DependentLibrariesSection());
1389     sectionMapping(IO,
1390                    *cast<ELFYAML::DependentLibrariesSection>(Section.get()));
1391     break;
1392   case ELF::SHT_LLVM_CALL_GRAPH_PROFILE:
1393     if (!IO.outputting())
1394       Section.reset(new ELFYAML::CallGraphProfileSection());
1395     sectionMapping(IO, *cast<ELFYAML::CallGraphProfileSection>(Section.get()));
1396     break;
1397   default:
1398     if (!IO.outputting()) {
1399       StringRef Name;
1400       IO.mapOptional("Name", Name, StringRef());
1401       Name = ELFYAML::dropUniqueSuffix(Name);
1402 
1403       if (ELFYAML::StackSizesSection::nameMatches(Name))
1404         Section = std::make_unique<ELFYAML::StackSizesSection>();
1405       else
1406         Section = std::make_unique<ELFYAML::RawContentSection>();
1407     }
1408 
1409     if (auto S = dyn_cast<ELFYAML::RawContentSection>(Section.get()))
1410       sectionMapping(IO, *S);
1411     else
1412       sectionMapping(IO, *cast<ELFYAML::StackSizesSection>(Section.get()));
1413   }
1414 }
1415 
1416 StringRef MappingTraits<std::unique_ptr<ELFYAML::Chunk>>::validate(
1417     IO &io, std::unique_ptr<ELFYAML::Chunk> &C) {
1418   if (const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(C.get())) {
1419     if (RawSection->Size && RawSection->Content &&
1420         (uint64_t)(*RawSection->Size) < RawSection->Content->binary_size())
1421       return "Section size must be greater than or equal to the content size";
1422     if (RawSection->Flags && RawSection->ShFlags)
1423       return "ShFlags and Flags cannot be used together";
1424     return {};
1425   }
1426 
1427   if (const auto *SS = dyn_cast<ELFYAML::StackSizesSection>(C.get())) {
1428     if (!SS->Entries && !SS->Content && !SS->Size)
1429       return ".stack_sizes: one of Content, Entries and Size must be specified";
1430 
1431     if (SS->Size && SS->Content &&
1432         (uint64_t)(*SS->Size) < SS->Content->binary_size())
1433       return ".stack_sizes: Size must be greater than or equal to the content "
1434              "size";
1435 
1436     // We accept Content, Size or both together when there are no Entries.
1437     if (!SS->Entries)
1438       return {};
1439 
1440     if (SS->Size)
1441       return ".stack_sizes: Size and Entries cannot be used together";
1442     if (SS->Content)
1443       return ".stack_sizes: Content and Entries cannot be used together";
1444     return {};
1445   }
1446 
1447   if (const auto *HS = dyn_cast<ELFYAML::HashSection>(C.get())) {
1448     if (!HS->Content && !HS->Bucket && !HS->Chain && !HS->Size)
1449       return "one of \"Content\", \"Size\", \"Bucket\" or \"Chain\" must be "
1450              "specified";
1451 
1452     if (HS->Content || HS->Size) {
1453       if (HS->Size && HS->Content &&
1454           (uint64_t)*HS->Size < HS->Content->binary_size())
1455         return "\"Size\" must be greater than or equal to the content "
1456                "size";
1457 
1458       if (HS->Bucket)
1459         return "\"Bucket\" cannot be used with \"Content\" or \"Size\"";
1460       if (HS->Chain)
1461         return "\"Chain\" cannot be used with \"Content\" or \"Size\"";
1462       return {};
1463     }
1464 
1465     if ((HS->Bucket && !HS->Chain) || (!HS->Bucket && HS->Chain))
1466       return "\"Bucket\" and \"Chain\" must be used together";
1467     return {};
1468   }
1469 
1470   if (const auto *Sec = dyn_cast<ELFYAML::AddrsigSection>(C.get())) {
1471     if (!Sec->Symbols && !Sec->Content && !Sec->Size)
1472       return "one of \"Content\", \"Size\" or \"Symbols\" must be specified";
1473 
1474     if (Sec->Content || Sec->Size) {
1475       if (Sec->Size && Sec->Content &&
1476           (uint64_t)*Sec->Size < Sec->Content->binary_size())
1477         return "\"Size\" must be greater than or equal to the content "
1478                "size";
1479 
1480       if (Sec->Symbols)
1481         return "\"Symbols\" cannot be used with \"Content\" or \"Size\"";
1482       return {};
1483     }
1484 
1485     if (!Sec->Symbols)
1486       return {};
1487     return {};
1488   }
1489 
1490   if (const auto *NS = dyn_cast<ELFYAML::NoteSection>(C.get())) {
1491     if (!NS->Content && !NS->Size && !NS->Notes)
1492       return "one of \"Content\", \"Size\" or \"Notes\" must be "
1493              "specified";
1494 
1495     if (!NS->Content && !NS->Size)
1496       return {};
1497 
1498     if (NS->Size && NS->Content &&
1499         (uint64_t)*NS->Size < NS->Content->binary_size())
1500       return "\"Size\" must be greater than or equal to the content "
1501              "size";
1502 
1503     if (NS->Notes)
1504       return "\"Notes\" cannot be used with \"Content\" or \"Size\"";
1505     return {};
1506   }
1507 
1508   if (const auto *Sec = dyn_cast<ELFYAML::GnuHashSection>(C.get())) {
1509     if (!Sec->Content && !Sec->Header && !Sec->BloomFilter &&
1510         !Sec->HashBuckets && !Sec->HashValues)
1511       return "either \"Content\" or \"Header\", \"BloomFilter\", "
1512              "\"HashBuckets\" and \"HashBuckets\" must be specified";
1513 
1514     if (Sec->Header || Sec->BloomFilter || Sec->HashBuckets ||
1515         Sec->HashValues) {
1516       if (!Sec->Header || !Sec->BloomFilter || !Sec->HashBuckets ||
1517           !Sec->HashValues)
1518         return "\"Header\", \"BloomFilter\", "
1519                "\"HashBuckets\" and \"HashValues\" must be used together";
1520       if (Sec->Content)
1521         return "\"Header\", \"BloomFilter\", "
1522                "\"HashBuckets\" and \"HashValues\" can't be used together with "
1523                "\"Content\"";
1524       return {};
1525     }
1526 
1527     // Only Content is specified.
1528     return {};
1529   }
1530 
1531   if (const auto *Sec = dyn_cast<ELFYAML::LinkerOptionsSection>(C.get())) {
1532     if (Sec->Options && Sec->Content)
1533       return "\"Options\" and \"Content\" can't be used together";
1534     return {};
1535   }
1536 
1537   if (const auto *Sec = dyn_cast<ELFYAML::DependentLibrariesSection>(C.get())) {
1538     if (Sec->Libs && Sec->Content)
1539       return "SHT_LLVM_DEPENDENT_LIBRARIES: \"Libraries\" and \"Content\" "
1540              "can't "
1541              "be used together";
1542     return {};
1543   }
1544 
1545   if (const auto *F = dyn_cast<ELFYAML::Fill>(C.get())) {
1546     if (!F->Pattern)
1547       return {};
1548     if (F->Pattern->binary_size() != 0 && !F->Size)
1549       return "\"Size\" can't be 0 when \"Pattern\" is not empty";
1550     return {};
1551   }
1552 
1553   if (const auto *VD = dyn_cast<ELFYAML::VerdefSection>(C.get())) {
1554     if (VD->Entries && VD->Content)
1555       return "SHT_GNU_verdef: \"Entries\" and \"Content\" can't be used "
1556              "together";
1557     return {};
1558   }
1559 
1560   if (const auto *VD = dyn_cast<ELFYAML::VerneedSection>(C.get())) {
1561     if (VD->VerneedV && VD->Content)
1562       return "SHT_GNU_verneed: \"Dependencies\" and \"Content\" can't be used "
1563              "together";
1564     return {};
1565   }
1566 
1567   if (const auto *RS = dyn_cast<ELFYAML::RelrSection>(C.get())) {
1568     if (RS->Entries && RS->Content)
1569       return "\"Entries\" and \"Content\" can't be used together";
1570     return {};
1571   }
1572 
1573   if (const auto *CGP = dyn_cast<ELFYAML::CallGraphProfileSection>(C.get())) {
1574     if (CGP->Entries && CGP->Content)
1575       return "\"Entries\" and \"Content\" can't be used together";
1576     return {};
1577   }
1578 
1579   return {};
1580 }
1581 
1582 namespace {
1583 
1584 struct NormalizedMips64RelType {
1585   NormalizedMips64RelType(IO &)
1586       : Type(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1587         Type2(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1588         Type3(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1589         SpecSym(ELFYAML::ELF_REL(ELF::RSS_UNDEF)) {}
1590   NormalizedMips64RelType(IO &, ELFYAML::ELF_REL Original)
1591       : Type(Original & 0xFF), Type2(Original >> 8 & 0xFF),
1592         Type3(Original >> 16 & 0xFF), SpecSym(Original >> 24 & 0xFF) {}
1593 
1594   ELFYAML::ELF_REL denormalize(IO &) {
1595     ELFYAML::ELF_REL Res = Type | Type2 << 8 | Type3 << 16 | SpecSym << 24;
1596     return Res;
1597   }
1598 
1599   ELFYAML::ELF_REL Type;
1600   ELFYAML::ELF_REL Type2;
1601   ELFYAML::ELF_REL Type3;
1602   ELFYAML::ELF_RSS SpecSym;
1603 };
1604 
1605 } // end anonymous namespace
1606 
1607 void MappingTraits<ELFYAML::StackSizeEntry>::mapping(
1608     IO &IO, ELFYAML::StackSizeEntry &E) {
1609   assert(IO.getContext() && "The IO context is not initialized");
1610   IO.mapOptional("Address", E.Address, Hex64(0));
1611   IO.mapRequired("Size", E.Size);
1612 }
1613 
1614 void MappingTraits<ELFYAML::GnuHashHeader>::mapping(IO &IO,
1615                                                     ELFYAML::GnuHashHeader &E) {
1616   assert(IO.getContext() && "The IO context is not initialized");
1617   IO.mapOptional("NBuckets", E.NBuckets);
1618   IO.mapRequired("SymNdx", E.SymNdx);
1619   IO.mapOptional("MaskWords", E.MaskWords);
1620   IO.mapRequired("Shift2", E.Shift2);
1621 }
1622 
1623 void MappingTraits<ELFYAML::DynamicEntry>::mapping(IO &IO,
1624                                                    ELFYAML::DynamicEntry &Rel) {
1625   assert(IO.getContext() && "The IO context is not initialized");
1626 
1627   IO.mapRequired("Tag", Rel.Tag);
1628   IO.mapRequired("Value", Rel.Val);
1629 }
1630 
1631 void MappingTraits<ELFYAML::NoteEntry>::mapping(IO &IO, ELFYAML::NoteEntry &N) {
1632   assert(IO.getContext() && "The IO context is not initialized");
1633 
1634   IO.mapOptional("Name", N.Name);
1635   IO.mapOptional("Desc", N.Desc);
1636   IO.mapRequired("Type", N.Type);
1637 }
1638 
1639 void MappingTraits<ELFYAML::VerdefEntry>::mapping(IO &IO,
1640                                                   ELFYAML::VerdefEntry &E) {
1641   assert(IO.getContext() && "The IO context is not initialized");
1642 
1643   IO.mapRequired("Version", E.Version);
1644   IO.mapRequired("Flags", E.Flags);
1645   IO.mapRequired("VersionNdx", E.VersionNdx);
1646   IO.mapRequired("Hash", E.Hash);
1647   IO.mapRequired("Names", E.VerNames);
1648 }
1649 
1650 void MappingTraits<ELFYAML::VerneedEntry>::mapping(IO &IO,
1651                                                    ELFYAML::VerneedEntry &E) {
1652   assert(IO.getContext() && "The IO context is not initialized");
1653 
1654   IO.mapRequired("Version", E.Version);
1655   IO.mapRequired("File", E.File);
1656   IO.mapRequired("Entries", E.AuxV);
1657 }
1658 
1659 void MappingTraits<ELFYAML::VernauxEntry>::mapping(IO &IO,
1660                                                    ELFYAML::VernauxEntry &E) {
1661   assert(IO.getContext() && "The IO context is not initialized");
1662 
1663   IO.mapRequired("Name", E.Name);
1664   IO.mapRequired("Hash", E.Hash);
1665   IO.mapRequired("Flags", E.Flags);
1666   IO.mapRequired("Other", E.Other);
1667 }
1668 
1669 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
1670                                                  ELFYAML::Relocation &Rel) {
1671   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
1672   assert(Object && "The IO context is not initialized");
1673 
1674   IO.mapOptional("Offset", Rel.Offset, (Hex64)0);
1675   IO.mapOptional("Symbol", Rel.Symbol);
1676 
1677   if (Object->getMachine() == ELFYAML::ELF_EM(ELF::EM_MIPS) &&
1678       Object->Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
1679     MappingNormalization<NormalizedMips64RelType, ELFYAML::ELF_REL> Key(
1680         IO, Rel.Type);
1681     IO.mapRequired("Type", Key->Type);
1682     IO.mapOptional("Type2", Key->Type2, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
1683     IO.mapOptional("Type3", Key->Type3, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
1684     IO.mapOptional("SpecSym", Key->SpecSym, ELFYAML::ELF_RSS(ELF::RSS_UNDEF));
1685   } else
1686     IO.mapRequired("Type", Rel.Type);
1687 
1688   IO.mapOptional("Addend", Rel.Addend, (ELFYAML::YAMLIntUInt)0);
1689 }
1690 
1691 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
1692   assert(!IO.getContext() && "The IO context is initialized already");
1693   IO.setContext(&Object);
1694   IO.mapTag("!ELF", true);
1695   IO.mapRequired("FileHeader", Object.Header);
1696   IO.mapOptional("SectionHeaderTable", Object.SectionHeaders);
1697   IO.mapOptional("ProgramHeaders", Object.ProgramHeaders);
1698   IO.mapOptional("Sections", Object.Chunks);
1699   IO.mapOptional("Symbols", Object.Symbols);
1700   IO.mapOptional("DynamicSymbols", Object.DynamicSymbols);
1701   IO.mapOptional("DWARF", Object.DWARF);
1702   if (Object.DWARF) {
1703     Object.DWARF->IsLittleEndian =
1704         Object.Header.Data == ELFYAML::ELF_ELFDATA(ELF::ELFDATA2LSB);
1705     Object.DWARF->Is64BitAddrSize =
1706         Object.Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64);
1707   }
1708   IO.setContext(nullptr);
1709 }
1710 
1711 void MappingTraits<ELFYAML::LinkerOption>::mapping(IO &IO,
1712                                                    ELFYAML::LinkerOption &Opt) {
1713   assert(IO.getContext() && "The IO context is not initialized");
1714   IO.mapRequired("Name", Opt.Key);
1715   IO.mapRequired("Value", Opt.Value);
1716 }
1717 
1718 void MappingTraits<ELFYAML::CallGraphEntry>::mapping(
1719     IO &IO, ELFYAML::CallGraphEntry &E) {
1720   assert(IO.getContext() && "The IO context is not initialized");
1721   IO.mapRequired("From", E.From);
1722   IO.mapRequired("To", E.To);
1723   IO.mapRequired("Weight", E.Weight);
1724 }
1725 
1726 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_AFL_REG)
1727 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_ABI_FP)
1728 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_EXT)
1729 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_ASE)
1730 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_FLAGS1)
1731 
1732 } // end namespace yaml
1733 
1734 } // end namespace llvm
1735