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