Add new ExecutionEngine::getGlobalValueAtAddress method, which can efficiently
[oota-llvm.git] / lib / ExecutionEngine / ExecutionEngine.cpp
index dbcaf63cdee879b9f2fb142d6447d71270fd3d90..76ba2284306414437452b62e3c93395a4a09b112 100644 (file)
@@ -1,4 +1,11 @@
-//===-- ExecutionEngine.cpp - Common Implementation shared by EE's --------===//
+//===-- ExecutionEngine.cpp - Common Implementation shared by EEs ---------===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 // 
 // This file defines the common interface used by the various execution engine
 // subclasses.
 //===----------------------------------------------------------------------===//
 
 #define DEBUG_TYPE "jit"
-#include "ExecutionEngine.h"
-#include "GenericValue.h"
-#include "llvm/DerivedTypes.h"
+#include "Interpreter/Interpreter.h"
+#include "JIT/JIT.h"
 #include "llvm/Constants.h"
+#include "llvm/DerivedTypes.h"
+#include "llvm/IntrinsicLowering.h"
 #include "llvm/Module.h"
+#include "llvm/ModuleProvider.h"
+#include "llvm/ExecutionEngine/ExecutionEngine.h"
+#include "llvm/ExecutionEngine/GenericValue.h"
 #include "llvm/Target/TargetData.h"
 #include "Support/Debug.h"
 #include "Support/Statistic.h"
+#include "Support/DynamicLinker.h"
 #include "Config/dlfcn.h"
-#include "JIT/VM.h"
-#include "Interpreter/Interpreter.h"
+using namespace llvm;
 
-Statistic<> NumInitBytes("lli", "Number of bytes of global vars initialized");
+namespace {
+  Statistic<> NumInitBytes("lli", "Number of bytes of global vars initialized");
+  Statistic<> NumGlobals  ("lli", "Number of global vars initialized");
+}
+
+ExecutionEngine::ExecutionEngine(ModuleProvider *P) : 
+  CurMod(*P->getModule()), MP(P) {
+  assert(P && "ModuleProvider is null?");
+}
+
+ExecutionEngine::ExecutionEngine(Module *M) : CurMod(*M), MP(0) {
+  assert(M && "Module is null?");
+}
+
+ExecutionEngine::~ExecutionEngine() {
+  delete MP;
+}
 
-ExecutionEngine *ExecutionEngine::create (Module *M, bool ForceInterpreter,
-                                         bool TraceMode) {
+/// getGlobalValueAtAddress - Return the LLVM global value object that starts
+/// at the specified address.
+///
+const GlobalValue *ExecutionEngine::getGlobalValueAtAddress(void *Addr) {
+  // If we haven't computed the reverse mapping yet, do so first.
+  if (GlobalAddressReverseMap.empty()) {
+    for (std::map<const GlobalValue*, void *>::iterator I = 
+           GlobalAddressMap.begin(), E = GlobalAddressMap.end(); I != E; ++I)
+      GlobalAddressReverseMap.insert(std::make_pair(I->second, I->first));
+  }
+
+  std::map<void *, const GlobalValue*>::iterator I =
+    GlobalAddressReverseMap.find(Addr);
+  return I != GlobalAddressReverseMap.end() ? I->second : 0;
+}
+
+// CreateArgv - Turn a vector of strings into a nice argv style array of
+// pointers to null terminated strings.
+//
+static void *CreateArgv(ExecutionEngine *EE,
+                        const std::vector<std::string> &InputArgv) {
+  unsigned PtrSize = EE->getTargetData().getPointerSize();
+  char *Result = new char[(InputArgv.size()+1)*PtrSize];
+
+  DEBUG(std::cerr << "ARGV = " << (void*)Result << "\n");
+  const Type *SBytePtr = PointerType::get(Type::SByteTy);
+
+  for (unsigned i = 0; i != InputArgv.size(); ++i) {
+    unsigned Size = InputArgv[i].size()+1;
+    char *Dest = new char[Size];
+    DEBUG(std::cerr << "ARGV[" << i << "] = " << (void*)Dest << "\n");
+      
+    std::copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
+    Dest[Size-1] = 0;
+      
+    // Endian safe: Result[i] = (PointerTy)Dest;
+    EE->StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i*PtrSize),
+                           SBytePtr);
+  }
+
+  // Null terminate it
+  EE->StoreValueToMemory(PTOGV(0),
+                         (GenericValue*)(Result+InputArgv.size()*PtrSize),
+                         SBytePtr);
+  return Result;
+}
+
+/// runFunctionAsMain - This is a helper function which wraps runFunction to
+/// handle the common task of starting up main with the specified argc, argv,
+/// and envp parameters.
+int ExecutionEngine::runFunctionAsMain(Function *Fn,
+                                       const std::vector<std::string> &argv,
+                                       const char * const * envp) {
+  std::vector<GenericValue> GVArgs;
+  GenericValue GVArgc;
+  GVArgc.IntVal = argv.size();
+  GVArgs.push_back(GVArgc); // Arg #0 = argc.
+  GVArgs.push_back(PTOGV(CreateArgv(this, argv))); // Arg #1 = argv.
+  assert(((char **)GVTOP(GVArgs[1]))[0] && "argv[0] was null after CreateArgv");
+
+  std::vector<std::string> EnvVars;
+  for (unsigned i = 0; envp[i]; ++i)
+    EnvVars.push_back(envp[i]);
+  GVArgs.push_back(PTOGV(CreateArgv(this, EnvVars))); // Arg #2 = envp.
+  return runFunction(Fn, GVArgs).IntVal;
+}
+
+
+
+/// If possible, create a JIT, unless the caller specifically requests an
+/// Interpreter or there's an error. If even an Interpreter cannot be created,
+/// NULL is returned. 
+///
+ExecutionEngine *ExecutionEngine::create(ModuleProvider *MP, 
+                                         bool ForceInterpreter,
+                                         IntrinsicLowering *IL) {
   ExecutionEngine *EE = 0;
 
-  // If there is nothing that is forcing us to use the interpreter, make a JIT.
-  if (!ForceInterpreter && !TraceMode)
-    EE = VM::create(M);
+  // Unless the interpreter was explicitly selected, try making a JIT.
+  if (!ForceInterpreter)
+    EE = JIT::create(MP, IL);
 
   // If we can't make a JIT, make an interpreter instead.
-  if (EE == 0)
-    EE = Interpreter::create(M, TraceMode);
+  try {
+    if (EE == 0)
+      EE = Interpreter::create(MP->materializeModule(), IL);
+  } catch (...) {
+    EE = 0;
+  }
+
+  if (EE == 0) delete IL;
   return EE;
 }
 
-// getPointerToGlobal - This returns the address of the specified global
-// value.  This may involve code generation if it's a function.
-//
+/// getPointerToGlobal - This returns the address of the specified global
+/// value.  This may involve code generation if it's a function.
+///
 void *ExecutionEngine::getPointerToGlobal(const GlobalValue *GV) {
   if (Function *F = const_cast<Function*>(dyn_cast<Function>(GV)))
     return getPointerToFunction(F);
 
-  assert(GlobalAddress[GV] && "Global hasn't had an address allocated yet?");
-  return GlobalAddress[GV];
+  assert(GlobalAddressMap[GV] && "Global hasn't had an address allocated yet?");
+  return GlobalAddressMap[GV];
 }
 
+/// FIXME: document
+/// 
 GenericValue ExecutionEngine::getConstantValue(const Constant *C) {
   GenericValue Result;
 
@@ -115,7 +224,12 @@ GenericValue ExecutionEngine::getConstantValue(const Constant *C) {
     if (isa<ConstantPointerNull>(C)) {
       Result.PointerVal = 0;
     } else if (const ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(C)){
-      Result = PTOGV(getPointerToGlobal(CPR->getValue()));
+      if (Function *F =
+          const_cast<Function*>(dyn_cast<Function>(CPR->getValue())))
+        Result = PTOGV(getPointerToFunctionOrStub(F));
+      else 
+        Result = PTOGV(getOrEmitGlobalVariable(
+                           cast<GlobalVariable>(CPR->getValue())));
 
     } else {
       assert(0 && "Unknown constant pointer type!");
@@ -128,8 +242,10 @@ GenericValue ExecutionEngine::getConstantValue(const Constant *C) {
   return Result;
 }
 
+/// FIXME: document
+///
 void ExecutionEngine::StoreValueToMemory(GenericValue Val, GenericValue *Ptr,
-                                    const Type *Ty) {
+                                         const Type *Ty) {
   if (getTargetData().isLittleEndian()) {
     switch (Ty->getPrimitiveID()) {
     case Type::BoolTyID:
@@ -199,6 +315,8 @@ void ExecutionEngine::StoreValueToMemory(GenericValue Val, GenericValue *Ptr,
   }
 }
 
+/// FIXME: document
+///
 GenericValue ExecutionEngine::LoadValueFromMemory(GenericValue *Ptr,
                                                   const Type *Ty) {
   GenericValue Result;
@@ -312,45 +430,6 @@ void ExecutionEngine::InitializeMemory(const Constant *Init, void *Addr) {
   }
 }
 
-void *ExecutionEngine::CreateArgv(const std::vector<std::string> &InputArgv) {
-  if (getTargetData().getPointerSize() == 8) {   // 64 bit target?
-    PointerTy *Result = new PointerTy[InputArgv.size()+1];
-    DEBUG(std::cerr << "ARGV = " << (void*)Result << "\n");
-
-    for (unsigned i = 0; i < InputArgv.size(); ++i) {
-      unsigned Size = InputArgv[i].size()+1;
-      char *Dest = new char[Size];
-      DEBUG(std::cerr << "ARGV[" << i << "] = " << (void*)Dest << "\n");
-      
-      copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
-      Dest[Size-1] = 0;
-      
-      // Endian safe: Result[i] = (PointerTy)Dest;
-      StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i), Type::LongTy);
-    }
-    Result[InputArgv.size()] = 0;
-    return Result;
-
-  } else {                                      // 32 bit target?
-    int *Result = new int[InputArgv.size()+1];
-    DEBUG(std::cerr << "ARGV = " << (void*)Result << "\n");
-
-    for (unsigned i = 0; i < InputArgv.size(); ++i) {
-      unsigned Size = InputArgv[i].size()+1;
-      char *Dest = new char[Size];
-      DEBUG(std::cerr << "ARGV[" << i << "] = " << (void*)Dest << "\n");
-      
-      copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
-      Dest[Size-1] = 0;
-      
-      // Endian safe: Result[i] = (PointerTy)Dest;
-      StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i), Type::IntTy);
-    }
-    Result[InputArgv.size()] = 0;  // null terminate it
-    return Result;
-  }
-}
-
 /// EmitGlobals - Emit all of the global variables to memory, storing their
 /// addresses into GlobalAddress.  This must make sure to copy the contents of
 /// their initializers into the memory.
@@ -368,21 +447,15 @@ void ExecutionEngine::emitGlobals() {
       
       // Allocate some memory for it!
       unsigned Size = TD.getTypeSize(Ty);
-      GlobalAddress[I] = new char[Size];
-      NumInitBytes += Size;
+      addGlobalMapping(I, new char[Size]);
 
       DEBUG(std::cerr << "Global '" << I->getName() << "' -> "
-                     << (void*)GlobalAddress[I] << "\n");
+                      << getPointerToGlobal(I) << "\n");
     } else {
-      // On Sparc, RTLD_SELF is already defined and it's not zero
-      // Linux/x86 wants to use a 0, other systems may differ
-#ifndef RTLD_SELF
-#define RTLD_SELF 0
-#endif
-      // External variable reference, try to use dlsym to get a pointer to it in
-      // the LLI image.
-      if (void *SymAddr = dlsym(RTLD_SELF, I->getName().c_str()))
-        GlobalAddress[I] = SymAddr;
+      // External variable reference. Try to use the dynamic loader to
+      // get a pointer to it.
+      if (void *SymAddr = GetAddressOfSymbol(I->getName().c_str()))
+        addGlobalMapping(I, SymAddr);
       else {
         std::cerr << "Could not resolve external global address: "
                   << I->getName() << "\n";
@@ -395,6 +468,22 @@ void ExecutionEngine::emitGlobals() {
   for (Module::giterator I = getModule().gbegin(), E = getModule().gend();
        I != E; ++I)
     if (!I->isExternal())
-      InitializeMemory(I->getInitializer(), GlobalAddress[I]);
+      EmitGlobalVariable(I);
 }
 
+// EmitGlobalVariable - This method emits the specified global variable to the
+// address specified in GlobalAddresses, or allocates new memory if it's not
+// already in the map.
+void ExecutionEngine::EmitGlobalVariable(const GlobalVariable *GV) {
+  void *GA = getPointerToGlobalIfAvailable(GV);
+  const Type *ElTy = GV->getType()->getElementType();
+  if (GA == 0) {
+    // If it's not already specified, allocate memory for the global.
+    GA = new char[getTargetData().getTypeSize(ElTy)];
+    addGlobalMapping(GV, GA);
+  }
+
+  InitializeMemory(GV->getInitializer(), GA);
+  NumInitBytes += getTargetData().getTypeSize(ElTy);
+  ++NumGlobals;
+}