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