xref: /llvm-project/llvm/lib/ExecutionEngine/Orc/SimpleRemoteEPC.cpp (revision 4d7cea3d2e833209d06e201a273f97342035c196) 
1 //===------- SimpleRemoteEPC.cpp -- Simple remote executor control --------===//
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/SimpleRemoteEPC.h"
10 #include "llvm/ExecutionEngine/Orc/EPCGenericJITLinkMemoryManager.h"
11 #include "llvm/ExecutionEngine/Orc/EPCGenericMemoryAccess.h"
12 #include "llvm/ExecutionEngine/Orc/Shared/OrcRTBridge.h"
13 #include "llvm/Support/FormatVariadic.h"
14 
15 #define DEBUG_TYPE "orc"
16 
17 namespace llvm {
18 namespace orc {
19 
20 SimpleRemoteEPC::~SimpleRemoteEPC() {
21 #ifndef NDEBUG
22   std::lock_guard<std::mutex> Lock(SimpleRemoteEPCMutex);
23   assert(Disconnected && "Destroyed without disconnection");
24 #endif // NDEBUG
25 }
26 
27 Expected<tpctypes::DylibHandle>
28 SimpleRemoteEPC::loadDylib(const char *DylibPath) {
29   return DylibMgr->open(DylibPath, 0);
30 }
31 
32 Expected<std::vector<tpctypes::LookupResult>>
33 SimpleRemoteEPC::lookupSymbols(ArrayRef<LookupRequest> Request) {
34   std::vector<tpctypes::LookupResult> Result;
35 
36   for (auto &Element : Request) {
37     if (auto R = DylibMgr->lookup(Element.Handle, Element.Symbols)) {
38       Result.push_back({});
39       Result.back().reserve(R->size());
40       for (auto Addr : *R)
41         Result.back().push_back(Addr.getValue());
42     } else
43       return R.takeError();
44   }
45   return std::move(Result);
46 }
47 
48 Expected<int32_t> SimpleRemoteEPC::runAsMain(ExecutorAddr MainFnAddr,
49                                              ArrayRef<std::string> Args) {
50   int64_t Result = 0;
51   if (auto Err = callSPSWrapper<rt::SPSRunAsMainSignature>(
52           RunAsMainAddr, Result, ExecutorAddr(MainFnAddr), Args))
53     return std::move(Err);
54   return Result;
55 }
56 
57 void SimpleRemoteEPC::callWrapperAsync(ExecutorAddr WrapperFnAddr,
58                                        IncomingWFRHandler OnComplete,
59                                        ArrayRef<char> ArgBuffer) {
60   uint64_t SeqNo;
61   {
62     std::lock_guard<std::mutex> Lock(SimpleRemoteEPCMutex);
63     SeqNo = getNextSeqNo();
64     assert(!PendingCallWrapperResults.count(SeqNo) && "SeqNo already in use");
65     PendingCallWrapperResults[SeqNo] = std::move(OnComplete);
66   }
67 
68   if (auto Err = sendMessage(SimpleRemoteEPCOpcode::CallWrapper, SeqNo,
69                              WrapperFnAddr, ArgBuffer)) {
70     getExecutionSession().reportError(std::move(Err));
71   }
72 }
73 
74 Error SimpleRemoteEPC::disconnect() {
75   T->disconnect();
76   std::unique_lock<std::mutex> Lock(SimpleRemoteEPCMutex);
77   DisconnectCV.wait(Lock, [this] { return Disconnected; });
78   return std::move(DisconnectErr);
79 }
80 
81 Expected<SimpleRemoteEPCTransportClient::HandleMessageAction>
82 SimpleRemoteEPC::handleMessage(SimpleRemoteEPCOpcode OpC, uint64_t SeqNo,
83                                ExecutorAddr TagAddr,
84                                SimpleRemoteEPCArgBytesVector ArgBytes) {
85 
86   LLVM_DEBUG({
87     dbgs() << "SimpleRemoteEPC::handleMessage: opc = ";
88     switch (OpC) {
89     case SimpleRemoteEPCOpcode::Setup:
90       dbgs() << "Setup";
91       assert(SeqNo == 0 && "Non-zero SeqNo for Setup?");
92       assert(TagAddr.getValue() == 0 && "Non-zero TagAddr for Setup?");
93       break;
94     case SimpleRemoteEPCOpcode::Hangup:
95       dbgs() << "Hangup";
96       assert(SeqNo == 0 && "Non-zero SeqNo for Hangup?");
97       assert(TagAddr.getValue() == 0 && "Non-zero TagAddr for Hangup?");
98       break;
99     case SimpleRemoteEPCOpcode::Result:
100       dbgs() << "Result";
101       assert(TagAddr.getValue() == 0 && "Non-zero TagAddr for Result?");
102       break;
103     case SimpleRemoteEPCOpcode::CallWrapper:
104       dbgs() << "CallWrapper";
105       break;
106     }
107     dbgs() << ", seqno = " << SeqNo
108            << ", tag-addr = " << formatv("{0:x}", TagAddr.getValue())
109            << ", arg-buffer = " << formatv("{0:x}", ArgBytes.size())
110            << " bytes\n";
111   });
112 
113   using UT = std::underlying_type_t<SimpleRemoteEPCOpcode>;
114   if (static_cast<UT>(OpC) > static_cast<UT>(SimpleRemoteEPCOpcode::LastOpC))
115     return make_error<StringError>("Unexpected opcode",
116                                    inconvertibleErrorCode());
117 
118   switch (OpC) {
119   case SimpleRemoteEPCOpcode::Setup:
120     if (auto Err = handleSetup(SeqNo, TagAddr, std::move(ArgBytes)))
121       return std::move(Err);
122     break;
123   case SimpleRemoteEPCOpcode::Hangup:
124     return make_error<StringError>("Unexpected Hangup opcode",
125                                    inconvertibleErrorCode());
126   case SimpleRemoteEPCOpcode::Result:
127     if (auto Err = handleResult(SeqNo, TagAddr, std::move(ArgBytes)))
128       return std::move(Err);
129     break;
130   case SimpleRemoteEPCOpcode::CallWrapper:
131     handleCallWrapper(SeqNo, TagAddr, std::move(ArgBytes));
132     break;
133   }
134   return ContinueSession;
135 }
136 
137 void SimpleRemoteEPC::handleDisconnect(Error Err) {
138   LLVM_DEBUG({
139     dbgs() << "SimpleRemoteEPC::handleDisconnect: "
140            << (Err ? "failure" : "success") << "\n";
141   });
142 
143   PendingCallWrapperResultsMap TmpPending;
144 
145   {
146     std::lock_guard<std::mutex> Lock(SimpleRemoteEPCMutex);
147     std::swap(TmpPending, PendingCallWrapperResults);
148   }
149 
150   for (auto &KV : TmpPending)
151     KV.second(
152         shared::WrapperFunctionResult::createOutOfBandError("disconnecting"));
153 
154   std::lock_guard<std::mutex> Lock(SimpleRemoteEPCMutex);
155   DisconnectErr = joinErrors(std::move(DisconnectErr), std::move(Err));
156   Disconnected = true;
157   DisconnectCV.notify_all();
158 }
159 
160 Expected<std::unique_ptr<jitlink::JITLinkMemoryManager>>
161 SimpleRemoteEPC::createMemoryManager() {
162   EPCGenericJITLinkMemoryManager::SymbolAddrs SAs;
163   if (auto Err = getBootstrapSymbols(
164           {{SAs.Allocator, rt::SimpleExecutorMemoryManagerInstanceName},
165            {SAs.Reserve, rt::SimpleExecutorMemoryManagerReserveWrapperName},
166            {SAs.Finalize, rt::SimpleExecutorMemoryManagerFinalizeWrapperName},
167            {SAs.Deallocate,
168             rt::SimpleExecutorMemoryManagerDeallocateWrapperName}}))
169     return std::move(Err);
170 
171   return std::make_unique<EPCGenericJITLinkMemoryManager>(*this, SAs);
172 }
173 
174 Expected<std::unique_ptr<ExecutorProcessControl::MemoryAccess>>
175 SimpleRemoteEPC::createMemoryAccess() {
176 
177   return nullptr;
178 }
179 
180 Error SimpleRemoteEPC::sendMessage(SimpleRemoteEPCOpcode OpC, uint64_t SeqNo,
181                                    ExecutorAddr TagAddr,
182                                    ArrayRef<char> ArgBytes) {
183   assert(OpC != SimpleRemoteEPCOpcode::Setup &&
184          "SimpleRemoteEPC sending Setup message? That's the wrong direction.");
185 
186   LLVM_DEBUG({
187     dbgs() << "SimpleRemoteEPC::sendMessage: opc = ";
188     switch (OpC) {
189     case SimpleRemoteEPCOpcode::Hangup:
190       dbgs() << "Hangup";
191       assert(SeqNo == 0 && "Non-zero SeqNo for Hangup?");
192       assert(TagAddr.getValue() == 0 && "Non-zero TagAddr for Hangup?");
193       break;
194     case SimpleRemoteEPCOpcode::Result:
195       dbgs() << "Result";
196       assert(TagAddr.getValue() == 0 && "Non-zero TagAddr for Result?");
197       break;
198     case SimpleRemoteEPCOpcode::CallWrapper:
199       dbgs() << "CallWrapper";
200       break;
201     default:
202       llvm_unreachable("Invalid opcode");
203     }
204     dbgs() << ", seqno = " << SeqNo
205            << ", tag-addr = " << formatv("{0:x}", TagAddr.getValue())
206            << ", arg-buffer = " << formatv("{0:x}", ArgBytes.size())
207            << " bytes\n";
208   });
209   auto Err = T->sendMessage(OpC, SeqNo, TagAddr, ArgBytes);
210   LLVM_DEBUG({
211     if (Err)
212       dbgs() << "  \\--> SimpleRemoteEPC::sendMessage failed\n";
213   });
214   return Err;
215 }
216 
217 Error SimpleRemoteEPC::handleSetup(uint64_t SeqNo, ExecutorAddr TagAddr,
218                                    SimpleRemoteEPCArgBytesVector ArgBytes) {
219   if (SeqNo != 0)
220     return make_error<StringError>("Setup packet SeqNo not zero",
221                                    inconvertibleErrorCode());
222 
223   if (TagAddr)
224     return make_error<StringError>("Setup packet TagAddr not zero",
225                                    inconvertibleErrorCode());
226 
227   std::lock_guard<std::mutex> Lock(SimpleRemoteEPCMutex);
228   auto I = PendingCallWrapperResults.find(0);
229   assert(PendingCallWrapperResults.size() == 1 &&
230          I != PendingCallWrapperResults.end() &&
231          "Setup message handler not connectly set up");
232   auto SetupMsgHandler = std::move(I->second);
233   PendingCallWrapperResults.erase(I);
234 
235   auto WFR =
236       shared::WrapperFunctionResult::copyFrom(ArgBytes.data(), ArgBytes.size());
237   SetupMsgHandler(std::move(WFR));
238   return Error::success();
239 }
240 
241 Error SimpleRemoteEPC::setup() {
242   using namespace SimpleRemoteEPCDefaultBootstrapSymbolNames;
243 
244   std::promise<MSVCPExpected<SimpleRemoteEPCExecutorInfo>> EIP;
245   auto EIF = EIP.get_future();
246 
247   // Prepare a handler for the setup packet.
248   PendingCallWrapperResults[0] =
249     RunInPlace()(
250       [&](shared::WrapperFunctionResult SetupMsgBytes) {
251         if (const char *ErrMsg = SetupMsgBytes.getOutOfBandError()) {
252           EIP.set_value(
253               make_error<StringError>(ErrMsg, inconvertibleErrorCode()));
254           return;
255         }
256         using SPSSerialize =
257             shared::SPSArgList<shared::SPSSimpleRemoteEPCExecutorInfo>;
258         shared::SPSInputBuffer IB(SetupMsgBytes.data(), SetupMsgBytes.size());
259         SimpleRemoteEPCExecutorInfo EI;
260         if (SPSSerialize::deserialize(IB, EI))
261           EIP.set_value(EI);
262         else
263           EIP.set_value(make_error<StringError>(
264               "Could not deserialize setup message", inconvertibleErrorCode()));
265       });
266 
267   // Start the transport.
268   if (auto Err = T->start())
269     return Err;
270 
271   // Wait for setup packet to arrive.
272   auto EI = EIF.get();
273   if (!EI) {
274     T->disconnect();
275     return EI.takeError();
276   }
277 
278   LLVM_DEBUG({
279     dbgs() << "SimpleRemoteEPC received setup message:\n"
280            << "  Triple: " << EI->TargetTriple << "\n"
281            << "  Page size: " << EI->PageSize << "\n"
282            << "  Bootstrap symbols:\n";
283     for (const auto &KV : EI->BootstrapSymbols)
284       dbgs() << "    " << KV.first() << ": "
285              << formatv("{0:x16}", KV.second.getValue()) << "\n";
286   });
287   TargetTriple = Triple(EI->TargetTriple);
288   PageSize = EI->PageSize;
289   BootstrapSymbols = std::move(EI->BootstrapSymbols);
290 
291   if (auto Err = getBootstrapSymbols(
292           {{JDI.JITDispatchContext, ExecutorSessionObjectName},
293            {JDI.JITDispatchFunction, DispatchFnName},
294            {RunAsMainAddr, rt::RunAsMainWrapperName}}))
295     return Err;
296 
297   if (auto DM =
298           EPCGenericDylibManager::CreateWithDefaultBootstrapSymbols(*this))
299     DylibMgr = std::make_unique<EPCGenericDylibManager>(std::move(*DM));
300   else
301     return DM.takeError();
302 
303   if (auto MemMgr = createMemoryManager()) {
304     OwnedMemMgr = std::move(*MemMgr);
305     this->MemMgr = OwnedMemMgr.get();
306   } else
307     return MemMgr.takeError();
308 
309   if (auto MemAccess = createMemoryAccess()) {
310     OwnedMemAccess = std::move(*MemAccess);
311     this->MemAccess = OwnedMemAccess.get();
312   } else
313     return MemAccess.takeError();
314 
315   return Error::success();
316 }
317 
318 Error SimpleRemoteEPC::handleResult(uint64_t SeqNo, ExecutorAddr TagAddr,
319                                     SimpleRemoteEPCArgBytesVector ArgBytes) {
320   IncomingWFRHandler SendResult;
321 
322   if (TagAddr)
323     return make_error<StringError>("Unexpected TagAddr in result message",
324                                    inconvertibleErrorCode());
325 
326   {
327     std::lock_guard<std::mutex> Lock(SimpleRemoteEPCMutex);
328     auto I = PendingCallWrapperResults.find(SeqNo);
329     if (I == PendingCallWrapperResults.end())
330       return make_error<StringError>("No call for sequence number " +
331                                          Twine(SeqNo),
332                                      inconvertibleErrorCode());
333     SendResult = std::move(I->second);
334     PendingCallWrapperResults.erase(I);
335     releaseSeqNo(SeqNo);
336   }
337 
338   auto WFR =
339       shared::WrapperFunctionResult::copyFrom(ArgBytes.data(), ArgBytes.size());
340   SendResult(std::move(WFR));
341   return Error::success();
342 }
343 
344 void SimpleRemoteEPC::handleCallWrapper(
345     uint64_t RemoteSeqNo, ExecutorAddr TagAddr,
346     SimpleRemoteEPCArgBytesVector ArgBytes) {
347   assert(ES && "No ExecutionSession attached");
348   ES->runJITDispatchHandler(
349       [this, RemoteSeqNo](shared::WrapperFunctionResult WFR) {
350         if (auto Err = sendMessage(SimpleRemoteEPCOpcode::Result, RemoteSeqNo,
351                                    ExecutorAddr(), {WFR.data(), WFR.size()}))
352           getExecutionSession().reportError(std::move(Err));
353       },
354       TagAddr.getValue(), ArgBytes);
355 }
356 
357 } // end namespace orc
358 } // end namespace llvm
359