1//===---- IndirectionUtils.cpp - Utilities for call indirection in Orc ----===//
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#include "llvm/ExecutionEngine/Orc/IndirectionUtils.h"
10#include "llvm/ExecutionEngine/JITLink/x86_64.h"
11#include "llvm/ExecutionEngine/Orc/OrcABISupport.h"
12#include "llvm/IR/IRBuilder.h"
13#include "llvm/IR/Module.h"
14#include "llvm/MC/MCDisassembler/MCDisassembler.h"
15#include "llvm/MC/MCInstrAnalysis.h"
16#include "llvm/TargetParser/Triple.h"
17#include "llvm/Transforms/Utils/Cloning.h"
18
19#define DEBUG_TYPE "orc"
20
21using namespace llvm;
22using namespace llvm::orc;
23
24namespace {
25
26class CompileCallbackMaterializationUnit : public orc::MaterializationUnit {
27public:
28 using CompileFunction = JITCompileCallbackManager::CompileFunction;
29
30 CompileCallbackMaterializationUnit(SymbolStringPtr Name,
31 CompileFunction Compile)
32 : MaterializationUnit(Interface(
33 SymbolFlagsMap({{Name, JITSymbolFlags::Exported}}), nullptr)),
34 Name(std::move(Name)), Compile(std::move(Compile)) {}
35
36 StringRef getName() const override { return "<Compile Callbacks>"; }
37
38private:
39 void materialize(std::unique_ptr<MaterializationResponsibility> R) override {
40 SymbolMap Result;
41 Result[Name] = {Compile(), JITSymbolFlags::Exported};
42 // No dependencies, so these calls cannot fail.
43 cantFail(Err: R->notifyResolved(Symbols: Result));
44 cantFail(Err: R->notifyEmitted(EmittedDeps: {}));
45 }
46
47 void discard(const JITDylib &JD, const SymbolStringPtr &Name) override {
48 llvm_unreachable("Discard should never occur on a LMU?");
49 }
50
51 SymbolStringPtr Name;
52 CompileFunction Compile;
53};
54
55} // namespace
56
57namespace llvm {
58namespace orc {
59
60TrampolinePool::~TrampolinePool() = default;
61void IndirectStubsManager::anchor() {}
62
63Expected<ExecutorAddr>
64JITCompileCallbackManager::getCompileCallback(CompileFunction Compile) {
65 if (auto TrampolineAddr = TP->getTrampoline()) {
66 auto CallbackName =
67 ES.intern(SymName: std::string("cc") + std::to_string(val: ++NextCallbackId));
68
69 std::lock_guard<std::mutex> Lock(CCMgrMutex);
70 AddrToSymbol[*TrampolineAddr] = CallbackName;
71 cantFail(
72 Err: CallbacksJD.define(MU: std::make_unique<CompileCallbackMaterializationUnit>(
73 args: std::move(CallbackName), args: std::move(Compile))));
74 return *TrampolineAddr;
75 } else
76 return TrampolineAddr.takeError();
77}
78
79ExecutorAddr
80JITCompileCallbackManager::executeCompileCallback(ExecutorAddr TrampolineAddr) {
81 SymbolStringPtr Name;
82
83 {
84 std::unique_lock<std::mutex> Lock(CCMgrMutex);
85 auto I = AddrToSymbol.find(x: TrampolineAddr);
86
87 // If this address is not associated with a compile callback then report an
88 // error to the execution session and return ErrorHandlerAddress to the
89 // callee.
90 if (I == AddrToSymbol.end()) {
91 Lock.unlock();
92 ES.reportError(
93 Err: make_error<StringError>(Args: "No compile callback for trampoline at " +
94 formatv(Fmt: "{0:x}", Vals&: TrampolineAddr),
95 Args: inconvertibleErrorCode()));
96 return ErrorHandlerAddress;
97 } else
98 Name = I->second;
99 }
100
101 if (auto Sym =
102 ES.lookup(SearchOrder: makeJITDylibSearchOrder(
103 JDs: &CallbacksJD, Flags: JITDylibLookupFlags::MatchAllSymbols),
104 Symbol: Name))
105 return Sym->getAddress();
106 else {
107 llvm::dbgs() << "Didn't find callback.\n";
108 // If anything goes wrong materializing Sym then report it to the session
109 // and return the ErrorHandlerAddress;
110 ES.reportError(Err: Sym.takeError());
111 return ErrorHandlerAddress;
112 }
113}
114
115Error IndirectStubsManager::redirect(JITDylib &JD, const SymbolMap &NewDests) {
116 for (auto &[Name, Dest] : NewDests)
117 if (auto Err = updatePointer(Name: *Name, NewAddr: Dest.getAddress()))
118 return Err;
119 return Error::success();
120}
121
122void IndirectStubsManager::emitRedirectableSymbols(
123 std::unique_ptr<MaterializationResponsibility> MR, SymbolMap InitialDests) {
124 StubInitsMap StubInits;
125 for (auto &[Name, Dest] : InitialDests)
126 StubInits[*Name] = {Dest.getAddress(), Dest.getFlags()};
127 if (auto Err = createStubs(StubInits)) {
128 MR->getExecutionSession().reportError(Err: std::move(Err));
129 return MR->failMaterialization();
130 }
131 SymbolMap Stubs;
132 for (auto &[Name, Dest] : InitialDests) {
133 auto StubSym = findStub(Name: *Name, ExportedStubsOnly: false);
134 assert(StubSym.getAddress() && "Stub symbol should be present");
135 Stubs[Name] = StubSym;
136 }
137 if (auto Err = MR->notifyResolved(Symbols: Stubs)) {
138 MR->getExecutionSession().reportError(Err: std::move(Err));
139 return MR->failMaterialization();
140 }
141 if (auto Err = MR->notifyEmitted(EmittedDeps: {})) {
142 MR->getExecutionSession().reportError(Err: std::move(Err));
143 return MR->failMaterialization();
144 }
145}
146
147Expected<std::unique_ptr<JITCompileCallbackManager>>
148createLocalCompileCallbackManager(const Triple &T, ExecutionSession &ES,
149 ExecutorAddr ErrorHandlerAddress) {
150 switch (T.getArch()) {
151 default:
152 return make_error<StringError>(
153 Args: std::string("No callback manager available for ") + T.str(),
154 Args: inconvertibleErrorCode());
155 case Triple::aarch64:
156 case Triple::aarch64_32: {
157 typedef orc::LocalJITCompileCallbackManager<orc::OrcAArch64> CCMgrT;
158 return CCMgrT::Create(ES, ErrorHandlerAddress);
159 }
160
161 case Triple::x86: {
162 typedef orc::LocalJITCompileCallbackManager<orc::OrcI386> CCMgrT;
163 return CCMgrT::Create(ES, ErrorHandlerAddress);
164 }
165
166 case Triple::loongarch64: {
167 typedef orc::LocalJITCompileCallbackManager<orc::OrcLoongArch64> CCMgrT;
168 return CCMgrT::Create(ES, ErrorHandlerAddress);
169 }
170
171 case Triple::mips: {
172 typedef orc::LocalJITCompileCallbackManager<orc::OrcMips32Be> CCMgrT;
173 return CCMgrT::Create(ES, ErrorHandlerAddress);
174 }
175 case Triple::mipsel: {
176 typedef orc::LocalJITCompileCallbackManager<orc::OrcMips32Le> CCMgrT;
177 return CCMgrT::Create(ES, ErrorHandlerAddress);
178 }
179
180 case Triple::mips64:
181 case Triple::mips64el: {
182 typedef orc::LocalJITCompileCallbackManager<orc::OrcMips64> CCMgrT;
183 return CCMgrT::Create(ES, ErrorHandlerAddress);
184 }
185
186 case Triple::riscv64: {
187 typedef orc::LocalJITCompileCallbackManager<orc::OrcRiscv64> CCMgrT;
188 return CCMgrT::Create(ES, ErrorHandlerAddress);
189 }
190
191 case Triple::x86_64: {
192 if (T.getOS() == Triple::OSType::Win32) {
193 typedef orc::LocalJITCompileCallbackManager<orc::OrcX86_64_Win32> CCMgrT;
194 return CCMgrT::Create(ES, ErrorHandlerAddress);
195 } else {
196 typedef orc::LocalJITCompileCallbackManager<orc::OrcX86_64_SysV> CCMgrT;
197 return CCMgrT::Create(ES, ErrorHandlerAddress);
198 }
199 }
200
201 }
202}
203
204std::function<std::unique_ptr<IndirectStubsManager>()>
205createLocalIndirectStubsManagerBuilder(const Triple &T) {
206 switch (T.getArch()) {
207 default:
208 return [](){
209 return std::make_unique<
210 orc::LocalIndirectStubsManager<orc::OrcGenericABI>>();
211 };
212
213 case Triple::aarch64:
214 case Triple::aarch64_32:
215 return [](){
216 return std::make_unique<
217 orc::LocalIndirectStubsManager<orc::OrcAArch64>>();
218 };
219
220 case Triple::x86:
221 return [](){
222 return std::make_unique<
223 orc::LocalIndirectStubsManager<orc::OrcI386>>();
224 };
225
226 case Triple::loongarch64:
227 return []() {
228 return std::make_unique<
229 orc::LocalIndirectStubsManager<orc::OrcLoongArch64>>();
230 };
231
232 case Triple::mips:
233 return [](){
234 return std::make_unique<
235 orc::LocalIndirectStubsManager<orc::OrcMips32Be>>();
236 };
237
238 case Triple::mipsel:
239 return [](){
240 return std::make_unique<
241 orc::LocalIndirectStubsManager<orc::OrcMips32Le>>();
242 };
243
244 case Triple::mips64:
245 case Triple::mips64el:
246 return [](){
247 return std::make_unique<
248 orc::LocalIndirectStubsManager<orc::OrcMips64>>();
249 };
250
251 case Triple::riscv64:
252 return []() {
253 return std::make_unique<
254 orc::LocalIndirectStubsManager<orc::OrcRiscv64>>();
255 };
256
257 case Triple::x86_64:
258 if (T.getOS() == Triple::OSType::Win32) {
259 return [](){
260 return std::make_unique<
261 orc::LocalIndirectStubsManager<orc::OrcX86_64_Win32>>();
262 };
263 } else {
264 return [](){
265 return std::make_unique<
266 orc::LocalIndirectStubsManager<orc::OrcX86_64_SysV>>();
267 };
268 }
269
270 }
271}
272
273Constant* createIRTypedAddress(FunctionType &FT, ExecutorAddr Addr) {
274 Constant *AddrIntVal =
275 ConstantInt::get(Ty: Type::getInt64Ty(C&: FT.getContext()), V: Addr.getValue());
276 Constant *AddrPtrVal = ConstantExpr::getIntToPtr(
277 C: AddrIntVal, Ty: PointerType::get(C&: FT.getContext(), AddressSpace: 0));
278 return AddrPtrVal;
279}
280
281GlobalVariable* createImplPointer(PointerType &PT, Module &M,
282 const Twine &Name, Constant *Initializer) {
283 auto IP = new GlobalVariable(M, &PT, false, GlobalValue::ExternalLinkage,
284 Initializer, Name, nullptr,
285 GlobalValue::NotThreadLocal, 0, true);
286 IP->setVisibility(GlobalValue::HiddenVisibility);
287 return IP;
288}
289
290void makeStub(Function &F, Value &ImplPointer) {
291 assert(F.isDeclaration() && "Can't turn a definition into a stub.");
292 assert(F.getParent() && "Function isn't in a module.");
293 Module &M = *F.getParent();
294 BasicBlock *EntryBlock = BasicBlock::Create(Context&: M.getContext(), Name: "entry", Parent: &F);
295 IRBuilder<> Builder(EntryBlock);
296 LoadInst *ImplAddr = Builder.CreateLoad(Ty: F.getType(), Ptr: &ImplPointer);
297 std::vector<Value*> CallArgs;
298 for (auto &A : F.args())
299 CallArgs.push_back(x: &A);
300 CallInst *Call = Builder.CreateCall(FTy: F.getFunctionType(), Callee: ImplAddr, Args: CallArgs);
301 Call->setTailCall();
302 Call->setAttributes(F.getAttributes());
303 if (F.getReturnType()->isVoidTy())
304 Builder.CreateRetVoid();
305 else
306 Builder.CreateRet(V: Call);
307}
308
309std::vector<GlobalValue *> SymbolLinkagePromoter::operator()(Module &M) {
310 std::vector<GlobalValue *> PromotedGlobals;
311
312 for (auto &GV : M.global_values()) {
313 bool Promoted = true;
314
315 // Rename if necessary.
316 if (!GV.hasName())
317 GV.setName("__orc_anon." + Twine(NextId++));
318 else if (GV.getName().starts_with(Prefix: "\01L"))
319 GV.setName("__" + GV.getName().substr(Start: 1) + "." + Twine(NextId++));
320 else if (GV.hasLocalLinkage())
321 GV.setName("__orc_lcl." + GV.getName() + "." + Twine(NextId++));
322 else
323 Promoted = false;
324
325 if (GV.hasLocalLinkage()) {
326 GV.setLinkage(GlobalValue::ExternalLinkage);
327 GV.setVisibility(GlobalValue::HiddenVisibility);
328 Promoted = true;
329 }
330 GV.setUnnamedAddr(GlobalValue::UnnamedAddr::None);
331
332 if (Promoted)
333 PromotedGlobals.push_back(x: &GV);
334 }
335
336 return PromotedGlobals;
337}
338
339Function* cloneFunctionDecl(Module &Dst, const Function &F,
340 ValueToValueMapTy *VMap) {
341 Function *NewF =
342 Function::Create(Ty: F.getFunctionType(), Linkage: F.getLinkage(), N: F.getName(), M: &Dst);
343 NewF->copyAttributesFrom(Src: &F);
344
345 if (VMap) {
346 (*VMap)[&F] = NewF;
347 auto NewArgI = NewF->arg_begin();
348 for (auto ArgI = F.arg_begin(), ArgE = F.arg_end(); ArgI != ArgE;
349 ++ArgI, ++NewArgI)
350 (*VMap)[&*ArgI] = &*NewArgI;
351 }
352
353 return NewF;
354}
355
356GlobalVariable* cloneGlobalVariableDecl(Module &Dst, const GlobalVariable &GV,
357 ValueToValueMapTy *VMap) {
358 GlobalVariable *NewGV = new GlobalVariable(
359 Dst, GV.getValueType(), GV.isConstant(),
360 GV.getLinkage(), nullptr, GV.getName(), nullptr,
361 GV.getThreadLocalMode(), GV.getType()->getAddressSpace());
362 NewGV->copyAttributesFrom(Src: &GV);
363 if (VMap)
364 (*VMap)[&GV] = NewGV;
365 return NewGV;
366}
367
368GlobalAlias* cloneGlobalAliasDecl(Module &Dst, const GlobalAlias &OrigA,
369 ValueToValueMapTy &VMap) {
370 assert(OrigA.getAliasee() && "Original alias doesn't have an aliasee?");
371 auto *NewA = GlobalAlias::create(Ty: OrigA.getValueType(),
372 AddressSpace: OrigA.getType()->getPointerAddressSpace(),
373 Linkage: OrigA.getLinkage(), Name: OrigA.getName(), Parent: &Dst);
374 NewA->copyAttributesFrom(Src: &OrigA);
375 VMap[&OrigA] = NewA;
376 return NewA;
377}
378
379Error addFunctionPointerRelocationsToCurrentSymbol(jitlink::Symbol &Sym,
380 jitlink::LinkGraph &G,
381 MCDisassembler &Disassembler,
382 MCInstrAnalysis &MIA) {
383 // AArch64 appears to already come with the necessary relocations. Among other
384 // architectures, only x86_64 is currently implemented here.
385 if (G.getTargetTriple().getArch() != Triple::x86_64)
386 return Error::success();
387
388 raw_null_ostream CommentStream;
389 auto &STI = Disassembler.getSubtargetInfo();
390
391 // Determine the function bounds
392 auto &B = Sym.getBlock();
393 assert(!B.isZeroFill() && "expected content block");
394 auto SymAddress = Sym.getAddress();
395 auto SymStartInBlock =
396 (const uint8_t *)B.getContent().data() + Sym.getOffset();
397 auto SymSize = Sym.getSize() ? Sym.getSize() : B.getSize() - Sym.getOffset();
398 auto Content = ArrayRef(SymStartInBlock, SymSize);
399
400 LLVM_DEBUG(dbgs() << "Adding self-relocations to " << Sym.getName() << "\n");
401
402 SmallDenseSet<uintptr_t, 8> ExistingRelocations;
403 for (auto &E : B.edges()) {
404 if (E.isRelocation())
405 ExistingRelocations.insert(V: E.getOffset());
406 }
407
408 size_t I = 0;
409 while (I < Content.size()) {
410 MCInst Instr;
411 uint64_t InstrSize = 0;
412 uint64_t InstrStart = SymAddress.getValue() + I;
413 auto DecodeStatus = Disassembler.getInstruction(
414 Instr, Size&: InstrSize, Bytes: Content.drop_front(N: I), Address: InstrStart, CStream&: CommentStream);
415 if (DecodeStatus != MCDisassembler::Success) {
416 LLVM_DEBUG(dbgs() << "Aborting due to disassembly failure at address "
417 << InstrStart);
418 return make_error<StringError>(
419 Args: formatv(Fmt: "failed to disassemble at address {0:x16}", Vals&: InstrStart),
420 Args: inconvertibleErrorCode());
421 }
422 // Advance to the next instruction.
423 I += InstrSize;
424
425 // Check for a PC-relative address equal to the symbol itself.
426 auto PCRelAddr =
427 MIA.evaluateMemoryOperandAddress(Inst: Instr, STI: &STI, Addr: InstrStart, Size: InstrSize);
428 if (!PCRelAddr || *PCRelAddr != SymAddress.getValue())
429 continue;
430
431 auto RelocOffInInstr =
432 MIA.getMemoryOperandRelocationOffset(Inst: Instr, Size: InstrSize);
433 if (!RelocOffInInstr || InstrSize - *RelocOffInInstr != 4) {
434 LLVM_DEBUG(dbgs() << "Skipping unknown self-relocation at "
435 << InstrStart);
436 continue;
437 }
438
439 auto RelocOffInBlock = orc::ExecutorAddr(InstrStart) + *RelocOffInInstr -
440 SymAddress + Sym.getOffset();
441 if (ExistingRelocations.contains(V: RelocOffInBlock))
442 continue;
443
444 LLVM_DEBUG(dbgs() << "Adding delta32 self-relocation at " << InstrStart);
445 B.addEdge(K: jitlink::x86_64::Delta32, Offset: RelocOffInBlock, Target&: Sym, /*Addend=*/-4);
446 }
447 return Error::success();
448}
449
450} // End namespace orc.
451} // End namespace llvm.
452