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