blob: cb2888025b27a2e8c248392c797d4d16076da49e [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
Reid Kleckner4b1511b2009-07-18 00:42:18 +000038ExecutionEngine *(*ExecutionEngine::JITCtor)(ModuleProvider *MP,
39 std::string *ErrorStr,
40 JITMemoryManager *JMM,
41 CodeGenOpt::Level OptLevel,
42 bool GVsWithCode) = 0;
43ExecutionEngine *(*ExecutionEngine::InterpCtor)(ModuleProvider *MP,
44 std::string *ErrorStr) = 0;
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +000045ExecutionEngine::EERegisterFn ExecutionEngine::ExceptionTableRegister = 0;
46
Chris Lattner2fe4bb02006-03-22 06:07:50 +000047
Chris Lattnerd958a5a2007-10-22 02:50:12 +000048ExecutionEngine::ExecutionEngine(ModuleProvider *P) : LazyFunctionCreator(0) {
Chris Lattner3d6e33d2006-11-09 19:31:15 +000049 LazyCompilationDisabled = false;
Evan Cheng446531e2008-09-24 16:25:55 +000050 GVCompilationDisabled = false;
Evan Cheng1b088f32008-06-17 16:49:02 +000051 SymbolSearchingDisabled = false;
Nate Begemand6b7a242009-02-18 08:31:02 +000052 DlsymStubsEnabled = false;
Chris Lattnerfe854032006-08-16 01:24:12 +000053 Modules.push_back(P);
Misha Brukman19684162003-10-16 21:18:05 +000054 assert(P && "ModuleProvider is null?");
55}
56
Brian Gaeke8e539482003-09-04 22:57:27 +000057ExecutionEngine::~ExecutionEngine() {
Reid Spencerd4c0e622007-03-03 18:19:18 +000058 clearAllGlobalMappings();
Chris Lattnerfe854032006-08-16 01:24:12 +000059 for (unsigned i = 0, e = Modules.size(); i != e; ++i)
60 delete Modules[i];
Brian Gaeke8e539482003-09-04 22:57:27 +000061}
62
Nicolas Geoffray46fa1392008-10-25 15:41:43 +000063char* ExecutionEngine::getMemoryForGV(const GlobalVariable* GV) {
64 const Type *ElTy = GV->getType()->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +000065 size_t GVSize = (size_t)getTargetData()->getTypeAllocSize(ElTy);
Nicolas Geoffray46fa1392008-10-25 15:41:43 +000066 return new char[GVSize];
67}
68
Devang Patel73d0e212007-10-15 19:56:32 +000069/// removeModuleProvider - Remove a ModuleProvider from the list of modules.
Nate Begeman60789e42009-01-23 19:27:28 +000070/// Relases the Module from the ModuleProvider, materializing it in the
71/// process, and returns the materialized Module.
Devang Patel73d0e212007-10-15 19:56:32 +000072Module* ExecutionEngine::removeModuleProvider(ModuleProvider *P,
73 std::string *ErrInfo) {
74 for(SmallVector<ModuleProvider *, 1>::iterator I = Modules.begin(),
75 E = Modules.end(); I != E; ++I) {
76 ModuleProvider *MP = *I;
77 if (MP == P) {
78 Modules.erase(I);
Nate Begemanf049e072008-05-21 16:34:48 +000079 clearGlobalMappingsFromModule(MP->getModule());
Devang Patel73d0e212007-10-15 19:56:32 +000080 return MP->releaseModule(ErrInfo);
81 }
82 }
83 return NULL;
84}
85
Nate Begeman60789e42009-01-23 19:27:28 +000086/// deleteModuleProvider - Remove a ModuleProvider from the list of modules,
87/// and deletes the ModuleProvider and owned Module. Avoids materializing
88/// the underlying module.
89void ExecutionEngine::deleteModuleProvider(ModuleProvider *P,
90 std::string *ErrInfo) {
91 for(SmallVector<ModuleProvider *, 1>::iterator I = Modules.begin(),
92 E = Modules.end(); I != E; ++I) {
93 ModuleProvider *MP = *I;
94 if (MP == P) {
95 Modules.erase(I);
96 clearGlobalMappingsFromModule(MP->getModule());
97 delete MP;
98 return;
99 }
100 }
101}
102
Chris Lattnerfe854032006-08-16 01:24:12 +0000103/// FindFunctionNamed - Search all of the active modules to find the one that
104/// defines FnName. This is very slow operation and shouldn't be used for
105/// general code.
106Function *ExecutionEngine::FindFunctionNamed(const char *FnName) {
107 for (unsigned i = 0, e = Modules.size(); i != e; ++i) {
Reid Spencer688b0492007-02-05 21:19:13 +0000108 if (Function *F = Modules[i]->getModule()->getFunction(FnName))
Chris Lattnerfe854032006-08-16 01:24:12 +0000109 return F;
110 }
111 return 0;
112}
113
114
Chris Lattnere7fd5532006-05-08 22:00:52 +0000115/// addGlobalMapping - Tell the execution engine that the specified global is
116/// at the specified location. This is used internally as functions are JIT'd
117/// and as global variables are laid out in memory. It can and should also be
118/// used by clients of the EE that want to have an LLVM global overlay
119/// existing data in memory.
120void ExecutionEngine::addGlobalMapping(const GlobalValue *GV, void *Addr) {
121 MutexGuard locked(lock);
Evan Chengbc4707a2008-09-18 07:54:21 +0000122
Evan Cheng366cf292008-11-07 22:30:29 +0000123 DOUT << "JIT: Map \'" << GV->getNameStart() << "\' to [" << Addr << "]\n";
Chris Lattnere7fd5532006-05-08 22:00:52 +0000124 void *&CurVal = state.getGlobalAddressMap(locked)[GV];
125 assert((CurVal == 0 || Addr == 0) && "GlobalMapping already established!");
126 CurVal = Addr;
127
128 // If we are using the reverse mapping, add it too
129 if (!state.getGlobalAddressReverseMap(locked).empty()) {
130 const GlobalValue *&V = state.getGlobalAddressReverseMap(locked)[Addr];
131 assert((V == 0 || GV == 0) && "GlobalMapping already established!");
132 V = GV;
133 }
134}
135
136/// clearAllGlobalMappings - Clear all global mappings and start over again
137/// use in dynamic compilation scenarios when you want to move globals
138void ExecutionEngine::clearAllGlobalMappings() {
139 MutexGuard locked(lock);
140
141 state.getGlobalAddressMap(locked).clear();
142 state.getGlobalAddressReverseMap(locked).clear();
143}
144
Nate Begemanf049e072008-05-21 16:34:48 +0000145/// clearGlobalMappingsFromModule - Clear all global mappings that came from a
146/// particular module, because it has been removed from the JIT.
147void ExecutionEngine::clearGlobalMappingsFromModule(Module *M) {
148 MutexGuard locked(lock);
149
150 for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; ++FI) {
151 state.getGlobalAddressMap(locked).erase(FI);
152 state.getGlobalAddressReverseMap(locked).erase(FI);
153 }
154 for (Module::global_iterator GI = M->global_begin(), GE = M->global_end();
155 GI != GE; ++GI) {
156 state.getGlobalAddressMap(locked).erase(GI);
157 state.getGlobalAddressReverseMap(locked).erase(GI);
158 }
159}
160
Chris Lattnere7fd5532006-05-08 22:00:52 +0000161/// updateGlobalMapping - Replace an existing mapping for GV with a new
162/// address. This updates both maps as required. If "Addr" is null, the
163/// entry for the global is removed from the mappings.
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000164void *ExecutionEngine::updateGlobalMapping(const GlobalValue *GV, void *Addr) {
Chris Lattnere7fd5532006-05-08 22:00:52 +0000165 MutexGuard locked(lock);
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000166
167 std::map<const GlobalValue*, void *> &Map = state.getGlobalAddressMap(locked);
168
Chris Lattnere7fd5532006-05-08 22:00:52 +0000169 // Deleting from the mapping?
170 if (Addr == 0) {
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000171 std::map<const GlobalValue*, void *>::iterator I = Map.find(GV);
172 void *OldVal;
173 if (I == Map.end())
174 OldVal = 0;
175 else {
176 OldVal = I->second;
177 Map.erase(I);
178 }
179
Chris Lattnere7fd5532006-05-08 22:00:52 +0000180 if (!state.getGlobalAddressReverseMap(locked).empty())
181 state.getGlobalAddressReverseMap(locked).erase(Addr);
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000182 return OldVal;
Chris Lattnere7fd5532006-05-08 22:00:52 +0000183 }
184
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000185 void *&CurVal = Map[GV];
186 void *OldVal = CurVal;
187
Chris Lattnere7fd5532006-05-08 22:00:52 +0000188 if (CurVal && !state.getGlobalAddressReverseMap(locked).empty())
189 state.getGlobalAddressReverseMap(locked).erase(CurVal);
190 CurVal = Addr;
191
192 // If we are using the reverse mapping, add it too
193 if (!state.getGlobalAddressReverseMap(locked).empty()) {
194 const GlobalValue *&V = state.getGlobalAddressReverseMap(locked)[Addr];
195 assert((V == 0 || GV == 0) && "GlobalMapping already established!");
196 V = GV;
197 }
Chris Lattnerf4cc3092008-04-04 04:47:41 +0000198 return OldVal;
Chris Lattnere7fd5532006-05-08 22:00:52 +0000199}
200
201/// getPointerToGlobalIfAvailable - This returns the address of the specified
202/// global value if it is has already been codegen'd, otherwise it returns null.
203///
204void *ExecutionEngine::getPointerToGlobalIfAvailable(const GlobalValue *GV) {
205 MutexGuard locked(lock);
206
207 std::map<const GlobalValue*, void*>::iterator I =
208 state.getGlobalAddressMap(locked).find(GV);
209 return I != state.getGlobalAddressMap(locked).end() ? I->second : 0;
210}
211
Chris Lattner55d86482003-12-31 20:21:04 +0000212/// getGlobalValueAtAddress - Return the LLVM global value object that starts
213/// at the specified address.
214///
215const GlobalValue *ExecutionEngine::getGlobalValueAtAddress(void *Addr) {
Reid Spenceree448632005-07-12 15:51:55 +0000216 MutexGuard locked(lock);
217
Chris Lattner55d86482003-12-31 20:21:04 +0000218 // If we haven't computed the reverse mapping yet, do so first.
Reid Spenceree448632005-07-12 15:51:55 +0000219 if (state.getGlobalAddressReverseMap(locked).empty()) {
Chris Lattnere7fd5532006-05-08 22:00:52 +0000220 for (std::map<const GlobalValue*, void *>::iterator
221 I = state.getGlobalAddressMap(locked).begin(),
222 E = state.getGlobalAddressMap(locked).end(); I != E; ++I)
223 state.getGlobalAddressReverseMap(locked).insert(std::make_pair(I->second,
224 I->first));
Chris Lattner55d86482003-12-31 20:21:04 +0000225 }
226
227 std::map<void *, const GlobalValue*>::iterator I =
Reid Spenceree448632005-07-12 15:51:55 +0000228 state.getGlobalAddressReverseMap(locked).find(Addr);
229 return I != state.getGlobalAddressReverseMap(locked).end() ? I->second : 0;
Chris Lattner55d86482003-12-31 20:21:04 +0000230}
Chris Lattner87f03102003-12-26 06:50:30 +0000231
232// CreateArgv - Turn a vector of strings into a nice argv style array of
233// pointers to null terminated strings.
234//
235static void *CreateArgv(ExecutionEngine *EE,
236 const std::vector<std::string> &InputArgv) {
Owen Andersona69571c2006-05-03 01:29:57 +0000237 unsigned PtrSize = EE->getTargetData()->getPointerSize();
Chris Lattner87f03102003-12-26 06:50:30 +0000238 char *Result = new char[(InputArgv.size()+1)*PtrSize];
239
Evan Chengeb5d95a2008-11-06 17:46:04 +0000240 DOUT << "JIT: ARGV = " << (void*)Result << "\n";
Christopher Lamb43ad6b32007-12-17 01:12:55 +0000241 const Type *SBytePtr = PointerType::getUnqual(Type::Int8Ty);
Chris Lattner87f03102003-12-26 06:50:30 +0000242
243 for (unsigned i = 0; i != InputArgv.size(); ++i) {
244 unsigned Size = InputArgv[i].size()+1;
245 char *Dest = new char[Size];
Evan Chengeb5d95a2008-11-06 17:46:04 +0000246 DOUT << "JIT: ARGV[" << i << "] = " << (void*)Dest << "\n";
Misha Brukmanedf128a2005-04-21 22:36:52 +0000247
Chris Lattner87f03102003-12-26 06:50:30 +0000248 std::copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
249 Dest[Size-1] = 0;
Misha Brukmanedf128a2005-04-21 22:36:52 +0000250
Chris Lattner87f03102003-12-26 06:50:30 +0000251 // Endian safe: Result[i] = (PointerTy)Dest;
252 EE->StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i*PtrSize),
253 SBytePtr);
254 }
255
256 // Null terminate it
257 EE->StoreValueToMemory(PTOGV(0),
258 (GenericValue*)(Result+InputArgv.size()*PtrSize),
259 SBytePtr);
260 return Result;
261}
262
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000263
264/// runStaticConstructorsDestructors - This method is used to execute all of
Evan Cheng18314dc2008-09-30 15:51:21 +0000265/// the static constructors or destructors for a module, depending on the
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000266/// value of isDtors.
Evan Cheng18314dc2008-09-30 15:51:21 +0000267void ExecutionEngine::runStaticConstructorsDestructors(Module *module, bool isDtors) {
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000268 const char *Name = isDtors ? "llvm.global_dtors" : "llvm.global_ctors";
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000269
Chris Lattnerfe854032006-08-16 01:24:12 +0000270 // Execute global ctors/dtors for each module in the program.
Chris Lattnerfe854032006-08-16 01:24:12 +0000271
Evan Cheng18314dc2008-09-30 15:51:21 +0000272 GlobalVariable *GV = module->getNamedGlobal(Name);
273
274 // If this global has internal linkage, or if it has a use, then it must be
275 // an old-style (llvmgcc3) static ctor with __main linked in and in use. If
276 // this is the case, don't execute any of the global ctors, __main will do
277 // it.
Rafael Espindolabb46f522009-01-15 20:18:42 +0000278 if (!GV || GV->isDeclaration() || GV->hasLocalLinkage()) return;
Evan Cheng18314dc2008-09-30 15:51:21 +0000279
280 // Should be an array of '{ int, void ()* }' structs. The first value is
281 // the init priority, which we ignore.
282 ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
283 if (!InitList) return;
284 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
285 if (ConstantStruct *CS =
286 dyn_cast<ConstantStruct>(InitList->getOperand(i))) {
287 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
288
289 Constant *FP = CS->getOperand(1);
290 if (FP->isNullValue())
291 break; // Found a null terminator, exit.
292
293 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(FP))
294 if (CE->isCast())
295 FP = CE->getOperand(0);
296 if (Function *F = dyn_cast<Function>(FP)) {
297 // Execute the ctor/dtor function!
298 runFunction(F, std::vector<GenericValue>());
299 }
300 }
301}
302
303/// runStaticConstructorsDestructors - This method is used to execute all of
304/// the static constructors or destructors for a program, depending on the
305/// value of isDtors.
306void ExecutionEngine::runStaticConstructorsDestructors(bool isDtors) {
307 // Execute global ctors/dtors for each module in the program.
308 for (unsigned m = 0, e = Modules.size(); m != e; ++m)
309 runStaticConstructorsDestructors(Modules[m]->getModule(), isDtors);
Chris Lattner9ca6cda2006-03-08 18:42:46 +0000310}
311
Dan Gohmanb6e3d6c2008-08-26 01:38:29 +0000312#ifndef NDEBUG
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000313/// isTargetNullPtr - Return whether the target pointer stored at Loc is null.
314static bool isTargetNullPtr(ExecutionEngine *EE, void *Loc) {
315 unsigned PtrSize = EE->getTargetData()->getPointerSize();
316 for (unsigned i = 0; i < PtrSize; ++i)
317 if (*(i + (uint8_t*)Loc))
318 return false;
319 return true;
320}
Dan Gohmanb6e3d6c2008-08-26 01:38:29 +0000321#endif
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000322
Chris Lattner87f03102003-12-26 06:50:30 +0000323/// runFunctionAsMain - This is a helper function which wraps runFunction to
324/// handle the common task of starting up main with the specified argc, argv,
325/// and envp parameters.
326int ExecutionEngine::runFunctionAsMain(Function *Fn,
327 const std::vector<std::string> &argv,
328 const char * const * envp) {
329 std::vector<GenericValue> GVArgs;
330 GenericValue GVArgc;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000331 GVArgc.IntVal = APInt(32, argv.size());
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000332
333 // Check main() type
Chris Lattnerf24d0992004-08-16 01:05:35 +0000334 unsigned NumArgs = Fn->getFunctionType()->getNumParams();
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000335 const FunctionType *FTy = Fn->getFunctionType();
Christopher Lamb43ad6b32007-12-17 01:12:55 +0000336 const Type* PPInt8Ty =
337 PointerType::getUnqual(PointerType::getUnqual(Type::Int8Ty));
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000338 switch (NumArgs) {
339 case 3:
340 if (FTy->getParamType(2) != PPInt8Ty) {
Torok Edwin7d696d82009-07-11 13:10:19 +0000341 llvm_report_error("Invalid type for third 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 2:
345 if (FTy->getParamType(1) != PPInt8Ty) {
Torok Edwin7d696d82009-07-11 13:10:19 +0000346 llvm_report_error("Invalid type for second 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 1:
350 if (FTy->getParamType(0) != Type::Int32Ty) {
Torok Edwin7d696d82009-07-11 13:10:19 +0000351 llvm_report_error("Invalid type for first argument of main() supplied");
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000352 }
Anton Korobeynikovfb450862007-06-03 19:20:49 +0000353 // FALLS THROUGH
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000354 case 0:
Chris Lattner45f36832009-02-04 17:48:18 +0000355 if (!isa<IntegerType>(FTy->getReturnType()) &&
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000356 FTy->getReturnType() != Type::VoidTy) {
Torok Edwin7d696d82009-07-11 13:10:19 +0000357 llvm_report_error("Invalid return type of main() supplied");
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000358 }
359 break;
360 default:
Torok Edwin7d696d82009-07-11 13:10:19 +0000361 llvm_report_error("Invalid number of arguments of main() supplied");
Anton Korobeynikov499d8f02007-06-03 19:17:35 +0000362 }
363
Chris Lattnerf24d0992004-08-16 01:05:35 +0000364 if (NumArgs) {
365 GVArgs.push_back(GVArgc); // Arg #0 = argc.
366 if (NumArgs > 1) {
367 GVArgs.push_back(PTOGV(CreateArgv(this, argv))); // Arg #1 = argv.
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000368 assert(!isTargetNullPtr(this, GVTOP(GVArgs[1])) &&
Chris Lattnerf24d0992004-08-16 01:05:35 +0000369 "argv[0] was null after CreateArgv");
370 if (NumArgs > 2) {
371 std::vector<std::string> EnvVars;
372 for (unsigned i = 0; envp[i]; ++i)
373 EnvVars.push_back(envp[i]);
374 GVArgs.push_back(PTOGV(CreateArgv(this, EnvVars))); // Arg #2 = envp.
375 }
376 }
377 }
Reid Spencer8fb0f192007-03-06 03:04:04 +0000378 return runFunction(Fn, GVArgs).IntVal.getZExtValue();
Chris Lattner87f03102003-12-26 06:50:30 +0000379}
380
Misha Brukman19684162003-10-16 21:18:05 +0000381/// If possible, create a JIT, unless the caller specifically requests an
382/// Interpreter or there's an error. If even an Interpreter cannot be created,
Misha Brukmanedf128a2005-04-21 22:36:52 +0000383/// NULL is returned.
Misha Brukman4afac182003-10-10 17:45:12 +0000384///
Misha Brukmanedf128a2005-04-21 22:36:52 +0000385ExecutionEngine *ExecutionEngine::create(ModuleProvider *MP,
Reid Spencerd4c0e622007-03-03 18:19:18 +0000386 bool ForceInterpreter,
Evan Cheng502f20b2008-08-08 08:11:34 +0000387 std::string *ErrorStr,
Jeffrey Yasskin489393d2009-07-08 21:59:57 +0000388 CodeGenOpt::Level OptLevel,
389 bool GVsWithCode) {
Reid Kleckner4b1511b2009-07-18 00:42:18 +0000390 return EngineBuilder(MP)
391 .setEngineKind(ForceInterpreter
392 ? EngineKind::Interpreter
393 : EngineKind::JIT)
394 .setErrorStr(ErrorStr)
395 .setOptLevel(OptLevel)
396 .setAllocateGVsWithCode(GVsWithCode)
397 .create();
398}
Brian Gaeke82d82772003-09-03 20:34:19 +0000399
Reid Kleckner4b1511b2009-07-18 00:42:18 +0000400ExecutionEngine *ExecutionEngine::create(Module *M) {
401 return EngineBuilder(M).create();
402}
403
404/// EngineBuilder - Overloaded constructor that automatically creates an
405/// ExistingModuleProvider for an existing module.
406EngineBuilder::EngineBuilder(Module *m) : MP(new ExistingModuleProvider(m)) {
407 InitEngine();
408}
409
410ExecutionEngine *EngineBuilder::create() {
Nick Lewycky6456d862008-03-08 02:49:45 +0000411 // Make sure we can resolve symbols in the program as well. The zero arg
412 // to the function tells DynamicLibrary to load the program, not a library.
413 if (sys::DynamicLibrary::LoadLibraryPermanently(0, ErrorStr))
414 return 0;
415
Reid Kleckner4b1511b2009-07-18 00:42:18 +0000416 // If the user specified a memory manager but didn't specify which engine to
417 // create, we assume they only want the JIT, and we fail if they only want
418 // the interpreter.
419 if (JMM) {
420 if (WhichEngine & EngineKind::JIT) {
421 WhichEngine = EngineKind::JIT;
422 } else {
423 *ErrorStr = "Cannot create an interpreter with a memory manager.";
424 }
425 }
Brian Gaeke82d82772003-09-03 20:34:19 +0000426
Reid Kleckner4b1511b2009-07-18 00:42:18 +0000427 ExecutionEngine *EE = 0;
428
429 // Unless the interpreter was explicitly selected or the JIT is not linked,
430 // try making a JIT.
431 if (WhichEngine & EngineKind::JIT && ExecutionEngine::JITCtor) {
432 EE = ExecutionEngine::JITCtor(MP, ErrorStr, JMM, OptLevel,
433 AllocateGVsWithCode);
434 }
435
436 // If we can't make a JIT and we didn't request one specifically, try making
437 // an interpreter instead.
438 if (WhichEngine & EngineKind::Interpreter && EE == 0 &&
439 ExecutionEngine::InterpCtor) {
440 EE = ExecutionEngine::InterpCtor(MP, ErrorStr);
441 }
Chris Lattner73011782003-12-28 09:44:37 +0000442
Brian Gaeke82d82772003-09-03 20:34:19 +0000443 return EE;
444}
445
Misha Brukman4afac182003-10-10 17:45:12 +0000446/// getPointerToGlobal - This returns the address of the specified global
447/// value. This may involve code generation if it's a function.
448///
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000449void *ExecutionEngine::getPointerToGlobal(const GlobalValue *GV) {
Brian Gaeke37df4602003-08-13 18:16:14 +0000450 if (Function *F = const_cast<Function*>(dyn_cast<Function>(GV)))
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000451 return getPointerToFunction(F);
452
Reid Spenceree448632005-07-12 15:51:55 +0000453 MutexGuard locked(lock);
Jeff Cohen68835dd2006-02-07 05:11:57 +0000454 void *p = state.getGlobalAddressMap(locked)[GV];
455 if (p)
456 return p;
457
458 // Global variable might have been added since interpreter started.
459 if (GlobalVariable *GVar =
460 const_cast<GlobalVariable *>(dyn_cast<GlobalVariable>(GV)))
461 EmitGlobalVariable(GVar);
462 else
Torok Edwinc23197a2009-07-14 16:55:14 +0000463 llvm_unreachable("Global hasn't had an address allocated yet!");
Reid Spenceree448632005-07-12 15:51:55 +0000464 return state.getGlobalAddressMap(locked)[GV];
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000465}
466
Reid Spencer3da59db2006-11-27 01:05:10 +0000467/// This function converts a Constant* into a GenericValue. The interesting
468/// part is if C is a ConstantExpr.
Reid Spencerba28cb92007-08-11 15:57:56 +0000469/// @brief Get a GenericValue for a Constant*
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000470GenericValue ExecutionEngine::getConstantValue(const Constant *C) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000471 // If its undefined, return the garbage.
Reid Spencerbce30f12007-03-06 22:23:15 +0000472 if (isa<UndefValue>(C))
473 return GenericValue();
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000474
Reid Spencer3da59db2006-11-27 01:05:10 +0000475 // If the value is a ConstantExpr
476 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Reid Spencerbce30f12007-03-06 22:23:15 +0000477 Constant *Op0 = CE->getOperand(0);
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000478 switch (CE->getOpcode()) {
479 case Instruction::GetElementPtr: {
Reid Spencer3da59db2006-11-27 01:05:10 +0000480 // Compute the index
Reid Spencerbce30f12007-03-06 22:23:15 +0000481 GenericValue Result = getConstantValue(Op0);
Chris Lattner829621c2007-02-10 20:35:22 +0000482 SmallVector<Value*, 8> Indices(CE->op_begin()+1, CE->op_end());
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000483 uint64_t Offset =
Reid Spencerbce30f12007-03-06 22:23:15 +0000484 TD->getIndexedOffset(Op0->getType(), &Indices[0], Indices.size());
Misha Brukmanedf128a2005-04-21 22:36:52 +0000485
Reid Spencer8fb0f192007-03-06 03:04:04 +0000486 char* tmp = (char*) Result.PointerVal;
487 Result = PTOGV(tmp + Offset);
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000488 return Result;
489 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000490 case Instruction::Trunc: {
491 GenericValue GV = getConstantValue(Op0);
492 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
493 GV.IntVal = GV.IntVal.trunc(BitWidth);
494 return GV;
495 }
496 case Instruction::ZExt: {
497 GenericValue GV = getConstantValue(Op0);
498 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
499 GV.IntVal = GV.IntVal.zext(BitWidth);
500 return GV;
501 }
502 case Instruction::SExt: {
503 GenericValue GV = getConstantValue(Op0);
504 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
505 GV.IntVal = GV.IntVal.sext(BitWidth);
506 return GV;
507 }
508 case Instruction::FPTrunc: {
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000509 // FIXME long double
Reid Spencerbce30f12007-03-06 22:23:15 +0000510 GenericValue GV = getConstantValue(Op0);
511 GV.FloatVal = float(GV.DoubleVal);
512 return GV;
513 }
514 case Instruction::FPExt:{
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000515 // FIXME long double
Reid Spencerbce30f12007-03-06 22:23:15 +0000516 GenericValue GV = getConstantValue(Op0);
517 GV.DoubleVal = double(GV.FloatVal);
518 return GV;
519 }
520 case Instruction::UIToFP: {
521 GenericValue GV = getConstantValue(Op0);
522 if (CE->getType() == Type::FloatTy)
523 GV.FloatVal = float(GV.IntVal.roundToDouble());
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000524 else if (CE->getType() == Type::DoubleTy)
Reid Spencerbce30f12007-03-06 22:23:15 +0000525 GV.DoubleVal = GV.IntVal.roundToDouble();
Dale Johannesen910993e2007-09-21 22:09:37 +0000526 else if (CE->getType() == Type::X86_FP80Ty) {
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000527 const uint64_t zero[] = {0, 0};
528 APFloat apf = APFloat(APInt(80, 2, zero));
Dan Gohman62824062008-02-29 01:27:13 +0000529 (void)apf.convertFromAPInt(GV.IntVal,
530 false,
531 APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000532 GV.IntVal = apf.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000533 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000534 return GV;
535 }
536 case Instruction::SIToFP: {
537 GenericValue GV = getConstantValue(Op0);
538 if (CE->getType() == Type::FloatTy)
539 GV.FloatVal = float(GV.IntVal.signedRoundToDouble());
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000540 else if (CE->getType() == Type::DoubleTy)
Reid Spencerbce30f12007-03-06 22:23:15 +0000541 GV.DoubleVal = GV.IntVal.signedRoundToDouble();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000542 else if (CE->getType() == Type::X86_FP80Ty) {
543 const uint64_t zero[] = { 0, 0};
544 APFloat apf = APFloat(APInt(80, 2, zero));
Dan Gohman62824062008-02-29 01:27:13 +0000545 (void)apf.convertFromAPInt(GV.IntVal,
546 true,
547 APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000548 GV.IntVal = apf.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000549 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000550 return GV;
551 }
552 case Instruction::FPToUI: // double->APInt conversion handles sign
553 case Instruction::FPToSI: {
554 GenericValue GV = getConstantValue(Op0);
555 uint32_t BitWidth = cast<IntegerType>(CE->getType())->getBitWidth();
556 if (Op0->getType() == Type::FloatTy)
557 GV.IntVal = APIntOps::RoundFloatToAPInt(GV.FloatVal, BitWidth);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000558 else if (Op0->getType() == Type::DoubleTy)
Reid Spencerbce30f12007-03-06 22:23:15 +0000559 GV.IntVal = APIntOps::RoundDoubleToAPInt(GV.DoubleVal, BitWidth);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000560 else if (Op0->getType() == Type::X86_FP80Ty) {
561 APFloat apf = APFloat(GV.IntVal);
562 uint64_t v;
Dale Johannesen23a98552008-10-09 23:00:39 +0000563 bool ignored;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000564 (void)apf.convertToInteger(&v, BitWidth,
565 CE->getOpcode()==Instruction::FPToSI,
Dale Johannesen23a98552008-10-09 23:00:39 +0000566 APFloat::rmTowardZero, &ignored);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000567 GV.IntVal = v; // endian?
568 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000569 return GV;
570 }
Reid Spencer3da59db2006-11-27 01:05:10 +0000571 case Instruction::PtrToInt: {
Reid Spencerbce30f12007-03-06 22:23:15 +0000572 GenericValue GV = getConstantValue(Op0);
573 uint32_t PtrWidth = TD->getPointerSizeInBits();
574 GV.IntVal = APInt(PtrWidth, uintptr_t(GV.PointerVal));
575 return GV;
576 }
577 case Instruction::IntToPtr: {
578 GenericValue GV = getConstantValue(Op0);
579 uint32_t PtrWidth = TD->getPointerSizeInBits();
580 if (PtrWidth != GV.IntVal.getBitWidth())
581 GV.IntVal = GV.IntVal.zextOrTrunc(PtrWidth);
582 assert(GV.IntVal.getBitWidth() <= 64 && "Bad pointer width");
583 GV.PointerVal = PointerTy(uintptr_t(GV.IntVal.getZExtValue()));
Reid Spencer3da59db2006-11-27 01:05:10 +0000584 return GV;
585 }
586 case Instruction::BitCast: {
Reid Spencerbce30f12007-03-06 22:23:15 +0000587 GenericValue GV = getConstantValue(Op0);
588 const Type* DestTy = CE->getType();
589 switch (Op0->getType()->getTypeID()) {
Torok Edwinc23197a2009-07-14 16:55:14 +0000590 default: llvm_unreachable("Invalid bitcast operand");
Reid Spencerbce30f12007-03-06 22:23:15 +0000591 case Type::IntegerTyID:
592 assert(DestTy->isFloatingPoint() && "invalid bitcast");
593 if (DestTy == Type::FloatTy)
594 GV.FloatVal = GV.IntVal.bitsToFloat();
595 else if (DestTy == Type::DoubleTy)
596 GV.DoubleVal = GV.IntVal.bitsToDouble();
597 break;
598 case Type::FloatTyID:
599 assert(DestTy == Type::Int32Ty && "Invalid bitcast");
600 GV.IntVal.floatToBits(GV.FloatVal);
601 break;
602 case Type::DoubleTyID:
603 assert(DestTy == Type::Int64Ty && "Invalid bitcast");
604 GV.IntVal.doubleToBits(GV.DoubleVal);
605 break;
606 case Type::PointerTyID:
607 assert(isa<PointerType>(DestTy) && "Invalid bitcast");
608 break; // getConstantValue(Op0) above already converted it
609 }
610 return GV;
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000611 }
Chris Lattner9a231222003-05-14 17:51:49 +0000612 case Instruction::Add:
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000613 case Instruction::FAdd:
Reid Spencerbce30f12007-03-06 22:23:15 +0000614 case Instruction::Sub:
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000615 case Instruction::FSub:
Reid Spencerbce30f12007-03-06 22:23:15 +0000616 case Instruction::Mul:
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000617 case Instruction::FMul:
Reid Spencerbce30f12007-03-06 22:23:15 +0000618 case Instruction::UDiv:
619 case Instruction::SDiv:
620 case Instruction::URem:
621 case Instruction::SRem:
622 case Instruction::And:
623 case Instruction::Or:
624 case Instruction::Xor: {
625 GenericValue LHS = getConstantValue(Op0);
626 GenericValue RHS = getConstantValue(CE->getOperand(1));
627 GenericValue GV;
Chris Lattner5f90cb82004-07-11 08:01:11 +0000628 switch (CE->getOperand(0)->getType()->getTypeID()) {
Torok Edwinc23197a2009-07-14 16:55:14 +0000629 default: llvm_unreachable("Bad add type!");
Reid Spencera54b7cb2007-01-12 07:05:14 +0000630 case Type::IntegerTyID:
Reid Spencerbce30f12007-03-06 22:23:15 +0000631 switch (CE->getOpcode()) {
Torok Edwinc23197a2009-07-14 16:55:14 +0000632 default: llvm_unreachable("Invalid integer opcode");
Reid Spencerbce30f12007-03-06 22:23:15 +0000633 case Instruction::Add: GV.IntVal = LHS.IntVal + RHS.IntVal; break;
634 case Instruction::Sub: GV.IntVal = LHS.IntVal - RHS.IntVal; break;
635 case Instruction::Mul: GV.IntVal = LHS.IntVal * RHS.IntVal; break;
636 case Instruction::UDiv:GV.IntVal = LHS.IntVal.udiv(RHS.IntVal); break;
637 case Instruction::SDiv:GV.IntVal = LHS.IntVal.sdiv(RHS.IntVal); break;
638 case Instruction::URem:GV.IntVal = LHS.IntVal.urem(RHS.IntVal); break;
639 case Instruction::SRem:GV.IntVal = LHS.IntVal.srem(RHS.IntVal); break;
640 case Instruction::And: GV.IntVal = LHS.IntVal & RHS.IntVal; break;
641 case Instruction::Or: GV.IntVal = LHS.IntVal | RHS.IntVal; break;
642 case Instruction::Xor: GV.IntVal = LHS.IntVal ^ RHS.IntVal; break;
643 }
Chris Lattner5f90cb82004-07-11 08:01:11 +0000644 break;
645 case Type::FloatTyID:
Reid Spencerbce30f12007-03-06 22:23:15 +0000646 switch (CE->getOpcode()) {
Torok Edwinc23197a2009-07-14 16:55:14 +0000647 default: llvm_unreachable("Invalid float opcode");
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000648 case Instruction::FAdd:
Reid Spencerbce30f12007-03-06 22:23:15 +0000649 GV.FloatVal = LHS.FloatVal + RHS.FloatVal; break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000650 case Instruction::FSub:
Reid Spencerbce30f12007-03-06 22:23:15 +0000651 GV.FloatVal = LHS.FloatVal - RHS.FloatVal; break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000652 case Instruction::FMul:
Reid Spencerbce30f12007-03-06 22:23:15 +0000653 GV.FloatVal = LHS.FloatVal * RHS.FloatVal; break;
654 case Instruction::FDiv:
655 GV.FloatVal = LHS.FloatVal / RHS.FloatVal; break;
656 case Instruction::FRem:
657 GV.FloatVal = ::fmodf(LHS.FloatVal,RHS.FloatVal); break;
658 }
Chris Lattner5f90cb82004-07-11 08:01:11 +0000659 break;
660 case Type::DoubleTyID:
Reid Spencerbce30f12007-03-06 22:23:15 +0000661 switch (CE->getOpcode()) {
Torok Edwinc23197a2009-07-14 16:55:14 +0000662 default: llvm_unreachable("Invalid double opcode");
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000663 case Instruction::FAdd:
Reid Spencerbce30f12007-03-06 22:23:15 +0000664 GV.DoubleVal = LHS.DoubleVal + RHS.DoubleVal; break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000665 case Instruction::FSub:
Reid Spencerbce30f12007-03-06 22:23:15 +0000666 GV.DoubleVal = LHS.DoubleVal - RHS.DoubleVal; break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000667 case Instruction::FMul:
Reid Spencerbce30f12007-03-06 22:23:15 +0000668 GV.DoubleVal = LHS.DoubleVal * RHS.DoubleVal; break;
669 case Instruction::FDiv:
670 GV.DoubleVal = LHS.DoubleVal / RHS.DoubleVal; break;
671 case Instruction::FRem:
672 GV.DoubleVal = ::fmod(LHS.DoubleVal,RHS.DoubleVal); break;
673 }
Chris Lattner5f90cb82004-07-11 08:01:11 +0000674 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000675 case Type::X86_FP80TyID:
676 case Type::PPC_FP128TyID:
677 case Type::FP128TyID: {
678 APFloat apfLHS = APFloat(LHS.IntVal);
679 switch (CE->getOpcode()) {
Torok Edwinc23197a2009-07-14 16:55:14 +0000680 default: llvm_unreachable("Invalid long double opcode");llvm_unreachable(0);
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000681 case Instruction::FAdd:
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000682 apfLHS.add(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000683 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000684 break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000685 case Instruction::FSub:
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000686 apfLHS.subtract(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000687 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000688 break;
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000689 case Instruction::FMul:
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000690 apfLHS.multiply(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000691 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000692 break;
693 case Instruction::FDiv:
694 apfLHS.divide(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000695 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000696 break;
697 case Instruction::FRem:
698 apfLHS.mod(APFloat(RHS.IntVal), APFloat::rmNearestTiesToEven);
Dale Johannesen7111b022008-10-09 18:53:47 +0000699 GV.IntVal = apfLHS.bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000700 break;
701 }
702 }
703 break;
Chris Lattner5f90cb82004-07-11 08:01:11 +0000704 }
Reid Spencerbce30f12007-03-06 22:23:15 +0000705 return GV;
706 }
Chris Lattner9a231222003-05-14 17:51:49 +0000707 default:
708 break;
709 }
Torok Edwin7d696d82009-07-11 13:10:19 +0000710 std::string msg;
711 raw_string_ostream Msg(msg);
712 Msg << "ConstantExpr not handled: " << *CE;
713 llvm_report_error(Msg.str());
Chris Lattner9a231222003-05-14 17:51:49 +0000714 }
Misha Brukmanedf128a2005-04-21 22:36:52 +0000715
Reid Spencerbce30f12007-03-06 22:23:15 +0000716 GenericValue Result;
Chris Lattnerf70c22b2004-06-17 18:19:28 +0000717 switch (C->getType()->getTypeID()) {
Reid Spencer8fb0f192007-03-06 03:04:04 +0000718 case Type::FloatTyID:
Dale Johannesen43421b32007-09-06 18:13:44 +0000719 Result.FloatVal = cast<ConstantFP>(C)->getValueAPF().convertToFloat();
Reid Spencera54b7cb2007-01-12 07:05:14 +0000720 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000721 case Type::DoubleTyID:
Dale Johannesen43421b32007-09-06 18:13:44 +0000722 Result.DoubleVal = cast<ConstantFP>(C)->getValueAPF().convertToDouble();
Reid Spencer8fb0f192007-03-06 03:04:04 +0000723 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000724 case Type::X86_FP80TyID:
725 case Type::FP128TyID:
726 case Type::PPC_FP128TyID:
Dale Johannesen7111b022008-10-09 18:53:47 +0000727 Result.IntVal = cast <ConstantFP>(C)->getValueAPF().bitcastToAPInt();
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000728 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000729 case Type::IntegerTyID:
730 Result.IntVal = cast<ConstantInt>(C)->getValue();
731 break;
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000732 case Type::PointerTyID:
Reid Spencer40cf2f92004-07-18 00:41:27 +0000733 if (isa<ConstantPointerNull>(C))
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000734 Result.PointerVal = 0;
Reid Spencer40cf2f92004-07-18 00:41:27 +0000735 else if (const Function *F = dyn_cast<Function>(C))
736 Result = PTOGV(getPointerToFunctionOrStub(const_cast<Function*>(F)));
737 else if (const GlobalVariable* GV = dyn_cast<GlobalVariable>(C))
738 Result = PTOGV(getOrEmitGlobalVariable(const_cast<GlobalVariable*>(GV)));
739 else
Torok Edwinc23197a2009-07-14 16:55:14 +0000740 llvm_unreachable("Unknown constant pointer type!");
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000741 break;
742 default:
Torok Edwin7d696d82009-07-11 13:10:19 +0000743 std::string msg;
744 raw_string_ostream Msg(msg);
745 Msg << "ERROR: Constant unimplemented for type: " << *C->getType();
746 llvm_report_error(Msg.str());
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000747 }
748 return Result;
749}
750
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000751/// StoreIntToMemory - Fills the StoreBytes bytes of memory starting from Dst
752/// with the integer held in IntVal.
753static void StoreIntToMemory(const APInt &IntVal, uint8_t *Dst,
754 unsigned StoreBytes) {
755 assert((IntVal.getBitWidth()+7)/8 >= StoreBytes && "Integer too small!");
756 uint8_t *Src = (uint8_t *)IntVal.getRawData();
757
Chris Lattnerb67c9582009-01-22 19:53:00 +0000758 if (sys::isLittleEndianHost())
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000759 // Little-endian host - the source is ordered from LSB to MSB. Order the
760 // destination from LSB to MSB: Do a straight copy.
761 memcpy(Dst, Src, StoreBytes);
762 else {
763 // Big-endian host - the source is an array of 64 bit words ordered from
764 // LSW to MSW. Each word is ordered from MSB to LSB. Order the destination
765 // from MSB to LSB: Reverse the word order, but not the bytes in a word.
766 while (StoreBytes > sizeof(uint64_t)) {
767 StoreBytes -= sizeof(uint64_t);
768 // May not be aligned so use memcpy.
769 memcpy(Dst + StoreBytes, Src, sizeof(uint64_t));
770 Src += sizeof(uint64_t);
771 }
772
773 memcpy(Dst, Src + sizeof(uint64_t) - StoreBytes, StoreBytes);
774 }
775}
776
Nate Begeman37efe672006-04-22 18:53:45 +0000777/// StoreValueToMemory - Stores the data in Val of type Ty at address Ptr. Ptr
778/// is the address of the memory at which to store Val, cast to GenericValue *.
779/// It is not a pointer to a GenericValue containing the address at which to
780/// store Val.
Evan Cheng89687e32008-11-04 06:10:31 +0000781void ExecutionEngine::StoreValueToMemory(const GenericValue &Val,
782 GenericValue *Ptr, const Type *Ty) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000783 const unsigned StoreBytes = getTargetData()->getTypeStoreSize(Ty);
784
Reid Spencer8fb0f192007-03-06 03:04:04 +0000785 switch (Ty->getTypeID()) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000786 case Type::IntegerTyID:
787 StoreIntToMemory(Val.IntVal, (uint8_t*)Ptr, StoreBytes);
Reid Spencer8fb0f192007-03-06 03:04:04 +0000788 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000789 case Type::FloatTyID:
790 *((float*)Ptr) = Val.FloatVal;
791 break;
792 case Type::DoubleTyID:
793 *((double*)Ptr) = Val.DoubleVal;
794 break;
Dale Johannesen1f8c5642009-03-24 18:16:17 +0000795 case Type::X86_FP80TyID:
796 memcpy(Ptr, Val.IntVal.getRawData(), 10);
797 break;
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000798 case Type::PointerTyID:
799 // Ensure 64 bit target pointers are fully initialized on 32 bit hosts.
800 if (StoreBytes != sizeof(PointerTy))
801 memset(Ptr, 0, StoreBytes);
802
Reid Spencer8fb0f192007-03-06 03:04:04 +0000803 *((PointerTy*)Ptr) = Val.PointerVal;
804 break;
805 default:
806 cerr << "Cannot store value of type " << *Ty << "!\n";
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000807 }
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000808
Chris Lattnerb67c9582009-01-22 19:53:00 +0000809 if (sys::isLittleEndianHost() != getTargetData()->isLittleEndian())
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000810 // Host and target are different endian - reverse the stored bytes.
811 std::reverse((uint8_t*)Ptr, StoreBytes + (uint8_t*)Ptr);
812}
813
814/// LoadIntFromMemory - Loads the integer stored in the LoadBytes bytes starting
815/// from Src into IntVal, which is assumed to be wide enough and to hold zero.
816static void LoadIntFromMemory(APInt &IntVal, uint8_t *Src, unsigned LoadBytes) {
817 assert((IntVal.getBitWidth()+7)/8 >= LoadBytes && "Integer too small!");
818 uint8_t *Dst = (uint8_t *)IntVal.getRawData();
819
Chris Lattnerb67c9582009-01-22 19:53:00 +0000820 if (sys::isLittleEndianHost())
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000821 // Little-endian host - the destination must be ordered from LSB to MSB.
822 // The source is ordered from LSB to MSB: Do a straight copy.
823 memcpy(Dst, Src, LoadBytes);
824 else {
825 // Big-endian - the destination is an array of 64 bit words ordered from
826 // LSW to MSW. Each word must be ordered from MSB to LSB. The source is
827 // ordered from MSB to LSB: Reverse the word order, but not the bytes in
828 // a word.
829 while (LoadBytes > sizeof(uint64_t)) {
830 LoadBytes -= sizeof(uint64_t);
831 // May not be aligned so use memcpy.
832 memcpy(Dst, Src + LoadBytes, sizeof(uint64_t));
833 Dst += sizeof(uint64_t);
834 }
835
836 memcpy(Dst + sizeof(uint64_t) - LoadBytes, Src, LoadBytes);
837 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000838}
839
Misha Brukman4afac182003-10-10 17:45:12 +0000840/// FIXME: document
841///
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000842void ExecutionEngine::LoadValueFromMemory(GenericValue &Result,
Duncan Sands08bfe262008-03-10 16:38:37 +0000843 GenericValue *Ptr,
844 const Type *Ty) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000845 const unsigned LoadBytes = getTargetData()->getTypeStoreSize(Ty);
Duncan Sands1eff7042007-12-10 17:43:13 +0000846
Chris Lattnerb67c9582009-01-22 19:53:00 +0000847 if (sys::isLittleEndianHost() != getTargetData()->isLittleEndian()) {
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000848 // Host and target are different endian - reverse copy the stored
849 // bytes into a buffer, and load from that.
850 uint8_t *Src = (uint8_t*)Ptr;
851 uint8_t *Buf = (uint8_t*)alloca(LoadBytes);
852 std::reverse_copy(Src, Src + LoadBytes, Buf);
853 Ptr = (GenericValue*)Buf;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000854 }
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000855
856 switch (Ty->getTypeID()) {
857 case Type::IntegerTyID:
858 // An APInt with all words initially zero.
859 Result.IntVal = APInt(cast<IntegerType>(Ty)->getBitWidth(), 0);
860 LoadIntFromMemory(Result.IntVal, (uint8_t*)Ptr, LoadBytes);
861 break;
Reid Spencer8fb0f192007-03-06 03:04:04 +0000862 case Type::FloatTyID:
863 Result.FloatVal = *((float*)Ptr);
864 break;
865 case Type::DoubleTyID:
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000866 Result.DoubleVal = *((double*)Ptr);
Reid Spencer8fb0f192007-03-06 03:04:04 +0000867 break;
Duncan Sands8a43e9e2007-12-14 19:38:31 +0000868 case Type::PointerTyID:
Reid Spencer8fb0f192007-03-06 03:04:04 +0000869 Result.PointerVal = *((PointerTy*)Ptr);
870 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000871 case Type::X86_FP80TyID: {
872 // This is endian dependent, but it will only work on x86 anyway.
Duncan Sands9e4635a2007-12-15 17:37:40 +0000873 // FIXME: Will not trap if loading a signaling NaN.
Dale Johannesen1f8c5642009-03-24 18:16:17 +0000874 uint64_t y[2];
875 memcpy(y, Ptr, 10);
Duncan Sandsdd65a732007-11-28 10:36:19 +0000876 Result.IntVal = APInt(80, 2, y);
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000877 break;
878 }
Reid Spencer8fb0f192007-03-06 03:04:04 +0000879 default:
Torok Edwin7d696d82009-07-11 13:10:19 +0000880 std::string msg;
881 raw_string_ostream Msg(msg);
882 Msg << "Cannot load value of type " << *Ty << "!";
883 llvm_report_error(Msg.str());
Chris Lattnerf88b9a62003-05-08 16:52:16 +0000884 }
Chris Lattnerf88b9a62003-05-08 16:52:16 +0000885}
886
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000887// InitializeMemory - Recursive function to apply a Constant value into the
888// specified memory location...
889//
890void ExecutionEngine::InitializeMemory(const Constant *Init, void *Addr) {
Evan Chengeb5d95a2008-11-06 17:46:04 +0000891 DOUT << "JIT: Initializing " << Addr << " ";
Dale Johannesendd947ea2008-08-07 01:30:15 +0000892 DEBUG(Init->dump());
Chris Lattnerbd1d3822004-10-16 18:19:26 +0000893 if (isa<UndefValue>(Init)) {
894 return;
Reid Spencer9d6565a2007-02-15 02:26:10 +0000895 } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(Init)) {
Robert Bocchino7c2b7c72006-01-20 18:18:40 +0000896 unsigned ElementSize =
Duncan Sands777d2302009-05-09 07:06:46 +0000897 getTargetData()->getTypeAllocSize(CP->getType()->getElementType());
Robert Bocchino7c2b7c72006-01-20 18:18:40 +0000898 for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
899 InitializeMemory(CP->getOperand(i), (char*)Addr+i*ElementSize);
900 return;
Chris Lattnerb6e1dd72008-02-15 00:57:28 +0000901 } else if (isa<ConstantAggregateZero>(Init)) {
Duncan Sands777d2302009-05-09 07:06:46 +0000902 memset(Addr, 0, (size_t)getTargetData()->getTypeAllocSize(Init->getType()));
Chris Lattnerb6e1dd72008-02-15 00:57:28 +0000903 return;
Dan Gohman638e3782008-05-20 03:20:09 +0000904 } else if (const ConstantArray *CPA = dyn_cast<ConstantArray>(Init)) {
905 unsigned ElementSize =
Duncan Sands777d2302009-05-09 07:06:46 +0000906 getTargetData()->getTypeAllocSize(CPA->getType()->getElementType());
Dan Gohman638e3782008-05-20 03:20:09 +0000907 for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
908 InitializeMemory(CPA->getOperand(i), (char*)Addr+i*ElementSize);
909 return;
910 } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(Init)) {
911 const StructLayout *SL =
912 getTargetData()->getStructLayout(cast<StructType>(CPS->getType()));
913 for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
914 InitializeMemory(CPS->getOperand(i), (char*)Addr+SL->getElementOffset(i));
915 return;
Chris Lattnerbd1d3822004-10-16 18:19:26 +0000916 } else if (Init->getType()->isFirstClassType()) {
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000917 GenericValue Val = getConstantValue(Init);
918 StoreValueToMemory(Val, (GenericValue*)Addr, Init->getType());
919 return;
920 }
921
Dan Gohman638e3782008-05-20 03:20:09 +0000922 cerr << "Bad Type: " << *Init->getType() << "\n";
Torok Edwinc23197a2009-07-14 16:55:14 +0000923 llvm_unreachable("Unknown constant type to initialize memory with!");
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000924}
925
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000926/// EmitGlobals - Emit all of the global variables to memory, storing their
927/// addresses into GlobalAddress. This must make sure to copy the contents of
928/// their initializers into the memory.
929///
930void ExecutionEngine::emitGlobals() {
Misha Brukmanedf128a2005-04-21 22:36:52 +0000931
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000932 // Loop over all of the global variables in the program, allocating the memory
Chris Lattnerfe854032006-08-16 01:24:12 +0000933 // to hold them. If there is more than one module, do a prepass over globals
934 // to figure out how the different modules should link together.
935 //
936 std::map<std::pair<std::string, const Type*>,
937 const GlobalValue*> LinkedGlobalsMap;
Misha Brukmanedf128a2005-04-21 22:36:52 +0000938
Chris Lattnerfe854032006-08-16 01:24:12 +0000939 if (Modules.size() != 1) {
940 for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
941 Module &M = *Modules[m]->getModule();
942 for (Module::const_global_iterator I = M.global_begin(),
943 E = M.global_end(); I != E; ++I) {
944 const GlobalValue *GV = I;
Rafael Espindolabb46f522009-01-15 20:18:42 +0000945 if (GV->hasLocalLinkage() || GV->isDeclaration() ||
Chris Lattnerfe854032006-08-16 01:24:12 +0000946 GV->hasAppendingLinkage() || !GV->hasName())
947 continue;// Ignore external globals and globals with internal linkage.
948
949 const GlobalValue *&GVEntry =
950 LinkedGlobalsMap[std::make_pair(GV->getName(), GV->getType())];
951
952 // If this is the first time we've seen this global, it is the canonical
953 // version.
954 if (!GVEntry) {
955 GVEntry = GV;
956 continue;
957 }
958
959 // If the existing global is strong, never replace it.
Anton Korobeynikovb74ed072006-09-14 18:23:27 +0000960 if (GVEntry->hasExternalLinkage() ||
961 GVEntry->hasDLLImportLinkage() ||
962 GVEntry->hasDLLExportLinkage())
Chris Lattnerfe854032006-08-16 01:24:12 +0000963 continue;
964
965 // Otherwise, we know it's linkonce/weak, replace it if this is a strong
Dale Johannesenaafce772008-05-14 20:12:51 +0000966 // symbol. FIXME is this right for common?
Anton Korobeynikov78ee7b72006-12-01 00:25:12 +0000967 if (GV->hasExternalLinkage() || GVEntry->hasExternalWeakLinkage())
Chris Lattnerfe854032006-08-16 01:24:12 +0000968 GVEntry = GV;
Chris Lattnerd8c03bf2003-04-23 19:01:49 +0000969 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000970 }
Chris Lattnerfe854032006-08-16 01:24:12 +0000971 }
972
973 std::vector<const GlobalValue*> NonCanonicalGlobals;
974 for (unsigned m = 0, e = Modules.size(); m != e; ++m) {
975 Module &M = *Modules[m]->getModule();
976 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
977 I != E; ++I) {
978 // In the multi-module case, see what this global maps to.
979 if (!LinkedGlobalsMap.empty()) {
980 if (const GlobalValue *GVEntry =
981 LinkedGlobalsMap[std::make_pair(I->getName(), I->getType())]) {
982 // If something else is the canonical global, ignore this one.
983 if (GVEntry != &*I) {
984 NonCanonicalGlobals.push_back(I);
985 continue;
986 }
987 }
988 }
989
Reid Spencer5cbf9852007-01-30 20:08:39 +0000990 if (!I->isDeclaration()) {
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000991 addGlobalMapping(I, getMemoryForGV(I));
Chris Lattnerfe854032006-08-16 01:24:12 +0000992 } else {
993 // External variable reference. Try to use the dynamic loader to
994 // get a pointer to it.
995 if (void *SymAddr =
Daniel Dunbarfbee5792009-07-21 08:54:24 +0000996 sys::DynamicLibrary::SearchForAddressOfSymbol(I->getName()))
Chris Lattnerfe854032006-08-16 01:24:12 +0000997 addGlobalMapping(I, SymAddr);
998 else {
Torok Edwin31e24662009-07-07 17:32:34 +0000999 llvm_report_error("Could not resolve external global address: "
1000 +I->getName());
Chris Lattnerfe854032006-08-16 01:24:12 +00001001 }
1002 }
1003 }
1004
1005 // If there are multiple modules, map the non-canonical globals to their
1006 // canonical location.
1007 if (!NonCanonicalGlobals.empty()) {
1008 for (unsigned i = 0, e = NonCanonicalGlobals.size(); i != e; ++i) {
1009 const GlobalValue *GV = NonCanonicalGlobals[i];
1010 const GlobalValue *CGV =
1011 LinkedGlobalsMap[std::make_pair(GV->getName(), GV->getType())];
1012 void *Ptr = getPointerToGlobalIfAvailable(CGV);
1013 assert(Ptr && "Canonical global wasn't codegen'd!");
Nuno Lopesc8ed9022008-10-14 10:04:52 +00001014 addGlobalMapping(GV, Ptr);
Chris Lattnerfe854032006-08-16 01:24:12 +00001015 }
1016 }
1017
Reid Spencera54b7cb2007-01-12 07:05:14 +00001018 // Now that all of the globals are set up in memory, loop through them all
1019 // and initialize their contents.
Chris Lattnerfe854032006-08-16 01:24:12 +00001020 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
1021 I != E; ++I) {
Reid Spencer5cbf9852007-01-30 20:08:39 +00001022 if (!I->isDeclaration()) {
Chris Lattnerfe854032006-08-16 01:24:12 +00001023 if (!LinkedGlobalsMap.empty()) {
1024 if (const GlobalValue *GVEntry =
1025 LinkedGlobalsMap[std::make_pair(I->getName(), I->getType())])
1026 if (GVEntry != &*I) // Not the canonical variable.
1027 continue;
1028 }
1029 EmitGlobalVariable(I);
1030 }
1031 }
1032 }
Chris Lattner24b0a182003-12-20 02:45:37 +00001033}
1034
1035// EmitGlobalVariable - This method emits the specified global variable to the
1036// address specified in GlobalAddresses, or allocates new memory if it's not
1037// already in the map.
Chris Lattnerc07ed132003-12-20 03:36:47 +00001038void ExecutionEngine::EmitGlobalVariable(const GlobalVariable *GV) {
Chris Lattner55d86482003-12-31 20:21:04 +00001039 void *GA = getPointerToGlobalIfAvailable(GV);
Chris Lattner23c47242004-02-08 19:33:23 +00001040
Chris Lattner24b0a182003-12-20 02:45:37 +00001041 if (GA == 0) {
1042 // If it's not already specified, allocate memory for the global.
Nicolas Geoffray46fa1392008-10-25 15:41:43 +00001043 GA = getMemoryForGV(GV);
Chris Lattner55d86482003-12-31 20:21:04 +00001044 addGlobalMapping(GV, GA);
Chris Lattner24b0a182003-12-20 02:45:37 +00001045 }
Nicolas Geoffray46fa1392008-10-25 15:41:43 +00001046
1047 // Don't initialize if it's thread local, let the client do it.
1048 if (!GV->isThreadLocal())
1049 InitializeMemory(GV->getInitializer(), GA);
1050
1051 const Type *ElTy = GV->getType()->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +00001052 size_t GVSize = (size_t)getTargetData()->getTypeAllocSize(ElTy);
Chris Lattner813c8152005-01-08 20:13:19 +00001053 NumInitBytes += (unsigned)GVSize;
Chris Lattner24b0a182003-12-20 02:45:37 +00001054 ++NumGlobals;
Chris Lattnerbd199fb2002-12-24 00:01:05 +00001055}