1 //===-- Interpreter.h ------------------------------------------*- C++ -*--===//
3 // This header file defines the interpreter structure
5 //===----------------------------------------------------------------------===//
7 #ifndef LLI_INTERPRETER_H
8 #define LLI_INTERPRETER_H
10 #include "llvm/Module.h"
11 #include "llvm/Method.h"
12 #include "llvm/Support/DataTypes.h"
14 struct MethodInfo; // Defined in ExecutionAnnotations.h
22 unsigned char UByteVal;
24 unsigned short UShortVal;
25 signed short ShortVal;
32 GenericValue *PointerVal;
35 typedef vector<GenericValue> ValuePlaneTy;
37 // ExecutionContext struct - This struct represents one stack frame currently
40 struct ExecutionContext {
41 Method *CurMethod; // The currently executing method
42 BasicBlock *CurBB; // The currently executing BB
43 BasicBlock::iterator CurInst; // The next instruction to execute
44 MethodInfo *MethInfo; // The MethInfo annotation for the method
45 vector<ValuePlaneTy> Values; // ValuePlanes for each type
47 BasicBlock *PrevBB; // The previous BB or null if in first BB
48 CallInst *Caller; // Holds the call that called subframes.
49 // NULL if main func or debugger invoked fn
53 // Interpreter - This class represents the entirety of the interpreter.
56 Module *CurMod; // The current Module being executed (0 if none)
57 int ExitCode; // The exit code to be returned by the lli util
58 bool Profile; // Profiling enabled?
59 int CurFrame; // The current stack frame being inspected
61 // The runtime stack of executing code. The top of the stack is the current
63 vector<ExecutionContext> ECStack;
67 inline ~Interpreter() { delete CurMod; }
69 // getExitCode - return the code that should be the exit code for the lli
71 inline int getExitCode() const { return ExitCode; }
73 // enableProfiling() - Turn profiling on, clear stats?
74 void enableProfiling() { Profile = true; }
76 void initializeExecutionEngine();
77 void handleUserInput();
79 // User Interation Methods...
80 void loadModule(const string &Filename);
82 bool callMethod(const string &Name); // return true on failure
83 void setBreakpoint(const string &Name);
84 void infoValue(const string &Name);
85 void print(const string &Name);
86 static void print(const Type *Ty, GenericValue V);
87 static void printValue(const Type *Ty, GenericValue V);
89 // Hack until we can parse command line args...
90 bool callMainMethod(const string &MainName,
91 const string &InputFilename);
93 void list(); // Do the 'list' command
94 void printStackTrace(); // Do the 'backtrace' command
96 // Code execution methods...
97 void callMethod (Method *Meth, const vector<GenericValue> &ArgVals);
98 void callExternalMethod(Method *Meth, const vector<GenericValue> &ArgVals);
99 bool executeInstruction(); // Execute one instruction...
101 void stepInstruction(); // Do the 'step' command
102 void nextInstruction(); // Do the 'next' command
103 void run(); // Do the 'run' command
104 void finish(); // Do the 'finish' command
106 // Opcode Implementations
107 void executeCallInst(CallInst *I, ExecutionContext &SF);
108 void executeRetInst(ReturnInst *I, ExecutionContext &SF);
109 void executeBrInst(BranchInst *I, ExecutionContext &SF);
110 void executeAllocInst(AllocationInst *I, ExecutionContext &SF);
112 // getCurrentMethod - Return the currently executing method
113 inline Method *getCurrentMethod() const {
114 return CurFrame < 0 ? 0 : ECStack[CurFrame].CurMethod;
117 // isStopped - Return true if a program is stopped. Return false if no
118 // program is running.
120 inline bool isStopped() const { return !ECStack.empty(); }
122 private: // Helper functions
123 // printCurrentInstruction - Print out the instruction that the virtual PC is
124 // at, or fail silently if no program is running.
126 void printCurrentInstruction();
128 // LookupMatchingNames - Search the current method namespace, then the global
129 // namespace looking for values that match the specified name. Return ALL
130 // matches to that name. This is obviously slow, and should only be used for
133 vector<Value*> LookupMatchingNames(const string &Name);
135 // ChooseOneOption - Prompt the user to choose among the specified options to
136 // pick one value. If no options are provided, emit an error. If a single
137 // option is provided, just return that option.
139 Value *ChooseOneOption(const string &Name, const vector<Value*> &Opts);