1 //===-- ExecutionEngine.cpp - Common Implementation shared by EEs ---------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file was developed by the LLVM research group and is distributed under 6 // the University of Illinois Open Source 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 "Interpreter/Interpreter.h" 17 #include "JIT/JIT.h" 18 #include "llvm/Constants.h" 19 #include "llvm/DerivedTypes.h" 20 #include "llvm/Module.h" 21 #include "llvm/ModuleProvider.h" 22 #include "llvm/ExecutionEngine/ExecutionEngine.h" 23 #include "llvm/ExecutionEngine/GenericValue.h" 24 #include "llvm/Target/TargetData.h" 25 #include "Support/Debug.h" 26 #include "Support/Statistic.h" 27 #include "Support/DynamicLinker.h" 28 #include "Config/dlfcn.h" 29 using namespace llvm; 30 31 namespace { 32 Statistic<> NumInitBytes("lli", "Number of bytes of global vars initialized"); 33 Statistic<> NumGlobals ("lli", "Number of global vars initialized"); 34 } 35 36 ExecutionEngine::ExecutionEngine(ModuleProvider *P) : 37 CurMod(*P->getModule()), MP(P) { 38 assert(P && "ModuleProvider is null?"); 39 } 40 41 ExecutionEngine::ExecutionEngine(Module *M) : CurMod(*M), MP(0) { 42 assert(M && "Module is null?"); 43 } 44 45 ExecutionEngine::~ExecutionEngine() { 46 delete MP; 47 } 48 49 /// If possible, create a JIT, unless the caller specifically requests an 50 /// Interpreter or there's an error. If even an Interpreter cannot be created, 51 /// NULL is returned. 52 /// 53 ExecutionEngine *ExecutionEngine::create(ModuleProvider *MP, 54 bool ForceInterpreter) { 55 ExecutionEngine *EE = 0; 56 57 // Unless the interpreter was explicitly selected, make a JIT. 58 if (!ForceInterpreter) 59 EE = JIT::create(MP); 60 61 // If we can't make a JIT, make an interpreter instead. 62 try { 63 if (EE == 0) 64 EE = Interpreter::create(MP->materializeModule()); 65 } catch (...) { 66 EE = 0; 67 } 68 return EE; 69 } 70 71 /// getPointerToGlobal - This returns the address of the specified global 72 /// value. This may involve code generation if it's a function. 73 /// 74 void *ExecutionEngine::getPointerToGlobal(const GlobalValue *GV) { 75 if (Function *F = const_cast<Function*>(dyn_cast<Function>(GV))) 76 return getPointerToFunction(F); 77 78 assert(GlobalAddress[GV] && "Global hasn't had an address allocated yet?"); 79 return GlobalAddress[GV]; 80 } 81 82 /// FIXME: document 83 /// 84 GenericValue ExecutionEngine::getConstantValue(const Constant *C) { 85 GenericValue Result; 86 87 if (ConstantExpr *CE = const_cast<ConstantExpr*>(dyn_cast<ConstantExpr>(C))) { 88 switch (CE->getOpcode()) { 89 case Instruction::GetElementPtr: { 90 Result = getConstantValue(CE->getOperand(0)); 91 std::vector<Value*> Indexes(CE->op_begin()+1, CE->op_end()); 92 uint64_t Offset = 93 TD->getIndexedOffset(CE->getOperand(0)->getType(), Indexes); 94 95 Result.LongVal += Offset; 96 return Result; 97 } 98 case Instruction::Cast: { 99 // We only need to handle a few cases here. Almost all casts will 100 // automatically fold, just the ones involving pointers won't. 101 // 102 Constant *Op = CE->getOperand(0); 103 104 // Handle cast of pointer to pointer... 105 if (Op->getType()->getPrimitiveID() == C->getType()->getPrimitiveID()) 106 return getConstantValue(Op); 107 108 // Handle a cast of pointer to any integral type... 109 if (isa<PointerType>(Op->getType()) && C->getType()->isIntegral()) 110 return getConstantValue(Op); 111 112 // Handle cast of long to pointer... 113 if (isa<PointerType>(C->getType()) && (Op->getType() == Type::LongTy || 114 Op->getType() == Type::ULongTy)) 115 return getConstantValue(Op); 116 break; 117 } 118 119 case Instruction::Add: 120 if (CE->getOperand(0)->getType() == Type::LongTy || 121 CE->getOperand(0)->getType() == Type::ULongTy) 122 Result.LongVal = getConstantValue(CE->getOperand(0)).LongVal + 123 getConstantValue(CE->getOperand(1)).LongVal; 124 else 125 break; 126 return Result; 127 128 default: 129 break; 130 } 131 std::cerr << "ConstantExpr not handled as global var init: " << *CE << "\n"; 132 abort(); 133 } 134 135 switch (C->getType()->getPrimitiveID()) { 136 #define GET_CONST_VAL(TY, CLASS) \ 137 case Type::TY##TyID: Result.TY##Val = cast<CLASS>(C)->getValue(); break 138 GET_CONST_VAL(Bool , ConstantBool); 139 GET_CONST_VAL(UByte , ConstantUInt); 140 GET_CONST_VAL(SByte , ConstantSInt); 141 GET_CONST_VAL(UShort , ConstantUInt); 142 GET_CONST_VAL(Short , ConstantSInt); 143 GET_CONST_VAL(UInt , ConstantUInt); 144 GET_CONST_VAL(Int , ConstantSInt); 145 GET_CONST_VAL(ULong , ConstantUInt); 146 GET_CONST_VAL(Long , ConstantSInt); 147 GET_CONST_VAL(Float , ConstantFP); 148 GET_CONST_VAL(Double , ConstantFP); 149 #undef GET_CONST_VAL 150 case Type::PointerTyID: 151 if (isa<ConstantPointerNull>(C)) { 152 Result.PointerVal = 0; 153 } else if (const ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(C)){ 154 if (Function *F = 155 const_cast<Function*>(dyn_cast<Function>(CPR->getValue()))) 156 Result = PTOGV(getPointerToFunctionOrStub(F)); 157 else 158 Result = PTOGV(getOrEmitGlobalVariable( 159 cast<GlobalVariable>(CPR->getValue()))); 160 161 } else { 162 assert(0 && "Unknown constant pointer type!"); 163 } 164 break; 165 default: 166 std::cout << "ERROR: Constant unimp for type: " << C->getType() << "\n"; 167 abort(); 168 } 169 return Result; 170 } 171 172 /// FIXME: document 173 /// 174 void ExecutionEngine::StoreValueToMemory(GenericValue Val, GenericValue *Ptr, 175 const Type *Ty) { 176 if (getTargetData().isLittleEndian()) { 177 switch (Ty->getPrimitiveID()) { 178 case Type::BoolTyID: 179 case Type::UByteTyID: 180 case Type::SByteTyID: Ptr->Untyped[0] = Val.UByteVal; break; 181 case Type::UShortTyID: 182 case Type::ShortTyID: Ptr->Untyped[0] = Val.UShortVal & 255; 183 Ptr->Untyped[1] = (Val.UShortVal >> 8) & 255; 184 break; 185 Store4BytesLittleEndian: 186 case Type::FloatTyID: 187 case Type::UIntTyID: 188 case Type::IntTyID: Ptr->Untyped[0] = Val.UIntVal & 255; 189 Ptr->Untyped[1] = (Val.UIntVal >> 8) & 255; 190 Ptr->Untyped[2] = (Val.UIntVal >> 16) & 255; 191 Ptr->Untyped[3] = (Val.UIntVal >> 24) & 255; 192 break; 193 case Type::PointerTyID: if (getTargetData().getPointerSize() == 4) 194 goto Store4BytesLittleEndian; 195 case Type::DoubleTyID: 196 case Type::ULongTyID: 197 case Type::LongTyID: Ptr->Untyped[0] = Val.ULongVal & 255; 198 Ptr->Untyped[1] = (Val.ULongVal >> 8) & 255; 199 Ptr->Untyped[2] = (Val.ULongVal >> 16) & 255; 200 Ptr->Untyped[3] = (Val.ULongVal >> 24) & 255; 201 Ptr->Untyped[4] = (Val.ULongVal >> 32) & 255; 202 Ptr->Untyped[5] = (Val.ULongVal >> 40) & 255; 203 Ptr->Untyped[6] = (Val.ULongVal >> 48) & 255; 204 Ptr->Untyped[7] = (Val.ULongVal >> 56) & 255; 205 break; 206 default: 207 std::cout << "Cannot store value of type " << Ty << "!\n"; 208 } 209 } else { 210 switch (Ty->getPrimitiveID()) { 211 case Type::BoolTyID: 212 case Type::UByteTyID: 213 case Type::SByteTyID: Ptr->Untyped[0] = Val.UByteVal; break; 214 case Type::UShortTyID: 215 case Type::ShortTyID: Ptr->Untyped[1] = Val.UShortVal & 255; 216 Ptr->Untyped[0] = (Val.UShortVal >> 8) & 255; 217 break; 218 Store4BytesBigEndian: 219 case Type::FloatTyID: 220 case Type::UIntTyID: 221 case Type::IntTyID: Ptr->Untyped[3] = Val.UIntVal & 255; 222 Ptr->Untyped[2] = (Val.UIntVal >> 8) & 255; 223 Ptr->Untyped[1] = (Val.UIntVal >> 16) & 255; 224 Ptr->Untyped[0] = (Val.UIntVal >> 24) & 255; 225 break; 226 case Type::PointerTyID: if (getTargetData().getPointerSize() == 4) 227 goto Store4BytesBigEndian; 228 case Type::DoubleTyID: 229 case Type::ULongTyID: 230 case Type::LongTyID: Ptr->Untyped[7] = Val.ULongVal & 255; 231 Ptr->Untyped[6] = (Val.ULongVal >> 8) & 255; 232 Ptr->Untyped[5] = (Val.ULongVal >> 16) & 255; 233 Ptr->Untyped[4] = (Val.ULongVal >> 24) & 255; 234 Ptr->Untyped[3] = (Val.ULongVal >> 32) & 255; 235 Ptr->Untyped[2] = (Val.ULongVal >> 40) & 255; 236 Ptr->Untyped[1] = (Val.ULongVal >> 48) & 255; 237 Ptr->Untyped[0] = (Val.ULongVal >> 56) & 255; 238 break; 239 default: 240 std::cout << "Cannot store value of type " << Ty << "!\n"; 241 } 242 } 243 } 244 245 /// FIXME: document 246 /// 247 GenericValue ExecutionEngine::LoadValueFromMemory(GenericValue *Ptr, 248 const Type *Ty) { 249 GenericValue Result; 250 if (getTargetData().isLittleEndian()) { 251 switch (Ty->getPrimitiveID()) { 252 case Type::BoolTyID: 253 case Type::UByteTyID: 254 case Type::SByteTyID: Result.UByteVal = Ptr->Untyped[0]; break; 255 case Type::UShortTyID: 256 case Type::ShortTyID: Result.UShortVal = (unsigned)Ptr->Untyped[0] | 257 ((unsigned)Ptr->Untyped[1] << 8); 258 break; 259 Load4BytesLittleEndian: 260 case Type::FloatTyID: 261 case Type::UIntTyID: 262 case Type::IntTyID: Result.UIntVal = (unsigned)Ptr->Untyped[0] | 263 ((unsigned)Ptr->Untyped[1] << 8) | 264 ((unsigned)Ptr->Untyped[2] << 16) | 265 ((unsigned)Ptr->Untyped[3] << 24); 266 break; 267 case Type::PointerTyID: if (getTargetData().getPointerSize() == 4) 268 goto Load4BytesLittleEndian; 269 case Type::DoubleTyID: 270 case Type::ULongTyID: 271 case Type::LongTyID: Result.ULongVal = (uint64_t)Ptr->Untyped[0] | 272 ((uint64_t)Ptr->Untyped[1] << 8) | 273 ((uint64_t)Ptr->Untyped[2] << 16) | 274 ((uint64_t)Ptr->Untyped[3] << 24) | 275 ((uint64_t)Ptr->Untyped[4] << 32) | 276 ((uint64_t)Ptr->Untyped[5] << 40) | 277 ((uint64_t)Ptr->Untyped[6] << 48) | 278 ((uint64_t)Ptr->Untyped[7] << 56); 279 break; 280 default: 281 std::cout << "Cannot load value of type " << *Ty << "!\n"; 282 abort(); 283 } 284 } else { 285 switch (Ty->getPrimitiveID()) { 286 case Type::BoolTyID: 287 case Type::UByteTyID: 288 case Type::SByteTyID: Result.UByteVal = Ptr->Untyped[0]; break; 289 case Type::UShortTyID: 290 case Type::ShortTyID: Result.UShortVal = (unsigned)Ptr->Untyped[1] | 291 ((unsigned)Ptr->Untyped[0] << 8); 292 break; 293 Load4BytesBigEndian: 294 case Type::FloatTyID: 295 case Type::UIntTyID: 296 case Type::IntTyID: Result.UIntVal = (unsigned)Ptr->Untyped[3] | 297 ((unsigned)Ptr->Untyped[2] << 8) | 298 ((unsigned)Ptr->Untyped[1] << 16) | 299 ((unsigned)Ptr->Untyped[0] << 24); 300 break; 301 case Type::PointerTyID: if (getTargetData().getPointerSize() == 4) 302 goto Load4BytesBigEndian; 303 case Type::DoubleTyID: 304 case Type::ULongTyID: 305 case Type::LongTyID: Result.ULongVal = (uint64_t)Ptr->Untyped[7] | 306 ((uint64_t)Ptr->Untyped[6] << 8) | 307 ((uint64_t)Ptr->Untyped[5] << 16) | 308 ((uint64_t)Ptr->Untyped[4] << 24) | 309 ((uint64_t)Ptr->Untyped[3] << 32) | 310 ((uint64_t)Ptr->Untyped[2] << 40) | 311 ((uint64_t)Ptr->Untyped[1] << 48) | 312 ((uint64_t)Ptr->Untyped[0] << 56); 313 break; 314 default: 315 std::cout << "Cannot load value of type " << *Ty << "!\n"; 316 abort(); 317 } 318 } 319 return Result; 320 } 321 322 // InitializeMemory - Recursive function to apply a Constant value into the 323 // specified memory location... 324 // 325 void ExecutionEngine::InitializeMemory(const Constant *Init, void *Addr) { 326 if (Init->getType()->isFirstClassType()) { 327 GenericValue Val = getConstantValue(Init); 328 StoreValueToMemory(Val, (GenericValue*)Addr, Init->getType()); 329 return; 330 } 331 332 switch (Init->getType()->getPrimitiveID()) { 333 case Type::ArrayTyID: { 334 const ConstantArray *CPA = cast<ConstantArray>(Init); 335 const std::vector<Use> &Val = CPA->getValues(); 336 unsigned ElementSize = 337 getTargetData().getTypeSize(cast<ArrayType>(CPA->getType())->getElementType()); 338 for (unsigned i = 0; i < Val.size(); ++i) 339 InitializeMemory(cast<Constant>(Val[i].get()), (char*)Addr+i*ElementSize); 340 return; 341 } 342 343 case Type::StructTyID: { 344 const ConstantStruct *CPS = cast<ConstantStruct>(Init); 345 const StructLayout *SL = 346 getTargetData().getStructLayout(cast<StructType>(CPS->getType())); 347 const std::vector<Use> &Val = CPS->getValues(); 348 for (unsigned i = 0; i < Val.size(); ++i) 349 InitializeMemory(cast<Constant>(Val[i].get()), 350 (char*)Addr+SL->MemberOffsets[i]); 351 return; 352 } 353 354 default: 355 std::cerr << "Bad Type: " << Init->getType() << "\n"; 356 assert(0 && "Unknown constant type to initialize memory with!"); 357 } 358 } 359 360 /// EmitGlobals - Emit all of the global variables to memory, storing their 361 /// addresses into GlobalAddress. This must make sure to copy the contents of 362 /// their initializers into the memory. 363 /// 364 void ExecutionEngine::emitGlobals() { 365 const TargetData &TD = getTargetData(); 366 367 // Loop over all of the global variables in the program, allocating the memory 368 // to hold them. 369 for (Module::giterator I = getModule().gbegin(), E = getModule().gend(); 370 I != E; ++I) 371 if (!I->isExternal()) { 372 // Get the type of the global... 373 const Type *Ty = I->getType()->getElementType(); 374 375 // Allocate some memory for it! 376 unsigned Size = TD.getTypeSize(Ty); 377 addGlobalMapping(I, new char[Size]); 378 379 DEBUG(std::cerr << "Global '" << I->getName() << "' -> " 380 << (void*)GlobalAddress[I] << "\n"); 381 } else { 382 // External variable reference. Try to use the dynamic loader to 383 // get a pointer to it. 384 if (void *SymAddr = GetAddressOfSymbol(I->getName().c_str())) 385 GlobalAddress[I] = SymAddr; 386 else { 387 std::cerr << "Could not resolve external global address: " 388 << I->getName() << "\n"; 389 abort(); 390 } 391 } 392 393 // Now that all of the globals are set up in memory, loop through them all and 394 // initialize their contents. 395 for (Module::giterator I = getModule().gbegin(), E = getModule().gend(); 396 I != E; ++I) 397 if (!I->isExternal()) 398 EmitGlobalVariable(I); 399 } 400 401 // EmitGlobalVariable - This method emits the specified global variable to the 402 // address specified in GlobalAddresses, or allocates new memory if it's not 403 // already in the map. 404 void ExecutionEngine::EmitGlobalVariable(const GlobalVariable *GV) { 405 void *&GA = GlobalAddress[GV]; 406 const Type *ElTy = GV->getType()->getElementType(); 407 if (GA == 0) { 408 // If it's not already specified, allocate memory for the global. 409 GA = new char[getTargetData().getTypeSize(ElTy)]; 410 } 411 412 InitializeMemory(GV->getInitializer(), GA); 413 NumInitBytes += getTargetData().getTypeSize(ElTy); 414 ++NumGlobals; 415 } 416