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