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 "../ExecutionEngine.h"
11 #include "../GenericValue.h"
12 #include "Support/DataTypes.h"
13 #include "llvm/Assembly/CachedWriter.h"
14 #include "llvm/Target/TargetData.h"
15 #include "llvm/BasicBlock.h"
16 #include "llvm/Support/InstVisitor.h"
18 extern CachedWriter CW; // Object to accelerate printing of LLVM
20 struct FunctionInfo; // Defined in ExecutionAnnotations.h
22 // AllocaHolder - Object to track all of the blocks of memory allocated by
23 // alloca. When the function returns, this object is poped off the execution
24 // stack, which causes the dtor to be run, which frees all the alloca'd memory.
27 friend class AllocaHolderHandle;
28 std::vector<void*> Allocations;
31 AllocaHolder() : RefCnt(0) {}
32 void add(void *mem) { Allocations.push_back(mem); }
34 for (unsigned i = 0; i < Allocations.size(); ++i)
39 // AllocaHolderHandle gives AllocaHolder value semantics so we can stick it into
42 class AllocaHolderHandle {
45 AllocaHolderHandle() : H(new AllocaHolder()) { H->RefCnt++; }
46 AllocaHolderHandle(const AllocaHolderHandle &AH) : H(AH.H) { H->RefCnt++; }
47 ~AllocaHolderHandle() { if (--H->RefCnt == 0) delete H; }
49 void add(void *mem) { H->add(mem); }
52 typedef std::vector<GenericValue> ValuePlaneTy;
54 // ExecutionContext struct - This struct represents one stack frame currently
57 struct ExecutionContext {
58 Function *CurFunction;// The currently executing function
59 BasicBlock *CurBB; // The currently executing BB
60 BasicBlock::iterator CurInst; // The next instruction to execute
61 FunctionInfo *FuncInfo; // The FuncInfo annotation for the function
62 std::vector<ValuePlaneTy> Values;// ValuePlanes for each type
63 std::vector<GenericValue> VarArgs; // Values passed through an ellipsis
65 CallInst *Caller; // Holds the call that called subframes.
66 // NULL if main func or debugger invoked fn
67 AllocaHolderHandle Allocas; // Track memory allocated by alloca
70 // Interpreter - This class represents the entirety of the interpreter.
72 class Interpreter : public ExecutionEngine, public InstVisitor<Interpreter> {
73 int ExitCode; // The exit code to be returned by the lli util
74 bool Trace; // Tracing enabled?
75 int CurFrame; // The current stack frame being inspected
78 // The runtime stack of executing code. The top of the stack is the current
80 std::vector<ExecutionContext> ECStack;
82 // AtExitHandlers - List of functions to call when the program exits.
83 std::vector<Function*> AtExitHandlers;
85 Interpreter(Module *M, bool isLittleEndian, bool isLongPointer,
87 inline ~Interpreter() { CW.setModule(0); }
89 /// create - Create an interpreter ExecutionEngine. This can never fail.
91 static ExecutionEngine *create(Module *M, bool TraceMode);
93 /// run - Start execution with the specified function and arguments.
95 virtual int run(const std::string &FnName,
96 const std::vector<std::string> &Args,
100 void enableTracing() { Trace = true; }
102 void handleUserInput();
104 // User Interation Methods...
105 bool callFunction(const std::string &Name); // return true on failure
106 static void print(const Type *Ty, GenericValue V);
107 static void printValue(const Type *Ty, GenericValue V);
109 bool callMainFunction(const std::string &MainName,
110 const std::vector<std::string> &InputFilename);
112 // Code execution methods...
113 void callFunction(Function *F, const std::vector<GenericValue> &ArgVals);
114 void executeInstruction(); // Execute one instruction...
116 void run(); // Do the 'run' command
118 // Opcode Implementations
119 void visitReturnInst(ReturnInst &I);
120 void visitBranchInst(BranchInst &I);
121 void visitSwitchInst(SwitchInst &I);
123 void visitBinaryOperator(BinaryOperator &I);
124 void visitAllocationInst(AllocationInst &I);
125 void visitFreeInst(FreeInst &I);
126 void visitLoadInst(LoadInst &I);
127 void visitStoreInst(StoreInst &I);
128 void visitGetElementPtrInst(GetElementPtrInst &I);
130 void visitPHINode(PHINode &PN) { assert(0 && "PHI nodes already handled!"); }
131 void visitCastInst(CastInst &I);
132 void visitCallInst(CallInst &I);
133 void visitShl(ShiftInst &I);
134 void visitShr(ShiftInst &I);
135 void visitVarArgInst(VarArgInst &I);
136 void visitInstruction(Instruction &I) {
138 assert(0 && "Instruction not interpretable yet!");
141 GenericValue callExternalFunction(Function *F,
142 const std::vector<GenericValue> &ArgVals);
143 void exitCalled(GenericValue GV);
145 // getCurrentFunction - Return the currently executing function
146 inline Function *getCurrentFunction() const {
147 return CurFrame < 0 ? 0 : ECStack[CurFrame].CurFunction;
150 // isStopped - Return true if a program is stopped. Return false if no
151 // program is running.
153 inline bool isStopped() const { return !ECStack.empty(); }
155 void addAtExitHandler(Function *F) {
156 AtExitHandlers.push_back(F);
161 GenericValue executeGEPOperation(Value *Ptr, User::op_iterator I,
162 User::op_iterator E, ExecutionContext &SF);
164 private: // Helper functions
165 // SwitchToNewBasicBlock - Start execution in a new basic block and run any
166 // PHI nodes in the top of the block. This is used for intraprocedural
169 void SwitchToNewBasicBlock(BasicBlock *Dest, ExecutionContext &SF);
171 void *getPointerToFunction(Function *F) { return (void*)F; }
173 // getCurrentExecutablePath() - Return the directory that the lli executable
176 std::string getCurrentExecutablePath() const;
178 // printCurrentInstruction - Print out the instruction that the virtual PC is
179 // at, or fail silently if no program is running.
181 void printCurrentInstruction();
183 void initializeExecutionEngine();
184 void initializeExternalFunctions();