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