LLVM 24.0.0git
ELFYAML.cpp
Go to the documentation of this file.
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
14#include "llvm/ADT/APInt.h"
15#include "llvm/ADT/MapVector.h"
16#include "llvm/ADT/StringRef.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
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>(Value);
54}
55
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>(Value);
74}
75
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>(Value);
194}
195
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>(Value);
201}
202
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
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
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>(Value);
255}
256
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_HEXAGON:
321 BCaseMask(EF_HEXAGON_MACH_V2, EF_HEXAGON_MACH);
322 BCaseMask(EF_HEXAGON_MACH_V3, EF_HEXAGON_MACH);
323 BCaseMask(EF_HEXAGON_MACH_V4, EF_HEXAGON_MACH);
324 BCaseMask(EF_HEXAGON_MACH_V5, EF_HEXAGON_MACH);
325 BCaseMask(EF_HEXAGON_MACH_V55, EF_HEXAGON_MACH);
326 BCaseMask(EF_HEXAGON_MACH_V60, EF_HEXAGON_MACH);
327 BCaseMask(EF_HEXAGON_MACH_V61, EF_HEXAGON_MACH);
328 BCaseMask(EF_HEXAGON_MACH_V62, EF_HEXAGON_MACH);
329 BCaseMask(EF_HEXAGON_MACH_V65, EF_HEXAGON_MACH);
330 BCaseMask(EF_HEXAGON_MACH_V66, EF_HEXAGON_MACH);
331 BCaseMask(EF_HEXAGON_MACH_V67, EF_HEXAGON_MACH);
332 BCaseMask(EF_HEXAGON_MACH_V67T, EF_HEXAGON_MACH);
333 BCaseMask(EF_HEXAGON_MACH_V68, EF_HEXAGON_MACH);
334 BCaseMask(EF_HEXAGON_MACH_V69, EF_HEXAGON_MACH);
335 BCaseMask(EF_HEXAGON_MACH_V71, EF_HEXAGON_MACH);
336 BCaseMask(EF_HEXAGON_MACH_V71T, EF_HEXAGON_MACH);
337 BCaseMask(EF_HEXAGON_MACH_V73, EF_HEXAGON_MACH);
338 BCaseMask(EF_HEXAGON_MACH_V75, EF_HEXAGON_MACH);
339 BCaseMask(EF_HEXAGON_MACH_V77, EF_HEXAGON_MACH);
340 BCaseMask(EF_HEXAGON_MACH_V79, EF_HEXAGON_MACH);
341 BCaseMask(EF_HEXAGON_MACH_V81, EF_HEXAGON_MACH);
342 BCaseMask(EF_HEXAGON_MACH_V83, EF_HEXAGON_MACH);
343 BCaseMask(EF_HEXAGON_MACH_V85, EF_HEXAGON_MACH);
344 BCaseMask(EF_HEXAGON_MACH_V87, EF_HEXAGON_MACH);
345 BCaseMask(EF_HEXAGON_MACH_V89, EF_HEXAGON_MACH);
346 BCaseMask(EF_HEXAGON_MACH_V91, EF_HEXAGON_MACH);
347 BCaseMask(EF_HEXAGON_MACH_V93, EF_HEXAGON_MACH);
348 BCaseMask(EF_HEXAGON_ISA_V2, EF_HEXAGON_ISA);
349 BCaseMask(EF_HEXAGON_ISA_V3, EF_HEXAGON_ISA);
350 BCaseMask(EF_HEXAGON_ISA_V4, EF_HEXAGON_ISA);
351 BCaseMask(EF_HEXAGON_ISA_V5, EF_HEXAGON_ISA);
352 BCaseMask(EF_HEXAGON_ISA_V55, EF_HEXAGON_ISA);
353 BCaseMask(EF_HEXAGON_ISA_V60, EF_HEXAGON_ISA);
354 BCaseMask(EF_HEXAGON_ISA_V61, EF_HEXAGON_ISA);
355 BCaseMask(EF_HEXAGON_ISA_V62, EF_HEXAGON_ISA);
356 BCaseMask(EF_HEXAGON_ISA_V65, EF_HEXAGON_ISA);
357 BCaseMask(EF_HEXAGON_ISA_V66, EF_HEXAGON_ISA);
358 BCaseMask(EF_HEXAGON_ISA_V67, EF_HEXAGON_ISA);
359 BCaseMask(EF_HEXAGON_ISA_V68, EF_HEXAGON_ISA);
360 BCaseMask(EF_HEXAGON_ISA_V69, EF_HEXAGON_ISA);
361 BCaseMask(EF_HEXAGON_ISA_V71, EF_HEXAGON_ISA);
362 BCaseMask(EF_HEXAGON_ISA_V73, EF_HEXAGON_ISA);
363 BCaseMask(EF_HEXAGON_ISA_V75, EF_HEXAGON_ISA);
364 BCaseMask(EF_HEXAGON_ISA_V77, EF_HEXAGON_ISA);
365 BCaseMask(EF_HEXAGON_ISA_V79, EF_HEXAGON_ISA);
366 BCaseMask(EF_HEXAGON_ISA_V81, EF_HEXAGON_ISA);
367 BCaseMask(EF_HEXAGON_ISA_V83, EF_HEXAGON_ISA);
368 BCaseMask(EF_HEXAGON_ISA_V85, EF_HEXAGON_ISA);
369 BCaseMask(EF_HEXAGON_ISA_V87, EF_HEXAGON_ISA);
370 BCaseMask(EF_HEXAGON_ISA_V89, EF_HEXAGON_ISA);
371 BCaseMask(EF_HEXAGON_ISA_V91, EF_HEXAGON_ISA);
372 BCaseMask(EF_HEXAGON_ISA_V93, EF_HEXAGON_ISA);
373 break;
374 case ELF::EM_AVR:
375 BCaseMask(EF_AVR_ARCH_AVR1, EF_AVR_ARCH_MASK);
376 BCaseMask(EF_AVR_ARCH_AVR2, EF_AVR_ARCH_MASK);
377 BCaseMask(EF_AVR_ARCH_AVR25, EF_AVR_ARCH_MASK);
378 BCaseMask(EF_AVR_ARCH_AVR3, EF_AVR_ARCH_MASK);
379 BCaseMask(EF_AVR_ARCH_AVR31, EF_AVR_ARCH_MASK);
380 BCaseMask(EF_AVR_ARCH_AVR35, EF_AVR_ARCH_MASK);
381 BCaseMask(EF_AVR_ARCH_AVR4, EF_AVR_ARCH_MASK);
382 BCaseMask(EF_AVR_ARCH_AVR5, EF_AVR_ARCH_MASK);
383 BCaseMask(EF_AVR_ARCH_AVR51, EF_AVR_ARCH_MASK);
384 BCaseMask(EF_AVR_ARCH_AVR6, EF_AVR_ARCH_MASK);
385 BCaseMask(EF_AVR_ARCH_AVRTINY, EF_AVR_ARCH_MASK);
386 BCaseMask(EF_AVR_ARCH_XMEGA1, EF_AVR_ARCH_MASK);
387 BCaseMask(EF_AVR_ARCH_XMEGA2, EF_AVR_ARCH_MASK);
388 BCaseMask(EF_AVR_ARCH_XMEGA3, EF_AVR_ARCH_MASK);
389 BCaseMask(EF_AVR_ARCH_XMEGA4, EF_AVR_ARCH_MASK);
390 BCaseMask(EF_AVR_ARCH_XMEGA5, EF_AVR_ARCH_MASK);
391 BCaseMask(EF_AVR_ARCH_XMEGA6, EF_AVR_ARCH_MASK);
392 BCaseMask(EF_AVR_ARCH_XMEGA7, EF_AVR_ARCH_MASK);
393 BCase(EF_AVR_LINKRELAX_PREPARED);
394 break;
395 case ELF::EM_LOONGARCH:
396 BCaseMask(EF_LOONGARCH_ABI_SOFT_FLOAT, EF_LOONGARCH_ABI_MODIFIER_MASK);
397 BCaseMask(EF_LOONGARCH_ABI_SINGLE_FLOAT, EF_LOONGARCH_ABI_MODIFIER_MASK);
398 BCaseMask(EF_LOONGARCH_ABI_DOUBLE_FLOAT, EF_LOONGARCH_ABI_MODIFIER_MASK);
399 BCaseMask(EF_LOONGARCH_OBJABI_V0, EF_LOONGARCH_OBJABI_MASK);
400 BCaseMask(EF_LOONGARCH_OBJABI_V1, EF_LOONGARCH_OBJABI_MASK);
401 break;
402 case ELF::EM_RISCV:
403 BCase(EF_RISCV_RVC);
404 BCaseMask(EF_RISCV_FLOAT_ABI_SOFT, EF_RISCV_FLOAT_ABI);
405 BCaseMask(EF_RISCV_FLOAT_ABI_SINGLE, EF_RISCV_FLOAT_ABI);
406 BCaseMask(EF_RISCV_FLOAT_ABI_DOUBLE, EF_RISCV_FLOAT_ABI);
407 BCaseMask(EF_RISCV_FLOAT_ABI_QUAD, EF_RISCV_FLOAT_ABI);
408 BCase(EF_RISCV_RVE);
409 BCase(EF_RISCV_TSO);
410 break;
411 case ELF::EM_SPARC32PLUS:
412 BCase(EF_SPARC_32PLUS);
413 BCase(EF_SPARC_SUN_US1);
414 BCase(EF_SPARC_SUN_US3);
415 BCase(EF_SPARC_HAL_R1);
416 break;
417 case ELF::EM_SPARCV9:
418 BCase(EF_SPARC_SUN_US1);
419 BCase(EF_SPARC_SUN_US3);
420 BCase(EF_SPARC_HAL_R1);
421 BCaseMask(EF_SPARCV9_RMO, EF_SPARCV9_MM);
422 BCaseMask(EF_SPARCV9_PSO, EF_SPARCV9_MM);
423 BCaseMask(EF_SPARCV9_TSO, EF_SPARCV9_MM);
424 break;
425 case ELF::EM_XTENSA:
426 BCase(EF_XTENSA_XT_INSN);
427 BCaseMask(EF_XTENSA_MACH_NONE, EF_XTENSA_MACH);
428 BCase(EF_XTENSA_XT_LIT);
429 break;
430 case ELF::EM_AMDGPU:
431 BCaseMask(EF_AMDGPU_MACH_NONE, EF_AMDGPU_MACH);
432#define X(NUM, ENUM, NAME) BCaseMask(ENUM, EF_AMDGPU_MACH);
434#undef X
435 switch (Object->Header.ABIVersion) {
436 default:
437 // ELFOSABI_AMDGPU_PAL, ELFOSABI_AMDGPU_MESA3D support *_V3 flags.
438 [[fallthrough]];
440 BCase(EF_AMDGPU_FEATURE_XNACK_V3);
441 BCase(EF_AMDGPU_FEATURE_SRAMECC_V3);
442 break;
446 std::string Key = "EF_AMDGPU_GENERIC_VERSION_V" + std::to_string(K);
450 }
451 [[fallthrough]];
454 BCaseMask(EF_AMDGPU_FEATURE_XNACK_UNSUPPORTED_V4,
455 EF_AMDGPU_FEATURE_XNACK_V4);
456 BCaseMask(EF_AMDGPU_FEATURE_XNACK_ANY_V4,
457 EF_AMDGPU_FEATURE_XNACK_V4);
458 BCaseMask(EF_AMDGPU_FEATURE_XNACK_OFF_V4,
459 EF_AMDGPU_FEATURE_XNACK_V4);
460 BCaseMask(EF_AMDGPU_FEATURE_XNACK_ON_V4,
461 EF_AMDGPU_FEATURE_XNACK_V4);
462 BCaseMask(EF_AMDGPU_FEATURE_SRAMECC_UNSUPPORTED_V4,
463 EF_AMDGPU_FEATURE_SRAMECC_V4);
464 BCaseMask(EF_AMDGPU_FEATURE_SRAMECC_ANY_V4,
465 EF_AMDGPU_FEATURE_SRAMECC_V4);
466 BCaseMask(EF_AMDGPU_FEATURE_SRAMECC_OFF_V4,
467 EF_AMDGPU_FEATURE_SRAMECC_V4);
468 BCaseMask(EF_AMDGPU_FEATURE_SRAMECC_ON_V4,
469 EF_AMDGPU_FEATURE_SRAMECC_V4);
470 break;
471 }
472 break;
473 default:
474 break;
475 }
476#undef BCase
477#undef BCaseMask
478}
479
481 IO &IO, ELFYAML::ELF_SHT &Value) {
482 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
483 assert(Object && "The IO context is not initialized");
484#define ECase(X) IO.enumCase(Value, #X, ELF::X)
485 ECase(SHT_NULL);
486 ECase(SHT_PROGBITS);
487 ECase(SHT_SYMTAB);
488 // FIXME: Issue a diagnostic with this information.
489 ECase(SHT_STRTAB);
490 ECase(SHT_RELA);
491 ECase(SHT_HASH);
492 ECase(SHT_DYNAMIC);
493 ECase(SHT_NOTE);
494 ECase(SHT_NOBITS);
495 ECase(SHT_REL);
496 ECase(SHT_SHLIB);
497 ECase(SHT_DYNSYM);
498 ECase(SHT_INIT_ARRAY);
499 ECase(SHT_FINI_ARRAY);
500 ECase(SHT_PREINIT_ARRAY);
501 ECase(SHT_GROUP);
502 ECase(SHT_SYMTAB_SHNDX);
503 ECase(SHT_RELR);
504 ECase(SHT_CREL);
505 ECase(SHT_ANDROID_REL);
506 ECase(SHT_ANDROID_RELA);
507 ECase(SHT_ANDROID_RELR);
508 ECase(SHT_LLVM_ODRTAB);
509 ECase(SHT_LLVM_LINKER_OPTIONS);
510 ECase(SHT_LLVM_CALL_GRAPH_PROFILE);
511 ECase(SHT_LLVM_ADDRSIG);
512 ECase(SHT_LLVM_DEPENDENT_LIBRARIES);
513 ECase(SHT_LLVM_SYMPART);
514 ECase(SHT_LLVM_PART_EHDR);
515 ECase(SHT_LLVM_PART_PHDR);
516 ECase(SHT_LLVM_BB_ADDR_MAP);
517 ECase(SHT_LLVM_OFFLOADING);
518 ECase(SHT_LLVM_LTO);
519 ECase(SHT_LLVM_CALL_GRAPH);
520 ECase(SHT_LLVM_DYNDBG_ELF);
521 ECase(SHT_GNU_SFRAME);
522 ECase(SHT_GNU_ATTRIBUTES);
523 ECase(SHT_GNU_HASH);
524 ECase(SHT_GNU_verdef);
525 ECase(SHT_GNU_verneed);
526 ECase(SHT_GNU_versym);
527 switch (Object->getMachine()) {
528 case ELF::EM_ARM:
529 ECase(SHT_ARM_EXIDX);
530 ECase(SHT_ARM_PREEMPTMAP);
531 ECase(SHT_ARM_ATTRIBUTES);
532 ECase(SHT_ARM_DEBUGOVERLAY);
533 ECase(SHT_ARM_OVERLAYSECTION);
534 break;
535 case ELF::EM_HEXAGON:
536 ECase(SHT_HEX_ORDERED);
537 ECase(SHT_HEXAGON_ATTRIBUTES);
538 break;
539 case ELF::EM_X86_64:
540 ECase(SHT_X86_64_UNWIND);
541 break;
542 case ELF::EM_MIPS:
543 ECase(SHT_MIPS_REGINFO);
544 ECase(SHT_MIPS_OPTIONS);
545 ECase(SHT_MIPS_DWARF);
546 ECase(SHT_MIPS_ABIFLAGS);
547 break;
548 case ELF::EM_RISCV:
549 ECase(SHT_RISCV_ATTRIBUTES);
550 break;
551 case ELF::EM_MSP430:
552 ECase(SHT_MSP430_ATTRIBUTES);
553 break;
554 case ELF::EM_AARCH64:
555 ECase(SHT_AARCH64_AUTH_RELR);
556 ECase(SHT_AARCH64_MEMTAG_GLOBALS_STATIC);
557 ECase(SHT_AARCH64_MEMTAG_GLOBALS_DYNAMIC);
558 break;
559 default:
560 // Nothing to do.
561 break;
562 }
563#undef ECase
564 IO.enumFallback<Hex32>(Value);
565}
566
568 ELFYAML::ELF_PF &Value) {
569#define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
570 BCase(PF_X);
571 BCase(PF_W);
572 BCase(PF_R);
573}
574
576 ELFYAML::ELF_SHF &Value) {
577 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
578#define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
579 BCase(SHF_WRITE);
580 BCase(SHF_ALLOC);
581 BCase(SHF_EXCLUDE);
582 BCase(SHF_EXECINSTR);
583 BCase(SHF_MERGE);
584 BCase(SHF_STRINGS);
585 BCase(SHF_INFO_LINK);
586 BCase(SHF_LINK_ORDER);
587 BCase(SHF_OS_NONCONFORMING);
588 BCase(SHF_GROUP);
589 BCase(SHF_TLS);
590 BCase(SHF_COMPRESSED);
591 switch (Object->getOSAbi()) {
593 BCase(SHF_SUNW_NODISCARD);
594 break;
595 default:
596 BCase(SHF_GNU_RETAIN);
597 break;
598 }
599 switch (Object->getMachine()) {
600 case ELF::EM_AARCH64:
601 BCase(SHF_AARCH64_PURECODE);
602 break;
603 case ELF::EM_ARM:
604 BCase(SHF_ARM_PURECODE);
605 break;
606 case ELF::EM_HEXAGON:
607 BCase(SHF_HEX_GPREL);
608 break;
609 case ELF::EM_MIPS:
610 BCase(SHF_MIPS_NODUPES);
611 BCase(SHF_MIPS_NAMES);
612 BCase(SHF_MIPS_LOCAL);
613 BCase(SHF_MIPS_NOSTRIP);
614 BCase(SHF_MIPS_GPREL);
615 BCase(SHF_MIPS_MERGE);
616 BCase(SHF_MIPS_ADDR);
617 BCase(SHF_MIPS_STRING);
618 break;
619 case ELF::EM_X86_64:
620 BCase(SHF_X86_64_LARGE);
621 break;
622 default:
623 // Nothing to do.
624 break;
625 }
626#undef BCase
627}
628
630 IO &IO, ELFYAML::ELF_SHN &Value) {
631 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
632 assert(Object && "The IO context is not initialized");
633#define ECase(X) IO.enumCase(Value, #X, ELF::X)
634 ECase(SHN_UNDEF);
635 ECase(SHN_LORESERVE);
636 ECase(SHN_LOPROC);
637 ECase(SHN_HIPROC);
638 ECase(SHN_LOOS);
639 ECase(SHN_HIOS);
640 ECase(SHN_ABS);
641 ECase(SHN_COMMON);
642 ECase(SHN_XINDEX);
643 ECase(SHN_HIRESERVE);
644 ECase(SHN_AMDGPU_LDS);
645
646 if (!IO.outputting() || Object->getMachine() == ELF::EM_MIPS) {
647 ECase(SHN_MIPS_ACOMMON);
648 ECase(SHN_MIPS_TEXT);
649 ECase(SHN_MIPS_DATA);
650 ECase(SHN_MIPS_SCOMMON);
651 ECase(SHN_MIPS_SUNDEFINED);
652 }
653
654 ECase(SHN_HEXAGON_SCOMMON);
655 ECase(SHN_HEXAGON_SCOMMON_1);
656 ECase(SHN_HEXAGON_SCOMMON_2);
657 ECase(SHN_HEXAGON_SCOMMON_4);
658 ECase(SHN_HEXAGON_SCOMMON_8);
659#undef ECase
660 IO.enumFallback<Hex16>(Value);
661}
662
664 IO &IO, ELFYAML::ELF_STB &Value) {
665#define ECase(X) IO.enumCase(Value, #X, ELF::X)
666 ECase(STB_LOCAL);
667 ECase(STB_GLOBAL);
668 ECase(STB_WEAK);
669 ECase(STB_GNU_UNIQUE);
670#undef ECase
671 IO.enumFallback<Hex8>(Value);
672}
673
675 IO &IO, ELFYAML::ELF_STT &Value) {
676#define ECase(X) IO.enumCase(Value, #X, ELF::X)
677 ECase(STT_NOTYPE);
678 ECase(STT_OBJECT);
679 ECase(STT_FUNC);
680 ECase(STT_SECTION);
681 ECase(STT_FILE);
682 ECase(STT_COMMON);
683 ECase(STT_TLS);
684 ECase(STT_GNU_IFUNC);
685#undef ECase
686 IO.enumFallback<Hex8>(Value);
687}
688
689
691 IO &IO, ELFYAML::ELF_RSS &Value) {
692#define ECase(X) IO.enumCase(Value, #X, ELF::X)
693 ECase(RSS_UNDEF);
694 ECase(RSS_GP);
695 ECase(RSS_GP0);
696 ECase(RSS_LOC);
697#undef ECase
698}
699
701 IO &IO, ELFYAML::ELF_REL &Value) {
702 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
703 assert(Object && "The IO context is not initialized");
704#define ELF_RELOC(X, Y) IO.enumCase(Value, #X, ELF::X);
705 switch (Object->getMachine()) {
706 case ELF::EM_X86_64:
707#include "llvm/BinaryFormat/ELFRelocs/x86_64.def"
708 break;
709 case ELF::EM_MIPS:
710#include "llvm/BinaryFormat/ELFRelocs/Mips.def"
711 break;
712 case ELF::EM_HEXAGON:
713#include "llvm/BinaryFormat/ELFRelocs/Hexagon.def"
714 break;
715 case ELF::EM_386:
716 case ELF::EM_IAMCU:
717#include "llvm/BinaryFormat/ELFRelocs/i386.def"
718 break;
719 case ELF::EM_AARCH64:
720#include "llvm/BinaryFormat/ELFRelocs/AArch64.def"
721 break;
722 case ELF::EM_ARM:
723#include "llvm/BinaryFormat/ELFRelocs/ARM.def"
724 break;
725 case ELF::EM_ARC:
726#include "llvm/BinaryFormat/ELFRelocs/ARC.def"
727 break;
728 case ELF::EM_RISCV:
729#include "llvm/BinaryFormat/ELFRelocs/RISCV.def"
730 break;
731 case ELF::EM_LANAI:
732#include "llvm/BinaryFormat/ELFRelocs/Lanai.def"
733 break;
734 case ELF::EM_AMDGPU:
735#include "llvm/BinaryFormat/ELFRelocs/AMDGPU.def"
736 break;
737 case ELF::EM_BPF:
738#include "llvm/BinaryFormat/ELFRelocs/BPF.def"
739 break;
740 case ELF::EM_VE:
741#include "llvm/BinaryFormat/ELFRelocs/VE.def"
742 break;
743 case ELF::EM_CSKY:
744#include "llvm/BinaryFormat/ELFRelocs/CSKY.def"
745 break;
746 case ELF::EM_PPC:
747#include "llvm/BinaryFormat/ELFRelocs/PowerPC.def"
748 break;
749 case ELF::EM_PPC64:
750#include "llvm/BinaryFormat/ELFRelocs/PowerPC64.def"
751 break;
752 case ELF::EM_SPARCV9:
753#include "llvm/BinaryFormat/ELFRelocs/Sparc.def"
754 break;
755 case ELF::EM_68K:
756#include "llvm/BinaryFormat/ELFRelocs/M68k.def"
757 break;
758 case ELF::EM_LOONGARCH:
759#include "llvm/BinaryFormat/ELFRelocs/LoongArch.def"
760 break;
761 case ELF::EM_XTENSA:
762#include "llvm/BinaryFormat/ELFRelocs/Xtensa.def"
763 break;
764 default:
765 // Nothing to do.
766 break;
767 }
768#undef ELF_RELOC
769 IO.enumFallback<Hex32>(Value);
770}
771
773 IO &IO, ELFYAML::ELF_DYNTAG &Value) {
774 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
775 assert(Object && "The IO context is not initialized");
776
777// Disable architecture specific tags by default. We might enable them below.
778#define AARCH64_DYNAMIC_TAG(name, value)
779#define MIPS_DYNAMIC_TAG(name, value)
780#define HEXAGON_DYNAMIC_TAG(name, value)
781#define PPC_DYNAMIC_TAG(name, value)
782#define PPC64_DYNAMIC_TAG(name, value)
783// Ignore marker tags such as DT_HIOS (maps to DT_VERNEEDNUM), etc.
784#define DYNAMIC_TAG_MARKER(name, value)
785
786#define STRINGIFY(X) (#X)
787#define DYNAMIC_TAG(X, Y) IO.enumCase(Value, STRINGIFY(DT_##X), ELF::DT_##X);
788 switch (Object->getMachine()) {
789 case ELF::EM_AARCH64:
790#undef AARCH64_DYNAMIC_TAG
791#define AARCH64_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
792#include "llvm/BinaryFormat/DynamicTags.def"
793#undef AARCH64_DYNAMIC_TAG
794#define AARCH64_DYNAMIC_TAG(name, value)
795 break;
796 case ELF::EM_MIPS:
797#undef MIPS_DYNAMIC_TAG
798#define MIPS_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
799#include "llvm/BinaryFormat/DynamicTags.def"
800#undef MIPS_DYNAMIC_TAG
801#define MIPS_DYNAMIC_TAG(name, value)
802 break;
803 case ELF::EM_HEXAGON:
804#undef HEXAGON_DYNAMIC_TAG
805#define HEXAGON_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
806#include "llvm/BinaryFormat/DynamicTags.def"
807#undef HEXAGON_DYNAMIC_TAG
808#define HEXAGON_DYNAMIC_TAG(name, value)
809 break;
810 case ELF::EM_PPC:
811#undef PPC_DYNAMIC_TAG
812#define PPC_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
813#include "llvm/BinaryFormat/DynamicTags.def"
814#undef PPC_DYNAMIC_TAG
815#define PPC_DYNAMIC_TAG(name, value)
816 break;
817 case ELF::EM_PPC64:
818#undef PPC64_DYNAMIC_TAG
819#define PPC64_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
820#include "llvm/BinaryFormat/DynamicTags.def"
821#undef PPC64_DYNAMIC_TAG
822#define PPC64_DYNAMIC_TAG(name, value)
823 break;
824 case ELF::EM_RISCV:
825#undef RISCV_DYNAMIC_TAG
826#define RISCV_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
827#include "llvm/BinaryFormat/DynamicTags.def"
828#undef RISCV_DYNAMIC_TAG
829#define RISCV_DYNAMIC_TAG(name, value)
830 break;
831 case ELF::EM_SPARCV9:
832#undef SPARC_DYNAMIC_TAG
833#define SPARC_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
834#include "llvm/BinaryFormat/DynamicTags.def"
835#undef SPARC_DYNAMIC_TAG
836#define SPARC_DYNAMIC_TAG(name, value)
837 break;
838 default:
839#include "llvm/BinaryFormat/DynamicTags.def"
840 break;
841 }
842#undef AARCH64_DYNAMIC_TAG
843#undef MIPS_DYNAMIC_TAG
844#undef HEXAGON_DYNAMIC_TAG
845#undef PPC_DYNAMIC_TAG
846#undef PPC64_DYNAMIC_TAG
847#undef DYNAMIC_TAG_MARKER
848#undef STRINGIFY
849#undef DYNAMIC_TAG
850
851 IO.enumFallback<Hex64>(Value);
852}
853
855 IO &IO, ELFYAML::MIPS_AFL_REG &Value) {
856#define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
857 ECase(REG_NONE);
858 ECase(REG_32);
859 ECase(REG_64);
860 ECase(REG_128);
861#undef ECase
862}
863
865 IO &IO, ELFYAML::MIPS_ABI_FP &Value) {
866#define ECase(X) IO.enumCase(Value, #X, Mips::Val_GNU_MIPS_ABI_##X)
867 ECase(FP_ANY);
868 ECase(FP_DOUBLE);
869 ECase(FP_SINGLE);
870 ECase(FP_SOFT);
871 ECase(FP_OLD_64);
872 ECase(FP_XX);
873 ECase(FP_64);
874 ECase(FP_64A);
875#undef ECase
876}
877
879 IO &IO, ELFYAML::MIPS_AFL_EXT &Value) {
880#define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
881 ECase(EXT_NONE);
882 ECase(EXT_XLR);
883 ECase(EXT_OCTEON2);
884 ECase(EXT_OCTEONP);
885 ECase(EXT_LOONGSON_3A);
886 ECase(EXT_OCTEON);
887 ECase(EXT_5900);
888 ECase(EXT_4650);
889 ECase(EXT_4010);
890 ECase(EXT_4100);
891 ECase(EXT_3900);
892 ECase(EXT_10000);
893 ECase(EXT_SB1);
894 ECase(EXT_4111);
895 ECase(EXT_4120);
896 ECase(EXT_5400);
897 ECase(EXT_5500);
898 ECase(EXT_LOONGSON_2E);
899 ECase(EXT_LOONGSON_2F);
900 ECase(EXT_OCTEON3);
901#undef ECase
902}
903
905 IO &IO, ELFYAML::MIPS_ISA &Value) {
906 IO.enumCase(Value, "MIPS1", 1);
907 IO.enumCase(Value, "MIPS2", 2);
908 IO.enumCase(Value, "MIPS3", 3);
909 IO.enumCase(Value, "MIPS4", 4);
910 IO.enumCase(Value, "MIPS5", 5);
911 IO.enumCase(Value, "MIPS32", 32);
912 IO.enumCase(Value, "MIPS64", 64);
913 IO.enumFallback<Hex32>(Value);
914}
915
917 IO &IO, ELFYAML::MIPS_AFL_ASE &Value) {
918#define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_ASE_##X)
919 BCase(DSP);
920 BCase(DSPR2);
921 BCase(EVA);
922 BCase(MCU);
923 BCase(MDMX);
924 BCase(MIPS3D);
925 BCase(MT);
926 BCase(SMARTMIPS);
927 BCase(VIRT);
928 BCase(MSA);
929 BCase(MIPS16);
930 BCase(MICROMIPS);
931 BCase(XPA);
932 BCase(CRC);
933 BCase(GINV);
934#undef BCase
935}
936
938 IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value) {
939#define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_FLAGS1_##X)
940 BCase(ODDSPREG);
941#undef BCase
942}
943
948
950 ELFYAML::FileHeader &FileHdr) {
951 IO.mapRequired("Class", FileHdr.Class);
952 IO.mapRequired("Data", FileHdr.Data);
953 IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
954 IO.mapOptional("ABIVersion", FileHdr.ABIVersion, Hex8(0));
955 IO.mapRequired("Type", FileHdr.Type);
956 IO.mapOptional("Machine", FileHdr.Machine);
957 IO.mapOptional("Flags", FileHdr.Flags);
958 IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
959 IO.mapOptional("SectionHeaderStringTable", FileHdr.SectionHeaderStringTable);
960
961 // obj2yaml does not dump these fields.
962 assert(!IO.outputting() ||
963 (!FileHdr.EPhOff && !FileHdr.EPhEntSize && !FileHdr.EPhNum));
964 IO.mapOptional("EPhOff", FileHdr.EPhOff);
965 IO.mapOptional("EPhEntSize", FileHdr.EPhEntSize);
966 IO.mapOptional("EPhNum", FileHdr.EPhNum);
967 IO.mapOptional("EShEntSize", FileHdr.EShEntSize);
968 IO.mapOptional("EShOff", FileHdr.EShOff);
969 IO.mapOptional("EShNum", FileHdr.EShNum);
970 IO.mapOptional("EShStrNdx", FileHdr.EShStrNdx);
971}
972
974 IO &IO, ELFYAML::ProgramHeader &Phdr) {
975 IO.mapRequired("Type", Phdr.Type);
976 IO.mapOptional("Flags", Phdr.Flags, ELFYAML::ELF_PF(0));
977 IO.mapOptional("FirstSec", Phdr.FirstSec);
978 IO.mapOptional("LastSec", Phdr.LastSec);
979 IO.mapOptional("VAddr", Phdr.VAddr, Hex64(0));
980 IO.mapOptional("PAddr", Phdr.PAddr, Phdr.VAddr);
981 IO.mapOptional("Align", Phdr.Align);
982 IO.mapOptional("FileSize", Phdr.FileSize);
983 IO.mapOptional("MemSize", Phdr.MemSize);
984 IO.mapOptional("Offset", Phdr.Offset);
985}
986
988 IO &IO, ELFYAML::ProgramHeader &FileHdr) {
989 if (!FileHdr.FirstSec && FileHdr.LastSec)
990 return "the \"LastSec\" key can't be used without the \"FirstSec\" key";
991 if (FileHdr.FirstSec && !FileHdr.LastSec)
992 return "the \"FirstSec\" key can't be used without the \"LastSec\" key";
993 return "";
994}
995
997
998template <> struct ScalarTraits<StOtherPiece> {
999 static void output(const StOtherPiece &Val, void *, raw_ostream &Out) {
1000 Out << Val;
1001 }
1002 static StringRef input(StringRef Scalar, void *, StOtherPiece &Val) {
1003 Val = Scalar;
1004 return {};
1005 }
1007};
1008template <> struct SequenceElementTraits<StOtherPiece> {
1009 static const bool flow = true;
1010};
1011
1012template <> struct ScalarTraits<ELFYAML::YAMLFlowString> {
1013 static void output(const ELFYAML::YAMLFlowString &Val, void *,
1014 raw_ostream &Out) {
1015 Out << Val;
1016 }
1018 ELFYAML::YAMLFlowString &Val) {
1019 Val = Scalar;
1020 return {};
1021 }
1025};
1026template <> struct SequenceElementTraits<ELFYAML::YAMLFlowString> {
1027 static const bool flow = true;
1028};
1029
1030namespace {
1031
1032struct NormalizedOther {
1033 NormalizedOther(IO &IO) : YamlIO(IO) {}
1034 NormalizedOther(IO &IO, std::optional<uint8_t> Original) : YamlIO(IO) {
1035 assert(Original && "This constructor is only used for outputting YAML and "
1036 "assumes a non-empty Original");
1037 std::vector<StOtherPiece> Ret;
1038 const auto *Object = static_cast<ELFYAML::Object *>(YamlIO.getContext());
1039 for (std::pair<StringRef, uint8_t> &P :
1040 getFlags(Object->getMachine()).takeVector()) {
1041 uint8_t FlagValue = P.second;
1042 if ((*Original & FlagValue) != FlagValue)
1043 continue;
1044 *Original &= ~FlagValue;
1045 Ret.push_back({P.first});
1046 }
1047
1048 if (*Original != 0) {
1049 UnknownFlagsHolder = std::to_string(*Original);
1050 Ret.push_back({UnknownFlagsHolder});
1051 }
1052
1053 if (!Ret.empty())
1054 Other = std::move(Ret);
1055 }
1056
1057 uint8_t toValue(StringRef Name) {
1058 const auto *Object = static_cast<ELFYAML::Object *>(YamlIO.getContext());
1059 MapVector<StringRef, uint8_t> Flags = getFlags(Object->getMachine());
1060
1061 auto It = Flags.find(Name);
1062 if (It != Flags.end())
1063 return It->second;
1064
1065 uint8_t Val;
1066 if (to_integer(Name, Val))
1067 return Val;
1068
1069 YamlIO.setError("an unknown value is used for symbol's 'Other' field: " +
1070 Name);
1071 return 0;
1072 }
1073
1074 std::optional<uint8_t> denormalize(IO &) {
1075 if (!Other)
1076 return std::nullopt;
1077 uint8_t Ret = 0;
1078 for (StOtherPiece &Val : *Other)
1079 Ret |= toValue(Val);
1080 return Ret;
1081 }
1082
1083 // st_other field is used to encode symbol visibility and platform-dependent
1084 // flags and values. This method returns a name to value map that is used for
1085 // parsing and encoding this field.
1086 MapVector<StringRef, uint8_t> getFlags(unsigned EMachine) {
1088 // STV_* values are just enumeration values. We add them in a reversed order
1089 // because when we convert the st_other to named constants when printing
1090 // YAML we want to use a maximum number of bits on each step:
1091 // when we have st_other == 3, we want to print it as STV_PROTECTED (3), but
1092 // not as STV_HIDDEN (2) + STV_INTERNAL (1).
1093 Map["STV_PROTECTED"] = ELF::STV_PROTECTED;
1094 Map["STV_HIDDEN"] = ELF::STV_HIDDEN;
1095 Map["STV_INTERNAL"] = ELF::STV_INTERNAL;
1096 // STV_DEFAULT is used to represent the default visibility and has a value
1097 // 0. We want to be able to read it from YAML documents, but there is no
1098 // reason to print it.
1099 if (!YamlIO.outputting())
1100 Map["STV_DEFAULT"] = ELF::STV_DEFAULT;
1101
1102 // MIPS is not consistent. All of the STO_MIPS_* values are bit flags,
1103 // except STO_MIPS_MIPS16 which overlaps them. It should be checked and
1104 // consumed first when we print the output, because we do not want to print
1105 // any other flags that have the same bits instead.
1106 if (EMachine == ELF::EM_MIPS) {
1107 Map["STO_MIPS_MIPS16"] = ELF::STO_MIPS_MIPS16;
1108 Map["STO_MIPS_MICROMIPS"] = ELF::STO_MIPS_MICROMIPS;
1109 Map["STO_MIPS_PIC"] = ELF::STO_MIPS_PIC;
1110 Map["STO_MIPS_PLT"] = ELF::STO_MIPS_PLT;
1111 Map["STO_MIPS_OPTIONAL"] = ELF::STO_MIPS_OPTIONAL;
1112 }
1113
1114 if (EMachine == ELF::EM_AARCH64)
1115 Map["STO_AARCH64_VARIANT_PCS"] = ELF::STO_AARCH64_VARIANT_PCS;
1116 if (EMachine == ELF::EM_RISCV)
1117 Map["STO_RISCV_VARIANT_CC"] = ELF::STO_RISCV_VARIANT_CC;
1118 return Map;
1119 }
1120
1121 IO &YamlIO;
1122 std::optional<std::vector<StOtherPiece>> Other;
1123 std::string UnknownFlagsHolder;
1124};
1125
1126} // end anonymous namespace
1127
1128void ScalarTraits<ELFYAML::YAMLIntUInt>::output(const ELFYAML::YAMLIntUInt &Val,
1129 void *Ctx, raw_ostream &Out) {
1130 Out << Val;
1131}
1132
1134 ELFYAML::YAMLIntUInt &Val) {
1135 const bool Is64 = static_cast<ELFYAML::Object *>(Ctx)->Header.Class ==
1136 ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64);
1137 StringRef ErrMsg = "invalid number";
1138 // We do not accept negative hex numbers because their meaning is ambiguous.
1139 // For example, would -0xfffffffff mean 1 or INT32_MIN?
1140 if (Scalar.empty() || Scalar.starts_with("-0x"))
1141 return ErrMsg;
1142
1143 if (Scalar.starts_with("-")) {
1144 const int64_t MinVal = Is64 ? INT64_MIN : INT32_MIN;
1145 long long Int;
1146 if (getAsSignedInteger(Scalar, /*Radix=*/0, Int) || (Int < MinVal))
1147 return ErrMsg;
1148 Val = Int;
1149 return "";
1150 }
1151
1152 const uint64_t MaxVal = Is64 ? UINT64_MAX : UINT32_MAX;
1153 unsigned long long UInt;
1154 if (getAsUnsignedInteger(Scalar, /*Radix=*/0, UInt) || (UInt > MaxVal))
1155 return ErrMsg;
1156 Val = UInt;
1157 return "";
1158}
1159
1161 IO.mapOptional("Name", Symbol.Name, StringRef());
1162 IO.mapOptional("StName", Symbol.StName);
1163 IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
1164 IO.mapOptional("Section", Symbol.Section);
1165 IO.mapOptional("Index", Symbol.Index);
1166 IO.mapOptional("Binding", Symbol.Binding, ELFYAML::ELF_STB(0));
1167 IO.mapOptional("Value", Symbol.Value);
1168 IO.mapOptional("Size", Symbol.Size);
1169
1170 // Symbol's Other field is a bit special. It is usually a field that
1171 // represents st_other and holds the symbol visibility. However, on some
1172 // platforms, it can contain bit fields and regular values, or even sometimes
1173 // a crazy mix of them (see comments for NormalizedOther). Because of this, we
1174 // need special handling.
1176 IO, Symbol.Other);
1177 IO.mapOptional("Other", Keys->Other);
1178}
1179
1181 ELFYAML::Symbol &Symbol) {
1182 if (Symbol.Index && Symbol.Section)
1183 return "Index and Section cannot both be specified for Symbol";
1184 return "";
1185}
1186
1188 IO.mapOptional("Name", Section.Name, StringRef());
1189 IO.mapRequired("Type", Section.Type);
1190 IO.mapOptional("Flags", Section.Flags);
1191 IO.mapOptional("Address", Section.Address);
1192 IO.mapOptional("Link", Section.Link);
1193 IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
1194 IO.mapOptional("EntSize", Section.EntSize);
1195 IO.mapOptional("Offset", Section.Offset);
1196
1197 IO.mapOptional("Content", Section.Content);
1198 IO.mapOptional("Size", Section.Size);
1199
1200 // obj2yaml does not dump these fields. They are expected to be empty when we
1201 // are producing YAML, because yaml2obj sets appropriate values for them
1202 // automatically when they are not explicitly defined.
1203 assert(!IO.outputting() ||
1204 (!Section.ShOffset && !Section.ShSize && !Section.ShName &&
1205 !Section.ShFlags && !Section.ShType && !Section.ShAddrAlign));
1206 IO.mapOptional("ShAddrAlign", Section.ShAddrAlign);
1207 IO.mapOptional("ShName", Section.ShName);
1208 IO.mapOptional("ShOffset", Section.ShOffset);
1209 IO.mapOptional("ShSize", Section.ShSize);
1210 IO.mapOptional("ShFlags", Section.ShFlags);
1211 IO.mapOptional("ShType", Section.ShType);
1212}
1213
1215 commonSectionMapping(IO, Section);
1216 IO.mapOptional("Entries", Section.Entries);
1217}
1218
1220 commonSectionMapping(IO, Section);
1221
1222 // We also support reading a content as array of bytes using the ContentArray
1223 // key. obj2yaml never prints this field.
1224 assert(!IO.outputting() || !Section.ContentBuf);
1225 IO.mapOptional("ContentArray", Section.ContentBuf);
1226 if (Section.ContentBuf) {
1227 if (Section.Content)
1228 IO.setError("Content and ContentArray can't be used together");
1229 Section.Content = yaml::BinaryRef(*Section.ContentBuf);
1230 }
1231
1232 IO.mapOptional("Info", Section.Info);
1233}
1234
1236 commonSectionMapping(IO, Section);
1237 IO.mapOptional("Content", Section.Content);
1238 IO.mapOptional("Entries", Section.Entries);
1239 IO.mapOptional("PGOAnalyses", Section.PGOAnalyses);
1240}
1241
1243 commonSectionMapping(IO, Section);
1244 IO.mapOptional("Entries", Section.Entries);
1245}
1246
1247static void sectionMapping(IO &IO, ELFYAML::HashSection &Section) {
1248 commonSectionMapping(IO, Section);
1249 IO.mapOptional("Bucket", Section.Bucket);
1250 IO.mapOptional("Chain", Section.Chain);
1251
1252 // obj2yaml does not dump these fields. They can be used to override nchain
1253 // and nbucket values for creating broken sections.
1254 assert(!IO.outputting() || (!Section.NBucket && !Section.NChain));
1255 IO.mapOptional("NChain", Section.NChain);
1256 IO.mapOptional("NBucket", Section.NBucket);
1257}
1258
1259static void sectionMapping(IO &IO, ELFYAML::NoteSection &Section) {
1260 commonSectionMapping(IO, Section);
1261 IO.mapOptional("Notes", Section.Notes);
1262}
1263
1264
1266 commonSectionMapping(IO, Section);
1267 IO.mapOptional("Header", Section.Header);
1268 IO.mapOptional("BloomFilter", Section.BloomFilter);
1269 IO.mapOptional("HashBuckets", Section.HashBuckets);
1270 IO.mapOptional("HashValues", Section.HashValues);
1271}
1273 commonSectionMapping(IO, Section);
1274}
1275
1277 commonSectionMapping(IO, Section);
1278 IO.mapOptional("Info", Section.Info);
1279 IO.mapOptional("Entries", Section.Entries);
1280}
1281
1283 commonSectionMapping(IO, Section);
1284 IO.mapOptional("Entries", Section.Entries);
1285}
1286
1288 commonSectionMapping(IO, Section);
1289 IO.mapOptional("Info", Section.Info);
1290 IO.mapOptional("Dependencies", Section.VerneedV);
1291}
1292
1294 commonSectionMapping(IO, Section);
1295 IO.mapOptional("Info", Section.RelocatableSec, StringRef());
1296 IO.mapOptional("Relocations", Section.Relocations);
1297}
1298
1299static void sectionMapping(IO &IO, ELFYAML::RelrSection &Section) {
1300 commonSectionMapping(IO, Section);
1301 IO.mapOptional("Entries", Section.Entries);
1302}
1303
1305 commonSectionMapping(IO, Group);
1306 IO.mapOptional("Info", Group.Signature);
1307 IO.mapOptional("Members", Group.Members);
1308}
1309
1311 commonSectionMapping(IO, Section);
1312 IO.mapOptional("Entries", Section.Entries);
1313}
1314
1316 commonSectionMapping(IO, Section);
1317 IO.mapOptional("Symbols", Section.Symbols);
1318}
1319
1320static void fillMapping(IO &IO, ELFYAML::Fill &Fill) {
1321 IO.mapOptional("Name", Fill.Name, StringRef());
1322 IO.mapOptional("Pattern", Fill.Pattern);
1323 IO.mapOptional("Offset", Fill.Offset);
1324 IO.mapRequired("Size", Fill.Size);
1325}
1326
1329 IO.mapOptional("Offset", SHT.Offset);
1330 IO.mapOptional("Sections", SHT.Sections);
1331 IO.mapOptional("Excluded", SHT.Excluded);
1332 IO.mapOptional("NoHeaders", SHT.NoHeaders);
1333}
1334
1336 commonSectionMapping(IO, Section);
1337 IO.mapOptional("Options", Section.Options);
1338}
1339
1340static void sectionMapping(IO &IO,
1342 commonSectionMapping(IO, Section);
1343 IO.mapOptional("Libraries", Section.Libs);
1344}
1345
1347 commonSectionMapping(IO, Section);
1348 IO.mapOptional("Entries", Section.Entries);
1349}
1350
1352 IO &IO, ELFYAML::SectionOrType &sectionOrType) {
1353 IO.mapRequired("SectionOrType", sectionOrType.sectionNameOrType);
1354}
1355
1357 commonSectionMapping(IO, Section);
1358 IO.mapOptional("Entries", Section.Entries);
1359}
1360
1362 commonSectionMapping(IO, Section);
1363 IO.mapOptional("Version", Section.Version, Hex16(0));
1364 IO.mapRequired("ISA", Section.ISALevel);
1365 IO.mapOptional("ISARevision", Section.ISARevision, Hex8(0));
1366 IO.mapOptional("ISAExtension", Section.ISAExtension,
1367 ELFYAML::MIPS_AFL_EXT(Mips::AFL_EXT_NONE));
1368 IO.mapOptional("ASEs", Section.ASEs, ELFYAML::MIPS_AFL_ASE(0));
1369 IO.mapOptional("FpABI", Section.FpABI,
1370 ELFYAML::MIPS_ABI_FP(Mips::Val_GNU_MIPS_ABI_FP_ANY));
1371 IO.mapOptional("GPRSize", Section.GPRSize,
1372 ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1373 IO.mapOptional("CPR1Size", Section.CPR1Size,
1374 ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1375 IO.mapOptional("CPR2Size", Section.CPR2Size,
1376 ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1377 IO.mapOptional("Flags1", Section.Flags1, ELFYAML::MIPS_AFL_FLAGS1(0));
1378 IO.mapOptional("Flags2", Section.Flags2, Hex32(0));
1379}
1380
1381static StringRef getStringValue(IO &IO, const char *Key) {
1382 StringRef Val;
1383 IO.mapRequired(Key, Val);
1384 return Val;
1385}
1386
1387static void setStringValue(IO &IO, const char *Key, StringRef Val) {
1388 IO.mapRequired(Key, Val);
1389}
1390
1391static bool isInteger(StringRef Val) {
1392 APInt Tmp;
1393 return !Val.getAsInteger(0, Tmp);
1394}
1395
1397 IO &IO, std::unique_ptr<ELFYAML::Chunk> &Section) {
1398 ELFYAML::ELF_SHT Type = ELF::SHT_NULL;
1399 StringRef TypeStr;
1400 if (IO.outputting()) {
1401 if (auto *S = dyn_cast<ELFYAML::Section>(Section.get()))
1402 Type = S->Type;
1403 else if (auto *SHT = dyn_cast<ELFYAML::SectionHeaderTable>(Section.get()))
1404 TypeStr = SHT->TypeStr;
1405 } else {
1406 // When the Type string does not have a "SHT_" prefix, we know it is not a
1407 // description of a regular ELF output section.
1408 TypeStr = getStringValue(IO, "Type");
1409 if (TypeStr.starts_with("SHT_") || isInteger(TypeStr))
1410 IO.mapRequired("Type", Type);
1411 }
1412
1413 if (TypeStr == "Fill") {
1414 assert(!IO.outputting()); // We don't dump fills currently.
1415 Section.reset(new ELFYAML::Fill());
1416 fillMapping(IO, *cast<ELFYAML::Fill>(Section.get()));
1417 return;
1418 }
1419
1420 if (TypeStr == ELFYAML::SectionHeaderTable::TypeStr) {
1421 if (IO.outputting())
1422 setStringValue(IO, "Type", TypeStr);
1423 else
1424 Section.reset(new ELFYAML::SectionHeaderTable(/*IsImplicit=*/false));
1425
1427 IO, *cast<ELFYAML::SectionHeaderTable>(Section.get()));
1428 return;
1429 }
1430
1431 const auto &Obj = *static_cast<ELFYAML::Object *>(IO.getContext());
1432 if (Obj.getMachine() == ELF::EM_MIPS && Type == ELF::SHT_MIPS_ABIFLAGS) {
1433 if (!IO.outputting())
1434 Section.reset(new ELFYAML::MipsABIFlags());
1436 return;
1437 }
1438
1439 if (Obj.getMachine() == ELF::EM_ARM && Type == ELF::SHT_ARM_EXIDX) {
1440 if (!IO.outputting())
1441 Section.reset(new ELFYAML::ARMIndexTableSection());
1443 return;
1444 }
1445
1446 switch (Type) {
1447 case ELF::SHT_DYNAMIC:
1448 if (!IO.outputting())
1449 Section.reset(new ELFYAML::DynamicSection());
1451 break;
1452 case ELF::SHT_REL:
1453 case ELF::SHT_RELA:
1454 case ELF::SHT_CREL:
1455 if (!IO.outputting())
1456 Section.reset(new ELFYAML::RelocationSection());
1458 break;
1459 case ELF::SHT_RELR:
1460 if (!IO.outputting())
1461 Section.reset(new ELFYAML::RelrSection());
1463 break;
1464 case ELF::SHT_GROUP:
1465 if (!IO.outputting())
1466 Section.reset(new ELFYAML::GroupSection());
1468 break;
1469 case ELF::SHT_NOBITS:
1470 if (!IO.outputting())
1471 Section.reset(new ELFYAML::NoBitsSection());
1473 break;
1474 case ELF::SHT_HASH:
1475 if (!IO.outputting())
1476 Section.reset(new ELFYAML::HashSection());
1478 break;
1479 case ELF::SHT_NOTE:
1480 if (!IO.outputting())
1481 Section.reset(new ELFYAML::NoteSection());
1483 break;
1484 case ELF::SHT_GNU_HASH:
1485 if (!IO.outputting())
1486 Section.reset(new ELFYAML::GnuHashSection());
1488 break;
1490 if (!IO.outputting())
1491 Section.reset(new ELFYAML::VerdefSection());
1493 break;
1495 if (!IO.outputting())
1496 Section.reset(new ELFYAML::SymverSection());
1498 break;
1500 if (!IO.outputting())
1501 Section.reset(new ELFYAML::VerneedSection());
1503 break;
1505 if (!IO.outputting())
1506 Section.reset(new ELFYAML::SymtabShndxSection());
1508 break;
1510 if (!IO.outputting())
1511 Section.reset(new ELFYAML::AddrsigSection());
1513 break;
1515 if (!IO.outputting())
1516 Section.reset(new ELFYAML::LinkerOptionsSection());
1518 break;
1520 if (!IO.outputting())
1521 Section.reset(new ELFYAML::DependentLibrariesSection());
1524 break;
1526 if (!IO.outputting())
1527 Section.reset(new ELFYAML::CallGraphProfileSection());
1529 break;
1531 if (!IO.outputting())
1532 Section.reset(new ELFYAML::BBAddrMapSection());
1534 break;
1535 default:
1536 if (!IO.outputting()) {
1537 StringRef Name;
1538 IO.mapOptional("Name", Name, StringRef());
1539 Name = ELFYAML::dropUniqueSuffix(Name);
1540
1542 Section = std::make_unique<ELFYAML::StackSizesSection>();
1543 else
1544 Section = std::make_unique<ELFYAML::RawContentSection>();
1545 }
1546
1547 if (auto S = dyn_cast<ELFYAML::RawContentSection>(Section.get()))
1548 sectionMapping(IO, *S);
1549 else
1551 }
1552}
1553
1555 IO &io, std::unique_ptr<ELFYAML::Chunk> &C) {
1556 if (const auto *F = dyn_cast<ELFYAML::Fill>(C.get())) {
1557 // Can't check the `Size`, as it's required and may be left uninitialized by
1558 // previous error.
1559 if (!io.error() && F->Pattern && F->Pattern->binary_size() != 0 && !F->Size)
1560 return "\"Size\" can't be 0 when \"Pattern\" is not empty";
1561 return "";
1562 }
1563
1564 if (const auto *SHT = dyn_cast<ELFYAML::SectionHeaderTable>(C.get())) {
1565 if (SHT->NoHeaders && (SHT->Sections || SHT->Excluded || SHT->Offset))
1566 return "NoHeaders can't be used together with Offset/Sections/Excluded";
1567 return "";
1568 }
1569
1570 const ELFYAML::Section &Sec = *cast<ELFYAML::Section>(C.get());
1571 if (Sec.Size && Sec.Content &&
1572 (uint64_t)(*Sec.Size) < Sec.Content->binary_size())
1573 return "Section size must be greater than or equal to the content size";
1574
1575 auto BuildErrPrefix = [](ArrayRef<std::pair<StringRef, bool>> EntV) {
1576 std::string Msg;
1577 for (size_t I = 0, E = EntV.size(); I != E; ++I) {
1578 StringRef Name = EntV[I].first;
1579 if (I == 0) {
1580 Msg = "\"" + Name.str() + "\"";
1581 continue;
1582 }
1583 if (I != EntV.size() - 1)
1584 Msg += ", \"" + Name.str() + "\"";
1585 else
1586 Msg += " and \"" + Name.str() + "\"";
1587 }
1588 return Msg;
1589 };
1590
1591 std::vector<std::pair<StringRef, bool>> Entries = Sec.getEntries();
1592 const size_t NumUsedEntries = llvm::count_if(
1593 Entries, [](const std::pair<StringRef, bool> &P) { return P.second; });
1594
1595 if ((Sec.Size || Sec.Content) && NumUsedEntries > 0)
1596 return BuildErrPrefix(Entries) +
1597 " cannot be used with \"Content\" or \"Size\"";
1598
1599 if (NumUsedEntries > 0 && Entries.size() != NumUsedEntries)
1600 return BuildErrPrefix(Entries) + " must be used together";
1601
1602 if (const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(C.get())) {
1603 if (RawSection->Flags && RawSection->ShFlags)
1604 return "ShFlags and Flags cannot be used together";
1605 return "";
1606 }
1607
1608 if (const auto *NB = dyn_cast<ELFYAML::NoBitsSection>(C.get())) {
1609 if (NB->Content)
1610 return "SHT_NOBITS section cannot have \"Content\"";
1611 return "";
1612 }
1613
1614 if (const auto *MF = dyn_cast<ELFYAML::MipsABIFlags>(C.get())) {
1615 if (MF->Content)
1616 return "\"Content\" key is not implemented for SHT_MIPS_ABIFLAGS "
1617 "sections";
1618 if (MF->Size)
1619 return "\"Size\" key is not implemented for SHT_MIPS_ABIFLAGS sections";
1620 return "";
1621 }
1622
1623 return "";
1624}
1625
1626namespace {
1627
1628struct NormalizedMips64RelType {
1629 NormalizedMips64RelType(IO &)
1630 : Type(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1631 Type2(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1632 Type3(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1633 SpecSym(ELFYAML::ELF_REL(ELF::RSS_UNDEF)) {}
1634 NormalizedMips64RelType(IO &, ELFYAML::ELF_REL Original)
1635 : Type(Original & 0xFF), Type2(Original >> 8 & 0xFF),
1636 Type3(Original >> 16 & 0xFF), SpecSym(Original >> 24 & 0xFF) {}
1637
1638 ELFYAML::ELF_REL denormalize(IO &) {
1639 ELFYAML::ELF_REL Res = Type | Type2 << 8 | Type3 << 16 | SpecSym << 24;
1640 return Res;
1641 }
1642
1643 ELFYAML::ELF_REL Type;
1644 ELFYAML::ELF_REL Type2;
1645 ELFYAML::ELF_REL Type3;
1646 ELFYAML::ELF_RSS SpecSym;
1647};
1648
1649} // end anonymous namespace
1650
1653 assert(IO.getContext() && "The IO context is not initialized");
1654 IO.mapOptional("Address", E.Address, Hex64(0));
1655 IO.mapRequired("Size", E.Size);
1656}
1657
1660 assert(IO.getContext() && "The IO context is not initialized");
1661 IO.mapOptional("NBuckets", E.NBuckets);
1662 IO.mapRequired("SymNdx", E.SymNdx);
1663 IO.mapOptional("MaskWords", E.MaskWords);
1664 IO.mapRequired("Shift2", E.Shift2);
1665}
1666
1668 ELFYAML::DynamicEntry &Rel) {
1669 assert(IO.getContext() && "The IO context is not initialized");
1670
1671 IO.mapRequired("Tag", Rel.Tag);
1672 IO.mapRequired("Value", Rel.Val);
1673}
1674
1676 assert(IO.getContext() && "The IO context is not initialized");
1677
1678 IO.mapOptional("Name", N.Name);
1679 IO.mapOptional("Desc", N.Desc);
1680 IO.mapRequired("Type", N.Type);
1681}
1682
1685 assert(IO.getContext() && "The IO context is not initialized");
1686
1687 IO.mapOptional("Version", E.Version);
1688 IO.mapOptional("Flags", E.Flags);
1689 IO.mapOptional("VersionNdx", E.VersionNdx);
1690 IO.mapOptional("Hash", E.Hash);
1691 IO.mapOptional("VDAux", E.VDAux);
1692 IO.mapRequired("Names", E.VerNames);
1693}
1694
1697 assert(IO.getContext() && "The IO context is not initialized");
1698
1699 IO.mapRequired("Version", E.Version);
1700 IO.mapRequired("File", E.File);
1701 IO.mapRequired("Entries", E.AuxV);
1702}
1703
1706 assert(IO.getContext() && "The IO context is not initialized");
1707
1708 IO.mapRequired("Name", E.Name);
1709 IO.mapRequired("Hash", E.Hash);
1710 IO.mapRequired("Flags", E.Flags);
1711 IO.mapRequired("Other", E.Other);
1712}
1713
1715 ELFYAML::Relocation &Rel) {
1716 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
1717 assert(Object && "The IO context is not initialized");
1718
1719 IO.mapOptional("Offset", Rel.Offset, (Hex64)0);
1720 IO.mapOptional("Symbol", Rel.Symbol);
1721
1722 if (Object->getMachine() == ELFYAML::ELF_EM(ELF::EM_MIPS) &&
1723 Object->Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
1725 IO, Rel.Type);
1726 IO.mapRequired("Type", Key->Type);
1727 IO.mapOptional("Type2", Key->Type2, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
1728 IO.mapOptional("Type3", Key->Type3, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
1729 IO.mapOptional("SpecSym", Key->SpecSym, ELFYAML::ELF_RSS(ELF::RSS_UNDEF));
1730 } else
1731 IO.mapRequired("Type", Rel.Type);
1732
1733 IO.mapOptional("Addend", Rel.Addend, (ELFYAML::YAMLIntUInt)0);
1734}
1735
1738 assert(IO.getContext() && "The IO context is not initialized");
1739 IO.mapRequired("Offset", E.Offset);
1740
1741 StringRef CantUnwind = "EXIDX_CANTUNWIND";
1743 IO.mapRequired("Value", CantUnwind);
1744 else if (!IO.outputting() && getStringValue(IO, "Value") == CantUnwind)
1746 else
1747 IO.mapRequired("Value", E.Value);
1748}
1749
1751 assert(!IO.getContext() && "The IO context is initialized already");
1752 IO.setContext(&Object);
1753 IO.mapTag("!ELF", true);
1754 IO.mapRequired("FileHeader", Object.Header);
1755 IO.mapOptional("ProgramHeaders", Object.ProgramHeaders);
1756 IO.mapOptional("Sections", Object.Chunks);
1757 IO.mapOptional("Symbols", Object.Symbols);
1758 IO.mapOptional("DynamicSymbols", Object.DynamicSymbols);
1759 IO.mapOptional("DWARF", Object.DWARF);
1760 if (Object.DWARF) {
1761 Object.DWARF->IsLittleEndian =
1762 Object.Header.Data == ELFYAML::ELF_ELFDATA(ELF::ELFDATA2LSB);
1763 Object.DWARF->Is64BitAddrSize =
1764 Object.Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64);
1765 }
1766 IO.setContext(nullptr);
1767}
1768
1770 ELFYAML::LinkerOption &Opt) {
1771 assert(IO.getContext() && "The IO context is not initialized");
1772 IO.mapRequired("Name", Opt.Key);
1773 IO.mapRequired("Value", Opt.Value);
1774}
1775
1778 assert(IO.getContext() && "The IO context is not initialized");
1779 IO.mapRequired("Weight", E.Weight);
1780}
1781
1782} // end namespace yaml
1783
1784} // end namespace llvm
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
uint64_t uint64_t
This file implements a class to represent arbitrary precision integral constant values and operations...
#define X(NUM, ENUM, NAME)
Definition ELF.h:665
#define AMDGPU_MACH_LIST(X)
Definition ELF.h:576
static GCRegistry::Add< ShadowStackGC > C("shadow-stack", "Very portable GC for uncooperative code generators")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
#define BCase(X)
Definition COFFYAML.cpp:267
#define BCaseMask(X, M)
This file declares classes for handling the YAML representation of ELF.
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
This file implements a map that provides insertion order iteration.
#define P(N)
const char * Msg
static uint32_t getFlags(const Symbol *Sym)
Definition TapiFile.cpp:26
#define ECase(X)
#define LLVM_YAML_STRONG_TYPEDEF(_base, _type)
YAML I/O does conversion based on types. But often native data types are just a typedef of built in i...
Class for arbitrary precision integers.
Definition APInt.h:78
Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
This class implements a map that also provides access to all stored values in a deterministic order.
Definition MapVector.h:38
Represent a constant reference to a string, i.e.
Definition StringRef.h:56
bool getAsInteger(unsigned Radix, T &Result) const
Parse the current string as an integer of the specified radix.
Definition StringRef.h:490
bool starts_with(StringRef Prefix) const
Check if this string starts with the given Prefix.
Definition StringRef.h:258
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
Type(LLVMContext &C, TypeID tid)
Definition Type.h:95
LLVM Value Representation.
Definition Value.h:75
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
Specialized YAMLIO scalar type for representing a binary blob.
Definition YAML.h:64
void setContext(void *)
virtual bool outputting() const =0
virtual bool mapTag(StringRef Tag, bool Default=false)=0
void enumCase(T &Val, StringRef Str, const T ConstVal)
Definition YAMLTraits.h:735
virtual std::error_code error()=0
void mapOptional(StringRef Key, T &Val)
Definition YAMLTraits.h:800
virtual void setError(const Twine &)=0
void * getContext() const
void enumFallback(T &Val)
Definition YAMLTraits.h:749
void mapRequired(StringRef Key, T &Val)
Definition YAMLTraits.h:790
void maskedBitSetCase(T &Val, StringRef Str, T ConstVal, T Mask)
Definition YAMLTraits.h:775
#define UINT64_MAX
Definition DataTypes.h:77
#define INT64_MIN
Definition DataTypes.h:74
@ EXIDX_CANTUNWIND
Special entry for the function never unwind.
Definition ARMEHABI.h:35
LLVM_ABI StringRef dropUniqueSuffix(StringRef S)
@ STO_MIPS_PIC
Definition ELF.h:409
@ STO_MIPS_OPTIONAL
Definition ELF.h:407
@ STO_MIPS_MICROMIPS
Definition ELF.h:410
@ STO_MIPS_MIPS16
Definition ELF.h:411
@ STO_MIPS_PLT
Definition ELF.h:408
@ SHT_LLVM_DEPENDENT_LIBRARIES
Definition ELF.h:996
@ SHT_GROUP
Definition ELF.h:979
@ SHT_LLVM_LINKER_OPTIONS
Definition ELF.h:993
@ SHT_REL
Definition ELF.h:973
@ SHT_NULL
Definition ELF.h:964
@ SHT_LLVM_CALL_GRAPH_PROFILE
Definition ELF.h:1002
@ SHT_NOBITS
Definition ELF.h:972
@ SHT_GNU_verneed
Definition ELF.h:1017
@ SHT_RELR
Definition ELF.h:983
@ SHT_GNU_verdef
Definition ELF.h:1016
@ SHT_CREL
Definition ELF.h:986
@ SHT_DYNAMIC
Definition ELF.h:970
@ SHT_SYMTAB_SHNDX
Definition ELF.h:980
@ SHT_LLVM_ADDRSIG
Definition ELF.h:994
@ SHT_ARM_EXIDX
Definition ELF.h:1023
@ SHT_LLVM_BB_ADDR_MAP
Definition ELF.h:1003
@ SHT_GNU_HASH
Definition ELF.h:1015
@ SHT_RELA
Definition ELF.h:968
@ SHT_NOTE
Definition ELF.h:971
@ SHT_MIPS_ABIFLAGS
Definition ELF.h:1046
@ SHT_GNU_versym
Definition ELF.h:1018
@ SHT_HASH
Definition ELF.h:969
@ ELFOSABI_SOLARIS
Definition ELF.h:160
@ ELFDATA2LSB
Definition ELF.h:148
@ RSS_UNDEF
Definition ELF.h:1270
@ ELFABIVERSION_AMDGPU_HSA_V4
Definition ELF.h:192
@ ELFABIVERSION_AMDGPU_HSA_V5
Definition ELF.h:193
@ ELFABIVERSION_AMDGPU_HSA_V3
Definition ELF.h:191
@ ELFABIVERSION_AMDGPU_HSA_V6
Definition ELF.h:194
@ ELFCLASS64
Definition ELF.h:142
@ STO_RISCV_VARIANT_CC
Definition ELF.h:541
@ EF_AMDGPU_GENERIC_VERSION_MAX
Definition ELF.h:741
@ EF_AMDGPU_GENERIC_VERSION_OFFSET
Definition ELF.h:739
@ EF_AMDGPU_GENERIC_VERSION_MIN
Definition ELF.h:740
@ EF_AMDGPU_GENERIC_VERSION
Definition ELF.h:738
@ STO_AARCH64_VARIANT_PCS
Definition ELF.h:252
@ STV_INTERNAL
Definition ELF.h:1260
@ STV_HIDDEN
Definition ELF.h:1261
@ STV_PROTECTED
Definition ELF.h:1262
@ STV_DEFAULT
Definition ELF.h:1259
@ Val_GNU_MIPS_ABI_FP_ANY
static void sectionMapping(IO &IO, ELFYAML::DynamicSection &Section)
Definition ELFYAML.cpp:1214
QuotingType
Describe which type of quotes should be used when quoting is necessary.
Definition YAMLTraits.h:132
static void groupSectionMapping(IO &IO, ELFYAML::GroupSection &Group)
Definition ELFYAML.cpp:1304
static StringRef getStringValue(IO &IO, const char *Key)
Definition ELFYAML.cpp:1381
static void sectionHeaderTableMapping(IO &IO, ELFYAML::SectionHeaderTable &SHT)
Definition ELFYAML.cpp:1327
static void commonSectionMapping(IO &IO, ELFYAML::Section &Section)
Definition ELFYAML.cpp:1187
static bool isInteger(StringRef Val)
Definition ELFYAML.cpp:1391
static void fillMapping(IO &IO, ELFYAML::Fill &Fill)
Definition ELFYAML.cpp:1320
static void setStringValue(IO &IO, const char *Key, StringRef Val)
Definition ELFYAML.cpp:1387
This is an optimization pass for GlobalISel generic memory operations.
LLVM_ABI bool getAsSignedInteger(StringRef Str, unsigned Radix, long long &Result)
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
LLVM_ATTRIBUTE_VISIBILITY_DEFAULT AnalysisKey InnerAnalysisManagerProxy< AnalysisManagerT, IRUnitT, ExtraArgTs... >::Key
@ Other
Any other memory.
Definition ModRef.h:68
auto count_if(R &&Range, UnaryPredicate P)
Wrapper function around std::count_if to count the number of times an element satisfying a given pred...
Definition STLExtras.h:2035
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
LLVM_ABI bool getAsUnsignedInteger(StringRef Str, unsigned Radix, unsigned long long &Result)
Helper functions for StringRef::getAsInteger.
bool to_integer(StringRef S, N &Num, unsigned Base=0)
Convert the string S to an integer of the specified type using the radix Base. If Base is 0,...
#define N
std::optional< llvm::yaml::Hex64 > Offset
Definition ELFYAML.h:203
llvm::yaml::Hex64 Val
Definition ELFYAML.h:157
std::optional< llvm::yaml::Hex16 > EPhNum
Definition ELFYAML.h:127
std::optional< llvm::yaml::Hex64 > EShOff
Definition ELFYAML.h:129
std::optional< llvm::yaml::Hex64 > EPhOff
Definition ELFYAML.h:125
std::optional< llvm::yaml::Hex16 > EShEntSize
Definition ELFYAML.h:128
std::optional< llvm::yaml::Hex16 > EPhEntSize
Definition ELFYAML.h:126
llvm::yaml::Hex8 ABIVersion
Definition ELFYAML.h:118
std::optional< llvm::yaml::Hex16 > EShNum
Definition ELFYAML.h:130
llvm::yaml::Hex64 Entry
Definition ELFYAML.h:122
std::optional< ELF_EF > Flags
Definition ELFYAML.h:121
std::optional< ELF_EM > Machine
Definition ELFYAML.h:120
std::optional< StringRef > SectionHeaderStringTable
Definition ELFYAML.h:123
std::optional< llvm::yaml::Hex16 > EShStrNdx
Definition ELFYAML.h:131
llvm::yaml::Hex64 Size
Definition ELFYAML.h:273
std::optional< yaml::BinaryRef > Pattern
Definition ELFYAML.h:272
std::optional< std::vector< SectionOrType > > Members
Definition ELFYAML.h:567
std::optional< StringRef > Signature
Definition ELFYAML.h:568
LLVM_ABI unsigned getMachine() const
Definition ELFYAML.cpp:35
FileHeader Header
Definition ELFYAML.h:686
LLVM_ABI ELF_ELFOSABI getOSAbi() const
Definition ELFYAML.cpp:33
std::optional< llvm::yaml::Hex64 > Align
Definition ELFYAML.h:674
llvm::yaml::Hex64 PAddr
Definition ELFYAML.h:673
std::optional< llvm::yaml::Hex64 > Offset
Definition ELFYAML.h:677
llvm::yaml::Hex64 VAddr
Definition ELFYAML.h:672
std::optional< llvm::yaml::Hex64 > MemSize
Definition ELFYAML.h:676
std::optional< StringRef > FirstSec
Definition ELFYAML.h:678
std::optional< StringRef > LastSec
Definition ELFYAML.h:679
std::optional< llvm::yaml::Hex64 > FileSize
Definition ELFYAML.h:675
std::optional< StringRef > Symbol
Definition ELFYAML.h:583
llvm::yaml::Hex64 Offset
Definition ELFYAML.h:580
std::optional< std::vector< SectionHeader > > Excluded
Definition ELFYAML.h:289
static constexpr StringRef TypeStr
Definition ELFYAML.h:302
std::optional< bool > NoHeaders
Definition ELFYAML.h:290
std::optional< std::vector< SectionHeader > > Sections
Definition ELFYAML.h:288
std::optional< llvm::yaml::Hex64 > Size
Definition ELFYAML.h:222
virtual std::vector< std::pair< StringRef, bool > > getEntries() const
Definition ELFYAML.h:236
std::optional< yaml::BinaryRef > Content
Definition ELFYAML.h:221
static bool nameMatches(StringRef Name)
Definition ELFYAML.h:333
static LLVM_ABI std::string validate(IO &io, std::unique_ptr< ELFYAML::Chunk > &C)
Definition ELFYAML.cpp:1554
static LLVM_ABI void mapping(IO &IO, std::unique_ptr< ELFYAML::Chunk > &C)
Definition ELFYAML.cpp:1396
This class should be specialized by any type that needs to be converted to/from a YAML mapping.
Definition YAMLTraits.h:63
This class should be specialized by any integer type that is a union of bit values and the YAML repre...
Definition YAMLTraits.h:124
This class should be specialized by any integral type that converts to/from a YAML scalar where there...
Definition YAMLTraits.h:108
static StringRef input(StringRef Scalar, void *, ELFYAML::YAMLFlowString &Val)
Definition ELFYAML.cpp:1017
static void output(const ELFYAML::YAMLFlowString &Val, void *, raw_ostream &Out)
Definition ELFYAML.cpp:1013
static QuotingType mustQuote(StringRef S)
Definition ELFYAML.cpp:1022
static StringRef input(StringRef Scalar, void *, StOtherPiece &Val)
Definition ELFYAML.cpp:1002
static QuotingType mustQuote(StringRef)
Definition ELFYAML.cpp:1006
static void output(const StOtherPiece &Val, void *, raw_ostream &Out)
Definition ELFYAML.cpp:999
This class should be specialized by type that requires custom conversion to/from a yaml scalar.
Definition YAMLTraits.h:150
This class should be specialized by any type for which vectors of that type need to be converted to/f...
Definition YAMLTraits.h:258