1*da58b97aSjoerg //===------ TargetProcessControl.cpp -- Target process control APIs -------===//
2*da58b97aSjoerg //
3*da58b97aSjoerg // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*da58b97aSjoerg // See https://llvm.org/LICENSE.txt for license information.
5*da58b97aSjoerg // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*da58b97aSjoerg //
7*da58b97aSjoerg //===----------------------------------------------------------------------===//
8*da58b97aSjoerg
9*da58b97aSjoerg #include "llvm/ExecutionEngine/Orc/TargetProcessControl.h"
10*da58b97aSjoerg
11*da58b97aSjoerg #include "llvm/ExecutionEngine/Orc/Core.h"
12*da58b97aSjoerg #include "llvm/ExecutionEngine/Orc/TargetProcess/TargetExecutionUtils.h"
13*da58b97aSjoerg #include "llvm/Support/Host.h"
14*da58b97aSjoerg #include "llvm/Support/Process.h"
15*da58b97aSjoerg
16*da58b97aSjoerg #include <mutex>
17*da58b97aSjoerg
18*da58b97aSjoerg namespace llvm {
19*da58b97aSjoerg namespace orc {
20*da58b97aSjoerg
~MemoryAccess()21*da58b97aSjoerg TargetProcessControl::MemoryAccess::~MemoryAccess() {}
22*da58b97aSjoerg
~TargetProcessControl()23*da58b97aSjoerg TargetProcessControl::~TargetProcessControl() {}
24*da58b97aSjoerg
SelfTargetProcessControl(std::shared_ptr<SymbolStringPool> SSP,Triple TargetTriple,unsigned PageSize,std::unique_ptr<jitlink::JITLinkMemoryManager> MemMgr)25*da58b97aSjoerg SelfTargetProcessControl::SelfTargetProcessControl(
26*da58b97aSjoerg std::shared_ptr<SymbolStringPool> SSP, Triple TargetTriple,
27*da58b97aSjoerg unsigned PageSize, std::unique_ptr<jitlink::JITLinkMemoryManager> MemMgr)
28*da58b97aSjoerg : TargetProcessControl(std::move(SSP)) {
29*da58b97aSjoerg
30*da58b97aSjoerg OwnedMemMgr = std::move(MemMgr);
31*da58b97aSjoerg if (!OwnedMemMgr)
32*da58b97aSjoerg OwnedMemMgr = std::make_unique<jitlink::InProcessMemoryManager>();
33*da58b97aSjoerg
34*da58b97aSjoerg this->TargetTriple = std::move(TargetTriple);
35*da58b97aSjoerg this->PageSize = PageSize;
36*da58b97aSjoerg this->MemMgr = OwnedMemMgr.get();
37*da58b97aSjoerg this->MemAccess = this;
38*da58b97aSjoerg if (this->TargetTriple.isOSBinFormatMachO())
39*da58b97aSjoerg GlobalManglingPrefix = '_';
40*da58b97aSjoerg }
41*da58b97aSjoerg
42*da58b97aSjoerg Expected<std::unique_ptr<SelfTargetProcessControl>>
Create(std::shared_ptr<SymbolStringPool> SSP,std::unique_ptr<jitlink::JITLinkMemoryManager> MemMgr)43*da58b97aSjoerg SelfTargetProcessControl::Create(
44*da58b97aSjoerg std::shared_ptr<SymbolStringPool> SSP,
45*da58b97aSjoerg std::unique_ptr<jitlink::JITLinkMemoryManager> MemMgr) {
46*da58b97aSjoerg auto PageSize = sys::Process::getPageSize();
47*da58b97aSjoerg if (!PageSize)
48*da58b97aSjoerg return PageSize.takeError();
49*da58b97aSjoerg
50*da58b97aSjoerg Triple TT(sys::getProcessTriple());
51*da58b97aSjoerg
52*da58b97aSjoerg return std::make_unique<SelfTargetProcessControl>(
53*da58b97aSjoerg std::move(SSP), std::move(TT), *PageSize, std::move(MemMgr));
54*da58b97aSjoerg }
55*da58b97aSjoerg
56*da58b97aSjoerg Expected<tpctypes::DylibHandle>
loadDylib(const char * DylibPath)57*da58b97aSjoerg SelfTargetProcessControl::loadDylib(const char *DylibPath) {
58*da58b97aSjoerg std::string ErrMsg;
59*da58b97aSjoerg auto Dylib = std::make_unique<sys::DynamicLibrary>(
60*da58b97aSjoerg sys::DynamicLibrary::getPermanentLibrary(DylibPath, &ErrMsg));
61*da58b97aSjoerg if (!Dylib->isValid())
62*da58b97aSjoerg return make_error<StringError>(std::move(ErrMsg), inconvertibleErrorCode());
63*da58b97aSjoerg DynamicLibraries.push_back(std::move(Dylib));
64*da58b97aSjoerg return pointerToJITTargetAddress(DynamicLibraries.back().get());
65*da58b97aSjoerg }
66*da58b97aSjoerg
67*da58b97aSjoerg Expected<std::vector<tpctypes::LookupResult>>
lookupSymbols(ArrayRef<LookupRequest> Request)68*da58b97aSjoerg SelfTargetProcessControl::lookupSymbols(ArrayRef<LookupRequest> Request) {
69*da58b97aSjoerg std::vector<tpctypes::LookupResult> R;
70*da58b97aSjoerg
71*da58b97aSjoerg for (auto &Elem : Request) {
72*da58b97aSjoerg auto *Dylib = jitTargetAddressToPointer<sys::DynamicLibrary *>(Elem.Handle);
73*da58b97aSjoerg assert(llvm::any_of(DynamicLibraries,
74*da58b97aSjoerg [=](const std::unique_ptr<sys::DynamicLibrary> &DL) {
75*da58b97aSjoerg return DL.get() == Dylib;
76*da58b97aSjoerg }) &&
77*da58b97aSjoerg "Invalid handle");
78*da58b97aSjoerg
79*da58b97aSjoerg R.push_back(std::vector<JITTargetAddress>());
80*da58b97aSjoerg for (auto &KV : Elem.Symbols) {
81*da58b97aSjoerg auto &Sym = KV.first;
82*da58b97aSjoerg std::string Tmp((*Sym).data() + !!GlobalManglingPrefix,
83*da58b97aSjoerg (*Sym).size() - !!GlobalManglingPrefix);
84*da58b97aSjoerg void *Addr = Dylib->getAddressOfSymbol(Tmp.c_str());
85*da58b97aSjoerg if (!Addr && KV.second == SymbolLookupFlags::RequiredSymbol) {
86*da58b97aSjoerg // FIXME: Collect all failing symbols before erroring out.
87*da58b97aSjoerg SymbolNameVector MissingSymbols;
88*da58b97aSjoerg MissingSymbols.push_back(Sym);
89*da58b97aSjoerg return make_error<SymbolsNotFound>(std::move(MissingSymbols));
90*da58b97aSjoerg }
91*da58b97aSjoerg R.back().push_back(pointerToJITTargetAddress(Addr));
92*da58b97aSjoerg }
93*da58b97aSjoerg }
94*da58b97aSjoerg
95*da58b97aSjoerg return R;
96*da58b97aSjoerg }
97*da58b97aSjoerg
98*da58b97aSjoerg Expected<int32_t>
runAsMain(JITTargetAddress MainFnAddr,ArrayRef<std::string> Args)99*da58b97aSjoerg SelfTargetProcessControl::runAsMain(JITTargetAddress MainFnAddr,
100*da58b97aSjoerg ArrayRef<std::string> Args) {
101*da58b97aSjoerg using MainTy = int (*)(int, char *[]);
102*da58b97aSjoerg return orc::runAsMain(jitTargetAddressToFunction<MainTy>(MainFnAddr), Args);
103*da58b97aSjoerg }
104*da58b97aSjoerg
105*da58b97aSjoerg Expected<tpctypes::WrapperFunctionResult>
runWrapper(JITTargetAddress WrapperFnAddr,ArrayRef<uint8_t> ArgBuffer)106*da58b97aSjoerg SelfTargetProcessControl::runWrapper(JITTargetAddress WrapperFnAddr,
107*da58b97aSjoerg ArrayRef<uint8_t> ArgBuffer) {
108*da58b97aSjoerg using WrapperFnTy =
109*da58b97aSjoerg tpctypes::CWrapperFunctionResult (*)(const uint8_t *Data, uint64_t Size);
110*da58b97aSjoerg auto *WrapperFn = jitTargetAddressToFunction<WrapperFnTy>(WrapperFnAddr);
111*da58b97aSjoerg return WrapperFn(ArgBuffer.data(), ArgBuffer.size());
112*da58b97aSjoerg }
113*da58b97aSjoerg
disconnect()114*da58b97aSjoerg Error SelfTargetProcessControl::disconnect() { return Error::success(); }
115*da58b97aSjoerg
writeUInt8s(ArrayRef<tpctypes::UInt8Write> Ws,WriteResultFn OnWriteComplete)116*da58b97aSjoerg void SelfTargetProcessControl::writeUInt8s(ArrayRef<tpctypes::UInt8Write> Ws,
117*da58b97aSjoerg WriteResultFn OnWriteComplete) {
118*da58b97aSjoerg for (auto &W : Ws)
119*da58b97aSjoerg *jitTargetAddressToPointer<uint8_t *>(W.Address) = W.Value;
120*da58b97aSjoerg OnWriteComplete(Error::success());
121*da58b97aSjoerg }
122*da58b97aSjoerg
writeUInt16s(ArrayRef<tpctypes::UInt16Write> Ws,WriteResultFn OnWriteComplete)123*da58b97aSjoerg void SelfTargetProcessControl::writeUInt16s(ArrayRef<tpctypes::UInt16Write> Ws,
124*da58b97aSjoerg WriteResultFn OnWriteComplete) {
125*da58b97aSjoerg for (auto &W : Ws)
126*da58b97aSjoerg *jitTargetAddressToPointer<uint16_t *>(W.Address) = W.Value;
127*da58b97aSjoerg OnWriteComplete(Error::success());
128*da58b97aSjoerg }
129*da58b97aSjoerg
writeUInt32s(ArrayRef<tpctypes::UInt32Write> Ws,WriteResultFn OnWriteComplete)130*da58b97aSjoerg void SelfTargetProcessControl::writeUInt32s(ArrayRef<tpctypes::UInt32Write> Ws,
131*da58b97aSjoerg WriteResultFn OnWriteComplete) {
132*da58b97aSjoerg for (auto &W : Ws)
133*da58b97aSjoerg *jitTargetAddressToPointer<uint32_t *>(W.Address) = W.Value;
134*da58b97aSjoerg OnWriteComplete(Error::success());
135*da58b97aSjoerg }
136*da58b97aSjoerg
writeUInt64s(ArrayRef<tpctypes::UInt64Write> Ws,WriteResultFn OnWriteComplete)137*da58b97aSjoerg void SelfTargetProcessControl::writeUInt64s(ArrayRef<tpctypes::UInt64Write> Ws,
138*da58b97aSjoerg WriteResultFn OnWriteComplete) {
139*da58b97aSjoerg for (auto &W : Ws)
140*da58b97aSjoerg *jitTargetAddressToPointer<uint64_t *>(W.Address) = W.Value;
141*da58b97aSjoerg OnWriteComplete(Error::success());
142*da58b97aSjoerg }
143*da58b97aSjoerg
writeBuffers(ArrayRef<tpctypes::BufferWrite> Ws,WriteResultFn OnWriteComplete)144*da58b97aSjoerg void SelfTargetProcessControl::writeBuffers(ArrayRef<tpctypes::BufferWrite> Ws,
145*da58b97aSjoerg WriteResultFn OnWriteComplete) {
146*da58b97aSjoerg for (auto &W : Ws)
147*da58b97aSjoerg memcpy(jitTargetAddressToPointer<char *>(W.Address), W.Buffer.data(),
148*da58b97aSjoerg W.Buffer.size());
149*da58b97aSjoerg OnWriteComplete(Error::success());
150*da58b97aSjoerg }
151*da58b97aSjoerg
152*da58b97aSjoerg } // end namespace orc
153*da58b97aSjoerg } // end namespace llvm
154