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, uint32_t CodeAlign,
58 uintptr_t RODataSize, uint32_t RODataAlign,
60 uint32_t RWDataAlign) override {
61 return ClientMM->reserveAllocationSpace(CodeSize, CodeAlign,
62 RODataSize, RODataAlign,
63 RWDataSize, RWDataAlign);
66 bool needsToReserveAllocationSpace() override {
67 return ClientMM->needsToReserveAllocationSpace();
70 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
71 size_t Size) override {
72 return ClientMM->registerEHFrames(Addr, LoadAddr, Size);
75 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
76 size_t Size) override {
77 return ClientMM->deregisterEHFrames(Addr, LoadAddr, Size);
80 void notifyObjectLoaded(RuntimeDyld &RTDyld,
81 const object::ObjectFile &O) override {
82 return ClientMM->notifyObjectLoaded(RTDyld, O);
85 void notifyObjectLoaded(ExecutionEngine *EE,
86 const object::ObjectFile &O) override {
87 return ClientMM->notifyObjectLoaded(EE, O);
90 bool finalizeMemory(std::string *ErrMsg = nullptr) override {
91 // Each set of objects loaded will be finalized exactly once, but since
92 // symbol lookup during relocation may recursively trigger the
93 // loading/relocation of other modules, and since we're forwarding all
94 // finalizeMemory calls to a single underlying memory manager, we need to
95 // defer forwarding the call on until all necessary objects have been
96 // loaded. Otherwise, during the relocation of a leaf object, we will end
97 // up finalizing memory, causing a crash further up the stack when we
98 // attempt to apply relocations to finalized memory.
99 // To avoid finalizing too early, look at how many objects have been
100 // loaded but not yet finalized. This is a bit of a hack that relies on
101 // the fact that we're lazily emitting object files: The only way you can
102 // get more than one set of objects loaded but not yet finalized is if
103 // they were loaded during relocation of another set.
104 if (M.UnfinalizedSections.size() == 1)
105 return ClientMM->finalizeMemory(ErrMsg);
110 OrcMCJITReplacement &M;
111 std::shared_ptr<MCJITMemoryManager> ClientMM;
114 class LinkingResolver : public RuntimeDyld::SymbolResolver {
116 LinkingResolver(OrcMCJITReplacement &M) : M(M) {}
118 RuntimeDyld::SymbolInfo findSymbol(const std::string &Name) override {
119 return M.findMangledSymbol(Name);
122 RuntimeDyld::SymbolInfo
123 findSymbolInLogicalDylib(const std::string &Name) override {
124 return M.ClientResolver->findSymbol(Name);
128 OrcMCJITReplacement &M;
133 static ExecutionEngine *
134 createOrcMCJITReplacement(std::string *ErrorMsg,
135 std::shared_ptr<MCJITMemoryManager> MemMgr,
136 std::shared_ptr<RuntimeDyld::SymbolResolver> Resolver,
137 std::unique_ptr<TargetMachine> TM) {
138 return new OrcMCJITReplacement(std::move(MemMgr), std::move(Resolver),
143 static void Register() {
144 OrcMCJITReplacementCtor = createOrcMCJITReplacement;
148 std::shared_ptr<MCJITMemoryManager> MemMgr,
149 std::shared_ptr<RuntimeDyld::SymbolResolver> ClientResolver,
150 std::unique_ptr<TargetMachine> TM)
151 : ExecutionEngine(TM->createDataLayout()), TM(std::move(TM)),
152 MemMgr(*this, std::move(MemMgr)), Resolver(*this),
153 ClientResolver(std::move(ClientResolver)), NotifyObjectLoaded(*this),
154 NotifyFinalized(*this),
155 ObjectLayer(NotifyObjectLoaded, NotifyFinalized),
156 CompileLayer(ObjectLayer, SimpleCompiler(*this->TM)),
157 LazyEmitLayer(CompileLayer) {}
159 void addModule(std::unique_ptr<Module> M) override {
161 // If this module doesn't have a DataLayout attached then attach the
163 if (M->getDataLayout().isDefault()) {
164 M->setDataLayout(getDataLayout());
166 assert(M->getDataLayout() == getDataLayout() && "DataLayout Mismatch");
168 Modules.push_back(std::move(M));
169 std::vector<Module *> Ms;
170 Ms.push_back(&*Modules.back());
171 LazyEmitLayer.addModuleSet(std::move(Ms), &MemMgr, &Resolver);
174 void addObjectFile(std::unique_ptr<object::ObjectFile> O) override {
175 std::vector<std::unique_ptr<object::ObjectFile>> Objs;
176 Objs.push_back(std::move(O));
177 ObjectLayer.addObjectSet(std::move(Objs), &MemMgr, &Resolver);
180 void addObjectFile(object::OwningBinary<object::ObjectFile> O) override {
181 std::vector<std::unique_ptr<object::OwningBinary<object::ObjectFile>>> Objs;
183 llvm::make_unique<object::OwningBinary<object::ObjectFile>>(
185 ObjectLayer.addObjectSet(std::move(Objs), &MemMgr, &Resolver);
188 void addArchive(object::OwningBinary<object::Archive> A) override {
189 Archives.push_back(std::move(A));
192 uint64_t getSymbolAddress(StringRef Name) {
193 return findSymbol(Name).getAddress();
196 RuntimeDyld::SymbolInfo findSymbol(StringRef Name) {
197 return findMangledSymbol(Mangle(Name));
200 void finalizeObject() override {
201 // This is deprecated - Aim to remove in ExecutionEngine.
202 // REMOVE IF POSSIBLE - Doesn't make sense for New JIT.
205 void mapSectionAddress(const void *LocalAddress,
206 uint64_t TargetAddress) override {
207 for (auto &P : UnfinalizedSections)
208 if (P.second.count(LocalAddress))
209 ObjectLayer.mapSectionAddress(P.first, LocalAddress, TargetAddress);
212 uint64_t getGlobalValueAddress(const std::string &Name) override {
213 return getSymbolAddress(Name);
216 uint64_t getFunctionAddress(const std::string &Name) override {
217 return getSymbolAddress(Name);
220 void *getPointerToFunction(Function *F) override {
221 uint64_t FAddr = getSymbolAddress(F->getName());
222 return reinterpret_cast<void *>(static_cast<uintptr_t>(FAddr));
225 void *getPointerToNamedFunction(StringRef Name,
226 bool AbortOnFailure = true) override {
227 uint64_t Addr = getSymbolAddress(Name);
228 if (!Addr && AbortOnFailure)
229 llvm_unreachable("Missing symbol!");
230 return reinterpret_cast<void *>(static_cast<uintptr_t>(Addr));
233 GenericValue runFunction(Function *F,
234 ArrayRef<GenericValue> ArgValues) override;
236 void setObjectCache(ObjectCache *NewCache) override {
237 CompileLayer.setObjectCache(NewCache);
240 void setProcessAllSections(bool ProcessAllSections) override {
241 ObjectLayer.setProcessAllSections(ProcessAllSections);
246 RuntimeDyld::SymbolInfo findMangledSymbol(StringRef Name) {
247 if (auto Sym = LazyEmitLayer.findSymbol(Name, false))
248 return Sym.toRuntimeDyldSymbol();
249 if (auto Sym = ClientResolver->findSymbol(Name))
251 if (auto Sym = scanArchives(Name))
252 return Sym.toRuntimeDyldSymbol();
257 JITSymbol scanArchives(StringRef Name) {
258 for (object::OwningBinary<object::Archive> &OB : Archives) {
259 object::Archive *A = OB.getBinary();
260 // Look for our symbols in each Archive
261 auto OptionalChildOrErr = A->findSym(Name);
262 if (!OptionalChildOrErr)
263 report_fatal_error(OptionalChildOrErr.takeError());
264 auto &OptionalChild = *OptionalChildOrErr;
266 // FIXME: Support nested archives?
267 Expected<std::unique_ptr<object::Binary>> ChildBinOrErr =
268 OptionalChild->getAsBinary();
269 if (!ChildBinOrErr) {
270 // TODO: Actually report errors helpfully.
271 consumeError(ChildBinOrErr.takeError());
274 std::unique_ptr<object::Binary> &ChildBin = ChildBinOrErr.get();
275 if (ChildBin->isObject()) {
276 std::vector<std::unique_ptr<object::ObjectFile>> ObjSet;
277 ObjSet.push_back(std::unique_ptr<object::ObjectFile>(
278 static_cast<object::ObjectFile *>(ChildBin.release())));
279 ObjectLayer.addObjectSet(std::move(ObjSet), &MemMgr, &Resolver);
280 if (auto Sym = ObjectLayer.findSymbol(Name, true))
288 class NotifyObjectLoadedT {
290 typedef std::vector<std::unique_ptr<RuntimeDyld::LoadedObjectInfo>>
293 NotifyObjectLoadedT(OrcMCJITReplacement &M) : M(M) {}
295 template <typename ObjListT>
296 void operator()(ObjectLinkingLayerBase::ObjSetHandleT H,
297 const ObjListT &Objects,
298 const LoadedObjInfoListT &Infos) const {
299 M.UnfinalizedSections[H] = std::move(M.SectionsAllocatedSinceLastLoad);
300 M.SectionsAllocatedSinceLastLoad = SectionAddrSet();
301 assert(Objects.size() == Infos.size() &&
302 "Incorrect number of Infos for Objects.");
303 for (unsigned I = 0; I < Objects.size(); ++I)
304 M.MemMgr.notifyObjectLoaded(&M, getObject(*Objects[I]));
309 static const object::ObjectFile& getObject(const object::ObjectFile &Obj) {
313 template <typename ObjT>
314 static const object::ObjectFile&
315 getObject(const object::OwningBinary<ObjT> &Obj) {
316 return *Obj.getBinary();
319 OrcMCJITReplacement &M;
322 class NotifyFinalizedT {
324 NotifyFinalizedT(OrcMCJITReplacement &M) : M(M) {}
325 void operator()(ObjectLinkingLayerBase::ObjSetHandleT H) {
326 M.UnfinalizedSections.erase(H);
330 OrcMCJITReplacement &M;
333 std::string Mangle(StringRef Name) {
334 std::string MangledName;
336 raw_string_ostream MangledNameStream(MangledName);
337 Mang.getNameWithPrefix(MangledNameStream, Name, getDataLayout());
342 typedef ObjectLinkingLayer<NotifyObjectLoadedT> ObjectLayerT;
343 typedef IRCompileLayer<ObjectLayerT> CompileLayerT;
344 typedef LazyEmittingLayer<CompileLayerT> LazyEmitLayerT;
346 std::unique_ptr<TargetMachine> TM;
347 MCJITReplacementMemMgr MemMgr;
348 LinkingResolver Resolver;
349 std::shared_ptr<RuntimeDyld::SymbolResolver> ClientResolver;
352 NotifyObjectLoadedT NotifyObjectLoaded;
353 NotifyFinalizedT NotifyFinalized;
355 ObjectLayerT ObjectLayer;
356 CompileLayerT CompileLayer;
357 LazyEmitLayerT LazyEmitLayer;
359 // We need to store ObjLayerT::ObjSetHandles for each of the object sets
360 // that have been emitted but not yet finalized so that we can forward the
361 // mapSectionAddress calls appropriately.
362 typedef std::set<const void *> SectionAddrSet;
363 struct ObjSetHandleCompare {
364 bool operator()(ObjectLayerT::ObjSetHandleT H1,
365 ObjectLayerT::ObjSetHandleT H2) const {
369 SectionAddrSet SectionsAllocatedSinceLastLoad;
370 std::map<ObjectLayerT::ObjSetHandleT, SectionAddrSet, ObjSetHandleCompare>
373 std::vector<object::OwningBinary<object::Archive>> Archives;
376 } // End namespace orc.
377 } // End namespace llvm.
379 #endif // LLVM_LIB_EXECUTIONENGINE_ORC_MCJITREPLACEMENT_H