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