Add DisableGVCompilation which forces the JIT to assert when it tries to allocate...
[oota-llvm.git] / 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 program, depending on the
234 /// value of isDtors.
235 void ExecutionEngine::runStaticConstructorsDestructors(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   for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
240     GlobalVariable *GV = Modules[m]->getModule()->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()) continue;
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) continue;
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) break; // 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
272 #ifndef NDEBUG
273 /// isTargetNullPtr - Return whether the target pointer stored at Loc is null.
274 static bool isTargetNullPtr(ExecutionEngine *EE, void *Loc) {
275   unsigned PtrSize = EE->getTargetData()->getPointerSize();
276   for (unsigned i = 0; i < PtrSize; ++i)
277     if (*(i + (uint8_t*)Loc))
278       return false;
279   return true;
280 }
281 #endif
282
283 /// runFunctionAsMain - This is a helper function which wraps runFunction to
284 /// handle the common task of starting up main with the specified argc, argv,
285 /// and envp parameters.
286 int ExecutionEngine::runFunctionAsMain(Function *Fn,
287                                        const std::vector<std::string> &argv,
288                                        const char * const * envp) {
289   std::vector<GenericValue> GVArgs;
290   GenericValue GVArgc;
291   GVArgc.IntVal = APInt(32, argv.size());
292
293   // Check main() type
294   unsigned NumArgs = Fn->getFunctionType()->getNumParams();
295   const FunctionType *FTy = Fn->getFunctionType();
296   const Type* PPInt8Ty = 
297     PointerType::getUnqual(PointerType::getUnqual(Type::Int8Ty));
298   switch (NumArgs) {
299   case 3:
300    if (FTy->getParamType(2) != PPInt8Ty) {
301      cerr << "Invalid type for third argument of main() supplied\n";
302      abort();
303    }
304    // FALLS THROUGH
305   case 2:
306    if (FTy->getParamType(1) != PPInt8Ty) {
307      cerr << "Invalid type for second argument of main() supplied\n";
308      abort();
309    }
310    // FALLS THROUGH
311   case 1:
312    if (FTy->getParamType(0) != Type::Int32Ty) {
313      cerr << "Invalid type for first argument of main() supplied\n";
314      abort();
315    }
316    // FALLS THROUGH
317   case 0:
318    if (FTy->getReturnType() != Type::Int32Ty &&
319        FTy->getReturnType() != Type::VoidTy) {
320      cerr << "Invalid return type of main() supplied\n";
321      abort();
322    }
323    break;
324   default:
325    cerr << "Invalid number of arguments of main() supplied\n";
326    abort();
327   }
328   
329   if (NumArgs) {
330     GVArgs.push_back(GVArgc); // Arg #0 = argc.
331     if (NumArgs > 1) {
332       GVArgs.push_back(PTOGV(CreateArgv(this, argv))); // Arg #1 = argv.
333       assert(!isTargetNullPtr(this, GVTOP(GVArgs[1])) &&
334              "argv[0] was null after CreateArgv");
335       if (NumArgs > 2) {
336         std::vector<std::string> EnvVars;
337         for (unsigned i = 0; envp[i]; ++i)
338           EnvVars.push_back(envp[i]);
339         GVArgs.push_back(PTOGV(CreateArgv(this, EnvVars))); // Arg #2 = envp.
340       }
341     }
342   }
343   return runFunction(Fn, GVArgs).IntVal.getZExtValue();
344 }
345
346 /// If possible, create a JIT, unless the caller specifically requests an
347 /// Interpreter or there's an error. If even an Interpreter cannot be created,
348 /// NULL is returned.
349 ///
350 ExecutionEngine *ExecutionEngine::create(ModuleProvider *MP,
351                                          bool ForceInterpreter,
352                                          std::string *ErrorStr,
353                                          bool Fast) {
354   ExecutionEngine *EE = 0;
355
356   // Make sure we can resolve symbols in the program as well. The zero arg
357   // to the function tells DynamicLibrary to load the program, not a library.
358   if (sys::DynamicLibrary::LoadLibraryPermanently(0, ErrorStr))
359     return 0;
360
361   // Unless the interpreter was explicitly selected, try making a JIT.
362   if (!ForceInterpreter && JITCtor)
363     EE = JITCtor(MP, ErrorStr, Fast);
364
365   // If we can't make a JIT, make an interpreter instead.
366   if (EE == 0 && InterpCtor)
367     EE = InterpCtor(MP, ErrorStr, Fast);
368
369   return EE;
370 }
371
372 ExecutionEngine *ExecutionEngine::create(Module *M) {
373   return create(new ExistingModuleProvider(M));
374 }
375
376 /// getPointerToGlobal - This returns the address of the specified global
377 /// value.  This may involve code generation if it's a function.
378 ///
379 void *ExecutionEngine::getPointerToGlobal(const GlobalValue *GV) {
380   if (Function *F = const_cast<Function*>(dyn_cast<Function>(GV)))
381     return getPointerToFunction(F);
382
383   MutexGuard locked(lock);
384   void *p = state.getGlobalAddressMap(locked)[GV];
385   if (p)
386     return p;
387
388   // Global variable might have been added since interpreter started.
389   if (GlobalVariable *GVar =
390           const_cast<GlobalVariable *>(dyn_cast<GlobalVariable>(GV)))
391     EmitGlobalVariable(GVar);
392   else
393     assert(0 && "Global hasn't had an address allocated yet!");
394   return state.getGlobalAddressMap(locked)[GV];
395 }
396
397 /// This function converts a Constant* into a GenericValue. The interesting 
398 /// part is if C is a ConstantExpr.
399 /// @brief Get a GenericValue for a Constant*
400 GenericValue ExecutionEngine::getConstantValue(const Constant *C) {
401   // If its undefined, return the garbage.
402   if (isa<UndefValue>(C)) 
403     return GenericValue();
404
405   // If the value is a ConstantExpr
406   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
407     Constant *Op0 = CE->getOperand(0);
408     switch (CE->getOpcode()) {
409     case Instruction::GetElementPtr: {
410       // Compute the index 
411       GenericValue Result = getConstantValue(Op0);
412       SmallVector<Value*, 8> Indices(CE->op_begin()+1, CE->op_end());
413       uint64_t Offset =
414         TD->getIndexedOffset(Op0->getType(), &Indices[0], Indices.size());
415
416       char* tmp = (char*) Result.PointerVal;
417       Result = PTOGV(tmp + Offset);
418       return Result;
419     }
420     case Instruction::Trunc: {
421       GenericValue GV = getConstantValue(Op0);
422       uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
423       GV.IntVal = GV.IntVal.trunc(BitWidth);
424       return GV;
425     }
426     case Instruction::ZExt: {
427       GenericValue GV = getConstantValue(Op0);
428       uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
429       GV.IntVal = GV.IntVal.zext(BitWidth);
430       return GV;
431     }
432     case Instruction::SExt: {
433       GenericValue GV = getConstantValue(Op0);
434       uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
435       GV.IntVal = GV.IntVal.sext(BitWidth);
436       return GV;
437     }
438     case Instruction::FPTrunc: {
439       // FIXME long double
440       GenericValue GV = getConstantValue(Op0);
441       GV.FloatVal = float(GV.DoubleVal);
442       return GV;
443     }
444     case Instruction::FPExt:{
445       // FIXME long double
446       GenericValue GV = getConstantValue(Op0);
447       GV.DoubleVal = double(GV.FloatVal);
448       return GV;
449     }
450     case Instruction::UIToFP: {
451       GenericValue GV = getConstantValue(Op0);
452       if (CE->getType() == Type::FloatTy)
453         GV.FloatVal = float(GV.IntVal.roundToDouble());
454       else if (CE->getType() == Type::DoubleTy)
455         GV.DoubleVal = GV.IntVal.roundToDouble();
456       else if (CE->getType() == Type::X86_FP80Ty) {
457         const uint64_t zero[] = {0, 0};
458         APFloat apf = APFloat(APInt(80, 2, zero));
459         (void)apf.convertFromAPInt(GV.IntVal, 
460                                    false,
461                                    APFloat::rmNearestTiesToEven);
462         GV.IntVal = apf.convertToAPInt();
463       }
464       return GV;
465     }
466     case Instruction::SIToFP: {
467       GenericValue GV = getConstantValue(Op0);
468       if (CE->getType() == Type::FloatTy)
469         GV.FloatVal = float(GV.IntVal.signedRoundToDouble());
470       else if (CE->getType() == Type::DoubleTy)
471         GV.DoubleVal = GV.IntVal.signedRoundToDouble();
472       else if (CE->getType() == Type::X86_FP80Ty) {
473         const uint64_t zero[] = { 0, 0};
474         APFloat apf = APFloat(APInt(80, 2, zero));
475         (void)apf.convertFromAPInt(GV.IntVal, 
476                                    true,
477                                    APFloat::rmNearestTiesToEven);
478         GV.IntVal = apf.convertToAPInt();
479       }
480       return GV;
481     }
482     case Instruction::FPToUI: // double->APInt conversion handles sign
483     case Instruction::FPToSI: {
484       GenericValue GV = getConstantValue(Op0);
485       uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
486       if (Op0->getType() == Type::FloatTy)
487         GV.IntVal = APIntOps::RoundFloatToAPInt(GV.FloatVal, BitWidth);
488       else if (Op0->getType() == Type::DoubleTy)
489         GV.IntVal = APIntOps::RoundDoubleToAPInt(GV.DoubleVal, BitWidth);
490       else if (Op0->getType() == Type::X86_FP80Ty) {
491         APFloat apf = APFloat(GV.IntVal);
492         uint64_t v;
493         (void)apf.convertToInteger(&v, BitWidth,
494                                    CE->getOpcode()==Instruction::FPToSI, 
495                                    APFloat::rmTowardZero);
496         GV.IntVal = v; // endian?
497       }
498       return GV;
499     }
500     case Instruction::PtrToInt: {
501       GenericValue GV = getConstantValue(Op0);
502       uint32_t PtrWidth = TD->getPointerSizeInBits();
503       GV.IntVal = APInt(PtrWidth, uintptr_t(GV.PointerVal));
504       return GV;
505     }
506     case Instruction::IntToPtr: {
507       GenericValue GV = getConstantValue(Op0);
508       uint32_t PtrWidth = TD->getPointerSizeInBits();
509       if (PtrWidth != GV.IntVal.getBitWidth())
510         GV.IntVal = GV.IntVal.zextOrTrunc(PtrWidth);
511       assert(GV.IntVal.getBitWidth() <= 64 && "Bad pointer width");
512       GV.PointerVal = PointerTy(uintptr_t(GV.IntVal.getZExtValue()));
513       return GV;
514     }
515     case Instruction::BitCast: {
516       GenericValue GV = getConstantValue(Op0);
517       const Type* DestTy = CE->getType();
518       switch (Op0->getType()->getTypeID()) {
519         default: assert(0 && "Invalid bitcast operand");
520         case Type::IntegerTyID:
521           assert(DestTy->isFloatingPoint() && "invalid bitcast");
522           if (DestTy == Type::FloatTy)
523             GV.FloatVal = GV.IntVal.bitsToFloat();
524           else if (DestTy == Type::DoubleTy)
525             GV.DoubleVal = GV.IntVal.bitsToDouble();
526           break;
527         case Type::FloatTyID: 
528           assert(DestTy == Type::Int32Ty && "Invalid bitcast");
529           GV.IntVal.floatToBits(GV.FloatVal);
530           break;
531         case Type::DoubleTyID:
532           assert(DestTy == Type::Int64Ty && "Invalid bitcast");
533           GV.IntVal.doubleToBits(GV.DoubleVal);
534           break;
535         case Type::PointerTyID:
536           assert(isa<PointerType>(DestTy) && "Invalid bitcast");
537           break; // getConstantValue(Op0)  above already converted it
538       }
539       return GV;
540     }
541     case Instruction::Add:
542     case Instruction::Sub:
543     case Instruction::Mul:
544     case Instruction::UDiv:
545     case Instruction::SDiv:
546     case Instruction::URem:
547     case Instruction::SRem:
548     case Instruction::And:
549     case Instruction::Or:
550     case Instruction::Xor: {
551       GenericValue LHS = getConstantValue(Op0);
552       GenericValue RHS = getConstantValue(CE->getOperand(1));
553       GenericValue GV;
554       switch (CE->getOperand(0)->getType()->getTypeID()) {
555       default: assert(0 && "Bad add type!"); abort();
556       case Type::IntegerTyID:
557         switch (CE->getOpcode()) {
558           default: assert(0 && "Invalid integer opcode");
559           case Instruction::Add: GV.IntVal = LHS.IntVal + RHS.IntVal; break;
560           case Instruction::Sub: GV.IntVal = LHS.IntVal - RHS.IntVal; break;
561           case Instruction::Mul: GV.IntVal = LHS.IntVal * RHS.IntVal; break;
562           case Instruction::UDiv:GV.IntVal = LHS.IntVal.udiv(RHS.IntVal); break;
563           case Instruction::SDiv:GV.IntVal = LHS.IntVal.sdiv(RHS.IntVal); break;
564           case Instruction::URem:GV.IntVal = LHS.IntVal.urem(RHS.IntVal); break;
565           case Instruction::SRem:GV.IntVal = LHS.IntVal.srem(RHS.IntVal); break;
566           case Instruction::And: GV.IntVal = LHS.IntVal & RHS.IntVal; break;
567           case Instruction::Or:  GV.IntVal = LHS.IntVal | RHS.IntVal; break;
568           case Instruction::Xor: GV.IntVal = LHS.IntVal ^ RHS.IntVal; break;
569         }
570         break;
571       case Type::FloatTyID:
572         switch (CE->getOpcode()) {
573           default: assert(0 && "Invalid float opcode"); abort();
574           case Instruction::Add:  
575             GV.FloatVal = LHS.FloatVal + RHS.FloatVal; break;
576           case Instruction::Sub:  
577             GV.FloatVal = LHS.FloatVal - RHS.FloatVal; break;
578           case Instruction::Mul:  
579             GV.FloatVal = LHS.FloatVal * RHS.FloatVal; break;
580           case Instruction::FDiv: 
581             GV.FloatVal = LHS.FloatVal / RHS.FloatVal; break;
582           case Instruction::FRem: 
583             GV.FloatVal = ::fmodf(LHS.FloatVal,RHS.FloatVal); break;
584         }
585         break;
586       case Type::DoubleTyID:
587         switch (CE->getOpcode()) {
588           default: assert(0 && "Invalid double opcode"); abort();
589           case Instruction::Add:  
590             GV.DoubleVal = LHS.DoubleVal + RHS.DoubleVal; break;
591           case Instruction::Sub:  
592             GV.DoubleVal = LHS.DoubleVal - RHS.DoubleVal; break;
593           case Instruction::Mul:  
594             GV.DoubleVal = LHS.DoubleVal * RHS.DoubleVal; break;
595           case Instruction::FDiv: 
596             GV.DoubleVal = LHS.DoubleVal / RHS.DoubleVal; break;
597           case Instruction::FRem: 
598             GV.DoubleVal = ::fmod(LHS.DoubleVal,RHS.DoubleVal); break;
599         }
600         break;
601       case Type::X86_FP80TyID:
602       case Type::PPC_FP128TyID:
603       case Type::FP128TyID: {
604         APFloat apfLHS = APFloat(LHS.IntVal);
605         switch (CE->getOpcode()) {
606           default: assert(0 && "Invalid long double opcode"); abort();
607           case Instruction::Add:  
608             apfLHS.add(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
609             GV.IntVal = apfLHS.convertToAPInt();
610             break;
611           case Instruction::Sub:  
612             apfLHS.subtract(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
613             GV.IntVal = apfLHS.convertToAPInt();
614             break;
615           case Instruction::Mul:  
616             apfLHS.multiply(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
617             GV.IntVal = apfLHS.convertToAPInt();
618             break;
619           case Instruction::FDiv: 
620             apfLHS.divide(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
621             GV.IntVal = apfLHS.convertToAPInt();
622             break;
623           case Instruction::FRem: 
624             apfLHS.mod(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
625             GV.IntVal = apfLHS.convertToAPInt();
626             break;
627           }
628         }
629         break;
630       }
631       return GV;
632     }
633     default:
634       break;
635     }
636     cerr << "ConstantExpr not handled: " << *CE << "\n";
637     abort();
638   }
639
640   GenericValue Result;
641   switch (C->getType()->getTypeID()) {
642   case Type::FloatTyID: 
643     Result.FloatVal = cast<ConstantFP>(C)->getValueAPF().convertToFloat(); 
644     break;
645   case Type::DoubleTyID:
646     Result.DoubleVal = cast<ConstantFP>(C)->getValueAPF().convertToDouble();
647     break;
648   case Type::X86_FP80TyID:
649   case Type::FP128TyID:
650   case Type::PPC_FP128TyID:
651     Result.IntVal = cast <ConstantFP>(C)->getValueAPF().convertToAPInt();
652     break;
653   case Type::IntegerTyID:
654     Result.IntVal = cast<ConstantInt>(C)->getValue();
655     break;
656   case Type::PointerTyID:
657     if (isa<ConstantPointerNull>(C))
658       Result.PointerVal = 0;
659     else if (const Function *F = dyn_cast<Function>(C))
660       Result = PTOGV(getPointerToFunctionOrStub(const_cast<Function*>(F)));
661     else if (const GlobalVariable* GV = dyn_cast<GlobalVariable>(C))
662       Result = PTOGV(getOrEmitGlobalVariable(const_cast<GlobalVariable*>(GV)));
663     else
664       assert(0 && "Unknown constant pointer type!");
665     break;
666   default:
667     cerr << "ERROR: Constant unimplemented for type: " << *C->getType() << "\n";
668     abort();
669   }
670   return Result;
671 }
672
673 /// StoreIntToMemory - Fills the StoreBytes bytes of memory starting from Dst
674 /// with the integer held in IntVal.
675 static void StoreIntToMemory(const APInt &IntVal, uint8_t *Dst,
676                              unsigned StoreBytes) {
677   assert((IntVal.getBitWidth()+7)/8 >= StoreBytes && "Integer too small!");
678   uint8_t *Src = (uint8_t *)IntVal.getRawData();
679
680   if (sys::littleEndianHost())
681     // Little-endian host - the source is ordered from LSB to MSB.  Order the
682     // destination from LSB to MSB: Do a straight copy.
683     memcpy(Dst, Src, StoreBytes);
684   else {
685     // Big-endian host - the source is an array of 64 bit words ordered from
686     // LSW to MSW.  Each word is ordered from MSB to LSB.  Order the destination
687     // from MSB to LSB: Reverse the word order, but not the bytes in a word.
688     while (StoreBytes > sizeof(uint64_t)) {
689       StoreBytes -= sizeof(uint64_t);
690       // May not be aligned so use memcpy.
691       memcpy(Dst + StoreBytes, Src, sizeof(uint64_t));
692       Src += sizeof(uint64_t);
693     }
694
695     memcpy(Dst, Src + sizeof(uint64_t) - StoreBytes, StoreBytes);
696   }
697 }
698
699 /// StoreValueToMemory - Stores the data in Val of type Ty at address Ptr.  Ptr
700 /// is the address of the memory at which to store Val, cast to GenericValue *.
701 /// It is not a pointer to a GenericValue containing the address at which to
702 /// store Val.
703 void ExecutionEngine::StoreValueToMemory(const GenericValue &Val, GenericValue *Ptr,
704                                          const Type *Ty) {
705   const unsigned StoreBytes = getTargetData()->getTypeStoreSize(Ty);
706
707   switch (Ty->getTypeID()) {
708   case Type::IntegerTyID:
709     StoreIntToMemory(Val.IntVal, (uint8_t*)Ptr, StoreBytes);
710     break;
711   case Type::FloatTyID:
712     *((float*)Ptr) = Val.FloatVal;
713     break;
714   case Type::DoubleTyID:
715     *((double*)Ptr) = Val.DoubleVal;
716     break;
717   case Type::X86_FP80TyID: {
718       uint16_t *Dest = (uint16_t*)Ptr;
719       const uint16_t *Src = (uint16_t*)Val.IntVal.getRawData();
720       // This is endian dependent, but it will only work on x86 anyway.
721       Dest[0] = Src[4];
722       Dest[1] = Src[0];
723       Dest[2] = Src[1];
724       Dest[3] = Src[2];
725       Dest[4] = Src[3];
726       break;
727     }
728   case Type::PointerTyID:
729     // Ensure 64 bit target pointers are fully initialized on 32 bit hosts.
730     if (StoreBytes != sizeof(PointerTy))
731       memset(Ptr, 0, StoreBytes);
732
733     *((PointerTy*)Ptr) = Val.PointerVal;
734     break;
735   default:
736     cerr << "Cannot store value of type " << *Ty << "!\n";
737   }
738
739   if (sys::littleEndianHost() != getTargetData()->isLittleEndian())
740     // Host and target are different endian - reverse the stored bytes.
741     std::reverse((uint8_t*)Ptr, StoreBytes + (uint8_t*)Ptr);
742 }
743
744 /// LoadIntFromMemory - Loads the integer stored in the LoadBytes bytes starting
745 /// from Src into IntVal, which is assumed to be wide enough and to hold zero.
746 static void LoadIntFromMemory(APInt &IntVal, uint8_t *Src, unsigned LoadBytes) {
747   assert((IntVal.getBitWidth()+7)/8 >= LoadBytes && "Integer too small!");
748   uint8_t *Dst = (uint8_t *)IntVal.getRawData();
749
750   if (sys::littleEndianHost())
751     // Little-endian host - the destination must be ordered from LSB to MSB.
752     // The source is ordered from LSB to MSB: Do a straight copy.
753     memcpy(Dst, Src, LoadBytes);
754   else {
755     // Big-endian - the destination is an array of 64 bit words ordered from
756     // LSW to MSW.  Each word must be ordered from MSB to LSB.  The source is
757     // ordered from MSB to LSB: Reverse the word order, but not the bytes in
758     // a word.
759     while (LoadBytes > sizeof(uint64_t)) {
760       LoadBytes -= sizeof(uint64_t);
761       // May not be aligned so use memcpy.
762       memcpy(Dst, Src + LoadBytes, sizeof(uint64_t));
763       Dst += sizeof(uint64_t);
764     }
765
766     memcpy(Dst + sizeof(uint64_t) - LoadBytes, Src, LoadBytes);
767   }
768 }
769
770 /// FIXME: document
771 ///
772 void ExecutionEngine::LoadValueFromMemory(GenericValue &Result,
773                                           GenericValue *Ptr,
774                                           const Type *Ty) {
775   const unsigned LoadBytes = getTargetData()->getTypeStoreSize(Ty);
776
777   if (sys::littleEndianHost() != getTargetData()->isLittleEndian()) {
778     // Host and target are different endian - reverse copy the stored
779     // bytes into a buffer, and load from that.
780     uint8_t *Src = (uint8_t*)Ptr;
781     uint8_t *Buf = (uint8_t*)alloca(LoadBytes);
782     std::reverse_copy(Src, Src + LoadBytes, Buf);
783     Ptr = (GenericValue*)Buf;
784   }
785
786   switch (Ty->getTypeID()) {
787   case Type::IntegerTyID:
788     // An APInt with all words initially zero.
789     Result.IntVal = APInt(cast<IntegerType>(Ty)->getBitWidth(), 0);
790     LoadIntFromMemory(Result.IntVal, (uint8_t*)Ptr, LoadBytes);
791     break;
792   case Type::FloatTyID:
793     Result.FloatVal = *((float*)Ptr);
794     break;
795   case Type::DoubleTyID:
796     Result.DoubleVal = *((double*)Ptr);
797     break;
798   case Type::PointerTyID:
799     Result.PointerVal = *((PointerTy*)Ptr);
800     break;
801   case Type::X86_FP80TyID: {
802     // This is endian dependent, but it will only work on x86 anyway.
803     // FIXME: Will not trap if loading a signaling NaN.
804     uint16_t *p = (uint16_t*)Ptr;
805     union {
806       uint16_t x[8];
807       uint64_t y[2];
808     };
809     x[0] = p[1];
810     x[1] = p[2];
811     x[2] = p[3];
812     x[3] = p[4];
813     x[4] = p[0];
814     Result.IntVal = APInt(80, 2, y);
815     break;
816   }
817   default:
818     cerr << "Cannot load value of type " << *Ty << "!\n";
819     abort();
820   }
821 }
822
823 // InitializeMemory - Recursive function to apply a Constant value into the
824 // specified memory location...
825 //
826 void ExecutionEngine::InitializeMemory(const Constant *Init, void *Addr) {
827   DOUT << "Initializing " << Addr;
828   DEBUG(Init->dump());
829   if (isa<UndefValue>(Init)) {
830     return;
831   } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(Init)) {
832     unsigned ElementSize =
833       getTargetData()->getABITypeSize(CP->getType()->getElementType());
834     for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
835       InitializeMemory(CP->getOperand(i), (char*)Addr+i*ElementSize);
836     return;
837   } else if (isa<ConstantAggregateZero>(Init)) {
838     memset(Addr, 0, (size_t)getTargetData()->getABITypeSize(Init->getType()));
839     return;
840   } else if (const ConstantArray *CPA = dyn_cast<ConstantArray>(Init)) {
841     unsigned ElementSize =
842       getTargetData()->getABITypeSize(CPA->getType()->getElementType());
843     for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
844       InitializeMemory(CPA->getOperand(i), (char*)Addr+i*ElementSize);
845     return;
846   } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(Init)) {
847     const StructLayout *SL =
848       getTargetData()->getStructLayout(cast<StructType>(CPS->getType()));
849     for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
850       InitializeMemory(CPS->getOperand(i), (char*)Addr+SL->getElementOffset(i));
851     return;
852   } else if (Init->getType()->isFirstClassType()) {
853     GenericValue Val = getConstantValue(Init);
854     StoreValueToMemory(Val, (GenericValue*)Addr, Init->getType());
855     return;
856   }
857
858   cerr << "Bad Type: " << *Init->getType() << "\n";
859   assert(0 && "Unknown constant type to initialize memory with!");
860 }
861
862 /// EmitGlobals - Emit all of the global variables to memory, storing their
863 /// addresses into GlobalAddress.  This must make sure to copy the contents of
864 /// their initializers into the memory.
865 ///
866 void ExecutionEngine::emitGlobals() {
867   const TargetData *TD = getTargetData();
868
869   // Loop over all of the global variables in the program, allocating the memory
870   // to hold them.  If there is more than one module, do a prepass over globals
871   // to figure out how the different modules should link together.
872   //
873   std::map<std::pair<std::string, const Type*>,
874            const GlobalValue*> LinkedGlobalsMap;
875
876   if (Modules.size() != 1) {
877     for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
878       Module &M = *Modules[m]->getModule();
879       for (Module::const_global_iterator I = M.global_begin(),
880            E = M.global_end(); I != E; ++I) {
881         const GlobalValue *GV = I;
882         if (GV->hasInternalLinkage() || GV->isDeclaration() ||
883             GV->hasAppendingLinkage() || !GV->hasName())
884           continue;// Ignore external globals and globals with internal linkage.
885           
886         const GlobalValue *&GVEntry = 
887           LinkedGlobalsMap[std::make_pair(GV->getName(), GV->getType())];
888
889         // If this is the first time we've seen this global, it is the canonical
890         // version.
891         if (!GVEntry) {
892           GVEntry = GV;
893           continue;
894         }
895         
896         // If the existing global is strong, never replace it.
897         if (GVEntry->hasExternalLinkage() ||
898             GVEntry->hasDLLImportLinkage() ||
899             GVEntry->hasDLLExportLinkage())
900           continue;
901         
902         // Otherwise, we know it's linkonce/weak, replace it if this is a strong
903         // symbol.  FIXME is this right for common?
904         if (GV->hasExternalLinkage() || GVEntry->hasExternalWeakLinkage())
905           GVEntry = GV;
906       }
907     }
908   }
909   
910   std::vector<const GlobalValue*> NonCanonicalGlobals;
911   for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
912     Module &M = *Modules[m]->getModule();
913     for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
914          I != E; ++I) {
915       // In the multi-module case, see what this global maps to.
916       if (!LinkedGlobalsMap.empty()) {
917         if (const GlobalValue *GVEntry = 
918               LinkedGlobalsMap[std::make_pair(I->getName(), I->getType())]) {
919           // If something else is the canonical global, ignore this one.
920           if (GVEntry != &*I) {
921             NonCanonicalGlobals.push_back(I);
922             continue;
923           }
924         }
925       }
926       
927       if (!I->isDeclaration()) {
928         // Get the type of the global.
929         const Type *Ty = I->getType()->getElementType();
930
931         // Allocate some memory for it!
932         unsigned Size = TD->getABITypeSize(Ty);
933         addGlobalMapping(I, new char[Size]);
934       } else {
935         // External variable reference. Try to use the dynamic loader to
936         // get a pointer to it.
937         if (void *SymAddr =
938             sys::DynamicLibrary::SearchForAddressOfSymbol(I->getName().c_str()))
939           addGlobalMapping(I, SymAddr);
940         else {
941           cerr << "Could not resolve external global address: "
942                << I->getName() << "\n";
943           abort();
944         }
945       }
946     }
947     
948     // If there are multiple modules, map the non-canonical globals to their
949     // canonical location.
950     if (!NonCanonicalGlobals.empty()) {
951       for (unsigned i = 0, e = NonCanonicalGlobals.size(); i != e; ++i) {
952         const GlobalValue *GV = NonCanonicalGlobals[i];
953         const GlobalValue *CGV =
954           LinkedGlobalsMap[std::make_pair(GV->getName(), GV->getType())];
955         void *Ptr = getPointerToGlobalIfAvailable(CGV);
956         assert(Ptr && "Canonical global wasn't codegen'd!");
957         addGlobalMapping(GV, getPointerToGlobalIfAvailable(CGV));
958       }
959     }
960     
961     // Now that all of the globals are set up in memory, loop through them all 
962     // and initialize their contents.
963     for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
964          I != E; ++I) {
965       if (!I->isDeclaration()) {
966         if (!LinkedGlobalsMap.empty()) {
967           if (const GlobalValue *GVEntry = 
968                 LinkedGlobalsMap[std::make_pair(I->getName(), I->getType())])
969             if (GVEntry != &*I)  // Not the canonical variable.
970               continue;
971         }
972         EmitGlobalVariable(I);
973       }
974     }
975   }
976 }
977
978 // EmitGlobalVariable - This method emits the specified global variable to the
979 // address specified in GlobalAddresses, or allocates new memory if it's not
980 // already in the map.
981 void ExecutionEngine::EmitGlobalVariable(const GlobalVariable *GV) {
982   void *GA = getPointerToGlobalIfAvailable(GV);
983   DOUT << "Global '" << GV->getName() << "' -> " << GA << "\n";
984
985   const Type *ElTy = GV->getType()->getElementType();
986   size_t GVSize = (size_t)getTargetData()->getABITypeSize(ElTy);
987   if (GA == 0) {
988     // If it's not already specified, allocate memory for the global.
989     GA = new char[GVSize];
990     addGlobalMapping(GV, GA);
991   }
992
993   InitializeMemory(GV->getInitializer(), GA);
994   NumInitBytes += (unsigned)GVSize;
995   ++NumGlobals;
996 }