blob: 18d44816fcf3d9c43a546538e2ae1a32d83bd26b [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"
Chris Lattnere7fd5532006-05-08 22:00:52 +000025#include "llvm/Support/MutexGuard.h"
Reid Spencerdf5a37e2004-11-29 14:11:29 +000026#include "llvm/System/DynamicLibrary.h"
Duncan Sands67f1c492007-12-12 23:03:45 +000027#include "llvm/System/Host.h"
Reid Spencerdf5a37e2004-11-29 14:11:29 +000028#include "llvm/Target/TargetData.h"
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +000029#include <cmath>
30#include <cstring>
Chris Lattnerc2ee9b92003-11-19 21:08:57 +000031using namespace llvm;
Chris Lattnerbd199fb2002-12-24 00:01:05 +000032
Chris Lattner36343732006-12-19 22:43:32 +000033STATISTIC(NumInitBytes, "Number of bytes of global vars initialized");
34STATISTIC(NumGlobals , "Number of global vars initialized");
Chris Lattnerbd199fb2002-12-24 00:01:05 +000035
Chris Lattner2fe4bb02006-03-22 06:07:50 +000036ExecutionEngine::EECtorFn ExecutionEngine::JITCtor = 0;
37ExecutionEngine::EECtorFn ExecutionEngine::InterpCtor = 0;
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +000038ExecutionEngine::EERegisterFn ExecutionEngine::ExceptionTableRegister = 0;
39
Chris Lattner2fe4bb02006-03-22 06:07:50 +000040
Chris Lattnerd958a5a2007-10-22 02:50:12 +000041ExecutionEngine::ExecutionEngine(ModuleProvider *P) : LazyFunctionCreator(0) {
Chris Lattner3d6e33d2006-11-09 19:31:15 +000042 LazyCompilationDisabled = false;
Evan Cheng446531e2008-09-24 16:25:55 +000043 GVCompilationDisabled = false;
Evan Cheng1b088f32008-06-17 16:49:02 +000044 SymbolSearchingDisabled = false;
Chris Lattnerfe854032006-08-16 01:24:12 +000045 Modules.push_back(P);
Misha Brukman19684162003-10-16 21:18:05 +000046 assert(P && "ModuleProvider is null?");
47}
48
Brian Gaeke8e539482003-09-04 22:57:27 +000049ExecutionEngine::~ExecutionEngine() {
Reid Spencerd4c0e622007-03-03 18:19:18 +000050 clearAllGlobalMappings();
Chris Lattnerfe854032006-08-16 01:24:12 +000051 for (unsigned i = 0, e = Modules.size(); i != e; ++i)
52 delete Modules[i];
Brian Gaeke8e539482003-09-04 22:57:27 +000053}
54
Nicolas Geoffray46fa1392008-10-25 15:41:43 +000055char* ExecutionEngine::getMemoryForGV(const GlobalVariable* GV) {
56 const Type *ElTy = GV->getType()->getElementType();
57 size_t GVSize = (size_t)getTargetData()->getABITypeSize(ElTy);
58 return new char[GVSize];
59}
60
Devang Patel73d0e212007-10-15 19:56:32 +000061/// removeModuleProvider - Remove a ModuleProvider from the list of modules.
62/// Release module from ModuleProvider.
63Module* ExecutionEngine::removeModuleProvider(ModuleProvider *P,
64 std::string *ErrInfo) {
65 for(SmallVector<ModuleProvider *, 1>::iterator I = Modules.begin(),
66 E = Modules.end(); I != E; ++I) {
67 ModuleProvider *MP = *I;
68 if (MP == P) {
69 Modules.erase(I);
Nate Begemanf049e072008-05-21 16:34:48 +000070 clearGlobalMappingsFromModule(MP->getModule());
Devang Patel73d0e212007-10-15 19:56:32 +000071 return MP->releaseModule(ErrInfo);
72 }
73 }
74 return NULL;
75}
76
Chris Lattnerfe854032006-08-16 01:24:12 +000077/// FindFunctionNamed - Search all of the active modules to find the one that
78/// defines FnName. This is very slow operation and shouldn't be used for
79/// general code.
80Function *ExecutionEngine::FindFunctionNamed(const char *FnName) {
81 for (unsigned i = 0, e = Modules.size(); i != e; ++i) {
Reid Spencer688b0492007-02-05 21:19:13 +000082 if (Function *F = Modules[i]->getModule()->getFunction(FnName))
Chris Lattnerfe854032006-08-16 01:24:12 +000083 return F;
84 }
85 return 0;
86}
87
88
Chris Lattnere7fd5532006-05-08 22:00:52 +000089/// addGlobalMapping - Tell the execution engine that the specified global is
90/// at the specified location. This is used internally as functions are JIT'd
91/// and as global variables are laid out in memory. It can and should also be
92/// used by clients of the EE that want to have an LLVM global overlay
93/// existing data in memory.
94void ExecutionEngine::addGlobalMapping(const GlobalValue *GV, void *Addr) {
95 MutexGuard locked(lock);
Evan Chengbc4707a2008-09-18 07:54:21 +000096
Evan Cheng4e20c5c2008-11-05 00:22:28 +000097 DOUT << "Map \'" << GV->getNameStart() << "\' to " << Addr << "\n";
Chris Lattnere7fd5532006-05-08 22:00:52 +000098 void *&CurVal = state.getGlobalAddressMap(locked)[GV];
99 assert((CurVal == 0 || Addr == 0) && "GlobalMapping already established!");
100 CurVal = Addr;
101
102 // If we are using the reverse mapping, add it too
103 if (!state.getGlobalAddressReverseMap(locked).empty()) {
104 const GlobalValue *&V = state.getGlobalAddressReverseMap(locked)[Addr];
105 assert((V == 0 || GV == 0) && "GlobalMapping already established!");
106 V = GV;
107 }
108}
109
110/// clearAllGlobalMappings - Clear all global mappings and start over again
111/// use in dynamic compilation scenarios when you want to move globals
112void ExecutionEngine::clearAllGlobalMappings() {
113 MutexGuard locked(lock);
114
115 state.getGlobalAddressMap(locked).clear();
116 state.getGlobalAddressReverseMap(locked).clear();
117}
118
Nate Begemanf049e072008-05-21 16:34:48 +0000119/// clearGlobalMappingsFromModule - Clear all global mappings that came from a
120/// particular module, because it has been removed from the JIT.
121void ExecutionEngine::clearGlobalMappingsFromModule(Module *M) {
122 MutexGuard locked(lock);
123
124 for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; ++FI) {
125 state.getGlobalAddressMap(locked).erase(FI);
126 state.getGlobalAddressReverseMap(locked).erase(FI);
127 }
128 for (Module::global_iterator GI = M->global_begin(), GE = M->global_end();
129 GI != GE; ++GI) {
130 state.getGlobalAddressMap(locked).erase(GI);
131 state.getGlobalAddressReverseMap(locked).erase(GI);
132 }
133}
134
Chris Lattnere7fd5532006-05-08 22:00:52 +0000135/// updateGlobalMapping - Replace an existing mapping for GV with a new
136/// address. This updates both maps as required. If "Addr" is null, the
137/// entry for the global is removed from the mappings.
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000138void *ExecutionEngine::updateGlobalMapping(const GlobalValue *GV, void *Addr) {
Chris Lattnere7fd5532006-05-08 22:00:52 +0000139 MutexGuard locked(lock);
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000140
141 std::map<const GlobalValue*, void *> &Map = state.getGlobalAddressMap(locked);
142
Chris Lattnere7fd5532006-05-08 22:00:52 +0000143 // Deleting from the mapping?
144 if (Addr == 0) {
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000145 std::map<const GlobalValue*, void *>::iterator I = Map.find(GV);
146 void *OldVal;
147 if (I == Map.end())
148 OldVal = 0;
149 else {
150 OldVal = I->second;
151 Map.erase(I);
152 }
153
Chris Lattnere7fd5532006-05-08 22:00:52 +0000154 if (!state.getGlobalAddressReverseMap(locked).empty())
155 state.getGlobalAddressReverseMap(locked).erase(Addr);
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000156 return OldVal;
Chris Lattnere7fd5532006-05-08 22:00:52 +0000157 }
158
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000159 void *&CurVal = Map[GV];
160 void *OldVal = CurVal;
161
Chris Lattnere7fd5532006-05-08 22:00:52 +0000162 if (CurVal && !state.getGlobalAddressReverseMap(locked).empty())
163 state.getGlobalAddressReverseMap(locked).erase(CurVal);
164 CurVal = Addr;
165
166 // If we are using the reverse mapping, add it too
167 if (!state.getGlobalAddressReverseMap(locked).empty()) {
168 const GlobalValue *&V = state.getGlobalAddressReverseMap(locked)[Addr];
169 assert((V == 0 || GV == 0) && "GlobalMapping already established!");
170 V = GV;
171 }
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000172 return OldVal;
Chris Lattnere7fd5532006-05-08 22:00:52 +0000173}
174
175/// getPointerToGlobalIfAvailable - This returns the address of the specified
176/// global value if it is has already been codegen'd, otherwise it returns null.
177///
178void *ExecutionEngine::getPointerToGlobalIfAvailable(const GlobalValue *GV) {
179 MutexGuard locked(lock);
180
181 std::map<const GlobalValue*, void*>::iterator I =
182 state.getGlobalAddressMap(locked).find(GV);
183 return I != state.getGlobalAddressMap(locked).end() ? I->second : 0;
184}
185
Chris Lattner55d86482003-12-31 20:21:04 +0000186/// getGlobalValueAtAddress - Return the LLVM global value object that starts
187/// at the specified address.
188///
189const GlobalValue *ExecutionEngine::getGlobalValueAtAddress(void *Addr) {
Reid Spenceree448632005-07-12 15:51:55 +0000190 MutexGuard locked(lock);
191
Chris Lattner55d86482003-12-31 20:21:04 +0000192 // If we haven't computed the reverse mapping yet, do so first.
Reid Spenceree448632005-07-12 15:51:55 +0000193 if (state.getGlobalAddressReverseMap(locked).empty()) {
Chris Lattnere7fd5532006-05-08 22:00:52 +0000194 for (std::map<const GlobalValue*, void *>::iterator
195 I = state.getGlobalAddressMap(locked).begin(),
196 E = state.getGlobalAddressMap(locked).end(); I != E; ++I)
197 state.getGlobalAddressReverseMap(locked).insert(std::make_pair(I->second,
198 I->first));
Chris Lattner55d86482003-12-31 20:21:04 +0000199 }
200
201 std::map<void *, const GlobalValue*>::iterator I =
Reid Spenceree448632005-07-12 15:51:55 +0000202 state.getGlobalAddressReverseMap(locked).find(Addr);
203 return I != state.getGlobalAddressReverseMap(locked).end() ? I->second : 0;
Chris Lattner55d86482003-12-31 20:21:04 +0000204}
Chris Lattner87f03102003-12-26 06:50:30 +0000205
206// CreateArgv - Turn a vector of strings into a nice argv style array of
207// pointers to null terminated strings.
208//
209static void *CreateArgv(ExecutionEngine *EE,
210 const std::vector<std::string> &InputArgv) {
Owen Andersona69571c2006-05-03 01:29:57 +0000211 unsigned PtrSize = EE->getTargetData()->getPointerSize();
Chris Lattner87f03102003-12-26 06:50:30 +0000212 char *Result = new char[(InputArgv.size()+1)*PtrSize];
213
Bill Wendling480f0932006-11-27 23:54:50 +0000214 DOUT << "ARGV = " << (void*)Result << "\n";
Christopher Lamb43ad6b32007-12-17 01:12:55 +0000215 const Type *SBytePtr = PointerType::getUnqual(Type::Int8Ty);
Chris Lattner87f03102003-12-26 06:50:30 +0000216
217 for (unsigned i = 0; i != InputArgv.size(); ++i) {
218 unsigned Size = InputArgv[i].size()+1;
219 char *Dest = new char[Size];
Bill Wendling480f0932006-11-27 23:54:50 +0000220 DOUT << "ARGV[" << i << "] = " << (void*)Dest << "\n";
Misha Brukmanedf128a2005-04-21 22:36:52 +0000221
Chris Lattner87f03102003-12-26 06:50:30 +0000222 std::copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
223 Dest[Size-1] = 0;
Misha Brukmanedf128a2005-04-21 22:36:52 +0000224
Chris Lattner87f03102003-12-26 06:50:30 +0000225 // Endian safe: Result[i] = (PointerTy)Dest;
226 EE->StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i*PtrSize),
227 SBytePtr);
228 }
229
230 // Null terminate it
231 EE->StoreValueToMemory(PTOGV(0),
232 (GenericValue*)(Result+InputArgv.size()*PtrSize),
233 SBytePtr);
234 return Result;
235}
236
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000237
238/// runStaticConstructorsDestructors - This method is used to execute all of
Evan Cheng18314dc2008-09-30 15:51:21 +0000239/// the static constructors or destructors for a module, depending on the
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000240/// value of isDtors.
Evan Cheng18314dc2008-09-30 15:51:21 +0000241void ExecutionEngine::runStaticConstructorsDestructors(Module *module, bool isDtors) {
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000242 const char *Name = isDtors ? "llvm.global_dtors" : "llvm.global_ctors";
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000243
Chris Lattnerfe854032006-08-16 01:24:12 +0000244 // Execute global ctors/dtors for each module in the program.
Chris Lattnerfe854032006-08-16 01:24:12 +0000245
Evan Cheng18314dc2008-09-30 15:51:21 +0000246 GlobalVariable *GV = module->getNamedGlobal(Name);
247
248 // If this global has internal linkage, or if it has a use, then it must be
249 // an old-style (llvmgcc3) static ctor with __main linked in and in use. If
250 // this is the case, don't execute any of the global ctors, __main will do
251 // it.
252 if (!GV || GV->isDeclaration() || GV->hasInternalLinkage()) return;
253
254 // Should be an array of '{ int, void ()* }' structs. The first value is
255 // the init priority, which we ignore.
256 ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
257 if (!InitList) return;
258 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
259 if (ConstantStruct *CS =
260 dyn_cast<ConstantStruct>(InitList->getOperand(i))) {
261 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
262
263 Constant *FP = CS->getOperand(1);
264 if (FP->isNullValue())
265 break; // Found a null terminator, exit.
266
267 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(FP))
268 if (CE->isCast())
269 FP = CE->getOperand(0);
270 if (Function *F = dyn_cast<Function>(FP)) {
271 // Execute the ctor/dtor function!
272 runFunction(F, std::vector<GenericValue>());
273 }
274 }
275}
276
277/// runStaticConstructorsDestructors - This method is used to execute all of
278/// the static constructors or destructors for a program, depending on the
279/// value of isDtors.
280void ExecutionEngine::runStaticConstructorsDestructors(bool isDtors) {
281 // Execute global ctors/dtors for each module in the program.
282 for (unsigned m = 0, e = Modules.size(); m != e; ++m)
283 runStaticConstructorsDestructors(Modules[m]->getModule(), isDtors);
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000284}
285
Dan Gohmanb6e3d6c2008-08-26 01:38:29 +0000286#ifndef NDEBUG
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000287/// isTargetNullPtr - Return whether the target pointer stored at Loc is null.
288static bool isTargetNullPtr(ExecutionEngine *EE, void *Loc) {
289 unsigned PtrSize = EE->getTargetData()->getPointerSize();
290 for (unsigned i = 0; i < PtrSize; ++i)
291 if (*(i + (uint8_t*)Loc))
292 return false;
293 return true;
294}
Dan Gohmanb6e3d6c2008-08-26 01:38:29 +0000295#endif
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000296
Chris Lattner87f03102003-12-26 06:50:30 +0000297/// runFunctionAsMain - This is a helper function which wraps runFunction to
298/// handle the common task of starting up main with the specified argc, argv,
299/// and envp parameters.
300int ExecutionEngine::runFunctionAsMain(Function *Fn,
301 const std::vector<std::string> &argv,
302 const char * const * envp) {
303 std::vector<GenericValue> GVArgs;
304 GenericValue GVArgc;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000305 GVArgc.IntVal = APInt(32, argv.size());
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000306
307 // Check main() type
Chris Lattnerf24d0992004-08-16 01:05:35 +0000308 unsigned NumArgs = Fn->getFunctionType()->getNumParams();
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000309 const FunctionType *FTy = Fn->getFunctionType();
Christopher Lamb43ad6b32007-12-17 01:12:55 +0000310 const Type* PPInt8Ty =
311 PointerType::getUnqual(PointerType::getUnqual(Type::Int8Ty));
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000312 switch (NumArgs) {
313 case 3:
314 if (FTy->getParamType(2) != PPInt8Ty) {
315 cerr << "Invalid type for third argument of main() supplied\n";
316 abort();
317 }
Anton Korobeynikovfb450862007-06-03 19:20:49 +0000318 // FALLS THROUGH
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000319 case 2:
320 if (FTy->getParamType(1) != PPInt8Ty) {
321 cerr << "Invalid type for second argument of main() supplied\n";
322 abort();
323 }
Anton Korobeynikovfb450862007-06-03 19:20:49 +0000324 // FALLS THROUGH
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000325 case 1:
326 if (FTy->getParamType(0) != Type::Int32Ty) {
327 cerr << "Invalid type for first argument of main() supplied\n";
328 abort();
329 }
Anton Korobeynikovfb450862007-06-03 19:20:49 +0000330 // FALLS THROUGH
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000331 case 0:
332 if (FTy->getReturnType() != Type::Int32Ty &&
333 FTy->getReturnType() != Type::VoidTy) {
334 cerr << "Invalid return type of main() supplied\n";
335 abort();
336 }
337 break;
338 default:
339 cerr << "Invalid number of arguments of main() supplied\n";
340 abort();
341 }
342
Chris Lattnerf24d0992004-08-16 01:05:35 +0000343 if (NumArgs) {
344 GVArgs.push_back(GVArgc); // Arg #0 = argc.
345 if (NumArgs > 1) {
346 GVArgs.push_back(PTOGV(CreateArgv(this, argv))); // Arg #1 = argv.
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000347 assert(!isTargetNullPtr(this, GVTOP(GVArgs[1])) &&
Chris Lattnerf24d0992004-08-16 01:05:35 +0000348 "argv[0] was null after CreateArgv");
349 if (NumArgs > 2) {
350 std::vector<std::string> EnvVars;
351 for (unsigned i = 0; envp[i]; ++i)
352 EnvVars.push_back(envp[i]);
353 GVArgs.push_back(PTOGV(CreateArgv(this, EnvVars))); // Arg #2 = envp.
354 }
355 }
356 }
Reid Spencer8fb0f192007-03-06 03:04:04 +0000357 return runFunction(Fn, GVArgs).IntVal.getZExtValue();
Chris Lattner87f03102003-12-26 06:50:30 +0000358}
359
Misha Brukman19684162003-10-16 21:18:05 +0000360/// If possible, create a JIT, unless the caller specifically requests an
361/// Interpreter or there's an error. If even an Interpreter cannot be created,
Misha Brukmanedf128a2005-04-21 22:36:52 +0000362/// NULL is returned.
Misha Brukman4afac182003-10-10 17:45:12 +0000363///
Misha Brukmanedf128a2005-04-21 22:36:52 +0000364ExecutionEngine *ExecutionEngine::create(ModuleProvider *MP,
Reid Spencerd4c0e622007-03-03 18:19:18 +0000365 bool ForceInterpreter,
Evan Cheng502f20b2008-08-08 08:11:34 +0000366 std::string *ErrorStr,
367 bool Fast) {
Brian Gaeke82d82772003-09-03 20:34:19 +0000368 ExecutionEngine *EE = 0;
369
Nick Lewycky6456d862008-03-08 02:49:45 +0000370 // Make sure we can resolve symbols in the program as well. The zero arg
371 // to the function tells DynamicLibrary to load the program, not a library.
372 if (sys::DynamicLibrary::LoadLibraryPermanently(0, ErrorStr))
373 return 0;
374
Chris Lattner73011782003-12-28 09:44:37 +0000375 // Unless the interpreter was explicitly selected, try making a JIT.
Chris Lattner2fe4bb02006-03-22 06:07:50 +0000376 if (!ForceInterpreter && JITCtor)
Evan Cheng502f20b2008-08-08 08:11:34 +0000377 EE = JITCtor(MP, ErrorStr, Fast);
Brian Gaeke82d82772003-09-03 20:34:19 +0000378
379 // If we can't make a JIT, make an interpreter instead.
Chris Lattner2fe4bb02006-03-22 06:07:50 +0000380 if (EE == 0 && InterpCtor)
Evan Cheng502f20b2008-08-08 08:11:34 +0000381 EE = InterpCtor(MP, ErrorStr, Fast);
Chris Lattner73011782003-12-28 09:44:37 +0000382
Brian Gaeke82d82772003-09-03 20:34:19 +0000383 return EE;
384}
385
Chris Lattner8b5295b2007-10-21 22:57:11 +0000386ExecutionEngine *ExecutionEngine::create(Module *M) {
387 return create(new ExistingModuleProvider(M));
388}
389
Misha Brukman4afac182003-10-10 17:45:12 +0000390/// getPointerToGlobal - This returns the address of the specified global
391/// value. This may involve code generation if it's a function.
392///
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000393void *ExecutionEngine::getPointerToGlobal(const GlobalValue *GV) {
Brian Gaeke37df4602003-08-13 18:16:14 +0000394 if (Function *F = const_cast<Function*>(dyn_cast<Function>(GV)))
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000395 return getPointerToFunction(F);
396
Reid Spenceree448632005-07-12 15:51:55 +0000397 MutexGuard locked(lock);
Jeff Cohen68835dd2006-02-07 05:11:57 +0000398 void *p = state.getGlobalAddressMap(locked)[GV];
399 if (p)
400 return p;
401
402 // Global variable might have been added since interpreter started.
403 if (GlobalVariable *GVar =
404 const_cast<GlobalVariable *>(dyn_cast<GlobalVariable>(GV)))
405 EmitGlobalVariable(GVar);
406 else
Chris Lattner64f150f2007-02-14 06:20:04 +0000407 assert(0 && "Global hasn't had an address allocated yet!");
Reid Spenceree448632005-07-12 15:51:55 +0000408 return state.getGlobalAddressMap(locked)[GV];
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000409}
410
Reid Spencer3da59db2006-11-27 01:05:10 +0000411/// This function converts a Constant* into a GenericValue. The interesting
412/// part is if C is a ConstantExpr.
Reid Spencerba28cb92007-08-11 15:57:56 +0000413/// @brief Get a GenericValue for a Constant*
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000414GenericValue ExecutionEngine::getConstantValue(const Constant *C) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000415 // If its undefined, return the garbage.
Reid Spencerbce30f12007-03-06 22:23:15 +0000416 if (isa<UndefValue>(C))
417 return GenericValue();
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000418
Reid Spencer3da59db2006-11-27 01:05:10 +0000419 // If the value is a ConstantExpr
420 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Reid Spencerbce30f12007-03-06 22:23:15 +0000421 Constant *Op0 = CE->getOperand(0);
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000422 switch (CE->getOpcode()) {
423 case Instruction::GetElementPtr: {
Reid Spencer3da59db2006-11-27 01:05:10 +0000424 // Compute the index
Reid Spencerbce30f12007-03-06 22:23:15 +0000425 GenericValue Result = getConstantValue(Op0);
Chris Lattner829621c2007-02-10 20:35:22 +0000426 SmallVector<Value*, 8> Indices(CE->op_begin()+1, CE->op_end());
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000427 uint64_t Offset =
Reid Spencerbce30f12007-03-06 22:23:15 +0000428 TD->getIndexedOffset(Op0->getType(), &Indices[0], Indices.size());
Misha Brukmanedf128a2005-04-21 22:36:52 +0000429
Reid Spencer8fb0f192007-03-06 03:04:04 +0000430 char* tmp = (char*) Result.PointerVal;
431 Result = PTOGV(tmp + Offset);
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000432 return Result;
433 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000434 case Instruction::Trunc: {
435 GenericValue GV = getConstantValue(Op0);
436 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
437 GV.IntVal = GV.IntVal.trunc(BitWidth);
438 return GV;
439 }
440 case Instruction::ZExt: {
441 GenericValue GV = getConstantValue(Op0);
442 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
443 GV.IntVal = GV.IntVal.zext(BitWidth);
444 return GV;
445 }
446 case Instruction::SExt: {
447 GenericValue GV = getConstantValue(Op0);
448 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
449 GV.IntVal = GV.IntVal.sext(BitWidth);
450 return GV;
451 }
452 case Instruction::FPTrunc: {
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000453 // FIXME long double
Reid Spencerbce30f12007-03-06 22:23:15 +0000454 GenericValue GV = getConstantValue(Op0);
455 GV.FloatVal = float(GV.DoubleVal);
456 return GV;
457 }
458 case Instruction::FPExt:{
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000459 // FIXME long double
Reid Spencerbce30f12007-03-06 22:23:15 +0000460 GenericValue GV = getConstantValue(Op0);
461 GV.DoubleVal = double(GV.FloatVal);
462 return GV;
463 }
464 case Instruction::UIToFP: {
465 GenericValue GV = getConstantValue(Op0);
466 if (CE->getType() == Type::FloatTy)
467 GV.FloatVal = float(GV.IntVal.roundToDouble());
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000468 else if (CE->getType() == Type::DoubleTy)
Reid Spencerbce30f12007-03-06 22:23:15 +0000469 GV.DoubleVal = GV.IntVal.roundToDouble();
Dale Johannesen910993e2007-09-21 22:09:37 +0000470 else if (CE->getType() == Type::X86_FP80Ty) {
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000471 const uint64_t zero[] = {0, 0};
472 APFloat apf = APFloat(APInt(80, 2, zero));
Dan Gohman62824062008-02-29 01:27:13 +0000473 (void)apf.convertFromAPInt(GV.IntVal,
474 false,
475 APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000476 GV.IntVal = apf.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000477 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000478 return GV;
479 }
480 case Instruction::SIToFP: {
481 GenericValue GV = getConstantValue(Op0);
482 if (CE->getType() == Type::FloatTy)
483 GV.FloatVal = float(GV.IntVal.signedRoundToDouble());
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000484 else if (CE->getType() == Type::DoubleTy)
Reid Spencerbce30f12007-03-06 22:23:15 +0000485 GV.DoubleVal = GV.IntVal.signedRoundToDouble();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000486 else if (CE->getType() == Type::X86_FP80Ty) {
487 const uint64_t zero[] = { 0, 0};
488 APFloat apf = APFloat(APInt(80, 2, zero));
Dan Gohman62824062008-02-29 01:27:13 +0000489 (void)apf.convertFromAPInt(GV.IntVal,
490 true,
491 APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000492 GV.IntVal = apf.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000493 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000494 return GV;
495 }
496 case Instruction::FPToUI: // double->APInt conversion handles sign
497 case Instruction::FPToSI: {
498 GenericValue GV = getConstantValue(Op0);
499 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
500 if (Op0->getType() == Type::FloatTy)
501 GV.IntVal = APIntOps::RoundFloatToAPInt(GV.FloatVal, BitWidth);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000502 else if (Op0->getType() == Type::DoubleTy)
Reid Spencerbce30f12007-03-06 22:23:15 +0000503 GV.IntVal = APIntOps::RoundDoubleToAPInt(GV.DoubleVal, BitWidth);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000504 else if (Op0->getType() == Type::X86_FP80Ty) {
505 APFloat apf = APFloat(GV.IntVal);
506 uint64_t v;
Dale Johannesen23a98552008-10-09 23:00:39 +0000507 bool ignored;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000508 (void)apf.convertToInteger(&v, BitWidth,
509 CE->getOpcode()==Instruction::FPToSI,
Dale Johannesen23a98552008-10-09 23:00:39 +0000510 APFloat::rmTowardZero, &ignored);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000511 GV.IntVal = v; // endian?
512 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000513 return GV;
514 }
Reid Spencer3da59db2006-11-27 01:05:10 +0000515 case Instruction::PtrToInt: {
Reid Spencerbce30f12007-03-06 22:23:15 +0000516 GenericValue GV = getConstantValue(Op0);
517 uint32_t PtrWidth = TD->getPointerSizeInBits();
518 GV.IntVal = APInt(PtrWidth, uintptr_t(GV.PointerVal));
519 return GV;
520 }
521 case Instruction::IntToPtr: {
522 GenericValue GV = getConstantValue(Op0);
523 uint32_t PtrWidth = TD->getPointerSizeInBits();
524 if (PtrWidth != GV.IntVal.getBitWidth())
525 GV.IntVal = GV.IntVal.zextOrTrunc(PtrWidth);
526 assert(GV.IntVal.getBitWidth() <= 64 && "Bad pointer width");
527 GV.PointerVal = PointerTy(uintptr_t(GV.IntVal.getZExtValue()));
Reid Spencer3da59db2006-11-27 01:05:10 +0000528 return GV;
529 }
530 case Instruction::BitCast: {
Reid Spencerbce30f12007-03-06 22:23:15 +0000531 GenericValue GV = getConstantValue(Op0);
532 const Type* DestTy = CE->getType();
533 switch (Op0->getType()->getTypeID()) {
534 default: assert(0 && "Invalid bitcast operand");
535 case Type::IntegerTyID:
536 assert(DestTy->isFloatingPoint() && "invalid bitcast");
537 if (DestTy == Type::FloatTy)
538 GV.FloatVal = GV.IntVal.bitsToFloat();
539 else if (DestTy == Type::DoubleTy)
540 GV.DoubleVal = GV.IntVal.bitsToDouble();
541 break;
542 case Type::FloatTyID:
543 assert(DestTy == Type::Int32Ty && "Invalid bitcast");
544 GV.IntVal.floatToBits(GV.FloatVal);
545 break;
546 case Type::DoubleTyID:
547 assert(DestTy == Type::Int64Ty && "Invalid bitcast");
548 GV.IntVal.doubleToBits(GV.DoubleVal);
549 break;
550 case Type::PointerTyID:
551 assert(isa<PointerType>(DestTy) && "Invalid bitcast");
552 break; // getConstantValue(Op0) above already converted it
553 }
554 return GV;
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000555 }
Chris Lattner9a231222003-05-14 17:51:49 +0000556 case Instruction::Add:
Reid Spencerbce30f12007-03-06 22:23:15 +0000557 case Instruction::Sub:
558 case Instruction::Mul:
559 case Instruction::UDiv:
560 case Instruction::SDiv:
561 case Instruction::URem:
562 case Instruction::SRem:
563 case Instruction::And:
564 case Instruction::Or:
565 case Instruction::Xor: {
566 GenericValue LHS = getConstantValue(Op0);
567 GenericValue RHS = getConstantValue(CE->getOperand(1));
568 GenericValue GV;
Chris Lattner5f90cb82004-07-11 08:01:11 +0000569 switch (CE->getOperand(0)->getType()->getTypeID()) {
570 default: assert(0 && "Bad add type!"); abort();
Reid Spencera54b7cb2007-01-12 07:05:14 +0000571 case Type::IntegerTyID:
Reid Spencerbce30f12007-03-06 22:23:15 +0000572 switch (CE->getOpcode()) {
573 default: assert(0 && "Invalid integer opcode");
574 case Instruction::Add: GV.IntVal = LHS.IntVal + RHS.IntVal; break;
575 case Instruction::Sub: GV.IntVal = LHS.IntVal - RHS.IntVal; break;
576 case Instruction::Mul: GV.IntVal = LHS.IntVal * RHS.IntVal; break;
577 case Instruction::UDiv:GV.IntVal = LHS.IntVal.udiv(RHS.IntVal); break;
578 case Instruction::SDiv:GV.IntVal = LHS.IntVal.sdiv(RHS.IntVal); break;
579 case Instruction::URem:GV.IntVal = LHS.IntVal.urem(RHS.IntVal); break;
580 case Instruction::SRem:GV.IntVal = LHS.IntVal.srem(RHS.IntVal); break;
581 case Instruction::And: GV.IntVal = LHS.IntVal & RHS.IntVal; break;
582 case Instruction::Or: GV.IntVal = LHS.IntVal | RHS.IntVal; break;
583 case Instruction::Xor: GV.IntVal = LHS.IntVal ^ RHS.IntVal; break;
584 }
Chris Lattner5f90cb82004-07-11 08:01:11 +0000585 break;
586 case Type::FloatTyID:
Reid Spencerbce30f12007-03-06 22:23:15 +0000587 switch (CE->getOpcode()) {
588 default: assert(0 && "Invalid float opcode"); abort();
589 case Instruction::Add:
590 GV.FloatVal = LHS.FloatVal + RHS.FloatVal; break;
591 case Instruction::Sub:
592 GV.FloatVal = LHS.FloatVal - RHS.FloatVal; break;
593 case Instruction::Mul:
594 GV.FloatVal = LHS.FloatVal * RHS.FloatVal; break;
595 case Instruction::FDiv:
596 GV.FloatVal = LHS.FloatVal / RHS.FloatVal; break;
597 case Instruction::FRem:
598 GV.FloatVal = ::fmodf(LHS.FloatVal,RHS.FloatVal); break;
599 }
Chris Lattner5f90cb82004-07-11 08:01:11 +0000600 break;
601 case Type::DoubleTyID:
Reid Spencerbce30f12007-03-06 22:23:15 +0000602 switch (CE->getOpcode()) {
603 default: assert(0 && "Invalid double opcode"); abort();
604 case Instruction::Add:
605 GV.DoubleVal = LHS.DoubleVal + RHS.DoubleVal; break;
606 case Instruction::Sub:
607 GV.DoubleVal = LHS.DoubleVal - RHS.DoubleVal; break;
608 case Instruction::Mul:
609 GV.DoubleVal = LHS.DoubleVal * RHS.DoubleVal; break;
610 case Instruction::FDiv:
611 GV.DoubleVal = LHS.DoubleVal / RHS.DoubleVal; break;
612 case Instruction::FRem:
613 GV.DoubleVal = ::fmod(LHS.DoubleVal,RHS.DoubleVal); break;
614 }
Chris Lattner5f90cb82004-07-11 08:01:11 +0000615 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000616 case Type::X86_FP80TyID:
617 case Type::PPC_FP128TyID:
618 case Type::FP128TyID: {
619 APFloat apfLHS = APFloat(LHS.IntVal);
620 switch (CE->getOpcode()) {
621 default: assert(0 && "Invalid long double opcode"); abort();
622 case Instruction::Add:
623 apfLHS.add(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000624 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000625 break;
626 case Instruction::Sub:
627 apfLHS.subtract(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000628 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000629 break;
630 case Instruction::Mul:
631 apfLHS.multiply(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000632 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000633 break;
634 case Instruction::FDiv:
635 apfLHS.divide(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000636 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000637 break;
638 case Instruction::FRem:
639 apfLHS.mod(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000640 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000641 break;
642 }
643 }
644 break;
Chris Lattner5f90cb82004-07-11 08:01:11 +0000645 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000646 return GV;
647 }
Chris Lattner9a231222003-05-14 17:51:49 +0000648 default:
649 break;
650 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000651 cerr << "ConstantExpr not handled: " << *CE << "\n";
Chris Lattner9a231222003-05-14 17:51:49 +0000652 abort();
653 }
Misha Brukmanedf128a2005-04-21 22:36:52 +0000654
Reid Spencerbce30f12007-03-06 22:23:15 +0000655 GenericValue Result;
Chris Lattnerf70c22b2004-06-17 18:19:28 +0000656 switch (C->getType()->getTypeID()) {
Reid Spencer8fb0f192007-03-06 03:04:04 +0000657 case Type::FloatTyID:
Dale Johannesen43421b32007-09-06 18:13:44 +0000658 Result.FloatVal = cast<ConstantFP>(C)->getValueAPF().convertToFloat();
Reid Spencera54b7cb2007-01-12 07:05:14 +0000659 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000660 case Type::DoubleTyID:
Dale Johannesen43421b32007-09-06 18:13:44 +0000661 Result.DoubleVal = cast<ConstantFP>(C)->getValueAPF().convertToDouble();
Reid Spencer8fb0f192007-03-06 03:04:04 +0000662 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000663 case Type::X86_FP80TyID:
664 case Type::FP128TyID:
665 case Type::PPC_FP128TyID:
Dale Johannesen7111b022008-10-09 18:53:47 +0000666 Result.IntVal = cast <ConstantFP>(C)->getValueAPF().bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000667 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000668 case Type::IntegerTyID:
669 Result.IntVal = cast<ConstantInt>(C)->getValue();
670 break;
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000671 case Type::PointerTyID:
Reid Spencer40cf2f92004-07-18 00:41:27 +0000672 if (isa<ConstantPointerNull>(C))
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000673 Result.PointerVal = 0;
Reid Spencer40cf2f92004-07-18 00:41:27 +0000674 else if (const Function *F = dyn_cast<Function>(C))
675 Result = PTOGV(getPointerToFunctionOrStub(const_cast<Function*>(F)));
676 else if (const GlobalVariable* GV = dyn_cast<GlobalVariable>(C))
677 Result = PTOGV(getOrEmitGlobalVariable(const_cast<GlobalVariable*>(GV)));
678 else
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000679 assert(0 && "Unknown constant pointer type!");
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000680 break;
681 default:
Reid Spencerbce30f12007-03-06 22:23:15 +0000682 cerr << "ERROR: Constant unimplemented for type: " << *C->getType() << "\n";
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000683 abort();
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000684 }
685 return Result;
686}
687
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000688/// StoreIntToMemory - Fills the StoreBytes bytes of memory starting from Dst
689/// with the integer held in IntVal.
690static void StoreIntToMemory(const APInt &IntVal, uint8_t *Dst,
691 unsigned StoreBytes) {
692 assert((IntVal.getBitWidth()+7)/8 >= StoreBytes && "Integer too small!");
693 uint8_t *Src = (uint8_t *)IntVal.getRawData();
694
695 if (sys::littleEndianHost())
696 // Little-endian host - the source is ordered from LSB to MSB. Order the
697 // destination from LSB to MSB: Do a straight copy.
698 memcpy(Dst, Src, StoreBytes);
699 else {
700 // Big-endian host - the source is an array of 64 bit words ordered from
701 // LSW to MSW. Each word is ordered from MSB to LSB. Order the destination
702 // from MSB to LSB: Reverse the word order, but not the bytes in a word.
703 while (StoreBytes > sizeof(uint64_t)) {
704 StoreBytes -= sizeof(uint64_t);
705 // May not be aligned so use memcpy.
706 memcpy(Dst + StoreBytes, Src, sizeof(uint64_t));
707 Src += sizeof(uint64_t);
708 }
709
710 memcpy(Dst, Src + sizeof(uint64_t) - StoreBytes, StoreBytes);
711 }
712}
713
Nate Begeman37efe672006-04-22 18:53:45 +0000714/// StoreValueToMemory - Stores the data in Val of type Ty at address Ptr. Ptr
715/// is the address of the memory at which to store Val, cast to GenericValue *.
716/// It is not a pointer to a GenericValue containing the address at which to
717/// store Val.
Evan Cheng89687e32008-11-04 06:10:31 +0000718void ExecutionEngine::StoreValueToMemory(const GenericValue &Val,
719 GenericValue *Ptr, const Type *Ty) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000720 const unsigned StoreBytes = getTargetData()->getTypeStoreSize(Ty);
721
Reid Spencer8fb0f192007-03-06 03:04:04 +0000722 switch (Ty->getTypeID()) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000723 case Type::IntegerTyID:
724 StoreIntToMemory(Val.IntVal, (uint8_t*)Ptr, StoreBytes);
Reid Spencer8fb0f192007-03-06 03:04:04 +0000725 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000726 case Type::FloatTyID:
727 *((float*)Ptr) = Val.FloatVal;
728 break;
729 case Type::DoubleTyID:
730 *((double*)Ptr) = Val.DoubleVal;
731 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000732 case Type::X86_FP80TyID: {
733 uint16_t *Dest = (uint16_t*)Ptr;
734 const uint16_t *Src = (uint16_t*)Val.IntVal.getRawData();
735 // This is endian dependent, but it will only work on x86 anyway.
736 Dest[0] = Src[4];
737 Dest[1] = Src[0];
738 Dest[2] = Src[1];
739 Dest[3] = Src[2];
740 Dest[4] = Src[3];
741 break;
742 }
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000743 case Type::PointerTyID:
744 // Ensure 64 bit target pointers are fully initialized on 32 bit hosts.
745 if (StoreBytes != sizeof(PointerTy))
746 memset(Ptr, 0, StoreBytes);
747
Reid Spencer8fb0f192007-03-06 03:04:04 +0000748 *((PointerTy*)Ptr) = Val.PointerVal;
749 break;
750 default:
751 cerr << "Cannot store value of type " << *Ty << "!\n";
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000752 }
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000753
754 if (sys::littleEndianHost() != getTargetData()->isLittleEndian())
755 // Host and target are different endian - reverse the stored bytes.
756 std::reverse((uint8_t*)Ptr, StoreBytes + (uint8_t*)Ptr);
757}
758
759/// LoadIntFromMemory - Loads the integer stored in the LoadBytes bytes starting
760/// from Src into IntVal, which is assumed to be wide enough and to hold zero.
761static void LoadIntFromMemory(APInt &IntVal, uint8_t *Src, unsigned LoadBytes) {
762 assert((IntVal.getBitWidth()+7)/8 >= LoadBytes && "Integer too small!");
763 uint8_t *Dst = (uint8_t *)IntVal.getRawData();
764
765 if (sys::littleEndianHost())
766 // Little-endian host - the destination must be ordered from LSB to MSB.
767 // The source is ordered from LSB to MSB: Do a straight copy.
768 memcpy(Dst, Src, LoadBytes);
769 else {
770 // Big-endian - the destination is an array of 64 bit words ordered from
771 // LSW to MSW. Each word must be ordered from MSB to LSB. The source is
772 // ordered from MSB to LSB: Reverse the word order, but not the bytes in
773 // a word.
774 while (LoadBytes > sizeof(uint64_t)) {
775 LoadBytes -= sizeof(uint64_t);
776 // May not be aligned so use memcpy.
777 memcpy(Dst, Src + LoadBytes, sizeof(uint64_t));
778 Dst += sizeof(uint64_t);
779 }
780
781 memcpy(Dst + sizeof(uint64_t) - LoadBytes, Src, LoadBytes);
782 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000783}
784
Misha Brukman4afac182003-10-10 17:45:12 +0000785/// FIXME: document
786///
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000787void ExecutionEngine::LoadValueFromMemory(GenericValue &Result,
Duncan Sands08bfe262008-03-10 16:38:37 +0000788 GenericValue *Ptr,
789 const Type *Ty) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000790 const unsigned LoadBytes = getTargetData()->getTypeStoreSize(Ty);
Duncan Sands1eff7042007-12-10 17:43:13 +0000791
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000792 if (sys::littleEndianHost() != getTargetData()->isLittleEndian()) {
793 // Host and target are different endian - reverse copy the stored
794 // bytes into a buffer, and load from that.
795 uint8_t *Src = (uint8_t*)Ptr;
796 uint8_t *Buf = (uint8_t*)alloca(LoadBytes);
797 std::reverse_copy(Src, Src + LoadBytes, Buf);
798 Ptr = (GenericValue*)Buf;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000799 }
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000800
801 switch (Ty->getTypeID()) {
802 case Type::IntegerTyID:
803 // An APInt with all words initially zero.
804 Result.IntVal = APInt(cast<IntegerType>(Ty)->getBitWidth(), 0);
805 LoadIntFromMemory(Result.IntVal, (uint8_t*)Ptr, LoadBytes);
806 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000807 case Type::FloatTyID:
808 Result.FloatVal = *((float*)Ptr);
809 break;
810 case Type::DoubleTyID:
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000811 Result.DoubleVal = *((double*)Ptr);
Reid Spencer8fb0f192007-03-06 03:04:04 +0000812 break;
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000813 case Type::PointerTyID:
Reid Spencer8fb0f192007-03-06 03:04:04 +0000814 Result.PointerVal = *((PointerTy*)Ptr);
815 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000816 case Type::X86_FP80TyID: {
817 // This is endian dependent, but it will only work on x86 anyway.
Duncan Sands9e4635a2007-12-15 17:37:40 +0000818 // FIXME: Will not trap if loading a signaling NaN.
Duncan Sandsdd65a732007-11-28 10:36:19 +0000819 uint16_t *p = (uint16_t*)Ptr;
820 union {
821 uint16_t x[8];
822 uint64_t y[2];
823 };
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000824 x[0] = p[1];
825 x[1] = p[2];
826 x[2] = p[3];
827 x[3] = p[4];
828 x[4] = p[0];
Duncan Sandsdd65a732007-11-28 10:36:19 +0000829 Result.IntVal = APInt(80, 2, y);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000830 break;
831 }
Reid Spencer8fb0f192007-03-06 03:04:04 +0000832 default:
833 cerr << "Cannot load value of type " << *Ty << "!\n";
834 abort();
Chris Lattnerf88b9a62003-05-08 16:52:16 +0000835 }
Chris Lattnerf88b9a62003-05-08 16:52:16 +0000836}
837
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000838// InitializeMemory - Recursive function to apply a Constant value into the
839// specified memory location...
840//
841void ExecutionEngine::InitializeMemory(const Constant *Init, void *Addr) {
Evan Cheng4e20c5c2008-11-05 00:22:28 +0000842 DOUT << "Initializing " << Addr << " ";
Dale Johannesendd947ea2008-08-07 01:30:15 +0000843 DEBUG(Init->dump());
Chris Lattnerbd1d3822004-10-16 18:19:26 +0000844 if (isa<UndefValue>(Init)) {
845 return;
Reid Spencer9d6565a2007-02-15 02:26:10 +0000846 } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(Init)) {
Robert Bocchino7c2b7c72006-01-20 18:18:40 +0000847 unsigned ElementSize =
Duncan Sands514ab342007-11-01 20:53:16 +0000848 getTargetData()->getABITypeSize(CP->getType()->getElementType());
Robert Bocchino7c2b7c72006-01-20 18:18:40 +0000849 for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
850 InitializeMemory(CP->getOperand(i), (char*)Addr+i*ElementSize);
851 return;
Chris Lattnerb6e1dd72008-02-15 00:57:28 +0000852 } else if (isa<ConstantAggregateZero>(Init)) {
853 memset(Addr, 0, (size_t)getTargetData()->getABITypeSize(Init->getType()));
854 return;
Dan Gohman638e3782008-05-20 03:20:09 +0000855 } else if (const ConstantArray *CPA = dyn_cast<ConstantArray>(Init)) {
856 unsigned ElementSize =
857 getTargetData()->getABITypeSize(CPA->getType()->getElementType());
858 for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
859 InitializeMemory(CPA->getOperand(i), (char*)Addr+i*ElementSize);
860 return;
861 } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(Init)) {
862 const StructLayout *SL =
863 getTargetData()->getStructLayout(cast<StructType>(CPS->getType()));
864 for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
865 InitializeMemory(CPS->getOperand(i), (char*)Addr+SL->getElementOffset(i));
866 return;
Chris Lattnerbd1d3822004-10-16 18:19:26 +0000867 } else if (Init->getType()->isFirstClassType()) {
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000868 GenericValue Val = getConstantValue(Init);
869 StoreValueToMemory(Val, (GenericValue*)Addr, Init->getType());
870 return;
871 }
872
Dan Gohman638e3782008-05-20 03:20:09 +0000873 cerr << "Bad Type: " << *Init->getType() << "\n";
874 assert(0 && "Unknown constant type to initialize memory with!");
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000875}
876
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000877/// EmitGlobals - Emit all of the global variables to memory, storing their
878/// addresses into GlobalAddress. This must make sure to copy the contents of
879/// their initializers into the memory.
880///
881void ExecutionEngine::emitGlobals() {
Misha Brukmanedf128a2005-04-21 22:36:52 +0000882
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000883 // Loop over all of the global variables in the program, allocating the memory
Chris Lattnerfe854032006-08-16 01:24:12 +0000884 // to hold them. If there is more than one module, do a prepass over globals
885 // to figure out how the different modules should link together.
886 //
887 std::map<std::pair<std::string, const Type*>,
888 const GlobalValue*> LinkedGlobalsMap;
Misha Brukmanedf128a2005-04-21 22:36:52 +0000889
Chris Lattnerfe854032006-08-16 01:24:12 +0000890 if (Modules.size() != 1) {
891 for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
892 Module &M = *Modules[m]->getModule();
893 for (Module::const_global_iterator I = M.global_begin(),
894 E = M.global_end(); I != E; ++I) {
895 const GlobalValue *GV = I;
Reid Spencer5cbf9852007-01-30 20:08:39 +0000896 if (GV->hasInternalLinkage() || GV->isDeclaration() ||
Chris Lattnerfe854032006-08-16 01:24:12 +0000897 GV->hasAppendingLinkage() || !GV->hasName())
898 continue;// Ignore external globals and globals with internal linkage.
899
900 const GlobalValue *&GVEntry =
901 LinkedGlobalsMap[std::make_pair(GV->getName(), GV->getType())];
902
903 // If this is the first time we've seen this global, it is the canonical
904 // version.
905 if (!GVEntry) {
906 GVEntry = GV;
907 continue;
908 }
909
910 // If the existing global is strong, never replace it.
Anton Korobeynikovb74ed072006-09-14 18:23:27 +0000911 if (GVEntry->hasExternalLinkage() ||
912 GVEntry->hasDLLImportLinkage() ||
913 GVEntry->hasDLLExportLinkage())
Chris Lattnerfe854032006-08-16 01:24:12 +0000914 continue;
915
916 // Otherwise, we know it's linkonce/weak, replace it if this is a strong
Dale Johannesenaafce772008-05-14 20:12:51 +0000917 // symbol. FIXME is this right for common?
Anton Korobeynikov78ee7b72006-12-01 00:25:12 +0000918 if (GV->hasExternalLinkage() || GVEntry->hasExternalWeakLinkage())
Chris Lattnerfe854032006-08-16 01:24:12 +0000919 GVEntry = GV;
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000920 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000921 }
Chris Lattnerfe854032006-08-16 01:24:12 +0000922 }
923
924 std::vector<const GlobalValue*> NonCanonicalGlobals;
925 for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
926 Module &M = *Modules[m]->getModule();
927 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
928 I != E; ++I) {
929 // In the multi-module case, see what this global maps to.
930 if (!LinkedGlobalsMap.empty()) {
931 if (const GlobalValue *GVEntry =
932 LinkedGlobalsMap[std::make_pair(I->getName(), I->getType())]) {
933 // If something else is the canonical global, ignore this one.
934 if (GVEntry != &*I) {
935 NonCanonicalGlobals.push_back(I);
936 continue;
937 }
938 }
939 }
940
Reid Spencer5cbf9852007-01-30 20:08:39 +0000941 if (!I->isDeclaration()) {
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000942 addGlobalMapping(I, getMemoryForGV(I));
Chris Lattnerfe854032006-08-16 01:24:12 +0000943 } else {
944 // External variable reference. Try to use the dynamic loader to
945 // get a pointer to it.
946 if (void *SymAddr =
947 sys::DynamicLibrary::SearchForAddressOfSymbol(I->getName().c_str()))
948 addGlobalMapping(I, SymAddr);
949 else {
Bill Wendlinge8156192006-12-07 01:30:32 +0000950 cerr << "Could not resolve external global address: "
951 << I->getName() << "\n";
Chris Lattnerfe854032006-08-16 01:24:12 +0000952 abort();
953 }
954 }
955 }
956
957 // If there are multiple modules, map the non-canonical globals to their
958 // canonical location.
959 if (!NonCanonicalGlobals.empty()) {
960 for (unsigned i = 0, e = NonCanonicalGlobals.size(); i != e; ++i) {
961 const GlobalValue *GV = NonCanonicalGlobals[i];
962 const GlobalValue *CGV =
963 LinkedGlobalsMap[std::make_pair(GV->getName(), GV->getType())];
964 void *Ptr = getPointerToGlobalIfAvailable(CGV);
965 assert(Ptr && "Canonical global wasn't codegen'd!");
Nuno Lopesc8ed9022008-10-14 10:04:52 +0000966 addGlobalMapping(GV, Ptr);
Chris Lattnerfe854032006-08-16 01:24:12 +0000967 }
968 }
969
Reid Spencera54b7cb2007-01-12 07:05:14 +0000970 // Now that all of the globals are set up in memory, loop through them all
971 // and initialize their contents.
Chris Lattnerfe854032006-08-16 01:24:12 +0000972 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
973 I != E; ++I) {
Reid Spencer5cbf9852007-01-30 20:08:39 +0000974 if (!I->isDeclaration()) {
Chris Lattnerfe854032006-08-16 01:24:12 +0000975 if (!LinkedGlobalsMap.empty()) {
976 if (const GlobalValue *GVEntry =
977 LinkedGlobalsMap[std::make_pair(I->getName(), I->getType())])
978 if (GVEntry != &*I) // Not the canonical variable.
979 continue;
980 }
981 EmitGlobalVariable(I);
982 }
983 }
984 }
Chris Lattner24b0a182003-12-20 02:45:37 +0000985}
986
987// EmitGlobalVariable - This method emits the specified global variable to the
988// address specified in GlobalAddresses, or allocates new memory if it's not
989// already in the map.
Chris Lattnerc07ed132003-12-20 03:36:47 +0000990void ExecutionEngine::EmitGlobalVariable(const GlobalVariable *GV) {
Chris Lattner55d86482003-12-31 20:21:04 +0000991 void *GA = getPointerToGlobalIfAvailable(GV);
Bill Wendling480f0932006-11-27 23:54:50 +0000992 DOUT << "Global '" << GV->getName() << "' -> " << GA << "\n";
Chris Lattner23c47242004-02-08 19:33:23 +0000993
Chris Lattner24b0a182003-12-20 02:45:37 +0000994 if (GA == 0) {
995 // If it's not already specified, allocate memory for the global.
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000996 GA = getMemoryForGV(GV);
Chris Lattner55d86482003-12-31 20:21:04 +0000997 addGlobalMapping(GV, GA);
Chris Lattner24b0a182003-12-20 02:45:37 +0000998 }
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000999
1000 // Don't initialize if it's thread local, let the client do it.
1001 if (!GV->isThreadLocal())
1002 InitializeMemory(GV->getInitializer(), GA);
1003
1004 const Type *ElTy = GV->getType()->getElementType();
1005 size_t GVSize = (size_t)getTargetData()->getABITypeSize(ElTy);
Chris Lattner813c8152005-01-08 20:13:19 +00001006 NumInitBytes += (unsigned)GVSize;
Chris Lattner24b0a182003-12-20 02:45:37 +00001007 ++NumGlobals;
Chris Lattnerbd199fb2002-12-24 00:01:05 +00001008}