blob: 785b5b9284f90dffe8a80a35e69497401009e47c [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"
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +000022#include "llvm/CodeGen/JITCodeEmitter.h"
Argyrios Kyrtzidisb3a847d2009-05-18 21:06:40 +000023#include "llvm/CodeGen/MachineCodeInfo.h"
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +000024#include "llvm/ExecutionEngine/GenericValue.h"
25#include "llvm/ExecutionEngine/JITEventListener.h"
Owen Anderson07000c62006-05-12 06:33:49 +000026#include "llvm/Target/TargetData.h"
Chris Lattnerbd199fb2002-12-24 00:01:05 +000027#include "llvm/Target/TargetMachine.h"
Chris Lattner4d326fa2003-12-20 01:46:27 +000028#include "llvm/Target/TargetJITInfo.h"
Chris Lattner44e3dd12009-03-03 20:10:23 +000029#include "llvm/Support/Dwarf.h"
Torok Edwin31e24662009-07-07 17:32:34 +000030#include "llvm/Support/ErrorHandling.h"
Chris Lattner44e3dd12009-03-03 20:10:23 +000031#include "llvm/Support/MutexGuard.h"
32#include "llvm/System/DynamicLibrary.h"
Anton Korobeynikov3b30a6e2007-07-30 20:02:02 +000033#include "llvm/Config/config.h"
34
Chris Lattnerc19aade2003-12-08 08:06:28 +000035using namespace llvm;
Misha Brukmanabb027c2003-05-27 21:40:39 +000036
Nate Begemanb76ea742006-07-22 16:59:38 +000037#ifdef __APPLE__
Anton Korobeynikov3b30a6e2007-07-30 20:02:02 +000038// Apple gcc defaults to -fuse-cxa-atexit (i.e. calls __cxa_atexit instead
39// of atexit). It passes the address of linker generated symbol __dso_handle
40// to the function.
41// This configuration change happened at version 5330.
42# include <AvailabilityMacros.h>
43# if defined(MAC_OS_X_VERSION_10_4) && \
44 ((MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_4) || \
45 (MAC_OS_X_VERSION_MIN_REQUIRED == MAC_OS_X_VERSION_10_4 && \
46 __APPLE_CC__ >= 5330))
47# ifndef HAVE___DSO_HANDLE
48# define HAVE___DSO_HANDLE 1
49# endif
50# endif
Evan Cheng5f42c552006-07-21 23:06:20 +000051#endif
Anton Korobeynikov3b30a6e2007-07-30 20:02:02 +000052
53#if HAVE___DSO_HANDLE
54extern void *__dso_handle __attribute__ ((__visibility__ ("hidden")));
Nate Begemanb76ea742006-07-22 16:59:38 +000055#endif
Evan Cheng5f42c552006-07-21 23:06:20 +000056
Dan Gohman844731a2008-05-13 00:00:25 +000057namespace {
58
Chris Lattner2fe4bb02006-03-22 06:07:50 +000059static struct RegisterJIT {
60 RegisterJIT() { JIT::Register(); }
61} JITRegistrator;
62
Dan Gohman844731a2008-05-13 00:00:25 +000063}
64
Bob Wilsone46161f2009-06-24 21:09:18 +000065extern "C" void LLVMLinkInJIT() {
Jeff Cohen2f519142006-03-24 02:53:49 +000066}
67
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +000068
Evan Cheng2d5424d2009-02-01 06:42:27 +000069#if defined(__GNUC__) && !defined(__ARM__EABI__)
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +000070
71// libgcc defines the __register_frame function to dynamically register new
72// dwarf frames for exception handling. This functionality is not portable
73// across compilers and is only provided by GCC. We use the __register_frame
74// function here so that code generated by the JIT cooperates with the unwinding
75// runtime of libgcc. When JITting with exception handling enable, LLVM
76// generates dwarf frames and registers it to libgcc with __register_frame.
77//
78// The __register_frame function works with Linux.
79//
80// Unfortunately, this functionality seems to be in libgcc after the unwinding
81// library of libgcc for darwin was written. The code for darwin overwrites the
82// value updated by __register_frame with a value fetched with "keymgr".
83// "keymgr" is an obsolete functionality, which should be rewritten some day.
84// In the meantime, since "keymgr" is on all libgccs shipped with apple-gcc, we
85// need a workaround in LLVM which uses the "keymgr" to dynamically modify the
86// values of an opaque key, used by libgcc to find dwarf tables.
87
Anton Korobeynikov299d9d72008-03-22 08:53:09 +000088extern "C" void __register_frame(void*);
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +000089
Evan Cheng00f16282009-04-14 22:31:59 +000090#if defined(__APPLE__) && MAC_OS_X_VERSION_MAX_ALLOWED <= 1050
91# define USE_KEYMGR 1
92#else
93# define USE_KEYMGR 0
94#endif
95
96#if USE_KEYMGR
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +000097
98namespace {
99
100// LibgccObject - This is the structure defined in libgcc. There is no #include
101// provided for this structure, so we also define it here. libgcc calls it
102// "struct object". The structure is undocumented in libgcc.
103struct LibgccObject {
104 void *unused1;
105 void *unused2;
106 void *unused3;
107
108 /// frame - Pointer to the exception table.
109 void *frame;
110
111 /// encoding - The encoding of the object?
112 union {
113 struct {
114 unsigned long sorted : 1;
115 unsigned long from_array : 1;
116 unsigned long mixed_encoding : 1;
117 unsigned long encoding : 8;
118 unsigned long count : 21;
119 } b;
120 size_t i;
121 } encoding;
122
123 /// fde_end - libgcc defines this field only if some macro is defined. We
124 /// include this field even if it may not there, to make libgcc happy.
125 char *fde_end;
126
127 /// next - At least we know it's a chained list!
128 struct LibgccObject *next;
129};
130
131// "kemgr" stuff. Apparently, all frame tables are stored there.
132extern "C" void _keymgr_set_and_unlock_processwide_ptr(int, void *);
133extern "C" void *_keymgr_get_and_lock_processwide_ptr(int);
134#define KEYMGR_GCC3_DW2_OBJ_LIST 302 /* Dwarf2 object list */
135
136/// LibgccObjectInfo - libgcc defines this struct as km_object_info. It
137/// probably contains all dwarf tables that are loaded.
138struct LibgccObjectInfo {
139
140 /// seenObjects - LibgccObjects already parsed by the unwinding runtime.
141 ///
142 struct LibgccObject* seenObjects;
143
144 /// unseenObjects - LibgccObjects not parsed yet by the unwinding runtime.
145 ///
146 struct LibgccObject* unseenObjects;
147
148 unsigned unused[2];
149};
150
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000151/// darwin_register_frame - Since __register_frame does not work with darwin's
152/// libgcc,we provide our own function, which "tricks" libgcc by modifying the
153/// "Dwarf2 object list" key.
154void DarwinRegisterFrame(void* FrameBegin) {
155 // Get the key.
Chris Lattner44e3dd12009-03-03 20:10:23 +0000156 LibgccObjectInfo* LOI = (struct LibgccObjectInfo*)
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000157 _keymgr_get_and_lock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST);
Chris Lattner44e3dd12009-03-03 20:10:23 +0000158 assert(LOI && "This should be preallocated by the runtime");
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000159
160 // Allocate a new LibgccObject to represent this frame. Deallocation of this
161 // object may be impossible: since darwin code in libgcc was written after
162 // the ability to dynamically register frames, things may crash if we
163 // deallocate it.
164 struct LibgccObject* ob = (struct LibgccObject*)
165 malloc(sizeof(struct LibgccObject));
166
167 // Do like libgcc for the values of the field.
168 ob->unused1 = (void *)-1;
169 ob->unused2 = 0;
170 ob->unused3 = 0;
171 ob->frame = FrameBegin;
172 ob->encoding.i = 0;
173 ob->encoding.b.encoding = llvm::dwarf::DW_EH_PE_omit;
174
175 // Put the info on both places, as libgcc uses the first or the the second
176 // field. Note that we rely on having two pointers here. If fde_end was a
177 // char, things would get complicated.
178 ob->fde_end = (char*)LOI->unseenObjects;
179 ob->next = LOI->unseenObjects;
180
181 // Update the key's unseenObjects list.
182 LOI->unseenObjects = ob;
183
184 // Finally update the "key". Apparently, libgcc requires it.
185 _keymgr_set_and_unlock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST,
186 LOI);
187
188}
189
190}
191#endif // __APPLE__
192#endif // __GNUC__
Anton Korobeynikov299d9d72008-03-22 08:53:09 +0000193
Chris Lattner34c94332007-12-06 01:34:04 +0000194/// createJIT - This is the factory method for creating a JIT for the current
195/// machine, it does not fall back to the interpreter. This takes ownership
196/// of the module provider.
197ExecutionEngine *ExecutionEngine::createJIT(ModuleProvider *MP,
198 std::string *ErrorStr,
Evan Cheng502f20b2008-08-08 08:11:34 +0000199 JITMemoryManager *JMM,
Bill Wendling98a366d2009-04-29 23:29:43 +0000200 CodeGenOpt::Level OptLevel) {
Bill Wendling5e5cb792009-04-29 00:32:19 +0000201 ExecutionEngine *EE = JIT::createJIT(MP, ErrorStr, JMM, OptLevel);
Chris Lattner34c94332007-12-06 01:34:04 +0000202 if (!EE) return 0;
203
Chris Lattner34c94332007-12-06 01:34:04 +0000204 // Make sure we can resolve symbols in the program as well. The zero arg
205 // to the function tells DynamicLibrary to load the program, not a library.
206 sys::DynamicLibrary::LoadLibraryPermanently(0, ErrorStr);
207 return EE;
208}
209
210JIT::JIT(ModuleProvider *MP, TargetMachine &tm, TargetJITInfo &tji,
Bill Wendling98a366d2009-04-29 23:29:43 +0000211 JITMemoryManager *JMM, CodeGenOpt::Level OptLevel)
Nate Begemanf049e072008-05-21 16:34:48 +0000212 : ExecutionEngine(MP), TM(tm), TJI(tji) {
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000213 setTargetData(TM.getTargetData());
Misha Brukmanabb027c2003-05-27 21:40:39 +0000214
Nate Begemanf049e072008-05-21 16:34:48 +0000215 jitstate = new JITState(MP);
216
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000217 // Initialize JCE
218 JCE = createEmitter(*this, JMM);
Misha Brukmanf976c852005-04-21 22:55:34 +0000219
Brian Gaeke50872d52004-04-14 17:45:52 +0000220 // Add target data
Reid Spenceree448632005-07-12 15:51:55 +0000221 MutexGuard locked(lock);
Nate Begemanf049e072008-05-21 16:34:48 +0000222 FunctionPassManager &PM = jitstate->getPM(locked);
Chris Lattnerb93b0342006-05-04 21:18:40 +0000223 PM.add(new TargetData(*TM.getTargetData()));
Brian Gaeke50872d52004-04-14 17:45:52 +0000224
Chris Lattner4d326fa2003-12-20 01:46:27 +0000225 // Turn the machine code intermediate representation into bytes in memory that
226 // may be executed.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000227 if (TM.addPassesToEmitMachineCode(PM, *JCE, OptLevel)) {
Bill Wendling832171c2006-12-07 20:04:42 +0000228 cerr << "Target does not support machine code emission!\n";
Chris Lattner4d326fa2003-12-20 01:46:27 +0000229 abort();
230 }
Chris Lattner1911fd42006-09-04 04:14:57 +0000231
Nicolas Geoffraya7ec87c2008-08-18 14:53:56 +0000232 // Register routine for informing unwinding runtime about new EH frames
Evan Cheng2d5424d2009-02-01 06:42:27 +0000233#if defined(__GNUC__) && !defined(__ARM_EABI__)
Evan Cheng00f16282009-04-14 22:31:59 +0000234#if USE_KEYMGR
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000235 struct LibgccObjectInfo* LOI = (struct LibgccObjectInfo*)
236 _keymgr_get_and_lock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST);
237
238 // The key is created on demand, and libgcc creates it the first time an
239 // exception occurs. Since we need the key to register frames, we create
240 // it now.
Chris Lattner3f91bb3ce2009-04-16 21:47:59 +0000241 if (!LOI)
242 LOI = (LibgccObjectInfo*)calloc(sizeof(struct LibgccObjectInfo), 1);
243 _keymgr_set_and_unlock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST, LOI);
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000244 InstallExceptionTableRegister(DarwinRegisterFrame);
245#else
Nicolas Geoffraya7ec87c2008-08-18 14:53:56 +0000246 InstallExceptionTableRegister(__register_frame);
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000247#endif // __APPLE__
248#endif // __GNUC__
Nicolas Geoffraya7ec87c2008-08-18 14:53:56 +0000249
Chris Lattner1911fd42006-09-04 04:14:57 +0000250 // Initialize passes.
251 PM.doInitialization();
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000252}
253
Chris Lattner4d326fa2003-12-20 01:46:27 +0000254JIT::~JIT() {
Nate Begemanf049e072008-05-21 16:34:48 +0000255 delete jitstate;
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000256 delete JCE;
Chris Lattner4d326fa2003-12-20 01:46:27 +0000257 delete &TM;
258}
259
Nate Begemanf049e072008-05-21 16:34:48 +0000260/// addModuleProvider - Add a new ModuleProvider to the JIT. If we previously
261/// removed the last ModuleProvider, we need re-initialize jitstate with a valid
262/// ModuleProvider.
263void JIT::addModuleProvider(ModuleProvider *MP) {
264 MutexGuard locked(lock);
265
266 if (Modules.empty()) {
267 assert(!jitstate && "jitstate should be NULL if Modules vector is empty!");
268
269 jitstate = new JITState(MP);
270
271 FunctionPassManager &PM = jitstate->getPM(locked);
272 PM.add(new TargetData(*TM.getTargetData()));
273
274 // Turn the machine code intermediate representation into bytes in memory
275 // that may be executed.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000276 if (TM.addPassesToEmitMachineCode(PM, *JCE, CodeGenOpt::Default)) {
Nate Begemanf049e072008-05-21 16:34:48 +0000277 cerr << "Target does not support machine code emission!\n";
278 abort();
279 }
280
281 // Initialize passes.
282 PM.doInitialization();
283 }
284
285 ExecutionEngine::addModuleProvider(MP);
286}
287
288/// removeModuleProvider - If we are removing the last ModuleProvider,
289/// invalidate the jitstate since the PassManager it contains references a
290/// released ModuleProvider.
291Module *JIT::removeModuleProvider(ModuleProvider *MP, std::string *E) {
292 Module *result = ExecutionEngine::removeModuleProvider(MP, E);
293
294 MutexGuard locked(lock);
Nate Begemand6b7a242009-02-18 08:31:02 +0000295
296 if (jitstate->getMP() == MP) {
Nate Begemanf049e072008-05-21 16:34:48 +0000297 delete jitstate;
298 jitstate = 0;
299 }
300
Nate Begemand6b7a242009-02-18 08:31:02 +0000301 if (!jitstate && !Modules.empty()) {
302 jitstate = new JITState(Modules[0]);
303
304 FunctionPassManager &PM = jitstate->getPM(locked);
305 PM.add(new TargetData(*TM.getTargetData()));
306
307 // Turn the machine code intermediate representation into bytes in memory
308 // that may be executed.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000309 if (TM.addPassesToEmitMachineCode(PM, *JCE, CodeGenOpt::Default)) {
Nate Begemand6b7a242009-02-18 08:31:02 +0000310 cerr << "Target does not support machine code emission!\n";
311 abort();
312 }
313
314 // Initialize passes.
315 PM.doInitialization();
316 }
Nate Begemanf049e072008-05-21 16:34:48 +0000317 return result;
318}
319
Nate Begeman60789e42009-01-23 19:27:28 +0000320/// deleteModuleProvider - Remove a ModuleProvider from the list of modules,
321/// and deletes the ModuleProvider and owned Module. Avoids materializing
322/// the underlying module.
323void JIT::deleteModuleProvider(ModuleProvider *MP, std::string *E) {
324 ExecutionEngine::deleteModuleProvider(MP, E);
325
326 MutexGuard locked(lock);
Nate Begemand6b7a242009-02-18 08:31:02 +0000327
328 if (jitstate->getMP() == MP) {
Nate Begeman60789e42009-01-23 19:27:28 +0000329 delete jitstate;
330 jitstate = 0;
331 }
Nate Begemand6b7a242009-02-18 08:31:02 +0000332
333 if (!jitstate && !Modules.empty()) {
334 jitstate = new JITState(Modules[0]);
335
336 FunctionPassManager &PM = jitstate->getPM(locked);
337 PM.add(new TargetData(*TM.getTargetData()));
338
339 // Turn the machine code intermediate representation into bytes in memory
340 // that may be executed.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000341 if (TM.addPassesToEmitMachineCode(PM, *JCE, CodeGenOpt::Default)) {
Nate Begemand6b7a242009-02-18 08:31:02 +0000342 cerr << "Target does not support machine code emission!\n";
343 abort();
344 }
345
346 // Initialize passes.
347 PM.doInitialization();
348 }
Nate Begeman60789e42009-01-23 19:27:28 +0000349}
350
Brian Gaeke70975ee2003-09-05 18:42:01 +0000351/// run - Start execution with the specified function and arguments.
Chris Lattner05a1a302003-08-21 21:32:12 +0000352///
Chris Lattnerff0f1bb2003-12-26 06:13:47 +0000353GenericValue JIT::runFunction(Function *F,
354 const std::vector<GenericValue> &ArgValues) {
Chris Lattnerb47130c2004-08-15 23:29:50 +0000355 assert(F && "Function *F was null at entry to run()");
Chris Lattnerb47130c2004-08-15 23:29:50 +0000356
357 void *FPtr = getPointerToFunction(F);
Chris Lattner7c45d782004-08-15 23:31:43 +0000358 assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000359 const FunctionType *FTy = F->getFunctionType();
Chris Lattnere5eab142004-08-15 23:53:06 +0000360 const Type *RetTy = FTy->getReturnType();
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000361
Dan Gohman07ab52b2009-02-19 02:55:18 +0000362 assert((FTy->getNumParams() == ArgValues.size() ||
363 (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
364 "Wrong number of arguments passed into function!");
Chris Lattnere5eab142004-08-15 23:53:06 +0000365 assert(FTy->getNumParams() == ArgValues.size() &&
366 "This doesn't support passing arguments through varargs (yet)!");
367
Misha Brukmanec843022004-10-22 23:35:57 +0000368 // Handle some common cases first. These cases correspond to common `main'
Chris Lattnere5eab142004-08-15 23:53:06 +0000369 // prototypes.
Chris Lattner79e038a2007-08-08 16:19:57 +0000370 if (RetTy == Type::Int32Ty || RetTy == Type::VoidTy) {
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000371 switch (ArgValues.size()) {
372 case 3:
Chris Lattner79e038a2007-08-08 16:19:57 +0000373 if (FTy->getParamType(0) == Type::Int32Ty &&
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000374 isa<PointerType>(FTy->getParamType(1)) &&
375 isa<PointerType>(FTy->getParamType(2))) {
376 int (*PF)(int, char **, const char **) =
Chris Lattner870286a2006-06-01 17:29:22 +0000377 (int(*)(int, char **, const char **))(intptr_t)FPtr;
Misha Brukmanec843022004-10-22 23:35:57 +0000378
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000379 // Call the function.
Chris Lattnere5eab142004-08-15 23:53:06 +0000380 GenericValue rv;
Reid Spencer38f6a152007-03-06 03:11:31 +0000381 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
382 (char **)GVTOP(ArgValues[1]),
383 (const char **)GVTOP(ArgValues[2])));
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000384 return rv;
385 }
386 break;
Chris Lattner174f2262004-08-16 01:07:04 +0000387 case 2:
Chris Lattner79e038a2007-08-08 16:19:57 +0000388 if (FTy->getParamType(0) == Type::Int32Ty &&
Chris Lattner174f2262004-08-16 01:07:04 +0000389 isa<PointerType>(FTy->getParamType(1))) {
Chris Lattner870286a2006-06-01 17:29:22 +0000390 int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
Misha Brukmanec843022004-10-22 23:35:57 +0000391
Chris Lattner174f2262004-08-16 01:07:04 +0000392 // Call the function.
393 GenericValue rv;
Reid Spencer38f6a152007-03-06 03:11:31 +0000394 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
395 (char **)GVTOP(ArgValues[1])));
Chris Lattner174f2262004-08-16 01:07:04 +0000396 return rv;
397 }
398 break;
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000399 case 1:
400 if (FTy->getNumParams() == 1 &&
Chris Lattner79e038a2007-08-08 16:19:57 +0000401 FTy->getParamType(0) == Type::Int32Ty) {
Chris Lattnere5eab142004-08-15 23:53:06 +0000402 GenericValue rv;
Chris Lattner870286a2006-06-01 17:29:22 +0000403 int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
Reid Spencer38f6a152007-03-06 03:11:31 +0000404 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000405 return rv;
406 }
407 break;
Chris Lattnere5eab142004-08-15 23:53:06 +0000408 }
409 }
410
411 // Handle cases where no arguments are passed first.
412 if (ArgValues.empty()) {
413 GenericValue rv;
414 switch (RetTy->getTypeID()) {
415 default: assert(0 && "Unknown return type for function call!");
Reid Spencera54b7cb2007-01-12 07:05:14 +0000416 case Type::IntegerTyID: {
417 unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
418 if (BitWidth == 1)
Reid Spencer38f6a152007-03-06 03:11:31 +0000419 rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000420 else if (BitWidth <= 8)
Reid Spencer38f6a152007-03-06 03:11:31 +0000421 rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000422 else if (BitWidth <= 16)
Reid Spencer38f6a152007-03-06 03:11:31 +0000423 rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000424 else if (BitWidth <= 32)
Reid Spencer38f6a152007-03-06 03:11:31 +0000425 rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000426 else if (BitWidth <= 64)
Reid Spencer38f6a152007-03-06 03:11:31 +0000427 rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000428 else
429 assert(0 && "Integer types > 64 bits not supported");
Chris Lattnerd297aea2004-08-15 23:34:48 +0000430 return rv;
Reid Spencera54b7cb2007-01-12 07:05:14 +0000431 }
Chris Lattnere5eab142004-08-15 23:53:06 +0000432 case Type::VoidTyID:
Reid Spencer38f6a152007-03-06 03:11:31 +0000433 rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
Chris Lattnere5eab142004-08-15 23:53:06 +0000434 return rv;
Chris Lattnere5eab142004-08-15 23:53:06 +0000435 case Type::FloatTyID:
Chris Lattner870286a2006-06-01 17:29:22 +0000436 rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
Chris Lattnere5eab142004-08-15 23:53:06 +0000437 return rv;
438 case Type::DoubleTyID:
Chris Lattner870286a2006-06-01 17:29:22 +0000439 rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
Chris Lattnere5eab142004-08-15 23:53:06 +0000440 return rv;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000441 case Type::X86_FP80TyID:
442 case Type::FP128TyID:
443 case Type::PPC_FP128TyID:
444 assert(0 && "long double not supported yet");
445 return rv;
Chris Lattnere5eab142004-08-15 23:53:06 +0000446 case Type::PointerTyID:
Chris Lattner870286a2006-06-01 17:29:22 +0000447 return PTOGV(((void*(*)())(intptr_t)FPtr)());
Chris Lattnerd297aea2004-08-15 23:34:48 +0000448 }
Chris Lattnerff0f1bb2003-12-26 06:13:47 +0000449 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000450
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000451 // Okay, this is not one of our quick and easy cases. Because we don't have a
452 // full FFI, we have to codegen a nullary stub function that just calls the
453 // function we are interested in, passing in constants for all of the
454 // arguments. Make this function and return.
455
456 // First, create the function.
Chris Lattner0fd38062009-07-01 04:13:31 +0000457 FunctionType *STy=FunctionType::get(RetTy, false);
Gabor Greif051a9502008-04-06 20:25:17 +0000458 Function *Stub = Function::Create(STy, Function::InternalLinkage, "",
459 F->getParent());
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000460
461 // Insert a basic block.
Gabor Greif051a9502008-04-06 20:25:17 +0000462 BasicBlock *StubBB = BasicBlock::Create("", Stub);
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000463
464 // Convert all of the GenericValue arguments over to constants. Note that we
465 // currently don't support varargs.
Chris Lattner990b8492007-02-13 06:01:22 +0000466 SmallVector<Value*, 8> Args;
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000467 for (unsigned i = 0, e = ArgValues.size(); i != e; ++i) {
468 Constant *C = 0;
469 const Type *ArgTy = FTy->getParamType(i);
470 const GenericValue &AV = ArgValues[i];
471 switch (ArgTy->getTypeID()) {
472 default: assert(0 && "Unknown argument type for function call!");
Chris Lattner02a260a2008-04-20 00:41:09 +0000473 case Type::IntegerTyID:
474 C = ConstantInt::get(AV.IntVal);
475 break;
476 case Type::FloatTyID:
477 C = ConstantFP::get(APFloat(AV.FloatVal));
478 break;
479 case Type::DoubleTyID:
480 C = ConstantFP::get(APFloat(AV.DoubleVal));
481 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000482 case Type::PPC_FP128TyID:
483 case Type::X86_FP80TyID:
Chris Lattner02a260a2008-04-20 00:41:09 +0000484 case Type::FP128TyID:
485 C = ConstantFP::get(APFloat(AV.IntVal));
486 break;
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000487 case Type::PointerTyID:
488 void *ArgPtr = GVTOP(AV);
Chris Lattner02a260a2008-04-20 00:41:09 +0000489 if (sizeof(void*) == 4)
Reid Spencere49661b2006-12-31 05:51:36 +0000490 C = ConstantInt::get(Type::Int32Ty, (int)(intptr_t)ArgPtr);
Chris Lattner02a260a2008-04-20 00:41:09 +0000491 else
Reid Spencere49661b2006-12-31 05:51:36 +0000492 C = ConstantInt::get(Type::Int64Ty, (intptr_t)ArgPtr);
Reid Spencer15f46d62006-12-12 01:17:41 +0000493 C = ConstantExpr::getIntToPtr(C, ArgTy); // Cast the integer to pointer
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000494 break;
495 }
496 Args.push_back(C);
497 }
498
Gabor Greifb1dbcd82008-05-15 10:04:30 +0000499 CallInst *TheCall = CallInst::Create(F, Args.begin(), Args.end(),
500 "", StubBB);
Chris Lattnercdfc51f2008-11-23 08:00:11 +0000501 TheCall->setCallingConv(F->getCallingConv());
Chris Lattnera471e042005-05-06 06:48:54 +0000502 TheCall->setTailCall();
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000503 if (TheCall->getType() != Type::VoidTy)
Gabor Greifb1dbcd82008-05-15 10:04:30 +0000504 ReturnInst::Create(TheCall, StubBB); // Return result of the call.
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000505 else
Gabor Greifb1dbcd82008-05-15 10:04:30 +0000506 ReturnInst::Create(StubBB); // Just return void.
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000507
508 // Finally, return the value returned by our nullary stub function.
509 return runFunction(Stub, std::vector<GenericValue>());
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000510}
Chris Lattner4d326fa2003-12-20 01:46:27 +0000511
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +0000512void JIT::RegisterJITEventListener(JITEventListener *L) {
513 if (L == NULL)
514 return;
515 MutexGuard locked(lock);
516 EventListeners.push_back(L);
517}
518void JIT::UnregisterJITEventListener(JITEventListener *L) {
519 if (L == NULL)
520 return;
521 MutexGuard locked(lock);
522 std::vector<JITEventListener*>::reverse_iterator I=
523 std::find(EventListeners.rbegin(), EventListeners.rend(), L);
524 if (I != EventListeners.rend()) {
525 std::swap(*I, EventListeners.back());
526 EventListeners.pop_back();
527 }
528}
529void JIT::NotifyFunctionEmitted(
530 const Function &F,
531 void *Code, size_t Size,
532 const JITEvent_EmittedFunctionDetails &Details) {
533 MutexGuard locked(lock);
534 for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
535 EventListeners[I]->NotifyFunctionEmitted(F, Code, Size, Details);
536 }
537}
538
539void JIT::NotifyFreeingMachineCode(const Function &F, void *OldPtr) {
540 MutexGuard locked(lock);
541 for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
542 EventListeners[I]->NotifyFreeingMachineCode(F, OldPtr);
543 }
544}
545
Chris Lattner4d326fa2003-12-20 01:46:27 +0000546/// runJITOnFunction - Run the FunctionPassManager full of
547/// just-in-time compilation passes on F, hopefully filling in
548/// GlobalAddress[F] with the address of F's machine code.
549///
Argyrios Kyrtzidisb3a847d2009-05-18 21:06:40 +0000550void JIT::runJITOnFunction(Function *F, MachineCodeInfo *MCI) {
Reid Spenceree448632005-07-12 15:51:55 +0000551 MutexGuard locked(lock);
Argyrios Kyrtzidisb3a847d2009-05-18 21:06:40 +0000552
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +0000553 class MCIListener : public JITEventListener {
554 MachineCodeInfo *const MCI;
555 public:
556 MCIListener(MachineCodeInfo *mci) : MCI(mci) {}
557 virtual void NotifyFunctionEmitted(const Function &,
558 void *Code, size_t Size,
559 const EmittedFunctionDetails &) {
560 MCI->setAddress(Code);
561 MCI->setSize(Size);
562 }
563 };
564 MCIListener MCIL(MCI);
565 RegisterJITEventListener(&MCIL);
Argyrios Kyrtzidisb3a847d2009-05-18 21:06:40 +0000566
Dan Gohman21afcda2009-02-06 21:25:08 +0000567 runJITOnFunctionUnlocked(F, locked);
Argyrios Kyrtzidisb3a847d2009-05-18 21:06:40 +0000568
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +0000569 UnregisterJITEventListener(&MCIL);
Dan Gohman21afcda2009-02-06 21:25:08 +0000570}
571
572void JIT::runJITOnFunctionUnlocked(Function *F, const MutexGuard &locked) {
573 static bool isAlreadyCodeGenerating = false;
Chris Lattner17f218e2007-08-13 20:08:16 +0000574 assert(!isAlreadyCodeGenerating && "Error: Recursive compilation detected!");
Chris Lattner4d326fa2003-12-20 01:46:27 +0000575
576 // JIT the function
577 isAlreadyCodeGenerating = true;
Nate Begemanf049e072008-05-21 16:34:48 +0000578 jitstate->getPM(locked).run(*F);
Chris Lattner4d326fa2003-12-20 01:46:27 +0000579 isAlreadyCodeGenerating = false;
Chris Lattnerc07ed132003-12-20 03:36:47 +0000580
Nate Begemand6b7a242009-02-18 08:31:02 +0000581 // If the function referred to another function that had not yet been
582 // read from bitcode, but we are jitting non-lazily, emit it now.
583 while (!jitstate->getPendingFunctions(locked).empty()) {
584 Function *PF = jitstate->getPendingFunctions(locked).back();
585 jitstate->getPendingFunctions(locked).pop_back();
586
587 // JIT the function
588 isAlreadyCodeGenerating = true;
589 jitstate->getPM(locked).run(*PF);
590 isAlreadyCodeGenerating = false;
591
592 // Now that the function has been jitted, ask the JITEmitter to rewrite
593 // the stub with real address of the function.
594 updateFunctionStub(PF);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000595 }
Nate Begemand6b7a242009-02-18 08:31:02 +0000596
597 // If the JIT is configured to emit info so that dlsym can be used to
598 // rewrite stubs to external globals, do so now.
599 if (areDlsymStubsEnabled() && isLazyCompilationDisabled())
600 updateDlsymStubTable();
Chris Lattner4d326fa2003-12-20 01:46:27 +0000601}
602
603/// getPointerToFunction - This method is used to get the address of the
604/// specified function, compiling it if neccesary.
605///
606void *JIT::getPointerToFunction(Function *F) {
Reid Spenceree448632005-07-12 15:51:55 +0000607
Chris Lattnerc07ed132003-12-20 03:36:47 +0000608 if (void *Addr = getPointerToGlobalIfAvailable(F))
609 return Addr; // Check if function already code gen'd
Chris Lattner4d326fa2003-12-20 01:46:27 +0000610
Dan Gohmana3ac0c12009-02-19 02:40:15 +0000611 MutexGuard locked(lock);
Nicolas Geoffraye91208c2009-06-12 14:11:08 +0000612
613 // Now that this thread owns the lock, check if another thread has already
614 // code gen'd the function.
615 if (void *Addr = getPointerToGlobalIfAvailable(F))
616 return Addr;
Dan Gohmana3ac0c12009-02-19 02:40:15 +0000617
Chris Lattnerfe854032006-08-16 01:24:12 +0000618 // Make sure we read in the function if it exists in this Module.
Gabor Greifa99be512007-07-05 17:07:56 +0000619 if (F->hasNotBeenReadFromBitcode()) {
Chris Lattnerfe854032006-08-16 01:24:12 +0000620 // Determine the module provider this function is provided by.
621 Module *M = F->getParent();
622 ModuleProvider *MP = 0;
623 for (unsigned i = 0, e = Modules.size(); i != e; ++i) {
624 if (Modules[i]->getModule() == M) {
625 MP = Modules[i];
626 break;
627 }
628 }
629 assert(MP && "Function isn't in a module we know about!");
630
Chris Lattner5c72a3a2006-07-07 17:18:09 +0000631 std::string ErrorMsg;
632 if (MP->materializeFunction(F, &ErrorMsg)) {
Bill Wendling832171c2006-12-07 20:04:42 +0000633 cerr << "Error reading function '" << F->getName()
Gabor Greifa99be512007-07-05 17:07:56 +0000634 << "' from bitcode file: " << ErrorMsg << "\n";
Chris Lattner0050ef82004-11-15 23:18:09 +0000635 abort();
636 }
Mon P Wang1c341c82008-10-10 01:47:42 +0000637
Dan Gohman69f93782009-01-05 05:32:42 +0000638 // Now retry to get the address.
639 if (void *Addr = getPointerToGlobalIfAvailable(F))
640 return Addr;
Nicolas Geoffrayfd7d9912008-04-20 08:33:02 +0000641 }
Chris Lattner4d326fa2003-12-20 01:46:27 +0000642
Reid Spencer5cbf9852007-01-30 20:08:39 +0000643 if (F->isDeclaration()) {
Duncan Sands667d4b82009-03-07 15:45:40 +0000644 bool AbortOnFailure =
645 !areDlsymStubsEnabled() && !F->hasExternalWeakLinkage();
Dan Gohman69f93782009-01-05 05:32:42 +0000646 void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000647 addGlobalMapping(F, Addr);
648 return Addr;
649 }
Chris Lattner4d326fa2003-12-20 01:46:27 +0000650
Dan Gohman21afcda2009-02-06 21:25:08 +0000651 runJITOnFunctionUnlocked(F, locked);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000652
653 void *Addr = getPointerToGlobalIfAvailable(F);
Chris Lattner4d326fa2003-12-20 01:46:27 +0000654 assert(Addr && "Code generation didn't add function to GlobalAddress table!");
655 return Addr;
656}
657
Chris Lattnerc07ed132003-12-20 03:36:47 +0000658/// getOrEmitGlobalVariable - Return the address of the specified global
659/// variable, possibly emitting it to memory if needed. This is used by the
660/// Emitter.
661void *JIT::getOrEmitGlobalVariable(const GlobalVariable *GV) {
Reid Spenceree448632005-07-12 15:51:55 +0000662 MutexGuard locked(lock);
663
Chris Lattnerc07ed132003-12-20 03:36:47 +0000664 void *Ptr = getPointerToGlobalIfAvailable(GV);
665 if (Ptr) return Ptr;
666
667 // If the global is external, just remember the address.
Reid Spencer5cbf9852007-01-30 20:08:39 +0000668 if (GV->isDeclaration()) {
Anton Korobeynikov3b30a6e2007-07-30 20:02:02 +0000669#if HAVE___DSO_HANDLE
Evan Cheng5f42c552006-07-21 23:06:20 +0000670 if (GV->getName() == "__dso_handle")
671 return (void*)&__dso_handle;
Evan Chengb82ab942006-07-22 00:42:03 +0000672#endif
Reid Spencerdf5a37e2004-11-29 14:11:29 +0000673 Ptr = sys::DynamicLibrary::SearchForAddressOfSymbol(GV->getName().c_str());
Nate Begeman66941982009-03-04 19:10:38 +0000674 if (Ptr == 0 && !areDlsymStubsEnabled()) {
Torok Edwin31e24662009-07-07 17:32:34 +0000675 llvm_report_error("Could not resolve external global address: "
676 +GV->getName());
Chris Lattnerc07ed132003-12-20 03:36:47 +0000677 }
Nate Begeman66941982009-03-04 19:10:38 +0000678 addGlobalMapping(GV, Ptr);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000679 } else {
Evan Cheng4d544a22009-01-16 19:14:49 +0000680 // GlobalVariable's which are not "constant" will cause trouble in a server
681 // situation. It's returned in the same block of memory as code which may
682 // not be writable.
683 if (isGVCompilationDisabled() && !GV->isConstant()) {
Evan Cheng77f86ad2008-12-09 07:31:49 +0000684 cerr << "Compilation of non-internal GlobalValue is disabled!\n";
Evan Cheng446531e2008-09-24 16:25:55 +0000685 abort();
686 }
Dale Johannesendd947ea2008-08-07 01:30:15 +0000687 // If the global hasn't been emitted to memory yet, allocate space and
688 // emit it into memory. It goes in the same array as the generated
689 // code, jump tables, etc.
Chris Lattnerf5d438c2006-05-02 21:57:51 +0000690 const Type *GlobalType = GV->getType()->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +0000691 size_t S = getTargetData()->getTypeAllocSize(GlobalType);
Duncan Sandsd1025932008-01-29 06:23:44 +0000692 size_t A = getTargetData()->getPreferredAlignment(GV);
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000693 if (GV->isThreadLocal()) {
694 MutexGuard locked(lock);
695 Ptr = TJI.allocateThreadLocalMemory(S);
Evan Chengb0b53492008-11-04 09:30:48 +0000696 } else if (TJI.allocateSeparateGVMemory()) {
697 if (A <= 8) {
698 Ptr = malloc(S);
699 } else {
700 // Allocate S+A bytes of memory, then use an aligned pointer within that
701 // space.
702 Ptr = malloc(S+A);
703 unsigned MisAligned = ((intptr_t)Ptr & (A-1));
704 Ptr = (char*)Ptr + (MisAligned ? (A-MisAligned) : 0);
705 }
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000706 } else {
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000707 Ptr = JCE->allocateSpace(S, A);
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000708 }
Dale Johannesendd947ea2008-08-07 01:30:15 +0000709 addGlobalMapping(GV, Ptr);
710 EmitGlobalVariable(GV);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000711 }
Chris Lattnerc07ed132003-12-20 03:36:47 +0000712 return Ptr;
713}
714
Chris Lattner4d326fa2003-12-20 01:46:27 +0000715/// recompileAndRelinkFunction - This method is used to force a function
716/// which has already been compiled, to be compiled again, possibly
717/// after it has been modified. Then the entry to the old copy is overwritten
718/// with a branch to the new copy. If there was no old copy, this acts
719/// just like JIT::getPointerToFunction().
720///
721void *JIT::recompileAndRelinkFunction(Function *F) {
Chris Lattnerc07ed132003-12-20 03:36:47 +0000722 void *OldAddr = getPointerToGlobalIfAvailable(F);
Chris Lattner4d326fa2003-12-20 01:46:27 +0000723
Chris Lattnerc07ed132003-12-20 03:36:47 +0000724 // If it's not already compiled there is no reason to patch it up.
725 if (OldAddr == 0) { return getPointerToFunction(F); }
Chris Lattner4d326fa2003-12-20 01:46:27 +0000726
Chris Lattnerc07ed132003-12-20 03:36:47 +0000727 // Delete the old function mapping.
728 addGlobalMapping(F, 0);
729
Chris Lattnerc07ed132003-12-20 03:36:47 +0000730 // Recodegen the function
Chris Lattner4d326fa2003-12-20 01:46:27 +0000731 runJITOnFunction(F);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000732
733 // Update state, forward the old function to the new function.
734 void *Addr = getPointerToGlobalIfAvailable(F);
Chris Lattner4d326fa2003-12-20 01:46:27 +0000735 assert(Addr && "Code generation didn't add function to GlobalAddress table!");
736 TJI.replaceMachineCodeForFunction(OldAddr, Addr);
737 return Addr;
738}
Misha Brukman895eddf2004-11-07 23:58:46 +0000739
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000740/// getMemoryForGV - This method abstracts memory allocation of global
741/// variable so that the JIT can allocate thread local variables depending
742/// on the target.
743///
744char* JIT::getMemoryForGV(const GlobalVariable* GV) {
745 const Type *ElTy = GV->getType()->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +0000746 size_t GVSize = (size_t)getTargetData()->getTypeAllocSize(ElTy);
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000747 if (GV->isThreadLocal()) {
748 MutexGuard locked(lock);
749 return TJI.allocateThreadLocalMemory(GVSize);
750 } else {
751 return new char[GVSize];
752 }
753}
Nate Begemand6b7a242009-02-18 08:31:02 +0000754
755void JIT::addPendingFunction(Function *F) {
756 MutexGuard locked(lock);
757 jitstate->getPendingFunctions(locked).push_back(F);
758}
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +0000759
760
761JITEventListener::~JITEventListener() {}