blob: 633a75ed61c5fa41bb9ef480dd1d338acc059447 [file] [log] [blame]
Chris Lattner4d326fa2003-12-20 01:46:27 +00001//===-- JIT.cpp - LLVM Just in Time Compiler ------------------------------===//
Misha Brukmanf976c852005-04-21 22:55:34 +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 Brukmanf976c852005-04-21 22:55:34 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnerbd199fb2002-12-24 00:01:05 +00009//
Chris Lattner4d326fa2003-12-20 01:46:27 +000010// This tool implements a just-in-time compiler for LLVM, allowing direct
Gabor Greifa99be512007-07-05 17:07:56 +000011// execution of LLVM bitcode in an efficient manner.
Chris Lattnerbd199fb2002-12-24 00:01:05 +000012//
13//===----------------------------------------------------------------------===//
14
Chris Lattner4d326fa2003-12-20 01:46:27 +000015#include "JIT.h"
Chris Lattnercc22e9f2004-08-16 00:14:18 +000016#include "llvm/Constants.h"
Chris Lattnerc07ed132003-12-20 03:36:47 +000017#include "llvm/DerivedTypes.h"
Chris Lattner4d326fa2003-12-20 01:46:27 +000018#include "llvm/Function.h"
Chris Lattnerc07ed132003-12-20 03:36:47 +000019#include "llvm/GlobalVariable.h"
Chris Lattnercc22e9f2004-08-16 00:14:18 +000020#include "llvm/Instructions.h"
Misha Brukman0f4f7d92003-10-16 21:19:34 +000021#include "llvm/ModuleProvider.h"
Chris Lattner4d326fa2003-12-20 01:46:27 +000022#include "llvm/CodeGen/MachineCodeEmitter.h"
Brian Gaeke97222942003-09-05 19:39:22 +000023#include "llvm/ExecutionEngine/GenericValue.h"
Owen Anderson07000c62006-05-12 06:33:49 +000024#include "llvm/Target/TargetData.h"
Chris Lattnerbd199fb2002-12-24 00:01:05 +000025#include "llvm/Target/TargetMachine.h"
Chris Lattner4d326fa2003-12-20 01:46:27 +000026#include "llvm/Target/TargetJITInfo.h"
Chris Lattner44e3dd12009-03-03 20:10:23 +000027#include "llvm/Support/Dwarf.h"
28#include "llvm/Support/MutexGuard.h"
29#include "llvm/System/DynamicLibrary.h"
Anton Korobeynikov3b30a6e2007-07-30 20:02:02 +000030#include "llvm/Config/config.h"
31
Chris Lattnerc19aade2003-12-08 08:06:28 +000032using namespace llvm;
Misha Brukmanabb027c2003-05-27 21:40:39 +000033
Nate Begemanb76ea742006-07-22 16:59:38 +000034#ifdef __APPLE__
Anton Korobeynikov3b30a6e2007-07-30 20:02:02 +000035// Apple gcc defaults to -fuse-cxa-atexit (i.e. calls __cxa_atexit instead
36// of atexit). It passes the address of linker generated symbol __dso_handle
37// to the function.
38// This configuration change happened at version 5330.
39# include <AvailabilityMacros.h>
40# if defined(MAC_OS_X_VERSION_10_4) && \
41 ((MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_4) || \
42 (MAC_OS_X_VERSION_MIN_REQUIRED == MAC_OS_X_VERSION_10_4 && \
43 __APPLE_CC__ >= 5330))
44# ifndef HAVE___DSO_HANDLE
45# define HAVE___DSO_HANDLE 1
46# endif
47# endif
Evan Cheng5f42c552006-07-21 23:06:20 +000048#endif
Anton Korobeynikov3b30a6e2007-07-30 20:02:02 +000049
50#if HAVE___DSO_HANDLE
51extern void *__dso_handle __attribute__ ((__visibility__ ("hidden")));
Nate Begemanb76ea742006-07-22 16:59:38 +000052#endif
Evan Cheng5f42c552006-07-21 23:06:20 +000053
Dan Gohman844731a2008-05-13 00:00:25 +000054namespace {
55
Chris Lattner2fe4bb02006-03-22 06:07:50 +000056static struct RegisterJIT {
57 RegisterJIT() { JIT::Register(); }
58} JITRegistrator;
59
Dan Gohman844731a2008-05-13 00:00:25 +000060}
61
Jeff Cohen2f519142006-03-24 02:53:49 +000062namespace llvm {
63 void LinkInJIT() {
64 }
65}
66
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +000067
Evan Cheng2d5424d2009-02-01 06:42:27 +000068#if defined(__GNUC__) && !defined(__ARM__EABI__)
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +000069
70// libgcc defines the __register_frame function to dynamically register new
71// dwarf frames for exception handling. This functionality is not portable
72// across compilers and is only provided by GCC. We use the __register_frame
73// function here so that code generated by the JIT cooperates with the unwinding
74// runtime of libgcc. When JITting with exception handling enable, LLVM
75// generates dwarf frames and registers it to libgcc with __register_frame.
76//
77// The __register_frame function works with Linux.
78//
79// Unfortunately, this functionality seems to be in libgcc after the unwinding
80// library of libgcc for darwin was written. The code for darwin overwrites the
81// value updated by __register_frame with a value fetched with "keymgr".
82// "keymgr" is an obsolete functionality, which should be rewritten some day.
83// In the meantime, since "keymgr" is on all libgccs shipped with apple-gcc, we
84// need a workaround in LLVM which uses the "keymgr" to dynamically modify the
85// values of an opaque key, used by libgcc to find dwarf tables.
86
Anton Korobeynikov299d9d72008-03-22 08:53:09 +000087extern "C" void __register_frame(void*);
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +000088
Evan Cheng2d5424d2009-02-01 06:42:27 +000089#if defined(__APPLE__)
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +000090
91namespace {
92
93// LibgccObject - This is the structure defined in libgcc. There is no #include
94// provided for this structure, so we also define it here. libgcc calls it
95// "struct object". The structure is undocumented in libgcc.
96struct LibgccObject {
97 void *unused1;
98 void *unused2;
99 void *unused3;
100
101 /// frame - Pointer to the exception table.
102 void *frame;
103
104 /// encoding - The encoding of the object?
105 union {
106 struct {
107 unsigned long sorted : 1;
108 unsigned long from_array : 1;
109 unsigned long mixed_encoding : 1;
110 unsigned long encoding : 8;
111 unsigned long count : 21;
112 } b;
113 size_t i;
114 } encoding;
115
116 /// fde_end - libgcc defines this field only if some macro is defined. We
117 /// include this field even if it may not there, to make libgcc happy.
118 char *fde_end;
119
120 /// next - At least we know it's a chained list!
121 struct LibgccObject *next;
122};
123
124// "kemgr" stuff. Apparently, all frame tables are stored there.
125extern "C" void _keymgr_set_and_unlock_processwide_ptr(int, void *);
126extern "C" void *_keymgr_get_and_lock_processwide_ptr(int);
127#define KEYMGR_GCC3_DW2_OBJ_LIST 302 /* Dwarf2 object list */
128
129/// LibgccObjectInfo - libgcc defines this struct as km_object_info. It
130/// probably contains all dwarf tables that are loaded.
131struct LibgccObjectInfo {
132
133 /// seenObjects - LibgccObjects already parsed by the unwinding runtime.
134 ///
135 struct LibgccObject* seenObjects;
136
137 /// unseenObjects - LibgccObjects not parsed yet by the unwinding runtime.
138 ///
139 struct LibgccObject* unseenObjects;
140
141 unsigned unused[2];
142};
143
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000144/// darwin_register_frame - Since __register_frame does not work with darwin's
145/// libgcc,we provide our own function, which "tricks" libgcc by modifying the
146/// "Dwarf2 object list" key.
147void DarwinRegisterFrame(void* FrameBegin) {
148 // Get the key.
Chris Lattner44e3dd12009-03-03 20:10:23 +0000149 LibgccObjectInfo* LOI = (struct LibgccObjectInfo*)
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000150 _keymgr_get_and_lock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST);
Chris Lattner44e3dd12009-03-03 20:10:23 +0000151 assert(LOI && "This should be preallocated by the runtime");
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000152
153 // Allocate a new LibgccObject to represent this frame. Deallocation of this
154 // object may be impossible: since darwin code in libgcc was written after
155 // the ability to dynamically register frames, things may crash if we
156 // deallocate it.
157 struct LibgccObject* ob = (struct LibgccObject*)
158 malloc(sizeof(struct LibgccObject));
159
160 // Do like libgcc for the values of the field.
161 ob->unused1 = (void *)-1;
162 ob->unused2 = 0;
163 ob->unused3 = 0;
164 ob->frame = FrameBegin;
165 ob->encoding.i = 0;
166 ob->encoding.b.encoding = llvm::dwarf::DW_EH_PE_omit;
167
168 // Put the info on both places, as libgcc uses the first or the the second
169 // field. Note that we rely on having two pointers here. If fde_end was a
170 // char, things would get complicated.
171 ob->fde_end = (char*)LOI->unseenObjects;
172 ob->next = LOI->unseenObjects;
173
174 // Update the key's unseenObjects list.
175 LOI->unseenObjects = ob;
176
177 // Finally update the "key". Apparently, libgcc requires it.
178 _keymgr_set_and_unlock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST,
179 LOI);
180
181}
182
183}
184#endif // __APPLE__
185#endif // __GNUC__
Anton Korobeynikov299d9d72008-03-22 08:53:09 +0000186
Chris Lattner34c94332007-12-06 01:34:04 +0000187/// createJIT - This is the factory method for creating a JIT for the current
188/// machine, it does not fall back to the interpreter. This takes ownership
189/// of the module provider.
190ExecutionEngine *ExecutionEngine::createJIT(ModuleProvider *MP,
191 std::string *ErrorStr,
Evan Cheng502f20b2008-08-08 08:11:34 +0000192 JITMemoryManager *JMM,
193 bool Fast) {
194 ExecutionEngine *EE = JIT::createJIT(MP, ErrorStr, JMM, Fast);
Chris Lattner34c94332007-12-06 01:34:04 +0000195 if (!EE) return 0;
196
Chris Lattner34c94332007-12-06 01:34:04 +0000197 // Make sure we can resolve symbols in the program as well. The zero arg
198 // to the function tells DynamicLibrary to load the program, not a library.
199 sys::DynamicLibrary::LoadLibraryPermanently(0, ErrorStr);
200 return EE;
201}
202
203JIT::JIT(ModuleProvider *MP, TargetMachine &tm, TargetJITInfo &tji,
Evan Cheng502f20b2008-08-08 08:11:34 +0000204 JITMemoryManager *JMM, bool Fast)
Nate Begemanf049e072008-05-21 16:34:48 +0000205 : ExecutionEngine(MP), TM(tm), TJI(tji) {
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000206 setTargetData(TM.getTargetData());
Misha Brukmanabb027c2003-05-27 21:40:39 +0000207
Nate Begemanf049e072008-05-21 16:34:48 +0000208 jitstate = new JITState(MP);
209
Misha Brukmanabb027c2003-05-27 21:40:39 +0000210 // Initialize MCE
Chris Lattner34c94332007-12-06 01:34:04 +0000211 MCE = createEmitter(*this, JMM);
Misha Brukmanf976c852005-04-21 22:55:34 +0000212
Brian Gaeke50872d52004-04-14 17:45:52 +0000213 // Add target data
Reid Spenceree448632005-07-12 15:51:55 +0000214 MutexGuard locked(lock);
Nate Begemanf049e072008-05-21 16:34:48 +0000215 FunctionPassManager &PM = jitstate->getPM(locked);
Chris Lattnerb93b0342006-05-04 21:18:40 +0000216 PM.add(new TargetData(*TM.getTargetData()));
Brian Gaeke50872d52004-04-14 17:45:52 +0000217
Chris Lattner4d326fa2003-12-20 01:46:27 +0000218 // Turn the machine code intermediate representation into bytes in memory that
219 // may be executed.
Evan Cheng502f20b2008-08-08 08:11:34 +0000220 if (TM.addPassesToEmitMachineCode(PM, *MCE, Fast)) {
Bill Wendling832171c2006-12-07 20:04:42 +0000221 cerr << "Target does not support machine code emission!\n";
Chris Lattner4d326fa2003-12-20 01:46:27 +0000222 abort();
223 }
Chris Lattner1911fd42006-09-04 04:14:57 +0000224
Nicolas Geoffraya7ec87c2008-08-18 14:53:56 +0000225 // Register routine for informing unwinding runtime about new EH frames
Evan Cheng2d5424d2009-02-01 06:42:27 +0000226#if defined(__GNUC__) && !defined(__ARM_EABI__)
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000227#if defined(__APPLE__)
228 struct LibgccObjectInfo* LOI = (struct LibgccObjectInfo*)
229 _keymgr_get_and_lock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST);
230
231 // The key is created on demand, and libgcc creates it the first time an
232 // exception occurs. Since we need the key to register frames, we create
233 // it now.
234 if (!LOI) {
235 LOI = (LibgccObjectInfo*)malloc(sizeof(struct LibgccObjectInfo));
236 _keymgr_set_and_unlock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST,
237 LOI);
238 }
239 InstallExceptionTableRegister(DarwinRegisterFrame);
240#else
Nicolas Geoffraya7ec87c2008-08-18 14:53:56 +0000241 InstallExceptionTableRegister(__register_frame);
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000242#endif // __APPLE__
243#endif // __GNUC__
Nicolas Geoffraya7ec87c2008-08-18 14:53:56 +0000244
Chris Lattner1911fd42006-09-04 04:14:57 +0000245 // Initialize passes.
246 PM.doInitialization();
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000247}
248
Chris Lattner4d326fa2003-12-20 01:46:27 +0000249JIT::~JIT() {
Nate Begemanf049e072008-05-21 16:34:48 +0000250 delete jitstate;
Chris Lattner4d326fa2003-12-20 01:46:27 +0000251 delete MCE;
252 delete &TM;
253}
254
Nate Begemanf049e072008-05-21 16:34:48 +0000255/// addModuleProvider - Add a new ModuleProvider to the JIT. If we previously
256/// removed the last ModuleProvider, we need re-initialize jitstate with a valid
257/// ModuleProvider.
258void JIT::addModuleProvider(ModuleProvider *MP) {
259 MutexGuard locked(lock);
260
261 if (Modules.empty()) {
262 assert(!jitstate && "jitstate should be NULL if Modules vector is empty!");
263
264 jitstate = new JITState(MP);
265
266 FunctionPassManager &PM = jitstate->getPM(locked);
267 PM.add(new TargetData(*TM.getTargetData()));
268
269 // Turn the machine code intermediate representation into bytes in memory
270 // that may be executed.
271 if (TM.addPassesToEmitMachineCode(PM, *MCE, false /*fast*/)) {
272 cerr << "Target does not support machine code emission!\n";
273 abort();
274 }
275
276 // Initialize passes.
277 PM.doInitialization();
278 }
279
280 ExecutionEngine::addModuleProvider(MP);
281}
282
283/// removeModuleProvider - If we are removing the last ModuleProvider,
284/// invalidate the jitstate since the PassManager it contains references a
285/// released ModuleProvider.
286Module *JIT::removeModuleProvider(ModuleProvider *MP, std::string *E) {
287 Module *result = ExecutionEngine::removeModuleProvider(MP, E);
288
289 MutexGuard locked(lock);
Nate Begemand6b7a242009-02-18 08:31:02 +0000290
291 if (jitstate->getMP() == MP) {
Nate Begemanf049e072008-05-21 16:34:48 +0000292 delete jitstate;
293 jitstate = 0;
294 }
295
Nate Begemand6b7a242009-02-18 08:31:02 +0000296 if (!jitstate && !Modules.empty()) {
297 jitstate = new JITState(Modules[0]);
298
299 FunctionPassManager &PM = jitstate->getPM(locked);
300 PM.add(new TargetData(*TM.getTargetData()));
301
302 // Turn the machine code intermediate representation into bytes in memory
303 // that may be executed.
304 if (TM.addPassesToEmitMachineCode(PM, *MCE, false /*fast*/)) {
305 cerr << "Target does not support machine code emission!\n";
306 abort();
307 }
308
309 // Initialize passes.
310 PM.doInitialization();
311 }
Nate Begemanf049e072008-05-21 16:34:48 +0000312 return result;
313}
314
Nate Begeman60789e42009-01-23 19:27:28 +0000315/// deleteModuleProvider - Remove a ModuleProvider from the list of modules,
316/// and deletes the ModuleProvider and owned Module. Avoids materializing
317/// the underlying module.
318void JIT::deleteModuleProvider(ModuleProvider *MP, std::string *E) {
319 ExecutionEngine::deleteModuleProvider(MP, E);
320
321 MutexGuard locked(lock);
Nate Begemand6b7a242009-02-18 08:31:02 +0000322
323 if (jitstate->getMP() == MP) {
Nate Begeman60789e42009-01-23 19:27:28 +0000324 delete jitstate;
325 jitstate = 0;
326 }
Nate Begemand6b7a242009-02-18 08:31:02 +0000327
328 if (!jitstate && !Modules.empty()) {
329 jitstate = new JITState(Modules[0]);
330
331 FunctionPassManager &PM = jitstate->getPM(locked);
332 PM.add(new TargetData(*TM.getTargetData()));
333
334 // Turn the machine code intermediate representation into bytes in memory
335 // that may be executed.
336 if (TM.addPassesToEmitMachineCode(PM, *MCE, false /*fast*/)) {
337 cerr << "Target does not support machine code emission!\n";
338 abort();
339 }
340
341 // Initialize passes.
342 PM.doInitialization();
343 }
Nate Begeman60789e42009-01-23 19:27:28 +0000344}
345
Brian Gaeke70975ee2003-09-05 18:42:01 +0000346/// run - Start execution with the specified function and arguments.
Chris Lattner05a1a302003-08-21 21:32:12 +0000347///
Chris Lattnerff0f1bb2003-12-26 06:13:47 +0000348GenericValue JIT::runFunction(Function *F,
349 const std::vector<GenericValue> &ArgValues) {
Chris Lattnerb47130c2004-08-15 23:29:50 +0000350 assert(F && "Function *F was null at entry to run()");
Chris Lattnerb47130c2004-08-15 23:29:50 +0000351
352 void *FPtr = getPointerToFunction(F);
Chris Lattner7c45d782004-08-15 23:31:43 +0000353 assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000354 const FunctionType *FTy = F->getFunctionType();
Chris Lattnere5eab142004-08-15 23:53:06 +0000355 const Type *RetTy = FTy->getReturnType();
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000356
Dan Gohman07ab52b2009-02-19 02:55:18 +0000357 assert((FTy->getNumParams() == ArgValues.size() ||
358 (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
359 "Wrong number of arguments passed into function!");
Chris Lattnere5eab142004-08-15 23:53:06 +0000360 assert(FTy->getNumParams() == ArgValues.size() &&
361 "This doesn't support passing arguments through varargs (yet)!");
362
Misha Brukmanec843022004-10-22 23:35:57 +0000363 // Handle some common cases first. These cases correspond to common `main'
Chris Lattnere5eab142004-08-15 23:53:06 +0000364 // prototypes.
Chris Lattner79e038a2007-08-08 16:19:57 +0000365 if (RetTy == Type::Int32Ty || RetTy == Type::VoidTy) {
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000366 switch (ArgValues.size()) {
367 case 3:
Chris Lattner79e038a2007-08-08 16:19:57 +0000368 if (FTy->getParamType(0) == Type::Int32Ty &&
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000369 isa<PointerType>(FTy->getParamType(1)) &&
370 isa<PointerType>(FTy->getParamType(2))) {
371 int (*PF)(int, char **, const char **) =
Chris Lattner870286a2006-06-01 17:29:22 +0000372 (int(*)(int, char **, const char **))(intptr_t)FPtr;
Misha Brukmanec843022004-10-22 23:35:57 +0000373
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000374 // Call the function.
Chris Lattnere5eab142004-08-15 23:53:06 +0000375 GenericValue rv;
Reid Spencer38f6a152007-03-06 03:11:31 +0000376 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
377 (char **)GVTOP(ArgValues[1]),
378 (const char **)GVTOP(ArgValues[2])));
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000379 return rv;
380 }
381 break;
Chris Lattner174f2262004-08-16 01:07:04 +0000382 case 2:
Chris Lattner79e038a2007-08-08 16:19:57 +0000383 if (FTy->getParamType(0) == Type::Int32Ty &&
Chris Lattner174f2262004-08-16 01:07:04 +0000384 isa<PointerType>(FTy->getParamType(1))) {
Chris Lattner870286a2006-06-01 17:29:22 +0000385 int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
Misha Brukmanec843022004-10-22 23:35:57 +0000386
Chris Lattner174f2262004-08-16 01:07:04 +0000387 // Call the function.
388 GenericValue rv;
Reid Spencer38f6a152007-03-06 03:11:31 +0000389 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
390 (char **)GVTOP(ArgValues[1])));
Chris Lattner174f2262004-08-16 01:07:04 +0000391 return rv;
392 }
393 break;
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000394 case 1:
395 if (FTy->getNumParams() == 1 &&
Chris Lattner79e038a2007-08-08 16:19:57 +0000396 FTy->getParamType(0) == Type::Int32Ty) {
Chris Lattnere5eab142004-08-15 23:53:06 +0000397 GenericValue rv;
Chris Lattner870286a2006-06-01 17:29:22 +0000398 int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
Reid Spencer38f6a152007-03-06 03:11:31 +0000399 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000400 return rv;
401 }
402 break;
Chris Lattnere5eab142004-08-15 23:53:06 +0000403 }
404 }
405
406 // Handle cases where no arguments are passed first.
407 if (ArgValues.empty()) {
408 GenericValue rv;
409 switch (RetTy->getTypeID()) {
410 default: assert(0 && "Unknown return type for function call!");
Reid Spencera54b7cb2007-01-12 07:05:14 +0000411 case Type::IntegerTyID: {
412 unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
413 if (BitWidth == 1)
Reid Spencer38f6a152007-03-06 03:11:31 +0000414 rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000415 else if (BitWidth <= 8)
Reid Spencer38f6a152007-03-06 03:11:31 +0000416 rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000417 else if (BitWidth <= 16)
Reid Spencer38f6a152007-03-06 03:11:31 +0000418 rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000419 else if (BitWidth <= 32)
Reid Spencer38f6a152007-03-06 03:11:31 +0000420 rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000421 else if (BitWidth <= 64)
Reid Spencer38f6a152007-03-06 03:11:31 +0000422 rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000423 else
424 assert(0 && "Integer types > 64 bits not supported");
Chris Lattnerd297aea2004-08-15 23:34:48 +0000425 return rv;
Reid Spencera54b7cb2007-01-12 07:05:14 +0000426 }
Chris Lattnere5eab142004-08-15 23:53:06 +0000427 case Type::VoidTyID:
Reid Spencer38f6a152007-03-06 03:11:31 +0000428 rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
Chris Lattnere5eab142004-08-15 23:53:06 +0000429 return rv;
Chris Lattnere5eab142004-08-15 23:53:06 +0000430 case Type::FloatTyID:
Chris Lattner870286a2006-06-01 17:29:22 +0000431 rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
Chris Lattnere5eab142004-08-15 23:53:06 +0000432 return rv;
433 case Type::DoubleTyID:
Chris Lattner870286a2006-06-01 17:29:22 +0000434 rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
Chris Lattnere5eab142004-08-15 23:53:06 +0000435 return rv;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000436 case Type::X86_FP80TyID:
437 case Type::FP128TyID:
438 case Type::PPC_FP128TyID:
439 assert(0 && "long double not supported yet");
440 return rv;
Chris Lattnere5eab142004-08-15 23:53:06 +0000441 case Type::PointerTyID:
Chris Lattner870286a2006-06-01 17:29:22 +0000442 return PTOGV(((void*(*)())(intptr_t)FPtr)());
Chris Lattnerd297aea2004-08-15 23:34:48 +0000443 }
Chris Lattnerff0f1bb2003-12-26 06:13:47 +0000444 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000445
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000446 // Okay, this is not one of our quick and easy cases. Because we don't have a
447 // full FFI, we have to codegen a nullary stub function that just calls the
448 // function we are interested in, passing in constants for all of the
449 // arguments. Make this function and return.
450
451 // First, create the function.
452 FunctionType *STy=FunctionType::get(RetTy, std::vector<const Type*>(), false);
Gabor Greif051a9502008-04-06 20:25:17 +0000453 Function *Stub = Function::Create(STy, Function::InternalLinkage, "",
454 F->getParent());
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000455
456 // Insert a basic block.
Gabor Greif051a9502008-04-06 20:25:17 +0000457 BasicBlock *StubBB = BasicBlock::Create("", Stub);
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000458
459 // Convert all of the GenericValue arguments over to constants. Note that we
460 // currently don't support varargs.
Chris Lattner990b8492007-02-13 06:01:22 +0000461 SmallVector<Value*, 8> Args;
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000462 for (unsigned i = 0, e = ArgValues.size(); i != e; ++i) {
463 Constant *C = 0;
464 const Type *ArgTy = FTy->getParamType(i);
465 const GenericValue &AV = ArgValues[i];
466 switch (ArgTy->getTypeID()) {
467 default: assert(0 && "Unknown argument type for function call!");
Chris Lattner02a260a2008-04-20 00:41:09 +0000468 case Type::IntegerTyID:
469 C = ConstantInt::get(AV.IntVal);
470 break;
471 case Type::FloatTyID:
472 C = ConstantFP::get(APFloat(AV.FloatVal));
473 break;
474 case Type::DoubleTyID:
475 C = ConstantFP::get(APFloat(AV.DoubleVal));
476 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000477 case Type::PPC_FP128TyID:
478 case Type::X86_FP80TyID:
Chris Lattner02a260a2008-04-20 00:41:09 +0000479 case Type::FP128TyID:
480 C = ConstantFP::get(APFloat(AV.IntVal));
481 break;
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000482 case Type::PointerTyID:
483 void *ArgPtr = GVTOP(AV);
Chris Lattner02a260a2008-04-20 00:41:09 +0000484 if (sizeof(void*) == 4)
Reid Spencere49661b2006-12-31 05:51:36 +0000485 C = ConstantInt::get(Type::Int32Ty, (int)(intptr_t)ArgPtr);
Chris Lattner02a260a2008-04-20 00:41:09 +0000486 else
Reid Spencere49661b2006-12-31 05:51:36 +0000487 C = ConstantInt::get(Type::Int64Ty, (intptr_t)ArgPtr);
Reid Spencer15f46d62006-12-12 01:17:41 +0000488 C = ConstantExpr::getIntToPtr(C, ArgTy); // Cast the integer to pointer
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000489 break;
490 }
491 Args.push_back(C);
492 }
493
Gabor Greifb1dbcd82008-05-15 10:04:30 +0000494 CallInst *TheCall = CallInst::Create(F, Args.begin(), Args.end(),
495 "", StubBB);
Chris Lattnercdfc51f2008-11-23 08:00:11 +0000496 TheCall->setCallingConv(F->getCallingConv());
Chris Lattnera471e042005-05-06 06:48:54 +0000497 TheCall->setTailCall();
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000498 if (TheCall->getType() != Type::VoidTy)
Gabor Greifb1dbcd82008-05-15 10:04:30 +0000499 ReturnInst::Create(TheCall, StubBB); // Return result of the call.
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000500 else
Gabor Greifb1dbcd82008-05-15 10:04:30 +0000501 ReturnInst::Create(StubBB); // Just return void.
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000502
503 // Finally, return the value returned by our nullary stub function.
504 return runFunction(Stub, std::vector<GenericValue>());
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000505}
Chris Lattner4d326fa2003-12-20 01:46:27 +0000506
507/// runJITOnFunction - Run the FunctionPassManager full of
508/// just-in-time compilation passes on F, hopefully filling in
509/// GlobalAddress[F] with the address of F's machine code.
510///
511void JIT::runJITOnFunction(Function *F) {
Reid Spenceree448632005-07-12 15:51:55 +0000512 MutexGuard locked(lock);
Dan Gohman21afcda2009-02-06 21:25:08 +0000513 runJITOnFunctionUnlocked(F, locked);
514}
515
516void JIT::runJITOnFunctionUnlocked(Function *F, const MutexGuard &locked) {
517 static bool isAlreadyCodeGenerating = false;
Chris Lattner17f218e2007-08-13 20:08:16 +0000518 assert(!isAlreadyCodeGenerating && "Error: Recursive compilation detected!");
Chris Lattner4d326fa2003-12-20 01:46:27 +0000519
520 // JIT the function
521 isAlreadyCodeGenerating = true;
Nate Begemanf049e072008-05-21 16:34:48 +0000522 jitstate->getPM(locked).run(*F);
Chris Lattner4d326fa2003-12-20 01:46:27 +0000523 isAlreadyCodeGenerating = false;
Chris Lattnerc07ed132003-12-20 03:36:47 +0000524
Nate Begemand6b7a242009-02-18 08:31:02 +0000525 // If the function referred to another function that had not yet been
526 // read from bitcode, but we are jitting non-lazily, emit it now.
527 while (!jitstate->getPendingFunctions(locked).empty()) {
528 Function *PF = jitstate->getPendingFunctions(locked).back();
529 jitstate->getPendingFunctions(locked).pop_back();
530
531 // JIT the function
532 isAlreadyCodeGenerating = true;
533 jitstate->getPM(locked).run(*PF);
534 isAlreadyCodeGenerating = false;
535
536 // Now that the function has been jitted, ask the JITEmitter to rewrite
537 // the stub with real address of the function.
538 updateFunctionStub(PF);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000539 }
Nate Begemand6b7a242009-02-18 08:31:02 +0000540
541 // If the JIT is configured to emit info so that dlsym can be used to
542 // rewrite stubs to external globals, do so now.
543 if (areDlsymStubsEnabled() && isLazyCompilationDisabled())
544 updateDlsymStubTable();
Chris Lattner4d326fa2003-12-20 01:46:27 +0000545}
546
547/// getPointerToFunction - This method is used to get the address of the
548/// specified function, compiling it if neccesary.
549///
550void *JIT::getPointerToFunction(Function *F) {
Reid Spenceree448632005-07-12 15:51:55 +0000551
Chris Lattnerc07ed132003-12-20 03:36:47 +0000552 if (void *Addr = getPointerToGlobalIfAvailable(F))
553 return Addr; // Check if function already code gen'd
Chris Lattner4d326fa2003-12-20 01:46:27 +0000554
Dan Gohmana3ac0c12009-02-19 02:40:15 +0000555 MutexGuard locked(lock);
556
Chris Lattnerfe854032006-08-16 01:24:12 +0000557 // Make sure we read in the function if it exists in this Module.
Gabor Greifa99be512007-07-05 17:07:56 +0000558 if (F->hasNotBeenReadFromBitcode()) {
Chris Lattnerfe854032006-08-16 01:24:12 +0000559 // Determine the module provider this function is provided by.
560 Module *M = F->getParent();
561 ModuleProvider *MP = 0;
562 for (unsigned i = 0, e = Modules.size(); i != e; ++i) {
563 if (Modules[i]->getModule() == M) {
564 MP = Modules[i];
565 break;
566 }
567 }
568 assert(MP && "Function isn't in a module we know about!");
569
Chris Lattner5c72a3a2006-07-07 17:18:09 +0000570 std::string ErrorMsg;
571 if (MP->materializeFunction(F, &ErrorMsg)) {
Bill Wendling832171c2006-12-07 20:04:42 +0000572 cerr << "Error reading function '" << F->getName()
Gabor Greifa99be512007-07-05 17:07:56 +0000573 << "' from bitcode file: " << ErrorMsg << "\n";
Chris Lattner0050ef82004-11-15 23:18:09 +0000574 abort();
575 }
Mon P Wang1c341c82008-10-10 01:47:42 +0000576
Dan Gohman69f93782009-01-05 05:32:42 +0000577 // Now retry to get the address.
578 if (void *Addr = getPointerToGlobalIfAvailable(F))
579 return Addr;
Nicolas Geoffrayfd7d9912008-04-20 08:33:02 +0000580 }
Chris Lattner4d326fa2003-12-20 01:46:27 +0000581
Reid Spencer5cbf9852007-01-30 20:08:39 +0000582 if (F->isDeclaration()) {
Dan Gohman69f93782009-01-05 05:32:42 +0000583 bool AbortOnFailure = F->getLinkage() != GlobalValue::ExternalWeakLinkage;
584 void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000585 addGlobalMapping(F, Addr);
586 return Addr;
587 }
Chris Lattner4d326fa2003-12-20 01:46:27 +0000588
Dan Gohman21afcda2009-02-06 21:25:08 +0000589 runJITOnFunctionUnlocked(F, locked);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000590
591 void *Addr = getPointerToGlobalIfAvailable(F);
Chris Lattner4d326fa2003-12-20 01:46:27 +0000592 assert(Addr && "Code generation didn't add function to GlobalAddress table!");
593 return Addr;
594}
595
Chris Lattnerc07ed132003-12-20 03:36:47 +0000596/// getOrEmitGlobalVariable - Return the address of the specified global
597/// variable, possibly emitting it to memory if needed. This is used by the
598/// Emitter.
599void *JIT::getOrEmitGlobalVariable(const GlobalVariable *GV) {
Reid Spenceree448632005-07-12 15:51:55 +0000600 MutexGuard locked(lock);
601
Chris Lattnerc07ed132003-12-20 03:36:47 +0000602 void *Ptr = getPointerToGlobalIfAvailable(GV);
603 if (Ptr) return Ptr;
604
605 // If the global is external, just remember the address.
Reid Spencer5cbf9852007-01-30 20:08:39 +0000606 if (GV->isDeclaration()) {
Anton Korobeynikov3b30a6e2007-07-30 20:02:02 +0000607#if HAVE___DSO_HANDLE
Evan Cheng5f42c552006-07-21 23:06:20 +0000608 if (GV->getName() == "__dso_handle")
609 return (void*)&__dso_handle;
Evan Chengb82ab942006-07-22 00:42:03 +0000610#endif
Reid Spencerdf5a37e2004-11-29 14:11:29 +0000611 Ptr = sys::DynamicLibrary::SearchForAddressOfSymbol(GV->getName().c_str());
Nate Begeman66941982009-03-04 19:10:38 +0000612 if (Ptr == 0 && !areDlsymStubsEnabled()) {
Bill Wendling832171c2006-12-07 20:04:42 +0000613 cerr << "Could not resolve external global address: "
614 << GV->getName() << "\n";
Chris Lattnerc07ed132003-12-20 03:36:47 +0000615 abort();
616 }
Nate Begeman66941982009-03-04 19:10:38 +0000617 addGlobalMapping(GV, Ptr);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000618 } else {
Evan Cheng4d544a22009-01-16 19:14:49 +0000619 // GlobalVariable's which are not "constant" will cause trouble in a server
620 // situation. It's returned in the same block of memory as code which may
621 // not be writable.
622 if (isGVCompilationDisabled() && !GV->isConstant()) {
Evan Cheng77f86ad2008-12-09 07:31:49 +0000623 cerr << "Compilation of non-internal GlobalValue is disabled!\n";
Evan Cheng446531e2008-09-24 16:25:55 +0000624 abort();
625 }
Dale Johannesendd947ea2008-08-07 01:30:15 +0000626 // If the global hasn't been emitted to memory yet, allocate space and
627 // emit it into memory. It goes in the same array as the generated
628 // code, jump tables, etc.
Chris Lattnerf5d438c2006-05-02 21:57:51 +0000629 const Type *GlobalType = GV->getType()->getElementType();
Duncan Sandsceb4d1a2009-01-12 20:38:59 +0000630 size_t S = getTargetData()->getTypePaddedSize(GlobalType);
Duncan Sandsd1025932008-01-29 06:23:44 +0000631 size_t A = getTargetData()->getPreferredAlignment(GV);
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000632 if (GV->isThreadLocal()) {
633 MutexGuard locked(lock);
634 Ptr = TJI.allocateThreadLocalMemory(S);
Evan Chengb0b53492008-11-04 09:30:48 +0000635 } else if (TJI.allocateSeparateGVMemory()) {
636 if (A <= 8) {
637 Ptr = malloc(S);
638 } else {
639 // Allocate S+A bytes of memory, then use an aligned pointer within that
640 // space.
641 Ptr = malloc(S+A);
642 unsigned MisAligned = ((intptr_t)Ptr & (A-1));
643 Ptr = (char*)Ptr + (MisAligned ? (A-MisAligned) : 0);
644 }
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000645 } else {
646 Ptr = MCE->allocateSpace(S, A);
647 }
Dale Johannesendd947ea2008-08-07 01:30:15 +0000648 addGlobalMapping(GV, Ptr);
649 EmitGlobalVariable(GV);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000650 }
Chris Lattnerc07ed132003-12-20 03:36:47 +0000651 return Ptr;
652}
653
Chris Lattner4d326fa2003-12-20 01:46:27 +0000654/// recompileAndRelinkFunction - This method is used to force a function
655/// which has already been compiled, to be compiled again, possibly
656/// after it has been modified. Then the entry to the old copy is overwritten
657/// with a branch to the new copy. If there was no old copy, this acts
658/// just like JIT::getPointerToFunction().
659///
660void *JIT::recompileAndRelinkFunction(Function *F) {
Chris Lattnerc07ed132003-12-20 03:36:47 +0000661 void *OldAddr = getPointerToGlobalIfAvailable(F);
Chris Lattner4d326fa2003-12-20 01:46:27 +0000662
Chris Lattnerc07ed132003-12-20 03:36:47 +0000663 // If it's not already compiled there is no reason to patch it up.
664 if (OldAddr == 0) { return getPointerToFunction(F); }
Chris Lattner4d326fa2003-12-20 01:46:27 +0000665
Chris Lattnerc07ed132003-12-20 03:36:47 +0000666 // Delete the old function mapping.
667 addGlobalMapping(F, 0);
668
Chris Lattnerc07ed132003-12-20 03:36:47 +0000669 // Recodegen the function
Chris Lattner4d326fa2003-12-20 01:46:27 +0000670 runJITOnFunction(F);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000671
672 // Update state, forward the old function to the new function.
673 void *Addr = getPointerToGlobalIfAvailable(F);
Chris Lattner4d326fa2003-12-20 01:46:27 +0000674 assert(Addr && "Code generation didn't add function to GlobalAddress table!");
675 TJI.replaceMachineCodeForFunction(OldAddr, Addr);
676 return Addr;
677}
Misha Brukman895eddf2004-11-07 23:58:46 +0000678
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000679/// getMemoryForGV - This method abstracts memory allocation of global
680/// variable so that the JIT can allocate thread local variables depending
681/// on the target.
682///
683char* JIT::getMemoryForGV(const GlobalVariable* GV) {
684 const Type *ElTy = GV->getType()->getElementType();
Duncan Sandsceb4d1a2009-01-12 20:38:59 +0000685 size_t GVSize = (size_t)getTargetData()->getTypePaddedSize(ElTy);
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000686 if (GV->isThreadLocal()) {
687 MutexGuard locked(lock);
688 return TJI.allocateThreadLocalMemory(GVSize);
689 } else {
690 return new char[GVSize];
691 }
692}
Nate Begemand6b7a242009-02-18 08:31:02 +0000693
694void JIT::addPendingFunction(Function *F) {
695 MutexGuard locked(lock);
696 jitstate->getPendingFunctions(locked).push_back(F);
697}