Fix #include broken by iMemory.h not including DerivedTypes.h
[oota-llvm.git] / lib / ExecutionEngine / Interpreter / Execution.cpp
1 //===-- Execution.cpp - Implement code to simulate the program ------------===//
2 // 
3 //  This file contains the actual instruction interpreter.
4 //
5 //===----------------------------------------------------------------------===//
6
7 #include "Interpreter.h"
8 #include "ExecutionAnnotations.h"
9 #include "llvm/iPHINode.h"
10 #include "llvm/iOther.h"
11 #include "llvm/iTerminators.h"
12 #include "llvm/iMemory.h"
13 #include "llvm/DerivedTypes.h"
14 #include "llvm/Constants.h"
15 #include "llvm/Assembly/Writer.h"
16 #include "llvm/Target/TargetData.h"
17 #include "llvm/GlobalVariable.h"
18 #include "Support/CommandLine.h"
19 #include <math.h>  // For fmod
20 #include <signal.h>
21 #include <setjmp.h>
22 #include <iostream>
23 using std::vector;
24 using std::cout;
25 using std::cerr;
26
27 cl::Flag   QuietMode ("quiet"  , "Do not emit any non-program output");
28 cl::Alias  QuietModeA("q"      , "Alias for -quiet", cl::NoFlags, QuietMode);
29 cl::Flag   ArrayChecksEnabled("array-checks", "Enable array bound checks");
30 cl::Flag   AbortOnExceptions("abort-on-exception", "Halt execution on a machine exception");
31
32 // Create a TargetData structure to handle memory addressing and size/alignment
33 // computations
34 //
35 static TargetData TD("lli Interpreter");
36 CachedWriter CW;     // Object to accelerate printing of LLVM
37
38
39 #ifdef PROFILE_STRUCTURE_FIELDS
40 static cl::Flag ProfileStructureFields("profilestructfields", 
41                                        "Profile Structure Field Accesses");
42 #include <map>
43 static std::map<const StructType *, vector<unsigned> > FieldAccessCounts;
44 #endif
45
46 sigjmp_buf SignalRecoverBuffer;
47 static bool InInstruction = false;
48
49 extern "C" {
50 static void SigHandler(int Signal) {
51   if (InInstruction)
52     siglongjmp(SignalRecoverBuffer, Signal);
53 }
54 }
55
56 static void initializeSignalHandlers() {
57   struct sigaction Action;
58   Action.sa_handler = SigHandler;
59   Action.sa_flags   = SA_SIGINFO;
60   sigemptyset(&Action.sa_mask);
61   sigaction(SIGSEGV, &Action, 0);
62   sigaction(SIGBUS, &Action, 0);
63   sigaction(SIGINT, &Action, 0);
64   sigaction(SIGFPE, &Action, 0);
65 }
66
67
68 //===----------------------------------------------------------------------===//
69 //                     Value Manipulation code
70 //===----------------------------------------------------------------------===//
71
72 static unsigned getOperandSlot(Value *V) {
73   SlotNumber *SN = (SlotNumber*)V->getAnnotation(SlotNumberAID);
74   assert(SN && "Operand does not have a slot number annotation!");
75   return SN->SlotNum;
76 }
77
78 #define GET_CONST_VAL(TY, CLASS) \
79   case Type::TY##TyID: Result.TY##Val = cast<CLASS>(CPV)->getValue(); break
80
81 static GenericValue getOperandValue(Value *V, ExecutionContext &SF) {
82   if (Constant *CPV = dyn_cast<Constant>(V)) {
83     GenericValue Result;
84     switch (CPV->getType()->getPrimitiveID()) {
85       GET_CONST_VAL(Bool   , ConstantBool);
86       GET_CONST_VAL(UByte  , ConstantUInt);
87       GET_CONST_VAL(SByte  , ConstantSInt);
88       GET_CONST_VAL(UShort , ConstantUInt);
89       GET_CONST_VAL(Short  , ConstantSInt);
90       GET_CONST_VAL(UInt   , ConstantUInt);
91       GET_CONST_VAL(Int    , ConstantSInt);
92       GET_CONST_VAL(ULong  , ConstantUInt);
93       GET_CONST_VAL(Long   , ConstantSInt);
94       GET_CONST_VAL(Float  , ConstantFP);
95       GET_CONST_VAL(Double , ConstantFP);
96     case Type::PointerTyID:
97       if (isa<ConstantPointerNull>(CPV)) {
98         Result.PointerVal = 0;
99       } else if (isa<ConstantPointerRef>(CPV)) {
100         assert(0 && "Not implemented!");
101       } else {
102         assert(0 && "Unknown constant pointer type!");
103       }
104       break;
105     default:
106       cout << "ERROR: Constant unimp for type: " << CPV->getType() << "\n";
107     }
108     return Result;
109   } else if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
110     GlobalAddress *Address = 
111       (GlobalAddress*)GV->getOrCreateAnnotation(GlobalAddressAID);
112     GenericValue Result;
113     Result.PointerVal = (PointerTy)(GenericValue*)Address->Ptr;
114     return Result;
115   } else {
116     unsigned TyP = V->getType()->getUniqueID();   // TypePlane for value
117     unsigned OpSlot = getOperandSlot(V);
118     assert(TyP < SF.Values.size() && 
119            OpSlot < SF.Values[TyP].size() && "Value out of range!");
120     return SF.Values[TyP][getOperandSlot(V)];
121   }
122 }
123
124 static void printOperandInfo(Value *V, ExecutionContext &SF) {
125   if (isa<Constant>(V)) {
126     cout << "Constant Pool Value\n";
127   } else if (isa<GlobalValue>(V)) {
128     cout << "Global Value\n";
129   } else {
130     unsigned TyP  = V->getType()->getUniqueID();   // TypePlane for value
131     unsigned Slot = getOperandSlot(V);
132     cout << "Value=" << (void*)V << " TypeID=" << TyP << " Slot=" << Slot
133          << " Addr=" << &SF.Values[TyP][Slot] << " SF=" << &SF
134          << " Contents=0x";
135
136     const unsigned char *Buf = (const unsigned char*)&SF.Values[TyP][Slot];
137     for (unsigned i = 0; i < sizeof(GenericValue); ++i) {
138       unsigned char Cur = Buf[i];
139       cout << ( Cur     >= 160? char((Cur>>4)+'A'-10) : char((Cur>>4) + '0'))
140            << ((Cur&15) >=  10? char((Cur&15)+'A'-10) : char((Cur&15) + '0'));
141     }
142     cout << "\n";
143   }
144 }
145
146
147
148 static void SetValue(Value *V, GenericValue Val, ExecutionContext &SF) {
149   unsigned TyP = V->getType()->getUniqueID();   // TypePlane for value
150
151   //cout << "Setting value: " << &SF.Values[TyP][getOperandSlot(V)] << "\n";
152   SF.Values[TyP][getOperandSlot(V)] = Val;
153 }
154
155
156 //===----------------------------------------------------------------------===//
157 //                    Annotation Wrangling code
158 //===----------------------------------------------------------------------===//
159
160 void Interpreter::initializeExecutionEngine() {
161   AnnotationManager::registerAnnotationFactory(MethodInfoAID,
162                                                &MethodInfo::Create);
163   AnnotationManager::registerAnnotationFactory(GlobalAddressAID, 
164                                                &GlobalAddress::Create);
165   initializeSignalHandlers();
166 }
167
168 // InitializeMemory - Recursive function to apply a Constant value into the
169 // specified memory location...
170 //
171 static void InitializeMemory(Constant *Init, char *Addr) {
172 #define INITIALIZE_MEMORY(TYID, CLASS, TY)  \
173   case Type::TYID##TyID: {                  \
174     TY Tmp = cast<CLASS>(Init)->getValue(); \
175     memcpy(Addr, &Tmp, sizeof(TY));         \
176   } return
177
178   switch (Init->getType()->getPrimitiveID()) {
179     INITIALIZE_MEMORY(Bool   , ConstantBool, bool);
180     INITIALIZE_MEMORY(UByte  , ConstantUInt, unsigned char);
181     INITIALIZE_MEMORY(SByte  , ConstantSInt, signed   char);
182     INITIALIZE_MEMORY(UShort , ConstantUInt, unsigned short);
183     INITIALIZE_MEMORY(Short  , ConstantSInt, signed   short);
184     INITIALIZE_MEMORY(UInt   , ConstantUInt, unsigned int);
185     INITIALIZE_MEMORY(Int    , ConstantSInt, signed   int);
186     INITIALIZE_MEMORY(ULong  , ConstantUInt, uint64_t);
187     INITIALIZE_MEMORY(Long   , ConstantSInt,  int64_t);
188     INITIALIZE_MEMORY(Float  , ConstantFP  , float);
189     INITIALIZE_MEMORY(Double , ConstantFP  , double);
190 #undef INITIALIZE_MEMORY
191
192   case Type::ArrayTyID: {
193     ConstantArray *CPA = cast<ConstantArray>(Init);
194     const vector<Use> &Val = CPA->getValues();
195     unsigned ElementSize = 
196       TD.getTypeSize(cast<ArrayType>(CPA->getType())->getElementType());
197     for (unsigned i = 0; i < Val.size(); ++i)
198       InitializeMemory(cast<Constant>(Val[i].get()), Addr+i*ElementSize);
199     return;
200   }
201
202   case Type::StructTyID: {
203     ConstantStruct *CPS = cast<ConstantStruct>(Init);
204     const StructLayout *SL=TD.getStructLayout(cast<StructType>(CPS->getType()));
205     const vector<Use> &Val = CPS->getValues();
206     for (unsigned i = 0; i < Val.size(); ++i)
207       InitializeMemory(cast<Constant>(Val[i].get()),
208                        Addr+SL->MemberOffsets[i]);
209     return;
210   }
211
212   case Type::PointerTyID:
213     if (isa<ConstantPointerNull>(Init)) {
214       *(void**)Addr = 0;
215     } else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(Init)) {
216       GlobalAddress *Address = 
217        (GlobalAddress*)CPR->getValue()->getOrCreateAnnotation(GlobalAddressAID);
218       *(void**)Addr = (GenericValue*)Address->Ptr;
219     } else {
220       assert(0 && "Unknown Constant pointer type!");
221     }
222     return;
223
224   default:
225     CW << "Bad Type: " << Init->getType() << "\n";
226     assert(0 && "Unknown constant type to initialize memory with!");
227   }
228 }
229
230 Annotation *GlobalAddress::Create(AnnotationID AID, const Annotable *O, void *){
231   assert(AID == GlobalAddressAID);
232
233   // This annotation will only be created on GlobalValue objects...
234   GlobalValue *GVal = cast<GlobalValue>((Value*)O);
235
236   if (isa<Function>(GVal)) {
237     // The GlobalAddress object for a function is just a pointer to function
238     // itself.  Don't delete it when the annotation is gone though!
239     return new GlobalAddress(GVal, false);
240   }
241
242   // Handle the case of a global variable...
243   assert(isa<GlobalVariable>(GVal) && 
244          "Global value found that isn't a function or global variable!");
245   GlobalVariable *GV = cast<GlobalVariable>(GVal);
246   
247   // First off, we must allocate space for the global variable to point at...
248   const Type *Ty = GV->getType()->getElementType();  // Type to be allocated
249
250   // Allocate enough memory to hold the type...
251   void *Addr = calloc(1, TD.getTypeSize(Ty));
252   assert(Addr != 0 && "Null pointer returned by malloc!");
253
254   // Initialize the memory if there is an initializer...
255   if (GV->hasInitializer())
256     InitializeMemory(GV->getInitializer(), (char*)Addr);
257
258   return new GlobalAddress(Addr, true);  // Simply invoke the ctor
259 }
260
261
262 //===----------------------------------------------------------------------===//
263 //                    Binary Instruction Implementations
264 //===----------------------------------------------------------------------===//
265
266 #define IMPLEMENT_BINARY_OPERATOR(OP, TY) \
267    case Type::TY##TyID: Dest.TY##Val = Src1.TY##Val OP Src2.TY##Val; break
268
269 static GenericValue executeAddInst(GenericValue Src1, GenericValue Src2, 
270                                    const Type *Ty, ExecutionContext &SF) {
271   GenericValue Dest;
272   switch (Ty->getPrimitiveID()) {
273     IMPLEMENT_BINARY_OPERATOR(+, UByte);
274     IMPLEMENT_BINARY_OPERATOR(+, SByte);
275     IMPLEMENT_BINARY_OPERATOR(+, UShort);
276     IMPLEMENT_BINARY_OPERATOR(+, Short);
277     IMPLEMENT_BINARY_OPERATOR(+, UInt);
278     IMPLEMENT_BINARY_OPERATOR(+, Int);
279     IMPLEMENT_BINARY_OPERATOR(+, ULong);
280     IMPLEMENT_BINARY_OPERATOR(+, Long);
281     IMPLEMENT_BINARY_OPERATOR(+, Float);
282     IMPLEMENT_BINARY_OPERATOR(+, Double);
283     IMPLEMENT_BINARY_OPERATOR(+, Pointer);
284   default:
285     cout << "Unhandled type for Add instruction: " << Ty << "\n";
286   }
287   return Dest;
288 }
289
290 static GenericValue executeSubInst(GenericValue Src1, GenericValue Src2, 
291                                    const Type *Ty, ExecutionContext &SF) {
292   GenericValue Dest;
293   switch (Ty->getPrimitiveID()) {
294     IMPLEMENT_BINARY_OPERATOR(-, UByte);
295     IMPLEMENT_BINARY_OPERATOR(-, SByte);
296     IMPLEMENT_BINARY_OPERATOR(-, UShort);
297     IMPLEMENT_BINARY_OPERATOR(-, Short);
298     IMPLEMENT_BINARY_OPERATOR(-, UInt);
299     IMPLEMENT_BINARY_OPERATOR(-, Int);
300     IMPLEMENT_BINARY_OPERATOR(-, ULong);
301     IMPLEMENT_BINARY_OPERATOR(-, Long);
302     IMPLEMENT_BINARY_OPERATOR(-, Float);
303     IMPLEMENT_BINARY_OPERATOR(-, Double);
304     IMPLEMENT_BINARY_OPERATOR(-, Pointer);
305   default:
306     cout << "Unhandled type for Sub instruction: " << Ty << "\n";
307   }
308   return Dest;
309 }
310
311 static GenericValue executeMulInst(GenericValue Src1, GenericValue Src2, 
312                                    const Type *Ty, ExecutionContext &SF) {
313   GenericValue Dest;
314   switch (Ty->getPrimitiveID()) {
315     IMPLEMENT_BINARY_OPERATOR(*, UByte);
316     IMPLEMENT_BINARY_OPERATOR(*, SByte);
317     IMPLEMENT_BINARY_OPERATOR(*, UShort);
318     IMPLEMENT_BINARY_OPERATOR(*, Short);
319     IMPLEMENT_BINARY_OPERATOR(*, UInt);
320     IMPLEMENT_BINARY_OPERATOR(*, Int);
321     IMPLEMENT_BINARY_OPERATOR(*, ULong);
322     IMPLEMENT_BINARY_OPERATOR(*, Long);
323     IMPLEMENT_BINARY_OPERATOR(*, Float);
324     IMPLEMENT_BINARY_OPERATOR(*, Double);
325     IMPLEMENT_BINARY_OPERATOR(*, Pointer);
326   default:
327     cout << "Unhandled type for Mul instruction: " << Ty << "\n";
328   }
329   return Dest;
330 }
331
332 static GenericValue executeDivInst(GenericValue Src1, GenericValue Src2, 
333                                    const Type *Ty, ExecutionContext &SF) {
334   GenericValue Dest;
335   switch (Ty->getPrimitiveID()) {
336     IMPLEMENT_BINARY_OPERATOR(/, UByte);
337     IMPLEMENT_BINARY_OPERATOR(/, SByte);
338     IMPLEMENT_BINARY_OPERATOR(/, UShort);
339     IMPLEMENT_BINARY_OPERATOR(/, Short);
340     IMPLEMENT_BINARY_OPERATOR(/, UInt);
341     IMPLEMENT_BINARY_OPERATOR(/, Int);
342     IMPLEMENT_BINARY_OPERATOR(/, ULong);
343     IMPLEMENT_BINARY_OPERATOR(/, Long);
344     IMPLEMENT_BINARY_OPERATOR(/, Float);
345     IMPLEMENT_BINARY_OPERATOR(/, Double);
346     IMPLEMENT_BINARY_OPERATOR(/, Pointer);
347   default:
348     cout << "Unhandled type for Div instruction: " << Ty << "\n";
349   }
350   return Dest;
351 }
352
353 static GenericValue executeRemInst(GenericValue Src1, GenericValue Src2, 
354                                    const Type *Ty, ExecutionContext &SF) {
355   GenericValue Dest;
356   switch (Ty->getPrimitiveID()) {
357     IMPLEMENT_BINARY_OPERATOR(%, UByte);
358     IMPLEMENT_BINARY_OPERATOR(%, SByte);
359     IMPLEMENT_BINARY_OPERATOR(%, UShort);
360     IMPLEMENT_BINARY_OPERATOR(%, Short);
361     IMPLEMENT_BINARY_OPERATOR(%, UInt);
362     IMPLEMENT_BINARY_OPERATOR(%, Int);
363     IMPLEMENT_BINARY_OPERATOR(%, ULong);
364     IMPLEMENT_BINARY_OPERATOR(%, Long);
365     IMPLEMENT_BINARY_OPERATOR(%, Pointer);
366   case Type::FloatTyID:
367     Dest.FloatVal = fmod(Src1.FloatVal, Src2.FloatVal);
368     break;
369   case Type::DoubleTyID:
370     Dest.DoubleVal = fmod(Src1.DoubleVal, Src2.DoubleVal);
371     break;
372   default:
373     cout << "Unhandled type for Rem instruction: " << Ty << "\n";
374   }
375   return Dest;
376 }
377
378 static GenericValue executeAndInst(GenericValue Src1, GenericValue Src2, 
379                                    const Type *Ty, ExecutionContext &SF) {
380   GenericValue Dest;
381   switch (Ty->getPrimitiveID()) {
382     IMPLEMENT_BINARY_OPERATOR(&, UByte);
383     IMPLEMENT_BINARY_OPERATOR(&, SByte);
384     IMPLEMENT_BINARY_OPERATOR(&, UShort);
385     IMPLEMENT_BINARY_OPERATOR(&, Short);
386     IMPLEMENT_BINARY_OPERATOR(&, UInt);
387     IMPLEMENT_BINARY_OPERATOR(&, Int);
388     IMPLEMENT_BINARY_OPERATOR(&, ULong);
389     IMPLEMENT_BINARY_OPERATOR(&, Long);
390     IMPLEMENT_BINARY_OPERATOR(&, Pointer);
391   default:
392     cout << "Unhandled type for And instruction: " << Ty << "\n";
393   }
394   return Dest;
395 }
396
397
398 static GenericValue executeOrInst(GenericValue Src1, GenericValue Src2, 
399                                   const Type *Ty, ExecutionContext &SF) {
400   GenericValue Dest;
401   switch (Ty->getPrimitiveID()) {
402     IMPLEMENT_BINARY_OPERATOR(|, UByte);
403     IMPLEMENT_BINARY_OPERATOR(|, SByte);
404     IMPLEMENT_BINARY_OPERATOR(|, UShort);
405     IMPLEMENT_BINARY_OPERATOR(|, Short);
406     IMPLEMENT_BINARY_OPERATOR(|, UInt);
407     IMPLEMENT_BINARY_OPERATOR(|, Int);
408     IMPLEMENT_BINARY_OPERATOR(|, ULong);
409     IMPLEMENT_BINARY_OPERATOR(|, Long);
410     IMPLEMENT_BINARY_OPERATOR(|, Pointer);
411   default:
412     cout << "Unhandled type for Or instruction: " << Ty << "\n";
413   }
414   return Dest;
415 }
416
417
418 static GenericValue executeXorInst(GenericValue Src1, GenericValue Src2, 
419                                    const Type *Ty, ExecutionContext &SF) {
420   GenericValue Dest;
421   switch (Ty->getPrimitiveID()) {
422     IMPLEMENT_BINARY_OPERATOR(^, UByte);
423     IMPLEMENT_BINARY_OPERATOR(^, SByte);
424     IMPLEMENT_BINARY_OPERATOR(^, UShort);
425     IMPLEMENT_BINARY_OPERATOR(^, Short);
426     IMPLEMENT_BINARY_OPERATOR(^, UInt);
427     IMPLEMENT_BINARY_OPERATOR(^, Int);
428     IMPLEMENT_BINARY_OPERATOR(^, ULong);
429     IMPLEMENT_BINARY_OPERATOR(^, Long);
430     IMPLEMENT_BINARY_OPERATOR(^, Pointer);
431   default:
432     cout << "Unhandled type for Xor instruction: " << Ty << "\n";
433   }
434   return Dest;
435 }
436
437
438 #define IMPLEMENT_SETCC(OP, TY) \
439    case Type::TY##TyID: Dest.BoolVal = Src1.TY##Val OP Src2.TY##Val; break
440
441 static GenericValue executeSetEQInst(GenericValue Src1, GenericValue Src2, 
442                                      const Type *Ty, ExecutionContext &SF) {
443   GenericValue Dest;
444   switch (Ty->getPrimitiveID()) {
445     IMPLEMENT_SETCC(==, UByte);
446     IMPLEMENT_SETCC(==, SByte);
447     IMPLEMENT_SETCC(==, UShort);
448     IMPLEMENT_SETCC(==, Short);
449     IMPLEMENT_SETCC(==, UInt);
450     IMPLEMENT_SETCC(==, Int);
451     IMPLEMENT_SETCC(==, ULong);
452     IMPLEMENT_SETCC(==, Long);
453     IMPLEMENT_SETCC(==, Float);
454     IMPLEMENT_SETCC(==, Double);
455     IMPLEMENT_SETCC(==, Pointer);
456   default:
457     cout << "Unhandled type for SetEQ instruction: " << Ty << "\n";
458   }
459   return Dest;
460 }
461
462 static GenericValue executeSetNEInst(GenericValue Src1, GenericValue Src2, 
463                                      const Type *Ty, ExecutionContext &SF) {
464   GenericValue Dest;
465   switch (Ty->getPrimitiveID()) {
466     IMPLEMENT_SETCC(!=, UByte);
467     IMPLEMENT_SETCC(!=, SByte);
468     IMPLEMENT_SETCC(!=, UShort);
469     IMPLEMENT_SETCC(!=, Short);
470     IMPLEMENT_SETCC(!=, UInt);
471     IMPLEMENT_SETCC(!=, Int);
472     IMPLEMENT_SETCC(!=, ULong);
473     IMPLEMENT_SETCC(!=, Long);
474     IMPLEMENT_SETCC(!=, Float);
475     IMPLEMENT_SETCC(!=, Double);
476     IMPLEMENT_SETCC(!=, Pointer);
477
478   default:
479     cout << "Unhandled type for SetNE instruction: " << Ty << "\n";
480   }
481   return Dest;
482 }
483
484 static GenericValue executeSetLEInst(GenericValue Src1, GenericValue Src2, 
485                                      const Type *Ty, ExecutionContext &SF) {
486   GenericValue Dest;
487   switch (Ty->getPrimitiveID()) {
488     IMPLEMENT_SETCC(<=, UByte);
489     IMPLEMENT_SETCC(<=, SByte);
490     IMPLEMENT_SETCC(<=, UShort);
491     IMPLEMENT_SETCC(<=, Short);
492     IMPLEMENT_SETCC(<=, UInt);
493     IMPLEMENT_SETCC(<=, Int);
494     IMPLEMENT_SETCC(<=, ULong);
495     IMPLEMENT_SETCC(<=, Long);
496     IMPLEMENT_SETCC(<=, Float);
497     IMPLEMENT_SETCC(<=, Double);
498     IMPLEMENT_SETCC(<=, Pointer);
499   default:
500     cout << "Unhandled type for SetLE instruction: " << Ty << "\n";
501   }
502   return Dest;
503 }
504
505 static GenericValue executeSetGEInst(GenericValue Src1, GenericValue Src2, 
506                                      const Type *Ty, ExecutionContext &SF) {
507   GenericValue Dest;
508   switch (Ty->getPrimitiveID()) {
509     IMPLEMENT_SETCC(>=, UByte);
510     IMPLEMENT_SETCC(>=, SByte);
511     IMPLEMENT_SETCC(>=, UShort);
512     IMPLEMENT_SETCC(>=, Short);
513     IMPLEMENT_SETCC(>=, UInt);
514     IMPLEMENT_SETCC(>=, Int);
515     IMPLEMENT_SETCC(>=, ULong);
516     IMPLEMENT_SETCC(>=, Long);
517     IMPLEMENT_SETCC(>=, Float);
518     IMPLEMENT_SETCC(>=, Double);
519     IMPLEMENT_SETCC(>=, Pointer);
520   default:
521     cout << "Unhandled type for SetGE instruction: " << Ty << "\n";
522   }
523   return Dest;
524 }
525
526 static GenericValue executeSetLTInst(GenericValue Src1, GenericValue Src2, 
527                                      const Type *Ty, ExecutionContext &SF) {
528   GenericValue Dest;
529   switch (Ty->getPrimitiveID()) {
530     IMPLEMENT_SETCC(<, UByte);
531     IMPLEMENT_SETCC(<, SByte);
532     IMPLEMENT_SETCC(<, UShort);
533     IMPLEMENT_SETCC(<, Short);
534     IMPLEMENT_SETCC(<, UInt);
535     IMPLEMENT_SETCC(<, Int);
536     IMPLEMENT_SETCC(<, ULong);
537     IMPLEMENT_SETCC(<, Long);
538     IMPLEMENT_SETCC(<, Float);
539     IMPLEMENT_SETCC(<, Double);
540     IMPLEMENT_SETCC(<, Pointer);
541   default:
542     cout << "Unhandled type for SetLT instruction: " << Ty << "\n";
543   }
544   return Dest;
545 }
546
547 static GenericValue executeSetGTInst(GenericValue Src1, GenericValue Src2, 
548                                      const Type *Ty, ExecutionContext &SF) {
549   GenericValue Dest;
550   switch (Ty->getPrimitiveID()) {
551     IMPLEMENT_SETCC(>, UByte);
552     IMPLEMENT_SETCC(>, SByte);
553     IMPLEMENT_SETCC(>, UShort);
554     IMPLEMENT_SETCC(>, Short);
555     IMPLEMENT_SETCC(>, UInt);
556     IMPLEMENT_SETCC(>, Int);
557     IMPLEMENT_SETCC(>, ULong);
558     IMPLEMENT_SETCC(>, Long);
559     IMPLEMENT_SETCC(>, Float);
560     IMPLEMENT_SETCC(>, Double);
561     IMPLEMENT_SETCC(>, Pointer);
562   default:
563     cout << "Unhandled type for SetGT instruction: " << Ty << "\n";
564   }
565   return Dest;
566 }
567
568 static void executeBinaryInst(BinaryOperator *I, ExecutionContext &SF) {
569   const Type *Ty = I->getOperand(0)->getType();
570   GenericValue Src1  = getOperandValue(I->getOperand(0), SF);
571   GenericValue Src2  = getOperandValue(I->getOperand(1), SF);
572   GenericValue R;   // Result
573
574   switch (I->getOpcode()) {
575   case Instruction::Add:   R = executeAddInst  (Src1, Src2, Ty, SF); break;
576   case Instruction::Sub:   R = executeSubInst  (Src1, Src2, Ty, SF); break;
577   case Instruction::Mul:   R = executeMulInst  (Src1, Src2, Ty, SF); break;
578   case Instruction::Div:   R = executeDivInst  (Src1, Src2, Ty, SF); break;
579   case Instruction::Rem:   R = executeRemInst  (Src1, Src2, Ty, SF); break;
580   case Instruction::And:   R = executeAndInst  (Src1, Src2, Ty, SF); break;
581   case Instruction::Or:    R = executeOrInst   (Src1, Src2, Ty, SF); break;
582   case Instruction::Xor:   R = executeXorInst  (Src1, Src2, Ty, SF); break;
583   case Instruction::SetEQ: R = executeSetEQInst(Src1, Src2, Ty, SF); break;
584   case Instruction::SetNE: R = executeSetNEInst(Src1, Src2, Ty, SF); break;
585   case Instruction::SetLE: R = executeSetLEInst(Src1, Src2, Ty, SF); break;
586   case Instruction::SetGE: R = executeSetGEInst(Src1, Src2, Ty, SF); break;
587   case Instruction::SetLT: R = executeSetLTInst(Src1, Src2, Ty, SF); break;
588   case Instruction::SetGT: R = executeSetGTInst(Src1, Src2, Ty, SF); break;
589   default:
590     cout << "Don't know how to handle this binary operator!\n-->" << I;
591     R = Src1;
592   }
593
594   SetValue(I, R, SF);
595 }
596
597 //===----------------------------------------------------------------------===//
598 //                     Terminator Instruction Implementations
599 //===----------------------------------------------------------------------===//
600
601 static void PerformExitStuff() {
602 #ifdef PROFILE_STRUCTURE_FIELDS
603   // Print out structure field accounting information...
604   if (!FieldAccessCounts.empty()) {
605     CW << "Profile Field Access Counts:\n";
606     std::map<const StructType *, vector<unsigned> >::iterator 
607       I = FieldAccessCounts.begin(), E = FieldAccessCounts.end();
608     for (; I != E; ++I) {
609       vector<unsigned> &OfC = I->second;
610       CW << "  '" << (Value*)I->first << "'\t- Sum=";
611       
612       unsigned Sum = 0;
613       for (unsigned i = 0; i < OfC.size(); ++i)
614         Sum += OfC[i];
615       CW << Sum << " - ";
616       
617       for (unsigned i = 0; i < OfC.size(); ++i) {
618         if (i) CW << ", ";
619         CW << OfC[i];
620       }
621       CW << "\n";
622     }
623     CW << "\n";
624
625     CW << "Profile Field Access Percentages:\n";
626     cout.precision(3);
627     for (I = FieldAccessCounts.begin(); I != E; ++I) {
628       vector<unsigned> &OfC = I->second;
629       unsigned Sum = 0;
630       for (unsigned i = 0; i < OfC.size(); ++i)
631         Sum += OfC[i];
632       
633       CW << "  '" << (Value*)I->first << "'\t- ";
634       for (unsigned i = 0; i < OfC.size(); ++i) {
635         if (i) CW << ", ";
636         CW << double(OfC[i])/Sum;
637       }
638       CW << "\n";
639     }
640     CW << "\n";
641
642     FieldAccessCounts.clear();
643   }
644 #endif
645 }
646
647 void Interpreter::exitCalled(GenericValue GV) {
648   if (!QuietMode) {
649     cout << "Program returned ";
650     print(Type::IntTy, GV);
651     cout << " via 'void exit(int)'\n";
652   }
653
654   ExitCode = GV.SByteVal;
655   ECStack.clear();
656   PerformExitStuff();
657 }
658
659 void Interpreter::executeRetInst(ReturnInst *I, ExecutionContext &SF) {
660   const Type *RetTy = 0;
661   GenericValue Result;
662
663   // Save away the return value... (if we are not 'ret void')
664   if (I->getNumOperands()) {
665     RetTy  = I->getReturnValue()->getType();
666     Result = getOperandValue(I->getReturnValue(), SF);
667   }
668
669   // Save previously executing meth
670   const Function *M = ECStack.back().CurMethod;
671
672   // Pop the current stack frame... this invalidates SF
673   ECStack.pop_back();
674
675   if (ECStack.empty()) {  // Finished main.  Put result into exit code...
676     if (RetTy) {          // Nonvoid return type?
677       if (!QuietMode) {
678         CW << "Function " << M->getType() << " \"" << M->getName()
679            << "\" returned ";
680         print(RetTy, Result);
681         cout << "\n";
682       }
683
684       if (RetTy->isIntegral())
685         ExitCode = Result.SByteVal;   // Capture the exit code of the program
686     } else {
687       ExitCode = 0;
688     }
689
690     PerformExitStuff();
691     return;
692   }
693
694   // If we have a previous stack frame, and we have a previous call, fill in
695   // the return value...
696   //
697   ExecutionContext &NewSF = ECStack.back();
698   if (NewSF.Caller) {
699     if (NewSF.Caller->getType() != Type::VoidTy)             // Save result...
700       SetValue(NewSF.Caller, Result, NewSF);
701
702     NewSF.Caller = 0;          // We returned from the call...
703   } else if (!QuietMode) {
704     // This must be a function that is executing because of a user 'call'
705     // instruction.
706     CW << "Function " << M->getType() << " \"" << M->getName()
707        << "\" returned ";
708     print(RetTy, Result);
709     cout << "\n";
710   }
711 }
712
713 void Interpreter::executeBrInst(BranchInst *I, ExecutionContext &SF) {
714   SF.PrevBB = SF.CurBB;               // Update PrevBB so that PHI nodes work...
715   BasicBlock *Dest;
716
717   Dest = I->getSuccessor(0);          // Uncond branches have a fixed dest...
718   if (!I->isUnconditional()) {
719     Value *Cond = I->getCondition();
720     GenericValue CondVal = getOperandValue(Cond, SF);
721     if (CondVal.BoolVal == 0) // If false cond...
722       Dest = I->getSuccessor(1);    
723   }
724   SF.CurBB   = Dest;                  // Update CurBB to branch destination
725   SF.CurInst = SF.CurBB->begin();     // Update new instruction ptr...
726 }
727
728 //===----------------------------------------------------------------------===//
729 //                     Memory Instruction Implementations
730 //===----------------------------------------------------------------------===//
731
732 void Interpreter::executeAllocInst(AllocationInst *I, ExecutionContext &SF) {
733   const Type *Ty = I->getType()->getElementType();  // Type to be allocated
734
735   // Get the number of elements being allocated by the array...
736   unsigned NumElements = getOperandValue(I->getOperand(0), SF).UIntVal;
737
738   // Allocate enough memory to hold the type...
739   // FIXME: Don't use CALLOC, use a tainted malloc.
740   void *Memory = calloc(NumElements, TD.getTypeSize(Ty));
741
742   GenericValue Result;
743   Result.PointerVal = (PointerTy)Memory;
744   assert(Result.PointerVal != 0 && "Null pointer returned by malloc!");
745   SetValue(I, Result, SF);
746
747   if (I->getOpcode() == Instruction::Alloca)
748     ECStack.back().Allocas.add(Memory);
749 }
750
751 static void executeFreeInst(FreeInst *I, ExecutionContext &SF) {
752   assert(I->getOperand(0)->getType()->isPointerType() && "Freeing nonptr?");
753   GenericValue Value = getOperandValue(I->getOperand(0), SF);
754   // TODO: Check to make sure memory is allocated
755   free((void*)Value.PointerVal);   // Free memory
756 }
757
758
759 // getElementOffset - The workhorse for getelementptr, load and store.  This 
760 // function returns the offset that arguments ArgOff+1 -> NumArgs specify for
761 // the pointer type specified by argument Arg.
762 //
763 static PointerTy getElementOffset(MemAccessInst *I, ExecutionContext &SF) {
764   assert(isa<PointerType>(I->getPointerOperand()->getType()) &&
765          "Cannot getElementOffset of a nonpointer type!");
766
767   PointerTy Total = 0;
768   const Type *Ty = I->getPointerOperand()->getType();
769   
770   unsigned ArgOff = I->getFirstIndexOperandNumber();
771   while (ArgOff < I->getNumOperands()) {
772     if (const StructType *STy = dyn_cast<StructType>(Ty)) {
773       const StructLayout *SLO = TD.getStructLayout(STy);
774       
775       // Indicies must be ubyte constants...
776       const ConstantUInt *CPU = cast<ConstantUInt>(I->getOperand(ArgOff++));
777       assert(CPU->getType() == Type::UByteTy);
778       unsigned Index = CPU->getValue();
779       
780 #ifdef PROFILE_STRUCTURE_FIELDS
781       if (ProfileStructureFields) {
782         // Do accounting for this field...
783         vector<unsigned> &OfC = FieldAccessCounts[STy];
784         if (OfC.size() == 0) OfC.resize(STy->getElementTypes().size());
785         OfC[Index]++;
786       }
787 #endif
788       
789       Total += SLO->MemberOffsets[Index];
790       Ty = STy->getElementTypes()[Index];
791     } else if (const SequentialType *ST = cast<SequentialType>(Ty)) {
792
793       // Get the index number for the array... which must be uint type...
794       assert(I->getOperand(ArgOff)->getType() == Type::UIntTy);
795       unsigned Idx = getOperandValue(I->getOperand(ArgOff++), SF).UIntVal;
796       if (const ArrayType *AT = dyn_cast<ArrayType>(ST))
797         if (Idx >= AT->getNumElements() && ArrayChecksEnabled) {
798           cerr << "Out of range memory access to element #" << Idx
799                << " of a " << AT->getNumElements() << " element array."
800                << " Subscript #" << (ArgOff-I->getFirstIndexOperandNumber())
801                << "\n";
802           // Get outta here!!!
803           siglongjmp(SignalRecoverBuffer, SIGTRAP);
804         }
805
806       Ty = ST->getElementType();
807       unsigned Size = TD.getTypeSize(Ty);
808       Total += Size*Idx;
809     }  
810   }
811
812   return Total;
813 }
814
815 static void executeGEPInst(GetElementPtrInst *I, ExecutionContext &SF) {
816   GenericValue SRC = getOperandValue(I->getPointerOperand(), SF);
817   PointerTy SrcPtr = SRC.PointerVal;
818
819   GenericValue Result;
820   Result.PointerVal = SrcPtr + getElementOffset(I, SF);
821   SetValue(I, Result, SF);
822 }
823
824 static void executeLoadInst(LoadInst *I, ExecutionContext &SF) {
825   GenericValue SRC = getOperandValue(I->getPointerOperand(), SF);
826   PointerTy SrcPtr = SRC.PointerVal;
827   PointerTy Offset = getElementOffset(I, SF);  // Handle any structure indices
828   SrcPtr += Offset;
829
830   GenericValue *Ptr = (GenericValue*)SrcPtr;
831   GenericValue Result;
832
833   switch (I->getType()->getPrimitiveID()) {
834   case Type::BoolTyID:
835   case Type::UByteTyID:
836   case Type::SByteTyID:   Result.SByteVal   = Ptr->SByteVal; break;
837   case Type::UShortTyID:
838   case Type::ShortTyID:   Result.ShortVal   = Ptr->ShortVal; break;
839   case Type::UIntTyID:
840   case Type::IntTyID:     Result.IntVal     = Ptr->IntVal; break;
841   case Type::ULongTyID:
842   case Type::LongTyID:    Result.ULongVal   = Ptr->ULongVal; break;
843   case Type::PointerTyID: Result.PointerVal = Ptr->PointerVal; break;
844   case Type::FloatTyID:   Result.FloatVal   = Ptr->FloatVal; break;
845   case Type::DoubleTyID:  Result.DoubleVal  = Ptr->DoubleVal; break;
846   default:
847     cout << "Cannot load value of type " << I->getType() << "!\n";
848   }
849
850   SetValue(I, Result, SF);
851 }
852
853 static void executeStoreInst(StoreInst *I, ExecutionContext &SF) {
854   GenericValue SRC = getOperandValue(I->getPointerOperand(), SF);
855   PointerTy SrcPtr = SRC.PointerVal;
856   SrcPtr += getElementOffset(I, SF);  // Handle any structure indices
857
858   GenericValue *Ptr = (GenericValue *)SrcPtr;
859   GenericValue Val = getOperandValue(I->getOperand(0), SF);
860
861   switch (I->getOperand(0)->getType()->getPrimitiveID()) {
862   case Type::BoolTyID:
863   case Type::UByteTyID:
864   case Type::SByteTyID:   Ptr->SByteVal = Val.SByteVal; break;
865   case Type::UShortTyID:
866   case Type::ShortTyID:   Ptr->ShortVal = Val.ShortVal; break;
867   case Type::UIntTyID:
868   case Type::IntTyID:     Ptr->IntVal = Val.IntVal; break;
869   case Type::ULongTyID:
870   case Type::LongTyID:    Ptr->LongVal = Val.LongVal; break;
871   case Type::PointerTyID: Ptr->PointerVal = Val.PointerVal; break;
872   case Type::FloatTyID:   Ptr->FloatVal = Val.FloatVal; break;
873   case Type::DoubleTyID:  Ptr->DoubleVal = Val.DoubleVal; break;
874   default:
875     cout << "Cannot store value of type " << I->getType() << "!\n";
876   }
877 }
878
879
880 //===----------------------------------------------------------------------===//
881 //                 Miscellaneous Instruction Implementations
882 //===----------------------------------------------------------------------===//
883
884 void Interpreter::executeCallInst(CallInst *I, ExecutionContext &SF) {
885   ECStack.back().Caller = I;
886   vector<GenericValue> ArgVals;
887   ArgVals.reserve(I->getNumOperands()-1);
888   for (unsigned i = 1; i < I->getNumOperands(); ++i)
889     ArgVals.push_back(getOperandValue(I->getOperand(i), SF));
890
891   // To handle indirect calls, we must get the pointer value from the argument 
892   // and treat it as a function pointer.
893   GenericValue SRC = getOperandValue(I->getCalledValue(), SF);
894   
895   callMethod((Function*)SRC.PointerVal, ArgVals);
896 }
897
898 static void executePHINode(PHINode *I, ExecutionContext &SF) {
899   BasicBlock *PrevBB = SF.PrevBB;
900   Value *IncomingValue = 0;
901
902   // Search for the value corresponding to this previous bb...
903   for (unsigned i = I->getNumIncomingValues(); i > 0;) {
904     if (I->getIncomingBlock(--i) == PrevBB) {
905       IncomingValue = I->getIncomingValue(i);
906       break;
907     }
908   }
909   assert(IncomingValue && "No PHI node predecessor for current PrevBB!");
910
911   // Found the value, set as the result...
912   SetValue(I, getOperandValue(IncomingValue, SF), SF);
913 }
914
915 #define IMPLEMENT_SHIFT(OP, TY) \
916    case Type::TY##TyID: Dest.TY##Val = Src1.TY##Val OP Src2.UByteVal; break
917
918 static void executeShlInst(ShiftInst *I, ExecutionContext &SF) {
919   const Type *Ty = I->getOperand(0)->getType();
920   GenericValue Src1  = getOperandValue(I->getOperand(0), SF);
921   GenericValue Src2  = getOperandValue(I->getOperand(1), SF);
922   GenericValue Dest;
923
924   switch (Ty->getPrimitiveID()) {
925     IMPLEMENT_SHIFT(<<, UByte);
926     IMPLEMENT_SHIFT(<<, SByte);
927     IMPLEMENT_SHIFT(<<, UShort);
928     IMPLEMENT_SHIFT(<<, Short);
929     IMPLEMENT_SHIFT(<<, UInt);
930     IMPLEMENT_SHIFT(<<, Int);
931     IMPLEMENT_SHIFT(<<, ULong);
932     IMPLEMENT_SHIFT(<<, Long);
933   default:
934     cout << "Unhandled type for Shl instruction: " << Ty << "\n";
935   }
936   SetValue(I, Dest, SF);
937 }
938
939 static void executeShrInst(ShiftInst *I, ExecutionContext &SF) {
940   const Type *Ty = I->getOperand(0)->getType();
941   GenericValue Src1  = getOperandValue(I->getOperand(0), SF);
942   GenericValue Src2  = getOperandValue(I->getOperand(1), SF);
943   GenericValue Dest;
944
945   switch (Ty->getPrimitiveID()) {
946     IMPLEMENT_SHIFT(>>, UByte);
947     IMPLEMENT_SHIFT(>>, SByte);
948     IMPLEMENT_SHIFT(>>, UShort);
949     IMPLEMENT_SHIFT(>>, Short);
950     IMPLEMENT_SHIFT(>>, UInt);
951     IMPLEMENT_SHIFT(>>, Int);
952     IMPLEMENT_SHIFT(>>, ULong);
953     IMPLEMENT_SHIFT(>>, Long);
954   default:
955     cout << "Unhandled type for Shr instruction: " << Ty << "\n";
956   }
957   SetValue(I, Dest, SF);
958 }
959
960 #define IMPLEMENT_CAST(DTY, DCTY, STY) \
961    case Type::STY##TyID: Dest.DTY##Val = DCTY Src.STY##Val; break;
962
963 #define IMPLEMENT_CAST_CASE_START(DESTTY, DESTCTY)    \
964   case Type::DESTTY##TyID:                      \
965     switch (SrcTy->getPrimitiveID()) {          \
966       IMPLEMENT_CAST(DESTTY, DESTCTY, UByte);   \
967       IMPLEMENT_CAST(DESTTY, DESTCTY, SByte);   \
968       IMPLEMENT_CAST(DESTTY, DESTCTY, UShort);  \
969       IMPLEMENT_CAST(DESTTY, DESTCTY, Short);   \
970       IMPLEMENT_CAST(DESTTY, DESTCTY, UInt);    \
971       IMPLEMENT_CAST(DESTTY, DESTCTY, Int);     \
972       IMPLEMENT_CAST(DESTTY, DESTCTY, ULong);   \
973       IMPLEMENT_CAST(DESTTY, DESTCTY, Long);    \
974       IMPLEMENT_CAST(DESTTY, DESTCTY, Pointer);
975
976 #define IMPLEMENT_CAST_CASE_FP_IMP(DESTTY, DESTCTY) \
977       IMPLEMENT_CAST(DESTTY, DESTCTY, Float);   \
978       IMPLEMENT_CAST(DESTTY, DESTCTY, Double)
979
980 #define IMPLEMENT_CAST_CASE_END()    \
981     default: cout << "Unhandled cast: " << SrcTy << " to " << Ty << "\n";  \
982       break;                                    \
983     }                                           \
984     break
985
986 #define IMPLEMENT_CAST_CASE(DESTTY, DESTCTY) \
987    IMPLEMENT_CAST_CASE_START(DESTTY, DESTCTY);   \
988    IMPLEMENT_CAST_CASE_FP_IMP(DESTTY, DESTCTY); \
989    IMPLEMENT_CAST_CASE_END()
990
991 static void executeCastInst(CastInst *I, ExecutionContext &SF) {
992   const Type *Ty = I->getType();
993   const Type *SrcTy = I->getOperand(0)->getType();
994   GenericValue Src  = getOperandValue(I->getOperand(0), SF);
995   GenericValue Dest;
996
997   switch (Ty->getPrimitiveID()) {
998     IMPLEMENT_CAST_CASE(UByte  , (unsigned char));
999     IMPLEMENT_CAST_CASE(SByte  , (  signed char));
1000     IMPLEMENT_CAST_CASE(UShort , (unsigned short));
1001     IMPLEMENT_CAST_CASE(Short  , (  signed char));
1002     IMPLEMENT_CAST_CASE(UInt   , (unsigned int ));
1003     IMPLEMENT_CAST_CASE(Int    , (  signed int ));
1004     IMPLEMENT_CAST_CASE(ULong  , (uint64_t));
1005     IMPLEMENT_CAST_CASE(Long   , ( int64_t));
1006     IMPLEMENT_CAST_CASE(Pointer, (PointerTy)(uint32_t));
1007     IMPLEMENT_CAST_CASE(Float  , (float));
1008     IMPLEMENT_CAST_CASE(Double , (double));
1009   default:
1010     cout << "Unhandled dest type for cast instruction: " << Ty << "\n";
1011   }
1012   SetValue(I, Dest, SF);
1013 }
1014
1015
1016
1017
1018 //===----------------------------------------------------------------------===//
1019 //                        Dispatch and Execution Code
1020 //===----------------------------------------------------------------------===//
1021
1022 MethodInfo::MethodInfo(Function *M) : Annotation(MethodInfoAID) {
1023   // Assign slot numbers to the function arguments...
1024   const Function::ArgumentListType &ArgList = M->getArgumentList();
1025   for (Function::ArgumentListType::const_iterator AI = ArgList.begin(), 
1026          AE = ArgList.end(); AI != AE; ++AI)
1027     ((Value*)(*AI))->addAnnotation(new SlotNumber(getValueSlot((Value*)*AI)));
1028
1029   // Iterate over all of the instructions...
1030   unsigned InstNum = 0;
1031   for (Function::iterator MI = M->begin(), ME = M->end(); MI != ME; ++MI) {
1032     BasicBlock *BB = *MI;
1033     for (BasicBlock::iterator II = BB->begin(), IE = BB->end(); II != IE; ++II){
1034       Instruction *I = *II;          // For each instruction... Add Annote
1035       I->addAnnotation(new InstNumber(++InstNum, getValueSlot(I)));
1036     }
1037   }
1038 }
1039
1040 unsigned MethodInfo::getValueSlot(const Value *V) {
1041   unsigned Plane = V->getType()->getUniqueID();
1042   if (Plane >= NumPlaneElements.size())
1043     NumPlaneElements.resize(Plane+1, 0);
1044   return NumPlaneElements[Plane]++;
1045 }
1046
1047
1048 //===----------------------------------------------------------------------===//
1049 // callMethod - Execute the specified function...
1050 //
1051 void Interpreter::callMethod(Function *M, const vector<GenericValue> &ArgVals) {
1052   assert((ECStack.empty() || ECStack.back().Caller == 0 || 
1053           ECStack.back().Caller->getNumOperands()-1 == ArgVals.size()) &&
1054          "Incorrect number of arguments passed into function call!");
1055   if (M->isExternal()) {
1056     GenericValue Result = callExternalMethod(M, ArgVals);
1057     const Type *RetTy = M->getReturnType();
1058
1059     // Copy the result back into the result variable if we are not returning
1060     // void.
1061     if (RetTy != Type::VoidTy) {
1062       if (!ECStack.empty() && ECStack.back().Caller) {
1063         ExecutionContext &SF = ECStack.back();
1064         SetValue(SF.Caller, Result, SF);
1065       
1066         SF.Caller = 0;          // We returned from the call...
1067       } else if (!QuietMode) {
1068         // print it.
1069         CW << "Function " << M->getType() << " \"" << M->getName()
1070            << "\" returned ";
1071         print(RetTy, Result); 
1072         cout << "\n";
1073         
1074         if (RetTy->isIntegral())
1075           ExitCode = Result.SByteVal;   // Capture the exit code of the program
1076       }
1077     }
1078
1079     return;
1080   }
1081
1082   // Process the function, assigning instruction numbers to the instructions in
1083   // the function.  Also calculate the number of values for each type slot
1084   // active.
1085   //
1086   MethodInfo *MethInfo = (MethodInfo*)M->getOrCreateAnnotation(MethodInfoAID);
1087   ECStack.push_back(ExecutionContext());         // Make a new stack frame...
1088
1089   ExecutionContext &StackFrame = ECStack.back(); // Fill it in...
1090   StackFrame.CurMethod = M;
1091   StackFrame.CurBB     = M->front();
1092   StackFrame.CurInst   = StackFrame.CurBB->begin();
1093   StackFrame.MethInfo  = MethInfo;
1094
1095   // Initialize the values to nothing...
1096   StackFrame.Values.resize(MethInfo->NumPlaneElements.size());
1097   for (unsigned i = 0; i < MethInfo->NumPlaneElements.size(); ++i) {
1098     StackFrame.Values[i].resize(MethInfo->NumPlaneElements[i]);
1099
1100     // Taint the initial values of stuff
1101     memset(&StackFrame.Values[i][0], 42,
1102            MethInfo->NumPlaneElements[i]*sizeof(GenericValue));
1103   }
1104
1105   StackFrame.PrevBB = 0;  // No previous BB for PHI nodes...
1106
1107
1108   // Run through the function arguments and initialize their values...
1109   assert(ArgVals.size() == M->getArgumentList().size() &&
1110          "Invalid number of values passed to function invocation!");
1111   unsigned i = 0;
1112   for (Function::ArgumentListType::iterator AI = M->getArgumentList().begin(),
1113          AE = M->getArgumentList().end(); AI != AE; ++AI, ++i) {
1114     SetValue((Value*)*AI, ArgVals[i], StackFrame);
1115   }
1116 }
1117
1118 // executeInstruction - Interpret a single instruction, increment the "PC", and
1119 // return true if the next instruction is a breakpoint...
1120 //
1121 bool Interpreter::executeInstruction() {
1122   assert(!ECStack.empty() && "No program running, cannot execute inst!");
1123
1124   ExecutionContext &SF = ECStack.back();  // Current stack frame
1125   Instruction *I = *SF.CurInst++;         // Increment before execute
1126
1127   if (Trace)
1128     CW << "Run:" << I;
1129
1130   // Set a sigsetjmp buffer so that we can recover if an error happens during
1131   // instruction execution...
1132   //
1133   if (int SigNo = sigsetjmp(SignalRecoverBuffer, 1)) {
1134     --SF.CurInst;   // Back up to erroring instruction
1135     if (SigNo != SIGINT) {
1136       cout << "EXCEPTION OCCURRED [" << _sys_siglistp[SigNo] << "]:\n";
1137       printStackTrace();
1138       // If -abort-on-exception was specified, terminate LLI instead of trying
1139       // to debug it.
1140       //
1141       if (AbortOnExceptions) exit(1);
1142     } else if (SigNo == SIGINT) {
1143       cout << "CTRL-C Detected, execution halted.\n";
1144     }
1145     InInstruction = false;
1146     return true;
1147   }
1148
1149   InInstruction = true;
1150   if (I->isBinaryOp()) {
1151     executeBinaryInst(cast<BinaryOperator>(I), SF);
1152   } else {
1153     switch (I->getOpcode()) {
1154       // Terminators
1155     case Instruction::Ret:     executeRetInst  (cast<ReturnInst>(I), SF); break;
1156     case Instruction::Br:      executeBrInst   (cast<BranchInst>(I), SF); break;
1157       // Memory Instructions
1158     case Instruction::Alloca:
1159     case Instruction::Malloc:  executeAllocInst((AllocationInst*)I, SF); break;
1160     case Instruction::Free:    executeFreeInst (cast<FreeInst> (I), SF); break;
1161     case Instruction::Load:    executeLoadInst (cast<LoadInst> (I), SF); break;
1162     case Instruction::Store:   executeStoreInst(cast<StoreInst>(I), SF); break;
1163     case Instruction::GetElementPtr:
1164                           executeGEPInst(cast<GetElementPtrInst>(I), SF); break;
1165
1166       // Miscellaneous Instructions
1167     case Instruction::Call:    executeCallInst (cast<CallInst> (I), SF); break;
1168     case Instruction::PHINode: executePHINode  (cast<PHINode>  (I), SF); break;
1169     case Instruction::Shl:     executeShlInst  (cast<ShiftInst>(I), SF); break;
1170     case Instruction::Shr:     executeShrInst  (cast<ShiftInst>(I), SF); break;
1171     case Instruction::Cast:    executeCastInst (cast<CastInst> (I), SF); break;
1172     default:
1173       cout << "Don't know how to execute this instruction!\n-->" << I;
1174     }
1175   }
1176   InInstruction = false;
1177   
1178   // Reset the current frame location to the top of stack
1179   CurFrame = ECStack.size()-1;
1180
1181   if (CurFrame == -1) return false;  // No breakpoint if no code
1182
1183   // Return true if there is a breakpoint annotation on the instruction...
1184   return (*ECStack[CurFrame].CurInst)->getAnnotation(BreakpointAID) != 0;
1185 }
1186
1187 void Interpreter::stepInstruction() {  // Do the 'step' command
1188   if (ECStack.empty()) {
1189     cout << "Error: no program running, cannot step!\n";
1190     return;
1191   }
1192
1193   // Run an instruction...
1194   executeInstruction();
1195
1196   // Print the next instruction to execute...
1197   printCurrentInstruction();
1198 }
1199
1200 // --- UI Stuff...
1201 void Interpreter::nextInstruction() {  // Do the 'next' command
1202   if (ECStack.empty()) {
1203     cout << "Error: no program running, cannot 'next'!\n";
1204     return;
1205   }
1206
1207   // If this is a call instruction, step over the call instruction...
1208   // TODO: ICALL, CALL WITH, ...
1209   if ((*ECStack.back().CurInst)->getOpcode() == Instruction::Call) {
1210     unsigned StackSize = ECStack.size();
1211     // Step into the function...
1212     if (executeInstruction()) {
1213       // Hit a breakpoint, print current instruction, then return to user...
1214       cout << "Breakpoint hit!\n";
1215       printCurrentInstruction();
1216       return;
1217     }
1218
1219     // If we we able to step into the function, finish it now.  We might not be
1220     // able the step into a function, if it's external for example.
1221     if (ECStack.size() != StackSize)
1222       finish(); // Finish executing the function...
1223     else
1224       printCurrentInstruction();
1225
1226   } else {
1227     // Normal instruction, just step...
1228     stepInstruction();
1229   }
1230 }
1231
1232 void Interpreter::run() {
1233   if (ECStack.empty()) {
1234     cout << "Error: no program running, cannot run!\n";
1235     return;
1236   }
1237
1238   bool HitBreakpoint = false;
1239   while (!ECStack.empty() && !HitBreakpoint) {
1240     // Run an instruction...
1241     HitBreakpoint = executeInstruction();
1242   }
1243
1244   if (HitBreakpoint) {
1245     cout << "Breakpoint hit!\n";
1246   }
1247   // Print the next instruction to execute...
1248   printCurrentInstruction();
1249 }
1250
1251 void Interpreter::finish() {
1252   if (ECStack.empty()) {
1253     cout << "Error: no program running, cannot run!\n";
1254     return;
1255   }
1256
1257   unsigned StackSize = ECStack.size();
1258   bool HitBreakpoint = false;
1259   while (ECStack.size() >= StackSize && !HitBreakpoint) {
1260     // Run an instruction...
1261     HitBreakpoint = executeInstruction();
1262   }
1263
1264   if (HitBreakpoint) {
1265     cout << "Breakpoint hit!\n";
1266   }
1267
1268   // Print the next instruction to execute...
1269   printCurrentInstruction();
1270 }
1271
1272
1273
1274 // printCurrentInstruction - Print out the instruction that the virtual PC is
1275 // at, or fail silently if no program is running.
1276 //
1277 void Interpreter::printCurrentInstruction() {
1278   if (!ECStack.empty()) {
1279     if (ECStack.back().CurBB->begin() == ECStack.back().CurInst)  // print label
1280       WriteAsOperand(cout, ECStack.back().CurBB) << ":\n";
1281
1282     Instruction *I = *ECStack.back().CurInst;
1283     InstNumber *IN = (InstNumber*)I->getAnnotation(SlotNumberAID);
1284     assert(IN && "Instruction has no numbering annotation!");
1285     cout << "#" << IN->InstNum << I;
1286   }
1287 }
1288
1289 void Interpreter::printValue(const Type *Ty, GenericValue V) {
1290   switch (Ty->getPrimitiveID()) {
1291   case Type::BoolTyID:   cout << (V.BoolVal?"true":"false"); break;
1292   case Type::SByteTyID:  cout << V.SByteVal;  break;
1293   case Type::UByteTyID:  cout << V.UByteVal;  break;
1294   case Type::ShortTyID:  cout << V.ShortVal;  break;
1295   case Type::UShortTyID: cout << V.UShortVal; break;
1296   case Type::IntTyID:    cout << V.IntVal;    break;
1297   case Type::UIntTyID:   cout << V.UIntVal;   break;
1298   case Type::LongTyID:   cout << (long)V.LongVal;   break;
1299   case Type::ULongTyID:  cout << (unsigned long)V.ULongVal;  break;
1300   case Type::FloatTyID:  cout << V.FloatVal;  break;
1301   case Type::DoubleTyID: cout << V.DoubleVal; break;
1302   case Type::PointerTyID:cout << (void*)V.PointerVal; break;
1303   default:
1304     cout << "- Don't know how to print value of this type!";
1305     break;
1306   }
1307 }
1308
1309 void Interpreter::print(const Type *Ty, GenericValue V) {
1310   CW << Ty << " ";
1311   printValue(Ty, V);
1312 }
1313
1314 void Interpreter::print(const std::string &Name) {
1315   Value *PickedVal = ChooseOneOption(Name, LookupMatchingNames(Name));
1316   if (!PickedVal) return;
1317
1318   if (const Function *F = dyn_cast<const Function>(PickedVal)) {
1319     CW << F;  // Print the function
1320   } else if (const Type *Ty = dyn_cast<const Type>(PickedVal)) {
1321     CW << "type %" << Name << " = " << Ty->getDescription() << "\n";
1322   } else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(PickedVal)) {
1323     CW << BB;   // Print the basic block
1324   } else {      // Otherwise there should be an annotation for the slot#
1325     print(PickedVal->getType(), 
1326           getOperandValue(PickedVal, ECStack[CurFrame]));
1327     cout << "\n";
1328   }
1329 }
1330
1331 void Interpreter::infoValue(const std::string &Name) {
1332   Value *PickedVal = ChooseOneOption(Name, LookupMatchingNames(Name));
1333   if (!PickedVal) return;
1334
1335   cout << "Value: ";
1336   print(PickedVal->getType(), 
1337         getOperandValue(PickedVal, ECStack[CurFrame]));
1338   cout << "\n";
1339   printOperandInfo(PickedVal, ECStack[CurFrame]);
1340 }
1341
1342 // printStackFrame - Print information about the specified stack frame, or -1
1343 // for the default one.
1344 //
1345 void Interpreter::printStackFrame(int FrameNo = -1) {
1346   if (FrameNo == -1) FrameNo = CurFrame;
1347   Function *Func = ECStack[FrameNo].CurMethod;
1348   const Type *RetTy = Func->getReturnType();
1349
1350   CW << ((FrameNo == CurFrame) ? '>' : '-') << "#" << FrameNo << ". "
1351      << (Value*)RetTy << " \"" << Func->getName() << "\"(";
1352   
1353   Function::ArgumentListType &Args = Func->getArgumentList();
1354   for (unsigned i = 0; i < Args.size(); ++i) {
1355     if (i != 0) cout << ", ";
1356     CW << (Value*)Args[i] << "=";
1357     
1358     printValue(((Value*)Args[i])->getType(),
1359                getOperandValue((Value*)Args[i], ECStack[FrameNo]));
1360   }
1361
1362   cout << ")\n";
1363   CW << *(ECStack[FrameNo].CurInst-(FrameNo != int(ECStack.size()-1)));
1364 }
1365