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