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/IntrinsicLowering.h"
21 #include "llvm/Module.h"
22 #include "llvm/ModuleProvider.h"
23 #include "llvm/ExecutionEngine/ExecutionEngine.h"
24 #include "llvm/ExecutionEngine/GenericValue.h"
25 #include "llvm/Target/TargetData.h"
26 #include "Support/Debug.h"
27 #include "Support/Statistic.h"
28 #include "Support/DynamicLinker.h"
29 #include "Config/dlfcn.h"
33 Statistic<> NumInitBytes("lli", "Number of bytes of global vars initialized");
34 Statistic<> NumGlobals ("lli", "Number of global vars initialized");
37 ExecutionEngine::ExecutionEngine(ModuleProvider *P) :
38 CurMod(*P->getModule()), MP(P) {
39 assert(P && "ModuleProvider is null?");
42 ExecutionEngine::ExecutionEngine(Module *M) : CurMod(*M), MP(0) {
43 assert(M && "Module is null?");
46 ExecutionEngine::~ExecutionEngine() {
50 /// getGlobalValueAtAddress - Return the LLVM global value object that starts
51 /// at the specified address.
53 const GlobalValue *ExecutionEngine::getGlobalValueAtAddress(void *Addr) {
54 // If we haven't computed the reverse mapping yet, do so first.
55 if (GlobalAddressReverseMap.empty()) {
56 for (std::map<const GlobalValue*, void *>::iterator I =
57 GlobalAddressMap.begin(), E = GlobalAddressMap.end(); I != E; ++I)
58 GlobalAddressReverseMap.insert(std::make_pair(I->second, I->first));
61 std::map<void *, const GlobalValue*>::iterator I =
62 GlobalAddressReverseMap.find(Addr);
63 return I != GlobalAddressReverseMap.end() ? I->second : 0;
66 // CreateArgv - Turn a vector of strings into a nice argv style array of
67 // pointers to null terminated strings.
69 static void *CreateArgv(ExecutionEngine *EE,
70 const std::vector<std::string> &InputArgv) {
71 unsigned PtrSize = EE->getTargetData().getPointerSize();
72 char *Result = new char[(InputArgv.size()+1)*PtrSize];
74 DEBUG(std::cerr << "ARGV = " << (void*)Result << "\n");
75 const Type *SBytePtr = PointerType::get(Type::SByteTy);
77 for (unsigned i = 0; i != InputArgv.size(); ++i) {
78 unsigned Size = InputArgv[i].size()+1;
79 char *Dest = new char[Size];
80 DEBUG(std::cerr << "ARGV[" << i << "] = " << (void*)Dest << "\n");
82 std::copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
85 // Endian safe: Result[i] = (PointerTy)Dest;
86 EE->StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i*PtrSize),
91 EE->StoreValueToMemory(PTOGV(0),
92 (GenericValue*)(Result+InputArgv.size()*PtrSize),
97 /// runFunctionAsMain - This is a helper function which wraps runFunction to
98 /// handle the common task of starting up main with the specified argc, argv,
99 /// and envp parameters.
100 int ExecutionEngine::runFunctionAsMain(Function *Fn,
101 const std::vector<std::string> &argv,
102 const char * const * envp) {
103 std::vector<GenericValue> GVArgs;
105 GVArgc.IntVal = argv.size();
106 GVArgs.push_back(GVArgc); // Arg #0 = argc.
107 GVArgs.push_back(PTOGV(CreateArgv(this, argv))); // Arg #1 = argv.
108 assert(((char **)GVTOP(GVArgs[1]))[0] && "argv[0] was null after CreateArgv");
110 std::vector<std::string> EnvVars;
111 for (unsigned i = 0; envp[i]; ++i)
112 EnvVars.push_back(envp[i]);
113 GVArgs.push_back(PTOGV(CreateArgv(this, EnvVars))); // Arg #2 = envp.
114 return runFunction(Fn, GVArgs).IntVal;
119 /// If possible, create a JIT, unless the caller specifically requests an
120 /// Interpreter or there's an error. If even an Interpreter cannot be created,
121 /// NULL is returned.
123 ExecutionEngine *ExecutionEngine::create(ModuleProvider *MP,
124 bool ForceInterpreter,
125 IntrinsicLowering *IL) {
126 ExecutionEngine *EE = 0;
128 // Unless the interpreter was explicitly selected, try making a JIT.
129 if (!ForceInterpreter)
130 EE = JIT::create(MP, IL);
132 // If we can't make a JIT, make an interpreter instead.
135 Module *M = MP->materializeModule();
137 EE = Interpreter::create(M, IL);
139 std::cerr << "Error creating the interpreter!\n";
142 std::cerr << "Error reading the bytecode file!\n";
146 if (EE == 0) delete IL;
150 /// getPointerToGlobal - This returns the address of the specified global
151 /// value. This may involve code generation if it's a function.
153 void *ExecutionEngine::getPointerToGlobal(const GlobalValue *GV) {
154 if (Function *F = const_cast<Function*>(dyn_cast<Function>(GV)))
155 return getPointerToFunction(F);
157 assert(GlobalAddressMap[GV] && "Global hasn't had an address allocated yet?");
158 return GlobalAddressMap[GV];
163 GenericValue ExecutionEngine::getConstantValue(const Constant *C) {
166 if (ConstantExpr *CE = const_cast<ConstantExpr*>(dyn_cast<ConstantExpr>(C))) {
167 switch (CE->getOpcode()) {
168 case Instruction::GetElementPtr: {
169 Result = getConstantValue(CE->getOperand(0));
170 std::vector<Value*> Indexes(CE->op_begin()+1, CE->op_end());
172 TD->getIndexedOffset(CE->getOperand(0)->getType(), Indexes);
174 Result.LongVal += Offset;
177 case Instruction::Cast: {
178 // We only need to handle a few cases here. Almost all casts will
179 // automatically fold, just the ones involving pointers won't.
181 Constant *Op = CE->getOperand(0);
183 // Handle cast of pointer to pointer...
184 if (Op->getType()->getPrimitiveID() == C->getType()->getPrimitiveID())
185 return getConstantValue(Op);
187 // Handle a cast of pointer to any integral type...
188 if (isa<PointerType>(Op->getType()) && C->getType()->isIntegral())
189 return getConstantValue(Op);
191 // Handle cast of long to pointer...
192 if (isa<PointerType>(C->getType()) && (Op->getType() == Type::LongTy ||
193 Op->getType() == Type::ULongTy))
194 return getConstantValue(Op);
198 case Instruction::Add:
199 if (CE->getOperand(0)->getType() == Type::LongTy ||
200 CE->getOperand(0)->getType() == Type::ULongTy)
201 Result.LongVal = getConstantValue(CE->getOperand(0)).LongVal +
202 getConstantValue(CE->getOperand(1)).LongVal;
210 std::cerr << "ConstantExpr not handled as global var init: " << *CE << "\n";
214 switch (C->getType()->getPrimitiveID()) {
215 #define GET_CONST_VAL(TY, CLASS) \
216 case Type::TY##TyID: Result.TY##Val = cast<CLASS>(C)->getValue(); break
217 GET_CONST_VAL(Bool , ConstantBool);
218 GET_CONST_VAL(UByte , ConstantUInt);
219 GET_CONST_VAL(SByte , ConstantSInt);
220 GET_CONST_VAL(UShort , ConstantUInt);
221 GET_CONST_VAL(Short , ConstantSInt);
222 GET_CONST_VAL(UInt , ConstantUInt);
223 GET_CONST_VAL(Int , ConstantSInt);
224 GET_CONST_VAL(ULong , ConstantUInt);
225 GET_CONST_VAL(Long , ConstantSInt);
226 GET_CONST_VAL(Float , ConstantFP);
227 GET_CONST_VAL(Double , ConstantFP);
229 case Type::PointerTyID:
230 if (isa<ConstantPointerNull>(C)) {
231 Result.PointerVal = 0;
232 } else if (const ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(C)){
234 const_cast<Function*>(dyn_cast<Function>(CPR->getValue())))
235 Result = PTOGV(getPointerToFunctionOrStub(F));
237 Result = PTOGV(getOrEmitGlobalVariable(
238 cast<GlobalVariable>(CPR->getValue())));
241 assert(0 && "Unknown constant pointer type!");
245 std::cout << "ERROR: Constant unimp for type: " << C->getType() << "\n";
253 void ExecutionEngine::StoreValueToMemory(GenericValue Val, GenericValue *Ptr,
255 if (getTargetData().isLittleEndian()) {
256 switch (Ty->getPrimitiveID()) {
258 case Type::UByteTyID:
259 case Type::SByteTyID: Ptr->Untyped[0] = Val.UByteVal; break;
260 case Type::UShortTyID:
261 case Type::ShortTyID: Ptr->Untyped[0] = Val.UShortVal & 255;
262 Ptr->Untyped[1] = (Val.UShortVal >> 8) & 255;
264 Store4BytesLittleEndian:
265 case Type::FloatTyID:
267 case Type::IntTyID: Ptr->Untyped[0] = Val.UIntVal & 255;
268 Ptr->Untyped[1] = (Val.UIntVal >> 8) & 255;
269 Ptr->Untyped[2] = (Val.UIntVal >> 16) & 255;
270 Ptr->Untyped[3] = (Val.UIntVal >> 24) & 255;
272 case Type::PointerTyID: if (getTargetData().getPointerSize() == 4)
273 goto Store4BytesLittleEndian;
274 case Type::DoubleTyID:
275 case Type::ULongTyID:
276 case Type::LongTyID: Ptr->Untyped[0] = Val.ULongVal & 255;
277 Ptr->Untyped[1] = (Val.ULongVal >> 8) & 255;
278 Ptr->Untyped[2] = (Val.ULongVal >> 16) & 255;
279 Ptr->Untyped[3] = (Val.ULongVal >> 24) & 255;
280 Ptr->Untyped[4] = (Val.ULongVal >> 32) & 255;
281 Ptr->Untyped[5] = (Val.ULongVal >> 40) & 255;
282 Ptr->Untyped[6] = (Val.ULongVal >> 48) & 255;
283 Ptr->Untyped[7] = (Val.ULongVal >> 56) & 255;
286 std::cout << "Cannot store value of type " << Ty << "!\n";
289 switch (Ty->getPrimitiveID()) {
291 case Type::UByteTyID:
292 case Type::SByteTyID: Ptr->Untyped[0] = Val.UByteVal; break;
293 case Type::UShortTyID:
294 case Type::ShortTyID: Ptr->Untyped[1] = Val.UShortVal & 255;
295 Ptr->Untyped[0] = (Val.UShortVal >> 8) & 255;
297 Store4BytesBigEndian:
298 case Type::FloatTyID:
300 case Type::IntTyID: Ptr->Untyped[3] = Val.UIntVal & 255;
301 Ptr->Untyped[2] = (Val.UIntVal >> 8) & 255;
302 Ptr->Untyped[1] = (Val.UIntVal >> 16) & 255;
303 Ptr->Untyped[0] = (Val.UIntVal >> 24) & 255;
305 case Type::PointerTyID: if (getTargetData().getPointerSize() == 4)
306 goto Store4BytesBigEndian;
307 case Type::DoubleTyID:
308 case Type::ULongTyID:
309 case Type::LongTyID: Ptr->Untyped[7] = Val.ULongVal & 255;
310 Ptr->Untyped[6] = (Val.ULongVal >> 8) & 255;
311 Ptr->Untyped[5] = (Val.ULongVal >> 16) & 255;
312 Ptr->Untyped[4] = (Val.ULongVal >> 24) & 255;
313 Ptr->Untyped[3] = (Val.ULongVal >> 32) & 255;
314 Ptr->Untyped[2] = (Val.ULongVal >> 40) & 255;
315 Ptr->Untyped[1] = (Val.ULongVal >> 48) & 255;
316 Ptr->Untyped[0] = (Val.ULongVal >> 56) & 255;
319 std::cout << "Cannot store value of type " << Ty << "!\n";
326 GenericValue ExecutionEngine::LoadValueFromMemory(GenericValue *Ptr,
329 if (getTargetData().isLittleEndian()) {
330 switch (Ty->getPrimitiveID()) {
332 case Type::UByteTyID:
333 case Type::SByteTyID: Result.UByteVal = Ptr->Untyped[0]; break;
334 case Type::UShortTyID:
335 case Type::ShortTyID: Result.UShortVal = (unsigned)Ptr->Untyped[0] |
336 ((unsigned)Ptr->Untyped[1] << 8);
338 Load4BytesLittleEndian:
339 case Type::FloatTyID:
341 case Type::IntTyID: Result.UIntVal = (unsigned)Ptr->Untyped[0] |
342 ((unsigned)Ptr->Untyped[1] << 8) |
343 ((unsigned)Ptr->Untyped[2] << 16) |
344 ((unsigned)Ptr->Untyped[3] << 24);
346 case Type::PointerTyID: if (getTargetData().getPointerSize() == 4)
347 goto Load4BytesLittleEndian;
348 case Type::DoubleTyID:
349 case Type::ULongTyID:
350 case Type::LongTyID: Result.ULongVal = (uint64_t)Ptr->Untyped[0] |
351 ((uint64_t)Ptr->Untyped[1] << 8) |
352 ((uint64_t)Ptr->Untyped[2] << 16) |
353 ((uint64_t)Ptr->Untyped[3] << 24) |
354 ((uint64_t)Ptr->Untyped[4] << 32) |
355 ((uint64_t)Ptr->Untyped[5] << 40) |
356 ((uint64_t)Ptr->Untyped[6] << 48) |
357 ((uint64_t)Ptr->Untyped[7] << 56);
360 std::cout << "Cannot load value of type " << *Ty << "!\n";
364 switch (Ty->getPrimitiveID()) {
366 case Type::UByteTyID:
367 case Type::SByteTyID: Result.UByteVal = Ptr->Untyped[0]; break;
368 case Type::UShortTyID:
369 case Type::ShortTyID: Result.UShortVal = (unsigned)Ptr->Untyped[1] |
370 ((unsigned)Ptr->Untyped[0] << 8);
373 case Type::FloatTyID:
375 case Type::IntTyID: Result.UIntVal = (unsigned)Ptr->Untyped[3] |
376 ((unsigned)Ptr->Untyped[2] << 8) |
377 ((unsigned)Ptr->Untyped[1] << 16) |
378 ((unsigned)Ptr->Untyped[0] << 24);
380 case Type::PointerTyID: if (getTargetData().getPointerSize() == 4)
381 goto Load4BytesBigEndian;
382 case Type::DoubleTyID:
383 case Type::ULongTyID:
384 case Type::LongTyID: Result.ULongVal = (uint64_t)Ptr->Untyped[7] |
385 ((uint64_t)Ptr->Untyped[6] << 8) |
386 ((uint64_t)Ptr->Untyped[5] << 16) |
387 ((uint64_t)Ptr->Untyped[4] << 24) |
388 ((uint64_t)Ptr->Untyped[3] << 32) |
389 ((uint64_t)Ptr->Untyped[2] << 40) |
390 ((uint64_t)Ptr->Untyped[1] << 48) |
391 ((uint64_t)Ptr->Untyped[0] << 56);
394 std::cout << "Cannot load value of type " << *Ty << "!\n";
401 // InitializeMemory - Recursive function to apply a Constant value into the
402 // specified memory location...
404 void ExecutionEngine::InitializeMemory(const Constant *Init, void *Addr) {
405 if (Init->getType()->isFirstClassType()) {
406 GenericValue Val = getConstantValue(Init);
407 StoreValueToMemory(Val, (GenericValue*)Addr, Init->getType());
409 } else if (isa<ConstantAggregateZero>(Init)) {
410 unsigned Size = getTargetData().getTypeSize(Init->getType());
411 memset(Addr, 0, Size);
415 switch (Init->getType()->getPrimitiveID()) {
416 case Type::ArrayTyID: {
417 const ConstantArray *CPA = cast<ConstantArray>(Init);
418 const std::vector<Use> &Val = CPA->getValues();
419 unsigned ElementSize =
420 getTargetData().getTypeSize(cast<ArrayType>(CPA->getType())->getElementType());
421 for (unsigned i = 0; i < Val.size(); ++i)
422 InitializeMemory(cast<Constant>(Val[i].get()), (char*)Addr+i*ElementSize);
426 case Type::StructTyID: {
427 const ConstantStruct *CPS = cast<ConstantStruct>(Init);
428 const StructLayout *SL =
429 getTargetData().getStructLayout(cast<StructType>(CPS->getType()));
430 const std::vector<Use> &Val = CPS->getValues();
431 for (unsigned i = 0; i < Val.size(); ++i)
432 InitializeMemory(cast<Constant>(Val[i].get()),
433 (char*)Addr+SL->MemberOffsets[i]);
438 std::cerr << "Bad Type: " << Init->getType() << "\n";
439 assert(0 && "Unknown constant type to initialize memory with!");
443 /// EmitGlobals - Emit all of the global variables to memory, storing their
444 /// addresses into GlobalAddress. This must make sure to copy the contents of
445 /// their initializers into the memory.
447 void ExecutionEngine::emitGlobals() {
448 const TargetData &TD = getTargetData();
450 // Loop over all of the global variables in the program, allocating the memory
452 for (Module::giterator I = getModule().gbegin(), E = getModule().gend();
454 if (!I->isExternal()) {
455 // Get the type of the global...
456 const Type *Ty = I->getType()->getElementType();
458 // Allocate some memory for it!
459 unsigned Size = TD.getTypeSize(Ty);
460 addGlobalMapping(I, new char[Size]);
462 // External variable reference. Try to use the dynamic loader to
463 // get a pointer to it.
464 if (void *SymAddr = GetAddressOfSymbol(I->getName().c_str()))
465 addGlobalMapping(I, SymAddr);
467 std::cerr << "Could not resolve external global address: "
468 << I->getName() << "\n";
473 // Now that all of the globals are set up in memory, loop through them all and
474 // initialize their contents.
475 for (Module::giterator I = getModule().gbegin(), E = getModule().gend();
477 if (!I->isExternal())
478 EmitGlobalVariable(I);
481 // EmitGlobalVariable - This method emits the specified global variable to the
482 // address specified in GlobalAddresses, or allocates new memory if it's not
483 // already in the map.
484 void ExecutionEngine::EmitGlobalVariable(const GlobalVariable *GV) {
485 void *GA = getPointerToGlobalIfAvailable(GV);
486 DEBUG(std::cerr << "Global '" << GV->getName() << "' -> " << GA << "\n");
488 const Type *ElTy = GV->getType()->getElementType();
490 // If it's not already specified, allocate memory for the global.
491 GA = new char[getTargetData().getTypeSize(ElTy)];
492 addGlobalMapping(GV, GA);
495 InitializeMemory(GV->getInitializer(), GA);
496 NumInitBytes += getTargetData().getTypeSize(ElTy);