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