lib/ExecutionEngine/Orc/OrcMCJITReplacement.h

   1 //===---- OrcMCJITReplacement.h - Orc based MCJIT replacement ---*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Orc based MCJIT replacement.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_LIB_EXECUTIONENGINE_ORC_ORCMCJITREPLACEMENT_H
  15 #define LLVM_LIB_EXECUTIONENGINE_ORC_ORCMCJITREPLACEMENT_H
  16
  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"
  23
  24 namespace llvm {
  25 namespace orc {
  26
  27 class OrcMCJITReplacement : public ExecutionEngine {
  28
  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 {
  33   public:
  34     MCJITReplacementMemMgr(OrcMCJITReplacement &M,
  35                            std::shared_ptr<MCJITMemoryManager> ClientMM)
  36       : M(M), ClientMM(std::move(ClientMM)) {}
  37
  38     uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
  39                                  unsigned SectionID,
  40                                  StringRef SectionName) override {
  41       uint8_t *Addr =
  42           ClientMM->allocateCodeSection(Size, Alignment, SectionID,
  43                                         SectionName);
  44       M.SectionsAllocatedSinceLastLoad.insert(Addr);
  45       return Addr;
  46     }
  47
  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);
  54       return Addr;
  55     }
  56
  57     void reserveAllocationSpace(uintptr_t CodeSize, uint32_t CodeAlign,
  58                                 uintptr_t RODataSize, uint32_t RODataAlign,
  59                                 uintptr_t RWDataSize,
  60                                 uint32_t RWDataAlign) override {
  61       return ClientMM->reserveAllocationSpace(CodeSize, CodeAlign,
  62                                               RODataSize, RODataAlign,
  63                                               RWDataSize, RWDataAlign);
  64     }
  65
  66     bool needsToReserveAllocationSpace() override {
  67       return ClientMM->needsToReserveAllocationSpace();
  68     }
  69
  70     void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
  71                           size_t Size) override {
  72       return ClientMM->registerEHFrames(Addr, LoadAddr, Size);
  73     }
  74
  75     void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
  76                             size_t Size) override {
  77       return ClientMM->deregisterEHFrames(Addr, LoadAddr, Size);
  78     }
  79
  80     void notifyObjectLoaded(ExecutionEngine *EE,
  81                             const object::ObjectFile &O) override {
  82       return ClientMM->notifyObjectLoaded(EE, O);
  83     }
  84
  85     bool finalizeMemory(std::string *ErrMsg = nullptr) override {
  86       // Each set of objects loaded will be finalized exactly once, but since
  87       // symbol lookup during relocation may recursively trigger the
  88       // loading/relocation of other modules, and since we're forwarding all
  89       // finalizeMemory calls to a single underlying memory manager, we need to
  90       // defer forwarding the call on until all necessary objects have been
  91       // loaded. Otherwise, during the relocation of a leaf object, we will end
  92       // up finalizing memory, causing a crash further up the stack when we
  93       // attempt to apply relocations to finalized memory.
  94       // To avoid finalizing too early, look at how many objects have been
  95       // loaded but not yet finalized. This is a bit of a hack that relies on
  96       // the fact that we're lazily emitting object files: The only way you can
  97       // get more than one set of objects loaded but not yet finalized is if
  98       // they were loaded during relocation of another set.
  99       if (M.UnfinalizedSections.size() == 1)
 100         return ClientMM->finalizeMemory(ErrMsg);
 101       return false;
 102     }
 103
 104   private:
 105     OrcMCJITReplacement &M;
 106     std::shared_ptr<MCJITMemoryManager> ClientMM;
 107   };
 108
 109   class LinkingResolver : public RuntimeDyld::SymbolResolver {
 110   public:
 111     LinkingResolver(OrcMCJITReplacement &M) : M(M) {}
 112
 113     RuntimeDyld::SymbolInfo findSymbol(const std::string &Name) override {
 114       return M.findMangledSymbol(Name);
 115     }
 116
 117     RuntimeDyld::SymbolInfo
 118     findSymbolInLogicalDylib(const std::string &Name) override {
 119       return M.ClientResolver->findSymbolInLogicalDylib(Name);
 120     }
 121
 122   private:
 123     OrcMCJITReplacement &M;
 124   };
 125
 126 private:
 127
 128   static ExecutionEngine *
 129   createOrcMCJITReplacement(std::string *ErrorMsg,
 130                             std::shared_ptr<MCJITMemoryManager> MemMgr,
 131                             std::shared_ptr<RuntimeDyld::SymbolResolver> Resolver,
 132                             std::unique_ptr<TargetMachine> TM) {
 133     return new OrcMCJITReplacement(std::move(MemMgr), std::move(Resolver),
 134                                    std::move(TM));
 135   }
 136
 137 public:
 138   static void Register() {
 139     OrcMCJITReplacementCtor = createOrcMCJITReplacement;
 140   }
 141
 142   OrcMCJITReplacement(
 143       std::shared_ptr<MCJITMemoryManager> MemMgr,
 144       std::shared_ptr<RuntimeDyld::SymbolResolver> ClientResolver,
 145       std::unique_ptr<TargetMachine> TM)
 146       : ExecutionEngine(TM->createDataLayout()), TM(std::move(TM)),
 147         MemMgr(*this, std::move(MemMgr)), Resolver(*this),
 148         ClientResolver(std::move(ClientResolver)), NotifyObjectLoaded(*this),
 149         NotifyFinalized(*this),
 150         ObjectLayer(NotifyObjectLoaded, NotifyFinalized),
 151         CompileLayer(ObjectLayer, SimpleCompiler(*this->TM)),
 152         LazyEmitLayer(CompileLayer) {}
 153
 154   void addModule(std::unique_ptr<Module> M) override {
 155
 156     // If this module doesn't have a DataLayout attached then attach the
 157     // default.
 158     if (M->getDataLayout().isDefault()) {
 159       M->setDataLayout(getDataLayout());
 160     } else {
 161       assert(M->getDataLayout() == getDataLayout() && "DataLayout Mismatch");
 162     }
 163     Modules.push_back(std::move(M));
 164     std::vector<Module *> Ms;
 165     Ms.push_back(&*Modules.back());
 166     LazyEmitLayer.addModuleSet(std::move(Ms), &MemMgr, &Resolver);
 167   }
 168
 169   void addObjectFile(std::unique_ptr<object::ObjectFile> O) override {
 170     std::vector<std::unique_ptr<object::ObjectFile>> Objs;
 171     Objs.push_back(std::move(O));
 172     ObjectLayer.addObjectSet(std::move(Objs), &MemMgr, &Resolver);
 173   }
 174
 175   void addObjectFile(object::OwningBinary<object::ObjectFile> O) override {
 176     std::unique_ptr<object::ObjectFile> Obj;
 177     std::unique_ptr<MemoryBuffer> Buf;
 178     std::tie(Obj, Buf) = O.takeBinary();
 179     std::vector<std::unique_ptr<object::ObjectFile>> Objs;
 180     Objs.push_back(std::move(Obj));
 181     ObjectLayer.addObjectSet(std::move(Objs), &MemMgr, &Resolver);
 182   }
 183
 184   void addArchive(object::OwningBinary<object::Archive> A) override {
 185     Archives.push_back(std::move(A));
 186   }
 187
 188   uint64_t getSymbolAddress(StringRef Name) {
 189     return findSymbol(Name).getAddress();
 190   }
 191
 192   RuntimeDyld::SymbolInfo findSymbol(StringRef Name) {
 193     return findMangledSymbol(Mangle(Name));
 194   }
 195
 196   void finalizeObject() override {
 197     // This is deprecated - Aim to remove in ExecutionEngine.
 198     // REMOVE IF POSSIBLE - Doesn't make sense for New JIT.
 199   }
 200
 201   void mapSectionAddress(const void *LocalAddress,
 202                          uint64_t TargetAddress) override {
 203     for (auto &P : UnfinalizedSections)
 204       if (P.second.count(LocalAddress))
 205         ObjectLayer.mapSectionAddress(P.first, LocalAddress, TargetAddress);
 206   }
 207
 208   uint64_t getGlobalValueAddress(const std::string &Name) override {
 209     return getSymbolAddress(Name);
 210   }
 211
 212   uint64_t getFunctionAddress(const std::string &Name) override {
 213     return getSymbolAddress(Name);
 214   }
 215
 216   void *getPointerToFunction(Function *F) override {
 217     uint64_t FAddr = getSymbolAddress(F->getName());
 218     return reinterpret_cast<void *>(static_cast<uintptr_t>(FAddr));
 219   }
 220
 221   void *getPointerToNamedFunction(StringRef Name,
 222                                   bool AbortOnFailure = true) override {
 223     uint64_t Addr = getSymbolAddress(Name);
 224     if (!Addr && AbortOnFailure)
 225       llvm_unreachable("Missing symbol!");
 226     return reinterpret_cast<void *>(static_cast<uintptr_t>(Addr));
 227   }
 228
 229   GenericValue runFunction(Function *F,
 230                            ArrayRef<GenericValue> ArgValues) override;
 231
 232   void setObjectCache(ObjectCache *NewCache) override {
 233     CompileLayer.setObjectCache(NewCache);
 234   }
 235
 236   void setProcessAllSections(bool ProcessAllSections) override {
 237     ObjectLayer.setProcessAllSections(ProcessAllSections);
 238   }
 239
 240 private:
 241
 242   RuntimeDyld::SymbolInfo findMangledSymbol(StringRef Name) {
 243     if (auto Sym = LazyEmitLayer.findSymbol(Name, false))
 244       return RuntimeDyld::SymbolInfo(Sym.getAddress(), Sym.getFlags());
 245     if (auto Sym = ClientResolver->findSymbol(Name))
 246       return RuntimeDyld::SymbolInfo(Sym.getAddress(), Sym.getFlags());
 247     if (auto Sym = scanArchives(Name))
 248       return RuntimeDyld::SymbolInfo(Sym.getAddress(), Sym.getFlags());
 249
 250     return nullptr;
 251   }
 252
 253   JITSymbol scanArchives(StringRef Name) {
 254     for (object::OwningBinary<object::Archive> &OB : Archives) {
 255       object::Archive *A = OB.getBinary();
 256       // Look for our symbols in each Archive
 257       object::Archive::child_iterator ChildIt = A->findSym(Name);
 258       if (std::error_code EC = ChildIt->getError())
 259         report_fatal_error(EC.message());
 260       if (ChildIt != A->child_end()) {
 261         // FIXME: Support nested archives?
 262         ErrorOr<std::unique_ptr<object::Binary>> ChildBinOrErr =
 263             (*ChildIt)->getAsBinary();
 264         if (ChildBinOrErr.getError())
 265           continue;
 266         std::unique_ptr<object::Binary> &ChildBin = ChildBinOrErr.get();
 267         if (ChildBin->isObject()) {
 268           std::vector<std::unique_ptr<object::ObjectFile>> ObjSet;
 269           ObjSet.push_back(std::unique_ptr<object::ObjectFile>(
 270               static_cast<object::ObjectFile *>(ChildBin.release())));
 271           ObjectLayer.addObjectSet(std::move(ObjSet), &MemMgr, &Resolver);
 272           if (auto Sym = ObjectLayer.findSymbol(Name, true))
 273             return Sym;
 274         }
 275       }
 276     }
 277     return nullptr;
 278   }
 279
 280   class NotifyObjectLoadedT {
 281   public:
 282     typedef std::vector<std::unique_ptr<object::ObjectFile>> ObjListT;
 283     typedef std::vector<std::unique_ptr<RuntimeDyld::LoadedObjectInfo>>
 284         LoadedObjInfoListT;
 285
 286     NotifyObjectLoadedT(OrcMCJITReplacement &M) : M(M) {}
 287
 288     void operator()(ObjectLinkingLayerBase::ObjSetHandleT H,
 289                     const ObjListT &Objects,
 290                     const LoadedObjInfoListT &Infos) const {
 291       M.UnfinalizedSections[H] = std::move(M.SectionsAllocatedSinceLastLoad);
 292       M.SectionsAllocatedSinceLastLoad = SectionAddrSet();
 293       assert(Objects.size() == Infos.size() &&
 294              "Incorrect number of Infos for Objects.");
 295       for (unsigned I = 0; I < Objects.size(); ++I)
 296         M.MemMgr.notifyObjectLoaded(&M, *Objects[I]);
 297     }
 298
 299   private:
 300     OrcMCJITReplacement &M;
 301   };
 302
 303   class NotifyFinalizedT {
 304   public:
 305     NotifyFinalizedT(OrcMCJITReplacement &M) : M(M) {}
 306     void operator()(ObjectLinkingLayerBase::ObjSetHandleT H) {
 307       M.UnfinalizedSections.erase(H);
 308     }
 309
 310   private:
 311     OrcMCJITReplacement &M;
 312   };
 313
 314   std::string Mangle(StringRef Name) {
 315     std::string MangledName;
 316     {
 317       raw_string_ostream MangledNameStream(MangledName);
 318       Mang.getNameWithPrefix(MangledNameStream, Name, getDataLayout());
 319     }
 320     return MangledName;
 321   }
 322
 323   typedef ObjectLinkingLayer<NotifyObjectLoadedT> ObjectLayerT;
 324   typedef IRCompileLayer<ObjectLayerT> CompileLayerT;
 325   typedef LazyEmittingLayer<CompileLayerT> LazyEmitLayerT;
 326
 327   std::unique_ptr<TargetMachine> TM;
 328   MCJITReplacementMemMgr MemMgr;
 329   LinkingResolver Resolver;
 330   std::shared_ptr<RuntimeDyld::SymbolResolver> ClientResolver;
 331   Mangler Mang;
 332
 333   NotifyObjectLoadedT NotifyObjectLoaded;
 334   NotifyFinalizedT NotifyFinalized;
 335
 336   ObjectLayerT ObjectLayer;
 337   CompileLayerT CompileLayer;
 338   LazyEmitLayerT LazyEmitLayer;
 339
 340   // We need to store ObjLayerT::ObjSetHandles for each of the object sets
 341   // that have been emitted but not yet finalized so that we can forward the
 342   // mapSectionAddress calls appropriately.
 343   typedef std::set<const void *> SectionAddrSet;
 344   struct ObjSetHandleCompare {
 345     bool operator()(ObjectLayerT::ObjSetHandleT H1,
 346                     ObjectLayerT::ObjSetHandleT H2) const {
 347       return &*H1 < &*H2;
 348     }
 349   };
 350   SectionAddrSet SectionsAllocatedSinceLastLoad;
 351   std::map<ObjectLayerT::ObjSetHandleT, SectionAddrSet, ObjSetHandleCompare>
 352       UnfinalizedSections;
 353
 354   std::vector<object::OwningBinary<object::Archive>> Archives;
 355 };
 356
 357 } // End namespace orc.
 358 } // End namespace llvm.
 359
 360 #endif // LLVM_LIB_EXECUTIONENGINE_ORC_MCJITREPLACEMENT_H