1//===- ELFObjectFile.cpp - ELF object file 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// Part of the ELFObjectFile class implementation.
10//
11//===----------------------------------------------------------------------===//
12
13#include "llvm/Object/ELFObjectFile.h"
14#include "llvm/BinaryFormat/ELF.h"
15#include "llvm/MC/MCInstrAnalysis.h"
16#include "llvm/MC/TargetRegistry.h"
17#include "llvm/Object/ELF.h"
18#include "llvm/Object/ELFTypes.h"
19#include "llvm/Object/Error.h"
20#include "llvm/Support/ARMAttributeParser.h"
21#include "llvm/Support/ARMBuildAttributes.h"
22#include "llvm/Support/ErrorHandling.h"
23#include "llvm/Support/HexagonAttributeParser.h"
24#include "llvm/Support/RISCVAttributeParser.h"
25#include "llvm/Support/RISCVAttributes.h"
26#include "llvm/TargetParser/RISCVISAInfo.h"
27#include "llvm/TargetParser/SubtargetFeature.h"
28#include "llvm/TargetParser/Triple.h"
29#include <algorithm>
30#include <cstddef>
31#include <cstdint>
32#include <memory>
33#include <optional>
34#include <string>
35#include <utility>
36
37using namespace llvm;
38using namespace object;
39
40EnumStrings<uint8_t, 2> llvm::object::getElfSymbolTypes() {
41 constexpr EnumStringDef<uint8_t, 2> ElfSymbolTypeDefs[] = {
42 {.Names: {"None", "NOTYPE"}, .Value: ELF::STT_NOTYPE},
43 {.Names: {"Object", "OBJECT"}, .Value: ELF::STT_OBJECT},
44 {.Names: {"Function", "FUNC"}, .Value: ELF::STT_FUNC},
45 {.Names: {"Section", "SECTION"}, .Value: ELF::STT_SECTION},
46 {.Names: {"File", "FILE"}, .Value: ELF::STT_FILE},
47 {.Names: {"Common", "COMMON"}, .Value: ELF::STT_COMMON},
48 {.Names: {"TLS", "TLS"}, .Value: ELF::STT_TLS},
49 {.Names: {"Unknown", "<unknown>: 7"}, .Value: 7},
50 {.Names: {"Unknown", "<unknown>: 8"}, .Value: 8},
51 {.Names: {"Unknown", "<unknown>: 9"}, .Value: 9},
52 {.Names: {"GNU_IFunc", "IFUNC"}, .Value: ELF::STT_GNU_IFUNC},
53 {.Names: {"OS Specific", "<OS specific>: 11"}, .Value: 11},
54 {.Names: {"OS Specific", "<OS specific>: 12"}, .Value: 12},
55 {.Names: {"Proc Specific", "<processor specific>: 13"}, .Value: 13},
56 {.Names: {"Proc Specific", "<processor specific>: 14"}, .Value: 14},
57 {.Names: {"Proc Specific", "<processor specific>: 15"}, .Value: 15},
58 };
59 static constexpr auto ElfSymbolTypes = BUILD_ENUM_STRINGS(ElfSymbolTypeDefs);
60 return ElfSymbolTypes;
61}
62
63ELFObjectFileBase::ELFObjectFileBase(unsigned int Type, MemoryBufferRef Source)
64 : ObjectFile(Type, Source) {}
65
66template <class ELFT>
67static Expected<std::unique_ptr<ELFObjectFile<ELFT>>>
68createPtr(MemoryBufferRef Object, bool InitContent) {
69 auto Ret = ELFObjectFile<ELFT>::create(Object, InitContent);
70 if (Error E = Ret.takeError())
71 return std::move(E);
72 return std::make_unique<ELFObjectFile<ELFT>>(std::move(*Ret));
73}
74
75Expected<std::unique_ptr<ObjectFile>>
76ObjectFile::createELFObjectFile(MemoryBufferRef Obj, bool InitContent) {
77 std::pair<unsigned char, unsigned char> Ident =
78 getElfArchType(Object: Obj.getBuffer());
79 std::size_t MaxAlignment =
80 1ULL << llvm::countr_zero(
81 Val: reinterpret_cast<uintptr_t>(Obj.getBufferStart()));
82
83 if (MaxAlignment < 2)
84 return createError(Err: "Insufficient alignment");
85
86 if (Ident.first == ELF::ELFCLASS32) {
87 if (Ident.second == ELF::ELFDATA2LSB)
88 return createPtr<ELF32LE>(Object: Obj, InitContent);
89 else if (Ident.second == ELF::ELFDATA2MSB)
90 return createPtr<ELF32BE>(Object: Obj, InitContent);
91 else
92 return createError(Err: "Invalid ELF data");
93 } else if (Ident.first == ELF::ELFCLASS64) {
94 if (Ident.second == ELF::ELFDATA2LSB)
95 return createPtr<ELF64LE>(Object: Obj, InitContent);
96 else if (Ident.second == ELF::ELFDATA2MSB)
97 return createPtr<ELF64BE>(Object: Obj, InitContent);
98 else
99 return createError(Err: "Invalid ELF data");
100 }
101 return createError(Err: "Invalid ELF class");
102}
103
104SubtargetFeatures ELFObjectFileBase::getMIPSFeatures() const {
105 SubtargetFeatures Features;
106 unsigned PlatformFlags = getPlatformFlags();
107
108 switch (PlatformFlags & ELF::EF_MIPS_ARCH) {
109 case ELF::EF_MIPS_ARCH_1:
110 break;
111 case ELF::EF_MIPS_ARCH_2:
112 Features.AddFeature(String: "mips2");
113 break;
114 case ELF::EF_MIPS_ARCH_3:
115 Features.AddFeature(String: "mips3");
116 break;
117 case ELF::EF_MIPS_ARCH_4:
118 Features.AddFeature(String: "mips4");
119 break;
120 case ELF::EF_MIPS_ARCH_5:
121 Features.AddFeature(String: "mips5");
122 break;
123 case ELF::EF_MIPS_ARCH_32:
124 Features.AddFeature(String: "mips32");
125 break;
126 case ELF::EF_MIPS_ARCH_64:
127 Features.AddFeature(String: "mips64");
128 break;
129 case ELF::EF_MIPS_ARCH_32R2:
130 Features.AddFeature(String: "mips32r2");
131 break;
132 case ELF::EF_MIPS_ARCH_64R2:
133 Features.AddFeature(String: "mips64r2");
134 break;
135 case ELF::EF_MIPS_ARCH_32R6:
136 Features.AddFeature(String: "mips32r6");
137 break;
138 case ELF::EF_MIPS_ARCH_64R6:
139 Features.AddFeature(String: "mips64r6");
140 break;
141 default:
142 llvm_unreachable("Unknown EF_MIPS_ARCH value");
143 }
144
145 switch (PlatformFlags & ELF::EF_MIPS_MACH) {
146 case ELF::EF_MIPS_MACH_NONE:
147 // No feature associated with this value.
148 break;
149 case ELF::EF_MIPS_MACH_OCTEON:
150 Features.AddFeature(String: "cnmips");
151 break;
152 default:
153 llvm_unreachable("Unknown EF_MIPS_ARCH value");
154 }
155
156 if (PlatformFlags & ELF::EF_MIPS_ARCH_ASE_M16)
157 Features.AddFeature(String: "mips16");
158 if (PlatformFlags & ELF::EF_MIPS_MICROMIPS)
159 Features.AddFeature(String: "micromips");
160
161 return Features;
162}
163
164SubtargetFeatures ELFObjectFileBase::getARMFeatures() const {
165 SubtargetFeatures Features;
166 ARMAttributeParser Attributes;
167 if (Error E = getBuildAttributes(Attributes)) {
168 consumeError(Err: std::move(E));
169 return SubtargetFeatures();
170 }
171
172 // both ARMv7-M and R have to support thumb hardware div
173 bool isV7 = false;
174 std::optional<unsigned> Attr =
175 Attributes.getAttributeValue(tag: ARMBuildAttrs::CPU_arch);
176 if (Attr)
177 isV7 = *Attr == ARMBuildAttrs::v7;
178
179 Attr = Attributes.getAttributeValue(tag: ARMBuildAttrs::CPU_arch_profile);
180 if (Attr) {
181 switch (*Attr) {
182 case ARMBuildAttrs::ApplicationProfile:
183 Features.AddFeature(String: "aclass");
184 break;
185 case ARMBuildAttrs::RealTimeProfile:
186 Features.AddFeature(String: "rclass");
187 if (isV7)
188 Features.AddFeature(String: "hwdiv");
189 break;
190 case ARMBuildAttrs::MicroControllerProfile:
191 Features.AddFeature(String: "mclass");
192 if (isV7)
193 Features.AddFeature(String: "hwdiv");
194 break;
195 }
196 }
197
198 Attr = Attributes.getAttributeValue(tag: ARMBuildAttrs::THUMB_ISA_use);
199 if (Attr) {
200 switch (*Attr) {
201 default:
202 break;
203 case ARMBuildAttrs::Not_Allowed:
204 Features.AddFeature(String: "thumb", Enable: false);
205 Features.AddFeature(String: "thumb2", Enable: false);
206 break;
207 case ARMBuildAttrs::AllowThumb32:
208 Features.AddFeature(String: "thumb2");
209 break;
210 }
211 }
212
213 Attr = Attributes.getAttributeValue(tag: ARMBuildAttrs::FP_arch);
214 if (Attr) {
215 switch (*Attr) {
216 default:
217 break;
218 case ARMBuildAttrs::Not_Allowed:
219 Features.AddFeature(String: "vfp2sp", Enable: false);
220 Features.AddFeature(String: "vfp3d16sp", Enable: false);
221 Features.AddFeature(String: "vfp4d16sp", Enable: false);
222 break;
223 case ARMBuildAttrs::AllowFPv2:
224 Features.AddFeature(String: "vfp2");
225 break;
226 case ARMBuildAttrs::AllowFPv3A:
227 case ARMBuildAttrs::AllowFPv3B:
228 Features.AddFeature(String: "vfp3");
229 break;
230 case ARMBuildAttrs::AllowFPv4A:
231 case ARMBuildAttrs::AllowFPv4B:
232 Features.AddFeature(String: "vfp4");
233 break;
234 }
235 }
236
237 Attr = Attributes.getAttributeValue(tag: ARMBuildAttrs::Advanced_SIMD_arch);
238 if (Attr) {
239 switch (*Attr) {
240 default:
241 break;
242 case ARMBuildAttrs::Not_Allowed:
243 Features.AddFeature(String: "neon", Enable: false);
244 Features.AddFeature(String: "fp16", Enable: false);
245 break;
246 case ARMBuildAttrs::AllowNeon:
247 Features.AddFeature(String: "neon");
248 break;
249 case ARMBuildAttrs::AllowNeon2:
250 Features.AddFeature(String: "neon");
251 Features.AddFeature(String: "fp16");
252 break;
253 }
254 }
255
256 Attr = Attributes.getAttributeValue(tag: ARMBuildAttrs::MVE_arch);
257 if (Attr) {
258 switch (*Attr) {
259 default:
260 break;
261 case ARMBuildAttrs::Not_Allowed:
262 Features.AddFeature(String: "mve", Enable: false);
263 Features.AddFeature(String: "mve.fp", Enable: false);
264 break;
265 case ARMBuildAttrs::AllowMVEInteger:
266 Features.AddFeature(String: "mve.fp", Enable: false);
267 Features.AddFeature(String: "mve");
268 break;
269 case ARMBuildAttrs::AllowMVEIntegerAndFloat:
270 Features.AddFeature(String: "mve.fp");
271 break;
272 }
273 }
274
275 Attr = Attributes.getAttributeValue(tag: ARMBuildAttrs::DIV_use);
276 if (Attr) {
277 switch (*Attr) {
278 default:
279 break;
280 case ARMBuildAttrs::DisallowDIV:
281 Features.AddFeature(String: "hwdiv", Enable: false);
282 Features.AddFeature(String: "hwdiv-arm", Enable: false);
283 break;
284 case ARMBuildAttrs::AllowDIVExt:
285 Features.AddFeature(String: "hwdiv");
286 Features.AddFeature(String: "hwdiv-arm");
287 break;
288 }
289 }
290
291 return Features;
292}
293
294static std::string hexagonAttrToFeatureString(unsigned Attr) {
295 return "v" + utostr(X: Attr);
296}
297
298SubtargetFeatures ELFObjectFileBase::getHexagonFeatures() const {
299 SubtargetFeatures Features;
300 HexagonAttributeParser Parser;
301 if (Error E = getBuildAttributes(Attributes&: Parser)) {
302 // Return no attributes if none can be read.
303 // This behavior is important for backwards compatibility.
304 consumeError(Err: std::move(E));
305 return Features;
306 }
307 std::optional<unsigned> Attr;
308
309 if ((Attr = Parser.getAttributeValue(tag: HexagonAttrs::ARCH)))
310 Features.AddFeature(String: hexagonAttrToFeatureString(Attr: *Attr));
311
312 if ((Attr = Parser.getAttributeValue(tag: HexagonAttrs::HVXARCH)))
313 Features.AddFeature(String: "hvx" + hexagonAttrToFeatureString(Attr: *Attr));
314
315 if ((Attr = Parser.getAttributeValue(tag: HexagonAttrs::HVXIEEEFP)))
316 if (*Attr)
317 Features.AddFeature(String: "hvx-ieee-fp");
318
319 if ((Attr = Parser.getAttributeValue(tag: HexagonAttrs::HVXQFLOAT)))
320 if (*Attr)
321 Features.AddFeature(String: "hvx-qfloat");
322
323 if ((Attr = Parser.getAttributeValue(tag: HexagonAttrs::ZREG)))
324 if (*Attr)
325 Features.AddFeature(String: "zreg");
326
327 if ((Attr = Parser.getAttributeValue(tag: HexagonAttrs::AUDIO)))
328 if (*Attr)
329 Features.AddFeature(String: "audio");
330
331 if ((Attr = Parser.getAttributeValue(tag: HexagonAttrs::CABAC)))
332 if (*Attr)
333 Features.AddFeature(String: "cabac");
334
335 return Features;
336}
337
338Expected<SubtargetFeatures> ELFObjectFileBase::getRISCVFeatures() const {
339 SubtargetFeatures Features;
340 unsigned PlatformFlags = getPlatformFlags();
341
342 if (PlatformFlags & ELF::EF_RISCV_RVC) {
343 Features.AddFeature(String: "zca");
344 }
345
346 RISCVAttributeParser Attributes;
347 if (Error E = getBuildAttributes(Attributes)) {
348 return std::move(E);
349 }
350
351 std::optional<StringRef> Attr =
352 Attributes.getAttributeString(tag: RISCVAttrs::ARCH);
353 if (Attr) {
354 auto ParseResult = RISCVISAInfo::parseNormalizedArchString(Arch: *Attr);
355 if (!ParseResult)
356 return ParseResult.takeError();
357 auto &ISAInfo = *ParseResult;
358
359 if (ISAInfo->getXLen() == 32)
360 Features.AddFeature(String: "64bit", Enable: false);
361 else if (ISAInfo->getXLen() == 64)
362 Features.AddFeature(String: "64bit");
363 else
364 llvm_unreachable("XLEN should be 32 or 64.");
365
366 Features.addFeaturesVector(OtherFeatures: ISAInfo->toFeatures());
367 }
368
369 return Features;
370}
371
372SubtargetFeatures ELFObjectFileBase::getLoongArchFeatures() const {
373 SubtargetFeatures Features;
374
375 switch (getPlatformFlags() & ELF::EF_LOONGARCH_ABI_MODIFIER_MASK) {
376 case ELF::EF_LOONGARCH_ABI_SOFT_FLOAT:
377 break;
378 case ELF::EF_LOONGARCH_ABI_DOUBLE_FLOAT:
379 Features.AddFeature(String: "d");
380 // D implies F according to LoongArch ISA spec.
381 [[fallthrough]];
382 case ELF::EF_LOONGARCH_ABI_SINGLE_FLOAT:
383 Features.AddFeature(String: "f");
384 break;
385 }
386
387 return Features;
388}
389
390SubtargetFeatures ELFObjectFileBase::getSparcFeatures() const {
391 SubtargetFeatures Features;
392 unsigned PlatformFlags = getPlatformFlags();
393
394 if (getEMachine() == ELF::EM_SPARC32PLUS ||
395 (PlatformFlags & ELF::EF_SPARC_32PLUS))
396 Features.AddFeature(String: "v9");
397 if (PlatformFlags & ELF::EF_SPARC_SUN_US1)
398 Features.AddFeature(String: "vis");
399 if (PlatformFlags & ELF::EF_SPARC_SUN_US3)
400 Features.AddFeature(String: "vis2");
401
402 return Features;
403}
404
405Expected<SubtargetFeatures> ELFObjectFileBase::getFeatures() const {
406 switch (getEMachine()) {
407 case ELF::EM_MIPS:
408 return getMIPSFeatures();
409 case ELF::EM_ARM:
410 return getARMFeatures();
411 case ELF::EM_RISCV:
412 return getRISCVFeatures();
413 case ELF::EM_LOONGARCH:
414 return getLoongArchFeatures();
415 case ELF::EM_HEXAGON:
416 return getHexagonFeatures();
417 case ELF::EM_SPARC:
418 case ELF::EM_SPARC32PLUS:
419 case ELF::EM_SPARCV9:
420 return getSparcFeatures();
421 default:
422 return SubtargetFeatures();
423 }
424}
425
426std::optional<StringRef> ELFObjectFileBase::tryGetCPUName() const {
427 switch (getEMachine()) {
428 case ELF::EM_AMDGPU:
429 return getAMDGPUCPUName();
430 case ELF::EM_CUDA:
431 return getNVPTXCPUName();
432 case ELF::EM_PPC:
433 case ELF::EM_PPC64:
434 return StringRef("future");
435 case ELF::EM_BPF:
436 return StringRef("v4");
437 default:
438 return std::nullopt;
439 }
440}
441
442StringRef ELFObjectFileBase::getAMDGPUCPUName() const {
443 assert(getEMachine() == ELF::EM_AMDGPU);
444 unsigned CPU = getPlatformFlags() & ELF::EF_AMDGPU_MACH;
445
446 switch (CPU) {
447#define X(NUM, ENUM, NAME) \
448 case ELF::ENUM: \
449 return NAME;
450 AMDGPU_MACH_LIST(X)
451#undef X
452
453 default:
454 llvm_unreachable("Unknown EF_AMDGPU_MACH value");
455 }
456}
457
458StringRef ELFObjectFileBase::getNVPTXCPUName() const {
459 assert(getEMachine() == ELF::EM_CUDA);
460 unsigned SM = getEIdentABIVersion() == ELF::ELFABIVERSION_CUDA_V1
461 ? getPlatformFlags() & ELF::EF_CUDA_SM
462 : (getPlatformFlags() & ELF::EF_CUDA_SM_MASK) >>
463 ELF::EF_CUDA_SM_OFFSET;
464
465 switch (SM) {
466 // Fermi architecture.
467 case ELF::EF_CUDA_SM20:
468 return "sm_20";
469 case ELF::EF_CUDA_SM21:
470 return "sm_21";
471
472 // Kepler architecture.
473 case ELF::EF_CUDA_SM30:
474 return "sm_30";
475 case ELF::EF_CUDA_SM32:
476 return "sm_32";
477 case ELF::EF_CUDA_SM35:
478 return "sm_35";
479 case ELF::EF_CUDA_SM37:
480 return "sm_37";
481
482 // Maxwell architecture.
483 case ELF::EF_CUDA_SM50:
484 return "sm_50";
485 case ELF::EF_CUDA_SM52:
486 return "sm_52";
487 case ELF::EF_CUDA_SM53:
488 return "sm_53";
489
490 // Pascal architecture.
491 case ELF::EF_CUDA_SM60:
492 return "sm_60";
493 case ELF::EF_CUDA_SM61:
494 return "sm_61";
495 case ELF::EF_CUDA_SM62:
496 return "sm_62";
497
498 // Volta architecture.
499 case ELF::EF_CUDA_SM70:
500 return "sm_70";
501 case ELF::EF_CUDA_SM72:
502 return "sm_72";
503
504 // Turing architecture.
505 case ELF::EF_CUDA_SM75:
506 return "sm_75";
507
508 // Ampere architecture.
509 case ELF::EF_CUDA_SM80:
510 return "sm_80";
511 case ELF::EF_CUDA_SM86:
512 return "sm_86";
513 case ELF::EF_CUDA_SM87:
514 return "sm_87";
515 case ELF::EF_CUDA_SM88:
516 return "sm_88";
517
518 // Ada architecture.
519 case ELF::EF_CUDA_SM89:
520 return "sm_89";
521
522 // Hopper architecture.
523 case ELF::EF_CUDA_SM90:
524 return getPlatformFlags() & ELF::EF_CUDA_ACCELERATORS_V1 ? "sm_90a"
525 : "sm_90";
526
527 // Blackwell architecture.
528 case ELF::EF_CUDA_SM100:
529 return getPlatformFlags() & ELF::EF_CUDA_ACCELERATORS ? "sm_100a"
530 : "sm_100";
531 case ELF::EF_CUDA_SM101:
532 return getPlatformFlags() & ELF::EF_CUDA_ACCELERATORS ? "sm_101a"
533 : "sm_101";
534 case ELF::EF_CUDA_SM103:
535 return getPlatformFlags() & ELF::EF_CUDA_ACCELERATORS ? "sm_103a"
536 : "sm_103";
537 case ELF::EF_CUDA_SM107:
538 return getPlatformFlags() & ELF::EF_CUDA_ACCELERATORS ? "sm_107a"
539 : "sm_107";
540 case ELF::EF_CUDA_SM110:
541 return getPlatformFlags() & ELF::EF_CUDA_ACCELERATORS ? "sm_110a"
542 : "sm_110";
543
544 // Rubin architecture.
545 case ELF::EF_CUDA_SM120:
546 return getPlatformFlags() & ELF::EF_CUDA_ACCELERATORS ? "sm_120a"
547 : "sm_120";
548 case ELF::EF_CUDA_SM121:
549 return getPlatformFlags() & ELF::EF_CUDA_ACCELERATORS ? "sm_121a"
550 : "sm_121";
551 default:
552 llvm_unreachable("Unknown EF_CUDA_SM value");
553 }
554}
555
556// FIXME Encode from a tablegen description or target parser.
557void ELFObjectFileBase::setARMSubArch(Triple &TheTriple) const {
558 if (TheTriple.getSubArch() != Triple::NoSubArch)
559 return;
560
561 ARMAttributeParser Attributes;
562 if (Error E = getBuildAttributes(Attributes)) {
563 // TODO Propagate Error.
564 consumeError(Err: std::move(E));
565 return;
566 }
567
568 std::string Triple;
569 // Default to ARM, but use the triple if it's been set.
570 if (TheTriple.isThumb())
571 Triple = "thumb";
572 else
573 Triple = "arm";
574
575 std::optional<unsigned> Attr =
576 Attributes.getAttributeValue(tag: ARMBuildAttrs::CPU_arch);
577 if (Attr) {
578 switch (*Attr) {
579 case ARMBuildAttrs::v4:
580 Triple += "v4";
581 break;
582 case ARMBuildAttrs::v4T:
583 Triple += "v4t";
584 break;
585 case ARMBuildAttrs::v5T:
586 Triple += "v5t";
587 break;
588 case ARMBuildAttrs::v5TE:
589 Triple += "v5te";
590 break;
591 case ARMBuildAttrs::v5TEJ:
592 Triple += "v5tej";
593 break;
594 case ARMBuildAttrs::v6:
595 Triple += "v6";
596 break;
597 case ARMBuildAttrs::v6KZ:
598 Triple += "v6kz";
599 break;
600 case ARMBuildAttrs::v6T2:
601 Triple += "v6t2";
602 break;
603 case ARMBuildAttrs::v6K:
604 Triple += "v6k";
605 break;
606 case ARMBuildAttrs::v7: {
607 std::optional<unsigned> ArchProfileAttr =
608 Attributes.getAttributeValue(tag: ARMBuildAttrs::CPU_arch_profile);
609 if (ArchProfileAttr == ARMBuildAttrs::MicroControllerProfile)
610 Triple += "v7m";
611 else
612 Triple += "v7";
613 break;
614 }
615 case ARMBuildAttrs::v6_M:
616 Triple += "v6m";
617 break;
618 case ARMBuildAttrs::v6S_M:
619 Triple += "v6sm";
620 break;
621 case ARMBuildAttrs::v7E_M:
622 Triple += "v7em";
623 break;
624 case ARMBuildAttrs::v8_A:
625 Triple += "v8a";
626 break;
627 case ARMBuildAttrs::v8_R:
628 Triple += "v8r";
629 break;
630 case ARMBuildAttrs::v8_M_Base:
631 Triple += "v8m.base";
632 break;
633 case ARMBuildAttrs::v8_M_Main:
634 Triple += "v8m.main";
635 break;
636 case ARMBuildAttrs::v8_1_M_Main:
637 Triple += "v8.1m.main";
638 break;
639 case ARMBuildAttrs::v9_A:
640 Triple += "v9a";
641 break;
642 }
643 }
644 if (!isLittleEndian())
645 Triple += "eb";
646
647 TheTriple.setArchName(Triple);
648}
649
650std::vector<ELFPltEntry>
651ELFObjectFileBase::getPltEntries(const MCSubtargetInfo &STI) const {
652 std::string Err;
653 const auto Triple = makeTriple();
654 const auto *T = TargetRegistry::lookupTarget(TheTriple: Triple, Error&: Err);
655 if (!T)
656 return {};
657 uint32_t JumpSlotReloc = 0, GlobDatReloc = 0;
658 switch (Triple.getArch()) {
659 case Triple::x86:
660 JumpSlotReloc = ELF::R_386_JUMP_SLOT;
661 GlobDatReloc = ELF::R_386_GLOB_DAT;
662 break;
663 case Triple::x86_64:
664 JumpSlotReloc = ELF::R_X86_64_JUMP_SLOT;
665 GlobDatReloc = ELF::R_X86_64_GLOB_DAT;
666 break;
667 case Triple::aarch64:
668 case Triple::aarch64_be:
669 JumpSlotReloc = ELF::R_AARCH64_JUMP_SLOT;
670 break;
671 case Triple::arm:
672 case Triple::armeb:
673 case Triple::thumb:
674 case Triple::thumbeb:
675 JumpSlotReloc = ELF::R_ARM_JUMP_SLOT;
676 break;
677 case Triple::hexagon:
678 JumpSlotReloc = ELF::R_HEX_JMP_SLOT;
679 GlobDatReloc = ELF::R_HEX_GLOB_DAT;
680 break;
681 case Triple::riscv32:
682 case Triple::riscv64:
683 JumpSlotReloc = ELF::R_RISCV_JUMP_SLOT;
684 break;
685 case Triple::loongarch32:
686 case Triple::loongarch64:
687 JumpSlotReloc = ELF::R_LARCH_JUMP_SLOT;
688 break;
689 default:
690 return {};
691 }
692 std::unique_ptr<const MCInstrInfo> MII(T->createMCInstrInfo());
693 std::unique_ptr<const MCInstrAnalysis> MIA(
694 T->createMCInstrAnalysis(Info: MII.get()));
695 if (!MIA)
696 return {};
697 std::vector<std::pair<uint64_t, uint64_t>> PltEntries;
698 std::optional<SectionRef> RelaPlt, RelaDyn;
699 uint64_t GotBaseVA = 0;
700 for (const SectionRef &Section : sections()) {
701 Expected<StringRef> NameOrErr = Section.getName();
702 if (!NameOrErr) {
703 consumeError(Err: NameOrErr.takeError());
704 continue;
705 }
706 StringRef Name = *NameOrErr;
707
708 if (Name == ".rela.plt" || Name == ".rel.plt") {
709 RelaPlt = Section;
710 } else if (Name == ".rela.dyn" || Name == ".rel.dyn") {
711 RelaDyn = Section;
712 } else if (Name == ".got.plt") {
713 GotBaseVA = Section.getAddress();
714 } else if (Name == ".plt" || Name == ".plt.got") {
715 Expected<StringRef> PltContents = Section.getContents();
716 if (!PltContents) {
717 consumeError(Err: PltContents.takeError());
718 return {};
719 }
720 llvm::append_range(
721 C&: PltEntries,
722 R: MIA->findPltEntries(PltSectionVA: Section.getAddress(),
723 PltContents: arrayRefFromStringRef(Input: *PltContents), STI));
724 }
725 }
726
727 // Build a map from GOT entry virtual address to PLT entry virtual address.
728 DenseMap<uint64_t, uint64_t> GotToPlt;
729 for (auto [Plt, GotPlt] : PltEntries) {
730 uint64_t GotPltEntry = GotPlt;
731 // An x86-32 PIC PLT uses jmp DWORD PTR [ebx-offset]. Add
732 // _GLOBAL_OFFSET_TABLE_ (EBX) to get the .got.plt (or .got) entry address.
733 // See X86MCTargetDesc.cpp:findPltEntries for the 1 << 32 bit.
734 if (GotPltEntry & (uint64_t(1) << 32) && getEMachine() == ELF::EM_386)
735 GotPltEntry = static_cast<int32_t>(GotPltEntry) + GotBaseVA;
736 GotToPlt.insert(KV: std::make_pair(x&: GotPltEntry, y&: Plt));
737 }
738
739 // Find the relocations in the dynamic relocation table that point to
740 // locations in the GOT for which we know the corresponding PLT entry.
741 std::vector<ELFPltEntry> Result;
742 auto handleRels = [&](iterator_range<relocation_iterator> Rels,
743 uint32_t RelType, StringRef PltSec) {
744 for (const auto &R : Rels) {
745 if (R.getType() != RelType)
746 continue;
747 auto PltEntryIter = GotToPlt.find(Val: R.getOffset());
748 if (PltEntryIter != GotToPlt.end()) {
749 symbol_iterator Sym = R.getSymbol();
750 if (Sym == symbol_end())
751 Result.push_back(
752 x: ELFPltEntry{.Section: PltSec, .Symbol: std::nullopt, .Address: PltEntryIter->second});
753 else
754 Result.push_back(x: ELFPltEntry{.Section: PltSec, .Symbol: Sym->getRawDataRefImpl(),
755 .Address: PltEntryIter->second});
756 }
757 }
758 };
759
760 if (RelaPlt)
761 handleRels(RelaPlt->relocations(), JumpSlotReloc, ".plt");
762
763 // If a symbol needing a PLT entry also needs a GLOB_DAT relocation, GNU ld's
764 // x86 port places the PLT entry in the .plt.got section.
765 if (RelaDyn)
766 handleRels(RelaDyn->relocations(), GlobDatReloc, ".plt.got");
767
768 return Result;
769}
770
771template <class ELFT>
772Expected<std::vector<BBAddrMap>> static readBBAddrMapImpl(
773 const ELFFile<ELFT> &EF, std::optional<unsigned> TextSectionIndex,
774 std::vector<PGOAnalysisMap> *PGOAnalyses) {
775 using Elf_Shdr = typename ELFT::Shdr;
776 bool IsRelocatable = EF.getHeader().e_type == ELF::ET_REL;
777 std::vector<BBAddrMap> BBAddrMaps;
778 if (PGOAnalyses)
779 PGOAnalyses->clear();
780
781 const auto &Sections = cantFail(EF.sections());
782 auto IsMatch = [&](const Elf_Shdr &Sec) -> Expected<bool> {
783 if (Sec.sh_type != ELF::SHT_LLVM_BB_ADDR_MAP)
784 return false;
785 if (!TextSectionIndex)
786 return true;
787 Expected<const Elf_Shdr *> TextSecOrErr = EF.getSection(Sec.sh_link);
788 if (!TextSecOrErr)
789 return createError("unable to get the linked-to section for " +
790 describe(EF, Sec) + ": " +
791 toString(TextSecOrErr.takeError()));
792 assert(*TextSecOrErr >= Sections.begin() &&
793 "Text section pointer outside of bounds");
794 if (*TextSectionIndex !=
795 (unsigned)std::distance(Sections.begin(), *TextSecOrErr))
796 return false;
797 return true;
798 };
799
800 Expected<MapVector<const Elf_Shdr *, const Elf_Shdr *>> SectionRelocMapOrErr =
801 EF.getSectionAndRelocations(IsMatch);
802 if (!SectionRelocMapOrErr)
803 return SectionRelocMapOrErr.takeError();
804
805 for (auto const &[Sec, RelocSec] : *SectionRelocMapOrErr) {
806 if (IsRelocatable && !RelocSec)
807 return createError("unable to get relocation section for " +
808 describe(EF, *Sec));
809 Expected<std::vector<BBAddrMap>> BBAddrMapOrErr =
810 EF.decodeBBAddrMap(*Sec, RelocSec, PGOAnalyses);
811 if (!BBAddrMapOrErr) {
812 if (PGOAnalyses)
813 PGOAnalyses->clear();
814 return createError(Err: "unable to read BB addr map section: " +
815 toString(E: BBAddrMapOrErr.takeError()));
816 }
817 std::move(first: BBAddrMapOrErr->begin(), last: BBAddrMapOrErr->end(),
818 result: std::back_inserter(x&: BBAddrMaps));
819 }
820 if (PGOAnalyses)
821 assert(PGOAnalyses->size() == BBAddrMaps.size() &&
822 "The same number of BBAddrMaps and PGOAnalysisMaps should be "
823 "returned when PGO information is requested");
824 return BBAddrMaps;
825}
826
827template <class ELFT>
828static Expected<std::vector<VersionEntry>>
829readDynsymVersionsImpl(const ELFFile<ELFT> &EF,
830 ELFObjectFileBase::elf_symbol_iterator_range Symbols) {
831 using Elf_Shdr = typename ELFT::Shdr;
832 const Elf_Shdr *VerSec = nullptr;
833 const Elf_Shdr *VerNeedSec = nullptr;
834 const Elf_Shdr *VerDefSec = nullptr;
835 // The user should ensure sections() can't fail here.
836 for (const Elf_Shdr &Sec : cantFail(EF.sections())) {
837 if (Sec.sh_type == ELF::SHT_GNU_versym)
838 VerSec = &Sec;
839 else if (Sec.sh_type == ELF::SHT_GNU_verdef)
840 VerDefSec = &Sec;
841 else if (Sec.sh_type == ELF::SHT_GNU_verneed)
842 VerNeedSec = &Sec;
843 }
844 if (!VerSec)
845 return std::vector<VersionEntry>();
846
847 Expected<SmallVector<std::optional<VersionEntry>, 0>> MapOrErr =
848 EF.loadVersionMap(VerNeedSec, VerDefSec);
849 if (!MapOrErr)
850 return MapOrErr.takeError();
851
852 std::vector<VersionEntry> Ret;
853 size_t I = 0;
854 for (const ELFSymbolRef &Sym : Symbols) {
855 ++I;
856 Expected<const typename ELFT::Versym *> VerEntryOrErr =
857 EF.template getEntry<typename ELFT::Versym>(*VerSec, I);
858 if (!VerEntryOrErr)
859 return createError("unable to read an entry with index " + Twine(I) +
860 " from " + describe(EF, *VerSec) + ": " +
861 toString(VerEntryOrErr.takeError()));
862
863 Expected<uint32_t> FlagsOrErr = Sym.getFlags();
864 if (!FlagsOrErr)
865 return createError(Err: "unable to read flags for symbol with index " +
866 Twine(I) + ": " + toString(E: FlagsOrErr.takeError()));
867
868 bool IsDefault;
869 Expected<StringRef> VerOrErr = EF.getSymbolVersionByIndex(
870 (*VerEntryOrErr)->vs_index, IsDefault, *MapOrErr,
871 (*FlagsOrErr) & SymbolRef::SF_Undefined);
872 if (!VerOrErr)
873 return createError("unable to get a version for entry " + Twine(I) +
874 " of " + describe(EF, *VerSec) + ": " +
875 toString(E: VerOrErr.takeError()));
876
877 Ret.push_back(x: {.Name: (*VerOrErr).str(), .IsVerDef: IsDefault});
878 }
879
880 return Ret;
881}
882
883Expected<std::vector<VersionEntry>>
884ELFObjectFileBase::readDynsymVersions() const {
885 elf_symbol_iterator_range Symbols = getDynamicSymbolIterators();
886 if (const auto *Obj = dyn_cast<ELF32LEObjectFile>(Val: this))
887 return readDynsymVersionsImpl(EF: Obj->getELFFile(), Symbols);
888 if (const auto *Obj = dyn_cast<ELF32BEObjectFile>(Val: this))
889 return readDynsymVersionsImpl(EF: Obj->getELFFile(), Symbols);
890 if (const auto *Obj = dyn_cast<ELF64LEObjectFile>(Val: this))
891 return readDynsymVersionsImpl(EF: Obj->getELFFile(), Symbols);
892 return readDynsymVersionsImpl(EF: cast<ELF64BEObjectFile>(Val: this)->getELFFile(),
893 Symbols);
894}
895
896Expected<std::vector<BBAddrMap>> ELFObjectFileBase::readBBAddrMap(
897 std::optional<unsigned> TextSectionIndex,
898 std::vector<PGOAnalysisMap> *PGOAnalyses) const {
899 if (const auto *Obj = dyn_cast<ELF32LEObjectFile>(Val: this))
900 return readBBAddrMapImpl(EF: Obj->getELFFile(), TextSectionIndex, PGOAnalyses);
901 if (const auto *Obj = dyn_cast<ELF64LEObjectFile>(Val: this))
902 return readBBAddrMapImpl(EF: Obj->getELFFile(), TextSectionIndex, PGOAnalyses);
903 if (const auto *Obj = dyn_cast<ELF32BEObjectFile>(Val: this))
904 return readBBAddrMapImpl(EF: Obj->getELFFile(), TextSectionIndex, PGOAnalyses);
905 return readBBAddrMapImpl(EF: cast<ELF64BEObjectFile>(Val: this)->getELFFile(),
906 TextSectionIndex, PGOAnalyses);
907}
908
909StringRef ELFObjectFileBase::getCrelDecodeProblem(SectionRef Sec) const {
910 auto Data = Sec.getRawDataRefImpl();
911 if (const auto *Obj = dyn_cast<ELF32LEObjectFile>(Val: this))
912 return Obj->getCrelDecodeProblem(Sec: Data);
913 if (const auto *Obj = dyn_cast<ELF32BEObjectFile>(Val: this))
914 return Obj->getCrelDecodeProblem(Sec: Data);
915 if (const auto *Obj = dyn_cast<ELF64LEObjectFile>(Val: this))
916 return Obj->getCrelDecodeProblem(Sec: Data);
917 return cast<ELF64BEObjectFile>(Val: this)->getCrelDecodeProblem(Sec: Data);
918}
919