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   case ELF::EM_X86_64:
438     break;
439   default:
440     llvm_unreachable("Unsupported architecture");
441   }
442 #undef BCase
443 #undef BCaseMask
444 }
445 
446 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
447     IO &IO, ELFYAML::ELF_SHT &Value) {
448   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
449   assert(Object && "The IO context is not initialized");
450 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
451   ECase(SHT_NULL);
452   ECase(SHT_PROGBITS);
453   ECase(SHT_SYMTAB);
454   // FIXME: Issue a diagnostic with this information.
455   ECase(SHT_STRTAB);
456   ECase(SHT_RELA);
457   ECase(SHT_HASH);
458   ECase(SHT_DYNAMIC);
459   ECase(SHT_NOTE);
460   ECase(SHT_NOBITS);
461   ECase(SHT_REL);
462   ECase(SHT_SHLIB);
463   ECase(SHT_DYNSYM);
464   ECase(SHT_INIT_ARRAY);
465   ECase(SHT_FINI_ARRAY);
466   ECase(SHT_PREINIT_ARRAY);
467   ECase(SHT_GROUP);
468   ECase(SHT_SYMTAB_SHNDX);
469   ECase(SHT_RELR);
470   ECase(SHT_ANDROID_REL);
471   ECase(SHT_ANDROID_RELA);
472   ECase(SHT_ANDROID_RELR);
473   ECase(SHT_LLVM_ODRTAB);
474   ECase(SHT_LLVM_LINKER_OPTIONS);
475   ECase(SHT_LLVM_CALL_GRAPH_PROFILE);
476   ECase(SHT_LLVM_ADDRSIG);
477   ECase(SHT_LLVM_DEPENDENT_LIBRARIES);
478   ECase(SHT_LLVM_SYMPART);
479   ECase(SHT_LLVM_PART_EHDR);
480   ECase(SHT_LLVM_PART_PHDR);
481   ECase(SHT_GNU_ATTRIBUTES);
482   ECase(SHT_GNU_HASH);
483   ECase(SHT_GNU_verdef);
484   ECase(SHT_GNU_verneed);
485   ECase(SHT_GNU_versym);
486   switch (Object->Header.Machine) {
487   case ELF::EM_ARM:
488     ECase(SHT_ARM_EXIDX);
489     ECase(SHT_ARM_PREEMPTMAP);
490     ECase(SHT_ARM_ATTRIBUTES);
491     ECase(SHT_ARM_DEBUGOVERLAY);
492     ECase(SHT_ARM_OVERLAYSECTION);
493     break;
494   case ELF::EM_HEXAGON:
495     ECase(SHT_HEX_ORDERED);
496     break;
497   case ELF::EM_X86_64:
498     ECase(SHT_X86_64_UNWIND);
499     break;
500   case ELF::EM_MIPS:
501     ECase(SHT_MIPS_REGINFO);
502     ECase(SHT_MIPS_OPTIONS);
503     ECase(SHT_MIPS_DWARF);
504     ECase(SHT_MIPS_ABIFLAGS);
505     break;
506   case ELF::EM_RISCV:
507     ECase(SHT_RISCV_ATTRIBUTES);
508     break;
509   default:
510     // Nothing to do.
511     break;
512   }
513 #undef ECase
514   IO.enumFallback<Hex32>(Value);
515 }
516 
517 void ScalarBitSetTraits<ELFYAML::ELF_PF>::bitset(IO &IO,
518                                                  ELFYAML::ELF_PF &Value) {
519 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
520   BCase(PF_X);
521   BCase(PF_W);
522   BCase(PF_R);
523 }
524 
525 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
526                                                   ELFYAML::ELF_SHF &Value) {
527   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
528 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
529   BCase(SHF_WRITE);
530   BCase(SHF_ALLOC);
531   BCase(SHF_EXCLUDE);
532   BCase(SHF_EXECINSTR);
533   BCase(SHF_MERGE);
534   BCase(SHF_STRINGS);
535   BCase(SHF_INFO_LINK);
536   BCase(SHF_LINK_ORDER);
537   BCase(SHF_OS_NONCONFORMING);
538   BCase(SHF_GROUP);
539   BCase(SHF_TLS);
540   BCase(SHF_COMPRESSED);
541   switch (Object->Header.Machine) {
542   case ELF::EM_ARM:
543     BCase(SHF_ARM_PURECODE);
544     break;
545   case ELF::EM_HEXAGON:
546     BCase(SHF_HEX_GPREL);
547     break;
548   case ELF::EM_MIPS:
549     BCase(SHF_MIPS_NODUPES);
550     BCase(SHF_MIPS_NAMES);
551     BCase(SHF_MIPS_LOCAL);
552     BCase(SHF_MIPS_NOSTRIP);
553     BCase(SHF_MIPS_GPREL);
554     BCase(SHF_MIPS_MERGE);
555     BCase(SHF_MIPS_ADDR);
556     BCase(SHF_MIPS_STRING);
557     break;
558   case ELF::EM_X86_64:
559     BCase(SHF_X86_64_LARGE);
560     break;
561   default:
562     // Nothing to do.
563     break;
564   }
565 #undef BCase
566 }
567 
568 void ScalarEnumerationTraits<ELFYAML::ELF_SHN>::enumeration(
569     IO &IO, ELFYAML::ELF_SHN &Value) {
570 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
571   ECase(SHN_UNDEF);
572   ECase(SHN_LORESERVE);
573   ECase(SHN_LOPROC);
574   ECase(SHN_HIPROC);
575   ECase(SHN_LOOS);
576   ECase(SHN_HIOS);
577   ECase(SHN_ABS);
578   ECase(SHN_COMMON);
579   ECase(SHN_XINDEX);
580   ECase(SHN_HIRESERVE);
581   ECase(SHN_AMDGPU_LDS);
582   ECase(SHN_HEXAGON_SCOMMON);
583   ECase(SHN_HEXAGON_SCOMMON_1);
584   ECase(SHN_HEXAGON_SCOMMON_2);
585   ECase(SHN_HEXAGON_SCOMMON_4);
586   ECase(SHN_HEXAGON_SCOMMON_8);
587 #undef ECase
588   IO.enumFallback<Hex16>(Value);
589 }
590 
591 void ScalarEnumerationTraits<ELFYAML::ELF_STB>::enumeration(
592     IO &IO, ELFYAML::ELF_STB &Value) {
593 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
594   ECase(STB_LOCAL);
595   ECase(STB_GLOBAL);
596   ECase(STB_WEAK);
597   ECase(STB_GNU_UNIQUE);
598 #undef ECase
599   IO.enumFallback<Hex8>(Value);
600 }
601 
602 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
603     IO &IO, ELFYAML::ELF_STT &Value) {
604 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
605   ECase(STT_NOTYPE);
606   ECase(STT_OBJECT);
607   ECase(STT_FUNC);
608   ECase(STT_SECTION);
609   ECase(STT_FILE);
610   ECase(STT_COMMON);
611   ECase(STT_TLS);
612   ECase(STT_GNU_IFUNC);
613 #undef ECase
614   IO.enumFallback<Hex8>(Value);
615 }
616 
617 
618 void ScalarEnumerationTraits<ELFYAML::ELF_RSS>::enumeration(
619     IO &IO, ELFYAML::ELF_RSS &Value) {
620 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
621   ECase(RSS_UNDEF);
622   ECase(RSS_GP);
623   ECase(RSS_GP0);
624   ECase(RSS_LOC);
625 #undef ECase
626 }
627 
628 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
629     IO &IO, ELFYAML::ELF_REL &Value) {
630   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
631   assert(Object && "The IO context is not initialized");
632 #define ELF_RELOC(X, Y) IO.enumCase(Value, #X, ELF::X);
633   switch (Object->Header.Machine) {
634   case ELF::EM_X86_64:
635 #include "llvm/BinaryFormat/ELFRelocs/x86_64.def"
636     break;
637   case ELF::EM_MIPS:
638 #include "llvm/BinaryFormat/ELFRelocs/Mips.def"
639     break;
640   case ELF::EM_HEXAGON:
641 #include "llvm/BinaryFormat/ELFRelocs/Hexagon.def"
642     break;
643   case ELF::EM_386:
644   case ELF::EM_IAMCU:
645 #include "llvm/BinaryFormat/ELFRelocs/i386.def"
646     break;
647   case ELF::EM_AARCH64:
648 #include "llvm/BinaryFormat/ELFRelocs/AArch64.def"
649     break;
650   case ELF::EM_ARM:
651 #include "llvm/BinaryFormat/ELFRelocs/ARM.def"
652     break;
653   case ELF::EM_ARC:
654 #include "llvm/BinaryFormat/ELFRelocs/ARC.def"
655     break;
656   case ELF::EM_RISCV:
657 #include "llvm/BinaryFormat/ELFRelocs/RISCV.def"
658     break;
659   case ELF::EM_LANAI:
660 #include "llvm/BinaryFormat/ELFRelocs/Lanai.def"
661     break;
662   case ELF::EM_AMDGPU:
663 #include "llvm/BinaryFormat/ELFRelocs/AMDGPU.def"
664     break;
665   case ELF::EM_BPF:
666 #include "llvm/BinaryFormat/ELFRelocs/BPF.def"
667     break;
668   case ELF::EM_VE:
669 #include "llvm/BinaryFormat/ELFRelocs/VE.def"
670     break;
671   case ELF::EM_PPC64:
672 #include "llvm/BinaryFormat/ELFRelocs/PowerPC64.def"
673     break;
674   default:
675     // Nothing to do.
676     break;
677   }
678 #undef ELF_RELOC
679   IO.enumFallback<Hex32>(Value);
680 }
681 
682 void ScalarEnumerationTraits<ELFYAML::ELF_DYNTAG>::enumeration(
683     IO &IO, ELFYAML::ELF_DYNTAG &Value) {
684   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
685   assert(Object && "The IO context is not initialized");
686 
687 // Disable architecture specific tags by default. We might enable them below.
688 #define AARCH64_DYNAMIC_TAG(name, value)
689 #define MIPS_DYNAMIC_TAG(name, value)
690 #define HEXAGON_DYNAMIC_TAG(name, value)
691 #define PPC_DYNAMIC_TAG(name, value)
692 #define PPC64_DYNAMIC_TAG(name, value)
693 // Ignore marker tags such as DT_HIOS (maps to DT_VERNEEDNUM), etc.
694 #define DYNAMIC_TAG_MARKER(name, value)
695 
696 #define STRINGIFY(X) (#X)
697 #define DYNAMIC_TAG(X, Y) IO.enumCase(Value, STRINGIFY(DT_##X), ELF::DT_##X);
698   switch (Object->Header.Machine) {
699   case ELF::EM_AARCH64:
700 #undef AARCH64_DYNAMIC_TAG
701 #define AARCH64_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
702 #include "llvm/BinaryFormat/DynamicTags.def"
703 #undef AARCH64_DYNAMIC_TAG
704 #define AARCH64_DYNAMIC_TAG(name, value)
705     break;
706   case ELF::EM_MIPS:
707 #undef MIPS_DYNAMIC_TAG
708 #define MIPS_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
709 #include "llvm/BinaryFormat/DynamicTags.def"
710 #undef MIPS_DYNAMIC_TAG
711 #define MIPS_DYNAMIC_TAG(name, value)
712     break;
713   case ELF::EM_HEXAGON:
714 #undef HEXAGON_DYNAMIC_TAG
715 #define HEXAGON_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
716 #include "llvm/BinaryFormat/DynamicTags.def"
717 #undef HEXAGON_DYNAMIC_TAG
718 #define HEXAGON_DYNAMIC_TAG(name, value)
719     break;
720   case ELF::EM_PPC:
721 #undef PPC_DYNAMIC_TAG
722 #define PPC_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
723 #include "llvm/BinaryFormat/DynamicTags.def"
724 #undef PPC_DYNAMIC_TAG
725 #define PPC_DYNAMIC_TAG(name, value)
726     break;
727   case ELF::EM_PPC64:
728 #undef PPC64_DYNAMIC_TAG
729 #define PPC64_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
730 #include "llvm/BinaryFormat/DynamicTags.def"
731 #undef PPC64_DYNAMIC_TAG
732 #define PPC64_DYNAMIC_TAG(name, value)
733     break;
734   default:
735 #include "llvm/BinaryFormat/DynamicTags.def"
736     break;
737   }
738 #undef AARCH64_DYNAMIC_TAG
739 #undef MIPS_DYNAMIC_TAG
740 #undef HEXAGON_DYNAMIC_TAG
741 #undef PPC_DYNAMIC_TAG
742 #undef PPC64_DYNAMIC_TAG
743 #undef DYNAMIC_TAG_MARKER
744 #undef STRINGIFY
745 #undef DYNAMIC_TAG
746 
747   IO.enumFallback<Hex64>(Value);
748 }
749 
750 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_REG>::enumeration(
751     IO &IO, ELFYAML::MIPS_AFL_REG &Value) {
752 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
753   ECase(REG_NONE);
754   ECase(REG_32);
755   ECase(REG_64);
756   ECase(REG_128);
757 #undef ECase
758 }
759 
760 void ScalarEnumerationTraits<ELFYAML::MIPS_ABI_FP>::enumeration(
761     IO &IO, ELFYAML::MIPS_ABI_FP &Value) {
762 #define ECase(X) IO.enumCase(Value, #X, Mips::Val_GNU_MIPS_ABI_##X)
763   ECase(FP_ANY);
764   ECase(FP_DOUBLE);
765   ECase(FP_SINGLE);
766   ECase(FP_SOFT);
767   ECase(FP_OLD_64);
768   ECase(FP_XX);
769   ECase(FP_64);
770   ECase(FP_64A);
771 #undef ECase
772 }
773 
774 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_EXT>::enumeration(
775     IO &IO, ELFYAML::MIPS_AFL_EXT &Value) {
776 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
777   ECase(EXT_NONE);
778   ECase(EXT_XLR);
779   ECase(EXT_OCTEON2);
780   ECase(EXT_OCTEONP);
781   ECase(EXT_LOONGSON_3A);
782   ECase(EXT_OCTEON);
783   ECase(EXT_5900);
784   ECase(EXT_4650);
785   ECase(EXT_4010);
786   ECase(EXT_4100);
787   ECase(EXT_3900);
788   ECase(EXT_10000);
789   ECase(EXT_SB1);
790   ECase(EXT_4111);
791   ECase(EXT_4120);
792   ECase(EXT_5400);
793   ECase(EXT_5500);
794   ECase(EXT_LOONGSON_2E);
795   ECase(EXT_LOONGSON_2F);
796   ECase(EXT_OCTEON3);
797 #undef ECase
798 }
799 
800 void ScalarEnumerationTraits<ELFYAML::MIPS_ISA>::enumeration(
801     IO &IO, ELFYAML::MIPS_ISA &Value) {
802   IO.enumCase(Value, "MIPS1", 1);
803   IO.enumCase(Value, "MIPS2", 2);
804   IO.enumCase(Value, "MIPS3", 3);
805   IO.enumCase(Value, "MIPS4", 4);
806   IO.enumCase(Value, "MIPS5", 5);
807   IO.enumCase(Value, "MIPS32", 32);
808   IO.enumCase(Value, "MIPS64", 64);
809 }
810 
811 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_ASE>::bitset(
812     IO &IO, ELFYAML::MIPS_AFL_ASE &Value) {
813 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_ASE_##X)
814   BCase(DSP);
815   BCase(DSPR2);
816   BCase(EVA);
817   BCase(MCU);
818   BCase(MDMX);
819   BCase(MIPS3D);
820   BCase(MT);
821   BCase(SMARTMIPS);
822   BCase(VIRT);
823   BCase(MSA);
824   BCase(MIPS16);
825   BCase(MICROMIPS);
826   BCase(XPA);
827   BCase(CRC);
828   BCase(GINV);
829 #undef BCase
830 }
831 
832 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_FLAGS1>::bitset(
833     IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value) {
834 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_FLAGS1_##X)
835   BCase(ODDSPREG);
836 #undef BCase
837 }
838 
839 void MappingTraits<ELFYAML::SectionHeader>::mapping(
840     IO &IO, ELFYAML::SectionHeader &SHdr) {
841   IO.mapRequired("Name", SHdr.Name);
842 }
843 
844 void MappingTraits<ELFYAML::SectionHeaderTable>::mapping(
845     IO &IO, ELFYAML::SectionHeaderTable &SectionHeader) {
846   IO.mapOptional("Sections", SectionHeader.Sections);
847   IO.mapOptional("Excluded", SectionHeader.Excluded);
848   IO.mapOptional("NoHeaders", SectionHeader.NoHeaders);
849 }
850 
851 StringRef MappingTraits<ELFYAML::SectionHeaderTable>::validate(
852     IO &IO, ELFYAML::SectionHeaderTable &SecHdrTable) {
853   if (SecHdrTable.NoHeaders && (SecHdrTable.Sections || SecHdrTable.Excluded))
854     return "NoHeaders can't be used together with Sections/Excluded";
855   if (!SecHdrTable.NoHeaders && !SecHdrTable.Sections && !SecHdrTable.Excluded)
856     return "SectionHeaderTable can't be empty. Use 'NoHeaders' key to drop the "
857            "section header table";
858   return StringRef();
859 }
860 
861 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
862                                                  ELFYAML::FileHeader &FileHdr) {
863   IO.mapRequired("Class", FileHdr.Class);
864   IO.mapRequired("Data", FileHdr.Data);
865   IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
866   IO.mapOptional("ABIVersion", FileHdr.ABIVersion, Hex8(0));
867   IO.mapRequired("Type", FileHdr.Type);
868   IO.mapRequired("Machine", FileHdr.Machine);
869   IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
870   IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
871 
872   // obj2yaml does not dump these fields.
873   assert(!IO.outputting() ||
874          (!FileHdr.EPhOff && !FileHdr.EPhEntSize && !FileHdr.EPhNum));
875   IO.mapOptional("EPhOff", FileHdr.EPhOff);
876   IO.mapOptional("EPhEntSize", FileHdr.EPhEntSize);
877   IO.mapOptional("EPhNum", FileHdr.EPhNum);
878   IO.mapOptional("EShEntSize", FileHdr.EShEntSize);
879   IO.mapOptional("EShOff", FileHdr.EShOff);
880   IO.mapOptional("EShNum", FileHdr.EShNum);
881   IO.mapOptional("EShStrNdx", FileHdr.EShStrNdx);
882 }
883 
884 void MappingTraits<ELFYAML::ProgramHeader>::mapping(
885     IO &IO, ELFYAML::ProgramHeader &Phdr) {
886   IO.mapRequired("Type", Phdr.Type);
887   IO.mapOptional("Flags", Phdr.Flags, ELFYAML::ELF_PF(0));
888   IO.mapOptional("Sections", Phdr.Sections);
889   IO.mapOptional("VAddr", Phdr.VAddr, Hex64(0));
890   IO.mapOptional("PAddr", Phdr.PAddr, Phdr.VAddr);
891   IO.mapOptional("Align", Phdr.Align);
892   IO.mapOptional("FileSize", Phdr.FileSize);
893   IO.mapOptional("MemSize", Phdr.MemSize);
894   IO.mapOptional("Offset", Phdr.Offset);
895 }
896 
897 LLVM_YAML_STRONG_TYPEDEF(StringRef, StOtherPiece)
898 
899 template <> struct ScalarTraits<StOtherPiece> {
900   static void output(const StOtherPiece &Val, void *, raw_ostream &Out) {
901     Out << Val;
902   }
903   static StringRef input(StringRef Scalar, void *, StOtherPiece &Val) {
904     Val = Scalar;
905     return {};
906   }
907   static QuotingType mustQuote(StringRef) { return QuotingType::None; }
908 };
909 template <> struct SequenceElementTraits<StOtherPiece> {
910   static const bool flow = true;
911 };
912 
913 template <> struct ScalarTraits<ELFYAML::YAMLFlowString> {
914   static void output(const ELFYAML::YAMLFlowString &Val, void *,
915                      raw_ostream &Out) {
916     Out << Val;
917   }
918   static StringRef input(StringRef Scalar, void *,
919                          ELFYAML::YAMLFlowString &Val) {
920     Val = Scalar;
921     return {};
922   }
923   static QuotingType mustQuote(StringRef S) {
924     return ScalarTraits<StringRef>::mustQuote(S);
925   }
926 };
927 template <> struct SequenceElementTraits<ELFYAML::YAMLFlowString> {
928   static const bool flow = true;
929 };
930 
931 namespace {
932 
933 struct NormalizedOther {
934   NormalizedOther(IO &IO) : YamlIO(IO) {}
935   NormalizedOther(IO &IO, Optional<uint8_t> Original) : YamlIO(IO) {
936     assert(Original && "This constructor is only used for outputting YAML and "
937                        "assumes a non-empty Original");
938     std::vector<StOtherPiece> Ret;
939     const auto *Object = static_cast<ELFYAML::Object *>(YamlIO.getContext());
940     for (std::pair<StringRef, uint8_t> &P :
941          getFlags(Object->Header.Machine).takeVector()) {
942       uint8_t FlagValue = P.second;
943       if ((*Original & FlagValue) != FlagValue)
944         continue;
945       *Original &= ~FlagValue;
946       Ret.push_back({P.first});
947     }
948 
949     if (*Original != 0) {
950       UnknownFlagsHolder = std::to_string(*Original);
951       Ret.push_back({UnknownFlagsHolder});
952     }
953 
954     if (!Ret.empty())
955       Other = std::move(Ret);
956   }
957 
958   uint8_t toValue(StringRef Name) {
959     const auto *Object = static_cast<ELFYAML::Object *>(YamlIO.getContext());
960     MapVector<StringRef, uint8_t> Flags = getFlags(Object->Header.Machine);
961 
962     auto It = Flags.find(Name);
963     if (It != Flags.end())
964       return It->second;
965 
966     uint8_t Val;
967     if (to_integer(Name, Val))
968       return Val;
969 
970     YamlIO.setError("an unknown value is used for symbol's 'Other' field: " +
971                     Name);
972     return 0;
973   }
974 
975   Optional<uint8_t> denormalize(IO &) {
976     if (!Other)
977       return None;
978     uint8_t Ret = 0;
979     for (StOtherPiece &Val : *Other)
980       Ret |= toValue(Val);
981     return Ret;
982   }
983 
984   // st_other field is used to encode symbol visibility and platform-dependent
985   // flags and values. This method returns a name to value map that is used for
986   // parsing and encoding this field.
987   MapVector<StringRef, uint8_t> getFlags(unsigned EMachine) {
988     MapVector<StringRef, uint8_t> Map;
989     // STV_* values are just enumeration values. We add them in a reversed order
990     // because when we convert the st_other to named constants when printing
991     // YAML we want to use a maximum number of bits on each step:
992     // when we have st_other == 3, we want to print it as STV_PROTECTED (3), but
993     // not as STV_HIDDEN (2) + STV_INTERNAL (1).
994     Map["STV_PROTECTED"] = ELF::STV_PROTECTED;
995     Map["STV_HIDDEN"] = ELF::STV_HIDDEN;
996     Map["STV_INTERNAL"] = ELF::STV_INTERNAL;
997     // STV_DEFAULT is used to represent the default visibility and has a value
998     // 0. We want to be able to read it from YAML documents, but there is no
999     // reason to print it.
1000     if (!YamlIO.outputting())
1001       Map["STV_DEFAULT"] = ELF::STV_DEFAULT;
1002 
1003     // MIPS is not consistent. All of the STO_MIPS_* values are bit flags,
1004     // except STO_MIPS_MIPS16 which overlaps them. It should be checked and
1005     // consumed first when we print the output, because we do not want to print
1006     // any other flags that have the same bits instead.
1007     if (EMachine == ELF::EM_MIPS) {
1008       Map["STO_MIPS_MIPS16"] = ELF::STO_MIPS_MIPS16;
1009       Map["STO_MIPS_MICROMIPS"] = ELF::STO_MIPS_MICROMIPS;
1010       Map["STO_MIPS_PIC"] = ELF::STO_MIPS_PIC;
1011       Map["STO_MIPS_PLT"] = ELF::STO_MIPS_PLT;
1012       Map["STO_MIPS_OPTIONAL"] = ELF::STO_MIPS_OPTIONAL;
1013     }
1014     return Map;
1015   }
1016 
1017   IO &YamlIO;
1018   Optional<std::vector<StOtherPiece>> Other;
1019   std::string UnknownFlagsHolder;
1020 };
1021 
1022 } // end anonymous namespace
1023 
1024 void ScalarTraits<ELFYAML::YAMLIntUInt>::output(const ELFYAML::YAMLIntUInt &Val,
1025                                                 void *Ctx, raw_ostream &Out) {
1026   Out << Val;
1027 }
1028 
1029 StringRef ScalarTraits<ELFYAML::YAMLIntUInt>::input(StringRef Scalar, void *Ctx,
1030                                                     ELFYAML::YAMLIntUInt &Val) {
1031   const bool Is64 = static_cast<ELFYAML::Object *>(Ctx)->Header.Class ==
1032                     ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64);
1033   StringRef ErrMsg = "invalid number";
1034   // We do not accept negative hex numbers because their meaning is ambiguous.
1035   // For example, would -0xfffffffff mean 1 or INT32_MIN?
1036   if (Scalar.empty() || Scalar.startswith("-0x"))
1037     return ErrMsg;
1038 
1039   if (Scalar.startswith("-")) {
1040     const int64_t MinVal = Is64 ? INT64_MIN : INT32_MIN;
1041     long long Int;
1042     if (getAsSignedInteger(Scalar, /*Radix=*/0, Int) || (Int < MinVal))
1043       return ErrMsg;
1044     Val = Int;
1045     return "";
1046   }
1047 
1048   const uint64_t MaxVal = Is64 ? UINT64_MAX : UINT32_MAX;
1049   unsigned long long UInt;
1050   if (getAsUnsignedInteger(Scalar, /*Radix=*/0, UInt) || (UInt > MaxVal))
1051     return ErrMsg;
1052   Val = UInt;
1053   return "";
1054 }
1055 
1056 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
1057   IO.mapOptional("Name", Symbol.Name, StringRef());
1058   IO.mapOptional("StName", Symbol.StName);
1059   IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
1060   IO.mapOptional("Section", Symbol.Section, StringRef());
1061   IO.mapOptional("Index", Symbol.Index);
1062   IO.mapOptional("Binding", Symbol.Binding, ELFYAML::ELF_STB(0));
1063   IO.mapOptional("Value", Symbol.Value, Hex64(0));
1064   IO.mapOptional("Size", Symbol.Size, Hex64(0));
1065 
1066   // Symbol's Other field is a bit special. It is usually a field that
1067   // represents st_other and holds the symbol visibility. However, on some
1068   // platforms, it can contain bit fields and regular values, or even sometimes a
1069   // crazy mix of them (see comments for NormalizedOther). Because of this, we
1070   // need special handling.
1071   MappingNormalization<NormalizedOther, Optional<uint8_t>> Keys(IO,
1072                                                                 Symbol.Other);
1073   IO.mapOptional("Other", Keys->Other);
1074 }
1075 
1076 StringRef MappingTraits<ELFYAML::Symbol>::validate(IO &IO,
1077                                                    ELFYAML::Symbol &Symbol) {
1078   if (Symbol.Index && Symbol.Section.data())
1079     return "Index and Section cannot both be specified for Symbol";
1080   return StringRef();
1081 }
1082 
1083 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
1084   IO.mapOptional("Name", Section.Name, StringRef());
1085   IO.mapRequired("Type", Section.Type);
1086   IO.mapOptional("Flags", Section.Flags);
1087   IO.mapOptional("Address", Section.Address);
1088   IO.mapOptional("Link", Section.Link, StringRef());
1089   IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
1090   IO.mapOptional("EntSize", Section.EntSize);
1091   IO.mapOptional("Offset", Section.Offset);
1092 
1093   // obj2yaml does not dump these fields. They are expected to be empty when we
1094   // are producing YAML, because yaml2obj sets appropriate values for them
1095   // automatically when they are not explicitly defined.
1096   assert(!IO.outputting() ||
1097          (!Section.ShOffset.hasValue() && !Section.ShSize.hasValue() &&
1098           !Section.ShName.hasValue() && !Section.ShFlags.hasValue() &&
1099           !Section.ShType.hasValue()));
1100   IO.mapOptional("ShName", Section.ShName);
1101   IO.mapOptional("ShOffset", Section.ShOffset);
1102   IO.mapOptional("ShSize", Section.ShSize);
1103   IO.mapOptional("ShFlags", Section.ShFlags);
1104   IO.mapOptional("ShType", Section.ShType);
1105 }
1106 
1107 static void sectionMapping(IO &IO, ELFYAML::DynamicSection &Section) {
1108   commonSectionMapping(IO, Section);
1109   IO.mapOptional("Entries", Section.Entries);
1110   IO.mapOptional("Content", Section.Content);
1111 }
1112 
1113 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
1114   commonSectionMapping(IO, Section);
1115   IO.mapOptional("Content", Section.Content);
1116 
1117   // We also support reading a content as array of bytes using the ContentArray
1118   // key. obj2yaml never prints this field.
1119   assert(!IO.outputting() || !Section.ContentBuf.hasValue());
1120   IO.mapOptional("ContentArray", Section.ContentBuf);
1121   if (Section.ContentBuf) {
1122     if (Section.Content)
1123       IO.setError("Content and ContentArray can't be used together");
1124     Section.Content = yaml::BinaryRef(*Section.ContentBuf);
1125   }
1126 
1127   IO.mapOptional("Size", Section.Size);
1128   IO.mapOptional("Info", Section.Info);
1129 }
1130 
1131 static void sectionMapping(IO &IO, ELFYAML::StackSizesSection &Section) {
1132   commonSectionMapping(IO, Section);
1133   IO.mapOptional("Content", Section.Content);
1134   IO.mapOptional("Size", Section.Size);
1135   IO.mapOptional("Entries", Section.Entries);
1136 }
1137 
1138 static void sectionMapping(IO &IO, ELFYAML::HashSection &Section) {
1139   commonSectionMapping(IO, Section);
1140   IO.mapOptional("Content", Section.Content);
1141   IO.mapOptional("Bucket", Section.Bucket);
1142   IO.mapOptional("Chain", Section.Chain);
1143   IO.mapOptional("Size", Section.Size);
1144 
1145   // obj2yaml does not dump these fields. They can be used to override nchain
1146   // and nbucket values for creating broken sections.
1147   assert(!IO.outputting() ||
1148          (!Section.NBucket.hasValue() && !Section.NChain.hasValue()));
1149   IO.mapOptional("NChain", Section.NChain);
1150   IO.mapOptional("NBucket", Section.NBucket);
1151 }
1152 
1153 static void sectionMapping(IO &IO, ELFYAML::NoteSection &Section) {
1154   commonSectionMapping(IO, Section);
1155   IO.mapOptional("Content", Section.Content);
1156   IO.mapOptional("Size", Section.Size);
1157   IO.mapOptional("Notes", Section.Notes);
1158 }
1159 
1160 
1161 static void sectionMapping(IO &IO, ELFYAML::GnuHashSection &Section) {
1162   commonSectionMapping(IO, Section);
1163   IO.mapOptional("Content", Section.Content);
1164   IO.mapOptional("Header", Section.Header);
1165   IO.mapOptional("BloomFilter", Section.BloomFilter);
1166   IO.mapOptional("HashBuckets", Section.HashBuckets);
1167   IO.mapOptional("HashValues", Section.HashValues);
1168 }
1169 static void sectionMapping(IO &IO, ELFYAML::NoBitsSection &Section) {
1170   commonSectionMapping(IO, Section);
1171   IO.mapOptional("Size", Section.Size, Hex64(0));
1172 }
1173 
1174 static void sectionMapping(IO &IO, ELFYAML::VerdefSection &Section) {
1175   commonSectionMapping(IO, Section);
1176   IO.mapRequired("Info", Section.Info);
1177   IO.mapOptional("Entries", Section.Entries);
1178   IO.mapOptional("Content", Section.Content);
1179 }
1180 
1181 static void sectionMapping(IO &IO, ELFYAML::SymverSection &Section) {
1182   commonSectionMapping(IO, Section);
1183   IO.mapRequired("Entries", Section.Entries);
1184 }
1185 
1186 static void sectionMapping(IO &IO, ELFYAML::VerneedSection &Section) {
1187   commonSectionMapping(IO, Section);
1188   IO.mapRequired("Info", Section.Info);
1189   IO.mapOptional("Dependencies", Section.VerneedV);
1190   IO.mapOptional("Content", Section.Content);
1191 }
1192 
1193 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
1194   commonSectionMapping(IO, Section);
1195   IO.mapOptional("Info", Section.RelocatableSec, StringRef());
1196   IO.mapOptional("Relocations", Section.Relocations);
1197 }
1198 
1199 static void sectionMapping(IO &IO, ELFYAML::RelrSection &Section) {
1200   commonSectionMapping(IO, Section);
1201   IO.mapOptional("Entries", Section.Entries);
1202   IO.mapOptional("Content", Section.Content);
1203 }
1204 
1205 static void groupSectionMapping(IO &IO, ELFYAML::Group &Group) {
1206   commonSectionMapping(IO, Group);
1207   IO.mapOptional("Info", Group.Signature);
1208   IO.mapRequired("Members", Group.Members);
1209 }
1210 
1211 static void sectionMapping(IO &IO, ELFYAML::SymtabShndxSection &Section) {
1212   commonSectionMapping(IO, Section);
1213   IO.mapRequired("Entries", Section.Entries);
1214 }
1215 
1216 static void sectionMapping(IO &IO, ELFYAML::AddrsigSection &Section) {
1217   commonSectionMapping(IO, Section);
1218   IO.mapOptional("Content", Section.Content);
1219   IO.mapOptional("Size", Section.Size);
1220   IO.mapOptional("Symbols", Section.Symbols);
1221 }
1222 
1223 static void fillMapping(IO &IO, ELFYAML::Fill &Fill) {
1224   IO.mapOptional("Name", Fill.Name, StringRef());
1225   IO.mapOptional("Pattern", Fill.Pattern);
1226   IO.mapOptional("Offset", Fill.Offset);
1227   IO.mapRequired("Size", Fill.Size);
1228 }
1229 
1230 static void sectionMapping(IO &IO, ELFYAML::LinkerOptionsSection &Section) {
1231   commonSectionMapping(IO, Section);
1232   IO.mapOptional("Options", Section.Options);
1233   IO.mapOptional("Content", Section.Content);
1234 }
1235 
1236 static void sectionMapping(IO &IO,
1237                            ELFYAML::DependentLibrariesSection &Section) {
1238   commonSectionMapping(IO, Section);
1239   IO.mapOptional("Libraries", Section.Libs);
1240   IO.mapOptional("Content", Section.Content);
1241 }
1242 
1243 static void sectionMapping(IO &IO, ELFYAML::CallGraphProfileSection &Section) {
1244   commonSectionMapping(IO, Section);
1245   IO.mapOptional("Entries", Section.Entries);
1246   IO.mapOptional("Content", Section.Content);
1247 }
1248 
1249 void MappingTraits<ELFYAML::SectionOrType>::mapping(
1250     IO &IO, ELFYAML::SectionOrType &sectionOrType) {
1251   IO.mapRequired("SectionOrType", sectionOrType.sectionNameOrType);
1252 }
1253 
1254 void MappingTraits<ELFYAML::SectionName>::mapping(
1255     IO &IO, ELFYAML::SectionName &sectionName) {
1256   IO.mapRequired("Section", sectionName.Section);
1257 }
1258 
1259 static void sectionMapping(IO &IO, ELFYAML::MipsABIFlags &Section) {
1260   commonSectionMapping(IO, Section);
1261   IO.mapOptional("Version", Section.Version, Hex16(0));
1262   IO.mapRequired("ISA", Section.ISALevel);
1263   IO.mapOptional("ISARevision", Section.ISARevision, Hex8(0));
1264   IO.mapOptional("ISAExtension", Section.ISAExtension,
1265                  ELFYAML::MIPS_AFL_EXT(Mips::AFL_EXT_NONE));
1266   IO.mapOptional("ASEs", Section.ASEs, ELFYAML::MIPS_AFL_ASE(0));
1267   IO.mapOptional("FpABI", Section.FpABI,
1268                  ELFYAML::MIPS_ABI_FP(Mips::Val_GNU_MIPS_ABI_FP_ANY));
1269   IO.mapOptional("GPRSize", Section.GPRSize,
1270                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1271   IO.mapOptional("CPR1Size", Section.CPR1Size,
1272                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1273   IO.mapOptional("CPR2Size", Section.CPR2Size,
1274                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1275   IO.mapOptional("Flags1", Section.Flags1, ELFYAML::MIPS_AFL_FLAGS1(0));
1276   IO.mapOptional("Flags2", Section.Flags2, Hex32(0));
1277 }
1278 
1279 void MappingTraits<std::unique_ptr<ELFYAML::Chunk>>::mapping(
1280     IO &IO, std::unique_ptr<ELFYAML::Chunk> &Section) {
1281   ELFYAML::ELF_SHT Type;
1282   if (IO.outputting()) {
1283     Type = cast<ELFYAML::Section>(Section.get())->Type;
1284   } else {
1285     // When the Type string does not have a "SHT_" prefix, we know it is not a
1286     // description of a regular ELF output section. Currently, we have one
1287     // special type named "Fill". See comments for Fill.
1288     StringRef StrType;
1289     IO.mapRequired("Type", StrType);
1290     if (StrType == "Fill") {
1291       Section.reset(new ELFYAML::Fill());
1292       fillMapping(IO, *cast<ELFYAML::Fill>(Section.get()));
1293       return;
1294     }
1295 
1296     IO.mapRequired("Type", Type);
1297   }
1298 
1299   switch (Type) {
1300   case ELF::SHT_DYNAMIC:
1301     if (!IO.outputting())
1302       Section.reset(new ELFYAML::DynamicSection());
1303     sectionMapping(IO, *cast<ELFYAML::DynamicSection>(Section.get()));
1304     break;
1305   case ELF::SHT_REL:
1306   case ELF::SHT_RELA:
1307     if (!IO.outputting())
1308       Section.reset(new ELFYAML::RelocationSection());
1309     sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
1310     break;
1311   case ELF::SHT_RELR:
1312     if (!IO.outputting())
1313       Section.reset(new ELFYAML::RelrSection());
1314     sectionMapping(IO, *cast<ELFYAML::RelrSection>(Section.get()));
1315     break;
1316   case ELF::SHT_GROUP:
1317     if (!IO.outputting())
1318       Section.reset(new ELFYAML::Group());
1319     groupSectionMapping(IO, *cast<ELFYAML::Group>(Section.get()));
1320     break;
1321   case ELF::SHT_NOBITS:
1322     if (!IO.outputting())
1323       Section.reset(new ELFYAML::NoBitsSection());
1324     sectionMapping(IO, *cast<ELFYAML::NoBitsSection>(Section.get()));
1325     break;
1326   case ELF::SHT_HASH:
1327     if (!IO.outputting())
1328       Section.reset(new ELFYAML::HashSection());
1329     sectionMapping(IO, *cast<ELFYAML::HashSection>(Section.get()));
1330     break;
1331   case ELF::SHT_NOTE:
1332     if (!IO.outputting())
1333       Section.reset(new ELFYAML::NoteSection());
1334     sectionMapping(IO, *cast<ELFYAML::NoteSection>(Section.get()));
1335     break;
1336  case ELF::SHT_GNU_HASH:
1337     if (!IO.outputting())
1338       Section.reset(new ELFYAML::GnuHashSection());
1339     sectionMapping(IO, *cast<ELFYAML::GnuHashSection>(Section.get()));
1340     break;
1341   case ELF::SHT_MIPS_ABIFLAGS:
1342     if (!IO.outputting())
1343       Section.reset(new ELFYAML::MipsABIFlags());
1344     sectionMapping(IO, *cast<ELFYAML::MipsABIFlags>(Section.get()));
1345     break;
1346   case ELF::SHT_GNU_verdef:
1347     if (!IO.outputting())
1348       Section.reset(new ELFYAML::VerdefSection());
1349     sectionMapping(IO, *cast<ELFYAML::VerdefSection>(Section.get()));
1350     break;
1351   case ELF::SHT_GNU_versym:
1352     if (!IO.outputting())
1353       Section.reset(new ELFYAML::SymverSection());
1354     sectionMapping(IO, *cast<ELFYAML::SymverSection>(Section.get()));
1355     break;
1356   case ELF::SHT_GNU_verneed:
1357     if (!IO.outputting())
1358       Section.reset(new ELFYAML::VerneedSection());
1359     sectionMapping(IO, *cast<ELFYAML::VerneedSection>(Section.get()));
1360     break;
1361   case ELF::SHT_SYMTAB_SHNDX:
1362     if (!IO.outputting())
1363       Section.reset(new ELFYAML::SymtabShndxSection());
1364     sectionMapping(IO, *cast<ELFYAML::SymtabShndxSection>(Section.get()));
1365     break;
1366   case ELF::SHT_LLVM_ADDRSIG:
1367     if (!IO.outputting())
1368       Section.reset(new ELFYAML::AddrsigSection());
1369     sectionMapping(IO, *cast<ELFYAML::AddrsigSection>(Section.get()));
1370     break;
1371   case ELF::SHT_LLVM_LINKER_OPTIONS:
1372     if (!IO.outputting())
1373       Section.reset(new ELFYAML::LinkerOptionsSection());
1374     sectionMapping(IO, *cast<ELFYAML::LinkerOptionsSection>(Section.get()));
1375     break;
1376   case ELF::SHT_LLVM_DEPENDENT_LIBRARIES:
1377     if (!IO.outputting())
1378       Section.reset(new ELFYAML::DependentLibrariesSection());
1379     sectionMapping(IO,
1380                    *cast<ELFYAML::DependentLibrariesSection>(Section.get()));
1381     break;
1382   case ELF::SHT_LLVM_CALL_GRAPH_PROFILE:
1383     if (!IO.outputting())
1384       Section.reset(new ELFYAML::CallGraphProfileSection());
1385     sectionMapping(IO, *cast<ELFYAML::CallGraphProfileSection>(Section.get()));
1386     break;
1387   default:
1388     if (!IO.outputting()) {
1389       StringRef Name;
1390       IO.mapOptional("Name", Name, StringRef());
1391       Name = ELFYAML::dropUniqueSuffix(Name);
1392 
1393       if (ELFYAML::StackSizesSection::nameMatches(Name))
1394         Section = std::make_unique<ELFYAML::StackSizesSection>();
1395       else
1396         Section = std::make_unique<ELFYAML::RawContentSection>();
1397     }
1398 
1399     if (auto S = dyn_cast<ELFYAML::RawContentSection>(Section.get()))
1400       sectionMapping(IO, *S);
1401     else
1402       sectionMapping(IO, *cast<ELFYAML::StackSizesSection>(Section.get()));
1403   }
1404 }
1405 
1406 StringRef MappingTraits<std::unique_ptr<ELFYAML::Chunk>>::validate(
1407     IO &io, std::unique_ptr<ELFYAML::Chunk> &C) {
1408   if (const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(C.get())) {
1409     if (RawSection->Size && RawSection->Content &&
1410         (uint64_t)(*RawSection->Size) < RawSection->Content->binary_size())
1411       return "Section size must be greater than or equal to the content size";
1412     if (RawSection->Flags && RawSection->ShFlags)
1413       return "ShFlags and Flags cannot be used together";
1414     return {};
1415   }
1416 
1417   if (const auto *SS = dyn_cast<ELFYAML::StackSizesSection>(C.get())) {
1418     if (!SS->Entries && !SS->Content && !SS->Size)
1419       return ".stack_sizes: one of Content, Entries and Size must be specified";
1420 
1421     if (SS->Size && SS->Content &&
1422         (uint64_t)(*SS->Size) < SS->Content->binary_size())
1423       return ".stack_sizes: Size must be greater than or equal to the content "
1424              "size";
1425 
1426     // We accept Content, Size or both together when there are no Entries.
1427     if (!SS->Entries)
1428       return {};
1429 
1430     if (SS->Size)
1431       return ".stack_sizes: Size and Entries cannot be used together";
1432     if (SS->Content)
1433       return ".stack_sizes: Content and Entries cannot be used together";
1434     return {};
1435   }
1436 
1437   if (const auto *HS = dyn_cast<ELFYAML::HashSection>(C.get())) {
1438     if (!HS->Content && !HS->Bucket && !HS->Chain && !HS->Size)
1439       return "one of \"Content\", \"Size\", \"Bucket\" or \"Chain\" must be "
1440              "specified";
1441 
1442     if (HS->Content || HS->Size) {
1443       if (HS->Size && HS->Content &&
1444           (uint64_t)*HS->Size < HS->Content->binary_size())
1445         return "\"Size\" must be greater than or equal to the content "
1446                "size";
1447 
1448       if (HS->Bucket)
1449         return "\"Bucket\" cannot be used with \"Content\" or \"Size\"";
1450       if (HS->Chain)
1451         return "\"Chain\" cannot be used with \"Content\" or \"Size\"";
1452       return {};
1453     }
1454 
1455     if ((HS->Bucket && !HS->Chain) || (!HS->Bucket && HS->Chain))
1456       return "\"Bucket\" and \"Chain\" must be used together";
1457     return {};
1458   }
1459 
1460   if (const auto *Sec = dyn_cast<ELFYAML::AddrsigSection>(C.get())) {
1461     if (!Sec->Symbols && !Sec->Content && !Sec->Size)
1462       return "one of \"Content\", \"Size\" or \"Symbols\" must be specified";
1463 
1464     if (Sec->Content || Sec->Size) {
1465       if (Sec->Size && Sec->Content &&
1466           (uint64_t)*Sec->Size < Sec->Content->binary_size())
1467         return "\"Size\" must be greater than or equal to the content "
1468                "size";
1469 
1470       if (Sec->Symbols)
1471         return "\"Symbols\" cannot be used with \"Content\" or \"Size\"";
1472       return {};
1473     }
1474 
1475     if (!Sec->Symbols)
1476       return {};
1477     return {};
1478   }
1479 
1480   if (const auto *NS = dyn_cast<ELFYAML::NoteSection>(C.get())) {
1481     if (!NS->Content && !NS->Size && !NS->Notes)
1482       return "one of \"Content\", \"Size\" or \"Notes\" must be "
1483              "specified";
1484 
1485     if (!NS->Content && !NS->Size)
1486       return {};
1487 
1488     if (NS->Size && NS->Content &&
1489         (uint64_t)*NS->Size < NS->Content->binary_size())
1490       return "\"Size\" must be greater than or equal to the content "
1491              "size";
1492 
1493     if (NS->Notes)
1494       return "\"Notes\" cannot be used with \"Content\" or \"Size\"";
1495     return {};
1496   }
1497 
1498   if (const auto *Sec = dyn_cast<ELFYAML::GnuHashSection>(C.get())) {
1499     if (!Sec->Content && !Sec->Header && !Sec->BloomFilter &&
1500         !Sec->HashBuckets && !Sec->HashValues)
1501       return "either \"Content\" or \"Header\", \"BloomFilter\", "
1502              "\"HashBuckets\" and \"HashBuckets\" must be specified";
1503 
1504     if (Sec->Header || Sec->BloomFilter || Sec->HashBuckets ||
1505         Sec->HashValues) {
1506       if (!Sec->Header || !Sec->BloomFilter || !Sec->HashBuckets ||
1507           !Sec->HashValues)
1508         return "\"Header\", \"BloomFilter\", "
1509                "\"HashBuckets\" and \"HashValues\" must be used together";
1510       if (Sec->Content)
1511         return "\"Header\", \"BloomFilter\", "
1512                "\"HashBuckets\" and \"HashValues\" can't be used together with "
1513                "\"Content\"";
1514       return {};
1515     }
1516 
1517     // Only Content is specified.
1518     return {};
1519   }
1520 
1521   if (const auto *Sec = dyn_cast<ELFYAML::LinkerOptionsSection>(C.get())) {
1522     if (Sec->Options && Sec->Content)
1523       return "\"Options\" and \"Content\" can't be used together";
1524     return {};
1525   }
1526 
1527   if (const auto *Sec = dyn_cast<ELFYAML::DependentLibrariesSection>(C.get())) {
1528     if (Sec->Libs && Sec->Content)
1529       return "SHT_LLVM_DEPENDENT_LIBRARIES: \"Libraries\" and \"Content\" "
1530              "can't "
1531              "be used together";
1532     return {};
1533   }
1534 
1535   if (const auto *F = dyn_cast<ELFYAML::Fill>(C.get())) {
1536     if (!F->Pattern)
1537       return {};
1538     if (F->Pattern->binary_size() != 0 && !F->Size)
1539       return "\"Size\" can't be 0 when \"Pattern\" is not empty";
1540     return {};
1541   }
1542 
1543   if (const auto *VD = dyn_cast<ELFYAML::VerdefSection>(C.get())) {
1544     if (VD->Entries && VD->Content)
1545       return "SHT_GNU_verdef: \"Entries\" and \"Content\" can't be used "
1546              "together";
1547     return {};
1548   }
1549 
1550   if (const auto *VD = dyn_cast<ELFYAML::VerneedSection>(C.get())) {
1551     if (VD->VerneedV && VD->Content)
1552       return "SHT_GNU_verneed: \"Dependencies\" and \"Content\" can't be used "
1553              "together";
1554     return {};
1555   }
1556 
1557   if (const auto *RS = dyn_cast<ELFYAML::RelrSection>(C.get())) {
1558     if (RS->Entries && RS->Content)
1559       return "\"Entries\" and \"Content\" can't be used together";
1560     return {};
1561   }
1562 
1563   if (const auto *CGP = dyn_cast<ELFYAML::CallGraphProfileSection>(C.get())) {
1564     if (CGP->Entries && CGP->Content)
1565       return "\"Entries\" and \"Content\" can't be used together";
1566     return {};
1567   }
1568 
1569   return {};
1570 }
1571 
1572 namespace {
1573 
1574 struct NormalizedMips64RelType {
1575   NormalizedMips64RelType(IO &)
1576       : Type(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1577         Type2(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1578         Type3(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1579         SpecSym(ELFYAML::ELF_REL(ELF::RSS_UNDEF)) {}
1580   NormalizedMips64RelType(IO &, ELFYAML::ELF_REL Original)
1581       : Type(Original & 0xFF), Type2(Original >> 8 & 0xFF),
1582         Type3(Original >> 16 & 0xFF), SpecSym(Original >> 24 & 0xFF) {}
1583 
1584   ELFYAML::ELF_REL denormalize(IO &) {
1585     ELFYAML::ELF_REL Res = Type | Type2 << 8 | Type3 << 16 | SpecSym << 24;
1586     return Res;
1587   }
1588 
1589   ELFYAML::ELF_REL Type;
1590   ELFYAML::ELF_REL Type2;
1591   ELFYAML::ELF_REL Type3;
1592   ELFYAML::ELF_RSS SpecSym;
1593 };
1594 
1595 } // end anonymous namespace
1596 
1597 void MappingTraits<ELFYAML::StackSizeEntry>::mapping(
1598     IO &IO, ELFYAML::StackSizeEntry &E) {
1599   assert(IO.getContext() && "The IO context is not initialized");
1600   IO.mapOptional("Address", E.Address, Hex64(0));
1601   IO.mapRequired("Size", E.Size);
1602 }
1603 
1604 void MappingTraits<ELFYAML::GnuHashHeader>::mapping(IO &IO,
1605                                                     ELFYAML::GnuHashHeader &E) {
1606   assert(IO.getContext() && "The IO context is not initialized");
1607   IO.mapOptional("NBuckets", E.NBuckets);
1608   IO.mapRequired("SymNdx", E.SymNdx);
1609   IO.mapOptional("MaskWords", E.MaskWords);
1610   IO.mapRequired("Shift2", E.Shift2);
1611 }
1612 
1613 void MappingTraits<ELFYAML::DynamicEntry>::mapping(IO &IO,
1614                                                    ELFYAML::DynamicEntry &Rel) {
1615   assert(IO.getContext() && "The IO context is not initialized");
1616 
1617   IO.mapRequired("Tag", Rel.Tag);
1618   IO.mapRequired("Value", Rel.Val);
1619 }
1620 
1621 void MappingTraits<ELFYAML::NoteEntry>::mapping(IO &IO, ELFYAML::NoteEntry &N) {
1622   assert(IO.getContext() && "The IO context is not initialized");
1623 
1624   IO.mapOptional("Name", N.Name);
1625   IO.mapOptional("Desc", N.Desc);
1626   IO.mapRequired("Type", N.Type);
1627 }
1628 
1629 void MappingTraits<ELFYAML::VerdefEntry>::mapping(IO &IO,
1630                                                   ELFYAML::VerdefEntry &E) {
1631   assert(IO.getContext() && "The IO context is not initialized");
1632 
1633   IO.mapRequired("Version", E.Version);
1634   IO.mapRequired("Flags", E.Flags);
1635   IO.mapRequired("VersionNdx", E.VersionNdx);
1636   IO.mapRequired("Hash", E.Hash);
1637   IO.mapRequired("Names", E.VerNames);
1638 }
1639 
1640 void MappingTraits<ELFYAML::VerneedEntry>::mapping(IO &IO,
1641                                                    ELFYAML::VerneedEntry &E) {
1642   assert(IO.getContext() && "The IO context is not initialized");
1643 
1644   IO.mapRequired("Version", E.Version);
1645   IO.mapRequired("File", E.File);
1646   IO.mapRequired("Entries", E.AuxV);
1647 }
1648 
1649 void MappingTraits<ELFYAML::VernauxEntry>::mapping(IO &IO,
1650                                                    ELFYAML::VernauxEntry &E) {
1651   assert(IO.getContext() && "The IO context is not initialized");
1652 
1653   IO.mapRequired("Name", E.Name);
1654   IO.mapRequired("Hash", E.Hash);
1655   IO.mapRequired("Flags", E.Flags);
1656   IO.mapRequired("Other", E.Other);
1657 }
1658 
1659 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
1660                                                  ELFYAML::Relocation &Rel) {
1661   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
1662   assert(Object && "The IO context is not initialized");
1663 
1664   IO.mapOptional("Offset", Rel.Offset, (Hex64)0);
1665   IO.mapOptional("Symbol", Rel.Symbol);
1666 
1667   if (Object->Header.Machine == ELFYAML::ELF_EM(ELF::EM_MIPS) &&
1668       Object->Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
1669     MappingNormalization<NormalizedMips64RelType, ELFYAML::ELF_REL> Key(
1670         IO, Rel.Type);
1671     IO.mapRequired("Type", Key->Type);
1672     IO.mapOptional("Type2", Key->Type2, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
1673     IO.mapOptional("Type3", Key->Type3, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
1674     IO.mapOptional("SpecSym", Key->SpecSym, ELFYAML::ELF_RSS(ELF::RSS_UNDEF));
1675   } else
1676     IO.mapRequired("Type", Rel.Type);
1677 
1678   IO.mapOptional("Addend", Rel.Addend, (ELFYAML::YAMLIntUInt)0);
1679 }
1680 
1681 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
1682   assert(!IO.getContext() && "The IO context is initialized already");
1683   IO.setContext(&Object);
1684   IO.mapTag("!ELF", true);
1685   IO.mapRequired("FileHeader", Object.Header);
1686   IO.mapOptional("SectionHeaderTable", Object.SectionHeaders);
1687   IO.mapOptional("ProgramHeaders", Object.ProgramHeaders);
1688   IO.mapOptional("Sections", Object.Chunks);
1689   IO.mapOptional("Symbols", Object.Symbols);
1690   IO.mapOptional("DynamicSymbols", Object.DynamicSymbols);
1691   IO.mapOptional("DWARF", Object.DWARF);
1692   if (Object.DWARF) {
1693     Object.DWARF->IsLittleEndian =
1694         Object.Header.Data == ELFYAML::ELF_ELFDATA(ELF::ELFDATA2LSB);
1695     Object.DWARF->Is64BitAddrSize =
1696         Object.Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64);
1697   }
1698   IO.setContext(nullptr);
1699 }
1700 
1701 void MappingTraits<ELFYAML::LinkerOption>::mapping(IO &IO,
1702                                                    ELFYAML::LinkerOption &Opt) {
1703   assert(IO.getContext() && "The IO context is not initialized");
1704   IO.mapRequired("Name", Opt.Key);
1705   IO.mapRequired("Value", Opt.Value);
1706 }
1707 
1708 void MappingTraits<ELFYAML::CallGraphEntry>::mapping(
1709     IO &IO, ELFYAML::CallGraphEntry &E) {
1710   assert(IO.getContext() && "The IO context is not initialized");
1711   IO.mapRequired("From", E.From);
1712   IO.mapRequired("To", E.To);
1713   IO.mapRequired("Weight", E.Weight);
1714 }
1715 
1716 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_AFL_REG)
1717 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_ABI_FP)
1718 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_EXT)
1719 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_ASE)
1720 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_FLAGS1)
1721 
1722 } // end namespace yaml
1723 
1724 } // end namespace llvm
1725