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