1857c21b4SMisha Brukman //===-- ExecutionEngine.cpp - Common Implementation shared by EEs ---------===//
2996fe010SChris Lattner //
3482202a6SJohn Criswell //                     The LLVM Compiler Infrastructure
4482202a6SJohn Criswell //
5482202a6SJohn Criswell // This file was developed by the LLVM research group and is distributed under
6482202a6SJohn Criswell // the University of Illinois Open Source License. See LICENSE.TXT for details.
7482202a6SJohn Criswell //
8482202a6SJohn Criswell //===----------------------------------------------------------------------===//
9482202a6SJohn Criswell //
10996fe010SChris Lattner // This file defines the common interface used by the various execution engine
11996fe010SChris Lattner // subclasses.
12996fe010SChris Lattner //
13996fe010SChris Lattner //===----------------------------------------------------------------------===//
14996fe010SChris Lattner 
15ee937c80SChris Lattner #define DEBUG_TYPE "jit"
16996fe010SChris Lattner #include "llvm/Constants.h"
17260b0c88SMisha Brukman #include "llvm/DerivedTypes.h"
18996fe010SChris Lattner #include "llvm/Module.h"
19260b0c88SMisha Brukman #include "llvm/ModuleProvider.h"
2070e37278SReid Spencer #include "llvm/ADT/Statistic.h"
214c96b088SChris Lattner #include "llvm/CodeGen/IntrinsicLowering.h"
22260b0c88SMisha Brukman #include "llvm/ExecutionEngine/ExecutionEngine.h"
23ad481312SChris Lattner #include "llvm/ExecutionEngine/GenericValue.h"
247c16caa3SReid Spencer #include "llvm/Support/Debug.h"
2570e37278SReid Spencer #include "llvm/System/DynamicLibrary.h"
2670e37278SReid Spencer #include "llvm/Target/TargetData.h"
272d52c1b8SChris Lattner #include <iostream>
2829681deeSChris Lattner using namespace llvm;
29996fe010SChris Lattner 
3029681deeSChris Lattner namespace {
31996fe010SChris Lattner   Statistic<> NumInitBytes("lli", "Number of bytes of global vars initialized");
326bbe3eceSChris Lattner   Statistic<> NumGlobals  ("lli", "Number of global vars initialized");
3329681deeSChris Lattner }
34996fe010SChris Lattner 
352d52c1b8SChris Lattner ExecutionEngine::EECtorFn ExecutionEngine::JITCtor = 0;
362d52c1b8SChris Lattner ExecutionEngine::EECtorFn ExecutionEngine::InterpCtor = 0;
372d52c1b8SChris Lattner 
38260b0c88SMisha Brukman ExecutionEngine::ExecutionEngine(ModuleProvider *P) :
39260b0c88SMisha Brukman   CurMod(*P->getModule()), MP(P) {
40260b0c88SMisha Brukman   assert(P && "ModuleProvider is null?");
41260b0c88SMisha Brukman }
42260b0c88SMisha Brukman 
43260b0c88SMisha Brukman ExecutionEngine::ExecutionEngine(Module *M) : CurMod(*M), MP(0) {
44260b0c88SMisha Brukman   assert(M && "Module is null?");
45260b0c88SMisha Brukman }
46260b0c88SMisha Brukman 
4792f8b30dSBrian Gaeke ExecutionEngine::~ExecutionEngine() {
482f1e2002SMisha Brukman   delete MP;
4992f8b30dSBrian Gaeke }
5092f8b30dSBrian Gaeke 
51748e8579SChris Lattner /// getGlobalValueAtAddress - Return the LLVM global value object that starts
52748e8579SChris Lattner /// at the specified address.
53748e8579SChris Lattner ///
54748e8579SChris Lattner const GlobalValue *ExecutionEngine::getGlobalValueAtAddress(void *Addr) {
5579876f52SReid Spencer   MutexGuard locked(lock);
5679876f52SReid Spencer 
57748e8579SChris Lattner   // If we haven't computed the reverse mapping yet, do so first.
5879876f52SReid Spencer   if (state.getGlobalAddressReverseMap(locked).empty()) {
59748e8579SChris Lattner     for (std::map<const GlobalValue*, void *>::iterator I =
6079876f52SReid Spencer            state.getGlobalAddressMap(locked).begin(), E = state.getGlobalAddressMap(locked).end(); I != E; ++I)
6179876f52SReid Spencer       state.getGlobalAddressReverseMap(locked).insert(std::make_pair(I->second, I->first));
62748e8579SChris Lattner   }
63748e8579SChris Lattner 
64748e8579SChris Lattner   std::map<void *, const GlobalValue*>::iterator I =
6579876f52SReid Spencer     state.getGlobalAddressReverseMap(locked).find(Addr);
6679876f52SReid Spencer   return I != state.getGlobalAddressReverseMap(locked).end() ? I->second : 0;
67748e8579SChris Lattner }
685a0d4829SChris Lattner 
695a0d4829SChris Lattner // CreateArgv - Turn a vector of strings into a nice argv style array of
705a0d4829SChris Lattner // pointers to null terminated strings.
715a0d4829SChris Lattner //
725a0d4829SChris Lattner static void *CreateArgv(ExecutionEngine *EE,
735a0d4829SChris Lattner                         const std::vector<std::string> &InputArgv) {
745a0d4829SChris Lattner   unsigned PtrSize = EE->getTargetData().getPointerSize();
755a0d4829SChris Lattner   char *Result = new char[(InputArgv.size()+1)*PtrSize];
765a0d4829SChris Lattner 
775a0d4829SChris Lattner   DEBUG(std::cerr << "ARGV = " << (void*)Result << "\n");
785a0d4829SChris Lattner   const Type *SBytePtr = PointerType::get(Type::SByteTy);
795a0d4829SChris Lattner 
805a0d4829SChris Lattner   for (unsigned i = 0; i != InputArgv.size(); ++i) {
815a0d4829SChris Lattner     unsigned Size = InputArgv[i].size()+1;
825a0d4829SChris Lattner     char *Dest = new char[Size];
835a0d4829SChris Lattner     DEBUG(std::cerr << "ARGV[" << i << "] = " << (void*)Dest << "\n");
845a0d4829SChris Lattner 
855a0d4829SChris Lattner     std::copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
865a0d4829SChris Lattner     Dest[Size-1] = 0;
875a0d4829SChris Lattner 
885a0d4829SChris Lattner     // Endian safe: Result[i] = (PointerTy)Dest;
895a0d4829SChris Lattner     EE->StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i*PtrSize),
905a0d4829SChris Lattner                            SBytePtr);
915a0d4829SChris Lattner   }
925a0d4829SChris Lattner 
935a0d4829SChris Lattner   // Null terminate it
945a0d4829SChris Lattner   EE->StoreValueToMemory(PTOGV(0),
955a0d4829SChris Lattner                          (GenericValue*)(Result+InputArgv.size()*PtrSize),
965a0d4829SChris Lattner                          SBytePtr);
975a0d4829SChris Lattner   return Result;
985a0d4829SChris Lattner }
995a0d4829SChris Lattner 
100faae50b6SChris Lattner 
101faae50b6SChris Lattner /// runStaticConstructorsDestructors - This method is used to execute all of
102faae50b6SChris Lattner /// the static constructors or destructors for a module, depending on the
103faae50b6SChris Lattner /// value of isDtors.
104faae50b6SChris Lattner void ExecutionEngine::runStaticConstructorsDestructors(bool isDtors) {
105faae50b6SChris Lattner   const char *Name = isDtors ? "llvm.global_dtors" : "llvm.global_ctors";
106faae50b6SChris Lattner   GlobalVariable *GV = CurMod.getNamedGlobal(Name);
107faae50b6SChris Lattner   if (!GV || GV->isExternal() || !GV->hasInternalLinkage()) return;
108faae50b6SChris Lattner 
109faae50b6SChris Lattner   // Should be an array of '{ int, void ()* }' structs.  The first value is the
110faae50b6SChris Lattner   // init priority, which we ignore.
111faae50b6SChris Lattner   ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
112faae50b6SChris Lattner   if (!InitList) return;
113faae50b6SChris Lattner   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
114faae50b6SChris Lattner     if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
115faae50b6SChris Lattner       if (CS->getNumOperands() != 2) return;  // Not array of 2-element structs.
116faae50b6SChris Lattner 
117faae50b6SChris Lattner       Constant *FP = CS->getOperand(1);
118faae50b6SChris Lattner       if (FP->isNullValue())
119faae50b6SChris Lattner         return;  // Found a null terminator, exit.
120faae50b6SChris Lattner 
121faae50b6SChris Lattner       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(FP))
122faae50b6SChris Lattner         if (CE->getOpcode() == Instruction::Cast)
123faae50b6SChris Lattner           FP = CE->getOperand(0);
124faae50b6SChris Lattner       if (Function *F = dyn_cast<Function>(FP)) {
125faae50b6SChris Lattner         // Execute the ctor/dtor function!
126faae50b6SChris Lattner         runFunction(F, std::vector<GenericValue>());
127faae50b6SChris Lattner       }
128faae50b6SChris Lattner     }
129faae50b6SChris Lattner }
130faae50b6SChris Lattner 
1315a0d4829SChris Lattner /// runFunctionAsMain - This is a helper function which wraps runFunction to
1325a0d4829SChris Lattner /// handle the common task of starting up main with the specified argc, argv,
1335a0d4829SChris Lattner /// and envp parameters.
1345a0d4829SChris Lattner int ExecutionEngine::runFunctionAsMain(Function *Fn,
1355a0d4829SChris Lattner                                        const std::vector<std::string> &argv,
1365a0d4829SChris Lattner                                        const char * const * envp) {
1375a0d4829SChris Lattner   std::vector<GenericValue> GVArgs;
1385a0d4829SChris Lattner   GenericValue GVArgc;
1395a0d4829SChris Lattner   GVArgc.IntVal = argv.size();
140b1cad0b3SChris Lattner   unsigned NumArgs = Fn->getFunctionType()->getNumParams();
141b1cad0b3SChris Lattner   if (NumArgs) {
1425a0d4829SChris Lattner     GVArgs.push_back(GVArgc); // Arg #0 = argc.
143b1cad0b3SChris Lattner     if (NumArgs > 1) {
1445a0d4829SChris Lattner       GVArgs.push_back(PTOGV(CreateArgv(this, argv))); // Arg #1 = argv.
145b1cad0b3SChris Lattner       assert(((char **)GVTOP(GVArgs[1]))[0] &&
146b1cad0b3SChris Lattner              "argv[0] was null after CreateArgv");
147b1cad0b3SChris Lattner       if (NumArgs > 2) {
1485a0d4829SChris Lattner         std::vector<std::string> EnvVars;
1495a0d4829SChris Lattner         for (unsigned i = 0; envp[i]; ++i)
1505a0d4829SChris Lattner           EnvVars.push_back(envp[i]);
1515a0d4829SChris Lattner         GVArgs.push_back(PTOGV(CreateArgv(this, EnvVars))); // Arg #2 = envp.
152b1cad0b3SChris Lattner       }
153b1cad0b3SChris Lattner     }
154b1cad0b3SChris Lattner   }
1555a0d4829SChris Lattner   return runFunction(Fn, GVArgs).IntVal;
1565a0d4829SChris Lattner }
1575a0d4829SChris Lattner 
158260b0c88SMisha Brukman /// If possible, create a JIT, unless the caller specifically requests an
159260b0c88SMisha Brukman /// Interpreter or there's an error. If even an Interpreter cannot be created,
160260b0c88SMisha Brukman /// NULL is returned.
161857c21b4SMisha Brukman ///
1622f1e2002SMisha Brukman ExecutionEngine *ExecutionEngine::create(ModuleProvider *MP,
163*0b2de9f2SChris Lattner                                          bool ForceInterpreter) {
1644bd3bd5bSBrian Gaeke   ExecutionEngine *EE = 0;
1654bd3bd5bSBrian Gaeke 
166c8c6c03dSChris Lattner   // Unless the interpreter was explicitly selected, try making a JIT.
1672d52c1b8SChris Lattner   if (!ForceInterpreter && JITCtor)
168*0b2de9f2SChris Lattner     EE = JITCtor(MP);
1694bd3bd5bSBrian Gaeke 
1704bd3bd5bSBrian Gaeke   // If we can't make a JIT, make an interpreter instead.
1712d52c1b8SChris Lattner   if (EE == 0 && InterpCtor)
172*0b2de9f2SChris Lattner     EE = InterpCtor(MP);
173c8c6c03dSChris Lattner 
174*0b2de9f2SChris Lattner   if (EE) {
17570e37278SReid Spencer     // Make sure we can resolve symbols in the program as well. The zero arg
17670e37278SReid Spencer     // to the function tells DynamicLibrary to load the program, not a library.
17770e37278SReid Spencer     sys::DynamicLibrary::LoadLibraryPermanently(0);
178*0b2de9f2SChris Lattner   }
17970e37278SReid Spencer 
1804bd3bd5bSBrian Gaeke   return EE;
1814bd3bd5bSBrian Gaeke }
1824bd3bd5bSBrian Gaeke 
183857c21b4SMisha Brukman /// getPointerToGlobal - This returns the address of the specified global
184857c21b4SMisha Brukman /// value.  This may involve code generation if it's a function.
185857c21b4SMisha Brukman ///
186996fe010SChris Lattner void *ExecutionEngine::getPointerToGlobal(const GlobalValue *GV) {
1871678e859SBrian Gaeke   if (Function *F = const_cast<Function*>(dyn_cast<Function>(GV)))
188996fe010SChris Lattner     return getPointerToFunction(F);
189996fe010SChris Lattner 
19079876f52SReid Spencer   MutexGuard locked(lock);
19169e84901SJeff Cohen   void *p = state.getGlobalAddressMap(locked)[GV];
19269e84901SJeff Cohen   if (p)
19369e84901SJeff Cohen     return p;
19469e84901SJeff Cohen 
19569e84901SJeff Cohen   // Global variable might have been added since interpreter started.
19669e84901SJeff Cohen   if (GlobalVariable *GVar =
19769e84901SJeff Cohen           const_cast<GlobalVariable *>(dyn_cast<GlobalVariable>(GV)))
19869e84901SJeff Cohen     EmitGlobalVariable(GVar);
19969e84901SJeff Cohen   else
20069e84901SJeff Cohen     assert("Global hasn't had an address allocated yet!");
20179876f52SReid Spencer   return state.getGlobalAddressMap(locked)[GV];
202996fe010SChris Lattner }
203996fe010SChris Lattner 
204857c21b4SMisha Brukman /// FIXME: document
205857c21b4SMisha Brukman ///
206996fe010SChris Lattner GenericValue ExecutionEngine::getConstantValue(const Constant *C) {
207996fe010SChris Lattner   GenericValue Result;
208d7a7a3f4SChris Lattner   if (isa<UndefValue>(C)) return Result;
2099de0d14dSChris Lattner 
21068cbcc3eSChris Lattner   if (ConstantExpr *CE = const_cast<ConstantExpr*>(dyn_cast<ConstantExpr>(C))) {
2119de0d14dSChris Lattner     switch (CE->getOpcode()) {
2129de0d14dSChris Lattner     case Instruction::GetElementPtr: {
21368cbcc3eSChris Lattner       Result = getConstantValue(CE->getOperand(0));
2149de0d14dSChris Lattner       std::vector<Value*> Indexes(CE->op_begin()+1, CE->op_end());
2159de0d14dSChris Lattner       uint64_t Offset =
2169de0d14dSChris Lattner         TD->getIndexedOffset(CE->getOperand(0)->getType(), Indexes);
2179de0d14dSChris Lattner 
218a551033eSChris Lattner       if (getTargetData().getPointerSize() == 4)
219a551033eSChris Lattner         Result.IntVal += Offset;
220a551033eSChris Lattner       else
2219de0d14dSChris Lattner         Result.LongVal += Offset;
2229de0d14dSChris Lattner       return Result;
2239de0d14dSChris Lattner     }
22468cbcc3eSChris Lattner     case Instruction::Cast: {
22568cbcc3eSChris Lattner       // We only need to handle a few cases here.  Almost all casts will
22668cbcc3eSChris Lattner       // automatically fold, just the ones involving pointers won't.
22768cbcc3eSChris Lattner       //
22868cbcc3eSChris Lattner       Constant *Op = CE->getOperand(0);
2295def7a57SChris Lattner       GenericValue GV = getConstantValue(Op);
23068cbcc3eSChris Lattner 
23168cbcc3eSChris Lattner       // Handle cast of pointer to pointer...
2326b727599SChris Lattner       if (Op->getType()->getTypeID() == C->getType()->getTypeID())
2335def7a57SChris Lattner         return GV;
23468cbcc3eSChris Lattner 
2350627a96eSChris Lattner       // Handle a cast of pointer to any integral type...
2368e693398SChris Lattner       if (isa<PointerType>(Op->getType()) && C->getType()->isIntegral())
2375def7a57SChris Lattner         return GV;
2380627a96eSChris Lattner 
2395def7a57SChris Lattner       // Handle cast of integer to a pointer...
2405def7a57SChris Lattner       if (isa<PointerType>(C->getType()) && Op->getType()->isIntegral())
2416b727599SChris Lattner         switch (Op->getType()->getTypeID()) {
2425def7a57SChris Lattner         case Type::BoolTyID:    return PTOGV((void*)(uintptr_t)GV.BoolVal);
2435def7a57SChris Lattner         case Type::SByteTyID:   return PTOGV((void*)( intptr_t)GV.SByteVal);
2445def7a57SChris Lattner         case Type::UByteTyID:   return PTOGV((void*)(uintptr_t)GV.UByteVal);
2455def7a57SChris Lattner         case Type::ShortTyID:   return PTOGV((void*)( intptr_t)GV.ShortVal);
2465def7a57SChris Lattner         case Type::UShortTyID:  return PTOGV((void*)(uintptr_t)GV.UShortVal);
2475def7a57SChris Lattner         case Type::IntTyID:     return PTOGV((void*)( intptr_t)GV.IntVal);
2485def7a57SChris Lattner         case Type::UIntTyID:    return PTOGV((void*)(uintptr_t)GV.UIntVal);
2495def7a57SChris Lattner         case Type::LongTyID:    return PTOGV((void*)( intptr_t)GV.LongVal);
2505def7a57SChris Lattner         case Type::ULongTyID:   return PTOGV((void*)(uintptr_t)GV.ULongVal);
2515def7a57SChris Lattner         default: assert(0 && "Unknown integral type!");
2525def7a57SChris Lattner         }
25368cbcc3eSChris Lattner       break;
25468cbcc3eSChris Lattner     }
25568cbcc3eSChris Lattner 
25668cbcc3eSChris Lattner     case Instruction::Add:
257c4e6bb5fSChris Lattner       switch (CE->getOperand(0)->getType()->getTypeID()) {
258c4e6bb5fSChris Lattner       default: assert(0 && "Bad add type!"); abort();
259c4e6bb5fSChris Lattner       case Type::LongTyID:
260c4e6bb5fSChris Lattner       case Type::ULongTyID:
2613b3276beSChris Lattner         Result.LongVal = getConstantValue(CE->getOperand(0)).LongVal +
2623b3276beSChris Lattner                          getConstantValue(CE->getOperand(1)).LongVal;
26368cbcc3eSChris Lattner         break;
264c4e6bb5fSChris Lattner       case Type::IntTyID:
265c4e6bb5fSChris Lattner       case Type::UIntTyID:
266c4e6bb5fSChris Lattner         Result.IntVal = getConstantValue(CE->getOperand(0)).IntVal +
267c4e6bb5fSChris Lattner                         getConstantValue(CE->getOperand(1)).IntVal;
268c4e6bb5fSChris Lattner         break;
269c4e6bb5fSChris Lattner       case Type::ShortTyID:
270c4e6bb5fSChris Lattner       case Type::UShortTyID:
271c4e6bb5fSChris Lattner         Result.ShortVal = getConstantValue(CE->getOperand(0)).ShortVal +
272c4e6bb5fSChris Lattner                           getConstantValue(CE->getOperand(1)).ShortVal;
273c4e6bb5fSChris Lattner         break;
274c4e6bb5fSChris Lattner       case Type::SByteTyID:
275c4e6bb5fSChris Lattner       case Type::UByteTyID:
276c4e6bb5fSChris Lattner         Result.SByteVal = getConstantValue(CE->getOperand(0)).SByteVal +
277c4e6bb5fSChris Lattner                           getConstantValue(CE->getOperand(1)).SByteVal;
278c4e6bb5fSChris Lattner         break;
279c4e6bb5fSChris Lattner       case Type::FloatTyID:
280c4e6bb5fSChris Lattner         Result.FloatVal = getConstantValue(CE->getOperand(0)).FloatVal +
281c4e6bb5fSChris Lattner                           getConstantValue(CE->getOperand(1)).FloatVal;
282c4e6bb5fSChris Lattner         break;
283c4e6bb5fSChris Lattner       case Type::DoubleTyID:
284c4e6bb5fSChris Lattner         Result.DoubleVal = getConstantValue(CE->getOperand(0)).DoubleVal +
285c4e6bb5fSChris Lattner                            getConstantValue(CE->getOperand(1)).DoubleVal;
286c4e6bb5fSChris Lattner         break;
287c4e6bb5fSChris Lattner       }
28868cbcc3eSChris Lattner       return Result;
2899de0d14dSChris Lattner     default:
29068cbcc3eSChris Lattner       break;
29168cbcc3eSChris Lattner     }
29268cbcc3eSChris Lattner     std::cerr << "ConstantExpr not handled as global var init: " << *CE << "\n";
2939de0d14dSChris Lattner     abort();
2949de0d14dSChris Lattner   }
295996fe010SChris Lattner 
2966b727599SChris Lattner   switch (C->getType()->getTypeID()) {
297df1f1524SChris Lattner #define GET_CONST_VAL(TY, CTY, CLASS) \
298df1f1524SChris Lattner   case Type::TY##TyID: Result.TY##Val = (CTY)cast<CLASS>(C)->getValue(); break
299df1f1524SChris Lattner     GET_CONST_VAL(Bool   , bool          , ConstantBool);
300df1f1524SChris Lattner     GET_CONST_VAL(UByte  , unsigned char , ConstantUInt);
301df1f1524SChris Lattner     GET_CONST_VAL(SByte  , signed char   , ConstantSInt);
302df1f1524SChris Lattner     GET_CONST_VAL(UShort , unsigned short, ConstantUInt);
303df1f1524SChris Lattner     GET_CONST_VAL(Short  , signed short  , ConstantSInt);
304df1f1524SChris Lattner     GET_CONST_VAL(UInt   , unsigned int  , ConstantUInt);
305df1f1524SChris Lattner     GET_CONST_VAL(Int    , signed int    , ConstantSInt);
306646c0f02SChris Lattner     GET_CONST_VAL(ULong  , uint64_t      , ConstantUInt);
307646c0f02SChris Lattner     GET_CONST_VAL(Long   , int64_t       , ConstantSInt);
308df1f1524SChris Lattner     GET_CONST_VAL(Float  , float         , ConstantFP);
309df1f1524SChris Lattner     GET_CONST_VAL(Double , double        , ConstantFP);
310996fe010SChris Lattner #undef GET_CONST_VAL
311996fe010SChris Lattner   case Type::PointerTyID:
3126a0fd73bSReid Spencer     if (isa<ConstantPointerNull>(C))
313996fe010SChris Lattner       Result.PointerVal = 0;
3146a0fd73bSReid Spencer     else if (const Function *F = dyn_cast<Function>(C))
3156a0fd73bSReid Spencer       Result = PTOGV(getPointerToFunctionOrStub(const_cast<Function*>(F)));
3166a0fd73bSReid Spencer     else if (const GlobalVariable* GV = dyn_cast<GlobalVariable>(C))
3176a0fd73bSReid Spencer       Result = PTOGV(getOrEmitGlobalVariable(const_cast<GlobalVariable*>(GV)));
318e6492f10SChris Lattner     else
319996fe010SChris Lattner       assert(0 && "Unknown constant pointer type!");
320996fe010SChris Lattner     break;
321996fe010SChris Lattner   default:
32260a7dd16SChris Lattner     std::cout << "ERROR: Constant unimp for type: " << *C->getType() << "\n";
3239de0d14dSChris Lattner     abort();
324996fe010SChris Lattner   }
325996fe010SChris Lattner   return Result;
326996fe010SChris Lattner }
327996fe010SChris Lattner 
328857c21b4SMisha Brukman /// FIXME: document
329857c21b4SMisha Brukman ///
330996fe010SChris Lattner void ExecutionEngine::StoreValueToMemory(GenericValue Val, GenericValue *Ptr,
331996fe010SChris Lattner                                          const Type *Ty) {
332996fe010SChris Lattner   if (getTargetData().isLittleEndian()) {
3336b727599SChris Lattner     switch (Ty->getTypeID()) {
334996fe010SChris Lattner     case Type::BoolTyID:
335996fe010SChris Lattner     case Type::UByteTyID:
336996fe010SChris Lattner     case Type::SByteTyID:   Ptr->Untyped[0] = Val.UByteVal; break;
337996fe010SChris Lattner     case Type::UShortTyID:
338996fe010SChris Lattner     case Type::ShortTyID:   Ptr->Untyped[0] = Val.UShortVal & 255;
339996fe010SChris Lattner                             Ptr->Untyped[1] = (Val.UShortVal >> 8) & 255;
340996fe010SChris Lattner                             break;
341b348952dSChris Lattner     Store4BytesLittleEndian:
342996fe010SChris Lattner     case Type::FloatTyID:
343996fe010SChris Lattner     case Type::UIntTyID:
344996fe010SChris Lattner     case Type::IntTyID:     Ptr->Untyped[0] =  Val.UIntVal        & 255;
345996fe010SChris Lattner                             Ptr->Untyped[1] = (Val.UIntVal >>  8) & 255;
346996fe010SChris Lattner                             Ptr->Untyped[2] = (Val.UIntVal >> 16) & 255;
347996fe010SChris Lattner                             Ptr->Untyped[3] = (Val.UIntVal >> 24) & 255;
348996fe010SChris Lattner                             break;
34969cab0ddSChris Lattner     case Type::PointerTyID: if (getTargetData().getPointerSize() == 4)
350b348952dSChris Lattner                               goto Store4BytesLittleEndian;
351996fe010SChris Lattner     case Type::DoubleTyID:
352996fe010SChris Lattner     case Type::ULongTyID:
353df1f1524SChris Lattner     case Type::LongTyID:
354df1f1524SChris Lattner       Ptr->Untyped[0] = (unsigned char)(Val.ULongVal      );
355df1f1524SChris Lattner       Ptr->Untyped[1] = (unsigned char)(Val.ULongVal >>  8);
356df1f1524SChris Lattner       Ptr->Untyped[2] = (unsigned char)(Val.ULongVal >> 16);
357df1f1524SChris Lattner       Ptr->Untyped[3] = (unsigned char)(Val.ULongVal >> 24);
358df1f1524SChris Lattner       Ptr->Untyped[4] = (unsigned char)(Val.ULongVal >> 32);
359df1f1524SChris Lattner       Ptr->Untyped[5] = (unsigned char)(Val.ULongVal >> 40);
360df1f1524SChris Lattner       Ptr->Untyped[6] = (unsigned char)(Val.ULongVal >> 48);
361df1f1524SChris Lattner       Ptr->Untyped[7] = (unsigned char)(Val.ULongVal >> 56);
362996fe010SChris Lattner       break;
363996fe010SChris Lattner     default:
36460a7dd16SChris Lattner       std::cout << "Cannot store value of type " << *Ty << "!\n";
365996fe010SChris Lattner     }
366996fe010SChris Lattner   } else {
3676b727599SChris Lattner     switch (Ty->getTypeID()) {
368996fe010SChris Lattner     case Type::BoolTyID:
369996fe010SChris Lattner     case Type::UByteTyID:
370996fe010SChris Lattner     case Type::SByteTyID:   Ptr->Untyped[0] = Val.UByteVal; break;
371996fe010SChris Lattner     case Type::UShortTyID:
372996fe010SChris Lattner     case Type::ShortTyID:   Ptr->Untyped[1] = Val.UShortVal & 255;
373996fe010SChris Lattner                             Ptr->Untyped[0] = (Val.UShortVal >> 8) & 255;
374996fe010SChris Lattner                             break;
375b348952dSChris Lattner     Store4BytesBigEndian:
376996fe010SChris Lattner     case Type::FloatTyID:
377996fe010SChris Lattner     case Type::UIntTyID:
378996fe010SChris Lattner     case Type::IntTyID:     Ptr->Untyped[3] =  Val.UIntVal        & 255;
379996fe010SChris Lattner                             Ptr->Untyped[2] = (Val.UIntVal >>  8) & 255;
380996fe010SChris Lattner                             Ptr->Untyped[1] = (Val.UIntVal >> 16) & 255;
381996fe010SChris Lattner                             Ptr->Untyped[0] = (Val.UIntVal >> 24) & 255;
382996fe010SChris Lattner                             break;
38369cab0ddSChris Lattner     case Type::PointerTyID: if (getTargetData().getPointerSize() == 4)
384b348952dSChris Lattner                               goto Store4BytesBigEndian;
385996fe010SChris Lattner     case Type::DoubleTyID:
386996fe010SChris Lattner     case Type::ULongTyID:
387df1f1524SChris Lattner     case Type::LongTyID:
388df1f1524SChris Lattner       Ptr->Untyped[7] = (unsigned char)(Val.ULongVal      );
389df1f1524SChris Lattner       Ptr->Untyped[6] = (unsigned char)(Val.ULongVal >>  8);
390df1f1524SChris Lattner       Ptr->Untyped[5] = (unsigned char)(Val.ULongVal >> 16);
391df1f1524SChris Lattner       Ptr->Untyped[4] = (unsigned char)(Val.ULongVal >> 24);
392df1f1524SChris Lattner       Ptr->Untyped[3] = (unsigned char)(Val.ULongVal >> 32);
393df1f1524SChris Lattner       Ptr->Untyped[2] = (unsigned char)(Val.ULongVal >> 40);
394df1f1524SChris Lattner       Ptr->Untyped[1] = (unsigned char)(Val.ULongVal >> 48);
395df1f1524SChris Lattner       Ptr->Untyped[0] = (unsigned char)(Val.ULongVal >> 56);
396996fe010SChris Lattner       break;
397996fe010SChris Lattner     default:
39860a7dd16SChris Lattner       std::cout << "Cannot store value of type " << *Ty << "!\n";
399996fe010SChris Lattner     }
400996fe010SChris Lattner   }
401996fe010SChris Lattner }
402996fe010SChris Lattner 
403857c21b4SMisha Brukman /// FIXME: document
404857c21b4SMisha Brukman ///
4057f389e8cSChris Lattner GenericValue ExecutionEngine::LoadValueFromMemory(GenericValue *Ptr,
4067f389e8cSChris Lattner                                                   const Type *Ty) {
4077f389e8cSChris Lattner   GenericValue Result;
4087f389e8cSChris Lattner   if (getTargetData().isLittleEndian()) {
4096b727599SChris Lattner     switch (Ty->getTypeID()) {
4107f389e8cSChris Lattner     case Type::BoolTyID:
4117f389e8cSChris Lattner     case Type::UByteTyID:
4127f389e8cSChris Lattner     case Type::SByteTyID:   Result.UByteVal = Ptr->Untyped[0]; break;
4137f389e8cSChris Lattner     case Type::UShortTyID:
4147f389e8cSChris Lattner     case Type::ShortTyID:   Result.UShortVal = (unsigned)Ptr->Untyped[0] |
4157f389e8cSChris Lattner                                               ((unsigned)Ptr->Untyped[1] << 8);
4167f389e8cSChris Lattner                             break;
4177f389e8cSChris Lattner     Load4BytesLittleEndian:
4187f389e8cSChris Lattner     case Type::FloatTyID:
4197f389e8cSChris Lattner     case Type::UIntTyID:
4207f389e8cSChris Lattner     case Type::IntTyID:     Result.UIntVal = (unsigned)Ptr->Untyped[0] |
4217f389e8cSChris Lattner                                             ((unsigned)Ptr->Untyped[1] <<  8) |
4227f389e8cSChris Lattner                                             ((unsigned)Ptr->Untyped[2] << 16) |
4237f389e8cSChris Lattner                                             ((unsigned)Ptr->Untyped[3] << 24);
4247f389e8cSChris Lattner                             break;
42569cab0ddSChris Lattner     case Type::PointerTyID: if (getTargetData().getPointerSize() == 4)
4267f389e8cSChris Lattner                               goto Load4BytesLittleEndian;
4277f389e8cSChris Lattner     case Type::DoubleTyID:
4287f389e8cSChris Lattner     case Type::ULongTyID:
4297f389e8cSChris Lattner     case Type::LongTyID:    Result.ULongVal = (uint64_t)Ptr->Untyped[0] |
4307f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[1] <<  8) |
4317f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[2] << 16) |
4327f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[3] << 24) |
4337f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[4] << 32) |
4347f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[5] << 40) |
4357f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[6] << 48) |
4367f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[7] << 56);
4377f389e8cSChris Lattner                             break;
4387f389e8cSChris Lattner     default:
4397f389e8cSChris Lattner       std::cout << "Cannot load value of type " << *Ty << "!\n";
4407f389e8cSChris Lattner       abort();
4417f389e8cSChris Lattner     }
4427f389e8cSChris Lattner   } else {
4436b727599SChris Lattner     switch (Ty->getTypeID()) {
4447f389e8cSChris Lattner     case Type::BoolTyID:
4457f389e8cSChris Lattner     case Type::UByteTyID:
4467f389e8cSChris Lattner     case Type::SByteTyID:   Result.UByteVal = Ptr->Untyped[0]; break;
4477f389e8cSChris Lattner     case Type::UShortTyID:
4487f389e8cSChris Lattner     case Type::ShortTyID:   Result.UShortVal = (unsigned)Ptr->Untyped[1] |
4497f389e8cSChris Lattner                                               ((unsigned)Ptr->Untyped[0] << 8);
4507f389e8cSChris Lattner                             break;
4517f389e8cSChris Lattner     Load4BytesBigEndian:
4527f389e8cSChris Lattner     case Type::FloatTyID:
4537f389e8cSChris Lattner     case Type::UIntTyID:
4547f389e8cSChris Lattner     case Type::IntTyID:     Result.UIntVal = (unsigned)Ptr->Untyped[3] |
4557f389e8cSChris Lattner                                             ((unsigned)Ptr->Untyped[2] <<  8) |
4567f389e8cSChris Lattner                                             ((unsigned)Ptr->Untyped[1] << 16) |
4577f389e8cSChris Lattner                                             ((unsigned)Ptr->Untyped[0] << 24);
4587f389e8cSChris Lattner                             break;
45969cab0ddSChris Lattner     case Type::PointerTyID: if (getTargetData().getPointerSize() == 4)
4607f389e8cSChris Lattner                               goto Load4BytesBigEndian;
4617f389e8cSChris Lattner     case Type::DoubleTyID:
4627f389e8cSChris Lattner     case Type::ULongTyID:
4637f389e8cSChris Lattner     case Type::LongTyID:    Result.ULongVal = (uint64_t)Ptr->Untyped[7] |
4647f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[6] <<  8) |
4657f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[5] << 16) |
4667f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[4] << 24) |
4677f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[3] << 32) |
4687f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[2] << 40) |
4697f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[1] << 48) |
4707f389e8cSChris Lattner                                              ((uint64_t)Ptr->Untyped[0] << 56);
4717f389e8cSChris Lattner                             break;
4727f389e8cSChris Lattner     default:
4737f389e8cSChris Lattner       std::cout << "Cannot load value of type " << *Ty << "!\n";
4747f389e8cSChris Lattner       abort();
4757f389e8cSChris Lattner     }
4767f389e8cSChris Lattner   }
4777f389e8cSChris Lattner   return Result;
4787f389e8cSChris Lattner }
4797f389e8cSChris Lattner 
480996fe010SChris Lattner // InitializeMemory - Recursive function to apply a Constant value into the
481996fe010SChris Lattner // specified memory location...
482996fe010SChris Lattner //
483996fe010SChris Lattner void ExecutionEngine::InitializeMemory(const Constant *Init, void *Addr) {
48461753bf8SChris Lattner   if (isa<UndefValue>(Init)) {
48561753bf8SChris Lattner     return;
48669d62138SRobert Bocchino   } else if (const ConstantPacked *CP = dyn_cast<ConstantPacked>(Init)) {
48769d62138SRobert Bocchino     unsigned ElementSize =
48869d62138SRobert Bocchino       getTargetData().getTypeSize(CP->getType()->getElementType());
48969d62138SRobert Bocchino     for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
49069d62138SRobert Bocchino       InitializeMemory(CP->getOperand(i), (char*)Addr+i*ElementSize);
49169d62138SRobert Bocchino     return;
49261753bf8SChris Lattner   } else if (Init->getType()->isFirstClassType()) {
493996fe010SChris Lattner     GenericValue Val = getConstantValue(Init);
494996fe010SChris Lattner     StoreValueToMemory(Val, (GenericValue*)Addr, Init->getType());
495996fe010SChris Lattner     return;
496834b1272SChris Lattner   } else if (isa<ConstantAggregateZero>(Init)) {
497df1f1524SChris Lattner     memset(Addr, 0, (size_t)getTargetData().getTypeSize(Init->getType()));
498834b1272SChris Lattner     return;
499996fe010SChris Lattner   }
500996fe010SChris Lattner 
5016b727599SChris Lattner   switch (Init->getType()->getTypeID()) {
502996fe010SChris Lattner   case Type::ArrayTyID: {
503996fe010SChris Lattner     const ConstantArray *CPA = cast<ConstantArray>(Init);
504996fe010SChris Lattner     unsigned ElementSize =
5058ffb6611SChris Lattner       getTargetData().getTypeSize(CPA->getType()->getElementType());
50683243725SAlkis Evlogimenos     for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
50783243725SAlkis Evlogimenos       InitializeMemory(CPA->getOperand(i), (char*)Addr+i*ElementSize);
508996fe010SChris Lattner     return;
509996fe010SChris Lattner   }
510996fe010SChris Lattner 
511996fe010SChris Lattner   case Type::StructTyID: {
512996fe010SChris Lattner     const ConstantStruct *CPS = cast<ConstantStruct>(Init);
513996fe010SChris Lattner     const StructLayout *SL =
514996fe010SChris Lattner       getTargetData().getStructLayout(cast<StructType>(CPS->getType()));
51583243725SAlkis Evlogimenos     for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
51683243725SAlkis Evlogimenos       InitializeMemory(CPS->getOperand(i), (char*)Addr+SL->MemberOffsets[i]);
517996fe010SChris Lattner     return;
518996fe010SChris Lattner   }
519996fe010SChris Lattner 
520996fe010SChris Lattner   default:
52160a7dd16SChris Lattner     std::cerr << "Bad Type: " << *Init->getType() << "\n";
522996fe010SChris Lattner     assert(0 && "Unknown constant type to initialize memory with!");
523996fe010SChris Lattner   }
524996fe010SChris Lattner }
525996fe010SChris Lattner 
526996fe010SChris Lattner /// EmitGlobals - Emit all of the global variables to memory, storing their
527996fe010SChris Lattner /// addresses into GlobalAddress.  This must make sure to copy the contents of
528996fe010SChris Lattner /// their initializers into the memory.
529996fe010SChris Lattner ///
530996fe010SChris Lattner void ExecutionEngine::emitGlobals() {
531996fe010SChris Lattner   const TargetData &TD = getTargetData();
532996fe010SChris Lattner 
533996fe010SChris Lattner   // Loop over all of the global variables in the program, allocating the memory
534996fe010SChris Lattner   // to hold them.
5358ffb6611SChris Lattner   Module &M = getModule();
5368ffb6611SChris Lattner   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
537996fe010SChris Lattner        I != E; ++I)
538996fe010SChris Lattner     if (!I->isExternal()) {
539996fe010SChris Lattner       // Get the type of the global...
540996fe010SChris Lattner       const Type *Ty = I->getType()->getElementType();
541996fe010SChris Lattner 
542996fe010SChris Lattner       // Allocate some memory for it!
543996fe010SChris Lattner       unsigned Size = TD.getTypeSize(Ty);
5446bbe3eceSChris Lattner       addGlobalMapping(I, new char[Size]);
545996fe010SChris Lattner     } else {
546e8bbcfc2SBrian Gaeke       // External variable reference. Try to use the dynamic loader to
547e8bbcfc2SBrian Gaeke       // get a pointer to it.
54870e37278SReid Spencer       if (void *SymAddr = sys::DynamicLibrary::SearchForAddressOfSymbol(
54970e37278SReid Spencer                             I->getName().c_str()))
550748e8579SChris Lattner         addGlobalMapping(I, SymAddr);
5519de0d14dSChris Lattner       else {
5529de0d14dSChris Lattner         std::cerr << "Could not resolve external global address: "
5539de0d14dSChris Lattner                   << I->getName() << "\n";
5549de0d14dSChris Lattner         abort();
5559de0d14dSChris Lattner       }
556996fe010SChris Lattner     }
557996fe010SChris Lattner 
558996fe010SChris Lattner   // Now that all of the globals are set up in memory, loop through them all and
559996fe010SChris Lattner   // initialize their contents.
5608ffb6611SChris Lattner   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
561996fe010SChris Lattner        I != E; ++I)
562996fe010SChris Lattner     if (!I->isExternal())
5636bbe3eceSChris Lattner       EmitGlobalVariable(I);
5646bbe3eceSChris Lattner }
5656bbe3eceSChris Lattner 
5666bbe3eceSChris Lattner // EmitGlobalVariable - This method emits the specified global variable to the
5676bbe3eceSChris Lattner // address specified in GlobalAddresses, or allocates new memory if it's not
5686bbe3eceSChris Lattner // already in the map.
569fbcc0aa1SChris Lattner void ExecutionEngine::EmitGlobalVariable(const GlobalVariable *GV) {
570748e8579SChris Lattner   void *GA = getPointerToGlobalIfAvailable(GV);
571dc631735SChris Lattner   DEBUG(std::cerr << "Global '" << GV->getName() << "' -> " << GA << "\n");
572dc631735SChris Lattner 
573fbcc0aa1SChris Lattner   const Type *ElTy = GV->getType()->getElementType();
574df1f1524SChris Lattner   size_t GVSize = (size_t)getTargetData().getTypeSize(ElTy);
5756bbe3eceSChris Lattner   if (GA == 0) {
5766bbe3eceSChris Lattner     // If it's not already specified, allocate memory for the global.
577d215992bSChris Lattner     GA = new char[GVSize];
578748e8579SChris Lattner     addGlobalMapping(GV, GA);
5796bbe3eceSChris Lattner   }
580fbcc0aa1SChris Lattner 
5816bbe3eceSChris Lattner   InitializeMemory(GV->getInitializer(), GA);
582df1f1524SChris Lattner   NumInitBytes += (unsigned)GVSize;
5836bbe3eceSChris Lattner   ++NumGlobals;
584996fe010SChris Lattner }
585