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