1 //===-- ExecutionEngine.cpp - Common Implementation shared by EEs ---------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file defines the common interface used by the various execution engine
13 //===----------------------------------------------------------------------===//
15 #define DEBUG_TYPE "jit"
16 #include "Interpreter/Interpreter.h"
18 #include "llvm/Constants.h"
19 #include "llvm/DerivedTypes.h"
20 #include "llvm/Module.h"
21 #include "llvm/ModuleProvider.h"
22 #include "llvm/ADT/Statistic.h"
23 #include "llvm/CodeGen/IntrinsicLowering.h"
24 #include "llvm/ExecutionEngine/ExecutionEngine.h"
25 #include "llvm/ExecutionEngine/GenericValue.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/System/DynamicLibrary.h"
28 #include "llvm/Target/TargetData.h"
32 Statistic<> NumInitBytes("lli", "Number of bytes of global vars initialized");
33 Statistic<> NumGlobals ("lli", "Number of global vars initialized");
36 ExecutionEngine::ExecutionEngine(ModuleProvider *P) :
37 CurMod(*P->getModule()), MP(P) {
38 assert(P && "ModuleProvider is null?");
41 ExecutionEngine::ExecutionEngine(Module *M) : CurMod(*M), MP(0) {
42 assert(M && "Module is null?");
45 ExecutionEngine::~ExecutionEngine() {
49 /// getGlobalValueAtAddress - Return the LLVM global value object that starts
50 /// at the specified address.
52 const GlobalValue *ExecutionEngine::getGlobalValueAtAddress(void *Addr) {
53 // If we haven't computed the reverse mapping yet, do so first.
54 if (GlobalAddressReverseMap.empty()) {
55 for (std::map<const GlobalValue*, void *>::iterator I =
56 GlobalAddressMap.begin(), E = GlobalAddressMap.end(); I != E; ++I)
57 GlobalAddressReverseMap.insert(std::make_pair(I->second, I->first));
60 std::map<void *, const GlobalValue*>::iterator I =
61 GlobalAddressReverseMap.find(Addr);
62 return I != GlobalAddressReverseMap.end() ? I->second : 0;
65 // CreateArgv - Turn a vector of strings into a nice argv style array of
66 // pointers to null terminated strings.
68 static void *CreateArgv(ExecutionEngine *EE,
69 const std::vector<std::string> &InputArgv) {
70 unsigned PtrSize = EE->getTargetData().getPointerSize();
71 char *Result = new char[(InputArgv.size()+1)*PtrSize];
73 DEBUG(std::cerr << "ARGV = " << (void*)Result << "\n");
74 const Type *SBytePtr = PointerType::get(Type::SByteTy);
76 for (unsigned i = 0; i != InputArgv.size(); ++i) {
77 unsigned Size = InputArgv[i].size()+1;
78 char *Dest = new char[Size];
79 DEBUG(std::cerr << "ARGV[" << i << "] = " << (void*)Dest << "\n");
81 std::copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
84 // Endian safe: Result[i] = (PointerTy)Dest;
85 EE->StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i*PtrSize),
90 EE->StoreValueToMemory(PTOGV(0),
91 (GenericValue*)(Result+InputArgv.size()*PtrSize),
96 /// runFunctionAsMain - This is a helper function which wraps runFunction to
97 /// handle the common task of starting up main with the specified argc, argv,
98 /// and envp parameters.
99 int ExecutionEngine::runFunctionAsMain(Function *Fn,
100 const std::vector<std::string> &argv,
101 const char * const * envp) {
102 std::vector<GenericValue> GVArgs;
104 GVArgc.IntVal = argv.size();
105 unsigned NumArgs = Fn->getFunctionType()->getNumParams();
107 GVArgs.push_back(GVArgc); // Arg #0 = argc.
109 GVArgs.push_back(PTOGV(CreateArgv(this, argv))); // Arg #1 = argv.
110 assert(((char **)GVTOP(GVArgs[1]))[0] &&
111 "argv[0] was null after CreateArgv");
113 std::vector<std::string> EnvVars;
114 for (unsigned i = 0; envp[i]; ++i)
115 EnvVars.push_back(envp[i]);
116 GVArgs.push_back(PTOGV(CreateArgv(this, EnvVars))); // Arg #2 = envp.
120 return runFunction(Fn, GVArgs).IntVal;
125 /// If possible, create a JIT, unless the caller specifically requests an
126 /// Interpreter or there's an error. If even an Interpreter cannot be created,
127 /// NULL is returned.
129 ExecutionEngine *ExecutionEngine::create(ModuleProvider *MP,
130 bool ForceInterpreter,
131 IntrinsicLowering *IL) {
132 ExecutionEngine *EE = 0;
134 // Unless the interpreter was explicitly selected, try making a JIT.
135 if (!ForceInterpreter)
136 EE = JIT::create(MP, IL);
138 // If we can't make a JIT, make an interpreter instead.
141 Module *M = MP->materializeModule();
143 EE = Interpreter::create(M, IL);
145 std::cerr << "Error creating the interpreter!\n";
147 } catch (std::string& errmsg) {
148 std::cerr << "Error reading the bytecode file: " << errmsg << "\n";
150 std::cerr << "Error reading the bytecode file!\n";
157 // Make sure we can resolve symbols in the program as well. The zero arg
158 // to the function tells DynamicLibrary to load the program, not a library.
159 sys::DynamicLibrary::LoadLibraryPermanently(0);
164 /// getPointerToGlobal - This returns the address of the specified global
165 /// value. This may involve code generation if it's a function.
167 void *ExecutionEngine::getPointerToGlobal(const GlobalValue *GV) {
168 if (Function *F = const_cast<Function*>(dyn_cast<Function>(GV)))
169 return getPointerToFunction(F);
171 assert(GlobalAddressMap[GV] && "Global hasn't had an address allocated yet?");
172 return GlobalAddressMap[GV];
177 GenericValue ExecutionEngine::getConstantValue(const Constant *C) {
179 if (isa<UndefValue>(C)) return Result;
181 if (ConstantExpr *CE = const_cast<ConstantExpr*>(dyn_cast<ConstantExpr>(C))) {
182 switch (CE->getOpcode()) {
183 case Instruction::GetElementPtr: {
184 Result = getConstantValue(CE->getOperand(0));
185 std::vector<Value*> Indexes(CE->op_begin()+1, CE->op_end());
187 TD->getIndexedOffset(CE->getOperand(0)->getType(), Indexes);
189 Result.LongVal += Offset;
192 case Instruction::Cast: {
193 // We only need to handle a few cases here. Almost all casts will
194 // automatically fold, just the ones involving pointers won't.
196 Constant *Op = CE->getOperand(0);
197 GenericValue GV = getConstantValue(Op);
199 // Handle cast of pointer to pointer...
200 if (Op->getType()->getTypeID() == C->getType()->getTypeID())
203 // Handle a cast of pointer to any integral type...
204 if (isa<PointerType>(Op->getType()) && C->getType()->isIntegral())
207 // Handle cast of integer to a pointer...
208 if (isa<PointerType>(C->getType()) && Op->getType()->isIntegral())
209 switch (Op->getType()->getTypeID()) {
210 case Type::BoolTyID: return PTOGV((void*)(uintptr_t)GV.BoolVal);
211 case Type::SByteTyID: return PTOGV((void*)( intptr_t)GV.SByteVal);
212 case Type::UByteTyID: return PTOGV((void*)(uintptr_t)GV.UByteVal);
213 case Type::ShortTyID: return PTOGV((void*)( intptr_t)GV.ShortVal);
214 case Type::UShortTyID: return PTOGV((void*)(uintptr_t)GV.UShortVal);
215 case Type::IntTyID: return PTOGV((void*)( intptr_t)GV.IntVal);
216 case Type::UIntTyID: return PTOGV((void*)(uintptr_t)GV.UIntVal);
217 case Type::LongTyID: return PTOGV((void*)( intptr_t)GV.LongVal);
218 case Type::ULongTyID: return PTOGV((void*)(uintptr_t)GV.ULongVal);
219 default: assert(0 && "Unknown integral type!");
224 case Instruction::Add:
225 switch (CE->getOperand(0)->getType()->getTypeID()) {
226 default: assert(0 && "Bad add type!"); abort();
228 case Type::ULongTyID:
229 Result.LongVal = getConstantValue(CE->getOperand(0)).LongVal +
230 getConstantValue(CE->getOperand(1)).LongVal;
234 Result.IntVal = getConstantValue(CE->getOperand(0)).IntVal +
235 getConstantValue(CE->getOperand(1)).IntVal;
237 case Type::ShortTyID:
238 case Type::UShortTyID:
239 Result.ShortVal = getConstantValue(CE->getOperand(0)).ShortVal +
240 getConstantValue(CE->getOperand(1)).ShortVal;
242 case Type::SByteTyID:
243 case Type::UByteTyID:
244 Result.SByteVal = getConstantValue(CE->getOperand(0)).SByteVal +
245 getConstantValue(CE->getOperand(1)).SByteVal;
247 case Type::FloatTyID:
248 Result.FloatVal = getConstantValue(CE->getOperand(0)).FloatVal +
249 getConstantValue(CE->getOperand(1)).FloatVal;
251 case Type::DoubleTyID:
252 Result.DoubleVal = getConstantValue(CE->getOperand(0)).DoubleVal +
253 getConstantValue(CE->getOperand(1)).DoubleVal;
260 std::cerr << "ConstantExpr not handled as global var init: " << *CE << "\n";
264 switch (C->getType()->getTypeID()) {
265 #define GET_CONST_VAL(TY, CTY, CLASS) \
266 case Type::TY##TyID: Result.TY##Val = (CTY)cast<CLASS>(C)->getValue(); break
267 GET_CONST_VAL(Bool , bool , ConstantBool);
268 GET_CONST_VAL(UByte , unsigned char , ConstantUInt);
269 GET_CONST_VAL(SByte , signed char , ConstantSInt);
270 GET_CONST_VAL(UShort , unsigned short, ConstantUInt);
271 GET_CONST_VAL(Short , signed short , ConstantSInt);
272 GET_CONST_VAL(UInt , unsigned int , ConstantUInt);
273 GET_CONST_VAL(Int , signed int , ConstantSInt);
274 GET_CONST_VAL(ULong , unsigned long , ConstantUInt);
275 GET_CONST_VAL(Long , signed long , ConstantSInt);
276 GET_CONST_VAL(Float , float , ConstantFP);
277 GET_CONST_VAL(Double , double , ConstantFP);
279 case Type::PointerTyID:
280 if (isa<ConstantPointerNull>(C))
281 Result.PointerVal = 0;
282 else if (const Function *F = dyn_cast<Function>(C))
283 Result = PTOGV(getPointerToFunctionOrStub(const_cast<Function*>(F)));
284 else if (const GlobalVariable* GV = dyn_cast<GlobalVariable>(C))
285 Result = PTOGV(getOrEmitGlobalVariable(const_cast<GlobalVariable*>(GV)));
287 assert(0 && "Unknown constant pointer type!");
290 std::cout << "ERROR: Constant unimp for type: " << *C->getType() << "\n";
298 void ExecutionEngine::StoreValueToMemory(GenericValue Val, GenericValue *Ptr,
300 if (getTargetData().isLittleEndian()) {
301 switch (Ty->getTypeID()) {
303 case Type::UByteTyID:
304 case Type::SByteTyID: Ptr->Untyped[0] = Val.UByteVal; break;
305 case Type::UShortTyID:
306 case Type::ShortTyID: Ptr->Untyped[0] = Val.UShortVal & 255;
307 Ptr->Untyped[1] = (Val.UShortVal >> 8) & 255;
309 Store4BytesLittleEndian:
310 case Type::FloatTyID:
312 case Type::IntTyID: Ptr->Untyped[0] = Val.UIntVal & 255;
313 Ptr->Untyped[1] = (Val.UIntVal >> 8) & 255;
314 Ptr->Untyped[2] = (Val.UIntVal >> 16) & 255;
315 Ptr->Untyped[3] = (Val.UIntVal >> 24) & 255;
317 case Type::PointerTyID: if (getTargetData().getPointerSize() == 4)
318 goto Store4BytesLittleEndian;
319 case Type::DoubleTyID:
320 case Type::ULongTyID:
322 Ptr->Untyped[0] = (unsigned char)(Val.ULongVal );
323 Ptr->Untyped[1] = (unsigned char)(Val.ULongVal >> 8);
324 Ptr->Untyped[2] = (unsigned char)(Val.ULongVal >> 16);
325 Ptr->Untyped[3] = (unsigned char)(Val.ULongVal >> 24);
326 Ptr->Untyped[4] = (unsigned char)(Val.ULongVal >> 32);
327 Ptr->Untyped[5] = (unsigned char)(Val.ULongVal >> 40);
328 Ptr->Untyped[6] = (unsigned char)(Val.ULongVal >> 48);
329 Ptr->Untyped[7] = (unsigned char)(Val.ULongVal >> 56);
332 std::cout << "Cannot store value of type " << *Ty << "!\n";
335 switch (Ty->getTypeID()) {
337 case Type::UByteTyID:
338 case Type::SByteTyID: Ptr->Untyped[0] = Val.UByteVal; break;
339 case Type::UShortTyID:
340 case Type::ShortTyID: Ptr->Untyped[1] = Val.UShortVal & 255;
341 Ptr->Untyped[0] = (Val.UShortVal >> 8) & 255;
343 Store4BytesBigEndian:
344 case Type::FloatTyID:
346 case Type::IntTyID: Ptr->Untyped[3] = Val.UIntVal & 255;
347 Ptr->Untyped[2] = (Val.UIntVal >> 8) & 255;
348 Ptr->Untyped[1] = (Val.UIntVal >> 16) & 255;
349 Ptr->Untyped[0] = (Val.UIntVal >> 24) & 255;
351 case Type::PointerTyID: if (getTargetData().getPointerSize() == 4)
352 goto Store4BytesBigEndian;
353 case Type::DoubleTyID:
354 case Type::ULongTyID:
356 Ptr->Untyped[7] = (unsigned char)(Val.ULongVal );
357 Ptr->Untyped[6] = (unsigned char)(Val.ULongVal >> 8);
358 Ptr->Untyped[5] = (unsigned char)(Val.ULongVal >> 16);
359 Ptr->Untyped[4] = (unsigned char)(Val.ULongVal >> 24);
360 Ptr->Untyped[3] = (unsigned char)(Val.ULongVal >> 32);
361 Ptr->Untyped[2] = (unsigned char)(Val.ULongVal >> 40);
362 Ptr->Untyped[1] = (unsigned char)(Val.ULongVal >> 48);
363 Ptr->Untyped[0] = (unsigned char)(Val.ULongVal >> 56);
366 std::cout << "Cannot store value of type " << *Ty << "!\n";
373 GenericValue ExecutionEngine::LoadValueFromMemory(GenericValue *Ptr,
376 if (getTargetData().isLittleEndian()) {
377 switch (Ty->getTypeID()) {
379 case Type::UByteTyID:
380 case Type::SByteTyID: Result.UByteVal = Ptr->Untyped[0]; break;
381 case Type::UShortTyID:
382 case Type::ShortTyID: Result.UShortVal = (unsigned)Ptr->Untyped[0] |
383 ((unsigned)Ptr->Untyped[1] << 8);
385 Load4BytesLittleEndian:
386 case Type::FloatTyID:
388 case Type::IntTyID: Result.UIntVal = (unsigned)Ptr->Untyped[0] |
389 ((unsigned)Ptr->Untyped[1] << 8) |
390 ((unsigned)Ptr->Untyped[2] << 16) |
391 ((unsigned)Ptr->Untyped[3] << 24);
393 case Type::PointerTyID: if (getTargetData().getPointerSize() == 4)
394 goto Load4BytesLittleEndian;
395 case Type::DoubleTyID:
396 case Type::ULongTyID:
397 case Type::LongTyID: Result.ULongVal = (uint64_t)Ptr->Untyped[0] |
398 ((uint64_t)Ptr->Untyped[1] << 8) |
399 ((uint64_t)Ptr->Untyped[2] << 16) |
400 ((uint64_t)Ptr->Untyped[3] << 24) |
401 ((uint64_t)Ptr->Untyped[4] << 32) |
402 ((uint64_t)Ptr->Untyped[5] << 40) |
403 ((uint64_t)Ptr->Untyped[6] << 48) |
404 ((uint64_t)Ptr->Untyped[7] << 56);
407 std::cout << "Cannot load value of type " << *Ty << "!\n";
411 switch (Ty->getTypeID()) {
413 case Type::UByteTyID:
414 case Type::SByteTyID: Result.UByteVal = Ptr->Untyped[0]; break;
415 case Type::UShortTyID:
416 case Type::ShortTyID: Result.UShortVal = (unsigned)Ptr->Untyped[1] |
417 ((unsigned)Ptr->Untyped[0] << 8);
420 case Type::FloatTyID:
422 case Type::IntTyID: Result.UIntVal = (unsigned)Ptr->Untyped[3] |
423 ((unsigned)Ptr->Untyped[2] << 8) |
424 ((unsigned)Ptr->Untyped[1] << 16) |
425 ((unsigned)Ptr->Untyped[0] << 24);
427 case Type::PointerTyID: if (getTargetData().getPointerSize() == 4)
428 goto Load4BytesBigEndian;
429 case Type::DoubleTyID:
430 case Type::ULongTyID:
431 case Type::LongTyID: Result.ULongVal = (uint64_t)Ptr->Untyped[7] |
432 ((uint64_t)Ptr->Untyped[6] << 8) |
433 ((uint64_t)Ptr->Untyped[5] << 16) |
434 ((uint64_t)Ptr->Untyped[4] << 24) |
435 ((uint64_t)Ptr->Untyped[3] << 32) |
436 ((uint64_t)Ptr->Untyped[2] << 40) |
437 ((uint64_t)Ptr->Untyped[1] << 48) |
438 ((uint64_t)Ptr->Untyped[0] << 56);
441 std::cout << "Cannot load value of type " << *Ty << "!\n";
448 // InitializeMemory - Recursive function to apply a Constant value into the
449 // specified memory location...
451 void ExecutionEngine::InitializeMemory(const Constant *Init, void *Addr) {
452 if (isa<UndefValue>(Init)) {
454 } else if (Init->getType()->isFirstClassType()) {
455 GenericValue Val = getConstantValue(Init);
456 StoreValueToMemory(Val, (GenericValue*)Addr, Init->getType());
458 } else if (isa<ConstantAggregateZero>(Init)) {
459 memset(Addr, 0, (size_t)getTargetData().getTypeSize(Init->getType()));
463 switch (Init->getType()->getTypeID()) {
464 case Type::ArrayTyID: {
465 const ConstantArray *CPA = cast<ConstantArray>(Init);
466 unsigned ElementSize =
467 getTargetData().getTypeSize(cast<ArrayType>(CPA->getType())->getElementType());
468 for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
469 InitializeMemory(CPA->getOperand(i), (char*)Addr+i*ElementSize);
473 case Type::StructTyID: {
474 const ConstantStruct *CPS = cast<ConstantStruct>(Init);
475 const StructLayout *SL =
476 getTargetData().getStructLayout(cast<StructType>(CPS->getType()));
477 for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
478 InitializeMemory(CPS->getOperand(i), (char*)Addr+SL->MemberOffsets[i]);
483 std::cerr << "Bad Type: " << *Init->getType() << "\n";
484 assert(0 && "Unknown constant type to initialize memory with!");
488 /// EmitGlobals - Emit all of the global variables to memory, storing their
489 /// addresses into GlobalAddress. This must make sure to copy the contents of
490 /// their initializers into the memory.
492 void ExecutionEngine::emitGlobals() {
493 const TargetData &TD = getTargetData();
495 // Loop over all of the global variables in the program, allocating the memory
497 for (Module::const_global_iterator I = getModule().global_begin(), E = getModule().global_end();
499 if (!I->isExternal()) {
500 // Get the type of the global...
501 const Type *Ty = I->getType()->getElementType();
503 // Allocate some memory for it!
504 unsigned Size = TD.getTypeSize(Ty);
505 addGlobalMapping(I, new char[Size]);
507 // External variable reference. Try to use the dynamic loader to
508 // get a pointer to it.
509 if (void *SymAddr = sys::DynamicLibrary::SearchForAddressOfSymbol(
510 I->getName().c_str()))
511 addGlobalMapping(I, SymAddr);
513 std::cerr << "Could not resolve external global address: "
514 << I->getName() << "\n";
519 // Now that all of the globals are set up in memory, loop through them all and
520 // initialize their contents.
521 for (Module::const_global_iterator I = getModule().global_begin(), E = getModule().global_end();
523 if (!I->isExternal())
524 EmitGlobalVariable(I);
527 // EmitGlobalVariable - This method emits the specified global variable to the
528 // address specified in GlobalAddresses, or allocates new memory if it's not
529 // already in the map.
530 void ExecutionEngine::EmitGlobalVariable(const GlobalVariable *GV) {
531 void *GA = getPointerToGlobalIfAvailable(GV);
532 DEBUG(std::cerr << "Global '" << GV->getName() << "' -> " << GA << "\n");
534 const Type *ElTy = GV->getType()->getElementType();
535 size_t GVSize = (size_t)getTargetData().getTypeSize(ElTy);
537 // If it's not already specified, allocate memory for the global.
538 GA = new char[GVSize];
539 addGlobalMapping(GV, GA);
542 InitializeMemory(GV->getInitializer(), GA);
543 NumInitBytes += (unsigned)GVSize;