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