blob: 69518b658495138260014d63763c2149e92c4bfd [file] [log] [blame]
Misha Brukman4afac182003-10-10 17:45:12 +00001//===-- ExecutionEngine.cpp - Common Implementation shared by EEs ---------===//
Misha Brukmanedf128a2005-04-21 22:36:52 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanedf128a2005-04-21 22:36:52 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Misha Brukmanedf128a2005-04-21 22:36:52 +00009//
Chris Lattnerbd199fb2002-12-24 00:01:05 +000010// This file defines the common interface used by the various execution engine
11// subclasses.
12//
13//===----------------------------------------------------------------------===//
14
Chris Lattner3785fad2003-08-05 17:00:32 +000015#define DEBUG_TYPE "jit"
Chris Lattnerbd199fb2002-12-24 00:01:05 +000016#include "llvm/Constants.h"
Misha Brukman19684162003-10-16 21:18:05 +000017#include "llvm/DerivedTypes.h"
Chris Lattnerbd199fb2002-12-24 00:01:05 +000018#include "llvm/Module.h"
Misha Brukman19684162003-10-16 21:18:05 +000019#include "llvm/ModuleProvider.h"
Reid Spencerdf5a37e2004-11-29 14:11:29 +000020#include "llvm/ADT/Statistic.h"
Duncan Sands8a43e9e2007-12-14 19:38:31 +000021#include "llvm/Config/alloca.h"
Misha Brukman19684162003-10-16 21:18:05 +000022#include "llvm/ExecutionEngine/ExecutionEngine.h"
Chris Lattnerfd131292003-09-05 20:08:15 +000023#include "llvm/ExecutionEngine/GenericValue.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000024#include "llvm/Support/Debug.h"
Torok Edwin31e24662009-07-07 17:32:34 +000025#include "llvm/Support/ErrorHandling.h"
Chris Lattnere7fd5532006-05-08 22:00:52 +000026#include "llvm/Support/MutexGuard.h"
Reid Spencerdf5a37e2004-11-29 14:11:29 +000027#include "llvm/System/DynamicLibrary.h"
Duncan Sands67f1c492007-12-12 23:03:45 +000028#include "llvm/System/Host.h"
Reid Spencerdf5a37e2004-11-29 14:11:29 +000029#include "llvm/Target/TargetData.h"
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +000030#include <cmath>
31#include <cstring>
Chris Lattnerc2ee9b92003-11-19 21:08:57 +000032using namespace llvm;
Chris Lattnerbd199fb2002-12-24 00:01:05 +000033
Chris Lattner36343732006-12-19 22:43:32 +000034STATISTIC(NumInitBytes, "Number of bytes of global vars initialized");
35STATISTIC(NumGlobals , "Number of global vars initialized");
Chris Lattnerbd199fb2002-12-24 00:01:05 +000036
Chris Lattner2fe4bb02006-03-22 06:07:50 +000037ExecutionEngine::EECtorFn ExecutionEngine::JITCtor = 0;
38ExecutionEngine::EECtorFn ExecutionEngine::InterpCtor = 0;
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +000039ExecutionEngine::EERegisterFn ExecutionEngine::ExceptionTableRegister = 0;
40
Chris Lattner2fe4bb02006-03-22 06:07:50 +000041
Chris Lattnerd958a5a2007-10-22 02:50:12 +000042ExecutionEngine::ExecutionEngine(ModuleProvider *P) : LazyFunctionCreator(0) {
Chris Lattner3d6e33d2006-11-09 19:31:15 +000043 LazyCompilationDisabled = false;
Evan Cheng446531e2008-09-24 16:25:55 +000044 GVCompilationDisabled = false;
Evan Cheng1b088f32008-06-17 16:49:02 +000045 SymbolSearchingDisabled = false;
Nate Begemand6b7a242009-02-18 08:31:02 +000046 DlsymStubsEnabled = false;
Chris Lattnerfe854032006-08-16 01:24:12 +000047 Modules.push_back(P);
Misha Brukman19684162003-10-16 21:18:05 +000048 assert(P && "ModuleProvider is null?");
49}
50
Brian Gaeke8e539482003-09-04 22:57:27 +000051ExecutionEngine::~ExecutionEngine() {
Reid Spencerd4c0e622007-03-03 18:19:18 +000052 clearAllGlobalMappings();
Chris Lattnerfe854032006-08-16 01:24:12 +000053 for (unsigned i = 0, e = Modules.size(); i != e; ++i)
54 delete Modules[i];
Brian Gaeke8e539482003-09-04 22:57:27 +000055}
56
Nicolas Geoffray46fa1392008-10-25 15:41:43 +000057char* ExecutionEngine::getMemoryForGV(const GlobalVariable* GV) {
58 const Type *ElTy = GV->getType()->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +000059 size_t GVSize = (size_t)getTargetData()->getTypeAllocSize(ElTy);
Nicolas Geoffray46fa1392008-10-25 15:41:43 +000060 return new char[GVSize];
61}
62
Devang Patel73d0e212007-10-15 19:56:32 +000063/// removeModuleProvider - Remove a ModuleProvider from the list of modules.
Nate Begeman60789e42009-01-23 19:27:28 +000064/// Relases the Module from the ModuleProvider, materializing it in the
65/// process, and returns the materialized Module.
Devang Patel73d0e212007-10-15 19:56:32 +000066Module* ExecutionEngine::removeModuleProvider(ModuleProvider *P,
67 std::string *ErrInfo) {
68 for(SmallVector<ModuleProvider *, 1>::iterator I = Modules.begin(),
69 E = Modules.end(); I != E; ++I) {
70 ModuleProvider *MP = *I;
71 if (MP == P) {
72 Modules.erase(I);
Nate Begemanf049e072008-05-21 16:34:48 +000073 clearGlobalMappingsFromModule(MP->getModule());
Devang Patel73d0e212007-10-15 19:56:32 +000074 return MP->releaseModule(ErrInfo);
75 }
76 }
77 return NULL;
78}
79
Nate Begeman60789e42009-01-23 19:27:28 +000080/// deleteModuleProvider - Remove a ModuleProvider from the list of modules,
81/// and deletes the ModuleProvider and owned Module. Avoids materializing
82/// the underlying module.
83void ExecutionEngine::deleteModuleProvider(ModuleProvider *P,
84 std::string *ErrInfo) {
85 for(SmallVector<ModuleProvider *, 1>::iterator I = Modules.begin(),
86 E = Modules.end(); I != E; ++I) {
87 ModuleProvider *MP = *I;
88 if (MP == P) {
89 Modules.erase(I);
90 clearGlobalMappingsFromModule(MP->getModule());
91 delete MP;
92 return;
93 }
94 }
95}
96
Chris Lattnerfe854032006-08-16 01:24:12 +000097/// FindFunctionNamed - Search all of the active modules to find the one that
98/// defines FnName. This is very slow operation and shouldn't be used for
99/// general code.
100Function *ExecutionEngine::FindFunctionNamed(const char *FnName) {
101 for (unsigned i = 0, e = Modules.size(); i != e; ++i) {
Reid Spencer688b0492007-02-05 21:19:13 +0000102 if (Function *F = Modules[i]->getModule()->getFunction(FnName))
Chris Lattnerfe854032006-08-16 01:24:12 +0000103 return F;
104 }
105 return 0;
106}
107
108
Chris Lattnere7fd5532006-05-08 22:00:52 +0000109/// addGlobalMapping - Tell the execution engine that the specified global is
110/// at the specified location. This is used internally as functions are JIT'd
111/// and as global variables are laid out in memory. It can and should also be
112/// used by clients of the EE that want to have an LLVM global overlay
113/// existing data in memory.
114void ExecutionEngine::addGlobalMapping(const GlobalValue *GV, void *Addr) {
115 MutexGuard locked(lock);
Evan Chengbc4707a2008-09-18 07:54:21 +0000116
Evan Cheng366cf292008-11-07 22:30:29 +0000117 DOUT << "JIT: Map \'" << GV->getNameStart() << "\' to [" << Addr << "]\n";
Chris Lattnere7fd5532006-05-08 22:00:52 +0000118 void *&CurVal = state.getGlobalAddressMap(locked)[GV];
119 assert((CurVal == 0 || Addr == 0) && "GlobalMapping already established!");
120 CurVal = Addr;
121
122 // If we are using the reverse mapping, add it too
123 if (!state.getGlobalAddressReverseMap(locked).empty()) {
124 const GlobalValue *&V = state.getGlobalAddressReverseMap(locked)[Addr];
125 assert((V == 0 || GV == 0) && "GlobalMapping already established!");
126 V = GV;
127 }
128}
129
130/// clearAllGlobalMappings - Clear all global mappings and start over again
131/// use in dynamic compilation scenarios when you want to move globals
132void ExecutionEngine::clearAllGlobalMappings() {
133 MutexGuard locked(lock);
134
135 state.getGlobalAddressMap(locked).clear();
136 state.getGlobalAddressReverseMap(locked).clear();
137}
138
Nate Begemanf049e072008-05-21 16:34:48 +0000139/// clearGlobalMappingsFromModule - Clear all global mappings that came from a
140/// particular module, because it has been removed from the JIT.
141void ExecutionEngine::clearGlobalMappingsFromModule(Module *M) {
142 MutexGuard locked(lock);
143
144 for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; ++FI) {
145 state.getGlobalAddressMap(locked).erase(FI);
146 state.getGlobalAddressReverseMap(locked).erase(FI);
147 }
148 for (Module::global_iterator GI = M->global_begin(), GE = M->global_end();
149 GI != GE; ++GI) {
150 state.getGlobalAddressMap(locked).erase(GI);
151 state.getGlobalAddressReverseMap(locked).erase(GI);
152 }
153}
154
Chris Lattnere7fd5532006-05-08 22:00:52 +0000155/// updateGlobalMapping - Replace an existing mapping for GV with a new
156/// address. This updates both maps as required. If "Addr" is null, the
157/// entry for the global is removed from the mappings.
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000158void *ExecutionEngine::updateGlobalMapping(const GlobalValue *GV, void *Addr) {
Chris Lattnere7fd5532006-05-08 22:00:52 +0000159 MutexGuard locked(lock);
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000160
161 std::map<const GlobalValue*, void *> &Map = state.getGlobalAddressMap(locked);
162
Chris Lattnere7fd5532006-05-08 22:00:52 +0000163 // Deleting from the mapping?
164 if (Addr == 0) {
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000165 std::map<const GlobalValue*, void *>::iterator I = Map.find(GV);
166 void *OldVal;
167 if (I == Map.end())
168 OldVal = 0;
169 else {
170 OldVal = I->second;
171 Map.erase(I);
172 }
173
Chris Lattnere7fd5532006-05-08 22:00:52 +0000174 if (!state.getGlobalAddressReverseMap(locked).empty())
175 state.getGlobalAddressReverseMap(locked).erase(Addr);
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000176 return OldVal;
Chris Lattnere7fd5532006-05-08 22:00:52 +0000177 }
178
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000179 void *&CurVal = Map[GV];
180 void *OldVal = CurVal;
181
Chris Lattnere7fd5532006-05-08 22:00:52 +0000182 if (CurVal && !state.getGlobalAddressReverseMap(locked).empty())
183 state.getGlobalAddressReverseMap(locked).erase(CurVal);
184 CurVal = Addr;
185
186 // If we are using the reverse mapping, add it too
187 if (!state.getGlobalAddressReverseMap(locked).empty()) {
188 const GlobalValue *&V = state.getGlobalAddressReverseMap(locked)[Addr];
189 assert((V == 0 || GV == 0) && "GlobalMapping already established!");
190 V = GV;
191 }
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000192 return OldVal;
Chris Lattnere7fd5532006-05-08 22:00:52 +0000193}
194
195/// getPointerToGlobalIfAvailable - This returns the address of the specified
196/// global value if it is has already been codegen'd, otherwise it returns null.
197///
198void *ExecutionEngine::getPointerToGlobalIfAvailable(const GlobalValue *GV) {
199 MutexGuard locked(lock);
200
201 std::map<const GlobalValue*, void*>::iterator I =
202 state.getGlobalAddressMap(locked).find(GV);
203 return I != state.getGlobalAddressMap(locked).end() ? I->second : 0;
204}
205
Chris Lattner55d86482003-12-31 20:21:04 +0000206/// getGlobalValueAtAddress - Return the LLVM global value object that starts
207/// at the specified address.
208///
209const GlobalValue *ExecutionEngine::getGlobalValueAtAddress(void *Addr) {
Reid Spenceree448632005-07-12 15:51:55 +0000210 MutexGuard locked(lock);
211
Chris Lattner55d86482003-12-31 20:21:04 +0000212 // If we haven't computed the reverse mapping yet, do so first.
Reid Spenceree448632005-07-12 15:51:55 +0000213 if (state.getGlobalAddressReverseMap(locked).empty()) {
Chris Lattnere7fd5532006-05-08 22:00:52 +0000214 for (std::map<const GlobalValue*, void *>::iterator
215 I = state.getGlobalAddressMap(locked).begin(),
216 E = state.getGlobalAddressMap(locked).end(); I != E; ++I)
217 state.getGlobalAddressReverseMap(locked).insert(std::make_pair(I->second,
218 I->first));
Chris Lattner55d86482003-12-31 20:21:04 +0000219 }
220
221 std::map<void *, const GlobalValue*>::iterator I =
Reid Spenceree448632005-07-12 15:51:55 +0000222 state.getGlobalAddressReverseMap(locked).find(Addr);
223 return I != state.getGlobalAddressReverseMap(locked).end() ? I->second : 0;
Chris Lattner55d86482003-12-31 20:21:04 +0000224}
Chris Lattner87f03102003-12-26 06:50:30 +0000225
226// CreateArgv - Turn a vector of strings into a nice argv style array of
227// pointers to null terminated strings.
228//
229static void *CreateArgv(ExecutionEngine *EE,
230 const std::vector<std::string> &InputArgv) {
Owen Andersona69571c2006-05-03 01:29:57 +0000231 unsigned PtrSize = EE->getTargetData()->getPointerSize();
Chris Lattner87f03102003-12-26 06:50:30 +0000232 char *Result = new char[(InputArgv.size()+1)*PtrSize];
233
Evan Chengeb5d95a2008-11-06 17:46:04 +0000234 DOUT << "JIT: ARGV = " << (void*)Result << "\n";
Christopher Lamb43ad6b32007-12-17 01:12:55 +0000235 const Type *SBytePtr = PointerType::getUnqual(Type::Int8Ty);
Chris Lattner87f03102003-12-26 06:50:30 +0000236
237 for (unsigned i = 0; i != InputArgv.size(); ++i) {
238 unsigned Size = InputArgv[i].size()+1;
239 char *Dest = new char[Size];
Evan Chengeb5d95a2008-11-06 17:46:04 +0000240 DOUT << "JIT: ARGV[" << i << "] = " << (void*)Dest << "\n";
Misha Brukmanedf128a2005-04-21 22:36:52 +0000241
Chris Lattner87f03102003-12-26 06:50:30 +0000242 std::copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
243 Dest[Size-1] = 0;
Misha Brukmanedf128a2005-04-21 22:36:52 +0000244
Chris Lattner87f03102003-12-26 06:50:30 +0000245 // Endian safe: Result[i] = (PointerTy)Dest;
246 EE->StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i*PtrSize),
247 SBytePtr);
248 }
249
250 // Null terminate it
251 EE->StoreValueToMemory(PTOGV(0),
252 (GenericValue*)(Result+InputArgv.size()*PtrSize),
253 SBytePtr);
254 return Result;
255}
256
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000257
258/// runStaticConstructorsDestructors - This method is used to execute all of
Evan Cheng18314dc2008-09-30 15:51:21 +0000259/// the static constructors or destructors for a module, depending on the
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000260/// value of isDtors.
Evan Cheng18314dc2008-09-30 15:51:21 +0000261void ExecutionEngine::runStaticConstructorsDestructors(Module *module, bool isDtors) {
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000262 const char *Name = isDtors ? "llvm.global_dtors" : "llvm.global_ctors";
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000263
Chris Lattnerfe854032006-08-16 01:24:12 +0000264 // Execute global ctors/dtors for each module in the program.
Chris Lattnerfe854032006-08-16 01:24:12 +0000265
Evan Cheng18314dc2008-09-30 15:51:21 +0000266 GlobalVariable *GV = module->getNamedGlobal(Name);
267
268 // If this global has internal linkage, or if it has a use, then it must be
269 // an old-style (llvmgcc3) static ctor with __main linked in and in use. If
270 // this is the case, don't execute any of the global ctors, __main will do
271 // it.
Rafael Espindolabb46f522009-01-15 20:18:42 +0000272 if (!GV || GV->isDeclaration() || GV->hasLocalLinkage()) return;
Evan Cheng18314dc2008-09-30 15:51:21 +0000273
274 // Should be an array of '{ int, void ()* }' structs. The first value is
275 // the init priority, which we ignore.
276 ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
277 if (!InitList) return;
278 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
279 if (ConstantStruct *CS =
280 dyn_cast<ConstantStruct>(InitList->getOperand(i))) {
281 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
282
283 Constant *FP = CS->getOperand(1);
284 if (FP->isNullValue())
285 break; // Found a null terminator, exit.
286
287 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(FP))
288 if (CE->isCast())
289 FP = CE->getOperand(0);
290 if (Function *F = dyn_cast<Function>(FP)) {
291 // Execute the ctor/dtor function!
292 runFunction(F, std::vector<GenericValue>());
293 }
294 }
295}
296
297/// runStaticConstructorsDestructors - This method is used to execute all of
298/// the static constructors or destructors for a program, depending on the
299/// value of isDtors.
300void ExecutionEngine::runStaticConstructorsDestructors(bool isDtors) {
301 // Execute global ctors/dtors for each module in the program.
302 for (unsigned m = 0, e = Modules.size(); m != e; ++m)
303 runStaticConstructorsDestructors(Modules[m]->getModule(), isDtors);
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000304}
305
Dan Gohmanb6e3d6c2008-08-26 01:38:29 +0000306#ifndef NDEBUG
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000307/// isTargetNullPtr - Return whether the target pointer stored at Loc is null.
308static bool isTargetNullPtr(ExecutionEngine *EE, void *Loc) {
309 unsigned PtrSize = EE->getTargetData()->getPointerSize();
310 for (unsigned i = 0; i < PtrSize; ++i)
311 if (*(i + (uint8_t*)Loc))
312 return false;
313 return true;
314}
Dan Gohmanb6e3d6c2008-08-26 01:38:29 +0000315#endif
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000316
Chris Lattner87f03102003-12-26 06:50:30 +0000317/// runFunctionAsMain - This is a helper function which wraps runFunction to
318/// handle the common task of starting up main with the specified argc, argv,
319/// and envp parameters.
320int ExecutionEngine::runFunctionAsMain(Function *Fn,
321 const std::vector<std::string> &argv,
322 const char * const * envp) {
323 std::vector<GenericValue> GVArgs;
324 GenericValue GVArgc;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000325 GVArgc.IntVal = APInt(32, argv.size());
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000326
327 // Check main() type
Chris Lattnerf24d0992004-08-16 01:05:35 +0000328 unsigned NumArgs = Fn->getFunctionType()->getNumParams();
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000329 const FunctionType *FTy = Fn->getFunctionType();
Christopher Lamb43ad6b32007-12-17 01:12:55 +0000330 const Type* PPInt8Ty =
331 PointerType::getUnqual(PointerType::getUnqual(Type::Int8Ty));
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000332 switch (NumArgs) {
333 case 3:
334 if (FTy->getParamType(2) != PPInt8Ty) {
335 cerr << "Invalid type for third argument of main() supplied\n";
336 abort();
337 }
Anton Korobeynikovfb450862007-06-03 19:20:49 +0000338 // FALLS THROUGH
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000339 case 2:
340 if (FTy->getParamType(1) != PPInt8Ty) {
341 cerr << "Invalid type for second argument of main() supplied\n";
342 abort();
343 }
Anton Korobeynikovfb450862007-06-03 19:20:49 +0000344 // FALLS THROUGH
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000345 case 1:
346 if (FTy->getParamType(0) != Type::Int32Ty) {
347 cerr << "Invalid type for first argument of main() supplied\n";
348 abort();
349 }
Anton Korobeynikovfb450862007-06-03 19:20:49 +0000350 // FALLS THROUGH
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000351 case 0:
Chris Lattner45f36832009-02-04 17:48:18 +0000352 if (!isa<IntegerType>(FTy->getReturnType()) &&
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000353 FTy->getReturnType() != Type::VoidTy) {
354 cerr << "Invalid return type of main() supplied\n";
355 abort();
356 }
357 break;
358 default:
359 cerr << "Invalid number of arguments of main() supplied\n";
360 abort();
361 }
362
Chris Lattnerf24d0992004-08-16 01:05:35 +0000363 if (NumArgs) {
364 GVArgs.push_back(GVArgc); // Arg #0 = argc.
365 if (NumArgs > 1) {
366 GVArgs.push_back(PTOGV(CreateArgv(this, argv))); // Arg #1 = argv.
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000367 assert(!isTargetNullPtr(this, GVTOP(GVArgs[1])) &&
Chris Lattnerf24d0992004-08-16 01:05:35 +0000368 "argv[0] was null after CreateArgv");
369 if (NumArgs > 2) {
370 std::vector<std::string> EnvVars;
371 for (unsigned i = 0; envp[i]; ++i)
372 EnvVars.push_back(envp[i]);
373 GVArgs.push_back(PTOGV(CreateArgv(this, EnvVars))); // Arg #2 = envp.
374 }
375 }
376 }
Reid Spencer8fb0f192007-03-06 03:04:04 +0000377 return runFunction(Fn, GVArgs).IntVal.getZExtValue();
Chris Lattner87f03102003-12-26 06:50:30 +0000378}
379
Misha Brukman19684162003-10-16 21:18:05 +0000380/// If possible, create a JIT, unless the caller specifically requests an
381/// Interpreter or there's an error. If even an Interpreter cannot be created,
Misha Brukmanedf128a2005-04-21 22:36:52 +0000382/// NULL is returned.
Misha Brukman4afac182003-10-10 17:45:12 +0000383///
Misha Brukmanedf128a2005-04-21 22:36:52 +0000384ExecutionEngine *ExecutionEngine::create(ModuleProvider *MP,
Reid Spencerd4c0e622007-03-03 18:19:18 +0000385 bool ForceInterpreter,
Evan Cheng502f20b2008-08-08 08:11:34 +0000386 std::string *ErrorStr,
Bill Wendling98a366d2009-04-29 23:29:43 +0000387 CodeGenOpt::Level OptLevel) {
Brian Gaeke82d82772003-09-03 20:34:19 +0000388 ExecutionEngine *EE = 0;
389
Nick Lewycky6456d862008-03-08 02:49:45 +0000390 // Make sure we can resolve symbols in the program as well. The zero arg
391 // to the function tells DynamicLibrary to load the program, not a library.
392 if (sys::DynamicLibrary::LoadLibraryPermanently(0, ErrorStr))
393 return 0;
394
Chris Lattner73011782003-12-28 09:44:37 +0000395 // Unless the interpreter was explicitly selected, try making a JIT.
Chris Lattner2fe4bb02006-03-22 06:07:50 +0000396 if (!ForceInterpreter && JITCtor)
Bill Wendling5e5cb792009-04-29 00:32:19 +0000397 EE = JITCtor(MP, ErrorStr, OptLevel);
Brian Gaeke82d82772003-09-03 20:34:19 +0000398
399 // If we can't make a JIT, make an interpreter instead.
Chris Lattner2fe4bb02006-03-22 06:07:50 +0000400 if (EE == 0 && InterpCtor)
Bill Wendling5e5cb792009-04-29 00:32:19 +0000401 EE = InterpCtor(MP, ErrorStr, OptLevel);
Chris Lattner73011782003-12-28 09:44:37 +0000402
Brian Gaeke82d82772003-09-03 20:34:19 +0000403 return EE;
404}
405
Chris Lattner8b5295b2007-10-21 22:57:11 +0000406ExecutionEngine *ExecutionEngine::create(Module *M) {
407 return create(new ExistingModuleProvider(M));
408}
409
Misha Brukman4afac182003-10-10 17:45:12 +0000410/// getPointerToGlobal - This returns the address of the specified global
411/// value. This may involve code generation if it's a function.
412///
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000413void *ExecutionEngine::getPointerToGlobal(const GlobalValue *GV) {
Brian Gaeke37df4602003-08-13 18:16:14 +0000414 if (Function *F = const_cast<Function*>(dyn_cast<Function>(GV)))
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000415 return getPointerToFunction(F);
416
Reid Spenceree448632005-07-12 15:51:55 +0000417 MutexGuard locked(lock);
Jeff Cohen68835dd2006-02-07 05:11:57 +0000418 void *p = state.getGlobalAddressMap(locked)[GV];
419 if (p)
420 return p;
421
422 // Global variable might have been added since interpreter started.
423 if (GlobalVariable *GVar =
424 const_cast<GlobalVariable *>(dyn_cast<GlobalVariable>(GV)))
425 EmitGlobalVariable(GVar);
426 else
Chris Lattner64f150f2007-02-14 06:20:04 +0000427 assert(0 && "Global hasn't had an address allocated yet!");
Reid Spenceree448632005-07-12 15:51:55 +0000428 return state.getGlobalAddressMap(locked)[GV];
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000429}
430
Reid Spencer3da59db2006-11-27 01:05:10 +0000431/// This function converts a Constant* into a GenericValue. The interesting
432/// part is if C is a ConstantExpr.
Reid Spencerba28cb92007-08-11 15:57:56 +0000433/// @brief Get a GenericValue for a Constant*
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000434GenericValue ExecutionEngine::getConstantValue(const Constant *C) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000435 // If its undefined, return the garbage.
Reid Spencerbce30f12007-03-06 22:23:15 +0000436 if (isa<UndefValue>(C))
437 return GenericValue();
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000438
Reid Spencer3da59db2006-11-27 01:05:10 +0000439 // If the value is a ConstantExpr
440 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Reid Spencerbce30f12007-03-06 22:23:15 +0000441 Constant *Op0 = CE->getOperand(0);
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000442 switch (CE->getOpcode()) {
443 case Instruction::GetElementPtr: {
Reid Spencer3da59db2006-11-27 01:05:10 +0000444 // Compute the index
Reid Spencerbce30f12007-03-06 22:23:15 +0000445 GenericValue Result = getConstantValue(Op0);
Chris Lattner829621c2007-02-10 20:35:22 +0000446 SmallVector<Value*, 8> Indices(CE->op_begin()+1, CE->op_end());
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000447 uint64_t Offset =
Reid Spencerbce30f12007-03-06 22:23:15 +0000448 TD->getIndexedOffset(Op0->getType(), &Indices[0], Indices.size());
Misha Brukmanedf128a2005-04-21 22:36:52 +0000449
Reid Spencer8fb0f192007-03-06 03:04:04 +0000450 char* tmp = (char*) Result.PointerVal;
451 Result = PTOGV(tmp + Offset);
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000452 return Result;
453 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000454 case Instruction::Trunc: {
455 GenericValue GV = getConstantValue(Op0);
456 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
457 GV.IntVal = GV.IntVal.trunc(BitWidth);
458 return GV;
459 }
460 case Instruction::ZExt: {
461 GenericValue GV = getConstantValue(Op0);
462 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
463 GV.IntVal = GV.IntVal.zext(BitWidth);
464 return GV;
465 }
466 case Instruction::SExt: {
467 GenericValue GV = getConstantValue(Op0);
468 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
469 GV.IntVal = GV.IntVal.sext(BitWidth);
470 return GV;
471 }
472 case Instruction::FPTrunc: {
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000473 // FIXME long double
Reid Spencerbce30f12007-03-06 22:23:15 +0000474 GenericValue GV = getConstantValue(Op0);
475 GV.FloatVal = float(GV.DoubleVal);
476 return GV;
477 }
478 case Instruction::FPExt:{
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000479 // FIXME long double
Reid Spencerbce30f12007-03-06 22:23:15 +0000480 GenericValue GV = getConstantValue(Op0);
481 GV.DoubleVal = double(GV.FloatVal);
482 return GV;
483 }
484 case Instruction::UIToFP: {
485 GenericValue GV = getConstantValue(Op0);
486 if (CE->getType() == Type::FloatTy)
487 GV.FloatVal = float(GV.IntVal.roundToDouble());
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000488 else if (CE->getType() == Type::DoubleTy)
Reid Spencerbce30f12007-03-06 22:23:15 +0000489 GV.DoubleVal = GV.IntVal.roundToDouble();
Dale Johannesen910993e2007-09-21 22:09:37 +0000490 else if (CE->getType() == Type::X86_FP80Ty) {
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000491 const uint64_t zero[] = {0, 0};
492 APFloat apf = APFloat(APInt(80, 2, zero));
Dan Gohman62824062008-02-29 01:27:13 +0000493 (void)apf.convertFromAPInt(GV.IntVal,
494 false,
495 APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000496 GV.IntVal = apf.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000497 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000498 return GV;
499 }
500 case Instruction::SIToFP: {
501 GenericValue GV = getConstantValue(Op0);
502 if (CE->getType() == Type::FloatTy)
503 GV.FloatVal = float(GV.IntVal.signedRoundToDouble());
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000504 else if (CE->getType() == Type::DoubleTy)
Reid Spencerbce30f12007-03-06 22:23:15 +0000505 GV.DoubleVal = GV.IntVal.signedRoundToDouble();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000506 else if (CE->getType() == Type::X86_FP80Ty) {
507 const uint64_t zero[] = { 0, 0};
508 APFloat apf = APFloat(APInt(80, 2, zero));
Dan Gohman62824062008-02-29 01:27:13 +0000509 (void)apf.convertFromAPInt(GV.IntVal,
510 true,
511 APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000512 GV.IntVal = apf.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000513 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000514 return GV;
515 }
516 case Instruction::FPToUI: // double->APInt conversion handles sign
517 case Instruction::FPToSI: {
518 GenericValue GV = getConstantValue(Op0);
519 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
520 if (Op0->getType() == Type::FloatTy)
521 GV.IntVal = APIntOps::RoundFloatToAPInt(GV.FloatVal, BitWidth);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000522 else if (Op0->getType() == Type::DoubleTy)
Reid Spencerbce30f12007-03-06 22:23:15 +0000523 GV.IntVal = APIntOps::RoundDoubleToAPInt(GV.DoubleVal, BitWidth);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000524 else if (Op0->getType() == Type::X86_FP80Ty) {
525 APFloat apf = APFloat(GV.IntVal);
526 uint64_t v;
Dale Johannesen23a98552008-10-09 23:00:39 +0000527 bool ignored;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000528 (void)apf.convertToInteger(&v, BitWidth,
529 CE->getOpcode()==Instruction::FPToSI,
Dale Johannesen23a98552008-10-09 23:00:39 +0000530 APFloat::rmTowardZero, &ignored);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000531 GV.IntVal = v; // endian?
532 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000533 return GV;
534 }
Reid Spencer3da59db2006-11-27 01:05:10 +0000535 case Instruction::PtrToInt: {
Reid Spencerbce30f12007-03-06 22:23:15 +0000536 GenericValue GV = getConstantValue(Op0);
537 uint32_t PtrWidth = TD->getPointerSizeInBits();
538 GV.IntVal = APInt(PtrWidth, uintptr_t(GV.PointerVal));
539 return GV;
540 }
541 case Instruction::IntToPtr: {
542 GenericValue GV = getConstantValue(Op0);
543 uint32_t PtrWidth = TD->getPointerSizeInBits();
544 if (PtrWidth != GV.IntVal.getBitWidth())
545 GV.IntVal = GV.IntVal.zextOrTrunc(PtrWidth);
546 assert(GV.IntVal.getBitWidth() <= 64 && "Bad pointer width");
547 GV.PointerVal = PointerTy(uintptr_t(GV.IntVal.getZExtValue()));
Reid Spencer3da59db2006-11-27 01:05:10 +0000548 return GV;
549 }
550 case Instruction::BitCast: {
Reid Spencerbce30f12007-03-06 22:23:15 +0000551 GenericValue GV = getConstantValue(Op0);
552 const Type* DestTy = CE->getType();
553 switch (Op0->getType()->getTypeID()) {
554 default: assert(0 && "Invalid bitcast operand");
555 case Type::IntegerTyID:
556 assert(DestTy->isFloatingPoint() && "invalid bitcast");
557 if (DestTy == Type::FloatTy)
558 GV.FloatVal = GV.IntVal.bitsToFloat();
559 else if (DestTy == Type::DoubleTy)
560 GV.DoubleVal = GV.IntVal.bitsToDouble();
561 break;
562 case Type::FloatTyID:
563 assert(DestTy == Type::Int32Ty && "Invalid bitcast");
564 GV.IntVal.floatToBits(GV.FloatVal);
565 break;
566 case Type::DoubleTyID:
567 assert(DestTy == Type::Int64Ty && "Invalid bitcast");
568 GV.IntVal.doubleToBits(GV.DoubleVal);
569 break;
570 case Type::PointerTyID:
571 assert(isa<PointerType>(DestTy) && "Invalid bitcast");
572 break; // getConstantValue(Op0) above already converted it
573 }
574 return GV;
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000575 }
Chris Lattner9a231222003-05-14 17:51:49 +0000576 case Instruction::Add:
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000577 case Instruction::FAdd:
Reid Spencerbce30f12007-03-06 22:23:15 +0000578 case Instruction::Sub:
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000579 case Instruction::FSub:
Reid Spencerbce30f12007-03-06 22:23:15 +0000580 case Instruction::Mul:
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000581 case Instruction::FMul:
Reid Spencerbce30f12007-03-06 22:23:15 +0000582 case Instruction::UDiv:
583 case Instruction::SDiv:
584 case Instruction::URem:
585 case Instruction::SRem:
586 case Instruction::And:
587 case Instruction::Or:
588 case Instruction::Xor: {
589 GenericValue LHS = getConstantValue(Op0);
590 GenericValue RHS = getConstantValue(CE->getOperand(1));
591 GenericValue GV;
Chris Lattner5f90cb82004-07-11 08:01:11 +0000592 switch (CE->getOperand(0)->getType()->getTypeID()) {
593 default: assert(0 && "Bad add type!"); abort();
Reid Spencera54b7cb2007-01-12 07:05:14 +0000594 case Type::IntegerTyID:
Reid Spencerbce30f12007-03-06 22:23:15 +0000595 switch (CE->getOpcode()) {
596 default: assert(0 && "Invalid integer opcode");
597 case Instruction::Add: GV.IntVal = LHS.IntVal + RHS.IntVal; break;
598 case Instruction::Sub: GV.IntVal = LHS.IntVal - RHS.IntVal; break;
599 case Instruction::Mul: GV.IntVal = LHS.IntVal * RHS.IntVal; break;
600 case Instruction::UDiv:GV.IntVal = LHS.IntVal.udiv(RHS.IntVal); break;
601 case Instruction::SDiv:GV.IntVal = LHS.IntVal.sdiv(RHS.IntVal); break;
602 case Instruction::URem:GV.IntVal = LHS.IntVal.urem(RHS.IntVal); break;
603 case Instruction::SRem:GV.IntVal = LHS.IntVal.srem(RHS.IntVal); break;
604 case Instruction::And: GV.IntVal = LHS.IntVal & RHS.IntVal; break;
605 case Instruction::Or: GV.IntVal = LHS.IntVal | RHS.IntVal; break;
606 case Instruction::Xor: GV.IntVal = LHS.IntVal ^ RHS.IntVal; break;
607 }
Chris Lattner5f90cb82004-07-11 08:01:11 +0000608 break;
609 case Type::FloatTyID:
Reid Spencerbce30f12007-03-06 22:23:15 +0000610 switch (CE->getOpcode()) {
611 default: assert(0 && "Invalid float opcode"); abort();
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000612 case Instruction::FAdd:
Reid Spencerbce30f12007-03-06 22:23:15 +0000613 GV.FloatVal = LHS.FloatVal + RHS.FloatVal; break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000614 case Instruction::FSub:
Reid Spencerbce30f12007-03-06 22:23:15 +0000615 GV.FloatVal = LHS.FloatVal - RHS.FloatVal; break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000616 case Instruction::FMul:
Reid Spencerbce30f12007-03-06 22:23:15 +0000617 GV.FloatVal = LHS.FloatVal * RHS.FloatVal; break;
618 case Instruction::FDiv:
619 GV.FloatVal = LHS.FloatVal / RHS.FloatVal; break;
620 case Instruction::FRem:
621 GV.FloatVal = ::fmodf(LHS.FloatVal,RHS.FloatVal); break;
622 }
Chris Lattner5f90cb82004-07-11 08:01:11 +0000623 break;
624 case Type::DoubleTyID:
Reid Spencerbce30f12007-03-06 22:23:15 +0000625 switch (CE->getOpcode()) {
626 default: assert(0 && "Invalid double opcode"); abort();
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000627 case Instruction::FAdd:
Reid Spencerbce30f12007-03-06 22:23:15 +0000628 GV.DoubleVal = LHS.DoubleVal + RHS.DoubleVal; break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000629 case Instruction::FSub:
Reid Spencerbce30f12007-03-06 22:23:15 +0000630 GV.DoubleVal = LHS.DoubleVal - RHS.DoubleVal; break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000631 case Instruction::FMul:
Reid Spencerbce30f12007-03-06 22:23:15 +0000632 GV.DoubleVal = LHS.DoubleVal * RHS.DoubleVal; break;
633 case Instruction::FDiv:
634 GV.DoubleVal = LHS.DoubleVal / RHS.DoubleVal; break;
635 case Instruction::FRem:
636 GV.DoubleVal = ::fmod(LHS.DoubleVal,RHS.DoubleVal); break;
637 }
Chris Lattner5f90cb82004-07-11 08:01:11 +0000638 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000639 case Type::X86_FP80TyID:
640 case Type::PPC_FP128TyID:
641 case Type::FP128TyID: {
642 APFloat apfLHS = APFloat(LHS.IntVal);
643 switch (CE->getOpcode()) {
Torok Edwin31e24662009-07-07 17:32:34 +0000644 default: assert(0 && "Invalid long double opcode");llvm_unreachable();
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000645 case Instruction::FAdd:
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000646 apfLHS.add(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000647 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000648 break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000649 case Instruction::FSub:
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000650 apfLHS.subtract(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000651 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000652 break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000653 case Instruction::FMul:
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000654 apfLHS.multiply(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000655 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000656 break;
657 case Instruction::FDiv:
658 apfLHS.divide(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000659 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000660 break;
661 case Instruction::FRem:
662 apfLHS.mod(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000663 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000664 break;
665 }
666 }
667 break;
Chris Lattner5f90cb82004-07-11 08:01:11 +0000668 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000669 return GV;
670 }
Chris Lattner9a231222003-05-14 17:51:49 +0000671 default:
672 break;
673 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000674 cerr << "ConstantExpr not handled: " << *CE << "\n";
Chris Lattner9a231222003-05-14 17:51:49 +0000675 abort();
676 }
Misha Brukmanedf128a2005-04-21 22:36:52 +0000677
Reid Spencerbce30f12007-03-06 22:23:15 +0000678 GenericValue Result;
Chris Lattnerf70c22b2004-06-17 18:19:28 +0000679 switch (C->getType()->getTypeID()) {
Reid Spencer8fb0f192007-03-06 03:04:04 +0000680 case Type::FloatTyID:
Dale Johannesen43421b32007-09-06 18:13:44 +0000681 Result.FloatVal = cast<ConstantFP>(C)->getValueAPF().convertToFloat();
Reid Spencera54b7cb2007-01-12 07:05:14 +0000682 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000683 case Type::DoubleTyID:
Dale Johannesen43421b32007-09-06 18:13:44 +0000684 Result.DoubleVal = cast<ConstantFP>(C)->getValueAPF().convertToDouble();
Reid Spencer8fb0f192007-03-06 03:04:04 +0000685 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000686 case Type::X86_FP80TyID:
687 case Type::FP128TyID:
688 case Type::PPC_FP128TyID:
Dale Johannesen7111b022008-10-09 18:53:47 +0000689 Result.IntVal = cast <ConstantFP>(C)->getValueAPF().bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000690 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000691 case Type::IntegerTyID:
692 Result.IntVal = cast<ConstantInt>(C)->getValue();
693 break;
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000694 case Type::PointerTyID:
Reid Spencer40cf2f92004-07-18 00:41:27 +0000695 if (isa<ConstantPointerNull>(C))
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000696 Result.PointerVal = 0;
Reid Spencer40cf2f92004-07-18 00:41:27 +0000697 else if (const Function *F = dyn_cast<Function>(C))
698 Result = PTOGV(getPointerToFunctionOrStub(const_cast<Function*>(F)));
699 else if (const GlobalVariable* GV = dyn_cast<GlobalVariable>(C))
700 Result = PTOGV(getOrEmitGlobalVariable(const_cast<GlobalVariable*>(GV)));
701 else
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000702 assert(0 && "Unknown constant pointer type!");
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000703 break;
704 default:
Reid Spencerbce30f12007-03-06 22:23:15 +0000705 cerr << "ERROR: Constant unimplemented for type: " << *C->getType() << "\n";
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000706 abort();
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000707 }
708 return Result;
709}
710
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000711/// StoreIntToMemory - Fills the StoreBytes bytes of memory starting from Dst
712/// with the integer held in IntVal.
713static void StoreIntToMemory(const APInt &IntVal, uint8_t *Dst,
714 unsigned StoreBytes) {
715 assert((IntVal.getBitWidth()+7)/8 >= StoreBytes && "Integer too small!");
716 uint8_t *Src = (uint8_t *)IntVal.getRawData();
717
Chris Lattnerb67c9582009-01-22 19:53:00 +0000718 if (sys::isLittleEndianHost())
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000719 // Little-endian host - the source is ordered from LSB to MSB. Order the
720 // destination from LSB to MSB: Do a straight copy.
721 memcpy(Dst, Src, StoreBytes);
722 else {
723 // Big-endian host - the source is an array of 64 bit words ordered from
724 // LSW to MSW. Each word is ordered from MSB to LSB. Order the destination
725 // from MSB to LSB: Reverse the word order, but not the bytes in a word.
726 while (StoreBytes > sizeof(uint64_t)) {
727 StoreBytes -= sizeof(uint64_t);
728 // May not be aligned so use memcpy.
729 memcpy(Dst + StoreBytes, Src, sizeof(uint64_t));
730 Src += sizeof(uint64_t);
731 }
732
733 memcpy(Dst, Src + sizeof(uint64_t) - StoreBytes, StoreBytes);
734 }
735}
736
Nate Begeman37efe672006-04-22 18:53:45 +0000737/// StoreValueToMemory - Stores the data in Val of type Ty at address Ptr. Ptr
738/// is the address of the memory at which to store Val, cast to GenericValue *.
739/// It is not a pointer to a GenericValue containing the address at which to
740/// store Val.
Evan Cheng89687e32008-11-04 06:10:31 +0000741void ExecutionEngine::StoreValueToMemory(const GenericValue &Val,
742 GenericValue *Ptr, const Type *Ty) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000743 const unsigned StoreBytes = getTargetData()->getTypeStoreSize(Ty);
744
Reid Spencer8fb0f192007-03-06 03:04:04 +0000745 switch (Ty->getTypeID()) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000746 case Type::IntegerTyID:
747 StoreIntToMemory(Val.IntVal, (uint8_t*)Ptr, StoreBytes);
Reid Spencer8fb0f192007-03-06 03:04:04 +0000748 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000749 case Type::FloatTyID:
750 *((float*)Ptr) = Val.FloatVal;
751 break;
752 case Type::DoubleTyID:
753 *((double*)Ptr) = Val.DoubleVal;
754 break;
Dale Johannesen1f8c5642009-03-24 18:16:17 +0000755 case Type::X86_FP80TyID:
756 memcpy(Ptr, Val.IntVal.getRawData(), 10);
757 break;
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000758 case Type::PointerTyID:
759 // Ensure 64 bit target pointers are fully initialized on 32 bit hosts.
760 if (StoreBytes != sizeof(PointerTy))
761 memset(Ptr, 0, StoreBytes);
762
Reid Spencer8fb0f192007-03-06 03:04:04 +0000763 *((PointerTy*)Ptr) = Val.PointerVal;
764 break;
765 default:
766 cerr << "Cannot store value of type " << *Ty << "!\n";
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000767 }
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000768
Chris Lattnerb67c9582009-01-22 19:53:00 +0000769 if (sys::isLittleEndianHost() != getTargetData()->isLittleEndian())
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000770 // Host and target are different endian - reverse the stored bytes.
771 std::reverse((uint8_t*)Ptr, StoreBytes + (uint8_t*)Ptr);
772}
773
774/// LoadIntFromMemory - Loads the integer stored in the LoadBytes bytes starting
775/// from Src into IntVal, which is assumed to be wide enough and to hold zero.
776static void LoadIntFromMemory(APInt &IntVal, uint8_t *Src, unsigned LoadBytes) {
777 assert((IntVal.getBitWidth()+7)/8 >= LoadBytes && "Integer too small!");
778 uint8_t *Dst = (uint8_t *)IntVal.getRawData();
779
Chris Lattnerb67c9582009-01-22 19:53:00 +0000780 if (sys::isLittleEndianHost())
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000781 // Little-endian host - the destination must be ordered from LSB to MSB.
782 // The source is ordered from LSB to MSB: Do a straight copy.
783 memcpy(Dst, Src, LoadBytes);
784 else {
785 // Big-endian - the destination is an array of 64 bit words ordered from
786 // LSW to MSW. Each word must be ordered from MSB to LSB. The source is
787 // ordered from MSB to LSB: Reverse the word order, but not the bytes in
788 // a word.
789 while (LoadBytes > sizeof(uint64_t)) {
790 LoadBytes -= sizeof(uint64_t);
791 // May not be aligned so use memcpy.
792 memcpy(Dst, Src + LoadBytes, sizeof(uint64_t));
793 Dst += sizeof(uint64_t);
794 }
795
796 memcpy(Dst + sizeof(uint64_t) - LoadBytes, Src, LoadBytes);
797 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000798}
799
Misha Brukman4afac182003-10-10 17:45:12 +0000800/// FIXME: document
801///
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000802void ExecutionEngine::LoadValueFromMemory(GenericValue &Result,
Duncan Sands08bfe262008-03-10 16:38:37 +0000803 GenericValue *Ptr,
804 const Type *Ty) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000805 const unsigned LoadBytes = getTargetData()->getTypeStoreSize(Ty);
Duncan Sands1eff7042007-12-10 17:43:13 +0000806
Chris Lattnerb67c9582009-01-22 19:53:00 +0000807 if (sys::isLittleEndianHost() != getTargetData()->isLittleEndian()) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000808 // Host and target are different endian - reverse copy the stored
809 // bytes into a buffer, and load from that.
810 uint8_t *Src = (uint8_t*)Ptr;
811 uint8_t *Buf = (uint8_t*)alloca(LoadBytes);
812 std::reverse_copy(Src, Src + LoadBytes, Buf);
813 Ptr = (GenericValue*)Buf;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000814 }
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000815
816 switch (Ty->getTypeID()) {
817 case Type::IntegerTyID:
818 // An APInt with all words initially zero.
819 Result.IntVal = APInt(cast<IntegerType>(Ty)->getBitWidth(), 0);
820 LoadIntFromMemory(Result.IntVal, (uint8_t*)Ptr, LoadBytes);
821 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000822 case Type::FloatTyID:
823 Result.FloatVal = *((float*)Ptr);
824 break;
825 case Type::DoubleTyID:
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000826 Result.DoubleVal = *((double*)Ptr);
Reid Spencer8fb0f192007-03-06 03:04:04 +0000827 break;
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000828 case Type::PointerTyID:
Reid Spencer8fb0f192007-03-06 03:04:04 +0000829 Result.PointerVal = *((PointerTy*)Ptr);
830 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000831 case Type::X86_FP80TyID: {
832 // This is endian dependent, but it will only work on x86 anyway.
Duncan Sands9e4635a2007-12-15 17:37:40 +0000833 // FIXME: Will not trap if loading a signaling NaN.
Dale Johannesen1f8c5642009-03-24 18:16:17 +0000834 uint64_t y[2];
835 memcpy(y, Ptr, 10);
Duncan Sandsdd65a732007-11-28 10:36:19 +0000836 Result.IntVal = APInt(80, 2, y);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000837 break;
838 }
Reid Spencer8fb0f192007-03-06 03:04:04 +0000839 default:
840 cerr << "Cannot load value of type " << *Ty << "!\n";
841 abort();
Chris Lattnerf88b9a62003-05-08 16:52:16 +0000842 }
Chris Lattnerf88b9a62003-05-08 16:52:16 +0000843}
844
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000845// InitializeMemory - Recursive function to apply a Constant value into the
846// specified memory location...
847//
848void ExecutionEngine::InitializeMemory(const Constant *Init, void *Addr) {
Evan Chengeb5d95a2008-11-06 17:46:04 +0000849 DOUT << "JIT: Initializing " << Addr << " ";
Dale Johannesendd947ea2008-08-07 01:30:15 +0000850 DEBUG(Init->dump());
Chris Lattnerbd1d3822004-10-16 18:19:26 +0000851 if (isa<UndefValue>(Init)) {
852 return;
Reid Spencer9d6565a2007-02-15 02:26:10 +0000853 } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(Init)) {
Robert Bocchino7c2b7c72006-01-20 18:18:40 +0000854 unsigned ElementSize =
Duncan Sands777d2302009-05-09 07:06:46 +0000855 getTargetData()->getTypeAllocSize(CP->getType()->getElementType());
Robert Bocchino7c2b7c72006-01-20 18:18:40 +0000856 for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
857 InitializeMemory(CP->getOperand(i), (char*)Addr+i*ElementSize);
858 return;
Chris Lattnerb6e1dd72008-02-15 00:57:28 +0000859 } else if (isa<ConstantAggregateZero>(Init)) {
Duncan Sands777d2302009-05-09 07:06:46 +0000860 memset(Addr, 0, (size_t)getTargetData()->getTypeAllocSize(Init->getType()));
Chris Lattnerb6e1dd72008-02-15 00:57:28 +0000861 return;
Dan Gohman638e3782008-05-20 03:20:09 +0000862 } else if (const ConstantArray *CPA = dyn_cast<ConstantArray>(Init)) {
863 unsigned ElementSize =
Duncan Sands777d2302009-05-09 07:06:46 +0000864 getTargetData()->getTypeAllocSize(CPA->getType()->getElementType());
Dan Gohman638e3782008-05-20 03:20:09 +0000865 for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
866 InitializeMemory(CPA->getOperand(i), (char*)Addr+i*ElementSize);
867 return;
868 } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(Init)) {
869 const StructLayout *SL =
870 getTargetData()->getStructLayout(cast<StructType>(CPS->getType()));
871 for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
872 InitializeMemory(CPS->getOperand(i), (char*)Addr+SL->getElementOffset(i));
873 return;
Chris Lattnerbd1d3822004-10-16 18:19:26 +0000874 } else if (Init->getType()->isFirstClassType()) {
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000875 GenericValue Val = getConstantValue(Init);
876 StoreValueToMemory(Val, (GenericValue*)Addr, Init->getType());
877 return;
878 }
879
Dan Gohman638e3782008-05-20 03:20:09 +0000880 cerr << "Bad Type: " << *Init->getType() << "\n";
881 assert(0 && "Unknown constant type to initialize memory with!");
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000882}
883
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000884/// EmitGlobals - Emit all of the global variables to memory, storing their
885/// addresses into GlobalAddress. This must make sure to copy the contents of
886/// their initializers into the memory.
887///
888void ExecutionEngine::emitGlobals() {
Misha Brukmanedf128a2005-04-21 22:36:52 +0000889
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000890 // Loop over all of the global variables in the program, allocating the memory
Chris Lattnerfe854032006-08-16 01:24:12 +0000891 // to hold them. If there is more than one module, do a prepass over globals
892 // to figure out how the different modules should link together.
893 //
894 std::map<std::pair<std::string, const Type*>,
895 const GlobalValue*> LinkedGlobalsMap;
Misha Brukmanedf128a2005-04-21 22:36:52 +0000896
Chris Lattnerfe854032006-08-16 01:24:12 +0000897 if (Modules.size() != 1) {
898 for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
899 Module &M = *Modules[m]->getModule();
900 for (Module::const_global_iterator I = M.global_begin(),
901 E = M.global_end(); I != E; ++I) {
902 const GlobalValue *GV = I;
Rafael Espindolabb46f522009-01-15 20:18:42 +0000903 if (GV->hasLocalLinkage() || GV->isDeclaration() ||
Chris Lattnerfe854032006-08-16 01:24:12 +0000904 GV->hasAppendingLinkage() || !GV->hasName())
905 continue;// Ignore external globals and globals with internal linkage.
906
907 const GlobalValue *&GVEntry =
908 LinkedGlobalsMap[std::make_pair(GV->getName(), GV->getType())];
909
910 // If this is the first time we've seen this global, it is the canonical
911 // version.
912 if (!GVEntry) {
913 GVEntry = GV;
914 continue;
915 }
916
917 // If the existing global is strong, never replace it.
Anton Korobeynikovb74ed072006-09-14 18:23:27 +0000918 if (GVEntry->hasExternalLinkage() ||
919 GVEntry->hasDLLImportLinkage() ||
920 GVEntry->hasDLLExportLinkage())
Chris Lattnerfe854032006-08-16 01:24:12 +0000921 continue;
922
923 // Otherwise, we know it's linkonce/weak, replace it if this is a strong
Dale Johannesenaafce772008-05-14 20:12:51 +0000924 // symbol. FIXME is this right for common?
Anton Korobeynikov78ee7b72006-12-01 00:25:12 +0000925 if (GV->hasExternalLinkage() || GVEntry->hasExternalWeakLinkage())
Chris Lattnerfe854032006-08-16 01:24:12 +0000926 GVEntry = GV;
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000927 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000928 }
Chris Lattnerfe854032006-08-16 01:24:12 +0000929 }
930
931 std::vector<const GlobalValue*> NonCanonicalGlobals;
932 for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
933 Module &M = *Modules[m]->getModule();
934 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
935 I != E; ++I) {
936 // In the multi-module case, see what this global maps to.
937 if (!LinkedGlobalsMap.empty()) {
938 if (const GlobalValue *GVEntry =
939 LinkedGlobalsMap[std::make_pair(I->getName(), I->getType())]) {
940 // If something else is the canonical global, ignore this one.
941 if (GVEntry != &*I) {
942 NonCanonicalGlobals.push_back(I);
943 continue;
944 }
945 }
946 }
947
Reid Spencer5cbf9852007-01-30 20:08:39 +0000948 if (!I->isDeclaration()) {
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000949 addGlobalMapping(I, getMemoryForGV(I));
Chris Lattnerfe854032006-08-16 01:24:12 +0000950 } else {
951 // External variable reference. Try to use the dynamic loader to
952 // get a pointer to it.
953 if (void *SymAddr =
954 sys::DynamicLibrary::SearchForAddressOfSymbol(I->getName().c_str()))
955 addGlobalMapping(I, SymAddr);
956 else {
Torok Edwin31e24662009-07-07 17:32:34 +0000957 llvm_report_error("Could not resolve external global address: "
958 +I->getName());
Chris Lattnerfe854032006-08-16 01:24:12 +0000959 }
960 }
961 }
962
963 // If there are multiple modules, map the non-canonical globals to their
964 // canonical location.
965 if (!NonCanonicalGlobals.empty()) {
966 for (unsigned i = 0, e = NonCanonicalGlobals.size(); i != e; ++i) {
967 const GlobalValue *GV = NonCanonicalGlobals[i];
968 const GlobalValue *CGV =
969 LinkedGlobalsMap[std::make_pair(GV->getName(), GV->getType())];
970 void *Ptr = getPointerToGlobalIfAvailable(CGV);
971 assert(Ptr && "Canonical global wasn't codegen'd!");
Nuno Lopesc8ed9022008-10-14 10:04:52 +0000972 addGlobalMapping(GV, Ptr);
Chris Lattnerfe854032006-08-16 01:24:12 +0000973 }
974 }
975
Reid Spencera54b7cb2007-01-12 07:05:14 +0000976 // Now that all of the globals are set up in memory, loop through them all
977 // and initialize their contents.
Chris Lattnerfe854032006-08-16 01:24:12 +0000978 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
979 I != E; ++I) {
Reid Spencer5cbf9852007-01-30 20:08:39 +0000980 if (!I->isDeclaration()) {
Chris Lattnerfe854032006-08-16 01:24:12 +0000981 if (!LinkedGlobalsMap.empty()) {
982 if (const GlobalValue *GVEntry =
983 LinkedGlobalsMap[std::make_pair(I->getName(), I->getType())])
984 if (GVEntry != &*I) // Not the canonical variable.
985 continue;
986 }
987 EmitGlobalVariable(I);
988 }
989 }
990 }
Chris Lattner24b0a182003-12-20 02:45:37 +0000991}
992
993// EmitGlobalVariable - This method emits the specified global variable to the
994// address specified in GlobalAddresses, or allocates new memory if it's not
995// already in the map.
Chris Lattnerc07ed132003-12-20 03:36:47 +0000996void ExecutionEngine::EmitGlobalVariable(const GlobalVariable *GV) {
Chris Lattner55d86482003-12-31 20:21:04 +0000997 void *GA = getPointerToGlobalIfAvailable(GV);
Chris Lattner23c47242004-02-08 19:33:23 +0000998
Chris Lattner24b0a182003-12-20 02:45:37 +0000999 if (GA == 0) {
1000 // If it's not already specified, allocate memory for the global.
Nicolas Geoffray46fa1392008-10-25 15:41:43 +00001001 GA = getMemoryForGV(GV);
Chris Lattner55d86482003-12-31 20:21:04 +00001002 addGlobalMapping(GV, GA);
Chris Lattner24b0a182003-12-20 02:45:37 +00001003 }
Nicolas Geoffray46fa1392008-10-25 15:41:43 +00001004
1005 // Don't initialize if it's thread local, let the client do it.
1006 if (!GV->isThreadLocal())
1007 InitializeMemory(GV->getInitializer(), GA);
1008
1009 const Type *ElTy = GV->getType()->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +00001010 size_t GVSize = (size_t)getTargetData()->getTypeAllocSize(ElTy);
Chris Lattner813c8152005-01-08 20:13:19 +00001011 NumInitBytes += (unsigned)GVSize;
Chris Lattner24b0a182003-12-20 02:45:37 +00001012 ++NumGlobals;
Chris Lattnerbd199fb2002-12-24 00:01:05 +00001013}