xref: /llvm-project/llvm/lib/ExecutionEngine/Orc/SimpleRemoteEPC.cpp (revision 17a0858f9d17a5d0d1b70b0e409e59a9f96967ca) 
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     IncomingWFRHandler H;
71 
72     // We just registered OnComplete, but there may be a race between this
73     // thread returning from sendMessage and handleDisconnect being called from
74     // the transport's listener thread. If handleDisconnect gets there first
75     // then it will have failed 'H' for us. If we get there first (or if
76     // handleDisconnect already ran) then we need to take care of it.
77     {
78       std::lock_guard<std::mutex> Lock(SimpleRemoteEPCMutex);
79       auto I = PendingCallWrapperResults.find(SeqNo);
80       if (I != PendingCallWrapperResults.end()) {
81         H = std::move(I->second);
82         PendingCallWrapperResults.erase(I);
83       }
84     }
85 
86     if (H)
87       H(shared::WrapperFunctionResult::createOutOfBandError("disconnecting"));
88 
89     getExecutionSession().reportError(std::move(Err));
90   }
91 }
92 
93 Error SimpleRemoteEPC::disconnect() {
94   T->disconnect();
95   std::unique_lock<std::mutex> Lock(SimpleRemoteEPCMutex);
96   DisconnectCV.wait(Lock, [this] { return Disconnected; });
97   return std::move(DisconnectErr);
98 }
99 
100 Expected<SimpleRemoteEPCTransportClient::HandleMessageAction>
101 SimpleRemoteEPC::handleMessage(SimpleRemoteEPCOpcode OpC, uint64_t SeqNo,
102                                ExecutorAddr TagAddr,
103                                SimpleRemoteEPCArgBytesVector ArgBytes) {
104 
105   LLVM_DEBUG({
106     dbgs() << "SimpleRemoteEPC::handleMessage: opc = ";
107     switch (OpC) {
108     case SimpleRemoteEPCOpcode::Setup:
109       dbgs() << "Setup";
110       assert(SeqNo == 0 && "Non-zero SeqNo for Setup?");
111       assert(TagAddr.getValue() == 0 && "Non-zero TagAddr for Setup?");
112       break;
113     case SimpleRemoteEPCOpcode::Hangup:
114       dbgs() << "Hangup";
115       assert(SeqNo == 0 && "Non-zero SeqNo for Hangup?");
116       assert(TagAddr.getValue() == 0 && "Non-zero TagAddr for Hangup?");
117       break;
118     case SimpleRemoteEPCOpcode::Result:
119       dbgs() << "Result";
120       assert(TagAddr.getValue() == 0 && "Non-zero TagAddr for Result?");
121       break;
122     case SimpleRemoteEPCOpcode::CallWrapper:
123       dbgs() << "CallWrapper";
124       break;
125     }
126     dbgs() << ", seqno = " << SeqNo
127            << ", tag-addr = " << formatv("{0:x}", TagAddr.getValue())
128            << ", arg-buffer = " << formatv("{0:x}", ArgBytes.size())
129            << " bytes\n";
130   });
131 
132   using UT = std::underlying_type_t<SimpleRemoteEPCOpcode>;
133   if (static_cast<UT>(OpC) > static_cast<UT>(SimpleRemoteEPCOpcode::LastOpC))
134     return make_error<StringError>("Unexpected opcode",
135                                    inconvertibleErrorCode());
136 
137   switch (OpC) {
138   case SimpleRemoteEPCOpcode::Setup:
139     if (auto Err = handleSetup(SeqNo, TagAddr, std::move(ArgBytes)))
140       return std::move(Err);
141     break;
142   case SimpleRemoteEPCOpcode::Hangup:
143     T->disconnect();
144     if (auto Err = handleHangup(std::move(ArgBytes)))
145       return std::move(Err);
146     return EndSession;
147   case SimpleRemoteEPCOpcode::Result:
148     if (auto Err = handleResult(SeqNo, TagAddr, std::move(ArgBytes)))
149       return std::move(Err);
150     break;
151   case SimpleRemoteEPCOpcode::CallWrapper:
152     handleCallWrapper(SeqNo, TagAddr, std::move(ArgBytes));
153     break;
154   }
155   return ContinueSession;
156 }
157 
158 void SimpleRemoteEPC::handleDisconnect(Error Err) {
159   LLVM_DEBUG({
160     dbgs() << "SimpleRemoteEPC::handleDisconnect: "
161            << (Err ? "failure" : "success") << "\n";
162   });
163 
164   PendingCallWrapperResultsMap TmpPending;
165 
166   {
167     std::lock_guard<std::mutex> Lock(SimpleRemoteEPCMutex);
168     std::swap(TmpPending, PendingCallWrapperResults);
169   }
170 
171   for (auto &KV : TmpPending)
172     KV.second(
173         shared::WrapperFunctionResult::createOutOfBandError("disconnecting"));
174 
175   std::lock_guard<std::mutex> Lock(SimpleRemoteEPCMutex);
176   DisconnectErr = joinErrors(std::move(DisconnectErr), std::move(Err));
177   Disconnected = true;
178   DisconnectCV.notify_all();
179 }
180 
181 Expected<std::unique_ptr<jitlink::JITLinkMemoryManager>>
182 SimpleRemoteEPC::createMemoryManager() {
183   EPCGenericJITLinkMemoryManager::SymbolAddrs SAs;
184   if (auto Err = getBootstrapSymbols(
185           {{SAs.Allocator, rt::SimpleExecutorMemoryManagerInstanceName},
186            {SAs.Reserve, rt::SimpleExecutorMemoryManagerReserveWrapperName},
187            {SAs.Finalize, rt::SimpleExecutorMemoryManagerFinalizeWrapperName},
188            {SAs.Deallocate,
189             rt::SimpleExecutorMemoryManagerDeallocateWrapperName}}))
190     return std::move(Err);
191 
192   return std::make_unique<EPCGenericJITLinkMemoryManager>(*this, SAs);
193 }
194 
195 Expected<std::unique_ptr<ExecutorProcessControl::MemoryAccess>>
196 SimpleRemoteEPC::createMemoryAccess() {
197 
198   return nullptr;
199 }
200 
201 Error SimpleRemoteEPC::sendMessage(SimpleRemoteEPCOpcode OpC, uint64_t SeqNo,
202                                    ExecutorAddr TagAddr,
203                                    ArrayRef<char> ArgBytes) {
204   assert(OpC != SimpleRemoteEPCOpcode::Setup &&
205          "SimpleRemoteEPC sending Setup message? That's the wrong direction.");
206 
207   LLVM_DEBUG({
208     dbgs() << "SimpleRemoteEPC::sendMessage: opc = ";
209     switch (OpC) {
210     case SimpleRemoteEPCOpcode::Hangup:
211       dbgs() << "Hangup";
212       assert(SeqNo == 0 && "Non-zero SeqNo for Hangup?");
213       assert(TagAddr.getValue() == 0 && "Non-zero TagAddr for Hangup?");
214       break;
215     case SimpleRemoteEPCOpcode::Result:
216       dbgs() << "Result";
217       assert(TagAddr.getValue() == 0 && "Non-zero TagAddr for Result?");
218       break;
219     case SimpleRemoteEPCOpcode::CallWrapper:
220       dbgs() << "CallWrapper";
221       break;
222     default:
223       llvm_unreachable("Invalid opcode");
224     }
225     dbgs() << ", seqno = " << SeqNo
226            << ", tag-addr = " << formatv("{0:x}", TagAddr.getValue())
227            << ", arg-buffer = " << formatv("{0:x}", ArgBytes.size())
228            << " bytes\n";
229   });
230   auto Err = T->sendMessage(OpC, SeqNo, TagAddr, ArgBytes);
231   LLVM_DEBUG({
232     if (Err)
233       dbgs() << "  \\--> SimpleRemoteEPC::sendMessage failed\n";
234   });
235   return Err;
236 }
237 
238 Error SimpleRemoteEPC::handleSetup(uint64_t SeqNo, ExecutorAddr TagAddr,
239                                    SimpleRemoteEPCArgBytesVector ArgBytes) {
240   if (SeqNo != 0)
241     return make_error<StringError>("Setup packet SeqNo not zero",
242                                    inconvertibleErrorCode());
243 
244   if (TagAddr)
245     return make_error<StringError>("Setup packet TagAddr not zero",
246                                    inconvertibleErrorCode());
247 
248   std::lock_guard<std::mutex> Lock(SimpleRemoteEPCMutex);
249   auto I = PendingCallWrapperResults.find(0);
250   assert(PendingCallWrapperResults.size() == 1 &&
251          I != PendingCallWrapperResults.end() &&
252          "Setup message handler not connectly set up");
253   auto SetupMsgHandler = std::move(I->second);
254   PendingCallWrapperResults.erase(I);
255 
256   auto WFR =
257       shared::WrapperFunctionResult::copyFrom(ArgBytes.data(), ArgBytes.size());
258   SetupMsgHandler(std::move(WFR));
259   return Error::success();
260 }
261 
262 Error SimpleRemoteEPC::setup() {
263   using namespace SimpleRemoteEPCDefaultBootstrapSymbolNames;
264 
265   std::promise<MSVCPExpected<SimpleRemoteEPCExecutorInfo>> EIP;
266   auto EIF = EIP.get_future();
267 
268   // Prepare a handler for the setup packet.
269   PendingCallWrapperResults[0] =
270     RunInPlace()(
271       [&](shared::WrapperFunctionResult SetupMsgBytes) {
272         if (const char *ErrMsg = SetupMsgBytes.getOutOfBandError()) {
273           EIP.set_value(
274               make_error<StringError>(ErrMsg, inconvertibleErrorCode()));
275           return;
276         }
277         using SPSSerialize =
278             shared::SPSArgList<shared::SPSSimpleRemoteEPCExecutorInfo>;
279         shared::SPSInputBuffer IB(SetupMsgBytes.data(), SetupMsgBytes.size());
280         SimpleRemoteEPCExecutorInfo EI;
281         if (SPSSerialize::deserialize(IB, EI))
282           EIP.set_value(EI);
283         else
284           EIP.set_value(make_error<StringError>(
285               "Could not deserialize setup message", inconvertibleErrorCode()));
286       });
287 
288   // Start the transport.
289   if (auto Err = T->start())
290     return Err;
291 
292   // Wait for setup packet to arrive.
293   auto EI = EIF.get();
294   if (!EI) {
295     T->disconnect();
296     return EI.takeError();
297   }
298 
299   LLVM_DEBUG({
300     dbgs() << "SimpleRemoteEPC received setup message:\n"
301            << "  Triple: " << EI->TargetTriple << "\n"
302            << "  Page size: " << EI->PageSize << "\n"
303            << "  Bootstrap symbols:\n";
304     for (const auto &KV : EI->BootstrapSymbols)
305       dbgs() << "    " << KV.first() << ": "
306              << formatv("{0:x16}", KV.second.getValue()) << "\n";
307   });
308   TargetTriple = Triple(EI->TargetTriple);
309   PageSize = EI->PageSize;
310   BootstrapSymbols = std::move(EI->BootstrapSymbols);
311 
312   if (auto Err = getBootstrapSymbols(
313           {{JDI.JITDispatchContext, ExecutorSessionObjectName},
314            {JDI.JITDispatchFunction, DispatchFnName},
315            {RunAsMainAddr, rt::RunAsMainWrapperName}}))
316     return Err;
317 
318   if (auto DM =
319           EPCGenericDylibManager::CreateWithDefaultBootstrapSymbols(*this))
320     DylibMgr = std::make_unique<EPCGenericDylibManager>(std::move(*DM));
321   else
322     return DM.takeError();
323 
324   if (auto MemMgr = createMemoryManager()) {
325     OwnedMemMgr = std::move(*MemMgr);
326     this->MemMgr = OwnedMemMgr.get();
327   } else
328     return MemMgr.takeError();
329 
330   if (auto MemAccess = createMemoryAccess()) {
331     OwnedMemAccess = std::move(*MemAccess);
332     this->MemAccess = OwnedMemAccess.get();
333   } else
334     return MemAccess.takeError();
335 
336   return Error::success();
337 }
338 
339 Error SimpleRemoteEPC::handleResult(uint64_t SeqNo, ExecutorAddr TagAddr,
340                                     SimpleRemoteEPCArgBytesVector ArgBytes) {
341   IncomingWFRHandler SendResult;
342 
343   if (TagAddr)
344     return make_error<StringError>("Unexpected TagAddr in result message",
345                                    inconvertibleErrorCode());
346 
347   {
348     std::lock_guard<std::mutex> Lock(SimpleRemoteEPCMutex);
349     auto I = PendingCallWrapperResults.find(SeqNo);
350     if (I == PendingCallWrapperResults.end())
351       return make_error<StringError>("No call for sequence number " +
352                                          Twine(SeqNo),
353                                      inconvertibleErrorCode());
354     SendResult = std::move(I->second);
355     PendingCallWrapperResults.erase(I);
356     releaseSeqNo(SeqNo);
357   }
358 
359   auto WFR =
360       shared::WrapperFunctionResult::copyFrom(ArgBytes.data(), ArgBytes.size());
361   SendResult(std::move(WFR));
362   return Error::success();
363 }
364 
365 void SimpleRemoteEPC::handleCallWrapper(
366     uint64_t RemoteSeqNo, ExecutorAddr TagAddr,
367     SimpleRemoteEPCArgBytesVector ArgBytes) {
368   assert(ES && "No ExecutionSession attached");
369   ES->runJITDispatchHandler(
370       [this, RemoteSeqNo](shared::WrapperFunctionResult WFR) {
371         if (auto Err = sendMessage(SimpleRemoteEPCOpcode::Result, RemoteSeqNo,
372                                    ExecutorAddr(), {WFR.data(), WFR.size()}))
373           getExecutionSession().reportError(std::move(Err));
374       },
375       TagAddr.getValue(), ArgBytes);
376 }
377 
378 Error SimpleRemoteEPC::handleHangup(SimpleRemoteEPCArgBytesVector ArgBytes) {
379   using namespace llvm::orc::shared;
380   auto WFR = WrapperFunctionResult::copyFrom(ArgBytes.data(), ArgBytes.size());
381   if (const char *ErrMsg = WFR.getOutOfBandError())
382     return make_error<StringError>(ErrMsg, inconvertibleErrorCode());
383 
384   detail::SPSSerializableError Info;
385   SPSInputBuffer IB(WFR.data(), WFR.size());
386   if (!SPSArgList<SPSError>::deserialize(IB, Info))
387     return make_error<StringError>("Could not deserialize hangup info",
388                                    inconvertibleErrorCode());
389   return fromSPSSerializable(std::move(Info));
390 }
391 
392 } // end namespace orc
393 } // end namespace llvm
394