lib/ExecutionEngine/Interpreter/Interpreter.h

   1 //===-- Interpreter.h ------------------------------------------*- C++ -*--===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This header file defines the interpreter structure
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLI_INTERPRETER_H
  15 #define LLI_INTERPRETER_H
  16
  17 #include "llvm/Function.h"
  18 #include "llvm/ExecutionEngine/ExecutionEngine.h"
  19 #include "llvm/ExecutionEngine/GenericValue.h"
  20 #include "llvm/Support/InstVisitor.h"
  21 #include "llvm/Support/CallSite.h"
  22 #include "llvm/Target/TargetData.h"
  23 #include "Support/DataTypes.h"
  24
  25 namespace llvm {
  26
  27 struct FunctionInfo;        // Defined in ExecutionAnnotations.h
  28 class gep_type_iterator;
  29 class ConstantExpr;
  30
  31 // AllocaHolder - Object to track all of the blocks of memory allocated by
  32 // alloca.  When the function returns, this object is popped off the execution
  33 // stack, which causes the dtor to be run, which frees all the alloca'd memory.
  34 //
  35 class AllocaHolder {
  36   friend class AllocaHolderHandle;
  37   std::vector<void*> Allocations;
  38   unsigned RefCnt;
  39 public:
  40   AllocaHolder() : RefCnt(0) {}
  41   void add(void *mem) { Allocations.push_back(mem); }
  42   ~AllocaHolder() {
  43     for (unsigned i = 0; i < Allocations.size(); ++i)
  44       free(Allocations[i]);
  45   }
  46 };
  47
  48 // AllocaHolderHandle gives AllocaHolder value semantics so we can stick it into
  49 // a vector...
  50 //
  51 class AllocaHolderHandle {
  52   AllocaHolder *H;
  53 public:
  54   AllocaHolderHandle() : H(new AllocaHolder()) { H->RefCnt++; }
  55   AllocaHolderHandle(const AllocaHolderHandle &AH) : H(AH.H) { H->RefCnt++; }
  56   ~AllocaHolderHandle() { if (--H->RefCnt == 0) delete H; }
  57
  58   void add(void *mem) { H->add(mem); }
  59 };
  60
  61 typedef std::vector<GenericValue> ValuePlaneTy;
  62
  63 // ExecutionContext struct - This struct represents one stack frame currently
  64 // executing.
  65 //
  66 struct ExecutionContext {
  67   Function             *CurFunction;// The currently executing function
  68   BasicBlock           *CurBB;      // The currently executing BB
  69   BasicBlock::iterator  CurInst;    // The next instruction to execute
  70   std::map<Value *, GenericValue> Values; // LLVM values used in this invocation
  71   std::vector<GenericValue>  VarArgs; // Values passed through an ellipsis
  72   CallSite             Caller;     // Holds the call that called subframes.
  73                                    // NULL if main func or debugger invoked fn
  74   AllocaHolderHandle    Allocas;    // Track memory allocated by alloca
  75 };
  76
  77 // Interpreter - This class represents the entirety of the interpreter.
  78 //
  79 class Interpreter : public ExecutionEngine, public InstVisitor<Interpreter> {
  80   int ExitCode;                // The exit code to be returned by the lli util
  81   TargetData TD;
  82
  83   // The runtime stack of executing code.  The top of the stack is the current
  84   // function record.
  85   std::vector<ExecutionContext> ECStack;
  86
  87   // AtExitHandlers - List of functions to call when the program exits,
  88   // registered with the atexit() library function.
  89   std::vector<Function*> AtExitHandlers;
  90
  91 public:
  92   Interpreter(Module *M, bool isLittleEndian, bool isLongPointer);
  93   inline ~Interpreter() { }
  94
  95   /// runAtExitHandlers - Run any functions registered by the
  96   /// program's calls to atexit(3), which we intercept and store in
  97   /// AtExitHandlers.
  98   ///
  99   void runAtExitHandlers ();
 100
 101   /// create - Create an interpreter ExecutionEngine. This can never fail.
 102   ///
 103   static ExecutionEngine *create(Module *M);
 104
 105   /// run - Start execution with the specified function and arguments.
 106   ///
 107   virtual GenericValue run(Function *F,
 108                            const std::vector<GenericValue> &ArgValues);
 109
 110   /// recompileAndRelinkFunction - For the interpreter, functions are always
 111   /// up-to-date.
 112   ///
 113   virtual void *recompileAndRelinkFunction(Function *F) {
 114     return getPointerToFunction(F);
 115   }
 116
 117   // Methods used to execute code:
 118   // Place a call on the stack
 119   void callFunction(Function *F, const std::vector<GenericValue> &ArgVals);
 120   void run();                // Execute instructions until nothing left to do
 121
 122   // Opcode Implementations
 123   void visitReturnInst(ReturnInst &I);
 124   void visitBranchInst(BranchInst &I);
 125   void visitSwitchInst(SwitchInst &I);
 126
 127   void visitBinaryOperator(BinaryOperator &I);
 128   void visitAllocationInst(AllocationInst &I);
 129   void visitFreeInst(FreeInst &I);
 130   void visitLoadInst(LoadInst &I);
 131   void visitStoreInst(StoreInst &I);
 132   void visitGetElementPtrInst(GetElementPtrInst &I);
 133   void visitPHINode(PHINode &PN) { assert(0 && "PHI nodes already handled!"); }
 134   void visitCastInst(CastInst &I);
 135
 136   void visitCallSite(CallSite CS);
 137   void visitCallInst(CallInst &I) { visitCallSite (CallSite (&I)); }
 138   void visitInvokeInst(InvokeInst &I) { visitCallSite (CallSite (&I)); }
 139   void visitUnwindInst(UnwindInst &I);
 140
 141   void visitShl(ShiftInst &I);
 142   void visitShr(ShiftInst &I);
 143   void visitVANextInst(VANextInst &I);
 144   void visitVAArgInst(VAArgInst &I);
 145   void visitInstruction(Instruction &I) {
 146     std::cerr << I;
 147     assert(0 && "Instruction not interpretable yet!");
 148   }
 149
 150   GenericValue callExternalFunction(Function *F,
 151                                     const std::vector<GenericValue> &ArgVals);
 152   void exitCalled(GenericValue GV);
 153
 154   void addAtExitHandler(Function *F) {
 155     AtExitHandlers.push_back(F);
 156   }
 157
 158   GenericValue *getFirstVarArg () {
 159     return &(ECStack[ECStack.size () - 2].VarArgs[0]);
 160   }
 161
 162   //FIXME: private:
 163 public:
 164   GenericValue executeGEPOperation(Value *Ptr, gep_type_iterator I,
 165                                    gep_type_iterator E, ExecutionContext &SF);
 166
 167 private:  // Helper functions
 168   // SwitchToNewBasicBlock - Start execution in a new basic block and run any
 169   // PHI nodes in the top of the block.  This is used for intraprocedural
 170   // control flow.
 171   //
 172   void SwitchToNewBasicBlock(BasicBlock *Dest, ExecutionContext &SF);
 173
 174   void *getPointerToFunction(Function *F) { return (void*)F; }
 175
 176   void initializeExecutionEngine();
 177   void initializeExternalFunctions();
 178   GenericValue getConstantExprValue(ConstantExpr *CE, ExecutionContext &SF);
 179   GenericValue getOperandValue(Value *V, ExecutionContext &SF);
 180   GenericValue executeCastOperation(Value *SrcVal, const Type *Ty,
 181                                     ExecutionContext &SF);
 182   void popStackAndReturnValueToCaller(const Type *RetTy, GenericValue Result);
 183 };
 184
 185 } // End llvm namespace
 186
 187 #endif