blob: 55ce16c354471a20fe8da658e0f818c2abb78acf [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,
Jeffrey Yasskin489393d2009-07-08 21:59:57 +0000200 CodeGenOpt::Level OptLevel,
201 bool GVsWithCode) {
202 ExecutionEngine *EE = JIT::createJIT(MP, ErrorStr, JMM, OptLevel,
203 GVsWithCode);
Chris Lattner34c94332007-12-06 01:34:04 +0000204 if (!EE) return 0;
205
Chris Lattner34c94332007-12-06 01:34:04 +0000206 // Make sure we can resolve symbols in the program as well. The zero arg
207 // to the function tells DynamicLibrary to load the program, not a library.
208 sys::DynamicLibrary::LoadLibraryPermanently(0, ErrorStr);
209 return EE;
210}
211
212JIT::JIT(ModuleProvider *MP, TargetMachine &tm, TargetJITInfo &tji,
Jeffrey Yasskin489393d2009-07-08 21:59:57 +0000213 JITMemoryManager *JMM, CodeGenOpt::Level OptLevel, bool GVsWithCode)
214 : ExecutionEngine(MP), TM(tm), TJI(tji), AllocateGVsWithCode(GVsWithCode) {
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000215 setTargetData(TM.getTargetData());
Misha Brukmanabb027c2003-05-27 21:40:39 +0000216
Nate Begemanf049e072008-05-21 16:34:48 +0000217 jitstate = new JITState(MP);
218
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000219 // Initialize JCE
220 JCE = createEmitter(*this, JMM);
Misha Brukmanf976c852005-04-21 22:55:34 +0000221
Brian Gaeke50872d52004-04-14 17:45:52 +0000222 // Add target data
Reid Spenceree448632005-07-12 15:51:55 +0000223 MutexGuard locked(lock);
Nate Begemanf049e072008-05-21 16:34:48 +0000224 FunctionPassManager &PM = jitstate->getPM(locked);
Chris Lattnerb93b0342006-05-04 21:18:40 +0000225 PM.add(new TargetData(*TM.getTargetData()));
Brian Gaeke50872d52004-04-14 17:45:52 +0000226
Chris Lattner4d326fa2003-12-20 01:46:27 +0000227 // Turn the machine code intermediate representation into bytes in memory that
228 // may be executed.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000229 if (TM.addPassesToEmitMachineCode(PM, *JCE, OptLevel)) {
Bill Wendling832171c2006-12-07 20:04:42 +0000230 cerr << "Target does not support machine code emission!\n";
Chris Lattner4d326fa2003-12-20 01:46:27 +0000231 abort();
232 }
Chris Lattner1911fd42006-09-04 04:14:57 +0000233
Nicolas Geoffraya7ec87c2008-08-18 14:53:56 +0000234 // Register routine for informing unwinding runtime about new EH frames
Evan Cheng2d5424d2009-02-01 06:42:27 +0000235#if defined(__GNUC__) && !defined(__ARM_EABI__)
Evan Cheng00f16282009-04-14 22:31:59 +0000236#if USE_KEYMGR
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000237 struct LibgccObjectInfo* LOI = (struct LibgccObjectInfo*)
238 _keymgr_get_and_lock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST);
239
240 // The key is created on demand, and libgcc creates it the first time an
241 // exception occurs. Since we need the key to register frames, we create
242 // it now.
Chris Lattner3f91bb3ce2009-04-16 21:47:59 +0000243 if (!LOI)
244 LOI = (LibgccObjectInfo*)calloc(sizeof(struct LibgccObjectInfo), 1);
245 _keymgr_set_and_unlock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST, LOI);
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000246 InstallExceptionTableRegister(DarwinRegisterFrame);
247#else
Nicolas Geoffraya7ec87c2008-08-18 14:53:56 +0000248 InstallExceptionTableRegister(__register_frame);
Nicolas Geoffrayd046fc62008-08-28 22:34:49 +0000249#endif // __APPLE__
250#endif // __GNUC__
Nicolas Geoffraya7ec87c2008-08-18 14:53:56 +0000251
Chris Lattner1911fd42006-09-04 04:14:57 +0000252 // Initialize passes.
253 PM.doInitialization();
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000254}
255
Chris Lattner4d326fa2003-12-20 01:46:27 +0000256JIT::~JIT() {
Nate Begemanf049e072008-05-21 16:34:48 +0000257 delete jitstate;
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000258 delete JCE;
Chris Lattner4d326fa2003-12-20 01:46:27 +0000259 delete &TM;
260}
261
Nate Begemanf049e072008-05-21 16:34:48 +0000262/// addModuleProvider - Add a new ModuleProvider to the JIT. If we previously
263/// removed the last ModuleProvider, we need re-initialize jitstate with a valid
264/// ModuleProvider.
265void JIT::addModuleProvider(ModuleProvider *MP) {
266 MutexGuard locked(lock);
267
268 if (Modules.empty()) {
269 assert(!jitstate && "jitstate should be NULL if Modules vector is empty!");
270
271 jitstate = new JITState(MP);
272
273 FunctionPassManager &PM = jitstate->getPM(locked);
274 PM.add(new TargetData(*TM.getTargetData()));
275
276 // Turn the machine code intermediate representation into bytes in memory
277 // that may be executed.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000278 if (TM.addPassesToEmitMachineCode(PM, *JCE, CodeGenOpt::Default)) {
Nate Begemanf049e072008-05-21 16:34:48 +0000279 cerr << "Target does not support machine code emission!\n";
280 abort();
281 }
282
283 // Initialize passes.
284 PM.doInitialization();
285 }
286
287 ExecutionEngine::addModuleProvider(MP);
288}
289
290/// removeModuleProvider - If we are removing the last ModuleProvider,
291/// invalidate the jitstate since the PassManager it contains references a
292/// released ModuleProvider.
293Module *JIT::removeModuleProvider(ModuleProvider *MP, std::string *E) {
294 Module *result = ExecutionEngine::removeModuleProvider(MP, E);
295
296 MutexGuard locked(lock);
Nate Begemand6b7a242009-02-18 08:31:02 +0000297
298 if (jitstate->getMP() == MP) {
Nate Begemanf049e072008-05-21 16:34:48 +0000299 delete jitstate;
300 jitstate = 0;
301 }
302
Nate Begemand6b7a242009-02-18 08:31:02 +0000303 if (!jitstate && !Modules.empty()) {
304 jitstate = new JITState(Modules[0]);
305
306 FunctionPassManager &PM = jitstate->getPM(locked);
307 PM.add(new TargetData(*TM.getTargetData()));
308
309 // Turn the machine code intermediate representation into bytes in memory
310 // that may be executed.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000311 if (TM.addPassesToEmitMachineCode(PM, *JCE, CodeGenOpt::Default)) {
Nate Begemand6b7a242009-02-18 08:31:02 +0000312 cerr << "Target does not support machine code emission!\n";
313 abort();
314 }
315
316 // Initialize passes.
317 PM.doInitialization();
318 }
Nate Begemanf049e072008-05-21 16:34:48 +0000319 return result;
320}
321
Nate Begeman60789e42009-01-23 19:27:28 +0000322/// deleteModuleProvider - Remove a ModuleProvider from the list of modules,
323/// and deletes the ModuleProvider and owned Module. Avoids materializing
324/// the underlying module.
325void JIT::deleteModuleProvider(ModuleProvider *MP, std::string *E) {
326 ExecutionEngine::deleteModuleProvider(MP, E);
327
328 MutexGuard locked(lock);
Nate Begemand6b7a242009-02-18 08:31:02 +0000329
330 if (jitstate->getMP() == MP) {
Nate Begeman60789e42009-01-23 19:27:28 +0000331 delete jitstate;
332 jitstate = 0;
333 }
Nate Begemand6b7a242009-02-18 08:31:02 +0000334
335 if (!jitstate && !Modules.empty()) {
336 jitstate = new JITState(Modules[0]);
337
338 FunctionPassManager &PM = jitstate->getPM(locked);
339 PM.add(new TargetData(*TM.getTargetData()));
340
341 // Turn the machine code intermediate representation into bytes in memory
342 // that may be executed.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +0000343 if (TM.addPassesToEmitMachineCode(PM, *JCE, CodeGenOpt::Default)) {
Nate Begemand6b7a242009-02-18 08:31:02 +0000344 cerr << "Target does not support machine code emission!\n";
345 abort();
346 }
347
348 // Initialize passes.
349 PM.doInitialization();
350 }
Nate Begeman60789e42009-01-23 19:27:28 +0000351}
352
Brian Gaeke70975ee2003-09-05 18:42:01 +0000353/// run - Start execution with the specified function and arguments.
Chris Lattner05a1a302003-08-21 21:32:12 +0000354///
Chris Lattnerff0f1bb2003-12-26 06:13:47 +0000355GenericValue JIT::runFunction(Function *F,
356 const std::vector<GenericValue> &ArgValues) {
Chris Lattnerb47130c2004-08-15 23:29:50 +0000357 assert(F && "Function *F was null at entry to run()");
Chris Lattnerb47130c2004-08-15 23:29:50 +0000358
359 void *FPtr = getPointerToFunction(F);
Chris Lattner7c45d782004-08-15 23:31:43 +0000360 assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000361 const FunctionType *FTy = F->getFunctionType();
Chris Lattnere5eab142004-08-15 23:53:06 +0000362 const Type *RetTy = FTy->getReturnType();
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000363
Dan Gohman07ab52b2009-02-19 02:55:18 +0000364 assert((FTy->getNumParams() == ArgValues.size() ||
365 (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
366 "Wrong number of arguments passed into function!");
Chris Lattnere5eab142004-08-15 23:53:06 +0000367 assert(FTy->getNumParams() == ArgValues.size() &&
368 "This doesn't support passing arguments through varargs (yet)!");
369
Misha Brukmanec843022004-10-22 23:35:57 +0000370 // Handle some common cases first. These cases correspond to common `main'
Chris Lattnere5eab142004-08-15 23:53:06 +0000371 // prototypes.
Chris Lattner79e038a2007-08-08 16:19:57 +0000372 if (RetTy == Type::Int32Ty || RetTy == Type::VoidTy) {
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000373 switch (ArgValues.size()) {
374 case 3:
Chris Lattner79e038a2007-08-08 16:19:57 +0000375 if (FTy->getParamType(0) == Type::Int32Ty &&
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000376 isa<PointerType>(FTy->getParamType(1)) &&
377 isa<PointerType>(FTy->getParamType(2))) {
378 int (*PF)(int, char **, const char **) =
Chris Lattner870286a2006-06-01 17:29:22 +0000379 (int(*)(int, char **, const char **))(intptr_t)FPtr;
Misha Brukmanec843022004-10-22 23:35:57 +0000380
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000381 // Call the function.
Chris Lattnere5eab142004-08-15 23:53:06 +0000382 GenericValue rv;
Reid Spencer38f6a152007-03-06 03:11:31 +0000383 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
384 (char **)GVTOP(ArgValues[1]),
385 (const char **)GVTOP(ArgValues[2])));
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000386 return rv;
387 }
388 break;
Chris Lattner174f2262004-08-16 01:07:04 +0000389 case 2:
Chris Lattner79e038a2007-08-08 16:19:57 +0000390 if (FTy->getParamType(0) == Type::Int32Ty &&
Chris Lattner174f2262004-08-16 01:07:04 +0000391 isa<PointerType>(FTy->getParamType(1))) {
Chris Lattner870286a2006-06-01 17:29:22 +0000392 int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
Misha Brukmanec843022004-10-22 23:35:57 +0000393
Chris Lattner174f2262004-08-16 01:07:04 +0000394 // Call the function.
395 GenericValue rv;
Reid Spencer38f6a152007-03-06 03:11:31 +0000396 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
397 (char **)GVTOP(ArgValues[1])));
Chris Lattner174f2262004-08-16 01:07:04 +0000398 return rv;
399 }
400 break;
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000401 case 1:
402 if (FTy->getNumParams() == 1 &&
Chris Lattner79e038a2007-08-08 16:19:57 +0000403 FTy->getParamType(0) == Type::Int32Ty) {
Chris Lattnere5eab142004-08-15 23:53:06 +0000404 GenericValue rv;
Chris Lattner870286a2006-06-01 17:29:22 +0000405 int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
Reid Spencer38f6a152007-03-06 03:11:31 +0000406 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
Chris Lattnerf7bedf42004-08-15 23:39:59 +0000407 return rv;
408 }
409 break;
Chris Lattnere5eab142004-08-15 23:53:06 +0000410 }
411 }
412
413 // Handle cases where no arguments are passed first.
414 if (ArgValues.empty()) {
415 GenericValue rv;
416 switch (RetTy->getTypeID()) {
417 default: assert(0 && "Unknown return type for function call!");
Reid Spencera54b7cb2007-01-12 07:05:14 +0000418 case Type::IntegerTyID: {
419 unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
420 if (BitWidth == 1)
Reid Spencer38f6a152007-03-06 03:11:31 +0000421 rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000422 else if (BitWidth <= 8)
Reid Spencer38f6a152007-03-06 03:11:31 +0000423 rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000424 else if (BitWidth <= 16)
Reid Spencer38f6a152007-03-06 03:11:31 +0000425 rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000426 else if (BitWidth <= 32)
Reid Spencer38f6a152007-03-06 03:11:31 +0000427 rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000428 else if (BitWidth <= 64)
Reid Spencer38f6a152007-03-06 03:11:31 +0000429 rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
Reid Spencera54b7cb2007-01-12 07:05:14 +0000430 else
431 assert(0 && "Integer types > 64 bits not supported");
Chris Lattnerd297aea2004-08-15 23:34:48 +0000432 return rv;
Reid Spencera54b7cb2007-01-12 07:05:14 +0000433 }
Chris Lattnere5eab142004-08-15 23:53:06 +0000434 case Type::VoidTyID:
Reid Spencer38f6a152007-03-06 03:11:31 +0000435 rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
Chris Lattnere5eab142004-08-15 23:53:06 +0000436 return rv;
Chris Lattnere5eab142004-08-15 23:53:06 +0000437 case Type::FloatTyID:
Chris Lattner870286a2006-06-01 17:29:22 +0000438 rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
Chris Lattnere5eab142004-08-15 23:53:06 +0000439 return rv;
440 case Type::DoubleTyID:
Chris Lattner870286a2006-06-01 17:29:22 +0000441 rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
Chris Lattnere5eab142004-08-15 23:53:06 +0000442 return rv;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000443 case Type::X86_FP80TyID:
444 case Type::FP128TyID:
445 case Type::PPC_FP128TyID:
446 assert(0 && "long double not supported yet");
447 return rv;
Chris Lattnere5eab142004-08-15 23:53:06 +0000448 case Type::PointerTyID:
Chris Lattner870286a2006-06-01 17:29:22 +0000449 return PTOGV(((void*(*)())(intptr_t)FPtr)());
Chris Lattnerd297aea2004-08-15 23:34:48 +0000450 }
Chris Lattnerff0f1bb2003-12-26 06:13:47 +0000451 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000452
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000453 // Okay, this is not one of our quick and easy cases. Because we don't have a
454 // full FFI, we have to codegen a nullary stub function that just calls the
455 // function we are interested in, passing in constants for all of the
456 // arguments. Make this function and return.
457
458 // First, create the function.
Chris Lattner0fd38062009-07-01 04:13:31 +0000459 FunctionType *STy=FunctionType::get(RetTy, false);
Gabor Greif051a9502008-04-06 20:25:17 +0000460 Function *Stub = Function::Create(STy, Function::InternalLinkage, "",
461 F->getParent());
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000462
463 // Insert a basic block.
Gabor Greif051a9502008-04-06 20:25:17 +0000464 BasicBlock *StubBB = BasicBlock::Create("", Stub);
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000465
466 // Convert all of the GenericValue arguments over to constants. Note that we
467 // currently don't support varargs.
Chris Lattner990b8492007-02-13 06:01:22 +0000468 SmallVector<Value*, 8> Args;
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000469 for (unsigned i = 0, e = ArgValues.size(); i != e; ++i) {
470 Constant *C = 0;
471 const Type *ArgTy = FTy->getParamType(i);
472 const GenericValue &AV = ArgValues[i];
473 switch (ArgTy->getTypeID()) {
474 default: assert(0 && "Unknown argument type for function call!");
Chris Lattner02a260a2008-04-20 00:41:09 +0000475 case Type::IntegerTyID:
476 C = ConstantInt::get(AV.IntVal);
477 break;
478 case Type::FloatTyID:
479 C = ConstantFP::get(APFloat(AV.FloatVal));
480 break;
481 case Type::DoubleTyID:
482 C = ConstantFP::get(APFloat(AV.DoubleVal));
483 break;
Dale Johannesen1abac0d2007-09-17 18:44:13 +0000484 case Type::PPC_FP128TyID:
485 case Type::X86_FP80TyID:
Chris Lattner02a260a2008-04-20 00:41:09 +0000486 case Type::FP128TyID:
487 C = ConstantFP::get(APFloat(AV.IntVal));
488 break;
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000489 case Type::PointerTyID:
490 void *ArgPtr = GVTOP(AV);
Chris Lattner02a260a2008-04-20 00:41:09 +0000491 if (sizeof(void*) == 4)
Reid Spencere49661b2006-12-31 05:51:36 +0000492 C = ConstantInt::get(Type::Int32Ty, (int)(intptr_t)ArgPtr);
Chris Lattner02a260a2008-04-20 00:41:09 +0000493 else
Reid Spencere49661b2006-12-31 05:51:36 +0000494 C = ConstantInt::get(Type::Int64Ty, (intptr_t)ArgPtr);
Reid Spencer15f46d62006-12-12 01:17:41 +0000495 C = ConstantExpr::getIntToPtr(C, ArgTy); // Cast the integer to pointer
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000496 break;
497 }
498 Args.push_back(C);
499 }
500
Gabor Greifb1dbcd82008-05-15 10:04:30 +0000501 CallInst *TheCall = CallInst::Create(F, Args.begin(), Args.end(),
502 "", StubBB);
Chris Lattnercdfc51f2008-11-23 08:00:11 +0000503 TheCall->setCallingConv(F->getCallingConv());
Chris Lattnera471e042005-05-06 06:48:54 +0000504 TheCall->setTailCall();
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000505 if (TheCall->getType() != Type::VoidTy)
Gabor Greifb1dbcd82008-05-15 10:04:30 +0000506 ReturnInst::Create(TheCall, StubBB); // Return result of the call.
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000507 else
Gabor Greifb1dbcd82008-05-15 10:04:30 +0000508 ReturnInst::Create(StubBB); // Just return void.
Chris Lattnercc22e9f2004-08-16 00:14:18 +0000509
510 // Finally, return the value returned by our nullary stub function.
511 return runFunction(Stub, std::vector<GenericValue>());
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000512}
Chris Lattner4d326fa2003-12-20 01:46:27 +0000513
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +0000514void JIT::RegisterJITEventListener(JITEventListener *L) {
515 if (L == NULL)
516 return;
517 MutexGuard locked(lock);
518 EventListeners.push_back(L);
519}
520void JIT::UnregisterJITEventListener(JITEventListener *L) {
521 if (L == NULL)
522 return;
523 MutexGuard locked(lock);
524 std::vector<JITEventListener*>::reverse_iterator I=
525 std::find(EventListeners.rbegin(), EventListeners.rend(), L);
526 if (I != EventListeners.rend()) {
527 std::swap(*I, EventListeners.back());
528 EventListeners.pop_back();
529 }
530}
531void JIT::NotifyFunctionEmitted(
532 const Function &F,
533 void *Code, size_t Size,
534 const JITEvent_EmittedFunctionDetails &Details) {
535 MutexGuard locked(lock);
536 for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
537 EventListeners[I]->NotifyFunctionEmitted(F, Code, Size, Details);
538 }
539}
540
541void JIT::NotifyFreeingMachineCode(const Function &F, void *OldPtr) {
542 MutexGuard locked(lock);
543 for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
544 EventListeners[I]->NotifyFreeingMachineCode(F, OldPtr);
545 }
546}
547
Chris Lattner4d326fa2003-12-20 01:46:27 +0000548/// runJITOnFunction - Run the FunctionPassManager full of
549/// just-in-time compilation passes on F, hopefully filling in
550/// GlobalAddress[F] with the address of F's machine code.
551///
Argyrios Kyrtzidisb3a847d2009-05-18 21:06:40 +0000552void JIT::runJITOnFunction(Function *F, MachineCodeInfo *MCI) {
Reid Spenceree448632005-07-12 15:51:55 +0000553 MutexGuard locked(lock);
Argyrios Kyrtzidisb3a847d2009-05-18 21:06:40 +0000554
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +0000555 class MCIListener : public JITEventListener {
556 MachineCodeInfo *const MCI;
557 public:
558 MCIListener(MachineCodeInfo *mci) : MCI(mci) {}
559 virtual void NotifyFunctionEmitted(const Function &,
560 void *Code, size_t Size,
561 const EmittedFunctionDetails &) {
562 MCI->setAddress(Code);
563 MCI->setSize(Size);
564 }
565 };
566 MCIListener MCIL(MCI);
567 RegisterJITEventListener(&MCIL);
Argyrios Kyrtzidisb3a847d2009-05-18 21:06:40 +0000568
Dan Gohman21afcda2009-02-06 21:25:08 +0000569 runJITOnFunctionUnlocked(F, locked);
Argyrios Kyrtzidisb3a847d2009-05-18 21:06:40 +0000570
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +0000571 UnregisterJITEventListener(&MCIL);
Dan Gohman21afcda2009-02-06 21:25:08 +0000572}
573
574void JIT::runJITOnFunctionUnlocked(Function *F, const MutexGuard &locked) {
575 static bool isAlreadyCodeGenerating = false;
Chris Lattner17f218e2007-08-13 20:08:16 +0000576 assert(!isAlreadyCodeGenerating && "Error: Recursive compilation detected!");
Chris Lattner4d326fa2003-12-20 01:46:27 +0000577
578 // JIT the function
579 isAlreadyCodeGenerating = true;
Nate Begemanf049e072008-05-21 16:34:48 +0000580 jitstate->getPM(locked).run(*F);
Chris Lattner4d326fa2003-12-20 01:46:27 +0000581 isAlreadyCodeGenerating = false;
Chris Lattnerc07ed132003-12-20 03:36:47 +0000582
Nate Begemand6b7a242009-02-18 08:31:02 +0000583 // If the function referred to another function that had not yet been
584 // read from bitcode, but we are jitting non-lazily, emit it now.
585 while (!jitstate->getPendingFunctions(locked).empty()) {
586 Function *PF = jitstate->getPendingFunctions(locked).back();
587 jitstate->getPendingFunctions(locked).pop_back();
588
589 // JIT the function
590 isAlreadyCodeGenerating = true;
591 jitstate->getPM(locked).run(*PF);
592 isAlreadyCodeGenerating = false;
593
594 // Now that the function has been jitted, ask the JITEmitter to rewrite
595 // the stub with real address of the function.
596 updateFunctionStub(PF);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000597 }
Nate Begemand6b7a242009-02-18 08:31:02 +0000598
599 // If the JIT is configured to emit info so that dlsym can be used to
600 // rewrite stubs to external globals, do so now.
601 if (areDlsymStubsEnabled() && isLazyCompilationDisabled())
602 updateDlsymStubTable();
Chris Lattner4d326fa2003-12-20 01:46:27 +0000603}
604
605/// getPointerToFunction - This method is used to get the address of the
606/// specified function, compiling it if neccesary.
607///
608void *JIT::getPointerToFunction(Function *F) {
Reid Spenceree448632005-07-12 15:51:55 +0000609
Chris Lattnerc07ed132003-12-20 03:36:47 +0000610 if (void *Addr = getPointerToGlobalIfAvailable(F))
611 return Addr; // Check if function already code gen'd
Chris Lattner4d326fa2003-12-20 01:46:27 +0000612
Dan Gohmana3ac0c12009-02-19 02:40:15 +0000613 MutexGuard locked(lock);
Nicolas Geoffraye91208c2009-06-12 14:11:08 +0000614
615 // Now that this thread owns the lock, check if another thread has already
616 // code gen'd the function.
617 if (void *Addr = getPointerToGlobalIfAvailable(F))
618 return Addr;
Dan Gohmana3ac0c12009-02-19 02:40:15 +0000619
Chris Lattnerfe854032006-08-16 01:24:12 +0000620 // Make sure we read in the function if it exists in this Module.
Gabor Greifa99be512007-07-05 17:07:56 +0000621 if (F->hasNotBeenReadFromBitcode()) {
Chris Lattnerfe854032006-08-16 01:24:12 +0000622 // Determine the module provider this function is provided by.
623 Module *M = F->getParent();
624 ModuleProvider *MP = 0;
625 for (unsigned i = 0, e = Modules.size(); i != e; ++i) {
626 if (Modules[i]->getModule() == M) {
627 MP = Modules[i];
628 break;
629 }
630 }
631 assert(MP && "Function isn't in a module we know about!");
632
Chris Lattner5c72a3a2006-07-07 17:18:09 +0000633 std::string ErrorMsg;
634 if (MP->materializeFunction(F, &ErrorMsg)) {
Bill Wendling832171c2006-12-07 20:04:42 +0000635 cerr << "Error reading function '" << F->getName()
Gabor Greifa99be512007-07-05 17:07:56 +0000636 << "' from bitcode file: " << ErrorMsg << "\n";
Chris Lattner0050ef82004-11-15 23:18:09 +0000637 abort();
638 }
Mon P Wang1c341c82008-10-10 01:47:42 +0000639
Dan Gohman69f93782009-01-05 05:32:42 +0000640 // Now retry to get the address.
641 if (void *Addr = getPointerToGlobalIfAvailable(F))
642 return Addr;
Nicolas Geoffrayfd7d9912008-04-20 08:33:02 +0000643 }
Chris Lattner4d326fa2003-12-20 01:46:27 +0000644
Reid Spencer5cbf9852007-01-30 20:08:39 +0000645 if (F->isDeclaration()) {
Duncan Sands667d4b82009-03-07 15:45:40 +0000646 bool AbortOnFailure =
647 !areDlsymStubsEnabled() && !F->hasExternalWeakLinkage();
Dan Gohman69f93782009-01-05 05:32:42 +0000648 void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000649 addGlobalMapping(F, Addr);
650 return Addr;
651 }
Chris Lattner4d326fa2003-12-20 01:46:27 +0000652
Dan Gohman21afcda2009-02-06 21:25:08 +0000653 runJITOnFunctionUnlocked(F, locked);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000654
655 void *Addr = getPointerToGlobalIfAvailable(F);
Chris Lattner4d326fa2003-12-20 01:46:27 +0000656 assert(Addr && "Code generation didn't add function to GlobalAddress table!");
657 return Addr;
658}
659
Chris Lattnerc07ed132003-12-20 03:36:47 +0000660/// getOrEmitGlobalVariable - Return the address of the specified global
661/// variable, possibly emitting it to memory if needed. This is used by the
662/// Emitter.
663void *JIT::getOrEmitGlobalVariable(const GlobalVariable *GV) {
Reid Spenceree448632005-07-12 15:51:55 +0000664 MutexGuard locked(lock);
665
Chris Lattnerc07ed132003-12-20 03:36:47 +0000666 void *Ptr = getPointerToGlobalIfAvailable(GV);
667 if (Ptr) return Ptr;
668
669 // If the global is external, just remember the address.
Reid Spencer5cbf9852007-01-30 20:08:39 +0000670 if (GV->isDeclaration()) {
Anton Korobeynikov3b30a6e2007-07-30 20:02:02 +0000671#if HAVE___DSO_HANDLE
Evan Cheng5f42c552006-07-21 23:06:20 +0000672 if (GV->getName() == "__dso_handle")
673 return (void*)&__dso_handle;
Evan Chengb82ab942006-07-22 00:42:03 +0000674#endif
Reid Spencerdf5a37e2004-11-29 14:11:29 +0000675 Ptr = sys::DynamicLibrary::SearchForAddressOfSymbol(GV->getName().c_str());
Nate Begeman66941982009-03-04 19:10:38 +0000676 if (Ptr == 0 && !areDlsymStubsEnabled()) {
Torok Edwin31e24662009-07-07 17:32:34 +0000677 llvm_report_error("Could not resolve external global address: "
678 +GV->getName());
Chris Lattnerc07ed132003-12-20 03:36:47 +0000679 }
Nate Begeman66941982009-03-04 19:10:38 +0000680 addGlobalMapping(GV, Ptr);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000681 } else {
Dale Johannesendd947ea2008-08-07 01:30:15 +0000682 // If the global hasn't been emitted to memory yet, allocate space and
Jeffrey Yasskin489393d2009-07-08 21:59:57 +0000683 // emit it into memory.
684 Ptr = getMemoryForGV(GV);
Dale Johannesendd947ea2008-08-07 01:30:15 +0000685 addGlobalMapping(GV, Ptr);
Jeffrey Yasskin489393d2009-07-08 21:59:57 +0000686 EmitGlobalVariable(GV); // Initialize the variable.
Chris Lattnerc07ed132003-12-20 03:36:47 +0000687 }
Chris Lattnerc07ed132003-12-20 03:36:47 +0000688 return Ptr;
689}
690
Chris Lattner4d326fa2003-12-20 01:46:27 +0000691/// recompileAndRelinkFunction - This method is used to force a function
692/// which has already been compiled, to be compiled again, possibly
693/// after it has been modified. Then the entry to the old copy is overwritten
694/// with a branch to the new copy. If there was no old copy, this acts
695/// just like JIT::getPointerToFunction().
696///
697void *JIT::recompileAndRelinkFunction(Function *F) {
Chris Lattnerc07ed132003-12-20 03:36:47 +0000698 void *OldAddr = getPointerToGlobalIfAvailable(F);
Chris Lattner4d326fa2003-12-20 01:46:27 +0000699
Chris Lattnerc07ed132003-12-20 03:36:47 +0000700 // If it's not already compiled there is no reason to patch it up.
701 if (OldAddr == 0) { return getPointerToFunction(F); }
Chris Lattner4d326fa2003-12-20 01:46:27 +0000702
Chris Lattnerc07ed132003-12-20 03:36:47 +0000703 // Delete the old function mapping.
704 addGlobalMapping(F, 0);
705
Chris Lattnerc07ed132003-12-20 03:36:47 +0000706 // Recodegen the function
Chris Lattner4d326fa2003-12-20 01:46:27 +0000707 runJITOnFunction(F);
Chris Lattnerc07ed132003-12-20 03:36:47 +0000708
709 // Update state, forward the old function to the new function.
710 void *Addr = getPointerToGlobalIfAvailable(F);
Chris Lattner4d326fa2003-12-20 01:46:27 +0000711 assert(Addr && "Code generation didn't add function to GlobalAddress table!");
712 TJI.replaceMachineCodeForFunction(OldAddr, Addr);
713 return Addr;
714}
Misha Brukman895eddf2004-11-07 23:58:46 +0000715
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000716/// getMemoryForGV - This method abstracts memory allocation of global
717/// variable so that the JIT can allocate thread local variables depending
718/// on the target.
719///
720char* JIT::getMemoryForGV(const GlobalVariable* GV) {
Jeffrey Yasskin489393d2009-07-08 21:59:57 +0000721 char *Ptr;
722
723 // GlobalVariable's which are not "constant" will cause trouble in a server
724 // situation. It's returned in the same block of memory as code which may
725 // not be writable.
726 if (isGVCompilationDisabled() && !GV->isConstant()) {
727 cerr << "Compilation of non-internal GlobalValue is disabled!\n";
728 abort();
729 }
730
731 // Some applications require globals and code to live together, so they may
732 // be allocated into the same buffer, but in general globals are allocated
733 // through the memory manager which puts them near the code but not in the
734 // same buffer.
735 const Type *GlobalType = GV->getType()->getElementType();
736 size_t S = getTargetData()->getTypeAllocSize(GlobalType);
737 size_t A = getTargetData()->getPreferredAlignment(GV);
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000738 if (GV->isThreadLocal()) {
739 MutexGuard locked(lock);
Jeffrey Yasskin489393d2009-07-08 21:59:57 +0000740 Ptr = TJI.allocateThreadLocalMemory(S);
741 } else if (TJI.allocateSeparateGVMemory()) {
742 if (A <= 8) {
743 Ptr = (char*)malloc(S);
744 } else {
745 // Allocate S+A bytes of memory, then use an aligned pointer within that
746 // space.
747 Ptr = (char*)malloc(S+A);
748 unsigned MisAligned = ((intptr_t)Ptr & (A-1));
749 Ptr = Ptr + (MisAligned ? (A-MisAligned) : 0);
750 }
751 } else if (AllocateGVsWithCode) {
752 Ptr = (char*)JCE->allocateSpace(S, A);
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000753 } else {
Jeffrey Yasskin489393d2009-07-08 21:59:57 +0000754 Ptr = (char*)JCE->allocateGlobal(S, A);
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000755 }
Jeffrey Yasskin489393d2009-07-08 21:59:57 +0000756 return Ptr;
Nicolas Geoffray46fa1392008-10-25 15:41:43 +0000757}
Nate Begemand6b7a242009-02-18 08:31:02 +0000758
759void JIT::addPendingFunction(Function *F) {
760 MutexGuard locked(lock);
761 jitstate->getPendingFunctions(locked).push_back(F);
762}
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +0000763
764
765JITEventListener::~JITEventListener() {}