blob: 7c7456562bb039f4a846e4c9743d75f64e2a4dd7 [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"
Torok Edwin7d696d82009-07-11 13:10:19 +000027#include "llvm/Support/raw_ostream.h"
Reid Spencerdf5a37e2004-11-29 14:11:29 +000028#include "llvm/System/DynamicLibrary.h"
Duncan Sands67f1c492007-12-12 23:03:45 +000029#include "llvm/System/Host.h"
Reid Spencerdf5a37e2004-11-29 14:11:29 +000030#include "llvm/Target/TargetData.h"
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +000031#include <cmath>
32#include <cstring>
Chris Lattnerc2ee9b92003-11-19 21:08:57 +000033using namespace llvm;
Chris Lattnerbd199fb2002-12-24 00:01:05 +000034
Chris Lattner36343732006-12-19 22:43:32 +000035STATISTIC(NumInitBytes, "Number of bytes of global vars initialized");
36STATISTIC(NumGlobals , "Number of global vars initialized");
Chris Lattnerbd199fb2002-12-24 00:01:05 +000037
Chris Lattner2fe4bb02006-03-22 06:07:50 +000038ExecutionEngine::EECtorFn ExecutionEngine::JITCtor = 0;
39ExecutionEngine::EECtorFn ExecutionEngine::InterpCtor = 0;
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +000040ExecutionEngine::EERegisterFn ExecutionEngine::ExceptionTableRegister = 0;
41
Chris Lattner2fe4bb02006-03-22 06:07:50 +000042
Chris Lattnerd958a5a2007-10-22 02:50:12 +000043ExecutionEngine::ExecutionEngine(ModuleProvider *P) : LazyFunctionCreator(0) {
Chris Lattner3d6e33d2006-11-09 19:31:15 +000044 LazyCompilationDisabled = false;
Evan Cheng446531e2008-09-24 16:25:55 +000045 GVCompilationDisabled = false;
Evan Cheng1b088f32008-06-17 16:49:02 +000046 SymbolSearchingDisabled = false;
Nate Begemand6b7a242009-02-18 08:31:02 +000047 DlsymStubsEnabled = false;
Chris Lattnerfe854032006-08-16 01:24:12 +000048 Modules.push_back(P);
Misha Brukman19684162003-10-16 21:18:05 +000049 assert(P && "ModuleProvider is null?");
50}
51
Brian Gaeke8e539482003-09-04 22:57:27 +000052ExecutionEngine::~ExecutionEngine() {
Reid Spencerd4c0e622007-03-03 18:19:18 +000053 clearAllGlobalMappings();
Chris Lattnerfe854032006-08-16 01:24:12 +000054 for (unsigned i = 0, e = Modules.size(); i != e; ++i)
55 delete Modules[i];
Brian Gaeke8e539482003-09-04 22:57:27 +000056}
57
Nicolas Geoffray46fa1392008-10-25 15:41:43 +000058char* ExecutionEngine::getMemoryForGV(const GlobalVariable* GV) {
59 const Type *ElTy = GV->getType()->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +000060 size_t GVSize = (size_t)getTargetData()->getTypeAllocSize(ElTy);
Nicolas Geoffray46fa1392008-10-25 15:41:43 +000061 return new char[GVSize];
62}
63
Devang Patel73d0e212007-10-15 19:56:32 +000064/// removeModuleProvider - Remove a ModuleProvider from the list of modules.
Nate Begeman60789e42009-01-23 19:27:28 +000065/// Relases the Module from the ModuleProvider, materializing it in the
66/// process, and returns the materialized Module.
Devang Patel73d0e212007-10-15 19:56:32 +000067Module* ExecutionEngine::removeModuleProvider(ModuleProvider *P,
68 std::string *ErrInfo) {
69 for(SmallVector<ModuleProvider *, 1>::iterator I = Modules.begin(),
70 E = Modules.end(); I != E; ++I) {
71 ModuleProvider *MP = *I;
72 if (MP == P) {
73 Modules.erase(I);
Nate Begemanf049e072008-05-21 16:34:48 +000074 clearGlobalMappingsFromModule(MP->getModule());
Devang Patel73d0e212007-10-15 19:56:32 +000075 return MP->releaseModule(ErrInfo);
76 }
77 }
78 return NULL;
79}
80
Nate Begeman60789e42009-01-23 19:27:28 +000081/// deleteModuleProvider - Remove a ModuleProvider from the list of modules,
82/// and deletes the ModuleProvider and owned Module. Avoids materializing
83/// the underlying module.
84void ExecutionEngine::deleteModuleProvider(ModuleProvider *P,
85 std::string *ErrInfo) {
86 for(SmallVector<ModuleProvider *, 1>::iterator I = Modules.begin(),
87 E = Modules.end(); I != E; ++I) {
88 ModuleProvider *MP = *I;
89 if (MP == P) {
90 Modules.erase(I);
91 clearGlobalMappingsFromModule(MP->getModule());
92 delete MP;
93 return;
94 }
95 }
96}
97
Chris Lattnerfe854032006-08-16 01:24:12 +000098/// FindFunctionNamed - Search all of the active modules to find the one that
99/// defines FnName. This is very slow operation and shouldn't be used for
100/// general code.
101Function *ExecutionEngine::FindFunctionNamed(const char *FnName) {
102 for (unsigned i = 0, e = Modules.size(); i != e; ++i) {
Reid Spencer688b0492007-02-05 21:19:13 +0000103 if (Function *F = Modules[i]->getModule()->getFunction(FnName))
Chris Lattnerfe854032006-08-16 01:24:12 +0000104 return F;
105 }
106 return 0;
107}
108
109
Chris Lattnere7fd5532006-05-08 22:00:52 +0000110/// addGlobalMapping - Tell the execution engine that the specified global is
111/// at the specified location. This is used internally as functions are JIT'd
112/// and as global variables are laid out in memory. It can and should also be
113/// used by clients of the EE that want to have an LLVM global overlay
114/// existing data in memory.
115void ExecutionEngine::addGlobalMapping(const GlobalValue *GV, void *Addr) {
116 MutexGuard locked(lock);
Evan Chengbc4707a2008-09-18 07:54:21 +0000117
Evan Cheng366cf292008-11-07 22:30:29 +0000118 DOUT << "JIT: Map \'" << GV->getNameStart() << "\' to [" << Addr << "]\n";
Chris Lattnere7fd5532006-05-08 22:00:52 +0000119 void *&CurVal = state.getGlobalAddressMap(locked)[GV];
120 assert((CurVal == 0 || Addr == 0) && "GlobalMapping already established!");
121 CurVal = Addr;
122
123 // If we are using the reverse mapping, add it too
124 if (!state.getGlobalAddressReverseMap(locked).empty()) {
125 const GlobalValue *&V = state.getGlobalAddressReverseMap(locked)[Addr];
126 assert((V == 0 || GV == 0) && "GlobalMapping already established!");
127 V = GV;
128 }
129}
130
131/// clearAllGlobalMappings - Clear all global mappings and start over again
132/// use in dynamic compilation scenarios when you want to move globals
133void ExecutionEngine::clearAllGlobalMappings() {
134 MutexGuard locked(lock);
135
136 state.getGlobalAddressMap(locked).clear();
137 state.getGlobalAddressReverseMap(locked).clear();
138}
139
Nate Begemanf049e072008-05-21 16:34:48 +0000140/// clearGlobalMappingsFromModule - Clear all global mappings that came from a
141/// particular module, because it has been removed from the JIT.
142void ExecutionEngine::clearGlobalMappingsFromModule(Module *M) {
143 MutexGuard locked(lock);
144
145 for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; ++FI) {
146 state.getGlobalAddressMap(locked).erase(FI);
147 state.getGlobalAddressReverseMap(locked).erase(FI);
148 }
149 for (Module::global_iterator GI = M->global_begin(), GE = M->global_end();
150 GI != GE; ++GI) {
151 state.getGlobalAddressMap(locked).erase(GI);
152 state.getGlobalAddressReverseMap(locked).erase(GI);
153 }
154}
155
Chris Lattnere7fd5532006-05-08 22:00:52 +0000156/// updateGlobalMapping - Replace an existing mapping for GV with a new
157/// address. This updates both maps as required. If "Addr" is null, the
158/// entry for the global is removed from the mappings.
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000159void *ExecutionEngine::updateGlobalMapping(const GlobalValue *GV, void *Addr) {
Chris Lattnere7fd5532006-05-08 22:00:52 +0000160 MutexGuard locked(lock);
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000161
162 std::map<const GlobalValue*, void *> &Map = state.getGlobalAddressMap(locked);
163
Chris Lattnere7fd5532006-05-08 22:00:52 +0000164 // Deleting from the mapping?
165 if (Addr == 0) {
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000166 std::map<const GlobalValue*, void *>::iterator I = Map.find(GV);
167 void *OldVal;
168 if (I == Map.end())
169 OldVal = 0;
170 else {
171 OldVal = I->second;
172 Map.erase(I);
173 }
174
Chris Lattnere7fd5532006-05-08 22:00:52 +0000175 if (!state.getGlobalAddressReverseMap(locked).empty())
176 state.getGlobalAddressReverseMap(locked).erase(Addr);
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000177 return OldVal;
Chris Lattnere7fd5532006-05-08 22:00:52 +0000178 }
179
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000180 void *&CurVal = Map[GV];
181 void *OldVal = CurVal;
182
Chris Lattnere7fd5532006-05-08 22:00:52 +0000183 if (CurVal && !state.getGlobalAddressReverseMap(locked).empty())
184 state.getGlobalAddressReverseMap(locked).erase(CurVal);
185 CurVal = Addr;
186
187 // If we are using the reverse mapping, add it too
188 if (!state.getGlobalAddressReverseMap(locked).empty()) {
189 const GlobalValue *&V = state.getGlobalAddressReverseMap(locked)[Addr];
190 assert((V == 0 || GV == 0) && "GlobalMapping already established!");
191 V = GV;
192 }
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000193 return OldVal;
Chris Lattnere7fd5532006-05-08 22:00:52 +0000194}
195
196/// getPointerToGlobalIfAvailable - This returns the address of the specified
197/// global value if it is has already been codegen'd, otherwise it returns null.
198///
199void *ExecutionEngine::getPointerToGlobalIfAvailable(const GlobalValue *GV) {
200 MutexGuard locked(lock);
201
202 std::map<const GlobalValue*, void*>::iterator I =
203 state.getGlobalAddressMap(locked).find(GV);
204 return I != state.getGlobalAddressMap(locked).end() ? I->second : 0;
205}
206
Chris Lattner55d86482003-12-31 20:21:04 +0000207/// getGlobalValueAtAddress - Return the LLVM global value object that starts
208/// at the specified address.
209///
210const GlobalValue *ExecutionEngine::getGlobalValueAtAddress(void *Addr) {
Reid Spenceree448632005-07-12 15:51:55 +0000211 MutexGuard locked(lock);
212
Chris Lattner55d86482003-12-31 20:21:04 +0000213 // If we haven't computed the reverse mapping yet, do so first.
Reid Spenceree448632005-07-12 15:51:55 +0000214 if (state.getGlobalAddressReverseMap(locked).empty()) {
Chris Lattnere7fd5532006-05-08 22:00:52 +0000215 for (std::map<const GlobalValue*, void *>::iterator
216 I = state.getGlobalAddressMap(locked).begin(),
217 E = state.getGlobalAddressMap(locked).end(); I != E; ++I)
218 state.getGlobalAddressReverseMap(locked).insert(std::make_pair(I->second,
219 I->first));
Chris Lattner55d86482003-12-31 20:21:04 +0000220 }
221
222 std::map<void *, const GlobalValue*>::iterator I =
Reid Spenceree448632005-07-12 15:51:55 +0000223 state.getGlobalAddressReverseMap(locked).find(Addr);
224 return I != state.getGlobalAddressReverseMap(locked).end() ? I->second : 0;
Chris Lattner55d86482003-12-31 20:21:04 +0000225}
Chris Lattner87f03102003-12-26 06:50:30 +0000226
227// CreateArgv - Turn a vector of strings into a nice argv style array of
228// pointers to null terminated strings.
229//
230static void *CreateArgv(ExecutionEngine *EE,
231 const std::vector<std::string> &InputArgv) {
Owen Andersona69571c2006-05-03 01:29:57 +0000232 unsigned PtrSize = EE->getTargetData()->getPointerSize();
Chris Lattner87f03102003-12-26 06:50:30 +0000233 char *Result = new char[(InputArgv.size()+1)*PtrSize];
234
Evan Chengeb5d95a2008-11-06 17:46:04 +0000235 DOUT << "JIT: ARGV = " << (void*)Result << "\n";
Christopher Lamb43ad6b32007-12-17 01:12:55 +0000236 const Type *SBytePtr = PointerType::getUnqual(Type::Int8Ty);
Chris Lattner87f03102003-12-26 06:50:30 +0000237
238 for (unsigned i = 0; i != InputArgv.size(); ++i) {
239 unsigned Size = InputArgv[i].size()+1;
240 char *Dest = new char[Size];
Evan Chengeb5d95a2008-11-06 17:46:04 +0000241 DOUT << "JIT: ARGV[" << i << "] = " << (void*)Dest << "\n";
Misha Brukmanedf128a2005-04-21 22:36:52 +0000242
Chris Lattner87f03102003-12-26 06:50:30 +0000243 std::copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
244 Dest[Size-1] = 0;
Misha Brukmanedf128a2005-04-21 22:36:52 +0000245
Chris Lattner87f03102003-12-26 06:50:30 +0000246 // Endian safe: Result[i] = (PointerTy)Dest;
247 EE->StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i*PtrSize),
248 SBytePtr);
249 }
250
251 // Null terminate it
252 EE->StoreValueToMemory(PTOGV(0),
253 (GenericValue*)(Result+InputArgv.size()*PtrSize),
254 SBytePtr);
255 return Result;
256}
257
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000258
259/// runStaticConstructorsDestructors - This method is used to execute all of
Evan Cheng18314dc2008-09-30 15:51:21 +0000260/// the static constructors or destructors for a module, depending on the
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000261/// value of isDtors.
Evan Cheng18314dc2008-09-30 15:51:21 +0000262void ExecutionEngine::runStaticConstructorsDestructors(Module *module, bool isDtors) {
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000263 const char *Name = isDtors ? "llvm.global_dtors" : "llvm.global_ctors";
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000264
Chris Lattnerfe854032006-08-16 01:24:12 +0000265 // Execute global ctors/dtors for each module in the program.
Chris Lattnerfe854032006-08-16 01:24:12 +0000266
Evan Cheng18314dc2008-09-30 15:51:21 +0000267 GlobalVariable *GV = module->getNamedGlobal(Name);
268
269 // If this global has internal linkage, or if it has a use, then it must be
270 // an old-style (llvmgcc3) static ctor with __main linked in and in use. If
271 // this is the case, don't execute any of the global ctors, __main will do
272 // it.
Rafael Espindolabb46f522009-01-15 20:18:42 +0000273 if (!GV || GV->isDeclaration() || GV->hasLocalLinkage()) return;
Evan Cheng18314dc2008-09-30 15:51:21 +0000274
275 // Should be an array of '{ int, void ()* }' structs. The first value is
276 // the init priority, which we ignore.
277 ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
278 if (!InitList) return;
279 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
280 if (ConstantStruct *CS =
281 dyn_cast<ConstantStruct>(InitList->getOperand(i))) {
282 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
283
284 Constant *FP = CS->getOperand(1);
285 if (FP->isNullValue())
286 break; // Found a null terminator, exit.
287
288 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(FP))
289 if (CE->isCast())
290 FP = CE->getOperand(0);
291 if (Function *F = dyn_cast<Function>(FP)) {
292 // Execute the ctor/dtor function!
293 runFunction(F, std::vector<GenericValue>());
294 }
295 }
296}
297
298/// runStaticConstructorsDestructors - This method is used to execute all of
299/// the static constructors or destructors for a program, depending on the
300/// value of isDtors.
301void ExecutionEngine::runStaticConstructorsDestructors(bool isDtors) {
302 // Execute global ctors/dtors for each module in the program.
303 for (unsigned m = 0, e = Modules.size(); m != e; ++m)
304 runStaticConstructorsDestructors(Modules[m]->getModule(), isDtors);
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000305}
306
Dan Gohmanb6e3d6c2008-08-26 01:38:29 +0000307#ifndef NDEBUG
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000308/// isTargetNullPtr - Return whether the target pointer stored at Loc is null.
309static bool isTargetNullPtr(ExecutionEngine *EE, void *Loc) {
310 unsigned PtrSize = EE->getTargetData()->getPointerSize();
311 for (unsigned i = 0; i < PtrSize; ++i)
312 if (*(i + (uint8_t*)Loc))
313 return false;
314 return true;
315}
Dan Gohmanb6e3d6c2008-08-26 01:38:29 +0000316#endif
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000317
Chris Lattner87f03102003-12-26 06:50:30 +0000318/// runFunctionAsMain - This is a helper function which wraps runFunction to
319/// handle the common task of starting up main with the specified argc, argv,
320/// and envp parameters.
321int ExecutionEngine::runFunctionAsMain(Function *Fn,
322 const std::vector<std::string> &argv,
323 const char * const * envp) {
324 std::vector<GenericValue> GVArgs;
325 GenericValue GVArgc;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000326 GVArgc.IntVal = APInt(32, argv.size());
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000327
328 // Check main() type
Chris Lattnerf24d0992004-08-16 01:05:35 +0000329 unsigned NumArgs = Fn->getFunctionType()->getNumParams();
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000330 const FunctionType *FTy = Fn->getFunctionType();
Christopher Lamb43ad6b32007-12-17 01:12:55 +0000331 const Type* PPInt8Ty =
332 PointerType::getUnqual(PointerType::getUnqual(Type::Int8Ty));
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000333 switch (NumArgs) {
334 case 3:
335 if (FTy->getParamType(2) != PPInt8Ty) {
Torok Edwin7d696d82009-07-11 13:10:19 +0000336 llvm_report_error("Invalid type for third argument of main() supplied");
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000337 }
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) {
Torok Edwin7d696d82009-07-11 13:10:19 +0000341 llvm_report_error("Invalid type for second argument of main() supplied");
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000342 }
Anton Korobeynikovfb450862007-06-03 19:20:49 +0000343 // FALLS THROUGH
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000344 case 1:
345 if (FTy->getParamType(0) != Type::Int32Ty) {
Torok Edwin7d696d82009-07-11 13:10:19 +0000346 llvm_report_error("Invalid type for first argument of main() supplied");
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000347 }
Anton Korobeynikovfb450862007-06-03 19:20:49 +0000348 // FALLS THROUGH
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000349 case 0:
Chris Lattner45f36832009-02-04 17:48:18 +0000350 if (!isa<IntegerType>(FTy->getReturnType()) &&
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000351 FTy->getReturnType() != Type::VoidTy) {
Torok Edwin7d696d82009-07-11 13:10:19 +0000352 llvm_report_error("Invalid return type of main() supplied");
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000353 }
354 break;
355 default:
Torok Edwin7d696d82009-07-11 13:10:19 +0000356 llvm_report_error("Invalid number of arguments of main() supplied");
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000357 }
358
Chris Lattnerf24d0992004-08-16 01:05:35 +0000359 if (NumArgs) {
360 GVArgs.push_back(GVArgc); // Arg #0 = argc.
361 if (NumArgs > 1) {
362 GVArgs.push_back(PTOGV(CreateArgv(this, argv))); // Arg #1 = argv.
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000363 assert(!isTargetNullPtr(this, GVTOP(GVArgs[1])) &&
Chris Lattnerf24d0992004-08-16 01:05:35 +0000364 "argv[0] was null after CreateArgv");
365 if (NumArgs > 2) {
366 std::vector<std::string> EnvVars;
367 for (unsigned i = 0; envp[i]; ++i)
368 EnvVars.push_back(envp[i]);
369 GVArgs.push_back(PTOGV(CreateArgv(this, EnvVars))); // Arg #2 = envp.
370 }
371 }
372 }
Reid Spencer8fb0f192007-03-06 03:04:04 +0000373 return runFunction(Fn, GVArgs).IntVal.getZExtValue();
Chris Lattner87f03102003-12-26 06:50:30 +0000374}
375
Misha Brukman19684162003-10-16 21:18:05 +0000376/// If possible, create a JIT, unless the caller specifically requests an
377/// Interpreter or there's an error. If even an Interpreter cannot be created,
Misha Brukmanedf128a2005-04-21 22:36:52 +0000378/// NULL is returned.
Misha Brukman4afac182003-10-10 17:45:12 +0000379///
Misha Brukmanedf128a2005-04-21 22:36:52 +0000380ExecutionEngine *ExecutionEngine::create(ModuleProvider *MP,
Reid Spencerd4c0e622007-03-03 18:19:18 +0000381 bool ForceInterpreter,
Evan Cheng502f20b2008-08-08 08:11:34 +0000382 std::string *ErrorStr,
Jeffrey Yasskin489393d2009-07-08 21:59:57 +0000383 CodeGenOpt::Level OptLevel,
384 bool GVsWithCode) {
Brian Gaeke82d82772003-09-03 20:34:19 +0000385 ExecutionEngine *EE = 0;
386
Nick Lewycky6456d862008-03-08 02:49:45 +0000387 // Make sure we can resolve symbols in the program as well. The zero arg
388 // to the function tells DynamicLibrary to load the program, not a library.
389 if (sys::DynamicLibrary::LoadLibraryPermanently(0, ErrorStr))
390 return 0;
391
Chris Lattner73011782003-12-28 09:44:37 +0000392 // Unless the interpreter was explicitly selected, try making a JIT.
Chris Lattner2fe4bb02006-03-22 06:07:50 +0000393 if (!ForceInterpreter && JITCtor)
Jeffrey Yasskin489393d2009-07-08 21:59:57 +0000394 EE = JITCtor(MP, ErrorStr, OptLevel, GVsWithCode);
Brian Gaeke82d82772003-09-03 20:34:19 +0000395
396 // If we can't make a JIT, make an interpreter instead.
Chris Lattner2fe4bb02006-03-22 06:07:50 +0000397 if (EE == 0 && InterpCtor)
Jeffrey Yasskin489393d2009-07-08 21:59:57 +0000398 EE = InterpCtor(MP, ErrorStr, OptLevel, GVsWithCode);
Chris Lattner73011782003-12-28 09:44:37 +0000399
Brian Gaeke82d82772003-09-03 20:34:19 +0000400 return EE;
401}
402
Chris Lattner8b5295b2007-10-21 22:57:11 +0000403ExecutionEngine *ExecutionEngine::create(Module *M) {
404 return create(new ExistingModuleProvider(M));
405}
406
Misha Brukman4afac182003-10-10 17:45:12 +0000407/// getPointerToGlobal - This returns the address of the specified global
408/// value. This may involve code generation if it's a function.
409///
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000410void *ExecutionEngine::getPointerToGlobal(const GlobalValue *GV) {
Brian Gaeke37df4602003-08-13 18:16:14 +0000411 if (Function *F = const_cast<Function*>(dyn_cast<Function>(GV)))
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000412 return getPointerToFunction(F);
413
Reid Spenceree448632005-07-12 15:51:55 +0000414 MutexGuard locked(lock);
Jeff Cohen68835dd2006-02-07 05:11:57 +0000415 void *p = state.getGlobalAddressMap(locked)[GV];
416 if (p)
417 return p;
418
419 // Global variable might have been added since interpreter started.
420 if (GlobalVariable *GVar =
421 const_cast<GlobalVariable *>(dyn_cast<GlobalVariable>(GV)))
422 EmitGlobalVariable(GVar);
423 else
Chris Lattner64f150f2007-02-14 06:20:04 +0000424 assert(0 && "Global hasn't had an address allocated yet!");
Reid Spenceree448632005-07-12 15:51:55 +0000425 return state.getGlobalAddressMap(locked)[GV];
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000426}
427
Reid Spencer3da59db2006-11-27 01:05:10 +0000428/// This function converts a Constant* into a GenericValue. The interesting
429/// part is if C is a ConstantExpr.
Reid Spencerba28cb92007-08-11 15:57:56 +0000430/// @brief Get a GenericValue for a Constant*
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000431GenericValue ExecutionEngine::getConstantValue(const Constant *C) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000432 // If its undefined, return the garbage.
Reid Spencerbce30f12007-03-06 22:23:15 +0000433 if (isa<UndefValue>(C))
434 return GenericValue();
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000435
Reid Spencer3da59db2006-11-27 01:05:10 +0000436 // If the value is a ConstantExpr
437 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Reid Spencerbce30f12007-03-06 22:23:15 +0000438 Constant *Op0 = CE->getOperand(0);
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000439 switch (CE->getOpcode()) {
440 case Instruction::GetElementPtr: {
Reid Spencer3da59db2006-11-27 01:05:10 +0000441 // Compute the index
Reid Spencerbce30f12007-03-06 22:23:15 +0000442 GenericValue Result = getConstantValue(Op0);
Chris Lattner829621c2007-02-10 20:35:22 +0000443 SmallVector<Value*, 8> Indices(CE->op_begin()+1, CE->op_end());
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000444 uint64_t Offset =
Reid Spencerbce30f12007-03-06 22:23:15 +0000445 TD->getIndexedOffset(Op0->getType(), &Indices[0], Indices.size());
Misha Brukmanedf128a2005-04-21 22:36:52 +0000446
Reid Spencer8fb0f192007-03-06 03:04:04 +0000447 char* tmp = (char*) Result.PointerVal;
448 Result = PTOGV(tmp + Offset);
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000449 return Result;
450 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000451 case Instruction::Trunc: {
452 GenericValue GV = getConstantValue(Op0);
453 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
454 GV.IntVal = GV.IntVal.trunc(BitWidth);
455 return GV;
456 }
457 case Instruction::ZExt: {
458 GenericValue GV = getConstantValue(Op0);
459 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
460 GV.IntVal = GV.IntVal.zext(BitWidth);
461 return GV;
462 }
463 case Instruction::SExt: {
464 GenericValue GV = getConstantValue(Op0);
465 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
466 GV.IntVal = GV.IntVal.sext(BitWidth);
467 return GV;
468 }
469 case Instruction::FPTrunc: {
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000470 // FIXME long double
Reid Spencerbce30f12007-03-06 22:23:15 +0000471 GenericValue GV = getConstantValue(Op0);
472 GV.FloatVal = float(GV.DoubleVal);
473 return GV;
474 }
475 case Instruction::FPExt:{
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000476 // FIXME long double
Reid Spencerbce30f12007-03-06 22:23:15 +0000477 GenericValue GV = getConstantValue(Op0);
478 GV.DoubleVal = double(GV.FloatVal);
479 return GV;
480 }
481 case Instruction::UIToFP: {
482 GenericValue GV = getConstantValue(Op0);
483 if (CE->getType() == Type::FloatTy)
484 GV.FloatVal = float(GV.IntVal.roundToDouble());
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000485 else if (CE->getType() == Type::DoubleTy)
Reid Spencerbce30f12007-03-06 22:23:15 +0000486 GV.DoubleVal = GV.IntVal.roundToDouble();
Dale Johannesen910993e2007-09-21 22:09:37 +0000487 else if (CE->getType() == Type::X86_FP80Ty) {
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000488 const uint64_t zero[] = {0, 0};
489 APFloat apf = APFloat(APInt(80, 2, zero));
Dan Gohman62824062008-02-29 01:27:13 +0000490 (void)apf.convertFromAPInt(GV.IntVal,
491 false,
492 APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000493 GV.IntVal = apf.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000494 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000495 return GV;
496 }
497 case Instruction::SIToFP: {
498 GenericValue GV = getConstantValue(Op0);
499 if (CE->getType() == Type::FloatTy)
500 GV.FloatVal = float(GV.IntVal.signedRoundToDouble());
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000501 else if (CE->getType() == Type::DoubleTy)
Reid Spencerbce30f12007-03-06 22:23:15 +0000502 GV.DoubleVal = GV.IntVal.signedRoundToDouble();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000503 else if (CE->getType() == Type::X86_FP80Ty) {
504 const uint64_t zero[] = { 0, 0};
505 APFloat apf = APFloat(APInt(80, 2, zero));
Dan Gohman62824062008-02-29 01:27:13 +0000506 (void)apf.convertFromAPInt(GV.IntVal,
507 true,
508 APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000509 GV.IntVal = apf.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000510 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000511 return GV;
512 }
513 case Instruction::FPToUI: // double->APInt conversion handles sign
514 case Instruction::FPToSI: {
515 GenericValue GV = getConstantValue(Op0);
516 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
517 if (Op0->getType() == Type::FloatTy)
518 GV.IntVal = APIntOps::RoundFloatToAPInt(GV.FloatVal, BitWidth);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000519 else if (Op0->getType() == Type::DoubleTy)
Reid Spencerbce30f12007-03-06 22:23:15 +0000520 GV.IntVal = APIntOps::RoundDoubleToAPInt(GV.DoubleVal, BitWidth);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000521 else if (Op0->getType() == Type::X86_FP80Ty) {
522 APFloat apf = APFloat(GV.IntVal);
523 uint64_t v;
Dale Johannesen23a98552008-10-09 23:00:39 +0000524 bool ignored;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000525 (void)apf.convertToInteger(&v, BitWidth,
526 CE->getOpcode()==Instruction::FPToSI,
Dale Johannesen23a98552008-10-09 23:00:39 +0000527 APFloat::rmTowardZero, &ignored);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000528 GV.IntVal = v; // endian?
529 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000530 return GV;
531 }
Reid Spencer3da59db2006-11-27 01:05:10 +0000532 case Instruction::PtrToInt: {
Reid Spencerbce30f12007-03-06 22:23:15 +0000533 GenericValue GV = getConstantValue(Op0);
534 uint32_t PtrWidth = TD->getPointerSizeInBits();
535 GV.IntVal = APInt(PtrWidth, uintptr_t(GV.PointerVal));
536 return GV;
537 }
538 case Instruction::IntToPtr: {
539 GenericValue GV = getConstantValue(Op0);
540 uint32_t PtrWidth = TD->getPointerSizeInBits();
541 if (PtrWidth != GV.IntVal.getBitWidth())
542 GV.IntVal = GV.IntVal.zextOrTrunc(PtrWidth);
543 assert(GV.IntVal.getBitWidth() <= 64 && "Bad pointer width");
544 GV.PointerVal = PointerTy(uintptr_t(GV.IntVal.getZExtValue()));
Reid Spencer3da59db2006-11-27 01:05:10 +0000545 return GV;
546 }
547 case Instruction::BitCast: {
Reid Spencerbce30f12007-03-06 22:23:15 +0000548 GenericValue GV = getConstantValue(Op0);
549 const Type* DestTy = CE->getType();
550 switch (Op0->getType()->getTypeID()) {
551 default: assert(0 && "Invalid bitcast operand");
552 case Type::IntegerTyID:
553 assert(DestTy->isFloatingPoint() && "invalid bitcast");
554 if (DestTy == Type::FloatTy)
555 GV.FloatVal = GV.IntVal.bitsToFloat();
556 else if (DestTy == Type::DoubleTy)
557 GV.DoubleVal = GV.IntVal.bitsToDouble();
558 break;
559 case Type::FloatTyID:
560 assert(DestTy == Type::Int32Ty && "Invalid bitcast");
561 GV.IntVal.floatToBits(GV.FloatVal);
562 break;
563 case Type::DoubleTyID:
564 assert(DestTy == Type::Int64Ty && "Invalid bitcast");
565 GV.IntVal.doubleToBits(GV.DoubleVal);
566 break;
567 case Type::PointerTyID:
568 assert(isa<PointerType>(DestTy) && "Invalid bitcast");
569 break; // getConstantValue(Op0) above already converted it
570 }
571 return GV;
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000572 }
Chris Lattner9a231222003-05-14 17:51:49 +0000573 case Instruction::Add:
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000574 case Instruction::FAdd:
Reid Spencerbce30f12007-03-06 22:23:15 +0000575 case Instruction::Sub:
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000576 case Instruction::FSub:
Reid Spencerbce30f12007-03-06 22:23:15 +0000577 case Instruction::Mul:
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000578 case Instruction::FMul:
Reid Spencerbce30f12007-03-06 22:23:15 +0000579 case Instruction::UDiv:
580 case Instruction::SDiv:
581 case Instruction::URem:
582 case Instruction::SRem:
583 case Instruction::And:
584 case Instruction::Or:
585 case Instruction::Xor: {
586 GenericValue LHS = getConstantValue(Op0);
587 GenericValue RHS = getConstantValue(CE->getOperand(1));
588 GenericValue GV;
Chris Lattner5f90cb82004-07-11 08:01:11 +0000589 switch (CE->getOperand(0)->getType()->getTypeID()) {
Torok Edwin7d696d82009-07-11 13:10:19 +0000590 default: LLVM_UNREACHABLE("Bad add type!");
Reid Spencera54b7cb2007-01-12 07:05:14 +0000591 case Type::IntegerTyID:
Reid Spencerbce30f12007-03-06 22:23:15 +0000592 switch (CE->getOpcode()) {
593 default: assert(0 && "Invalid integer opcode");
594 case Instruction::Add: GV.IntVal = LHS.IntVal + RHS.IntVal; break;
595 case Instruction::Sub: GV.IntVal = LHS.IntVal - RHS.IntVal; break;
596 case Instruction::Mul: GV.IntVal = LHS.IntVal * RHS.IntVal; break;
597 case Instruction::UDiv:GV.IntVal = LHS.IntVal.udiv(RHS.IntVal); break;
598 case Instruction::SDiv:GV.IntVal = LHS.IntVal.sdiv(RHS.IntVal); break;
599 case Instruction::URem:GV.IntVal = LHS.IntVal.urem(RHS.IntVal); break;
600 case Instruction::SRem:GV.IntVal = LHS.IntVal.srem(RHS.IntVal); break;
601 case Instruction::And: GV.IntVal = LHS.IntVal & RHS.IntVal; break;
602 case Instruction::Or: GV.IntVal = LHS.IntVal | RHS.IntVal; break;
603 case Instruction::Xor: GV.IntVal = LHS.IntVal ^ RHS.IntVal; break;
604 }
Chris Lattner5f90cb82004-07-11 08:01:11 +0000605 break;
606 case Type::FloatTyID:
Reid Spencerbce30f12007-03-06 22:23:15 +0000607 switch (CE->getOpcode()) {
Torok Edwin7d696d82009-07-11 13:10:19 +0000608 default: LLVM_UNREACHABLE("Invalid float opcode");
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000609 case Instruction::FAdd:
Reid Spencerbce30f12007-03-06 22:23:15 +0000610 GV.FloatVal = LHS.FloatVal + RHS.FloatVal; break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000611 case Instruction::FSub:
Reid Spencerbce30f12007-03-06 22:23:15 +0000612 GV.FloatVal = LHS.FloatVal - RHS.FloatVal; break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000613 case Instruction::FMul:
Reid Spencerbce30f12007-03-06 22:23:15 +0000614 GV.FloatVal = LHS.FloatVal * RHS.FloatVal; break;
615 case Instruction::FDiv:
616 GV.FloatVal = LHS.FloatVal / RHS.FloatVal; break;
617 case Instruction::FRem:
618 GV.FloatVal = ::fmodf(LHS.FloatVal,RHS.FloatVal); break;
619 }
Chris Lattner5f90cb82004-07-11 08:01:11 +0000620 break;
621 case Type::DoubleTyID:
Reid Spencerbce30f12007-03-06 22:23:15 +0000622 switch (CE->getOpcode()) {
Torok Edwin7d696d82009-07-11 13:10:19 +0000623 default: LLVM_UNREACHABLE("Invalid double opcode");
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000624 case Instruction::FAdd:
Reid Spencerbce30f12007-03-06 22:23:15 +0000625 GV.DoubleVal = LHS.DoubleVal + RHS.DoubleVal; break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000626 case Instruction::FSub:
Reid Spencerbce30f12007-03-06 22:23:15 +0000627 GV.DoubleVal = LHS.DoubleVal - RHS.DoubleVal; break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000628 case Instruction::FMul:
Reid Spencerbce30f12007-03-06 22:23:15 +0000629 GV.DoubleVal = LHS.DoubleVal * RHS.DoubleVal; break;
630 case Instruction::FDiv:
631 GV.DoubleVal = LHS.DoubleVal / RHS.DoubleVal; break;
632 case Instruction::FRem:
633 GV.DoubleVal = ::fmod(LHS.DoubleVal,RHS.DoubleVal); break;
634 }
Chris Lattner5f90cb82004-07-11 08:01:11 +0000635 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000636 case Type::X86_FP80TyID:
637 case Type::PPC_FP128TyID:
638 case Type::FP128TyID: {
639 APFloat apfLHS = APFloat(LHS.IntVal);
640 switch (CE->getOpcode()) {
Torok Edwin31e24662009-07-07 17:32:34 +0000641 default: assert(0 && "Invalid long double opcode");llvm_unreachable();
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000642 case Instruction::FAdd:
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000643 apfLHS.add(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000644 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000645 break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000646 case Instruction::FSub:
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000647 apfLHS.subtract(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000648 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000649 break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000650 case Instruction::FMul:
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000651 apfLHS.multiply(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000652 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000653 break;
654 case Instruction::FDiv:
655 apfLHS.divide(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000656 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000657 break;
658 case Instruction::FRem:
659 apfLHS.mod(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000660 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000661 break;
662 }
663 }
664 break;
Chris Lattner5f90cb82004-07-11 08:01:11 +0000665 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000666 return GV;
667 }
Chris Lattner9a231222003-05-14 17:51:49 +0000668 default:
669 break;
670 }
Torok Edwin7d696d82009-07-11 13:10:19 +0000671 std::string msg;
672 raw_string_ostream Msg(msg);
673 Msg << "ConstantExpr not handled: " << *CE;
674 llvm_report_error(Msg.str());
Chris Lattner9a231222003-05-14 17:51:49 +0000675 }
Misha Brukmanedf128a2005-04-21 22:36:52 +0000676
Reid Spencerbce30f12007-03-06 22:23:15 +0000677 GenericValue Result;
Chris Lattnerf70c22b2004-06-17 18:19:28 +0000678 switch (C->getType()->getTypeID()) {
Reid Spencer8fb0f192007-03-06 03:04:04 +0000679 case Type::FloatTyID:
Dale Johannesen43421b32007-09-06 18:13:44 +0000680 Result.FloatVal = cast<ConstantFP>(C)->getValueAPF().convertToFloat();
Reid Spencera54b7cb2007-01-12 07:05:14 +0000681 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000682 case Type::DoubleTyID:
Dale Johannesen43421b32007-09-06 18:13:44 +0000683 Result.DoubleVal = cast<ConstantFP>(C)->getValueAPF().convertToDouble();
Reid Spencer8fb0f192007-03-06 03:04:04 +0000684 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000685 case Type::X86_FP80TyID:
686 case Type::FP128TyID:
687 case Type::PPC_FP128TyID:
Dale Johannesen7111b022008-10-09 18:53:47 +0000688 Result.IntVal = cast <ConstantFP>(C)->getValueAPF().bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000689 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000690 case Type::IntegerTyID:
691 Result.IntVal = cast<ConstantInt>(C)->getValue();
692 break;
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000693 case Type::PointerTyID:
Reid Spencer40cf2f92004-07-18 00:41:27 +0000694 if (isa<ConstantPointerNull>(C))
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000695 Result.PointerVal = 0;
Reid Spencer40cf2f92004-07-18 00:41:27 +0000696 else if (const Function *F = dyn_cast<Function>(C))
697 Result = PTOGV(getPointerToFunctionOrStub(const_cast<Function*>(F)));
698 else if (const GlobalVariable* GV = dyn_cast<GlobalVariable>(C))
699 Result = PTOGV(getOrEmitGlobalVariable(const_cast<GlobalVariable*>(GV)));
700 else
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000701 assert(0 && "Unknown constant pointer type!");
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000702 break;
703 default:
Torok Edwin7d696d82009-07-11 13:10:19 +0000704 std::string msg;
705 raw_string_ostream Msg(msg);
706 Msg << "ERROR: Constant unimplemented for type: " << *C->getType();
707 llvm_report_error(Msg.str());
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000708 }
709 return Result;
710}
711
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000712/// StoreIntToMemory - Fills the StoreBytes bytes of memory starting from Dst
713/// with the integer held in IntVal.
714static void StoreIntToMemory(const APInt &IntVal, uint8_t *Dst,
715 unsigned StoreBytes) {
716 assert((IntVal.getBitWidth()+7)/8 >= StoreBytes && "Integer too small!");
717 uint8_t *Src = (uint8_t *)IntVal.getRawData();
718
Chris Lattnerb67c9582009-01-22 19:53:00 +0000719 if (sys::isLittleEndianHost())
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000720 // Little-endian host - the source is ordered from LSB to MSB. Order the
721 // destination from LSB to MSB: Do a straight copy.
722 memcpy(Dst, Src, StoreBytes);
723 else {
724 // Big-endian host - the source is an array of 64 bit words ordered from
725 // LSW to MSW. Each word is ordered from MSB to LSB. Order the destination
726 // from MSB to LSB: Reverse the word order, but not the bytes in a word.
727 while (StoreBytes > sizeof(uint64_t)) {
728 StoreBytes -= sizeof(uint64_t);
729 // May not be aligned so use memcpy.
730 memcpy(Dst + StoreBytes, Src, sizeof(uint64_t));
731 Src += sizeof(uint64_t);
732 }
733
734 memcpy(Dst, Src + sizeof(uint64_t) - StoreBytes, StoreBytes);
735 }
736}
737
Nate Begeman37efe672006-04-22 18:53:45 +0000738/// StoreValueToMemory - Stores the data in Val of type Ty at address Ptr. Ptr
739/// is the address of the memory at which to store Val, cast to GenericValue *.
740/// It is not a pointer to a GenericValue containing the address at which to
741/// store Val.
Evan Cheng89687e32008-11-04 06:10:31 +0000742void ExecutionEngine::StoreValueToMemory(const GenericValue &Val,
743 GenericValue *Ptr, const Type *Ty) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000744 const unsigned StoreBytes = getTargetData()->getTypeStoreSize(Ty);
745
Reid Spencer8fb0f192007-03-06 03:04:04 +0000746 switch (Ty->getTypeID()) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000747 case Type::IntegerTyID:
748 StoreIntToMemory(Val.IntVal, (uint8_t*)Ptr, StoreBytes);
Reid Spencer8fb0f192007-03-06 03:04:04 +0000749 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000750 case Type::FloatTyID:
751 *((float*)Ptr) = Val.FloatVal;
752 break;
753 case Type::DoubleTyID:
754 *((double*)Ptr) = Val.DoubleVal;
755 break;
Dale Johannesen1f8c5642009-03-24 18:16:17 +0000756 case Type::X86_FP80TyID:
757 memcpy(Ptr, Val.IntVal.getRawData(), 10);
758 break;
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000759 case Type::PointerTyID:
760 // Ensure 64 bit target pointers are fully initialized on 32 bit hosts.
761 if (StoreBytes != sizeof(PointerTy))
762 memset(Ptr, 0, StoreBytes);
763
Reid Spencer8fb0f192007-03-06 03:04:04 +0000764 *((PointerTy*)Ptr) = Val.PointerVal;
765 break;
766 default:
767 cerr << "Cannot store value of type " << *Ty << "!\n";
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000768 }
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000769
Chris Lattnerb67c9582009-01-22 19:53:00 +0000770 if (sys::isLittleEndianHost() != getTargetData()->isLittleEndian())
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000771 // Host and target are different endian - reverse the stored bytes.
772 std::reverse((uint8_t*)Ptr, StoreBytes + (uint8_t*)Ptr);
773}
774
775/// LoadIntFromMemory - Loads the integer stored in the LoadBytes bytes starting
776/// from Src into IntVal, which is assumed to be wide enough and to hold zero.
777static void LoadIntFromMemory(APInt &IntVal, uint8_t *Src, unsigned LoadBytes) {
778 assert((IntVal.getBitWidth()+7)/8 >= LoadBytes && "Integer too small!");
779 uint8_t *Dst = (uint8_t *)IntVal.getRawData();
780
Chris Lattnerb67c9582009-01-22 19:53:00 +0000781 if (sys::isLittleEndianHost())
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000782 // Little-endian host - the destination must be ordered from LSB to MSB.
783 // The source is ordered from LSB to MSB: Do a straight copy.
784 memcpy(Dst, Src, LoadBytes);
785 else {
786 // Big-endian - the destination is an array of 64 bit words ordered from
787 // LSW to MSW. Each word must be ordered from MSB to LSB. The source is
788 // ordered from MSB to LSB: Reverse the word order, but not the bytes in
789 // a word.
790 while (LoadBytes > sizeof(uint64_t)) {
791 LoadBytes -= sizeof(uint64_t);
792 // May not be aligned so use memcpy.
793 memcpy(Dst, Src + LoadBytes, sizeof(uint64_t));
794 Dst += sizeof(uint64_t);
795 }
796
797 memcpy(Dst + sizeof(uint64_t) - LoadBytes, Src, LoadBytes);
798 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000799}
800
Misha Brukman4afac182003-10-10 17:45:12 +0000801/// FIXME: document
802///
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000803void ExecutionEngine::LoadValueFromMemory(GenericValue &Result,
Duncan Sands08bfe262008-03-10 16:38:37 +0000804 GenericValue *Ptr,
805 const Type *Ty) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000806 const unsigned LoadBytes = getTargetData()->getTypeStoreSize(Ty);
Duncan Sands1eff7042007-12-10 17:43:13 +0000807
Chris Lattnerb67c9582009-01-22 19:53:00 +0000808 if (sys::isLittleEndianHost() != getTargetData()->isLittleEndian()) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000809 // Host and target are different endian - reverse copy the stored
810 // bytes into a buffer, and load from that.
811 uint8_t *Src = (uint8_t*)Ptr;
812 uint8_t *Buf = (uint8_t*)alloca(LoadBytes);
813 std::reverse_copy(Src, Src + LoadBytes, Buf);
814 Ptr = (GenericValue*)Buf;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000815 }
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000816
817 switch (Ty->getTypeID()) {
818 case Type::IntegerTyID:
819 // An APInt with all words initially zero.
820 Result.IntVal = APInt(cast<IntegerType>(Ty)->getBitWidth(), 0);
821 LoadIntFromMemory(Result.IntVal, (uint8_t*)Ptr, LoadBytes);
822 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000823 case Type::FloatTyID:
824 Result.FloatVal = *((float*)Ptr);
825 break;
826 case Type::DoubleTyID:
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000827 Result.DoubleVal = *((double*)Ptr);
Reid Spencer8fb0f192007-03-06 03:04:04 +0000828 break;
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000829 case Type::PointerTyID:
Reid Spencer8fb0f192007-03-06 03:04:04 +0000830 Result.PointerVal = *((PointerTy*)Ptr);
831 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000832 case Type::X86_FP80TyID: {
833 // This is endian dependent, but it will only work on x86 anyway.
Duncan Sands9e4635a2007-12-15 17:37:40 +0000834 // FIXME: Will not trap if loading a signaling NaN.
Dale Johannesen1f8c5642009-03-24 18:16:17 +0000835 uint64_t y[2];
836 memcpy(y, Ptr, 10);
Duncan Sandsdd65a732007-11-28 10:36:19 +0000837 Result.IntVal = APInt(80, 2, y);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000838 break;
839 }
Reid Spencer8fb0f192007-03-06 03:04:04 +0000840 default:
Torok Edwin7d696d82009-07-11 13:10:19 +0000841 std::string msg;
842 raw_string_ostream Msg(msg);
843 Msg << "Cannot load value of type " << *Ty << "!";
844 llvm_report_error(Msg.str());
Chris Lattnerf88b9a62003-05-08 16:52:16 +0000845 }
Chris Lattnerf88b9a62003-05-08 16:52:16 +0000846}
847
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000848// InitializeMemory - Recursive function to apply a Constant value into the
849// specified memory location...
850//
851void ExecutionEngine::InitializeMemory(const Constant *Init, void *Addr) {
Evan Chengeb5d95a2008-11-06 17:46:04 +0000852 DOUT << "JIT: Initializing " << Addr << " ";
Dale Johannesendd947ea2008-08-07 01:30:15 +0000853 DEBUG(Init->dump());
Chris Lattnerbd1d3822004-10-16 18:19:26 +0000854 if (isa<UndefValue>(Init)) {
855 return;
Reid Spencer9d6565a2007-02-15 02:26:10 +0000856 } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(Init)) {
Robert Bocchino7c2b7c72006-01-20 18:18:40 +0000857 unsigned ElementSize =
Duncan Sands777d2302009-05-09 07:06:46 +0000858 getTargetData()->getTypeAllocSize(CP->getType()->getElementType());
Robert Bocchino7c2b7c72006-01-20 18:18:40 +0000859 for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
860 InitializeMemory(CP->getOperand(i), (char*)Addr+i*ElementSize);
861 return;
Chris Lattnerb6e1dd72008-02-15 00:57:28 +0000862 } else if (isa<ConstantAggregateZero>(Init)) {
Duncan Sands777d2302009-05-09 07:06:46 +0000863 memset(Addr, 0, (size_t)getTargetData()->getTypeAllocSize(Init->getType()));
Chris Lattnerb6e1dd72008-02-15 00:57:28 +0000864 return;
Dan Gohman638e3782008-05-20 03:20:09 +0000865 } else if (const ConstantArray *CPA = dyn_cast<ConstantArray>(Init)) {
866 unsigned ElementSize =
Duncan Sands777d2302009-05-09 07:06:46 +0000867 getTargetData()->getTypeAllocSize(CPA->getType()->getElementType());
Dan Gohman638e3782008-05-20 03:20:09 +0000868 for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
869 InitializeMemory(CPA->getOperand(i), (char*)Addr+i*ElementSize);
870 return;
871 } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(Init)) {
872 const StructLayout *SL =
873 getTargetData()->getStructLayout(cast<StructType>(CPS->getType()));
874 for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
875 InitializeMemory(CPS->getOperand(i), (char*)Addr+SL->getElementOffset(i));
876 return;
Chris Lattnerbd1d3822004-10-16 18:19:26 +0000877 } else if (Init->getType()->isFirstClassType()) {
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000878 GenericValue Val = getConstantValue(Init);
879 StoreValueToMemory(Val, (GenericValue*)Addr, Init->getType());
880 return;
881 }
882
Dan Gohman638e3782008-05-20 03:20:09 +0000883 cerr << "Bad Type: " << *Init->getType() << "\n";
884 assert(0 && "Unknown constant type to initialize memory with!");
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000885}
886
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000887/// EmitGlobals - Emit all of the global variables to memory, storing their
888/// addresses into GlobalAddress. This must make sure to copy the contents of
889/// their initializers into the memory.
890///
891void ExecutionEngine::emitGlobals() {
Misha Brukmanedf128a2005-04-21 22:36:52 +0000892
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000893 // Loop over all of the global variables in the program, allocating the memory
Chris Lattnerfe854032006-08-16 01:24:12 +0000894 // to hold them. If there is more than one module, do a prepass over globals
895 // to figure out how the different modules should link together.
896 //
897 std::map<std::pair<std::string, const Type*>,
898 const GlobalValue*> LinkedGlobalsMap;
Misha Brukmanedf128a2005-04-21 22:36:52 +0000899
Chris Lattnerfe854032006-08-16 01:24:12 +0000900 if (Modules.size() != 1) {
901 for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
902 Module &M = *Modules[m]->getModule();
903 for (Module::const_global_iterator I = M.global_begin(),
904 E = M.global_end(); I != E; ++I) {
905 const GlobalValue *GV = I;
Rafael Espindolabb46f522009-01-15 20:18:42 +0000906 if (GV->hasLocalLinkage() || GV->isDeclaration() ||
Chris Lattnerfe854032006-08-16 01:24:12 +0000907 GV->hasAppendingLinkage() || !GV->hasName())
908 continue;// Ignore external globals and globals with internal linkage.
909
910 const GlobalValue *&GVEntry =
911 LinkedGlobalsMap[std::make_pair(GV->getName(), GV->getType())];
912
913 // If this is the first time we've seen this global, it is the canonical
914 // version.
915 if (!GVEntry) {
916 GVEntry = GV;
917 continue;
918 }
919
920 // If the existing global is strong, never replace it.
Anton Korobeynikovb74ed072006-09-14 18:23:27 +0000921 if (GVEntry->hasExternalLinkage() ||
922 GVEntry->hasDLLImportLinkage() ||
923 GVEntry->hasDLLExportLinkage())
Chris Lattnerfe854032006-08-16 01:24:12 +0000924 continue;
925
926 // Otherwise, we know it's linkonce/weak, replace it if this is a strong
Dale Johannesenaafce772008-05-14 20:12:51 +0000927 // symbol. FIXME is this right for common?
Anton Korobeynikov78ee7b72006-12-01 00:25:12 +0000928 if (GV->hasExternalLinkage() || GVEntry->hasExternalWeakLinkage())
Chris Lattnerfe854032006-08-16 01:24:12 +0000929 GVEntry = GV;
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000930 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000931 }
Chris Lattnerfe854032006-08-16 01:24:12 +0000932 }
933
934 std::vector<const GlobalValue*> NonCanonicalGlobals;
935 for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
936 Module &M = *Modules[m]->getModule();
937 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
938 I != E; ++I) {
939 // In the multi-module case, see what this global maps to.
940 if (!LinkedGlobalsMap.empty()) {
941 if (const GlobalValue *GVEntry =
942 LinkedGlobalsMap[std::make_pair(I->getName(), I->getType())]) {
943 // If something else is the canonical global, ignore this one.
944 if (GVEntry != &*I) {
945 NonCanonicalGlobals.push_back(I);
946 continue;
947 }
948 }
949 }
950
Reid Spencer5cbf9852007-01-30 20:08:39 +0000951 if (!I->isDeclaration()) {
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000952 addGlobalMapping(I, getMemoryForGV(I));
Chris Lattnerfe854032006-08-16 01:24:12 +0000953 } else {
954 // External variable reference. Try to use the dynamic loader to
955 // get a pointer to it.
956 if (void *SymAddr =
957 sys::DynamicLibrary::SearchForAddressOfSymbol(I->getName().c_str()))
958 addGlobalMapping(I, SymAddr);
959 else {
Torok Edwin31e24662009-07-07 17:32:34 +0000960 llvm_report_error("Could not resolve external global address: "
961 +I->getName());
Chris Lattnerfe854032006-08-16 01:24:12 +0000962 }
963 }
964 }
965
966 // If there are multiple modules, map the non-canonical globals to their
967 // canonical location.
968 if (!NonCanonicalGlobals.empty()) {
969 for (unsigned i = 0, e = NonCanonicalGlobals.size(); i != e; ++i) {
970 const GlobalValue *GV = NonCanonicalGlobals[i];
971 const GlobalValue *CGV =
972 LinkedGlobalsMap[std::make_pair(GV->getName(), GV->getType())];
973 void *Ptr = getPointerToGlobalIfAvailable(CGV);
974 assert(Ptr && "Canonical global wasn't codegen'd!");
Nuno Lopesc8ed9022008-10-14 10:04:52 +0000975 addGlobalMapping(GV, Ptr);
Chris Lattnerfe854032006-08-16 01:24:12 +0000976 }
977 }
978
Reid Spencera54b7cb2007-01-12 07:05:14 +0000979 // Now that all of the globals are set up in memory, loop through them all
980 // and initialize their contents.
Chris Lattnerfe854032006-08-16 01:24:12 +0000981 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
982 I != E; ++I) {
Reid Spencer5cbf9852007-01-30 20:08:39 +0000983 if (!I->isDeclaration()) {
Chris Lattnerfe854032006-08-16 01:24:12 +0000984 if (!LinkedGlobalsMap.empty()) {
985 if (const GlobalValue *GVEntry =
986 LinkedGlobalsMap[std::make_pair(I->getName(), I->getType())])
987 if (GVEntry != &*I) // Not the canonical variable.
988 continue;
989 }
990 EmitGlobalVariable(I);
991 }
992 }
993 }
Chris Lattner24b0a182003-12-20 02:45:37 +0000994}
995
996// EmitGlobalVariable - This method emits the specified global variable to the
997// address specified in GlobalAddresses, or allocates new memory if it's not
998// already in the map.
Chris Lattnerc07ed132003-12-20 03:36:47 +0000999void ExecutionEngine::EmitGlobalVariable(const GlobalVariable *GV) {
Chris Lattner55d86482003-12-31 20:21:04 +00001000 void *GA = getPointerToGlobalIfAvailable(GV);
Chris Lattner23c47242004-02-08 19:33:23 +00001001
Chris Lattner24b0a182003-12-20 02:45:37 +00001002 if (GA == 0) {
1003 // If it's not already specified, allocate memory for the global.
Nicolas Geoffray46fa1392008-10-25 15:41:43 +00001004 GA = getMemoryForGV(GV);
Chris Lattner55d86482003-12-31 20:21:04 +00001005 addGlobalMapping(GV, GA);
Chris Lattner24b0a182003-12-20 02:45:37 +00001006 }
Nicolas Geoffray46fa1392008-10-25 15:41:43 +00001007
1008 // Don't initialize if it's thread local, let the client do it.
1009 if (!GV->isThreadLocal())
1010 InitializeMemory(GV->getInitializer(), GA);
1011
1012 const Type *ElTy = GV->getType()->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +00001013 size_t GVSize = (size_t)getTargetData()->getTypeAllocSize(ElTy);
Chris Lattner813c8152005-01-08 20:13:19 +00001014 NumInitBytes += (unsigned)GVSize;
Chris Lattner24b0a182003-12-20 02:45:37 +00001015 ++NumGlobals;
Chris Lattnerbd199fb2002-12-24 00:01:05 +00001016}