DisableGVCompilation should not abort on internal GlobalValue's.
[oota-llvm.git] / include / llvm / ExecutionEngine / ExecutionEngine.h
index c2f8fed70dfe5ed8608273fe0b6aa368e3665c5d..327e9c6aa9290403ec6ff32b4b26b5bb0aa43ef9 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     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 is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
@@ -12,8 +12,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef EXECUTION_ENGINE_H
-#define EXECUTION_ENGINE_H
+#ifndef LLVM_EXECUTION_ENGINE_H
+#define LLVM_EXECUTION_ENGINE_H
 
 #include <vector>
 #include <map>
@@ -24,7 +24,7 @@
 
 namespace llvm {
 
-union GenericValue;
+struct GenericValue;
 class Constant;
 class Function;
 class GlobalVariable;
@@ -34,6 +34,7 @@ class ModuleProvider;
 class TargetData;
 class Type;
 class MutexGuard;
+class JITMemoryManager;
 
 class ExecutionEngineState {
 private:
@@ -49,12 +50,12 @@ private:
 
 public:
   std::map<const GlobalValue*, void *> &
-  getGlobalAddressMap(const MutexGuard &locked) {
+  getGlobalAddressMap(const MutexGuard &) {
     return GlobalAddressMap;
   }
 
   std::map<void*, const GlobalValue*> & 
-  getGlobalAddressReverseMap(const MutexGuard& locked) {
+  getGlobalAddressReverseMap(const MutexGuard &) {
     return GlobalAddressReverseMap;
   }
 };
@@ -64,6 +65,9 @@ class ExecutionEngine {
   const TargetData *TD;
   ExecutionEngineState state;
   bool LazyCompilationDisabled;
+  bool GVCompilationDisabled;
+  bool SymbolSearchingDisabled;
+
 protected:
   /// Modules - This is a list of ModuleProvider's that we are JIT'ing from.  We
   /// use a smallvector to optimize for the case where there is only one module.
@@ -72,42 +76,83 @@ protected:
   void setTargetData(const TargetData *td) {
     TD = td;
   }
+  
+  /// getMemoryforGV - Allocate memory for a global variable.
+  virtual char* getMemoryForGV(const GlobalVariable* GV);
 
   // To avoid having libexecutionengine depend on the JIT and interpreter
   // libraries, the JIT and Interpreter set these functions to ctor pointers
   // at startup time if they are linked in.
-  typedef ExecutionEngine *(*EECtorFn)(ModuleProvider*);
+  typedef ExecutionEngine *(*EECtorFn)(ModuleProvider*, std::string*,
+                                       bool Fast);
   static EECtorFn JITCtor, InterpCtor;
-    
+
+  /// LazyFunctionCreator - If an unknown function is needed, this function
+  /// pointer is invoked to create it. If this returns null, the JIT will abort.
+  void* (*LazyFunctionCreator)(const std::string &);
+  
+  /// ExceptionTableRegister - If Exception Handling is set, the JIT will 
+  /// register dwarf tables with this function
+  typedef void (*EERegisterFn)(void*);
+  static EERegisterFn ExceptionTableRegister;
+
 public:
   /// lock - This lock is protects the ExecutionEngine, JIT, JITResolver and
   /// JITEmitter classes.  It must be held while changing the internal state of
   /// any of those classes.
   sys::Mutex lock; // Used to make this class and subclasses thread-safe
 
-  ExecutionEngine(ModuleProvider *P);
-  ExecutionEngine(Module *M);
-  virtual ~ExecutionEngine();
+  //===--------------------------------------------------------------------===//
+  //  ExecutionEngine Startup
+  //===--------------------------------------------------------------------===//
 
-  const TargetData *getTargetData() const { return TD; }
+  virtual ~ExecutionEngine();
 
+  /// create - This is the factory method for creating an execution engine which
+  /// is appropriate for the current machine.  This takes ownership of the
+  /// module provider.
+  static ExecutionEngine *create(ModuleProvider *MP,
+                                 bool ForceInterpreter = false,
+                                 std::string *ErrorStr = 0,
+                                 bool Fast = false);
+  
+  /// create - This is the factory method for creating an execution engine which
+  /// is appropriate for the current machine.  This takes ownership of the
+  /// module.
+  static ExecutionEngine *create(Module *M);
+
+  /// createJIT - This is the factory method for creating a JIT for the current
+  /// machine, it does not fall back to the interpreter.  This takes ownership
+  /// of the ModuleProvider and JITMemoryManager if successful.
+  static ExecutionEngine *createJIT(ModuleProvider *MP,
+                                    std::string *ErrorStr = 0,
+                                    JITMemoryManager *JMM = 0,
+                                    bool Fast = false);
+  
+  
+  
   /// addModuleProvider - Add a ModuleProvider to the list of modules that we
   /// can JIT from.  Note that this takes ownership of the ModuleProvider: when
   /// the ExecutionEngine is destroyed, it destroys the MP as well.
-  void addModuleProvider(ModuleProvider *P) {
+  virtual void addModuleProvider(ModuleProvider *P) {
     Modules.push_back(P);
   }
   
+  //===----------------------------------------------------------------------===//
+
+  const TargetData *getTargetData() const { return TD; }
+
+
+  /// removeModuleProvider - Remove a ModuleProvider from the list of modules.
+  /// Release module from ModuleProvider.
+  virtual Module* removeModuleProvider(ModuleProvider *P,
+                                       std::string *ErrInfo = 0);
+
   /// FindFunctionNamed - Search all of the active modules to find the one that
   /// defines FnName.  This is very slow operation and shouldn't be used for
   /// general code.
   Function *FindFunctionNamed(const char *FnName);
   
-  /// create - This is the factory method for creating an execution engine which
-  /// is appropriate for the current machine.
-  static ExecutionEngine *create(ModuleProvider *MP,
-                                 bool ForceInterpreter = false);
-
   /// runFunction - Execute the specified function with the specified arguments,
   /// and return the result.
   ///
@@ -115,9 +160,13 @@ public:
                                 const std::vector<GenericValue> &ArgValues) = 0;
 
   /// runStaticConstructorsDestructors - This method is used to execute all of
-  /// the static constructors or destructors for a module, depending on the
+  /// the static constructors or destructors for a program, depending on the
   /// value of isDtors.
   void runStaticConstructorsDestructors(bool isDtors);
+  /// runStaticConstructorsDestructors - This method is used to execute all of
+  /// the static constructors or destructors for a module, depending on the
+  /// value of isDtors.
+  void runStaticConstructorsDestructors(Module *module, bool isDtors);
   
   
   /// runFunctionAsMain - This is a helper function which wraps runFunction to
@@ -138,10 +187,15 @@ public:
   /// use in dynamic compilation scenarios when you want to move globals
   void clearAllGlobalMappings();
   
+  /// clearGlobalMappingsFromModule - Clear all global mappings that came from a
+  /// particular module, because it has been removed from the JIT.
+  void clearGlobalMappingsFromModule(Module *M);
+  
   /// updateGlobalMapping - Replace an existing mapping for GV with a new
   /// address.  This updates both maps as required.  If "Addr" is null, the
-  /// entry for the global is removed from the mappings.
-  void updateGlobalMapping(const GlobalValue *GV, void *Addr);
+  /// entry for the global is removed from the mappings.  This returns the old
+  /// value of the pointer, or null if it was not in the map.
+  void *updateGlobalMapping(const GlobalValue *GV, void *Addr);
   
   /// getPointerToGlobalIfAvailable - This returns the address of the specified
   /// global value if it is has already been codegen'd, otherwise it returns
@@ -175,7 +229,8 @@ public:
   const GlobalValue *getGlobalValueAtAddress(void *Addr);
 
 
-  void StoreValueToMemory(GenericValue Val, GenericValue *Ptr, const Type *Ty);
+  void StoreValueToMemory(const GenericValue &Val, GenericValue *Ptr,
+                          const Type *Ty);
   void InitializeMemory(const Constant *Init, void *Addr);
 
   /// recompileAndRelinkFunction - This method is used to force a function
@@ -200,15 +255,58 @@ public:
   }
   
   /// DisableLazyCompilation - If called, the JIT will abort if lazy compilation
-  // is ever attempted.
-  void DisableLazyCompilation() {
-    LazyCompilationDisabled = true;
+  /// is ever attempted.
+  void DisableLazyCompilation(bool Disabled = true) {
+    LazyCompilationDisabled = Disabled;
   }
   bool isLazyCompilationDisabled() const {
     return LazyCompilationDisabled;
   }
 
+  /// DisableGVCompilation - If called, the JIT will abort if it's asked to
+  /// allocate space and populate a GlobalVariable that is not internal to
+  /// the module.
+  void DisableGVCompilation(bool Disabled = true) {
+    GVCompilationDisabled = Disabled;
+  }
+  bool isGVCompilationDisabled() const {
+    return GVCompilationDisabled;
+  }
+
+  /// DisableSymbolSearching - If called, the JIT will not try to lookup unknown
+  /// symbols with dlsym.  A client can still use InstallLazyFunctionCreator to
+  /// resolve symbols in a custom way.
+  void DisableSymbolSearching(bool Disabled = true) {
+    SymbolSearchingDisabled = Disabled;
+  }
+  bool isSymbolSearchingDisabled() const {
+    return SymbolSearchingDisabled;
+  }
+  
+  
+  /// InstallLazyFunctionCreator - If an unknown function is needed, the
+  /// specified function pointer is invoked to create it.  If it returns null,
+  /// the JIT will abort.
+  void InstallLazyFunctionCreator(void* (*P)(const std::string &)) {
+    LazyFunctionCreator = P;
+  }
+  
+  /// InstallExceptionTableRegister - The JIT will use the given function
+  /// to register the exception tables it generates.
+  static void InstallExceptionTableRegister(void (*F)(void*)) {
+    ExceptionTableRegister = F;
+  }
+  
+  /// RegisterTable - Registers the given pointer as an exception table. It uses
+  /// the ExceptionTableRegister function.
+  static void RegisterTable(void* res) {
+    if (ExceptionTableRegister)
+      ExceptionTableRegister(res);
+  }
+
 protected:
+  explicit ExecutionEngine(ModuleProvider *P);
+
   void emitGlobals();
 
   // EmitGlobalVariable - This method emits the specified global variable to the
@@ -217,7 +315,8 @@ protected:
   void EmitGlobalVariable(const GlobalVariable *GV);
 
   GenericValue getConstantValue(const Constant *C);
-  GenericValue LoadValueFromMemory(GenericValue *Ptr, const Type *Ty);
+  void LoadValueFromMemory(GenericValue &Result, GenericValue *Ptr, 
+                           const Type *Ty);
 };
 
 } // End llvm namespace