mirror of
https://github.com/Gericom/teak-llvm.git
synced 2025-06-20 03:55:48 -04:00
2946cd7010
to reflect the new license. We understand that people may be surprised that we're moving the header entirely to discuss the new license. We checked this carefully with the Foundation's lawyer and we believe this is the correct approach. Essentially, all code in the project is now made available by the LLVM project under our new license, so you will see that the license headers include that license only. Some of our contributors have contributed code under our old license, and accordingly, we have retained a copy of our old license notice in the top-level files in each project and repository. llvm-svn: 351636
372 lines
12 KiB
C++
372 lines
12 KiB
C++
//===---- IndirectionUtils.cpp - Utilities for call indirection in Orc ----===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/ExecutionEngine/Orc/IndirectionUtils.h"
|
|
#include "llvm/ADT/STLExtras.h"
|
|
#include "llvm/ADT/Triple.h"
|
|
#include "llvm/ExecutionEngine/Orc/OrcABISupport.h"
|
|
#include "llvm/IR/CallSite.h"
|
|
#include "llvm/IR/IRBuilder.h"
|
|
#include "llvm/Support/Format.h"
|
|
#include "llvm/Transforms/Utils/Cloning.h"
|
|
#include <sstream>
|
|
|
|
using namespace llvm;
|
|
using namespace llvm::orc;
|
|
|
|
namespace {
|
|
|
|
class CompileCallbackMaterializationUnit : public orc::MaterializationUnit {
|
|
public:
|
|
using CompileFunction = JITCompileCallbackManager::CompileFunction;
|
|
|
|
CompileCallbackMaterializationUnit(SymbolStringPtr Name,
|
|
CompileFunction Compile, VModuleKey K)
|
|
: MaterializationUnit(SymbolFlagsMap({{Name, JITSymbolFlags::Exported}}),
|
|
std::move(K)),
|
|
Name(std::move(Name)), Compile(std::move(Compile)) {}
|
|
|
|
StringRef getName() const override { return "<Compile Callbacks>"; }
|
|
|
|
private:
|
|
void materialize(MaterializationResponsibility R) override {
|
|
SymbolMap Result;
|
|
Result[Name] = JITEvaluatedSymbol(Compile(), JITSymbolFlags::Exported);
|
|
R.resolve(Result);
|
|
R.emit();
|
|
}
|
|
|
|
void discard(const JITDylib &JD, const SymbolStringPtr &Name) override {
|
|
llvm_unreachable("Discard should never occur on a LMU?");
|
|
}
|
|
|
|
SymbolStringPtr Name;
|
|
CompileFunction Compile;
|
|
};
|
|
|
|
} // namespace
|
|
|
|
namespace llvm {
|
|
namespace orc {
|
|
|
|
void IndirectStubsManager::anchor() {}
|
|
void TrampolinePool::anchor() {}
|
|
|
|
Expected<JITTargetAddress>
|
|
JITCompileCallbackManager::getCompileCallback(CompileFunction Compile) {
|
|
if (auto TrampolineAddr = TP->getTrampoline()) {
|
|
auto CallbackName =
|
|
ES.intern(std::string("cc") + std::to_string(++NextCallbackId));
|
|
|
|
std::lock_guard<std::mutex> Lock(CCMgrMutex);
|
|
AddrToSymbol[*TrampolineAddr] = CallbackName;
|
|
cantFail(CallbacksJD.define(
|
|
llvm::make_unique<CompileCallbackMaterializationUnit>(
|
|
std::move(CallbackName), std::move(Compile),
|
|
ES.allocateVModule())));
|
|
return *TrampolineAddr;
|
|
} else
|
|
return TrampolineAddr.takeError();
|
|
}
|
|
|
|
JITTargetAddress JITCompileCallbackManager::executeCompileCallback(
|
|
JITTargetAddress TrampolineAddr) {
|
|
SymbolStringPtr Name;
|
|
|
|
{
|
|
std::unique_lock<std::mutex> Lock(CCMgrMutex);
|
|
auto I = AddrToSymbol.find(TrampolineAddr);
|
|
|
|
// If this address is not associated with a compile callback then report an
|
|
// error to the execution session and return ErrorHandlerAddress to the
|
|
// callee.
|
|
if (I == AddrToSymbol.end()) {
|
|
Lock.unlock();
|
|
std::string ErrMsg;
|
|
{
|
|
raw_string_ostream ErrMsgStream(ErrMsg);
|
|
ErrMsgStream << "No compile callback for trampoline at "
|
|
<< format("0x%016" PRIx64, TrampolineAddr);
|
|
}
|
|
ES.reportError(
|
|
make_error<StringError>(std::move(ErrMsg), inconvertibleErrorCode()));
|
|
return ErrorHandlerAddress;
|
|
} else
|
|
Name = I->second;
|
|
}
|
|
|
|
if (auto Sym = ES.lookup(JITDylibSearchList({{&CallbacksJD, true}}), Name))
|
|
return Sym->getAddress();
|
|
else {
|
|
llvm::dbgs() << "Didn't find callback.\n";
|
|
// If anything goes wrong materializing Sym then report it to the session
|
|
// and return the ErrorHandlerAddress;
|
|
ES.reportError(Sym.takeError());
|
|
return ErrorHandlerAddress;
|
|
}
|
|
}
|
|
|
|
Expected<std::unique_ptr<JITCompileCallbackManager>>
|
|
createLocalCompileCallbackManager(const Triple &T, ExecutionSession &ES,
|
|
JITTargetAddress ErrorHandlerAddress) {
|
|
switch (T.getArch()) {
|
|
default:
|
|
return make_error<StringError>(
|
|
std::string("No callback manager available for ") + T.str(),
|
|
inconvertibleErrorCode());
|
|
case Triple::aarch64: {
|
|
typedef orc::LocalJITCompileCallbackManager<orc::OrcAArch64> CCMgrT;
|
|
return CCMgrT::Create(ES, ErrorHandlerAddress);
|
|
}
|
|
|
|
case Triple::x86: {
|
|
typedef orc::LocalJITCompileCallbackManager<orc::OrcI386> CCMgrT;
|
|
return CCMgrT::Create(ES, ErrorHandlerAddress);
|
|
}
|
|
|
|
case Triple::mips: {
|
|
typedef orc::LocalJITCompileCallbackManager<orc::OrcMips32Be> CCMgrT;
|
|
return CCMgrT::Create(ES, ErrorHandlerAddress);
|
|
}
|
|
case Triple::mipsel: {
|
|
typedef orc::LocalJITCompileCallbackManager<orc::OrcMips32Le> CCMgrT;
|
|
return CCMgrT::Create(ES, ErrorHandlerAddress);
|
|
}
|
|
|
|
case Triple::mips64:
|
|
case Triple::mips64el: {
|
|
typedef orc::LocalJITCompileCallbackManager<orc::OrcMips64> CCMgrT;
|
|
return CCMgrT::Create(ES, ErrorHandlerAddress);
|
|
}
|
|
|
|
case Triple::x86_64: {
|
|
if ( T.getOS() == Triple::OSType::Win32 ) {
|
|
typedef orc::LocalJITCompileCallbackManager<orc::OrcX86_64_Win32> CCMgrT;
|
|
return CCMgrT::Create(ES, ErrorHandlerAddress);
|
|
} else {
|
|
typedef orc::LocalJITCompileCallbackManager<orc::OrcX86_64_SysV> CCMgrT;
|
|
return CCMgrT::Create(ES, ErrorHandlerAddress);
|
|
}
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
std::function<std::unique_ptr<IndirectStubsManager>()>
|
|
createLocalIndirectStubsManagerBuilder(const Triple &T) {
|
|
switch (T.getArch()) {
|
|
default:
|
|
return [](){
|
|
return llvm::make_unique<
|
|
orc::LocalIndirectStubsManager<orc::OrcGenericABI>>();
|
|
};
|
|
|
|
case Triple::aarch64:
|
|
return [](){
|
|
return llvm::make_unique<
|
|
orc::LocalIndirectStubsManager<orc::OrcAArch64>>();
|
|
};
|
|
|
|
case Triple::x86:
|
|
return [](){
|
|
return llvm::make_unique<
|
|
orc::LocalIndirectStubsManager<orc::OrcI386>>();
|
|
};
|
|
|
|
case Triple::mips:
|
|
return [](){
|
|
return llvm::make_unique<
|
|
orc::LocalIndirectStubsManager<orc::OrcMips32Be>>();
|
|
};
|
|
|
|
case Triple::mipsel:
|
|
return [](){
|
|
return llvm::make_unique<
|
|
orc::LocalIndirectStubsManager<orc::OrcMips32Le>>();
|
|
};
|
|
|
|
case Triple::mips64:
|
|
case Triple::mips64el:
|
|
return [](){
|
|
return llvm::make_unique<
|
|
orc::LocalIndirectStubsManager<orc::OrcMips64>>();
|
|
};
|
|
|
|
case Triple::x86_64:
|
|
if (T.getOS() == Triple::OSType::Win32) {
|
|
return [](){
|
|
return llvm::make_unique<
|
|
orc::LocalIndirectStubsManager<orc::OrcX86_64_Win32>>();
|
|
};
|
|
} else {
|
|
return [](){
|
|
return llvm::make_unique<
|
|
orc::LocalIndirectStubsManager<orc::OrcX86_64_SysV>>();
|
|
};
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
Constant* createIRTypedAddress(FunctionType &FT, JITTargetAddress Addr) {
|
|
Constant *AddrIntVal =
|
|
ConstantInt::get(Type::getInt64Ty(FT.getContext()), Addr);
|
|
Constant *AddrPtrVal =
|
|
ConstantExpr::getCast(Instruction::IntToPtr, AddrIntVal,
|
|
PointerType::get(&FT, 0));
|
|
return AddrPtrVal;
|
|
}
|
|
|
|
GlobalVariable* createImplPointer(PointerType &PT, Module &M,
|
|
const Twine &Name, Constant *Initializer) {
|
|
auto IP = new GlobalVariable(M, &PT, false, GlobalValue::ExternalLinkage,
|
|
Initializer, Name, nullptr,
|
|
GlobalValue::NotThreadLocal, 0, true);
|
|
IP->setVisibility(GlobalValue::HiddenVisibility);
|
|
return IP;
|
|
}
|
|
|
|
void makeStub(Function &F, Value &ImplPointer) {
|
|
assert(F.isDeclaration() && "Can't turn a definition into a stub.");
|
|
assert(F.getParent() && "Function isn't in a module.");
|
|
Module &M = *F.getParent();
|
|
BasicBlock *EntryBlock = BasicBlock::Create(M.getContext(), "entry", &F);
|
|
IRBuilder<> Builder(EntryBlock);
|
|
LoadInst *ImplAddr = Builder.CreateLoad(&ImplPointer);
|
|
std::vector<Value*> CallArgs;
|
|
for (auto &A : F.args())
|
|
CallArgs.push_back(&A);
|
|
CallInst *Call = Builder.CreateCall(ImplAddr, CallArgs);
|
|
Call->setTailCall();
|
|
Call->setAttributes(F.getAttributes());
|
|
if (F.getReturnType()->isVoidTy())
|
|
Builder.CreateRetVoid();
|
|
else
|
|
Builder.CreateRet(Call);
|
|
}
|
|
|
|
std::vector<GlobalValue *> SymbolLinkagePromoter::operator()(Module &M) {
|
|
std::vector<GlobalValue *> PromotedGlobals;
|
|
|
|
for (auto &GV : M.global_values()) {
|
|
bool Promoted = true;
|
|
|
|
// Rename if necessary.
|
|
if (!GV.hasName())
|
|
GV.setName("__orc_anon." + Twine(NextId++));
|
|
else if (GV.getName().startswith("\01L"))
|
|
GV.setName("__" + GV.getName().substr(1) + "." + Twine(NextId++));
|
|
else if (GV.hasLocalLinkage())
|
|
GV.setName("__orc_lcl." + GV.getName() + "." + Twine(NextId++));
|
|
else
|
|
Promoted = false;
|
|
|
|
if (GV.hasLocalLinkage()) {
|
|
GV.setLinkage(GlobalValue::ExternalLinkage);
|
|
GV.setVisibility(GlobalValue::HiddenVisibility);
|
|
Promoted = true;
|
|
}
|
|
GV.setUnnamedAddr(GlobalValue::UnnamedAddr::None);
|
|
|
|
if (Promoted)
|
|
PromotedGlobals.push_back(&GV);
|
|
}
|
|
|
|
return PromotedGlobals;
|
|
}
|
|
|
|
Function* cloneFunctionDecl(Module &Dst, const Function &F,
|
|
ValueToValueMapTy *VMap) {
|
|
Function *NewF =
|
|
Function::Create(cast<FunctionType>(F.getValueType()),
|
|
F.getLinkage(), F.getName(), &Dst);
|
|
NewF->copyAttributesFrom(&F);
|
|
|
|
if (VMap) {
|
|
(*VMap)[&F] = NewF;
|
|
auto NewArgI = NewF->arg_begin();
|
|
for (auto ArgI = F.arg_begin(), ArgE = F.arg_end(); ArgI != ArgE;
|
|
++ArgI, ++NewArgI)
|
|
(*VMap)[&*ArgI] = &*NewArgI;
|
|
}
|
|
|
|
return NewF;
|
|
}
|
|
|
|
void moveFunctionBody(Function &OrigF, ValueToValueMapTy &VMap,
|
|
ValueMaterializer *Materializer,
|
|
Function *NewF) {
|
|
assert(!OrigF.isDeclaration() && "Nothing to move");
|
|
if (!NewF)
|
|
NewF = cast<Function>(VMap[&OrigF]);
|
|
else
|
|
assert(VMap[&OrigF] == NewF && "Incorrect function mapping in VMap.");
|
|
assert(NewF && "Function mapping missing from VMap.");
|
|
assert(NewF->getParent() != OrigF.getParent() &&
|
|
"moveFunctionBody should only be used to move bodies between "
|
|
"modules.");
|
|
|
|
SmallVector<ReturnInst *, 8> Returns; // Ignore returns cloned.
|
|
CloneFunctionInto(NewF, &OrigF, VMap, /*ModuleLevelChanges=*/true, Returns,
|
|
"", nullptr, nullptr, Materializer);
|
|
OrigF.deleteBody();
|
|
}
|
|
|
|
GlobalVariable* cloneGlobalVariableDecl(Module &Dst, const GlobalVariable &GV,
|
|
ValueToValueMapTy *VMap) {
|
|
GlobalVariable *NewGV = new GlobalVariable(
|
|
Dst, GV.getValueType(), GV.isConstant(),
|
|
GV.getLinkage(), nullptr, GV.getName(), nullptr,
|
|
GV.getThreadLocalMode(), GV.getType()->getAddressSpace());
|
|
NewGV->copyAttributesFrom(&GV);
|
|
if (VMap)
|
|
(*VMap)[&GV] = NewGV;
|
|
return NewGV;
|
|
}
|
|
|
|
void moveGlobalVariableInitializer(GlobalVariable &OrigGV,
|
|
ValueToValueMapTy &VMap,
|
|
ValueMaterializer *Materializer,
|
|
GlobalVariable *NewGV) {
|
|
assert(OrigGV.hasInitializer() && "Nothing to move");
|
|
if (!NewGV)
|
|
NewGV = cast<GlobalVariable>(VMap[&OrigGV]);
|
|
else
|
|
assert(VMap[&OrigGV] == NewGV &&
|
|
"Incorrect global variable mapping in VMap.");
|
|
assert(NewGV->getParent() != OrigGV.getParent() &&
|
|
"moveGlobalVariableInitializer should only be used to move "
|
|
"initializers between modules");
|
|
|
|
NewGV->setInitializer(MapValue(OrigGV.getInitializer(), VMap, RF_None,
|
|
nullptr, Materializer));
|
|
}
|
|
|
|
GlobalAlias* cloneGlobalAliasDecl(Module &Dst, const GlobalAlias &OrigA,
|
|
ValueToValueMapTy &VMap) {
|
|
assert(OrigA.getAliasee() && "Original alias doesn't have an aliasee?");
|
|
auto *NewA = GlobalAlias::create(OrigA.getValueType(),
|
|
OrigA.getType()->getPointerAddressSpace(),
|
|
OrigA.getLinkage(), OrigA.getName(), &Dst);
|
|
NewA->copyAttributesFrom(&OrigA);
|
|
VMap[&OrigA] = NewA;
|
|
return NewA;
|
|
}
|
|
|
|
void cloneModuleFlagsMetadata(Module &Dst, const Module &Src,
|
|
ValueToValueMapTy &VMap) {
|
|
auto *MFs = Src.getModuleFlagsMetadata();
|
|
if (!MFs)
|
|
return;
|
|
for (auto *MF : MFs->operands())
|
|
Dst.addModuleFlag(MapMetadata(MF, VMap));
|
|
}
|
|
|
|
} // End namespace orc.
|
|
} // End namespace llvm.
|