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