1//===------ SelfExecutorProcessControl.cpp -- EPC for in-process JITs -----===//
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/SelfExecutorProcessControl.h"
10
11#include "llvm/ExecutionEngine/JITLink/JITLinkMemoryManager.h"
12#include "llvm/ExecutionEngine/Orc/Core.h"
13#include "llvm/ExecutionEngine/Orc/DylibManager.h"
14#include "llvm/ExecutionEngine/Orc/InProcessMemoryAccess.h"
15#include "llvm/ExecutionEngine/Orc/Shared/OrcRTBridge.h"
16#include "llvm/ExecutionEngine/Orc/TargetProcess/DefaultHostBootstrapValues.h"
17#include "llvm/ExecutionEngine/Orc/TargetProcess/TargetExecutionUtils.h"
18#include "llvm/Support/DynamicLibrary.h"
19#include "llvm/Support/Process.h"
20#include "llvm/TargetParser/Host.h"
21
22#define DEBUG_TYPE "orc"
23
24namespace llvm::orc {
25
26class SelfExecutorProcessControl::InProcessDylibManager : public DylibManager {
27public:
28 InProcessDylibManager(char GlobalManglingPrefix);
29 Expected<tpctypes::DylibHandle> loadDylib(const char *DylibPath) override;
30 void
31 lookupSymbolsAsync(tpctypes::DylibHandle H, const SymbolLookupSet &Symbols,
32 DylibManager::SymbolLookupCompleteFn Complete) override;
33
34private:
35 char GlobalManglingPrefix;
36};
37
38SelfExecutorProcessControl::SelfExecutorProcessControl(
39 std::shared_ptr<SymbolStringPool> SSP, std::unique_ptr<TaskDispatcher> D,
40 Triple TargetTriple, unsigned PageSize)
41 : ExecutorProcessControl(std::move(SSP), std::move(D)) {
42
43 this->TargetTriple = std::move(TargetTriple);
44 this->PageSize = PageSize;
45
46 addDefaultBootstrapValuesForHostProcess(BootstrapMap, BootstrapSymbols);
47
48 BootstrapSymbols[rt::DispatchName] =
49 ExecutorAddr::fromPtr(Ptr: jitDispatchViaWrapperFunctionManager);
50 BootstrapSymbols[rt::DispatchCtxName] = ExecutorAddr::fromPtr(Ptr: this);
51
52#ifdef __APPLE__
53 // FIXME: Don't add an UnwindInfoManager by default -- it's redundant when
54 // the ORC runtime is loaded. We'll need a way to document this and
55 // allow clients to choose.
56 if (UnwindInfoManager::TryEnable())
57 UnwindInfoManager::addBootstrapSymbols(this->BootstrapSymbols);
58#endif // __APPLE__
59}
60
61Expected<std::unique_ptr<SelfExecutorProcessControl>>
62SelfExecutorProcessControl::Create(std::shared_ptr<SymbolStringPool> SSP,
63 std::unique_ptr<TaskDispatcher> D) {
64
65 if (!SSP)
66 SSP = std::make_shared<SymbolStringPool>();
67
68 if (!D)
69 D = std::make_unique<InPlaceTaskDispatcher>();
70
71 auto PageSize = sys::Process::getPageSize();
72 if (!PageSize)
73 return PageSize.takeError();
74
75 Triple TT(sys::getProcessTriple());
76
77 return std::make_unique<SelfExecutorProcessControl>(
78 args: std::move(SSP), args: std::move(D), args: std::move(TT), args&: *PageSize);
79}
80
81Expected<int32_t>
82SelfExecutorProcessControl::runAsMain(ExecutorAddr MainFnAddr,
83 ArrayRef<std::string> Args) {
84 using MainTy = int (*)(int, char *[]);
85 return orc::runAsMain(Main: MainFnAddr.toPtr<MainTy>(), Args);
86}
87
88void SelfExecutorProcessControl::callWrapperAsync(ExecutorAddr WrapperFnAddr,
89 IncomingWFRHandler SendResult,
90 ArrayRef<char> ArgBuffer) {
91 using WrapperFnTy =
92 shared::CWrapperFunctionBuffer (*)(const char *Data, size_t Size);
93 auto *WrapperFn = WrapperFnAddr.toPtr<WrapperFnTy>();
94 SendResult(shared::WrapperFunctionBuffer(
95 WrapperFn(ArgBuffer.data(), ArgBuffer.size())));
96}
97
98Error SelfExecutorProcessControl::disconnect() {
99 D->shutdown();
100 return Error::success();
101}
102
103Expected<std::unique_ptr<jitlink::JITLinkMemoryManager>>
104SelfExecutorProcessControl::createDefaultMemoryManager() {
105 return std::make_unique<jitlink::InProcessMemoryManager>(
106 args: sys::Process::getPageSizeEstimate());
107}
108
109Expected<std::unique_ptr<DylibManager>>
110SelfExecutorProcessControl::createDefaultDylibMgr() {
111 char Prefix = TargetTriple.isOSBinFormatMachO() ? '_' : '\0';
112 return std::make_unique<InProcessDylibManager>(args&: Prefix);
113}
114
115Expected<std::unique_ptr<MemoryAccess>>
116SelfExecutorProcessControl::createDefaultMemoryAccess() {
117 return std::make_unique<InProcessMemoryAccess>(args: TargetTriple.isArch64Bit());
118}
119
120shared::CWrapperFunctionBuffer
121SelfExecutorProcessControl::jitDispatchViaWrapperFunctionManager(
122 void *Ctx, const void *FnTag, const char *Data, size_t Size) {
123
124 LLVM_DEBUG({
125 dbgs() << "jit-dispatch call with tag " << FnTag << " and " << Size
126 << " byte payload.\n";
127 });
128
129 std::promise<shared::WrapperFunctionBuffer> ResultP;
130 auto ResultF = ResultP.get_future();
131 static_cast<SelfExecutorProcessControl *>(Ctx)
132 ->getExecutionSession()
133 .runJITDispatchHandler(
134 SendResult: [ResultP = std::move(ResultP)](
135 shared::WrapperFunctionBuffer Result) mutable {
136 ResultP.set_value(std::move(Result));
137 },
138 HandlerFnTagAddr: ExecutorAddr::fromPtr(Ptr: FnTag),
139 ArgBytes: shared::WrapperFunctionBuffer::copyFrom(Source: Data, Size));
140
141 return ResultF.get().release();
142}
143
144SelfExecutorProcessControl::InProcessDylibManager::InProcessDylibManager(
145 char GlobalManglingPrefix)
146 : GlobalManglingPrefix(GlobalManglingPrefix) {}
147
148Expected<tpctypes::DylibHandle>
149SelfExecutorProcessControl::InProcessDylibManager::loadDylib(
150 const char *DylibPath) {
151 std::string ErrMsg;
152 auto Dylib = sys::DynamicLibrary::getPermanentLibrary(filename: DylibPath, errMsg: &ErrMsg);
153 if (!Dylib.isValid())
154 return make_error<StringError>(Args: std::move(ErrMsg), Args: inconvertibleErrorCode());
155 return ExecutorAddr::fromPtr(Ptr: Dylib.getOSSpecificHandle());
156}
157
158void SelfExecutorProcessControl::InProcessDylibManager::lookupSymbolsAsync(
159 tpctypes::DylibHandle H, const SymbolLookupSet &Symbols,
160 DylibManager::SymbolLookupCompleteFn Complete) {
161 tpctypes::LookupResult R;
162
163 sys::DynamicLibrary Dylib(H.toPtr<void *>());
164 for (auto &KV : Symbols) {
165 auto &Sym = KV.first;
166 std::string Tmp((*Sym).data() + !!GlobalManglingPrefix,
167 (*Sym).size() - !!GlobalManglingPrefix);
168 void *Addr = Dylib.getAddressOfSymbol(symbolName: Tmp.c_str());
169 if (!Addr && KV.second == SymbolLookupFlags::RequiredSymbol)
170 R.emplace_back();
171 else
172 R.emplace_back(args: ExecutorAddr::fromPtr(Ptr: Addr));
173 }
174 Complete(std::move(R));
175}
176
177} // namespace llvm::orc
178