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