lib/ExecutionEngine/ExecutionEngine.cpp

   1 //===-- ExecutionEngine.cpp - Common Implementation shared by EEs ---------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the common interface used by the various execution engine
  11 // subclasses.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "jit"
  16 #include "llvm/Constants.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/ModuleProvider.h"
  20 #include "llvm/ADT/Statistic.h"
  21 #include "llvm/Config/alloca.h"
  22 #include "llvm/ExecutionEngine/ExecutionEngine.h"
  23 #include "llvm/ExecutionEngine/GenericValue.h"
  24 #include "llvm/Support/Debug.h"
  25 #include "llvm/Support/MutexGuard.h"
  26 #include "llvm/System/DynamicLibrary.h"
  27 #include "llvm/System/Host.h"
  28 #include "llvm/Target/TargetData.h"
  29 #include <cmath>
  30 #include <cstring>
  31 using namespace llvm;
  32
  33 STATISTIC(NumInitBytes, "Number of bytes of global vars initialized");
  34 STATISTIC(NumGlobals  , "Number of global vars initialized");
  35
  36 ExecutionEngine::EECtorFn ExecutionEngine::JITCtor = 0;
  37 ExecutionEngine::EECtorFn ExecutionEngine::InterpCtor = 0;
  38 ExecutionEngine::EERegisterFn ExecutionEngine::ExceptionTableRegister = 0;
  39
  40
  41 ExecutionEngine::ExecutionEngine(ModuleProvider *P) : LazyFunctionCreator(0) {
  42   LazyCompilationDisabled = false;
  43   GVCompilationDisabled   = false;
  44   SymbolSearchingDisabled = false;
  45   Modules.push_back(P);
  46   assert(P && "ModuleProvider is null?");
  47 }
  48
  49 ExecutionEngine::~ExecutionEngine() {
  50   clearAllGlobalMappings();
  51   for (unsigned i = 0, e = Modules.size(); i != e; ++i)
  52     delete Modules[i];
  53 }
  54
  55 /// removeModuleProvider - Remove a ModuleProvider from the list of modules.
  56 /// Release module from ModuleProvider.
  57 Module* ExecutionEngine::removeModuleProvider(ModuleProvider *P,
  58                                               std::string *ErrInfo) {
  59   for(SmallVector<ModuleProvider *, 1>::iterator I = Modules.begin(),
  60         E = Modules.end(); I != E; ++I) {
  61     ModuleProvider *MP = *I;
  62     if (MP == P) {
  63       Modules.erase(I);
  64       clearGlobalMappingsFromModule(MP->getModule());
  65       return MP->releaseModule(ErrInfo);
  66     }
  67   }
  68   return NULL;
  69 }
  70
  71 /// FindFunctionNamed - Search all of the active modules to find the one that
  72 /// defines FnName.  This is very slow operation and shouldn't be used for
  73 /// general code.
  74 Function *ExecutionEngine::FindFunctionNamed(const char *FnName) {
  75   for (unsigned i = 0, e = Modules.size(); i != e; ++i) {
  76     if (Function *F = Modules[i]->getModule()->getFunction(FnName))
  77       return F;
  78   }
  79   return 0;
  80 }
  81
  82
  83 /// addGlobalMapping - Tell the execution engine that the specified global is
  84 /// at the specified location.  This is used internally as functions are JIT'd
  85 /// and as global variables are laid out in memory.  It can and should also be
  86 /// used by clients of the EE that want to have an LLVM global overlay
  87 /// existing data in memory.
  88 void ExecutionEngine::addGlobalMapping(const GlobalValue *GV, void *Addr) {
  89   MutexGuard locked(lock);
  90
  91   DOUT << "Map " << *GV << " to " << Addr << "\n";
  92   void *&CurVal = state.getGlobalAddressMap(locked)[GV];
  93   assert((CurVal == 0 || Addr == 0) && "GlobalMapping already established!");
  94   CurVal = Addr;
  95
  96   // If we are using the reverse mapping, add it too
  97   if (!state.getGlobalAddressReverseMap(locked).empty()) {
  98     const GlobalValue *&V = state.getGlobalAddressReverseMap(locked)[Addr];
  99     assert((V == 0 || GV == 0) && "GlobalMapping already established!");
 100     V = GV;
 101   }
 102 }
 103
 104 /// clearAllGlobalMappings - Clear all global mappings and start over again
 105 /// use in dynamic compilation scenarios when you want to move globals
 106 void ExecutionEngine::clearAllGlobalMappings() {
 107   MutexGuard locked(lock);
 108
 109   state.getGlobalAddressMap(locked).clear();
 110   state.getGlobalAddressReverseMap(locked).clear();
 111 }
 112
 113 /// clearGlobalMappingsFromModule - Clear all global mappings that came from a
 114 /// particular module, because it has been removed from the JIT.
 115 void ExecutionEngine::clearGlobalMappingsFromModule(Module *M) {
 116   MutexGuard locked(lock);
 117
 118   for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; ++FI) {
 119     state.getGlobalAddressMap(locked).erase(FI);
 120     state.getGlobalAddressReverseMap(locked).erase(FI);
 121   }
 122   for (Module::global_iterator GI = M->global_begin(), GE = M->global_end();
 123        GI != GE; ++GI) {
 124     state.getGlobalAddressMap(locked).erase(GI);
 125     state.getGlobalAddressReverseMap(locked).erase(GI);
 126   }
 127 }
 128
 129 /// updateGlobalMapping - Replace an existing mapping for GV with a new
 130 /// address.  This updates both maps as required.  If "Addr" is null, the
 131 /// entry for the global is removed from the mappings.
 132 void *ExecutionEngine::updateGlobalMapping(const GlobalValue *GV, void *Addr) {
 133   MutexGuard locked(lock);
 134
 135   std::map<const GlobalValue*, void *> &Map = state.getGlobalAddressMap(locked);
 136
 137   // Deleting from the mapping?
 138   if (Addr == 0) {
 139     std::map<const GlobalValue*, void *>::iterator I = Map.find(GV);
 140     void *OldVal;
 141     if (I == Map.end())
 142       OldVal = 0;
 143     else {
 144       OldVal = I->second;
 145       Map.erase(I);
 146     }
 147
 148     if (!state.getGlobalAddressReverseMap(locked).empty())
 149       state.getGlobalAddressReverseMap(locked).erase(Addr);
 150     return OldVal;
 151   }
 152
 153   void *&CurVal = Map[GV];
 154   void *OldVal = CurVal;
 155
 156   if (CurVal && !state.getGlobalAddressReverseMap(locked).empty())
 157     state.getGlobalAddressReverseMap(locked).erase(CurVal);
 158   CurVal = Addr;
 159
 160   // If we are using the reverse mapping, add it too
 161   if (!state.getGlobalAddressReverseMap(locked).empty()) {
 162     const GlobalValue *&V = state.getGlobalAddressReverseMap(locked)[Addr];
 163     assert((V == 0 || GV == 0) && "GlobalMapping already established!");
 164     V = GV;
 165   }
 166   return OldVal;
 167 }
 168
 169 /// getPointerToGlobalIfAvailable - This returns the address of the specified
 170 /// global value if it is has already been codegen'd, otherwise it returns null.
 171 ///
 172 void *ExecutionEngine::getPointerToGlobalIfAvailable(const GlobalValue *GV) {
 173   MutexGuard locked(lock);
 174
 175   std::map<const GlobalValue*, void*>::iterator I =
 176   state.getGlobalAddressMap(locked).find(GV);
 177   return I != state.getGlobalAddressMap(locked).end() ? I->second : 0;
 178 }
 179
 180 /// getGlobalValueAtAddress - Return the LLVM global value object that starts
 181 /// at the specified address.
 182 ///
 183 const GlobalValue *ExecutionEngine::getGlobalValueAtAddress(void *Addr) {
 184   MutexGuard locked(lock);
 185
 186   // If we haven't computed the reverse mapping yet, do so first.
 187   if (state.getGlobalAddressReverseMap(locked).empty()) {
 188     for (std::map<const GlobalValue*, void *>::iterator
 189          I = state.getGlobalAddressMap(locked).begin(),
 190          E = state.getGlobalAddressMap(locked).end(); I != E; ++I)
 191       state.getGlobalAddressReverseMap(locked).insert(std::make_pair(I->second,
 192                                                                      I->first));
 193   }
 194
 195   std::map<void *, const GlobalValue*>::iterator I =
 196     state.getGlobalAddressReverseMap(locked).find(Addr);
 197   return I != state.getGlobalAddressReverseMap(locked).end() ? I->second : 0;
 198 }
 199
 200 // CreateArgv - Turn a vector of strings into a nice argv style array of
 201 // pointers to null terminated strings.
 202 //
 203 static void *CreateArgv(ExecutionEngine *EE,
 204                         const std::vector<std::string> &InputArgv) {
 205   unsigned PtrSize = EE->getTargetData()->getPointerSize();
 206   char *Result = new char[(InputArgv.size()+1)*PtrSize];
 207
 208   DOUT << "ARGV = " << (void*)Result << "\n";
 209   const Type *SBytePtr = PointerType::getUnqual(Type::Int8Ty);
 210
 211   for (unsigned i = 0; i != InputArgv.size(); ++i) {
 212     unsigned Size = InputArgv[i].size()+1;
 213     char *Dest = new char[Size];
 214     DOUT << "ARGV[" << i << "] = " << (void*)Dest << "\n";
 215
 216     std::copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
 217     Dest[Size-1] = 0;
 218
 219     // Endian safe: Result[i] = (PointerTy)Dest;
 220     EE->StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i*PtrSize),
 221                            SBytePtr);
 222   }
 223
 224   // Null terminate it
 225   EE->StoreValueToMemory(PTOGV(0),
 226                          (GenericValue*)(Result+InputArgv.size()*PtrSize),
 227                          SBytePtr);
 228   return Result;
 229 }
 230
 231
 232 /// runStaticConstructorsDestructors - This method is used to execute all of
 233 /// the static constructors or destructors for a module, depending on the
 234 /// value of isDtors.
 235 void ExecutionEngine::runStaticConstructorsDestructors(Module *module, bool isDtors) {
 236   const char *Name = isDtors ? "llvm.global_dtors" : "llvm.global_ctors";
 237
 238   // Execute global ctors/dtors for each module in the program.
 239
 240  GlobalVariable *GV = module->getNamedGlobal(Name);
 241
 242  // If this global has internal linkage, or if it has a use, then it must be
 243  // an old-style (llvmgcc3) static ctor with __main linked in and in use.  If
 244  // this is the case, don't execute any of the global ctors, __main will do
 245  // it.
 246  if (!GV || GV->isDeclaration() || GV->hasInternalLinkage()) return;
 247
 248  // Should be an array of '{ int, void ()* }' structs.  The first value is
 249  // the init priority, which we ignore.
 250  ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
 251  if (!InitList) return;
 252  for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
 253    if (ConstantStruct *CS =
 254        dyn_cast<ConstantStruct>(InitList->getOperand(i))) {
 255      if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
 256
 257      Constant *FP = CS->getOperand(1);
 258      if (FP->isNullValue())
 259        break;  // Found a null terminator, exit.
 260
 261      if (ConstantExpr *CE = dyn_cast<ConstantExpr>(FP))
 262        if (CE->isCast())
 263          FP = CE->getOperand(0);
 264      if (Function *F = dyn_cast<Function>(FP)) {
 265        // Execute the ctor/dtor function!
 266        runFunction(F, std::vector<GenericValue>());
 267      }
 268    }
 269 }
 270
 271 /// runStaticConstructorsDestructors - This method is used to execute all of
 272 /// the static constructors or destructors for a program, depending on the
 273 /// value of isDtors.
 274 void ExecutionEngine::runStaticConstructorsDestructors(bool isDtors) {
 275   // Execute global ctors/dtors for each module in the program.
 276   for (unsigned m = 0, e = Modules.size(); m != e; ++m)
 277     runStaticConstructorsDestructors(Modules[m]->getModule(), isDtors);
 278 }
 279
 280 #ifndef NDEBUG
 281 /// isTargetNullPtr - Return whether the target pointer stored at Loc is null.
 282 static bool isTargetNullPtr(ExecutionEngine *EE, void *Loc) {
 283   unsigned PtrSize = EE->getTargetData()->getPointerSize();
 284   for (unsigned i = 0; i < PtrSize; ++i)
 285     if (*(i + (uint8_t*)Loc))
 286       return false;
 287   return true;
 288 }
 289 #endif
 290
 291 /// runFunctionAsMain - This is a helper function which wraps runFunction to
 292 /// handle the common task of starting up main with the specified argc, argv,
 293 /// and envp parameters.
 294 int ExecutionEngine::runFunctionAsMain(Function *Fn,
 295                                        const std::vector<std::string> &argv,
 296                                        const char * const * envp) {
 297   std::vector<GenericValue> GVArgs;
 298   GenericValue GVArgc;
 299   GVArgc.IntVal = APInt(32, argv.size());
 300
 301   // Check main() type
 302   unsigned NumArgs = Fn->getFunctionType()->getNumParams();
 303   const FunctionType *FTy = Fn->getFunctionType();
 304   const Type* PPInt8Ty =
 305     PointerType::getUnqual(PointerType::getUnqual(Type::Int8Ty));
 306   switch (NumArgs) {
 307   case 3:
 308    if (FTy->getParamType(2) != PPInt8Ty) {
 309      cerr << "Invalid type for third argument of main() supplied\n";
 310      abort();
 311    }
 312    // FALLS THROUGH
 313   case 2:
 314    if (FTy->getParamType(1) != PPInt8Ty) {
 315      cerr << "Invalid type for second argument of main() supplied\n";
 316      abort();
 317    }
 318    // FALLS THROUGH
 319   case 1:
 320    if (FTy->getParamType(0) != Type::Int32Ty) {
 321      cerr << "Invalid type for first argument of main() supplied\n";
 322      abort();
 323    }
 324    // FALLS THROUGH
 325   case 0:
 326    if (FTy->getReturnType() != Type::Int32Ty &&
 327        FTy->getReturnType() != Type::VoidTy) {
 328      cerr << "Invalid return type of main() supplied\n";
 329      abort();
 330    }
 331    break;
 332   default:
 333    cerr << "Invalid number of arguments of main() supplied\n";
 334    abort();
 335   }
 336
 337   if (NumArgs) {
 338     GVArgs.push_back(GVArgc); // Arg #0 = argc.
 339     if (NumArgs > 1) {
 340       GVArgs.push_back(PTOGV(CreateArgv(this, argv))); // Arg #1 = argv.
 341       assert(!isTargetNullPtr(this, GVTOP(GVArgs[1])) &&
 342              "argv[0] was null after CreateArgv");
 343       if (NumArgs > 2) {
 344         std::vector<std::string> EnvVars;
 345         for (unsigned i = 0; envp[i]; ++i)
 346           EnvVars.push_back(envp[i]);
 347         GVArgs.push_back(PTOGV(CreateArgv(this, EnvVars))); // Arg #2 = envp.
 348       }
 349     }
 350   }
 351   return runFunction(Fn, GVArgs).IntVal.getZExtValue();
 352 }
 353
 354 /// If possible, create a JIT, unless the caller specifically requests an
 355 /// Interpreter or there's an error. If even an Interpreter cannot be created,
 356 /// NULL is returned.
 357 ///
 358 ExecutionEngine *ExecutionEngine::create(ModuleProvider *MP,
 359                                          bool ForceInterpreter,
 360                                          std::string *ErrorStr,
 361                                          bool Fast) {
 362   ExecutionEngine *EE = 0;
 363
 364   // Make sure we can resolve symbols in the program as well. The zero arg
 365   // to the function tells DynamicLibrary to load the program, not a library.
 366   if (sys::DynamicLibrary::LoadLibraryPermanently(0, ErrorStr))
 367     return 0;
 368
 369   // Unless the interpreter was explicitly selected, try making a JIT.
 370   if (!ForceInterpreter && JITCtor)
 371     EE = JITCtor(MP, ErrorStr, Fast);
 372
 373   // If we can't make a JIT, make an interpreter instead.
 374   if (EE == 0 && InterpCtor)
 375     EE = InterpCtor(MP, ErrorStr, Fast);
 376
 377   return EE;
 378 }
 379
 380 ExecutionEngine *ExecutionEngine::create(Module *M) {
 381   return create(new ExistingModuleProvider(M));
 382 }
 383
 384 /// getPointerToGlobal - This returns the address of the specified global
 385 /// value.  This may involve code generation if it's a function.
 386 ///
 387 void *ExecutionEngine::getPointerToGlobal(const GlobalValue *GV) {
 388   if (Function *F = const_cast<Function*>(dyn_cast<Function>(GV)))
 389     return getPointerToFunction(F);
 390
 391   MutexGuard locked(lock);
 392   void *p = state.getGlobalAddressMap(locked)[GV];
 393   if (p)
 394     return p;
 395
 396   // Global variable might have been added since interpreter started.
 397   if (GlobalVariable *GVar =
 398           const_cast<GlobalVariable *>(dyn_cast<GlobalVariable>(GV)))
 399     EmitGlobalVariable(GVar);
 400   else
 401     assert(0 && "Global hasn't had an address allocated yet!");
 402   return state.getGlobalAddressMap(locked)[GV];
 403 }
 404
 405 /// This function converts a Constant* into a GenericValue. The interesting
 406 /// part is if C is a ConstantExpr.
 407 /// @brief Get a GenericValue for a Constant*
 408 GenericValue ExecutionEngine::getConstantValue(const Constant *C) {
 409   // If its undefined, return the garbage.
 410   if (isa<UndefValue>(C))
 411     return GenericValue();
 412
 413   // If the value is a ConstantExpr
 414   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
 415     Constant *Op0 = CE->getOperand(0);
 416     switch (CE->getOpcode()) {
 417     case Instruction::GetElementPtr: {
 418       // Compute the index
 419       GenericValue Result = getConstantValue(Op0);
 420       SmallVector<Value*, 8> Indices(CE->op_begin()+1, CE->op_end());
 421       uint64_t Offset =
 422         TD->getIndexedOffset(Op0->getType(), &Indices[0], Indices.size());
 423
 424       char* tmp = (char*) Result.PointerVal;
 425       Result = PTOGV(tmp + Offset);
 426       return Result;
 427     }
 428     case Instruction::Trunc: {
 429       GenericValue GV = getConstantValue(Op0);
 430       uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
 431       GV.IntVal = GV.IntVal.trunc(BitWidth);
 432       return GV;
 433     }
 434     case Instruction::ZExt: {
 435       GenericValue GV = getConstantValue(Op0);
 436       uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
 437       GV.IntVal = GV.IntVal.zext(BitWidth);
 438       return GV;
 439     }
 440     case Instruction::SExt: {
 441       GenericValue GV = getConstantValue(Op0);
 442       uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
 443       GV.IntVal = GV.IntVal.sext(BitWidth);
 444       return GV;
 445     }
 446     case Instruction::FPTrunc: {
 447       // FIXME long double
 448       GenericValue GV = getConstantValue(Op0);
 449       GV.FloatVal = float(GV.DoubleVal);
 450       return GV;
 451     }
 452     case Instruction::FPExt:{
 453       // FIXME long double
 454       GenericValue GV = getConstantValue(Op0);
 455       GV.DoubleVal = double(GV.FloatVal);
 456       return GV;
 457     }
 458     case Instruction::UIToFP: {
 459       GenericValue GV = getConstantValue(Op0);
 460       if (CE->getType() == Type::FloatTy)
 461         GV.FloatVal = float(GV.IntVal.roundToDouble());
 462       else if (CE->getType() == Type::DoubleTy)
 463         GV.DoubleVal = GV.IntVal.roundToDouble();
 464       else if (CE->getType() == Type::X86_FP80Ty) {
 465         const uint64_t zero[] = {0, 0};
 466         APFloat apf = APFloat(APInt(80, 2, zero));
 467         (void)apf.convertFromAPInt(GV.IntVal,
 468                                    false,
 469                                    APFloat::rmNearestTiesToEven);
 470         GV.IntVal = apf.bitcastToAPInt();
 471       }
 472       return GV;
 473     }
 474     case Instruction::SIToFP: {
 475       GenericValue GV = getConstantValue(Op0);
 476       if (CE->getType() == Type::FloatTy)
 477         GV.FloatVal = float(GV.IntVal.signedRoundToDouble());
 478       else if (CE->getType() == Type::DoubleTy)
 479         GV.DoubleVal = GV.IntVal.signedRoundToDouble();
 480       else if (CE->getType() == Type::X86_FP80Ty) {
 481         const uint64_t zero[] = { 0, 0};
 482         APFloat apf = APFloat(APInt(80, 2, zero));
 483         (void)apf.convertFromAPInt(GV.IntVal,
 484                                    true,
 485                                    APFloat::rmNearestTiesToEven);
 486         GV.IntVal = apf.bitcastToAPInt();
 487       }
 488       return GV;
 489     }
 490     case Instruction::FPToUI: // double->APInt conversion handles sign
 491     case Instruction::FPToSI: {
 492       GenericValue GV = getConstantValue(Op0);
 493       uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
 494       if (Op0->getType() == Type::FloatTy)
 495         GV.IntVal = APIntOps::RoundFloatToAPInt(GV.FloatVal, BitWidth);
 496       else if (Op0->getType() == Type::DoubleTy)
 497         GV.IntVal = APIntOps::RoundDoubleToAPInt(GV.DoubleVal, BitWidth);
 498       else if (Op0->getType() == Type::X86_FP80Ty) {
 499         APFloat apf = APFloat(GV.IntVal);
 500         uint64_t v;
 501         bool ignored;
 502         (void)apf.convertToInteger(&v, BitWidth,
 503                                    CE->getOpcode()==Instruction::FPToSI,
 504                                    APFloat::rmTowardZero, &ignored);
 505         GV.IntVal = v; // endian?
 506       }
 507       return GV;
 508     }
 509     case Instruction::PtrToInt: {
 510       GenericValue GV = getConstantValue(Op0);
 511       uint32_t PtrWidth = TD->getPointerSizeInBits();
 512       GV.IntVal = APInt(PtrWidth, uintptr_t(GV.PointerVal));
 513       return GV;
 514     }
 515     case Instruction::IntToPtr: {
 516       GenericValue GV = getConstantValue(Op0);
 517       uint32_t PtrWidth = TD->getPointerSizeInBits();
 518       if (PtrWidth != GV.IntVal.getBitWidth())
 519         GV.IntVal = GV.IntVal.zextOrTrunc(PtrWidth);
 520       assert(GV.IntVal.getBitWidth() <= 64 && "Bad pointer width");
 521       GV.PointerVal = PointerTy(uintptr_t(GV.IntVal.getZExtValue()));
 522       return GV;
 523     }
 524     case Instruction::BitCast: {
 525       GenericValue GV = getConstantValue(Op0);
 526       const Type* DestTy = CE->getType();
 527       switch (Op0->getType()->getTypeID()) {
 528         default: assert(0 && "Invalid bitcast operand");
 529         case Type::IntegerTyID:
 530           assert(DestTy->isFloatingPoint() && "invalid bitcast");
 531           if (DestTy == Type::FloatTy)
 532             GV.FloatVal = GV.IntVal.bitsToFloat();
 533           else if (DestTy == Type::DoubleTy)
 534             GV.DoubleVal = GV.IntVal.bitsToDouble();
 535           break;
 536         case Type::FloatTyID:
 537           assert(DestTy == Type::Int32Ty && "Invalid bitcast");
 538           GV.IntVal.floatToBits(GV.FloatVal);
 539           break;
 540         case Type::DoubleTyID:
 541           assert(DestTy == Type::Int64Ty && "Invalid bitcast");
 542           GV.IntVal.doubleToBits(GV.DoubleVal);
 543           break;
 544         case Type::PointerTyID:
 545           assert(isa<PointerType>(DestTy) && "Invalid bitcast");
 546           break; // getConstantValue(Op0)  above already converted it
 547       }
 548       return GV;
 549     }
 550     case Instruction::Add:
 551     case Instruction::Sub:
 552     case Instruction::Mul:
 553     case Instruction::UDiv:
 554     case Instruction::SDiv:
 555     case Instruction::URem:
 556     case Instruction::SRem:
 557     case Instruction::And:
 558     case Instruction::Or:
 559     case Instruction::Xor: {
 560       GenericValue LHS = getConstantValue(Op0);
 561       GenericValue RHS = getConstantValue(CE->getOperand(1));
 562       GenericValue GV;
 563       switch (CE->getOperand(0)->getType()->getTypeID()) {
 564       default: assert(0 && "Bad add type!"); abort();
 565       case Type::IntegerTyID:
 566         switch (CE->getOpcode()) {
 567           default: assert(0 && "Invalid integer opcode");
 568           case Instruction::Add: GV.IntVal = LHS.IntVal + RHS.IntVal; break;
 569           case Instruction::Sub: GV.IntVal = LHS.IntVal - RHS.IntVal; break;
 570           case Instruction::Mul: GV.IntVal = LHS.IntVal * RHS.IntVal; break;
 571           case Instruction::UDiv:GV.IntVal = LHS.IntVal.udiv(RHS.IntVal); break;
 572           case Instruction::SDiv:GV.IntVal = LHS.IntVal.sdiv(RHS.IntVal); break;
 573           case Instruction::URem:GV.IntVal = LHS.IntVal.urem(RHS.IntVal); break;
 574           case Instruction::SRem:GV.IntVal = LHS.IntVal.srem(RHS.IntVal); break;
 575           case Instruction::And: GV.IntVal = LHS.IntVal & RHS.IntVal; break;
 576           case Instruction::Or:  GV.IntVal = LHS.IntVal | RHS.IntVal; break;
 577           case Instruction::Xor: GV.IntVal = LHS.IntVal ^ RHS.IntVal; break;
 578         }
 579         break;
 580       case Type::FloatTyID:
 581         switch (CE->getOpcode()) {
 582           default: assert(0 && "Invalid float opcode"); abort();
 583           case Instruction::Add:
 584             GV.FloatVal = LHS.FloatVal + RHS.FloatVal; break;
 585           case Instruction::Sub:
 586             GV.FloatVal = LHS.FloatVal - RHS.FloatVal; break;
 587           case Instruction::Mul:
 588             GV.FloatVal = LHS.FloatVal * RHS.FloatVal; break;
 589           case Instruction::FDiv:
 590             GV.FloatVal = LHS.FloatVal / RHS.FloatVal; break;
 591           case Instruction::FRem:
 592             GV.FloatVal = ::fmodf(LHS.FloatVal,RHS.FloatVal); break;
 593         }
 594         break;
 595       case Type::DoubleTyID:
 596         switch (CE->getOpcode()) {
 597           default: assert(0 && "Invalid double opcode"); abort();
 598           case Instruction::Add:
 599             GV.DoubleVal = LHS.DoubleVal + RHS.DoubleVal; break;
 600           case Instruction::Sub:
 601             GV.DoubleVal = LHS.DoubleVal - RHS.DoubleVal; break;
 602           case Instruction::Mul:
 603             GV.DoubleVal = LHS.DoubleVal * RHS.DoubleVal; break;
 604           case Instruction::FDiv:
 605             GV.DoubleVal = LHS.DoubleVal / RHS.DoubleVal; break;
 606           case Instruction::FRem:
 607             GV.DoubleVal = ::fmod(LHS.DoubleVal,RHS.DoubleVal); break;
 608         }
 609         break;
 610       case Type::X86_FP80TyID:
 611       case Type::PPC_FP128TyID:
 612       case Type::FP128TyID: {
 613         APFloat apfLHS = APFloat(LHS.IntVal);
 614         switch (CE->getOpcode()) {
 615           default: assert(0 && "Invalid long double opcode"); abort();
 616           case Instruction::Add:
 617             apfLHS.add(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
 618             GV.IntVal = apfLHS.bitcastToAPInt();
 619             break;
 620           case Instruction::Sub:
 621             apfLHS.subtract(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
 622             GV.IntVal = apfLHS.bitcastToAPInt();
 623             break;
 624           case Instruction::Mul:
 625             apfLHS.multiply(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
 626             GV.IntVal = apfLHS.bitcastToAPInt();
 627             break;
 628           case Instruction::FDiv:
 629             apfLHS.divide(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
 630             GV.IntVal = apfLHS.bitcastToAPInt();
 631             break;
 632           case Instruction::FRem:
 633             apfLHS.mod(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
 634             GV.IntVal = apfLHS.bitcastToAPInt();
 635             break;
 636           }
 637         }
 638         break;
 639       }
 640       return GV;
 641     }
 642     default:
 643       break;
 644     }
 645     cerr << "ConstantExpr not handled: " << *CE << "\n";
 646     abort();
 647   }
 648
 649   GenericValue Result;
 650   switch (C->getType()->getTypeID()) {
 651   case Type::FloatTyID:
 652     Result.FloatVal = cast<ConstantFP>(C)->getValueAPF().convertToFloat();
 653     break;
 654   case Type::DoubleTyID:
 655     Result.DoubleVal = cast<ConstantFP>(C)->getValueAPF().convertToDouble();
 656     break;
 657   case Type::X86_FP80TyID:
 658   case Type::FP128TyID:
 659   case Type::PPC_FP128TyID:
 660     Result.IntVal = cast <ConstantFP>(C)->getValueAPF().bitcastToAPInt();
 661     break;
 662   case Type::IntegerTyID:
 663     Result.IntVal = cast<ConstantInt>(C)->getValue();
 664     break;
 665   case Type::PointerTyID:
 666     if (isa<ConstantPointerNull>(C))
 667       Result.PointerVal = 0;
 668     else if (const Function *F = dyn_cast<Function>(C))
 669       Result = PTOGV(getPointerToFunctionOrStub(const_cast<Function*>(F)));
 670     else if (const GlobalVariable* GV = dyn_cast<GlobalVariable>(C))
 671       Result = PTOGV(getOrEmitGlobalVariable(const_cast<GlobalVariable*>(GV)));
 672     else
 673       assert(0 && "Unknown constant pointer type!");
 674     break;
 675   default:
 676     cerr << "ERROR: Constant unimplemented for type: " << *C->getType() << "\n";
 677     abort();
 678   }
 679   return Result;
 680 }
 681
 682 /// StoreIntToMemory - Fills the StoreBytes bytes of memory starting from Dst
 683 /// with the integer held in IntVal.
 684 static void StoreIntToMemory(const APInt &IntVal, uint8_t *Dst,
 685                              unsigned StoreBytes) {
 686   assert((IntVal.getBitWidth()+7)/8 >= StoreBytes && "Integer too small!");
 687   uint8_t *Src = (uint8_t *)IntVal.getRawData();
 688
 689   if (sys::littleEndianHost())
 690     // Little-endian host - the source is ordered from LSB to MSB.  Order the
 691     // destination from LSB to MSB: Do a straight copy.
 692     memcpy(Dst, Src, StoreBytes);
 693   else {
 694     // Big-endian host - the source is an array of 64 bit words ordered from
 695     // LSW to MSW.  Each word is ordered from MSB to LSB.  Order the destination
 696     // from MSB to LSB: Reverse the word order, but not the bytes in a word.
 697     while (StoreBytes > sizeof(uint64_t)) {
 698       StoreBytes -= sizeof(uint64_t);
 699       // May not be aligned so use memcpy.
 700       memcpy(Dst + StoreBytes, Src, sizeof(uint64_t));
 701       Src += sizeof(uint64_t);
 702     }
 703
 704     memcpy(Dst, Src + sizeof(uint64_t) - StoreBytes, StoreBytes);
 705   }
 706 }
 707
 708 /// StoreValueToMemory - Stores the data in Val of type Ty at address Ptr.  Ptr
 709 /// is the address of the memory at which to store Val, cast to GenericValue *.
 710 /// It is not a pointer to a GenericValue containing the address at which to
 711 /// store Val.
 712 void ExecutionEngine::StoreValueToMemory(const GenericValue &Val, GenericValue *Ptr,
 713                                          const Type *Ty) {
 714   const unsigned StoreBytes = getTargetData()->getTypeStoreSize(Ty);
 715
 716   switch (Ty->getTypeID()) {
 717   case Type::IntegerTyID:
 718     StoreIntToMemory(Val.IntVal, (uint8_t*)Ptr, StoreBytes);
 719     break;
 720   case Type::FloatTyID:
 721     *((float*)Ptr) = Val.FloatVal;
 722     break;
 723   case Type::DoubleTyID:
 724     *((double*)Ptr) = Val.DoubleVal;
 725     break;
 726   case Type::X86_FP80TyID: {
 727       uint16_t *Dest = (uint16_t*)Ptr;
 728       const uint16_t *Src = (uint16_t*)Val.IntVal.getRawData();
 729       // This is endian dependent, but it will only work on x86 anyway.
 730       Dest[0] = Src[4];
 731       Dest[1] = Src[0];
 732       Dest[2] = Src[1];
 733       Dest[3] = Src[2];
 734       Dest[4] = Src[3];
 735       break;
 736     }
 737   case Type::PointerTyID:
 738     // Ensure 64 bit target pointers are fully initialized on 32 bit hosts.
 739     if (StoreBytes != sizeof(PointerTy))
 740       memset(Ptr, 0, StoreBytes);
 741
 742     *((PointerTy*)Ptr) = Val.PointerVal;
 743     break;
 744   default:
 745     cerr << "Cannot store value of type " << *Ty << "!\n";
 746   }
 747
 748   if (sys::littleEndianHost() != getTargetData()->isLittleEndian())
 749     // Host and target are different endian - reverse the stored bytes.
 750     std::reverse((uint8_t*)Ptr, StoreBytes + (uint8_t*)Ptr);
 751 }
 752
 753 /// LoadIntFromMemory - Loads the integer stored in the LoadBytes bytes starting
 754 /// from Src into IntVal, which is assumed to be wide enough and to hold zero.
 755 static void LoadIntFromMemory(APInt &IntVal, uint8_t *Src, unsigned LoadBytes) {
 756   assert((IntVal.getBitWidth()+7)/8 >= LoadBytes && "Integer too small!");
 757   uint8_t *Dst = (uint8_t *)IntVal.getRawData();
 758
 759   if (sys::littleEndianHost())
 760     // Little-endian host - the destination must be ordered from LSB to MSB.
 761     // The source is ordered from LSB to MSB: Do a straight copy.
 762     memcpy(Dst, Src, LoadBytes);
 763   else {
 764     // Big-endian - the destination is an array of 64 bit words ordered from
 765     // LSW to MSW.  Each word must be ordered from MSB to LSB.  The source is
 766     // ordered from MSB to LSB: Reverse the word order, but not the bytes in
 767     // a word.
 768     while (LoadBytes > sizeof(uint64_t)) {
 769       LoadBytes -= sizeof(uint64_t);
 770       // May not be aligned so use memcpy.
 771       memcpy(Dst, Src + LoadBytes, sizeof(uint64_t));
 772       Dst += sizeof(uint64_t);
 773     }
 774
 775     memcpy(Dst + sizeof(uint64_t) - LoadBytes, Src, LoadBytes);
 776   }
 777 }
 778
 779 /// FIXME: document
 780 ///
 781 void ExecutionEngine::LoadValueFromMemory(GenericValue &Result,
 782                                           GenericValue *Ptr,
 783                                           const Type *Ty) {
 784   const unsigned LoadBytes = getTargetData()->getTypeStoreSize(Ty);
 785
 786   if (sys::littleEndianHost() != getTargetData()->isLittleEndian()) {
 787     // Host and target are different endian - reverse copy the stored
 788     // bytes into a buffer, and load from that.
 789     uint8_t *Src = (uint8_t*)Ptr;
 790     uint8_t *Buf = (uint8_t*)alloca(LoadBytes);
 791     std::reverse_copy(Src, Src + LoadBytes, Buf);
 792     Ptr = (GenericValue*)Buf;
 793   }
 794
 795   switch (Ty->getTypeID()) {
 796   case Type::IntegerTyID:
 797     // An APInt with all words initially zero.
 798     Result.IntVal = APInt(cast<IntegerType>(Ty)->getBitWidth(), 0);
 799     LoadIntFromMemory(Result.IntVal, (uint8_t*)Ptr, LoadBytes);
 800     break;
 801   case Type::FloatTyID:
 802     Result.FloatVal = *((float*)Ptr);
 803     break;
 804   case Type::DoubleTyID:
 805     Result.DoubleVal = *((double*)Ptr);
 806     break;
 807   case Type::PointerTyID:
 808     Result.PointerVal = *((PointerTy*)Ptr);
 809     break;
 810   case Type::X86_FP80TyID: {
 811     // This is endian dependent, but it will only work on x86 anyway.
 812     // FIXME: Will not trap if loading a signaling NaN.
 813     uint16_t *p = (uint16_t*)Ptr;
 814     union {
 815       uint16_t x[8];
 816       uint64_t y[2];
 817     };
 818     x[0] = p[1];
 819     x[1] = p[2];
 820     x[2] = p[3];
 821     x[3] = p[4];
 822     x[4] = p[0];
 823     Result.IntVal = APInt(80, 2, y);
 824     break;
 825   }
 826   default:
 827     cerr << "Cannot load value of type " << *Ty << "!\n";
 828     abort();
 829   }
 830 }
 831
 832 // InitializeMemory - Recursive function to apply a Constant value into the
 833 // specified memory location...
 834 //
 835 void ExecutionEngine::InitializeMemory(const Constant *Init, void *Addr) {
 836   DOUT << "Initializing " << Addr;
 837   DEBUG(Init->dump());
 838   if (isa<UndefValue>(Init)) {
 839     return;
 840   } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(Init)) {
 841     unsigned ElementSize =
 842       getTargetData()->getABITypeSize(CP->getType()->getElementType());
 843     for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
 844       InitializeMemory(CP->getOperand(i), (char*)Addr+i*ElementSize);
 845     return;
 846   } else if (isa<ConstantAggregateZero>(Init)) {
 847     memset(Addr, 0, (size_t)getTargetData()->getABITypeSize(Init->getType()));
 848     return;
 849   } else if (const ConstantArray *CPA = dyn_cast<ConstantArray>(Init)) {
 850     unsigned ElementSize =
 851       getTargetData()->getABITypeSize(CPA->getType()->getElementType());
 852     for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
 853       InitializeMemory(CPA->getOperand(i), (char*)Addr+i*ElementSize);
 854     return;
 855   } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(Init)) {
 856     const StructLayout *SL =
 857       getTargetData()->getStructLayout(cast<StructType>(CPS->getType()));
 858     for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
 859       InitializeMemory(CPS->getOperand(i), (char*)Addr+SL->getElementOffset(i));
 860     return;
 861   } else if (Init->getType()->isFirstClassType()) {
 862     GenericValue Val = getConstantValue(Init);
 863     StoreValueToMemory(Val, (GenericValue*)Addr, Init->getType());
 864     return;
 865   }
 866
 867   cerr << "Bad Type: " << *Init->getType() << "\n";
 868   assert(0 && "Unknown constant type to initialize memory with!");
 869 }
 870
 871 /// EmitGlobals - Emit all of the global variables to memory, storing their
 872 /// addresses into GlobalAddress.  This must make sure to copy the contents of
 873 /// their initializers into the memory.
 874 ///
 875 void ExecutionEngine::emitGlobals() {
 876   const TargetData *TD = getTargetData();
 877
 878   // Loop over all of the global variables in the program, allocating the memory
 879   // to hold them.  If there is more than one module, do a prepass over globals
 880   // to figure out how the different modules should link together.
 881   //
 882   std::map<std::pair<std::string, const Type*>,
 883            const GlobalValue*> LinkedGlobalsMap;
 884
 885   if (Modules.size() != 1) {
 886     for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
 887       Module &M = *Modules[m]->getModule();
 888       for (Module::const_global_iterator I = M.global_begin(),
 889            E = M.global_end(); I != E; ++I) {
 890         const GlobalValue *GV = I;
 891         if (GV->hasInternalLinkage() || GV->isDeclaration() ||
 892             GV->hasAppendingLinkage() || !GV->hasName())
 893           continue;// Ignore external globals and globals with internal linkage.
 894
 895         const GlobalValue *&GVEntry =
 896           LinkedGlobalsMap[std::make_pair(GV->getName(), GV->getType())];
 897
 898         // If this is the first time we've seen this global, it is the canonical
 899         // version.
 900         if (!GVEntry) {
 901           GVEntry = GV;
 902           continue;
 903         }
 904
 905         // If the existing global is strong, never replace it.
 906         if (GVEntry->hasExternalLinkage() ||
 907             GVEntry->hasDLLImportLinkage() ||
 908             GVEntry->hasDLLExportLinkage())
 909           continue;
 910
 911         // Otherwise, we know it's linkonce/weak, replace it if this is a strong
 912         // symbol.  FIXME is this right for common?
 913         if (GV->hasExternalLinkage() || GVEntry->hasExternalWeakLinkage())
 914           GVEntry = GV;
 915       }
 916     }
 917   }
 918
 919   std::vector<const GlobalValue*> NonCanonicalGlobals;
 920   for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
 921     Module &M = *Modules[m]->getModule();
 922     for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 923          I != E; ++I) {
 924       // In the multi-module case, see what this global maps to.
 925       if (!LinkedGlobalsMap.empty()) {
 926         if (const GlobalValue *GVEntry =
 927               LinkedGlobalsMap[std::make_pair(I->getName(), I->getType())]) {
 928           // If something else is the canonical global, ignore this one.
 929           if (GVEntry != &*I) {
 930             NonCanonicalGlobals.push_back(I);
 931             continue;
 932           }
 933         }
 934       }
 935
 936       if (!I->isDeclaration()) {
 937         // Get the type of the global.
 938         const Type *Ty = I->getType()->getElementType();
 939
 940         // Allocate some memory for it!
 941         unsigned Size = TD->getABITypeSize(Ty);
 942         addGlobalMapping(I, new char[Size]);
 943       } else {
 944         // External variable reference. Try to use the dynamic loader to
 945         // get a pointer to it.
 946         if (void *SymAddr =
 947             sys::DynamicLibrary::SearchForAddressOfSymbol(I->getName().c_str()))
 948           addGlobalMapping(I, SymAddr);
 949         else {
 950           cerr << "Could not resolve external global address: "
 951                << I->getName() << "\n";
 952           abort();
 953         }
 954       }
 955     }
 956
 957     // If there are multiple modules, map the non-canonical globals to their
 958     // canonical location.
 959     if (!NonCanonicalGlobals.empty()) {
 960       for (unsigned i = 0, e = NonCanonicalGlobals.size(); i != e; ++i) {
 961         const GlobalValue *GV = NonCanonicalGlobals[i];
 962         const GlobalValue *CGV =
 963           LinkedGlobalsMap[std::make_pair(GV->getName(), GV->getType())];
 964         void *Ptr = getPointerToGlobalIfAvailable(CGV);
 965         assert(Ptr && "Canonical global wasn't codegen'd!");
 966         addGlobalMapping(GV, getPointerToGlobalIfAvailable(CGV));
 967       }
 968     }
 969
 970     // Now that all of the globals are set up in memory, loop through them all
 971     // and initialize their contents.
 972     for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 973          I != E; ++I) {
 974       if (!I->isDeclaration()) {
 975         if (!LinkedGlobalsMap.empty()) {
 976           if (const GlobalValue *GVEntry =
 977                 LinkedGlobalsMap[std::make_pair(I->getName(), I->getType())])
 978             if (GVEntry != &*I)  // Not the canonical variable.
 979               continue;
 980         }
 981         EmitGlobalVariable(I);
 982       }
 983     }
 984   }
 985 }
 986
 987 // EmitGlobalVariable - This method emits the specified global variable to the
 988 // address specified in GlobalAddresses, or allocates new memory if it's not
 989 // already in the map.
 990 void ExecutionEngine::EmitGlobalVariable(const GlobalVariable *GV) {
 991   void *GA = getPointerToGlobalIfAvailable(GV);
 992   DOUT << "Global '" << GV->getName() << "' -> " << GA << "\n";
 993
 994   const Type *ElTy = GV->getType()->getElementType();
 995   size_t GVSize = (size_t)getTargetData()->getABITypeSize(ElTy);
 996   if (GA == 0) {
 997     // If it's not already specified, allocate memory for the global.
 998     GA = new char[GVSize];
 999     addGlobalMapping(GV, GA);
1000   }
1001
1002   InitializeMemory(GV->getInitializer(), GA);
1003   NumInitBytes += (unsigned)GVSize;
1004   ++NumGlobals;
1005 }