lib/ExecutionEngine/Interpreter/Interpreter.h

   1 //===-- Interpreter.h ------------------------------------------*- C++ -*--===//
   2 //
   3 // This header file defines the interpreter structure
   4 //
   5 //===----------------------------------------------------------------------===//
   6
   7 #ifndef LLI_INTERPRETER_H
   8 #define LLI_INTERPRETER_H
   9
  10 // Uncomment this line to enable profiling of structure field accesses.
  11 //#define PROFILE_STRUCTURE_FIELDS 1
  12
  13 #include "../ExecutionEngine.h"
  14 #include "../GenericValue.h"
  15 #include "Support/DataTypes.h"
  16 #include "llvm/Assembly/CachedWriter.h"
  17 #include "llvm/Target/TargetData.h"
  18 #include "llvm/BasicBlock.h"
  19 #include "llvm/Support/InstVisitor.h"
  20
  21 extern CachedWriter CW;     // Object to accelerate printing of LLVM
  22
  23 struct FunctionInfo;        // Defined in ExecutionAnnotations.h
  24
  25 // AllocaHolder - Object to track all of the blocks of memory allocated by
  26 // alloca.  When the function returns, this object is poped off the execution
  27 // stack, which causes the dtor to be run, which frees all the alloca'd memory.
  28 //
  29 class AllocaHolder {
  30   friend class AllocaHolderHandle;
  31   std::vector<void*> Allocations;
  32   unsigned RefCnt;
  33 public:
  34   AllocaHolder() : RefCnt(0) {}
  35   void add(void *mem) { Allocations.push_back(mem); }
  36   ~AllocaHolder() {
  37     for (unsigned i = 0; i < Allocations.size(); ++i)
  38       free(Allocations[i]);
  39   }
  40 };
  41
  42 // AllocaHolderHandle gives AllocaHolder value semantics so we can stick it into
  43 // a vector...
  44 //
  45 class AllocaHolderHandle {
  46   AllocaHolder *H;
  47 public:
  48   AllocaHolderHandle() : H(new AllocaHolder()) { H->RefCnt++; }
  49   AllocaHolderHandle(const AllocaHolderHandle &AH) : H(AH.H) { H->RefCnt++; }
  50   ~AllocaHolderHandle() { if (--H->RefCnt == 0) delete H; }
  51
  52   void add(void *mem) { H->add(mem); }
  53 };
  54
  55 typedef std::vector<GenericValue> ValuePlaneTy;
  56
  57 // ExecutionContext struct - This struct represents one stack frame currently
  58 // executing.
  59 //
  60 struct ExecutionContext {
  61   Function             *CurFunction;// The currently executing function
  62   BasicBlock           *CurBB;      // The currently executing BB
  63   BasicBlock::iterator  CurInst;    // The next instruction to execute
  64   FunctionInfo         *FuncInfo;   // The FuncInfo annotation for the function
  65   std::vector<ValuePlaneTy>  Values;// ValuePlanes for each type
  66   std::vector<GenericValue>  VarArgs; // Values passed through an ellipsis
  67
  68   CallInst             *Caller;     // Holds the call that called subframes.
  69                                     // NULL if main func or debugger invoked fn
  70   AllocaHolderHandle    Allocas;    // Track memory allocated by alloca
  71 };
  72
  73 // Interpreter - This class represents the entirety of the interpreter.
  74 //
  75 class Interpreter : public ExecutionEngine, public InstVisitor<Interpreter> {
  76   int ExitCode;                // The exit code to be returned by the lli util
  77   bool Debug;                  // Debug mode enabled?
  78   bool Profile;                // Profiling enabled?
  79   bool Trace;                  // Tracing enabled?
  80   int CurFrame;                // The current stack frame being inspected
  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   std::vector<Function*> AtExitHandlers;
  89 public:
  90   Interpreter(Module *M, bool isLittleEndian, bool isLongPointer,
  91               bool DebugMode, bool TraceMode);
  92   inline ~Interpreter() { CW.setModule(0); }
  93
  94   /// create - Create an interpreter ExecutionEngine. This can never fail.
  95   ///
  96   static ExecutionEngine *create(Module *M, bool DebugMode, bool TraceMode);
  97
  98   /// getExitCode - return the code that should be the exit code for the lli
  99   /// utility.
 100   ///
 101   inline int getExitCode() const { return ExitCode; }
 102
 103   /// run - Start execution with the specified function and arguments.
 104   ///
 105   virtual int run(const std::string &FnName,
 106                   const std::vector<std::string> &Args,
 107                   const char ** envp);
 108
 109
 110   // enableProfiling() - Turn profiling on, clear stats?
 111   void enableProfiling() { Profile = true; }
 112   void enableTracing() { Trace = true; }
 113
 114   void handleUserInput();
 115
 116   // User Interation Methods...
 117   bool callFunction(const std::string &Name);      // return true on failure
 118   void setBreakpoint(const std::string &Name);
 119   void infoValue(const std::string &Name);
 120   void print(const std::string &Name);
 121   static void print(const Type *Ty, GenericValue V);
 122   static void printValue(const Type *Ty, GenericValue V);
 123
 124   bool callMainFunction(const std::string &MainName,
 125                         const std::vector<std::string> &InputFilename);
 126
 127   void list();             // Do the 'list' command
 128   void printStackTrace();  // Do the 'backtrace' command
 129
 130   // Code execution methods...
 131   void callFunction(Function *F, const std::vector<GenericValue> &ArgVals);
 132   bool executeInstruction(); // Execute one instruction...
 133
 134   void stepInstruction();  // Do the 'step' command
 135   void nextInstruction();  // Do the 'next' command
 136   void run();              // Do the 'run' command
 137   void finish();           // Do the 'finish' command
 138
 139   // Opcode Implementations
 140   void visitReturnInst(ReturnInst &I);
 141   void visitBranchInst(BranchInst &I);
 142   void visitSwitchInst(SwitchInst &I);
 143
 144   void visitBinaryOperator(BinaryOperator &I);
 145   void visitAllocationInst(AllocationInst &I);
 146   void visitFreeInst(FreeInst &I);
 147   void visitLoadInst(LoadInst &I);
 148   void visitStoreInst(StoreInst &I);
 149   void visitGetElementPtrInst(GetElementPtrInst &I);
 150
 151   void visitPHINode(PHINode &PN) { assert(0 && "PHI nodes already handled!"); }
 152   void visitCastInst(CastInst &I);
 153   void visitCallInst(CallInst &I);
 154   void visitShl(ShiftInst &I);
 155   void visitShr(ShiftInst &I);
 156   void visitVarArgInst(VarArgInst &I);
 157   void visitInstruction(Instruction &I) {
 158     std::cerr << I;
 159     assert(0 && "Instruction not interpretable yet!");
 160   }
 161
 162   GenericValue callExternalFunction(Function *F,
 163                                     const std::vector<GenericValue> &ArgVals);
 164   void exitCalled(GenericValue GV);
 165
 166   // getCurrentFunction - Return the currently executing function
 167   inline Function *getCurrentFunction() const {
 168     return CurFrame < 0 ? 0 : ECStack[CurFrame].CurFunction;
 169   }
 170
 171   // isStopped - Return true if a program is stopped.  Return false if no
 172   // program is running.
 173   //
 174   inline bool isStopped() const { return !ECStack.empty(); }
 175
 176   void addAtExitHandler(Function *F) {
 177     AtExitHandlers.push_back(F);
 178   }
 179
 180   //FIXME: private:
 181 public:
 182   GenericValue executeGEPOperation(Value *Ptr, User::op_iterator I,
 183                                    User::op_iterator E, ExecutionContext &SF);
 184
 185 private:  // Helper functions
 186   // SwitchToNewBasicBlock - Start execution in a new basic block and run any
 187   // PHI nodes in the top of the block.  This is used for intraprocedural
 188   // control flow.
 189   //
 190   void SwitchToNewBasicBlock(BasicBlock *Dest, ExecutionContext &SF);
 191
 192   void *getPointerToFunction(Function *F) { return (void*)F; }
 193
 194   // getCurrentExecutablePath() - Return the directory that the lli executable
 195   // lives in.
 196   //
 197   std::string getCurrentExecutablePath() const;
 198
 199   // printCurrentInstruction - Print out the instruction that the virtual PC is
 200   // at, or fail silently if no program is running.
 201   //
 202   void printCurrentInstruction();
 203
 204   // printStackFrame - Print information about the specified stack frame, or -1
 205   // for the default one.
 206   //
 207   void printStackFrame(int FrameNo = -1);
 208
 209   // LookupMatchingNames - Search the current function namespace, then the
 210   // global namespace looking for values that match the specified name.  Return
 211   // ALL matches to that name.  This is obviously slow, and should only be used
 212   // for user interaction.
 213   //
 214   std::vector<Value*> LookupMatchingNames(const std::string &Name);
 215
 216   // ChooseOneOption - Prompt the user to choose among the specified options to
 217   // pick one value.  If no options are provided, emit an error.  If a single
 218   // option is provided, just return that option.
 219   //
 220   Value *ChooseOneOption(const std::string &Name,
 221                          const std::vector<Value*> &Opts);
 222
 223   // PerformExitStuff - Print out counters and profiling information if
 224   // applicable...
 225   void PerformExitStuff();
 226
 227   void initializeExecutionEngine();
 228   void initializeExternalFunctions();
 229 };
 230
 231 #endif