1 //===-- Interpreter.h ------------------------------------------*- C++ -*--===//
3 // This header file defines the interpreter structure
5 //===----------------------------------------------------------------------===//
7 #ifndef LLI_INTERPRETER_H
8 #define LLI_INTERPRETER_H
10 // Uncomment this line to enable profiling of structure field accesses.
11 //#define PROFILE_STRUCTURE_FIELDS 1
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"
21 extern CachedWriter CW; // Object to accelerate printing of LLVM
23 struct FunctionInfo; // Defined in ExecutionAnnotations.h
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.
30 friend class AllocaHolderHandle;
31 std::vector<void*> Allocations;
34 AllocaHolder() : RefCnt(0) {}
35 void add(void *mem) { Allocations.push_back(mem); }
37 for (unsigned i = 0; i < Allocations.size(); ++i)
42 // AllocaHolderHandle gives AllocaHolder value semantics so we can stick it into
45 class AllocaHolderHandle {
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; }
52 void add(void *mem) { H->add(mem); }
55 typedef std::vector<GenericValue> ValuePlaneTy;
57 // ExecutionContext struct - This struct represents one stack frame currently
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
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
73 // Interpreter - This class represents the entirety of the interpreter.
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
83 // The runtime stack of executing code. The top of the stack is the current
85 std::vector<ExecutionContext> ECStack;
87 // AtExitHandlers - List of functions to call when the program exits.
88 std::vector<Function*> AtExitHandlers;
90 Interpreter(Module *M, unsigned Config, bool DebugMode, bool TraceMode);
91 inline ~Interpreter() { CW.setModule(0); }
93 // getExitCode - return the code that should be the exit code for the lli
95 inline int getExitCode() const { return ExitCode; }
97 /// run - Start execution with the specified function and arguments.
99 virtual int run(const std::string &FnName,
100 const std::vector<std::string> &Args);
103 // enableProfiling() - Turn profiling on, clear stats?
104 void enableProfiling() { Profile = true; }
105 void enableTracing() { Trace = true; }
107 void handleUserInput();
109 // User Interation Methods...
110 bool callFunction(const std::string &Name); // return true on failure
111 void setBreakpoint(const std::string &Name);
112 void infoValue(const std::string &Name);
113 void print(const std::string &Name);
114 static void print(const Type *Ty, GenericValue V);
115 static void printValue(const Type *Ty, GenericValue V);
117 bool callMainFunction(const std::string &MainName,
118 const std::vector<std::string> &InputFilename);
120 void list(); // Do the 'list' command
121 void printStackTrace(); // Do the 'backtrace' command
123 // Code execution methods...
124 void callFunction(Function *F, const std::vector<GenericValue> &ArgVals);
125 bool executeInstruction(); // Execute one instruction...
127 void stepInstruction(); // Do the 'step' command
128 void nextInstruction(); // Do the 'next' command
129 void run(); // Do the 'run' command
130 void finish(); // Do the 'finish' command
132 // Opcode Implementations
133 void visitReturnInst(ReturnInst &I);
134 void visitBranchInst(BranchInst &I);
135 void visitSwitchInst(SwitchInst &I);
137 void visitBinaryOperator(BinaryOperator &I);
138 void visitAllocationInst(AllocationInst &I);
139 void visitFreeInst(FreeInst &I);
140 void visitLoadInst(LoadInst &I);
141 void visitStoreInst(StoreInst &I);
142 void visitGetElementPtrInst(GetElementPtrInst &I);
144 void visitPHINode(PHINode &PN) { assert(0 && "PHI nodes already handled!"); }
145 void visitCastInst(CastInst &I);
146 void visitCallInst(CallInst &I);
147 void visitShl(ShiftInst &I);
148 void visitShr(ShiftInst &I);
149 void visitVarArgInst(VarArgInst &I);
150 void visitInstruction(Instruction &I) {
152 assert(0 && "Instruction not interpretable yet!");
155 GenericValue callExternalFunction(Function *F,
156 const std::vector<GenericValue> &ArgVals);
157 void exitCalled(GenericValue GV);
159 // getCurrentFunction - Return the currently executing function
160 inline Function *getCurrentFunction() const {
161 return CurFrame < 0 ? 0 : ECStack[CurFrame].CurFunction;
164 // isStopped - Return true if a program is stopped. Return false if no
165 // program is running.
167 inline bool isStopped() const { return !ECStack.empty(); }
169 void addAtExitHandler(Function *F) {
170 AtExitHandlers.push_back(F);
175 GenericValue executeGEPOperation(Value *Ptr, User::op_iterator I,
176 User::op_iterator E, ExecutionContext &SF);
178 private: // Helper functions
179 // SwitchToNewBasicBlock - Start execution in a new basic block and run any
180 // PHI nodes in the top of the block. This is used for intraprocedural
183 void SwitchToNewBasicBlock(BasicBlock *Dest, ExecutionContext &SF);
185 void *getPointerToFunction(const Function *F) { return (void*)F; }
187 // getCurrentExecutablePath() - Return the directory that the lli executable
190 std::string getCurrentExecutablePath() const;
192 // printCurrentInstruction - Print out the instruction that the virtual PC is
193 // at, or fail silently if no program is running.
195 void printCurrentInstruction();
197 // printStackFrame - Print information about the specified stack frame, or -1
198 // for the default one.
200 void printStackFrame(int FrameNo = -1);
202 // LookupMatchingNames - Search the current function namespace, then the
203 // global namespace looking for values that match the specified name. Return
204 // ALL matches to that name. This is obviously slow, and should only be used
205 // for user interaction.
207 std::vector<Value*> LookupMatchingNames(const std::string &Name);
209 // ChooseOneOption - Prompt the user to choose among the specified options to
210 // pick one value. If no options are provided, emit an error. If a single
211 // option is provided, just return that option.
213 Value *ChooseOneOption(const std::string &Name,
214 const std::vector<Value*> &Opts);
216 // PerformExitStuff - Print out counters and profiling information if
218 void PerformExitStuff();
220 void initializeExecutionEngine();
221 void initializeExternalFunctions();