Interpreter cleanups:
[oota-llvm.git] / lib / ExecutionEngine / Interpreter / Interpreter.h
index e7c7942b0c9383affc622c19ac0b22812b6d7bb0..47f5c95f152e3630aef46775cbf6155e7c95b884 100644 (file)
@@ -7,40 +7,17 @@
 #ifndef LLI_INTERPRETER_H
 #define LLI_INTERPRETER_H
 
-// Uncomment this line to enable profiling of structure field accesses.
-#define PROFILE_STRUCTURE_FIELDS 1
-
-
-#include "llvm/Module.h"
-#include "llvm/Function.h"
-#include "llvm/BasicBlock.h"
+#include "../ExecutionEngine.h"
+#include "../GenericValue.h"
 #include "Support/DataTypes.h"
 #include "llvm/Assembly/CachedWriter.h"
+#include "llvm/Target/TargetData.h"
+#include "llvm/BasicBlock.h"
+#include "llvm/Support/InstVisitor.h"
 
-extern CachedWriter CW;     // Object to accellerate printing of LLVM
-
-struct MethodInfo;          // Defined in ExecutionAnnotations.h
-class CallInst;
-class ReturnInst;
-class BranchInst;
-class AllocationInst;
-
-typedef uint64_t PointerTy;
-
-union GenericValue {
-  bool            BoolVal;
-  unsigned char   UByteVal;
-  signed   char   SByteVal;
-  unsigned short  UShortVal;
-  signed   short  ShortVal;
-  unsigned int    UIntVal;
-  signed   int    IntVal;
-  uint64_t        ULongVal;
-  int64_t         LongVal;
-  double          DoubleVal;
-  float           FloatVal;
-  PointerTy       PointerVal;
-};
+extern CachedWriter CW;     // Object to accelerate printing of LLVM
+
+struct FunctionInfo;        // Defined in ExecutionAnnotations.h
 
 // AllocaHolder - Object to track all of the blocks of memory allocated by
 // alloca.  When the function returns, this object is poped off the execution
@@ -78,13 +55,13 @@ typedef std::vector<GenericValue> ValuePlaneTy;
 // executing.
 //
 struct ExecutionContext {
-  Function             *CurMethod;  // The currently executing function
+  Function             *CurFunction;// The currently executing function
   BasicBlock           *CurBB;      // The currently executing BB
   BasicBlock::iterator  CurInst;    // The next instruction to execute
-  MethodInfo           *MethInfo;   // The MethInfo annotation for the function
+  FunctionInfo         *FuncInfo;   // The FuncInfo annotation for the function
   std::vector<ValuePlaneTy>  Values;// ValuePlanes for each type
+  std::vector<GenericValue>  VarArgs; // Values passed through an ellipsis
 
-  BasicBlock           *PrevBB;     // The previous BB or null if in first BB
   CallInst             *Caller;     // Holds the call that called subframes.
                                     // NULL if main func or debugger invoked fn
   AllocaHolderHandle    Allocas;    // Track memory allocated by alloca
@@ -92,25 +69,40 @@ struct ExecutionContext {
 
 // Interpreter - This class represents the entirety of the interpreter.
 //
-class Interpreter {
-  Module *CurMod;              // The current Module being executed (0 if none)
+class Interpreter : public ExecutionEngine, public InstVisitor<Interpreter> {
   int ExitCode;                // The exit code to be returned by the lli util
   bool Profile;                // Profiling enabled?
   bool Trace;                  // Tracing enabled?
   int CurFrame;                // The current stack frame being inspected
+  TargetData TD;
 
   // The runtime stack of executing code.  The top of the stack is the current
   // function record.
   std::vector<ExecutionContext> ECStack;
 
+  // AtExitHandlers - List of functions to call when the program exits.
+  std::vector<Function*> AtExitHandlers;
 public:
-  Interpreter();
-  inline ~Interpreter() { CW.setModule(0); delete CurMod; }
+  Interpreter(Module *M, bool isLittleEndian, bool isLongPointer,
+              bool TraceMode);
+  inline ~Interpreter() { CW.setModule(0); }
+
+  /// create - Create an interpreter ExecutionEngine. This can never fail.
+  ///
+  static ExecutionEngine *create(Module *M, bool TraceMode);
 
-  // getExitCode - return the code that should be the exit code for the lli
-  // utility.
+  /// getExitCode - return the code that should be the exit code for the lli
+  /// utility.
+  ///
   inline int getExitCode() const { return ExitCode; }
 
+  /// run - Start execution with the specified function and arguments.
+  ///
+  virtual int run(const std::string &FnName,
+                 const std::vector<std::string> &Args,
+                  const char ** envp);
+
   // enableProfiling() - Turn profiling on, clear stats?
   void enableProfiling() { Profile = true; }
   void enableTracing() { Trace = true; }
@@ -118,24 +110,21 @@ public:
   void handleUserInput();
 
   // User Interation Methods...
-  void loadModule(const std::string &Filename);
-  bool flushModule();
-  bool callMethod(const std::string &Name);      // return true on failure
+  bool callFunction(const std::string &Name);      // return true on failure
   void setBreakpoint(const std::string &Name);
   void infoValue(const std::string &Name);
   void print(const std::string &Name);
   static void print(const Type *Ty, GenericValue V);
   static void printValue(const Type *Ty, GenericValue V);
 
-  // Hack until we can parse command line args...
-  bool callMainMethod(const std::string &MainName,
-                      const std::vector<std::string> &InputFilename);
+  bool callMainFunction(const std::string &MainName,
+                        const std::vector<std::string> &InputFilename);
 
   void list();             // Do the 'list' command
   void printStackTrace();  // Do the 'backtrace' command
 
   // Code execution methods...
-  void callMethod(Function *F, const std::vector<GenericValue> &ArgVals);
+  void callFunction(Function *F, const std::vector<GenericValue> &ArgVals);
   bool executeInstruction(); // Execute one instruction...
 
   void stepInstruction();  // Do the 'step' command
@@ -144,17 +133,35 @@ public:
   void finish();           // Do the 'finish' command
 
   // Opcode Implementations
-  void executeCallInst(CallInst *I, ExecutionContext &SF);
-  void executeRetInst(ReturnInst *I, ExecutionContext &SF);
-  void executeBrInst(BranchInst *I, ExecutionContext &SF);
-  void executeAllocInst(AllocationInst *I, ExecutionContext &SF);
-  GenericValue callExternalMethod(Function *F, 
-                                  const std::vector<GenericValue> &ArgVals);
+  void visitReturnInst(ReturnInst &I);
+  void visitBranchInst(BranchInst &I);
+  void visitSwitchInst(SwitchInst &I);
+
+  void visitBinaryOperator(BinaryOperator &I);
+  void visitAllocationInst(AllocationInst &I);
+  void visitFreeInst(FreeInst &I);
+  void visitLoadInst(LoadInst &I);
+  void visitStoreInst(StoreInst &I);
+  void visitGetElementPtrInst(GetElementPtrInst &I);
+
+  void visitPHINode(PHINode &PN) { assert(0 && "PHI nodes already handled!"); }
+  void visitCastInst(CastInst &I);
+  void visitCallInst(CallInst &I);
+  void visitShl(ShiftInst &I);
+  void visitShr(ShiftInst &I);
+  void visitVarArgInst(VarArgInst &I);
+  void visitInstruction(Instruction &I) {
+    std::cerr << I;
+    assert(0 && "Instruction not interpretable yet!");
+  }
+
+  GenericValue callExternalFunction(Function *F, 
+                                    const std::vector<GenericValue> &ArgVals);
   void exitCalled(GenericValue GV);
 
-  // getCurrentMethod - Return the currently executing method
-  inline Function *getCurrentMethod() const {
-    return CurFrame < 0 ? 0 : ECStack[CurFrame].CurMethod;
+  // getCurrentFunction - Return the currently executing function
+  inline Function *getCurrentFunction() const {
+    return CurFrame < 0 ? 0 : ECStack[CurFrame].CurFunction;
   }
 
   // isStopped - Return true if a program is stopped.  Return false if no
@@ -162,7 +169,24 @@ public:
   //
   inline bool isStopped() const { return !ECStack.empty(); }
 
+  void addAtExitHandler(Function *F) {
+    AtExitHandlers.push_back(F);
+  }
+
+  //FIXME: private:
+public:
+  GenericValue executeGEPOperation(Value *Ptr, User::op_iterator I,
+                                  User::op_iterator E, ExecutionContext &SF);
+
 private:  // Helper functions
+  // SwitchToNewBasicBlock - Start execution in a new basic block and run any
+  // PHI nodes in the top of the block.  This is used for intraprocedural
+  // control flow.
+  // 
+  void SwitchToNewBasicBlock(BasicBlock *Dest, ExecutionContext &SF);
+
+  void *getPointerToFunction(Function *F) { return (void*)F; }
+
   // getCurrentExecutablePath() - Return the directory that the lli executable
   // lives in.
   //
@@ -192,9 +216,8 @@ private:  // Helper functions
   Value *ChooseOneOption(const std::string &Name,
                          const std::vector<Value*> &Opts);
 
-
   void initializeExecutionEngine();
-  void initializeExternalMethods();
+  void initializeExternalFunctions();
 };
 
 #endif