Remove attribution from file headers, per discussion on llvmdev.

[oota-llvm.git] / lib / ExecutionEngine / JIT / JIT.h

diff --git a/lib/ExecutionEngine/JIT/JIT.h b/lib/ExecutionEngine/JIT/JIT.h
index 9080b3be04548346d3867103120b464933e57923..bf1e804cd412364444be90c0ba1b1d8dbf0728e0 100644 (file)
--- a/lib/ExecutionEngine/JIT/JIT.h
+++ b/lib/ExecutionEngine/JIT/JIT.h
@@ -1,48 +1,85 @@
-//===-- VM.h - Definitions for Virtual Machine ------------------*- C++ -*-===//
+//===-- JIT.h - Class definition for the JIT --------------------*- C++ -*-===//
 //
-// This file defines the top-level Virtual Machine data structure.
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines the top-level JIT data structure.
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef VM_H
-#define VM_H
+#ifndef JIT_H
+#define JIT_H
 
-#include "../ExecutionEngine.h"
+#include "llvm/ExecutionEngine/ExecutionEngine.h"
 #include "llvm/PassManager.h"
 #include <map>
 
+namespace llvm {
+
 class Function;
 class GlobalValue;
 class Constant;
 class TargetMachine;
+class TargetJITInfo;
 class MachineCodeEmitter;
 
-class VM : public ExecutionEngine {
+class JITState {
+private:
+  FunctionPassManager PM;  // Passes to compile a function
+
+  /// PendingGlobals - Global variables which have had memory allocated for them
+  /// while a function was code generated, but which have not been initialized
+  /// yet.
+  std::vector<const GlobalVariable*> PendingGlobals;
+
+public:
+  JITState(ModuleProvider *MP) : PM(MP) {}
+
+  FunctionPassManager &getPM(const MutexGuard &L) {
+    return PM;
+  }
+
+  std::vector<const GlobalVariable*> &getPendingGlobals(const MutexGuard &L) {
+    return PendingGlobals;
+  }
+};
+
+
+class JIT : public ExecutionEngine {
   TargetMachine &TM;       // The current target we are compiling to
-  PassManager PM;          // Passes to compile a function
+  TargetJITInfo &TJI;      // The JITInfo for the target we are compiling to
   MachineCodeEmitter *MCE; // MCE object
 
-  // FunctionRefs - A mapping between addresses that refer to unresolved
-  // functions and the LLVM function object itself.  This is used by the fault
-  // handler to lazily patch up references...
-  //
-  std::map<void*, Function*> FunctionRefs;
+  JITState jitstate;
+
+  JIT(ModuleProvider *MP, TargetMachine &tm, TargetJITInfo &tji, 
+      JITMemoryManager *JMM);
 public:
-  VM(Module *M, TargetMachine *tm);
-  ~VM();
+  ~JIT();
 
-  /// run - Start execution with the specified function and arguments.
+  static void Register() {
+    JITCtor = create;
+  }
+  
+  /// getJITInfo - Return the target JIT information structure.
   ///
-  virtual int run(const std::string &FnName,
-                 const std::vector<std::string> &Args);
+  TargetJITInfo &getJITInfo() const { return TJI; }
 
-  void addFunctionRef(void *Ref, Function *F) {
-    FunctionRefs[Ref] = F;
+  /// create - Create an return a new JIT compiler if there is one available
+  /// for the current target.  Otherwise, return null.
+  ///
+  static ExecutionEngine *create(ModuleProvider *MP, std::string *Err) {
+    return createJIT(MP, Err, 0);
   }
 
-  const std::string &getFunctionReferencedName(void *RefAddr);
-
-  void *resolveFunctionReference(void *RefAddr);
+  /// run - Start execution with the specified function and arguments.
+  ///
+  virtual GenericValue runFunction(Function *F,
+                                   const std::vector<GenericValue> &ArgValues);
 
   /// getPointerToNamedFunction - This method returns the address of the
   /// specified function by using the dlsym function call.  As such it is only
@@ -52,14 +89,49 @@ public:
 
   // CompilationCallback - Invoked the first time that a call site is found,
   // which causes lazy compilation of the target function.
-  // 
+  //
   static void CompilationCallback();
-private:
-  static MachineCodeEmitter *createEmitter(VM &V);
-  void setupPassManager();
-  void *getPointerToFunction(const Function *F);
 
-  void registerCallback();
+  /// getPointerToFunction - This returns the address of the specified function,
+  /// compiling it if necessary.
+  ///
+  void *getPointerToFunction(Function *F);
+
+  /// getOrEmitGlobalVariable - Return the address of the specified global
+  /// variable, possibly emitting it to memory if needed.  This is used by the
+  /// Emitter.
+  void *getOrEmitGlobalVariable(const GlobalVariable *GV);
+
+  /// getPointerToFunctionOrStub - If the specified function has been
+  /// code-gen'd, return a pointer to the function.  If not, compile it, or use
+  /// a stub to implement lazy compilation if available.
+  ///
+  void *getPointerToFunctionOrStub(Function *F);
+
+  /// recompileAndRelinkFunction - This method is used to force a function
+  /// which has already been compiled, to be compiled again, possibly
+  /// after it has been modified. Then the entry to the old copy is overwritten
+  /// with a branch to the new copy. If there was no old copy, this acts
+  /// just like JIT::getPointerToFunction().
+  ///
+  void *recompileAndRelinkFunction(Function *F);
+
+  /// freeMachineCodeForFunction - deallocate memory used to code-generate this
+  /// Function.
+  ///
+  void freeMachineCodeForFunction(Function *F);
+
+  /// getCodeEmitter - Return the code emitter this JIT is emitting into.
+  MachineCodeEmitter *getCodeEmitter() const { return MCE; }
+  
+  static ExecutionEngine *createJIT(ModuleProvider *MP, std::string *Err,
+                                    JITMemoryManager *JMM);
+  
+private:
+  static MachineCodeEmitter *createEmitter(JIT &J, JITMemoryManager *JMM);
+  void runJITOnFunction (Function *F);
 };
 
+} // End llvm namespace
+
 #endif