blob: a1bc4c853323102a3aa287aec4ba9fd2cacc05c2 [file] [log] [blame]
//===----- ELF_aarch32.cpp - JIT linker implementation for arm/thumb ------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// ELF/aarch32 jit-link implementation.
//
//===----------------------------------------------------------------------===//
#include "llvm/ExecutionEngine/JITLink/ELF_aarch32.h"
#include "llvm/BinaryFormat/ELF.h"
#include "llvm/ExecutionEngine/JITLink/JITLink.h"
#include "llvm/ExecutionEngine/JITLink/aarch32.h"
#include "llvm/Object/ELF.h"
#include "llvm/Object/ELFObjectFile.h"
#include "llvm/Support/Endian.h"
#include "llvm/Support/ErrorHandling.h"
#include "llvm/TargetParser/ARMTargetParser.h"
#include "ELFLinkGraphBuilder.h"
#include "JITLinkGeneric.h"
#define DEBUG_TYPE "jitlink"
using namespace llvm::object;
namespace llvm {
namespace jitlink {
/// Translate from ELF relocation type to JITLink-internal edge kind.
Expected<aarch32::EdgeKind_aarch32> getJITLinkEdgeKind(uint32_t ELFType) {
switch (ELFType) {
case ELF::R_ARM_ABS32:
return aarch32::Data_Pointer32;
case ELF::R_ARM_REL32:
return aarch32::Data_Delta32;
case ELF::R_ARM_CALL:
return aarch32::Arm_Call;
case ELF::R_ARM_THM_CALL:
return aarch32::Thumb_Call;
case ELF::R_ARM_THM_JUMP24:
return aarch32::Thumb_Jump24;
case ELF::R_ARM_THM_MOVW_ABS_NC:
return aarch32::Thumb_MovwAbsNC;
case ELF::R_ARM_THM_MOVT_ABS:
return aarch32::Thumb_MovtAbs;
}
return make_error<JITLinkError>(
"Unsupported aarch32 relocation " + formatv("{0:d}: ", ELFType) +
object::getELFRelocationTypeName(ELF::EM_ARM, ELFType));
}
/// Translate from JITLink-internal edge kind back to ELF relocation type.
Expected<uint32_t> getELFRelocationType(Edge::Kind Kind) {
switch (static_cast<aarch32::EdgeKind_aarch32>(Kind)) {
case aarch32::Data_Delta32:
return ELF::R_ARM_REL32;
case aarch32::Data_Pointer32:
return ELF::R_ARM_ABS32;
case aarch32::Arm_Call:
return ELF::R_ARM_CALL;
case aarch32::Thumb_Call:
return ELF::R_ARM_THM_CALL;
case aarch32::Thumb_Jump24:
return ELF::R_ARM_THM_JUMP24;
case aarch32::Thumb_MovwAbsNC:
return ELF::R_ARM_THM_MOVW_ABS_NC;
case aarch32::Thumb_MovtAbs:
return ELF::R_ARM_THM_MOVT_ABS;
}
return make_error<JITLinkError>(formatv("Invalid aarch32 edge {0:d}: ",
Kind));
}
/// Get a human-readable name for the given ELF AArch32 edge kind.
const char *getELFAArch32EdgeKindName(Edge::Kind R) {
// No ELF-specific edge kinds yet
return aarch32::getEdgeKindName(R);
}
class ELFJITLinker_aarch32 : public JITLinker<ELFJITLinker_aarch32> {
friend class JITLinker<ELFJITLinker_aarch32>;
public:
ELFJITLinker_aarch32(std::unique_ptr<JITLinkContext> Ctx,
std::unique_ptr<LinkGraph> G, PassConfiguration PassCfg,
aarch32::ArmConfig ArmCfg)
: JITLinker(std::move(Ctx), std::move(G), std::move(PassCfg)),
ArmCfg(std::move(ArmCfg)) {}
private:
aarch32::ArmConfig ArmCfg;
Error applyFixup(LinkGraph &G, Block &B, const Edge &E) const {
return aarch32::applyFixup(G, B, E, ArmCfg);
}
};
template <support::endianness DataEndianness>
class ELFLinkGraphBuilder_aarch32
: public ELFLinkGraphBuilder<ELFType<DataEndianness, false>> {
private:
using ELFT = ELFType<DataEndianness, false>;
using Base = ELFLinkGraphBuilder<ELFT>;
bool excludeSection(const typename ELFT::Shdr &Sect) const override {
// TODO: An .ARM.exidx (Exception Index table) entry is 8-bytes in size and
// consists of 2 words. It might be sufficient to process only relocations
// in the the second word (offset 4). Please find more details in: Exception
// Handling ABI for the ArmĀ® Architecture -> Index table entries
if (Sect.sh_type == ELF::SHT_ARM_EXIDX)
return true;
return false;
}
Error addRelocations() override {
LLVM_DEBUG(dbgs() << "Processing relocations:\n");
using Self = ELFLinkGraphBuilder_aarch32<DataEndianness>;
for (const auto &RelSect : Base::Sections) {
if (Error Err = Base::forEachRelRelocation(RelSect, this,
&Self::addSingleRelRelocation))
return Err;
}
return Error::success();
}
Error addSingleRelRelocation(const typename ELFT::Rel &Rel,
const typename ELFT::Shdr &FixupSect,
Block &BlockToFix) {
uint32_t SymbolIndex = Rel.getSymbol(false);
auto ObjSymbol = Base::Obj.getRelocationSymbol(Rel, Base::SymTabSec);
if (!ObjSymbol)
return ObjSymbol.takeError();
Symbol *GraphSymbol = Base::getGraphSymbol(SymbolIndex);
if (!GraphSymbol)
return make_error<StringError>(
formatv("Could not find symbol at given index, did you add it to "
"JITSymbolTable? index: {0}, shndx: {1} Size of table: {2}",
SymbolIndex, (*ObjSymbol)->st_shndx,
Base::GraphSymbols.size()),
inconvertibleErrorCode());
uint32_t Type = Rel.getType(false);
Expected<aarch32::EdgeKind_aarch32> Kind = getJITLinkEdgeKind(Type);
if (!Kind)
return Kind.takeError();
auto FixupAddress = orc::ExecutorAddr(FixupSect.sh_addr) + Rel.r_offset;
Edge::OffsetT Offset = FixupAddress - BlockToFix.getAddress();
Edge E(*Kind, Offset, *GraphSymbol, 0);
Expected<int64_t> Addend =
aarch32::readAddend(*Base::G, BlockToFix, E, ArmCfg);
if (!Addend)
return Addend.takeError();
E.setAddend(*Addend);
LLVM_DEBUG({
dbgs() << " ";
printEdge(dbgs(), BlockToFix, E, getELFAArch32EdgeKindName(*Kind));
dbgs() << "\n";
});
BlockToFix.addEdge(std::move(E));
return Error::success();
}
aarch32::ArmConfig ArmCfg;
protected:
TargetFlagsType makeTargetFlags(const typename ELFT::Sym &Sym) override {
if (Sym.getValue() & 0x01)
return aarch32::ThumbSymbol;
return TargetFlagsType{};
}
orc::ExecutorAddrDiff getRawOffset(const typename ELFT::Sym &Sym,
TargetFlagsType Flags) override {
assert((makeTargetFlags(Sym) & Flags) == Flags);
static constexpr uint64_t ThumbBit = 0x01;
return Sym.getValue() & ~ThumbBit;
}
public:
ELFLinkGraphBuilder_aarch32(StringRef FileName,
const llvm::object::ELFFile<ELFT> &Obj, Triple TT,
SubtargetFeatures Features,
aarch32::ArmConfig ArmCfg)
: ELFLinkGraphBuilder<ELFT>(Obj, std::move(TT), std::move(Features),
FileName, getELFAArch32EdgeKindName),
ArmCfg(std::move(ArmCfg)) {}
};
template <aarch32::StubsFlavor Flavor>
Error buildTables_ELF_aarch32(LinkGraph &G) {
LLVM_DEBUG(dbgs() << "Visiting edges in graph:\n");
aarch32::StubsManager<Flavor> PLT;
visitExistingEdges(G, PLT);
return Error::success();
}
Expected<std::unique_ptr<LinkGraph>>
createLinkGraphFromELFObject_aarch32(MemoryBufferRef ObjectBuffer) {
LLVM_DEBUG({
dbgs() << "Building jitlink graph for new input "
<< ObjectBuffer.getBufferIdentifier() << "...\n";
});
auto ELFObj = ObjectFile::createELFObjectFile(ObjectBuffer);
if (!ELFObj)
return ELFObj.takeError();
auto Features = (*ELFObj)->getFeatures();
if (!Features)
return Features.takeError();
// Find out what exact AArch32 instruction set and features we target.
auto TT = (*ELFObj)->makeTriple();
ARM::ArchKind AK = ARM::parseArch(TT.getArchName());
if (AK == ARM::ArchKind::INVALID)
return make_error<JITLinkError>(
"Failed to build ELF link graph: Invalid ARM ArchKind");
// Resolve our internal configuration for the target. If at some point the
// CPUArch alone becomes too unprecise, we can find more details in the
// Tag_CPU_arch_profile.
aarch32::ArmConfig ArmCfg;
using namespace ARMBuildAttrs;
auto Arch = static_cast<CPUArch>(ARM::getArchAttr(AK));
switch (Arch) {
case v7:
case v8_A:
ArmCfg = aarch32::getArmConfigForCPUArch(Arch);
assert(ArmCfg.Stubs != aarch32::Unsupported &&
"Provide a config for each supported CPU");
break;
default:
return make_error<JITLinkError>(
"Failed to build ELF link graph: Unsupported CPU arch " +
StringRef(aarch32::getCPUArchName(Arch)));
}
// Populate the link-graph.
switch (TT.getArch()) {
case Triple::arm:
case Triple::thumb: {
auto &ELFFile = cast<ELFObjectFile<ELF32LE>>(**ELFObj).getELFFile();
return ELFLinkGraphBuilder_aarch32<support::little>(
(*ELFObj)->getFileName(), ELFFile, TT, std::move(*Features),
ArmCfg)
.buildGraph();
}
case Triple::armeb:
case Triple::thumbeb: {
auto &ELFFile = cast<ELFObjectFile<ELF32BE>>(**ELFObj).getELFFile();
return ELFLinkGraphBuilder_aarch32<support::big>(
(*ELFObj)->getFileName(), ELFFile, TT, std::move(*Features),
ArmCfg)
.buildGraph();
}
default:
return make_error<JITLinkError>(
"Failed to build ELF/aarch32 link graph: Invalid target triple " +
TT.getTriple());
}
}
void link_ELF_aarch32(std::unique_ptr<LinkGraph> G,
std::unique_ptr<JITLinkContext> Ctx) {
const Triple &TT = G->getTargetTriple();
using namespace ARMBuildAttrs;
ARM::ArchKind AK = ARM::parseArch(TT.getArchName());
auto CPU = static_cast<CPUArch>(ARM::getArchAttr(AK));
aarch32::ArmConfig ArmCfg = aarch32::getArmConfigForCPUArch(CPU);
PassConfiguration PassCfg;
if (Ctx->shouldAddDefaultTargetPasses(TT)) {
// Add a mark-live pass.
if (auto MarkLive = Ctx->getMarkLivePass(TT))
PassCfg.PrePrunePasses.push_back(std::move(MarkLive));
else
PassCfg.PrePrunePasses.push_back(markAllSymbolsLive);
switch (ArmCfg.Stubs) {
case aarch32::Thumbv7:
PassCfg.PostPrunePasses.push_back(
buildTables_ELF_aarch32<aarch32::Thumbv7>);
break;
case aarch32::Unsupported:
llvm_unreachable("Check before building graph");
}
}
if (auto Err = Ctx->modifyPassConfig(*G, PassCfg))
return Ctx->notifyFailed(std::move(Err));
ELFJITLinker_aarch32::link(std::move(Ctx), std::move(G), std::move(PassCfg),
std::move(ArmCfg));
}
} // namespace jitlink
} // namespace llvm