More explicit keywords.
[oota-llvm.git] / lib / ExecutionEngine / Interpreter / Interpreter.h
index 51675b5d67191a99aaa8cc728c7f92a0dde730cb..9ad837c31b4b8051130bf84952653eb1cfd59624 100644 (file)
@@ -1,5 +1,12 @@
 //===-- Interpreter.h ------------------------------------------*- 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 header file defines the interpreter structure
 //
 //===----------------------------------------------------------------------===//
 #ifndef LLI_INTERPRETER_H
 #define LLI_INTERPRETER_H
 
-// Uncomment this line to enable profiling of structure field accesses.
-//#define PROFILE_STRUCTURE_FIELDS 1
-
-#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/Function.h"
+#include "llvm/ExecutionEngine/ExecutionEngine.h"
+#include "llvm/ExecutionEngine/GenericValue.h"
+#include "llvm/ADT/APInt.h"
 #include "llvm/Support/InstVisitor.h"
+#include "llvm/Support/CallSite.h"
+#include "llvm/Target/TargetData.h"
+#include "llvm/Support/DataTypes.h"
+
+namespace llvm {
 
-extern CachedWriter CW;     // Object to accelerate printing of LLVM
+class IntrinsicLowering;
+struct FunctionInfo;
+template<typename T> class generic_gep_type_iterator;
+class ConstantExpr;
+typedef generic_gep_type_iterator<User::const_op_iterator> gep_type_iterator;
 
-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
+// alloca.  When the function returns, this object is popped off the execution
 // stack, which causes the dtor to be run, which frees all the alloca'd memory.
 //
 class AllocaHolder {
@@ -61,73 +71,65 @@ struct ExecutionContext {
   Function             *CurFunction;// The currently executing function
   BasicBlock           *CurBB;      // The currently executing BB
   BasicBlock::iterator  CurInst;    // The next instruction to execute
-  FunctionInfo         *FuncInfo;   // The FuncInfo annotation for the function
-  std::vector<ValuePlaneTy>  Values;// ValuePlanes for each type
+  std::map<Value *, GenericValue> Values; // LLVM values used in this invocation
   std::vector<GenericValue>  VarArgs; // Values passed through an ellipsis
-
-  CallInst             *Caller;     // Holds the call that called subframes.
-                                    // NULL if main func or debugger invoked fn
+  CallSite             Caller;     // Holds the call that called subframes.
+                                   // NULL if main func or debugger invoked fn
   AllocaHolderHandle    Allocas;    // Track memory allocated by alloca
 };
 
 // Interpreter - This class represents the entirety of the interpreter.
 //
 class Interpreter : public ExecutionEngine, public InstVisitor<Interpreter> {
-  int ExitCode;                // The exit code to be returned by the lli util
-  bool Debug;                  // Debug mode enabled?
-  bool Profile;                // Profiling enabled?
-  bool Trace;                  // Tracing enabled?
-  int CurFrame;                // The current stack frame being inspected
+  GenericValue ExitValue;          // The return value of the called function
   TargetData TD;
+  IntrinsicLowering *IL;
 
   // 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.
+  // AtExitHandlers - List of functions to call when the program exits,
+  // registered with the atexit() library function.
   std::vector<Function*> AtExitHandlers;
-public:
-  Interpreter(Module *M, unsigned Config, bool DebugMode, bool TraceMode);
-  inline ~Interpreter() { CW.setModule(0); }
 
-  // getExitCode - return the code that should be the exit code for the lli
-  // utility.
-  inline int getExitCode() const { return ExitCode; }
+public:
+  explicit Interpreter(Module *M);
+  ~Interpreter();
 
-  /// run - Start execution with the specified function and arguments.
+  /// runAtExitHandlers - Run any functions registered by the program's calls to
+  /// atexit(3), which we intercept and store in AtExitHandlers.
   ///
-  virtual int run(const std::string &FnName,
-                 const std::vector<std::string> &Args);
-
-  // enableProfiling() - Turn profiling on, clear stats?
-  void enableProfiling() { Profile = true; }
-  void enableTracing() { Trace = true; }
+  void runAtExitHandlers();
 
-  void handleUserInput();
+  static void Register() {
+    InterpCtor = create;
+  }
+  
+  /// create - Create an interpreter ExecutionEngine. This can never fail.
+  ///
+  static ExecutionEngine *create(ModuleProvider *M, std::string *ErrorStr = 0);
 
-  // User Interation Methods...
-  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);
+  /// run - Start execution with the specified function and arguments.
+  ///
+  virtual GenericValue runFunction(Function *F,
+                                   const std::vector<GenericValue> &ArgValues);
 
-  bool callMainFunction(const std::string &MainName,
-                        const std::vector<std::string> &InputFilename);
+  /// recompileAndRelinkFunction - For the interpreter, functions are always
+  /// up-to-date.
+  ///
+  virtual void *recompileAndRelinkFunction(Function *F) {
+    return getPointerToFunction(F);
+  }
 
-  void list();             // Do the 'list' command
-  void printStackTrace();  // Do the 'backtrace' command
+  /// freeMachineCodeForFunction - The interpreter does not generate any code.
+  ///
+  void freeMachineCodeForFunction(Function *F) { }
 
-  // Code execution methods...
+  // Methods used to execute code:
+  // Place a call on the stack
   void callFunction(Function *F, const std::vector<GenericValue> &ArgVals);
-  bool executeInstruction(); // Execute one instruction...
-
-  void stepInstruction();  // Do the 'step' command
-  void nextInstruction();  // Do the 'next' command
-  void run();              // Do the 'run' command
-  void finish();           // Do the 'finish' command
+  void run();                // Execute instructions until nothing left to do
 
   // Opcode Implementations
   void visitReturnInst(ReturnInst &I);
@@ -135,90 +137,105 @@ public:
   void visitSwitchInst(SwitchInst &I);
 
   void visitBinaryOperator(BinaryOperator &I);
+  void visitICmpInst(ICmpInst &I);
+  void visitFCmpInst(FCmpInst &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 visitTruncInst(TruncInst &I);
+  void visitZExtInst(ZExtInst &I);
+  void visitSExtInst(SExtInst &I);
+  void visitFPTruncInst(FPTruncInst &I);
+  void visitFPExtInst(FPExtInst &I);
+  void visitUIToFPInst(UIToFPInst &I);
+  void visitSIToFPInst(SIToFPInst &I);
+  void visitFPToUIInst(FPToUIInst &I);
+  void visitFPToSIInst(FPToSIInst &I);
+  void visitPtrToIntInst(PtrToIntInst &I);
+  void visitIntToPtrInst(IntToPtrInst &I);
+  void visitBitCastInst(BitCastInst &I);
+  void visitSelectInst(SelectInst &I);
+
+
+  void visitCallSite(CallSite CS);
+  void visitCallInst(CallInst &I) { visitCallSite (CallSite (&I)); }
+  void visitInvokeInst(InvokeInst &I) { visitCallSite (CallSite (&I)); }
+  void visitUnwindInst(UnwindInst &I);
+  void visitUnreachableInst(UnreachableInst &I);
+
+  void visitShl(BinaryOperator &I);
+  void visitLShr(BinaryOperator &I);
+  void visitAShr(BinaryOperator &I);
+
+  void visitVAArgInst(VAArgInst &I);
   void visitInstruction(Instruction &I) {
-    std::cerr << I;
+    cerr << I;
     assert(0 && "Instruction not interpretable yet!");
   }
 
-  GenericValue callExternalFunction(Function *F, 
+  GenericValue callExternalFunction(Function *F,
                                     const std::vector<GenericValue> &ArgVals);
   void exitCalled(GenericValue GV);
 
-  // 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
-  // program is running.
-  //
-  inline bool isStopped() const { return !ECStack.empty(); }
-
   void addAtExitHandler(Function *F) {
     AtExitHandlers.push_back(F);
   }
 
+  GenericValue *getFirstVarArg () {
+    return &(ECStack.back ().VarArgs[0]);
+  }
+
   //FIXME: private:
 public:
-  GenericValue executeGEPOperation(Value *Ptr, User::op_iterator I,
-                                  User::op_iterator E, ExecutionContext &SF);
+  GenericValue executeGEPOperation(Value *Ptr, gep_type_iterator I,
+                                   gep_type_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.
-  //
-  std::string getCurrentExecutablePath() const;
-
-  // printCurrentInstruction - Print out the instruction that the virtual PC is
-  // at, or fail silently if no program is running.
-  //
-  void printCurrentInstruction();
-
-  // printStackFrame - Print information about the specified stack frame, or -1
-  // for the default one.
-  //
-  void printStackFrame(int FrameNo = -1);
-
-  // LookupMatchingNames - Search the current function namespace, then the
-  // global namespace looking for values that match the specified name.  Return
-  // ALL matches to that name.  This is obviously slow, and should only be used
-  // for user interaction.
-  //
-  std::vector<Value*> LookupMatchingNames(const std::string &Name);
-
-  // ChooseOneOption - Prompt the user to choose among the specified options to
-  // pick one value.  If no options are provided, emit an error.  If a single 
-  // option is provided, just return that option.
-  //
-  Value *ChooseOneOption(const std::string &Name,
-                         const std::vector<Value*> &Opts);
-
-  // PerformExitStuff - Print out counters and profiling information if
-  // applicable...
-  void PerformExitStuff();
-
   void initializeExecutionEngine();
   void initializeExternalFunctions();
+  GenericValue getConstantExprValue(ConstantExpr *CE, ExecutionContext &SF);
+  GenericValue getOperandValue(Value *V, ExecutionContext &SF);
+  GenericValue executeTruncInst(Value *SrcVal, const Type *DstTy,
+                                ExecutionContext &SF);
+  GenericValue executeSExtInst(Value *SrcVal, const Type *DstTy,
+                               ExecutionContext &SF);
+  GenericValue executeZExtInst(Value *SrcVal, const Type *DstTy,
+                               ExecutionContext &SF);
+  GenericValue executeFPTruncInst(Value *SrcVal, const Type *DstTy,
+                                  ExecutionContext &SF);
+  GenericValue executeFPExtInst(Value *SrcVal, const Type *DstTy,
+                                ExecutionContext &SF);
+  GenericValue executeFPToUIInst(Value *SrcVal, const Type *DstTy,
+                                 ExecutionContext &SF);
+  GenericValue executeFPToSIInst(Value *SrcVal, const Type *DstTy,
+                                 ExecutionContext &SF);
+  GenericValue executeUIToFPInst(Value *SrcVal, const Type *DstTy,
+                                 ExecutionContext &SF);
+  GenericValue executeSIToFPInst(Value *SrcVal, const Type *DstTy,
+                                 ExecutionContext &SF);
+  GenericValue executePtrToIntInst(Value *SrcVal, const Type *DstTy,
+                                   ExecutionContext &SF);
+  GenericValue executeIntToPtrInst(Value *SrcVal, const Type *DstTy,
+                                   ExecutionContext &SF);
+  GenericValue executeBitCastInst(Value *SrcVal, const Type *DstTy,
+                                  ExecutionContext &SF);
+  GenericValue executeCastOperation(Instruction::CastOps opcode, Value *SrcVal, 
+                                    const Type *Ty, ExecutionContext &SF);
+  void popStackAndReturnValueToCaller(const Type *RetTy, GenericValue Result);
+
 };
 
+} // End llvm namespace
+
 #endif