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 "llvm/Module.h"
  14 #include "Support/DataTypes.h"
  15 #include "llvm/Assembly/CachedWriter.h"
  16
  17 extern CachedWriter CW;     // Object to accellerate printing of LLVM
  18
  19 struct MethodInfo;          // Defined in ExecutionAnnotations.h
  20 class CallInst;
  21 class ReturnInst;
  22 class BranchInst;
  23 class AllocationInst;
  24
  25 typedef uint64_t PointerTy;
  26
  27 union GenericValue {
  28   bool            BoolVal;
  29   unsigned char   UByteVal;
  30   signed   char   SByteVal;
  31   unsigned short  UShortVal;
  32   signed   short  ShortVal;
  33   unsigned int    UIntVal;
  34   signed   int    IntVal;
  35   uint64_t        ULongVal;
  36   int64_t         LongVal;
  37   double          DoubleVal;
  38   float           FloatVal;
  39   PointerTy       PointerVal;
  40   unsigned char   Untyped[8];
  41 };
  42
  43 // AllocaHolder - Object to track all of the blocks of memory allocated by
  44 // alloca.  When the function returns, this object is poped off the execution
  45 // stack, which causes the dtor to be run, which frees all the alloca'd memory.
  46 //
  47 class AllocaHolder {
  48   friend class AllocaHolderHandle;
  49   std::vector<void*> Allocations;
  50   unsigned RefCnt;
  51 public:
  52   AllocaHolder() : RefCnt(0) {}
  53   void add(void *mem) { Allocations.push_back(mem); }
  54   ~AllocaHolder() {
  55     for (unsigned i = 0; i < Allocations.size(); ++i)
  56       free(Allocations[i]);
  57   }
  58 };
  59
  60 // AllocaHolderHandle gives AllocaHolder value semantics so we can stick it into
  61 // a vector...
  62 //
  63 class AllocaHolderHandle {
  64   AllocaHolder *H;
  65 public:
  66   AllocaHolderHandle() : H(new AllocaHolder()) { H->RefCnt++; }
  67   AllocaHolderHandle(const AllocaHolderHandle &AH) : H(AH.H) { H->RefCnt++; }
  68   ~AllocaHolderHandle() { if (--H->RefCnt == 0) delete H; }
  69
  70   void add(void *mem) { H->add(mem); }
  71 };
  72
  73 typedef std::vector<GenericValue> ValuePlaneTy;
  74
  75 // ExecutionContext struct - This struct represents one stack frame currently
  76 // executing.
  77 //
  78 struct ExecutionContext {
  79   Function             *CurMethod;  // The currently executing function
  80   BasicBlock           *CurBB;      // The currently executing BB
  81   BasicBlock::iterator  CurInst;    // The next instruction to execute
  82   MethodInfo           *MethInfo;   // The MethInfo annotation for the function
  83   std::vector<ValuePlaneTy>  Values;// ValuePlanes for each type
  84
  85   BasicBlock           *PrevBB;     // The previous BB or null if in first BB
  86   CallInst             *Caller;     // Holds the call that called subframes.
  87                                     // NULL if main func or debugger invoked fn
  88   AllocaHolderHandle    Allocas;    // Track memory allocated by alloca
  89 };
  90
  91 // Interpreter - This class represents the entirety of the interpreter.
  92 //
  93 class Interpreter {
  94   Module *CurMod;              // The current Module being executed (0 if none)
  95   int ExitCode;                // The exit code to be returned by the lli util
  96   bool Profile;                // Profiling enabled?
  97   bool Trace;                  // Tracing enabled?
  98   int CurFrame;                // The current stack frame being inspected
  99
 100   // The runtime stack of executing code.  The top of the stack is the current
 101   // function record.
 102   std::vector<ExecutionContext> ECStack;
 103
 104 public:
 105   Interpreter();
 106   inline ~Interpreter() { CW.setModule(0); delete CurMod; }
 107
 108   // getExitCode - return the code that should be the exit code for the lli
 109   // utility.
 110   inline int getExitCode() const { return ExitCode; }
 111   inline Module *getModule() const { return CurMod; }
 112
 113   // enableProfiling() - Turn profiling on, clear stats?
 114   void enableProfiling() { Profile = true; }
 115   void enableTracing() { Trace = true; }
 116
 117   void handleUserInput();
 118
 119   // User Interation Methods...
 120   void loadModule(const std::string &Filename);
 121   bool flushModule();
 122   bool callMethod(const std::string &Name);      // return true on failure
 123   void setBreakpoint(const std::string &Name);
 124   void infoValue(const std::string &Name);
 125   void print(const std::string &Name);
 126   static void print(const Type *Ty, GenericValue V);
 127   static void printValue(const Type *Ty, GenericValue V);
 128
 129   bool callMainMethod(const std::string &MainName,
 130                       const std::vector<std::string> &InputFilename);
 131   GenericValue CreateArgv(const std::vector<std::string> &InputArgv);
 132
 133   void list();             // Do the 'list' command
 134   void printStackTrace();  // Do the 'backtrace' command
 135
 136   // Code execution methods...
 137   void callMethod(Function *F, const std::vector<GenericValue> &ArgVals);
 138   bool executeInstruction(); // Execute one instruction...
 139
 140   void stepInstruction();  // Do the 'step' command
 141   void nextInstruction();  // Do the 'next' command
 142   void run();              // Do the 'run' command
 143   void finish();           // Do the 'finish' command
 144
 145   // Opcode Implementations
 146   void executeCallInst(CallInst &I, ExecutionContext &SF);
 147   void executeRetInst(ReturnInst &I, ExecutionContext &SF);
 148   void executeBrInst(BranchInst &I, ExecutionContext &SF);
 149   void executeAllocInst(AllocationInst &I, ExecutionContext &SF);
 150   GenericValue callExternalMethod(Function *F,
 151                                   const std::vector<GenericValue> &ArgVals);
 152   void exitCalled(GenericValue GV);
 153
 154   // getCurrentMethod - Return the currently executing method
 155   inline Function *getCurrentMethod() const {
 156     return CurFrame < 0 ? 0 : ECStack[CurFrame].CurMethod;
 157   }
 158
 159   // isStopped - Return true if a program is stopped.  Return false if no
 160   // program is running.
 161   //
 162   inline bool isStopped() const { return !ECStack.empty(); }
 163
 164 private:  // Helper functions
 165   // getCurrentExecutablePath() - Return the directory that the lli executable
 166   // lives in.
 167   //
 168   std::string getCurrentExecutablePath() const;
 169
 170   // printCurrentInstruction - Print out the instruction that the virtual PC is
 171   // at, or fail silently if no program is running.
 172   //
 173   void printCurrentInstruction();
 174
 175   // printStackFrame - Print information about the specified stack frame, or -1
 176   // for the default one.
 177   //
 178   void printStackFrame(int FrameNo = -1);
 179
 180   // LookupMatchingNames - Search the current function namespace, then the
 181   // global namespace looking for values that match the specified name.  Return
 182   // ALL matches to that name.  This is obviously slow, and should only be used
 183   // for user interaction.
 184   //
 185   std::vector<Value*> LookupMatchingNames(const std::string &Name);
 186
 187   // ChooseOneOption - Prompt the user to choose among the specified options to
 188   // pick one value.  If no options are provided, emit an error.  If a single
 189   // option is provided, just return that option.
 190   //
 191   Value *ChooseOneOption(const std::string &Name,
 192                          const std::vector<Value*> &Opts);
 193
 194
 195   void initializeExecutionEngine();
 196   void initializeExternalMethods();
 197 };
 198
 199 #endif