blob: 15627675a565b437f7ab7a1cc611490e7d2fd8e4 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001//===-- JIT.cpp - LLVM Just in Time Compiler ------------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner081ce942007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This tool implements a just-in-time compiler for LLVM, allowing direct
11// execution of LLVM bitcode in an efficient manner.
12//
13//===----------------------------------------------------------------------===//
14
15#include "JIT.h"
16#include "llvm/Constants.h"
17#include "llvm/DerivedTypes.h"
18#include "llvm/Function.h"
19#include "llvm/GlobalVariable.h"
20#include "llvm/Instructions.h"
Bruno Cardoso Lopes1ea31ff2009-05-30 20:51:52 +000021#include "llvm/CodeGen/JITCodeEmitter.h"
Argiris Kirtzidis6841c1a2009-05-18 21:06:40 +000022#include "llvm/CodeGen/MachineCodeInfo.h"
Jeffrey Yasskinf8d55342009-06-25 02:04:04 +000023#include "llvm/ExecutionEngine/GenericValue.h"
24#include "llvm/ExecutionEngine/JITEventListener.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000025#include "llvm/Target/TargetData.h"
26#include "llvm/Target/TargetMachine.h"
27#include "llvm/Target/TargetJITInfo.h"
Chris Lattner9e309642009-03-03 20:10:23 +000028#include "llvm/Support/Dwarf.h"
Edwin Törökf7cbfea2009-07-07 17:32:34 +000029#include "llvm/Support/ErrorHandling.h"
Chris Lattner9e309642009-03-03 20:10:23 +000030#include "llvm/Support/MutexGuard.h"
31#include "llvm/System/DynamicLibrary.h"
Anton Korobeynikov52f44db2007-07-30 20:02:02 +000032#include "llvm/Config/config.h"
33
Dan Gohmanf17a25c2007-07-18 16:29:46 +000034using namespace llvm;
35
36#ifdef __APPLE__
Anton Korobeynikov52f44db2007-07-30 20:02:02 +000037// Apple gcc defaults to -fuse-cxa-atexit (i.e. calls __cxa_atexit instead
38// of atexit). It passes the address of linker generated symbol __dso_handle
39// to the function.
40// This configuration change happened at version 5330.
41# include <AvailabilityMacros.h>
42# if defined(MAC_OS_X_VERSION_10_4) && \
43 ((MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_4) || \
44 (MAC_OS_X_VERSION_MIN_REQUIRED == MAC_OS_X_VERSION_10_4 && \
45 __APPLE_CC__ >= 5330))
46# ifndef HAVE___DSO_HANDLE
47# define HAVE___DSO_HANDLE 1
48# endif
49# endif
Dan Gohmanf17a25c2007-07-18 16:29:46 +000050#endif
Anton Korobeynikov52f44db2007-07-30 20:02:02 +000051
52#if HAVE___DSO_HANDLE
53extern void *__dso_handle __attribute__ ((__visibility__ ("hidden")));
Dan Gohmanf17a25c2007-07-18 16:29:46 +000054#endif
55
Dan Gohman089efff2008-05-13 00:00:25 +000056namespace {
57
Dan Gohmanf17a25c2007-07-18 16:29:46 +000058static struct RegisterJIT {
59 RegisterJIT() { JIT::Register(); }
60} JITRegistrator;
61
Dan Gohman089efff2008-05-13 00:00:25 +000062}
63
Bob Wilson3217b3e2009-06-24 21:09:18 +000064extern "C" void LLVMLinkInJIT() {
Dan Gohmanf17a25c2007-07-18 16:29:46 +000065}
66
Nicolas Geoffray72dfb8e2008-08-28 22:34:49 +000067
Evan Chengaf8dce02009-02-01 06:42:27 +000068#if defined(__GNUC__) && !defined(__ARM__EABI__)
Nicolas Geoffray72dfb8e2008-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 Korobeynikov6556e9e2008-03-22 08:53:09 +000087extern "C" void __register_frame(void*);
Nicolas Geoffray72dfb8e2008-08-28 22:34:49 +000088
Evan Cheng36304af2009-04-14 22:31:59 +000089#if defined(__APPLE__) && MAC_OS_X_VERSION_MAX_ALLOWED <= 1050
90# define USE_KEYMGR 1
91#else
92# define USE_KEYMGR 0
93#endif
94
95#if USE_KEYMGR
Nicolas Geoffray72dfb8e2008-08-28 22:34:49 +000096
97namespace {
98
99// LibgccObject - This is the structure defined in libgcc. There is no #include
100// provided for this structure, so we also define it here. libgcc calls it
101// "struct object". The structure is undocumented in libgcc.
102struct LibgccObject {
103 void *unused1;
104 void *unused2;
105 void *unused3;
106
107 /// frame - Pointer to the exception table.
108 void *frame;
109
110 /// encoding - The encoding of the object?
111 union {
112 struct {
113 unsigned long sorted : 1;
114 unsigned long from_array : 1;
115 unsigned long mixed_encoding : 1;
116 unsigned long encoding : 8;
117 unsigned long count : 21;
118 } b;
119 size_t i;
120 } encoding;
121
122 /// fde_end - libgcc defines this field only if some macro is defined. We
123 /// include this field even if it may not there, to make libgcc happy.
124 char *fde_end;
125
126 /// next - At least we know it's a chained list!
127 struct LibgccObject *next;
128};
129
130// "kemgr" stuff. Apparently, all frame tables are stored there.
131extern "C" void _keymgr_set_and_unlock_processwide_ptr(int, void *);
132extern "C" void *_keymgr_get_and_lock_processwide_ptr(int);
133#define KEYMGR_GCC3_DW2_OBJ_LIST 302 /* Dwarf2 object list */
134
135/// LibgccObjectInfo - libgcc defines this struct as km_object_info. It
136/// probably contains all dwarf tables that are loaded.
137struct LibgccObjectInfo {
138
139 /// seenObjects - LibgccObjects already parsed by the unwinding runtime.
140 ///
141 struct LibgccObject* seenObjects;
142
143 /// unseenObjects - LibgccObjects not parsed yet by the unwinding runtime.
144 ///
145 struct LibgccObject* unseenObjects;
146
147 unsigned unused[2];
148};
149
Nicolas Geoffray72dfb8e2008-08-28 22:34:49 +0000150/// darwin_register_frame - Since __register_frame does not work with darwin's
151/// libgcc,we provide our own function, which "tricks" libgcc by modifying the
152/// "Dwarf2 object list" key.
153void DarwinRegisterFrame(void* FrameBegin) {
154 // Get the key.
Chris Lattner9e309642009-03-03 20:10:23 +0000155 LibgccObjectInfo* LOI = (struct LibgccObjectInfo*)
Nicolas Geoffray72dfb8e2008-08-28 22:34:49 +0000156 _keymgr_get_and_lock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST);
Chris Lattner9e309642009-03-03 20:10:23 +0000157 assert(LOI && "This should be preallocated by the runtime");
Nicolas Geoffray72dfb8e2008-08-28 22:34:49 +0000158
159 // Allocate a new LibgccObject to represent this frame. Deallocation of this
160 // object may be impossible: since darwin code in libgcc was written after
161 // the ability to dynamically register frames, things may crash if we
162 // deallocate it.
163 struct LibgccObject* ob = (struct LibgccObject*)
164 malloc(sizeof(struct LibgccObject));
165
166 // Do like libgcc for the values of the field.
167 ob->unused1 = (void *)-1;
168 ob->unused2 = 0;
169 ob->unused3 = 0;
170 ob->frame = FrameBegin;
171 ob->encoding.i = 0;
172 ob->encoding.b.encoding = llvm::dwarf::DW_EH_PE_omit;
173
174 // Put the info on both places, as libgcc uses the first or the the second
175 // field. Note that we rely on having two pointers here. If fde_end was a
176 // char, things would get complicated.
177 ob->fde_end = (char*)LOI->unseenObjects;
178 ob->next = LOI->unseenObjects;
179
180 // Update the key's unseenObjects list.
181 LOI->unseenObjects = ob;
182
183 // Finally update the "key". Apparently, libgcc requires it.
184 _keymgr_set_and_unlock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST,
185 LOI);
186
187}
188
189}
190#endif // __APPLE__
191#endif // __GNUC__
Anton Korobeynikov6556e9e2008-03-22 08:53:09 +0000192
Chris Lattner4db98aa2007-12-06 01:34:04 +0000193/// createJIT - This is the factory method for creating a JIT for the current
194/// machine, it does not fall back to the interpreter. This takes ownership
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000195/// of the module.
196ExecutionEngine *ExecutionEngine::createJIT(Module *M,
Chris Lattner4db98aa2007-12-06 01:34:04 +0000197 std::string *ErrorStr,
Evan Chenga6394fc2008-08-08 08:11:34 +0000198 JITMemoryManager *JMM,
Jeffrey Yasskin892956a2009-07-08 21:59:57 +0000199 CodeGenOpt::Level OptLevel,
Eric Christopherb064d5e2009-11-17 21:58:16 +0000200 bool GVsWithCode,
201 CodeModel::Model CMM) {
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000202 return JIT::createJIT(M, ErrorStr, JMM, OptLevel, GVsWithCode, CMM);
Reid Klecknerfa3585b2009-07-18 00:42:18 +0000203}
204
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000205ExecutionEngine *JIT::createJIT(Module *M,
Reid Klecknerfa3585b2009-07-18 00:42:18 +0000206 std::string *ErrorStr,
207 JITMemoryManager *JMM,
208 CodeGenOpt::Level OptLevel,
Eric Christopherb064d5e2009-11-17 21:58:16 +0000209 bool GVsWithCode,
Eric Christopher9f669d92009-12-15 00:40:55 +0000210 CodeModel::Model CMM) {
Chris Lattner4db98aa2007-12-06 01:34:04 +0000211 // Make sure we can resolve symbols in the program as well. The zero arg
212 // to the function tells DynamicLibrary to load the program, not a library.
Reid Klecknerfa3585b2009-07-18 00:42:18 +0000213 if (sys::DynamicLibrary::LoadLibraryPermanently(0, ErrorStr))
214 return 0;
215
216 // Pick a target either via -march or by guessing the native arch.
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000217 TargetMachine *TM = JIT::selectTarget(M, ErrorStr);
Reid Klecknerfa3585b2009-07-18 00:42:18 +0000218 if (!TM || (ErrorStr && ErrorStr->length() > 0)) return 0;
Eric Christopherb064d5e2009-11-17 21:58:16 +0000219 TM->setCodeModel(CMM);
Reid Klecknerfa3585b2009-07-18 00:42:18 +0000220
221 // If the target supports JIT code generation, create a the JIT.
222 if (TargetJITInfo *TJ = TM->getJITInfo()) {
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000223 return new JIT(M, *TM, *TJ, JMM, OptLevel, GVsWithCode);
Reid Klecknerfa3585b2009-07-18 00:42:18 +0000224 } else {
225 if (ErrorStr)
226 *ErrorStr = "target does not support JIT code generation";
227 return 0;
228 }
Chris Lattner4db98aa2007-12-06 01:34:04 +0000229}
230
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000231JIT::JIT(Module *M, TargetMachine &tm, TargetJITInfo &tji,
Jeffrey Yasskin892956a2009-07-08 21:59:57 +0000232 JITMemoryManager *JMM, CodeGenOpt::Level OptLevel, bool GVsWithCode)
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000233 : ExecutionEngine(M), TM(tm), TJI(tji), AllocateGVsWithCode(GVsWithCode) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000234 setTargetData(TM.getTargetData());
235
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000236 jitstate = new JITState(M);
Nate Begemanf7113d92008-05-21 16:34:48 +0000237
Bruno Cardoso Lopes1ea31ff2009-05-30 20:51:52 +0000238 // Initialize JCE
Reid Kleckner738b4f22009-09-20 23:52:43 +0000239 JCE = createEmitter(*this, JMM, TM);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000240
241 // Add target data
242 MutexGuard locked(lock);
Nate Begemanf7113d92008-05-21 16:34:48 +0000243 FunctionPassManager &PM = jitstate->getPM(locked);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000244 PM.add(new TargetData(*TM.getTargetData()));
245
246 // Turn the machine code intermediate representation into bytes in memory that
247 // may be executed.
Bruno Cardoso Lopes1ea31ff2009-05-30 20:51:52 +0000248 if (TM.addPassesToEmitMachineCode(PM, *JCE, OptLevel)) {
Edwin Törökced9ff82009-07-11 13:10:19 +0000249 llvm_report_error("Target does not support machine code emission!");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000250 }
251
Nicolas Geoffraybed46f82008-08-18 14:53:56 +0000252 // Register routine for informing unwinding runtime about new EH frames
Evan Chengaf8dce02009-02-01 06:42:27 +0000253#if defined(__GNUC__) && !defined(__ARM_EABI__)
Evan Cheng36304af2009-04-14 22:31:59 +0000254#if USE_KEYMGR
Nicolas Geoffray72dfb8e2008-08-28 22:34:49 +0000255 struct LibgccObjectInfo* LOI = (struct LibgccObjectInfo*)
256 _keymgr_get_and_lock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST);
257
258 // The key is created on demand, and libgcc creates it the first time an
259 // exception occurs. Since we need the key to register frames, we create
260 // it now.
Chris Lattner0973f802009-04-16 21:47:59 +0000261 if (!LOI)
262 LOI = (LibgccObjectInfo*)calloc(sizeof(struct LibgccObjectInfo), 1);
263 _keymgr_set_and_unlock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST, LOI);
Nicolas Geoffray72dfb8e2008-08-28 22:34:49 +0000264 InstallExceptionTableRegister(DarwinRegisterFrame);
265#else
Nicolas Geoffraybed46f82008-08-18 14:53:56 +0000266 InstallExceptionTableRegister(__register_frame);
Nicolas Geoffray72dfb8e2008-08-28 22:34:49 +0000267#endif // __APPLE__
268#endif // __GNUC__
Nicolas Geoffraybed46f82008-08-18 14:53:56 +0000269
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000270 // Initialize passes.
271 PM.doInitialization();
272}
273
274JIT::~JIT() {
Nate Begemanf7113d92008-05-21 16:34:48 +0000275 delete jitstate;
Bruno Cardoso Lopes1ea31ff2009-05-30 20:51:52 +0000276 delete JCE;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000277 delete &TM;
278}
279
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000280/// addModule - Add a new Module to the JIT. If we previously removed the last
281/// Module, we need re-initialize jitstate with a valid Module.
282void JIT::addModule(Module *M) {
Nate Begemanf7113d92008-05-21 16:34:48 +0000283 MutexGuard locked(lock);
284
285 if (Modules.empty()) {
286 assert(!jitstate && "jitstate should be NULL if Modules vector is empty!");
287
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000288 jitstate = new JITState(M);
Nate Begemanf7113d92008-05-21 16:34:48 +0000289
290 FunctionPassManager &PM = jitstate->getPM(locked);
291 PM.add(new TargetData(*TM.getTargetData()));
292
293 // Turn the machine code intermediate representation into bytes in memory
294 // that may be executed.
Bruno Cardoso Lopes1ea31ff2009-05-30 20:51:52 +0000295 if (TM.addPassesToEmitMachineCode(PM, *JCE, CodeGenOpt::Default)) {
Edwin Törökced9ff82009-07-11 13:10:19 +0000296 llvm_report_error("Target does not support machine code emission!");
Nate Begemanf7113d92008-05-21 16:34:48 +0000297 }
298
299 // Initialize passes.
300 PM.doInitialization();
301 }
302
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000303 ExecutionEngine::addModule(M);
Nate Begemanf7113d92008-05-21 16:34:48 +0000304}
305
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000306/// removeModule - If we are removing the last Module, invalidate the jitstate
307/// since the PassManager it contains references a released Module.
308bool JIT::removeModule(Module *M) {
309 bool result = ExecutionEngine::removeModule(M);
Nate Begemanf7113d92008-05-21 16:34:48 +0000310
311 MutexGuard locked(lock);
Nate Begeman7b1a8472009-02-18 08:31:02 +0000312
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000313 if (jitstate->getModule() == M) {
Nate Begemanf7113d92008-05-21 16:34:48 +0000314 delete jitstate;
315 jitstate = 0;
316 }
317
Nate Begeman7b1a8472009-02-18 08:31:02 +0000318 if (!jitstate && !Modules.empty()) {
319 jitstate = new JITState(Modules[0]);
320
321 FunctionPassManager &PM = jitstate->getPM(locked);
322 PM.add(new TargetData(*TM.getTargetData()));
323
324 // Turn the machine code intermediate representation into bytes in memory
325 // that may be executed.
Bruno Cardoso Lopes1ea31ff2009-05-30 20:51:52 +0000326 if (TM.addPassesToEmitMachineCode(PM, *JCE, CodeGenOpt::Default)) {
Edwin Törökced9ff82009-07-11 13:10:19 +0000327 llvm_report_error("Target does not support machine code emission!");
Nate Begeman7b1a8472009-02-18 08:31:02 +0000328 }
329
330 // Initialize passes.
331 PM.doInitialization();
332 }
Nate Begemanf7113d92008-05-21 16:34:48 +0000333 return result;
334}
335
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000336/// run - Start execution with the specified function and arguments.
337///
338GenericValue JIT::runFunction(Function *F,
339 const std::vector<GenericValue> &ArgValues) {
340 assert(F && "Function *F was null at entry to run()");
341
342 void *FPtr = getPointerToFunction(F);
343 assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
344 const FunctionType *FTy = F->getFunctionType();
345 const Type *RetTy = FTy->getReturnType();
346
Dan Gohman4e28da42009-02-19 02:55:18 +0000347 assert((FTy->getNumParams() == ArgValues.size() ||
348 (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
349 "Wrong number of arguments passed into function!");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000350 assert(FTy->getNumParams() == ArgValues.size() &&
351 "This doesn't support passing arguments through varargs (yet)!");
352
353 // Handle some common cases first. These cases correspond to common `main'
354 // prototypes.
Benjamin Kramerf0e83d22010-01-05 21:05:54 +0000355 if (RetTy->isInteger(32) || RetTy->isVoidTy()) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000356 switch (ArgValues.size()) {
357 case 3:
Benjamin Kramer0461f522010-01-05 20:07:06 +0000358 if (FTy->getParamType(0)->isInteger(32) &&
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000359 isa<PointerType>(FTy->getParamType(1)) &&
360 isa<PointerType>(FTy->getParamType(2))) {
361 int (*PF)(int, char **, const char **) =
362 (int(*)(int, char **, const char **))(intptr_t)FPtr;
363
364 // Call the function.
365 GenericValue rv;
366 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
367 (char **)GVTOP(ArgValues[1]),
368 (const char **)GVTOP(ArgValues[2])));
369 return rv;
370 }
371 break;
372 case 2:
Benjamin Kramer0461f522010-01-05 20:07:06 +0000373 if (FTy->getParamType(0)->isInteger(32) &&
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000374 isa<PointerType>(FTy->getParamType(1))) {
375 int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
376
377 // Call the function.
378 GenericValue rv;
379 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
380 (char **)GVTOP(ArgValues[1])));
381 return rv;
382 }
383 break;
384 case 1:
385 if (FTy->getNumParams() == 1 &&
Benjamin Kramer0461f522010-01-05 20:07:06 +0000386 FTy->getParamType(0)->isInteger(32)) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000387 GenericValue rv;
388 int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
389 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
390 return rv;
391 }
392 break;
393 }
394 }
395
396 // Handle cases where no arguments are passed first.
397 if (ArgValues.empty()) {
398 GenericValue rv;
399 switch (RetTy->getTypeID()) {
Edwin Törökbd448e32009-07-14 16:55:14 +0000400 default: llvm_unreachable("Unknown return type for function call!");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000401 case Type::IntegerTyID: {
402 unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
403 if (BitWidth == 1)
404 rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
405 else if (BitWidth <= 8)
406 rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
407 else if (BitWidth <= 16)
408 rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
409 else if (BitWidth <= 32)
410 rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
411 else if (BitWidth <= 64)
412 rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
413 else
Edwin Törökbd448e32009-07-14 16:55:14 +0000414 llvm_unreachable("Integer types > 64 bits not supported");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000415 return rv;
416 }
417 case Type::VoidTyID:
418 rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
419 return rv;
420 case Type::FloatTyID:
421 rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
422 return rv;
423 case Type::DoubleTyID:
424 rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
425 return rv;
Dale Johannesenc560da62007-09-17 18:44:13 +0000426 case Type::X86_FP80TyID:
427 case Type::FP128TyID:
428 case Type::PPC_FP128TyID:
Edwin Törökbd448e32009-07-14 16:55:14 +0000429 llvm_unreachable("long double not supported yet");
Dale Johannesenc560da62007-09-17 18:44:13 +0000430 return rv;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000431 case Type::PointerTyID:
432 return PTOGV(((void*(*)())(intptr_t)FPtr)());
433 }
434 }
435
436 // Okay, this is not one of our quick and easy cases. Because we don't have a
437 // full FFI, we have to codegen a nullary stub function that just calls the
438 // function we are interested in, passing in constants for all of the
439 // arguments. Make this function and return.
440
441 // First, create the function.
Owen Anderson6b6e2d92009-07-29 22:17:13 +0000442 FunctionType *STy=FunctionType::get(RetTy, false);
Gabor Greifd6da1d02008-04-06 20:25:17 +0000443 Function *Stub = Function::Create(STy, Function::InternalLinkage, "",
444 F->getParent());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000445
446 // Insert a basic block.
Owen Anderson35b47072009-08-13 21:58:54 +0000447 BasicBlock *StubBB = BasicBlock::Create(F->getContext(), "", Stub);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000448
449 // Convert all of the GenericValue arguments over to constants. Note that we
450 // currently don't support varargs.
451 SmallVector<Value*, 8> Args;
452 for (unsigned i = 0, e = ArgValues.size(); i != e; ++i) {
453 Constant *C = 0;
454 const Type *ArgTy = FTy->getParamType(i);
455 const GenericValue &AV = ArgValues[i];
456 switch (ArgTy->getTypeID()) {
Edwin Törökbd448e32009-07-14 16:55:14 +0000457 default: llvm_unreachable("Unknown argument type for function call!");
Chris Lattner5e0610f2008-04-20 00:41:09 +0000458 case Type::IntegerTyID:
Owen Andersoneacb44d2009-07-24 23:12:02 +0000459 C = ConstantInt::get(F->getContext(), AV.IntVal);
Chris Lattner5e0610f2008-04-20 00:41:09 +0000460 break;
461 case Type::FloatTyID:
Owen Andersond363a0e2009-07-27 20:59:43 +0000462 C = ConstantFP::get(F->getContext(), APFloat(AV.FloatVal));
Chris Lattner5e0610f2008-04-20 00:41:09 +0000463 break;
464 case Type::DoubleTyID:
Owen Andersond363a0e2009-07-27 20:59:43 +0000465 C = ConstantFP::get(F->getContext(), APFloat(AV.DoubleVal));
Chris Lattner5e0610f2008-04-20 00:41:09 +0000466 break;
Dale Johannesenc560da62007-09-17 18:44:13 +0000467 case Type::PPC_FP128TyID:
468 case Type::X86_FP80TyID:
Chris Lattner5e0610f2008-04-20 00:41:09 +0000469 case Type::FP128TyID:
Owen Andersond363a0e2009-07-27 20:59:43 +0000470 C = ConstantFP::get(F->getContext(), APFloat(AV.IntVal));
Chris Lattner5e0610f2008-04-20 00:41:09 +0000471 break;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000472 case Type::PointerTyID:
473 void *ArgPtr = GVTOP(AV);
Chris Lattner5e0610f2008-04-20 00:41:09 +0000474 if (sizeof(void*) == 4)
Owen Anderson35b47072009-08-13 21:58:54 +0000475 C = ConstantInt::get(Type::getInt32Ty(F->getContext()),
476 (int)(intptr_t)ArgPtr);
Chris Lattner5e0610f2008-04-20 00:41:09 +0000477 else
Owen Anderson35b47072009-08-13 21:58:54 +0000478 C = ConstantInt::get(Type::getInt64Ty(F->getContext()),
479 (intptr_t)ArgPtr);
Owen Anderson9f5b2aa2009-07-14 23:09:55 +0000480 // Cast the integer to pointer
Owen Anderson02b48c32009-07-29 18:55:55 +0000481 C = ConstantExpr::getIntToPtr(C, ArgTy);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000482 break;
483 }
484 Args.push_back(C);
485 }
486
Gabor Greifb91ea9d2008-05-15 10:04:30 +0000487 CallInst *TheCall = CallInst::Create(F, Args.begin(), Args.end(),
488 "", StubBB);
Chris Lattner62ef4f12008-11-23 08:00:11 +0000489 TheCall->setCallingConv(F->getCallingConv());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000490 TheCall->setTailCall();
Benjamin Kramerf2052d52010-01-05 13:12:22 +0000491 if (!TheCall->getType()->isVoidTy())
Owen Anderson35b47072009-08-13 21:58:54 +0000492 // Return result of the call.
493 ReturnInst::Create(F->getContext(), TheCall, StubBB);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000494 else
Owen Anderson35b47072009-08-13 21:58:54 +0000495 ReturnInst::Create(F->getContext(), StubBB); // Just return void.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000496
497 // Finally, return the value returned by our nullary stub function.
498 return runFunction(Stub, std::vector<GenericValue>());
499}
500
Jeffrey Yasskinf8d55342009-06-25 02:04:04 +0000501void JIT::RegisterJITEventListener(JITEventListener *L) {
502 if (L == NULL)
503 return;
504 MutexGuard locked(lock);
505 EventListeners.push_back(L);
506}
507void JIT::UnregisterJITEventListener(JITEventListener *L) {
508 if (L == NULL)
509 return;
510 MutexGuard locked(lock);
511 std::vector<JITEventListener*>::reverse_iterator I=
512 std::find(EventListeners.rbegin(), EventListeners.rend(), L);
513 if (I != EventListeners.rend()) {
514 std::swap(*I, EventListeners.back());
515 EventListeners.pop_back();
516 }
517}
518void JIT::NotifyFunctionEmitted(
519 const Function &F,
520 void *Code, size_t Size,
521 const JITEvent_EmittedFunctionDetails &Details) {
522 MutexGuard locked(lock);
523 for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
524 EventListeners[I]->NotifyFunctionEmitted(F, Code, Size, Details);
525 }
526}
527
Jeffrey Yasskin1291fce62009-10-27 00:03:05 +0000528void JIT::NotifyFreeingMachineCode(void *OldPtr) {
Jeffrey Yasskinf8d55342009-06-25 02:04:04 +0000529 MutexGuard locked(lock);
530 for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
Jeffrey Yasskin1291fce62009-10-27 00:03:05 +0000531 EventListeners[I]->NotifyFreeingMachineCode(OldPtr);
Jeffrey Yasskinf8d55342009-06-25 02:04:04 +0000532 }
533}
534
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000535/// runJITOnFunction - Run the FunctionPassManager full of
536/// just-in-time compilation passes on F, hopefully filling in
537/// GlobalAddress[F] with the address of F's machine code.
538///
Argiris Kirtzidis6841c1a2009-05-18 21:06:40 +0000539void JIT::runJITOnFunction(Function *F, MachineCodeInfo *MCI) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000540 MutexGuard locked(lock);
Argiris Kirtzidis6841c1a2009-05-18 21:06:40 +0000541
Jeffrey Yasskinf8d55342009-06-25 02:04:04 +0000542 class MCIListener : public JITEventListener {
543 MachineCodeInfo *const MCI;
544 public:
545 MCIListener(MachineCodeInfo *mci) : MCI(mci) {}
546 virtual void NotifyFunctionEmitted(const Function &,
547 void *Code, size_t Size,
548 const EmittedFunctionDetails &) {
549 MCI->setAddress(Code);
550 MCI->setSize(Size);
551 }
552 };
553 MCIListener MCIL(MCI);
Jeffrey Yasskine4184542009-12-22 23:18:18 +0000554 if (MCI)
555 RegisterJITEventListener(&MCIL);
Argiris Kirtzidis6841c1a2009-05-18 21:06:40 +0000556
Dan Gohman2970af12009-02-06 21:25:08 +0000557 runJITOnFunctionUnlocked(F, locked);
Argiris Kirtzidis6841c1a2009-05-18 21:06:40 +0000558
Jeffrey Yasskine4184542009-12-22 23:18:18 +0000559 if (MCI)
560 UnregisterJITEventListener(&MCIL);
Dan Gohman2970af12009-02-06 21:25:08 +0000561}
562
563void JIT::runJITOnFunctionUnlocked(Function *F, const MutexGuard &locked) {
564 static bool isAlreadyCodeGenerating = false;
Chris Lattner700fb1d2007-08-13 20:08:16 +0000565 assert(!isAlreadyCodeGenerating && "Error: Recursive compilation detected!");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000566
567 // JIT the function
568 isAlreadyCodeGenerating = true;
Nate Begemanf7113d92008-05-21 16:34:48 +0000569 jitstate->getPM(locked).run(*F);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000570 isAlreadyCodeGenerating = false;
571
Nate Begeman7b1a8472009-02-18 08:31:02 +0000572 // If the function referred to another function that had not yet been
Jeffrey Yasskin4f6ac2f2009-10-27 20:30:28 +0000573 // read from bitcode, and we are jitting non-lazily, emit it now.
Nate Begeman7b1a8472009-02-18 08:31:02 +0000574 while (!jitstate->getPendingFunctions(locked).empty()) {
575 Function *PF = jitstate->getPendingFunctions(locked).back();
576 jitstate->getPendingFunctions(locked).pop_back();
577
Jeffrey Yasskin898fb792009-12-17 21:35:29 +0000578 assert(!PF->hasAvailableExternallyLinkage() &&
579 "Externally-defined function should not be in pending list.");
580
Nate Begeman7b1a8472009-02-18 08:31:02 +0000581 // JIT the function
582 isAlreadyCodeGenerating = true;
583 jitstate->getPM(locked).run(*PF);
584 isAlreadyCodeGenerating = false;
585
586 // Now that the function has been jitted, ask the JITEmitter to rewrite
587 // the stub with real address of the function.
588 updateFunctionStub(PF);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000589 }
590}
591
592/// getPointerToFunction - This method is used to get the address of the
593/// specified function, compiling it if neccesary.
594///
595void *JIT::getPointerToFunction(Function *F) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000596
597 if (void *Addr = getPointerToGlobalIfAvailable(F))
598 return Addr; // Check if function already code gen'd
599
Dan Gohman039d2a72009-02-19 02:40:15 +0000600 MutexGuard locked(lock);
601
Jeffrey Yasskin898fb792009-12-17 21:35:29 +0000602 // Now that this thread owns the lock, make sure we read in the function if it
603 // exists in this Module.
604 std::string ErrorMsg;
Jeffrey Yasskin62de4e72010-01-27 20:34:15 +0000605 if (F->Materialize(&ErrorMsg)) {
Jeffrey Yasskin898fb792009-12-17 21:35:29 +0000606 llvm_report_error("Error reading function '" + F->getName()+
607 "' from bitcode file: " + ErrorMsg);
Nicolas Geoffray8ae32352008-04-20 08:33:02 +0000608 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000609
Jeffrey Yasskin898fb792009-12-17 21:35:29 +0000610 // ... and check if another thread has already code gen'd the function.
611 if (void *Addr = getPointerToGlobalIfAvailable(F))
612 return Addr;
613
Chris Lattner79cdc2e2009-10-25 23:06:42 +0000614 if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
Jeffrey Yasskin35294ef2009-11-09 22:34:19 +0000615 bool AbortOnFailure = !F->hasExternalWeakLinkage();
Dan Gohman0ae39622009-01-05 05:32:42 +0000616 void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000617 addGlobalMapping(F, Addr);
618 return Addr;
619 }
620
Dan Gohman2970af12009-02-06 21:25:08 +0000621 runJITOnFunctionUnlocked(F, locked);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000622
623 void *Addr = getPointerToGlobalIfAvailable(F);
624 assert(Addr && "Code generation didn't add function to GlobalAddress table!");
625 return Addr;
626}
627
628/// getOrEmitGlobalVariable - Return the address of the specified global
629/// variable, possibly emitting it to memory if needed. This is used by the
630/// Emitter.
631void *JIT::getOrEmitGlobalVariable(const GlobalVariable *GV) {
632 MutexGuard locked(lock);
633
634 void *Ptr = getPointerToGlobalIfAvailable(GV);
635 if (Ptr) return Ptr;
636
637 // If the global is external, just remember the address.
Jeffrey Yasskin7fe6f872009-12-13 20:30:32 +0000638 if (GV->isDeclaration() || GV->hasAvailableExternallyLinkage()) {
Anton Korobeynikov52f44db2007-07-30 20:02:02 +0000639#if HAVE___DSO_HANDLE
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000640 if (GV->getName() == "__dso_handle")
641 return (void*)&__dso_handle;
642#endif
Daniel Dunbar9198e932009-07-21 08:54:24 +0000643 Ptr = sys::DynamicLibrary::SearchForAddressOfSymbol(GV->getName());
Jeffrey Yasskin35294ef2009-11-09 22:34:19 +0000644 if (Ptr == 0) {
Edwin Törökf7cbfea2009-07-07 17:32:34 +0000645 llvm_report_error("Could not resolve external global address: "
646 +GV->getName());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000647 }
Nate Begemane1ba87f2009-03-04 19:10:38 +0000648 addGlobalMapping(GV, Ptr);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000649 } else {
Dale Johannesen0ba4a0e2008-08-07 01:30:15 +0000650 // If the global hasn't been emitted to memory yet, allocate space and
Jeffrey Yasskin892956a2009-07-08 21:59:57 +0000651 // emit it into memory.
652 Ptr = getMemoryForGV(GV);
Dale Johannesen0ba4a0e2008-08-07 01:30:15 +0000653 addGlobalMapping(GV, Ptr);
Jeffrey Yasskin892956a2009-07-08 21:59:57 +0000654 EmitGlobalVariable(GV); // Initialize the variable.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000655 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000656 return Ptr;
657}
658
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000659/// recompileAndRelinkFunction - This method is used to force a function
660/// which has already been compiled, to be compiled again, possibly
661/// after it has been modified. Then the entry to the old copy is overwritten
662/// with a branch to the new copy. If there was no old copy, this acts
663/// just like JIT::getPointerToFunction().
664///
665void *JIT::recompileAndRelinkFunction(Function *F) {
666 void *OldAddr = getPointerToGlobalIfAvailable(F);
667
668 // If it's not already compiled there is no reason to patch it up.
669 if (OldAddr == 0) { return getPointerToFunction(F); }
670
671 // Delete the old function mapping.
672 addGlobalMapping(F, 0);
673
674 // Recodegen the function
675 runJITOnFunction(F);
676
677 // Update state, forward the old function to the new function.
678 void *Addr = getPointerToGlobalIfAvailable(F);
679 assert(Addr && "Code generation didn't add function to GlobalAddress table!");
680 TJI.replaceMachineCodeForFunction(OldAddr, Addr);
681 return Addr;
682}
683
Nicolas Geoffray46fa1532008-10-25 15:41:43 +0000684/// getMemoryForGV - This method abstracts memory allocation of global
685/// variable so that the JIT can allocate thread local variables depending
686/// on the target.
687///
688char* JIT::getMemoryForGV(const GlobalVariable* GV) {
Jeffrey Yasskin892956a2009-07-08 21:59:57 +0000689 char *Ptr;
690
691 // GlobalVariable's which are not "constant" will cause trouble in a server
692 // situation. It's returned in the same block of memory as code which may
693 // not be writable.
694 if (isGVCompilationDisabled() && !GV->isConstant()) {
Edwin Törökced9ff82009-07-11 13:10:19 +0000695 llvm_report_error("Compilation of non-internal GlobalValue is disabled!");
Jeffrey Yasskin892956a2009-07-08 21:59:57 +0000696 }
697
698 // Some applications require globals and code to live together, so they may
699 // be allocated into the same buffer, but in general globals are allocated
700 // through the memory manager which puts them near the code but not in the
701 // same buffer.
702 const Type *GlobalType = GV->getType()->getElementType();
703 size_t S = getTargetData()->getTypeAllocSize(GlobalType);
704 size_t A = getTargetData()->getPreferredAlignment(GV);
Nicolas Geoffray46fa1532008-10-25 15:41:43 +0000705 if (GV->isThreadLocal()) {
706 MutexGuard locked(lock);
Jeffrey Yasskin892956a2009-07-08 21:59:57 +0000707 Ptr = TJI.allocateThreadLocalMemory(S);
708 } else if (TJI.allocateSeparateGVMemory()) {
709 if (A <= 8) {
710 Ptr = (char*)malloc(S);
711 } else {
712 // Allocate S+A bytes of memory, then use an aligned pointer within that
713 // space.
714 Ptr = (char*)malloc(S+A);
715 unsigned MisAligned = ((intptr_t)Ptr & (A-1));
716 Ptr = Ptr + (MisAligned ? (A-MisAligned) : 0);
717 }
718 } else if (AllocateGVsWithCode) {
719 Ptr = (char*)JCE->allocateSpace(S, A);
Nicolas Geoffray46fa1532008-10-25 15:41:43 +0000720 } else {
Jeffrey Yasskin892956a2009-07-08 21:59:57 +0000721 Ptr = (char*)JCE->allocateGlobal(S, A);
Nicolas Geoffray46fa1532008-10-25 15:41:43 +0000722 }
Jeffrey Yasskin892956a2009-07-08 21:59:57 +0000723 return Ptr;
Nicolas Geoffray46fa1532008-10-25 15:41:43 +0000724}
Nate Begeman7b1a8472009-02-18 08:31:02 +0000725
726void JIT::addPendingFunction(Function *F) {
727 MutexGuard locked(lock);
728 jitstate->getPendingFunctions(locked).push_back(F);
729}
Jeffrey Yasskinf8d55342009-06-25 02:04:04 +0000730
731
732JITEventListener::~JITEventListener() {}