add a way to have multiple modules in a JIT :)
[oota-llvm.git] / include / llvm / ExecutionEngine / ExecutionEngine.h
index 2e4b3deda6ac5ae9aa6684fead278676fd4c7ad9..828cd3a962d04963b9089ba242f516a64da89765 100644 (file)
@@ -1,10 +1,10 @@
 //===- ExecutionEngine.h - Abstract Execution Engine Interface --*- C++ -*-===//
-// 
+//
 //                     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 abstract interface that implements execution support
@@ -18,6 +18,9 @@
 #include <vector>
 #include <map>
 #include <cassert>
+#include <string>
+#include "llvm/System/Mutex.h"
+#include "llvm/ADT/SmallVector.h"
 
 namespace llvm {
 
@@ -30,12 +33,10 @@ class Module;
 class ModuleProvider;
 class TargetData;
 class Type;
-class IntrinsicLowering;
-
-class ExecutionEngine {
-  Module &CurMod;
-  const TargetData *TD;
+class MutexGuard;
 
+class ExecutionEngineState {
+private:
   /// GlobalAddressMap - A mapping between LLVM global values and their
   /// actualized version...
   std::map<const GlobalValue*, void *> GlobalAddressMap;
@@ -45,26 +46,66 @@ class ExecutionEngine {
   /// at the address.  This map is not computed unless getGlobalValueAtAddress
   /// is called at some point.
   std::map<void *, const GlobalValue*> GlobalAddressReverseMap;
-protected:
-  ModuleProvider *MP;
 
-  void setTargetData(const TargetData &td) {
-    TD = &td;
+public:
+  std::map<const GlobalValue*, void *> &
+  getGlobalAddressMap(const MutexGuard &locked) {
+    return GlobalAddressMap;
+  }
+
+  std::map<void*, const GlobalValue*> & 
+  getGlobalAddressReverseMap(const MutexGuard& locked) {
+    return GlobalAddressReverseMap;
+  }
+};
+
+
+class ExecutionEngine {
+  const TargetData *TD;
+  ExecutionEngineState state;
+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.
+  SmallVector<ModuleProvider*, 1> Modules;
+  
+  void setTargetData(const TargetData *td) {
+    TD = td;
   }
 
+  // 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*);
+  static EECtorFn JITCtor, InterpCtor;
+    
 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();
-  
-  Module &getModule() const { return CurMod; }
-  const TargetData &getTargetData() const { return *TD; }
 
+  const TargetData *getTargetData() const { return TD; }
+
+  /// 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) {
+    Modules.push_back(P);
+  }
+  
+  /// 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.  If specified, the
-  /// IntrinsicLowering implementation should be allocated on the heap.
-  static ExecutionEngine *create(ModuleProvider *MP, bool ForceInterpreter,
-                                 IntrinsicLowering *IL = 0);
+  /// 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.
@@ -72,6 +113,12 @@ public:
   virtual GenericValue runFunction(Function *F,
                                 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
+  /// value of isDtors.
+  void runStaticConstructorsDestructors(bool isDtors);
+  
+  
   /// 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.
@@ -79,26 +126,27 @@ public:
                         const char * const * envp);
 
 
-  void addGlobalMapping(const GlobalValue *GV, void *Addr) {
-    void *&CurVal = GlobalAddressMap[GV];
-    assert((CurVal == 0 || Addr == 0) && "GlobalMapping already established!");
-    CurVal = Addr;
-
-    // If we are using the reverse mapping, add it too
-    if (!GlobalAddressReverseMap.empty()) {
-      const GlobalValue *&V = GlobalAddressReverseMap[Addr];
-      assert((V == 0 || GV == 0) && "GlobalMapping already established!");
-      V = GV;
-    }
-  }
-
+  /// addGlobalMapping - Tell the execution engine that the specified global is
+  /// at the specified location.  This is used internally as functions are JIT'd
+  /// and as global variables are laid out in memory.  It can and should also be
+  /// used by clients of the EE that want to have an LLVM global overlay
+  /// existing data in memory.
+  void addGlobalMapping(const GlobalValue *GV, void *Addr);
+  
+  /// clearAllGlobalMappings - Clear all global mappings and start over again
+  /// use in dynamic compilation scenarios when you want to move globals
+  void clearAllGlobalMappings();
+  
+  /// 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);
+  
   /// getPointerToGlobalIfAvailable - This returns the address of the specified
-  /// global value if it is available, otherwise it returns null.
+  /// global value if it is has already been codegen'd, otherwise it returns
+  /// null.
   ///
-  void *getPointerToGlobalIfAvailable(const GlobalValue *GV) {
-    std::map<const GlobalValue*, void*>::iterator I = GlobalAddressMap.find(GV);
-    return I != GlobalAddressMap.end() ? I->second : 0;
-  }
+  void *getPointerToGlobalIfAvailable(const GlobalValue *GV);
 
   /// getPointerToGlobal - This returns the address of the specified global
   /// value.  This may involve code generation if it's a function.
@@ -137,6 +185,12 @@ public:
   ///
   virtual void *recompileAndRelinkFunction(Function *F) = 0;
 
+  /// freeMachineCodeForFunction - Release memory in the ExecutionEngine
+  /// corresponding to the machine code emitted to execute this function, useful
+  /// for garbage-collecting generated code.
+  ///
+  virtual void freeMachineCodeForFunction(Function *F) = 0;
+
   /// getOrEmitGlobalVariable - Return the address of the specified global
   /// variable, possibly emitting it to memory if needed.  This is used by the
   /// Emitter.