1 //===---- OrcMCJITReplacement.h - Orc based MCJIT replacement ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Orc based MCJIT replacement.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_LIB_EXECUTIONENGINE_ORC_ORCMCJITREPLACEMENT_H
15 #define LLVM_LIB_EXECUTIONENGINE_ORC_ORCMCJITREPLACEMENT_H
17 #include "llvm/ExecutionEngine/ExecutionEngine.h"
18 #include "llvm/ExecutionEngine/Orc/CompileUtils.h"
19 #include "llvm/ExecutionEngine/Orc/IRCompileLayer.h"
20 #include "llvm/ExecutionEngine/Orc/LazyEmittingLayer.h"
21 #include "llvm/ExecutionEngine/Orc/ObjectLinkingLayer.h"
22 #include "llvm/Object/Archive.h"
27 class OrcMCJITReplacement : public ExecutionEngine {
29 // OrcMCJITReplacement needs to do a little extra book-keeping to ensure that
30 // Orc's automatic finalization doesn't kick in earlier than MCJIT clients are
31 // expecting - see finalizeMemory.
32 class MCJITReplacementMemMgr : public MCJITMemoryManager {
34 MCJITReplacementMemMgr(OrcMCJITReplacement &M,
35 std::shared_ptr<MCJITMemoryManager> ClientMM)
36 : M(M), ClientMM(std::move(ClientMM)) {}
38 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
40 StringRef SectionName) override {
42 ClientMM->allocateCodeSection(Size, Alignment, SectionID,
44 M.SectionsAllocatedSinceLastLoad.insert(Addr);
48 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
49 unsigned SectionID, StringRef SectionName,
50 bool IsReadOnly) override {
51 uint8_t *Addr = ClientMM->allocateDataSection(Size, Alignment, SectionID,
52 SectionName, IsReadOnly);
53 M.SectionsAllocatedSinceLastLoad.insert(Addr);
57 void reserveAllocationSpace(uintptr_t CodeSize, uintptr_t DataSizeRO,
58 uintptr_t DataSizeRW) override {
59 return ClientMM->reserveAllocationSpace(CodeSize, DataSizeRO,
63 bool needsToReserveAllocationSpace() override {
64 return ClientMM->needsToReserveAllocationSpace();
67 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
68 size_t Size) override {
69 return ClientMM->registerEHFrames(Addr, LoadAddr, Size);
72 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
73 size_t Size) override {
74 return ClientMM->deregisterEHFrames(Addr, LoadAddr, Size);
77 void notifyObjectLoaded(ExecutionEngine *EE,
78 const object::ObjectFile &O) override {
79 return ClientMM->notifyObjectLoaded(EE, O);
82 bool finalizeMemory(std::string *ErrMsg = nullptr) override {
83 // Each set of objects loaded will be finalized exactly once, but since
84 // symbol lookup during relocation may recursively trigger the
85 // loading/relocation of other modules, and since we're forwarding all
86 // finalizeMemory calls to a single underlying memory manager, we need to
87 // defer forwarding the call on until all necessary objects have been
88 // loaded. Otherwise, during the relocation of a leaf object, we will end
89 // up finalizing memory, causing a crash further up the stack when we
90 // attempt to apply relocations to finalized memory.
91 // To avoid finalizing too early, look at how many objects have been
92 // loaded but not yet finalized. This is a bit of a hack that relies on
93 // the fact that we're lazily emitting object files: The only way you can
94 // get more than one set of objects loaded but not yet finalized is if
95 // they were loaded during relocation of another set.
96 if (M.UnfinalizedSections.size() == 1)
97 return ClientMM->finalizeMemory(ErrMsg);
102 OrcMCJITReplacement &M;
103 std::shared_ptr<MCJITMemoryManager> ClientMM;
106 class LinkingResolver : public RuntimeDyld::SymbolResolver {
108 LinkingResolver(OrcMCJITReplacement &M) : M(M) {}
110 RuntimeDyld::SymbolInfo findSymbol(const std::string &Name) override {
111 return M.findMangledSymbol(Name);
114 RuntimeDyld::SymbolInfo
115 findSymbolInLogicalDylib(const std::string &Name) override {
116 return M.ClientResolver->findSymbolInLogicalDylib(Name);
120 OrcMCJITReplacement &M;
125 static ExecutionEngine *
126 createOrcMCJITReplacement(std::string *ErrorMsg,
127 std::shared_ptr<MCJITMemoryManager> MemMgr,
128 std::shared_ptr<RuntimeDyld::SymbolResolver> Resolver,
129 std::unique_ptr<TargetMachine> TM) {
130 return new OrcMCJITReplacement(std::move(MemMgr), std::move(Resolver),
135 static void Register() {
136 OrcMCJITReplacementCtor = createOrcMCJITReplacement;
140 std::shared_ptr<MCJITMemoryManager> MemMgr,
141 std::shared_ptr<RuntimeDyld::SymbolResolver> ClientResolver,
142 std::unique_ptr<TargetMachine> TM)
143 : TM(std::move(TM)), MemMgr(*this, std::move(MemMgr)),
144 Resolver(*this), ClientResolver(std::move(ClientResolver)),
145 NotifyObjectLoaded(*this), NotifyFinalized(*this),
146 ObjectLayer(NotifyObjectLoaded, NotifyFinalized),
147 CompileLayer(ObjectLayer, SimpleCompiler(*this->TM)),
148 LazyEmitLayer(CompileLayer) {
149 setDataLayout(this->TM->getDataLayout());
152 void addModule(std::unique_ptr<Module> M) override {
154 // If this module doesn't have a DataLayout attached then attach the
156 if (M->getDataLayout().isDefault())
157 M->setDataLayout(*getDataLayout());
159 Modules.push_back(std::move(M));
160 std::vector<Module *> Ms;
161 Ms.push_back(&*Modules.back());
162 LazyEmitLayer.addModuleSet(std::move(Ms), &MemMgr, &Resolver);
165 void addObjectFile(std::unique_ptr<object::ObjectFile> O) override {
166 std::vector<std::unique_ptr<object::ObjectFile>> Objs;
167 Objs.push_back(std::move(O));
168 ObjectLayer.addObjectSet(std::move(Objs), &MemMgr, &Resolver);
171 void addObjectFile(object::OwningBinary<object::ObjectFile> O) override {
172 std::unique_ptr<object::ObjectFile> Obj;
173 std::unique_ptr<MemoryBuffer> Buf;
174 std::tie(Obj, Buf) = O.takeBinary();
175 std::vector<std::unique_ptr<object::ObjectFile>> Objs;
176 Objs.push_back(std::move(Obj));
178 ObjectLayer.addObjectSet(std::move(Objs), &MemMgr, &Resolver);
180 std::vector<std::unique_ptr<MemoryBuffer>> Bufs;
181 Bufs.push_back(std::move(Buf));
182 ObjectLayer.takeOwnershipOfBuffers(H, std::move(Bufs));
185 void addArchive(object::OwningBinary<object::Archive> A) override {
186 Archives.push_back(std::move(A));
189 uint64_t getSymbolAddress(StringRef Name) {
190 return findSymbol(Name).getAddress();
193 RuntimeDyld::SymbolInfo findSymbol(StringRef Name) {
194 return findMangledSymbol(Mangle(Name));
197 void finalizeObject() override {
198 // This is deprecated - Aim to remove in ExecutionEngine.
199 // REMOVE IF POSSIBLE - Doesn't make sense for New JIT.
202 void mapSectionAddress(const void *LocalAddress,
203 uint64_t TargetAddress) override {
204 for (auto &P : UnfinalizedSections)
205 if (P.second.count(LocalAddress))
206 ObjectLayer.mapSectionAddress(P.first, LocalAddress, TargetAddress);
209 uint64_t getGlobalValueAddress(const std::string &Name) override {
210 return getSymbolAddress(Name);
213 uint64_t getFunctionAddress(const std::string &Name) override {
214 return getSymbolAddress(Name);
217 void *getPointerToFunction(Function *F) override {
218 uint64_t FAddr = getSymbolAddress(F->getName());
219 return reinterpret_cast<void *>(static_cast<uintptr_t>(FAddr));
222 void *getPointerToNamedFunction(StringRef Name,
223 bool AbortOnFailure = true) override {
224 uint64_t Addr = getSymbolAddress(Name);
225 if (!Addr && AbortOnFailure)
226 llvm_unreachable("Missing symbol!");
227 return reinterpret_cast<void *>(static_cast<uintptr_t>(Addr));
230 GenericValue runFunction(Function *F,
231 ArrayRef<GenericValue> ArgValues) override;
233 void setObjectCache(ObjectCache *NewCache) override {
234 CompileLayer.setObjectCache(NewCache);
239 RuntimeDyld::SymbolInfo findMangledSymbol(StringRef Name) {
240 if (auto Sym = LazyEmitLayer.findSymbol(Name, false))
241 return RuntimeDyld::SymbolInfo(Sym.getAddress(), Sym.getFlags());
242 if (auto Sym = ClientResolver->findSymbol(Name))
243 return RuntimeDyld::SymbolInfo(Sym.getAddress(), Sym.getFlags());
244 if (auto Sym = scanArchives(Name))
245 return RuntimeDyld::SymbolInfo(Sym.getAddress(), Sym.getFlags());
250 JITSymbol scanArchives(StringRef Name) {
251 for (object::OwningBinary<object::Archive> &OB : Archives) {
252 object::Archive *A = OB.getBinary();
253 // Look for our symbols in each Archive
254 object::Archive::child_iterator ChildIt = A->findSym(Name);
255 if (ChildIt != A->child_end()) {
256 // FIXME: Support nested archives?
257 ErrorOr<std::unique_ptr<object::Binary>> ChildBinOrErr =
258 ChildIt->getAsBinary();
259 if (ChildBinOrErr.getError())
261 std::unique_ptr<object::Binary> &ChildBin = ChildBinOrErr.get();
262 if (ChildBin->isObject()) {
263 std::vector<std::unique_ptr<object::ObjectFile>> ObjSet;
264 ObjSet.push_back(std::unique_ptr<object::ObjectFile>(
265 static_cast<object::ObjectFile *>(ChildBin.release())));
266 ObjectLayer.addObjectSet(std::move(ObjSet), &MemMgr, &Resolver);
267 if (auto Sym = ObjectLayer.findSymbol(Name, true))
275 class NotifyObjectLoadedT {
277 typedef std::vector<std::unique_ptr<object::ObjectFile>> ObjListT;
278 typedef std::vector<std::unique_ptr<RuntimeDyld::LoadedObjectInfo>>
281 NotifyObjectLoadedT(OrcMCJITReplacement &M) : M(M) {}
283 void operator()(ObjectLinkingLayerBase::ObjSetHandleT H,
284 const ObjListT &Objects,
285 const LoadedObjInfoListT &Infos) const {
286 M.UnfinalizedSections[H] = std::move(M.SectionsAllocatedSinceLastLoad);
287 M.SectionsAllocatedSinceLastLoad = SectionAddrSet();
288 assert(Objects.size() == Infos.size() &&
289 "Incorrect number of Infos for Objects.");
290 for (unsigned I = 0; I < Objects.size(); ++I)
291 M.MemMgr.notifyObjectLoaded(&M, *Objects[I]);
295 OrcMCJITReplacement &M;
298 class NotifyFinalizedT {
300 NotifyFinalizedT(OrcMCJITReplacement &M) : M(M) {}
301 void operator()(ObjectLinkingLayerBase::ObjSetHandleT H) {
302 M.UnfinalizedSections.erase(H);
306 OrcMCJITReplacement &M;
309 std::string Mangle(StringRef Name) {
310 std::string MangledName;
312 raw_string_ostream MangledNameStream(MangledName);
313 Mang.getNameWithPrefix(MangledNameStream, Name, *TM->getDataLayout());
318 typedef ObjectLinkingLayer<NotifyObjectLoadedT> ObjectLayerT;
319 typedef IRCompileLayer<ObjectLayerT> CompileLayerT;
320 typedef LazyEmittingLayer<CompileLayerT> LazyEmitLayerT;
322 std::unique_ptr<TargetMachine> TM;
323 MCJITReplacementMemMgr MemMgr;
324 LinkingResolver Resolver;
325 std::shared_ptr<RuntimeDyld::SymbolResolver> ClientResolver;
328 NotifyObjectLoadedT NotifyObjectLoaded;
329 NotifyFinalizedT NotifyFinalized;
331 ObjectLayerT ObjectLayer;
332 CompileLayerT CompileLayer;
333 LazyEmitLayerT LazyEmitLayer;
335 // We need to store ObjLayerT::ObjSetHandles for each of the object sets
336 // that have been emitted but not yet finalized so that we can forward the
337 // mapSectionAddress calls appropriately.
338 typedef std::set<const void *> SectionAddrSet;
339 struct ObjSetHandleCompare {
340 bool operator()(ObjectLayerT::ObjSetHandleT H1,
341 ObjectLayerT::ObjSetHandleT H2) const {
345 SectionAddrSet SectionsAllocatedSinceLastLoad;
346 std::map<ObjectLayerT::ObjSetHandleT, SectionAddrSet, ObjSetHandleCompare>
349 std::vector<object::OwningBinary<object::Archive>> Archives;
352 } // End namespace orc.
353 } // End namespace llvm.
355 #endif // LLVM_LIB_EXECUTIONENGINE_ORC_MCJITREPLACEMENT_H