Exposing MCJIT through C API
[oota-llvm.git] / lib / ExecutionEngine / MCJIT / MCJIT.cpp
1 //===-- MCJIT.cpp - MC-based Just-in-Time Compiler ------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #include "MCJIT.h"
11 #include "llvm/ExecutionEngine/GenericValue.h"
12 #include "llvm/ExecutionEngine/JITEventListener.h"
13 #include "llvm/ExecutionEngine/JITMemoryManager.h"
14 #include "llvm/ExecutionEngine/MCJIT.h"
15 #include "llvm/ExecutionEngine/ObjectBuffer.h"
16 #include "llvm/ExecutionEngine/ObjectImage.h"
17 #include "llvm/ExecutionEngine/SectionMemoryManager.h"
18 #include "llvm/IR/DataLayout.h"
19 #include "llvm/IR/DerivedTypes.h"
20 #include "llvm/IR/Function.h"
21 #include "llvm/MC/MCAsmInfo.h"
22 #include "llvm/Support/DynamicLibrary.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/MemoryBuffer.h"
25 #include "llvm/Support/MutexGuard.h"
26
27 using namespace llvm;
28
29 namespace {
30
31 static struct RegisterJIT {
32   RegisterJIT() { MCJIT::Register(); }
33 } JITRegistrator;
34
35 }
36
37 extern "C" void LLVMLinkInMCJIT() {
38 }
39
40 ExecutionEngine *MCJIT::createJIT(Module *M,
41                                   std::string *ErrorStr,
42                                   JITMemoryManager *JMM,
43                                   bool GVsWithCode,
44                                   TargetMachine *TM) {
45   // Try to register the program as a source of symbols to resolve against.
46   //
47   // FIXME: Don't do this here.
48   sys::DynamicLibrary::LoadLibraryPermanently(0, NULL);
49
50   return new MCJIT(M, TM, JMM ? JMM : new SectionMemoryManager(), GVsWithCode);
51 }
52
53 MCJIT::MCJIT(Module *m, TargetMachine *tm, RTDyldMemoryManager *MM,
54              bool AllocateGVsWithCode)
55   : ExecutionEngine(m), TM(tm), Ctx(0), MemMgr(MM), Dyld(MM),
56     IsLoaded(false), M(m), ObjCache(0)  {
57
58   setDataLayout(TM->getDataLayout());
59 }
60
61 MCJIT::~MCJIT() {
62   if (LoadedObject)
63     NotifyFreeingObject(*LoadedObject.get());
64   delete MemMgr;
65   delete TM;
66 }
67
68 void MCJIT::setObjectCache(ObjectCache* NewCache) {
69   ObjCache = NewCache;
70 }
71
72 ObjectBufferStream* MCJIT::emitObject(Module *m) {
73   /// Currently, MCJIT only supports a single module and the module passed to
74   /// this function call is expected to be the contained module.  The module
75   /// is passed as a parameter here to prepare for multiple module support in
76   /// the future.
77   assert(M == m);
78
79   // Get a thread lock to make sure we aren't trying to compile multiple times
80   MutexGuard locked(lock);
81
82   // FIXME: Track compilation state on a per-module basis when multiple modules
83   //        are supported.
84   // Re-compilation is not supported
85   assert(!IsLoaded);
86
87   PassManager PM;
88
89   PM.add(new DataLayout(*TM->getDataLayout()));
90
91   // The RuntimeDyld will take ownership of this shortly
92   OwningPtr<ObjectBufferStream> CompiledObject(new ObjectBufferStream());
93
94   // Turn the machine code intermediate representation into bytes in memory
95   // that may be executed.
96   if (TM->addPassesToEmitMC(PM, Ctx, CompiledObject->getOStream(), false)) {
97     report_fatal_error("Target does not support MC emission!");
98   }
99
100   // Initialize passes.
101   PM.run(*m);
102   // Flush the output buffer to get the generated code into memory
103   CompiledObject->flush();
104
105   // If we have an object cache, tell it about the new object.
106   // Note that we're using the compiled image, not the loaded image (as below).
107   if (ObjCache) {
108     // MemoryBuffer is a thin wrapper around the actual memory, so it's OK
109     // to create a temporary object here and delete it after the call.
110     OwningPtr<MemoryBuffer> MB(CompiledObject->getMemBuffer());
111     ObjCache->notifyObjectCompiled(m, MB.get());
112   }
113
114   return CompiledObject.take();
115 }
116
117 void MCJIT::loadObject(Module *M) {
118
119   // Get a thread lock to make sure we aren't trying to load multiple times
120   MutexGuard locked(lock);
121
122   // FIXME: Track compilation state on a per-module basis when multiple modules
123   //        are supported.
124   // Re-compilation is not supported
125   if (IsLoaded)
126     return;
127
128   OwningPtr<ObjectBuffer> ObjectToLoad;
129   // Try to load the pre-compiled object from cache if possible
130   if (0 != ObjCache) {
131     OwningPtr<MemoryBuffer> PreCompiledObject(ObjCache->getObjectCopy(M));
132     if (0 != PreCompiledObject.get())
133       ObjectToLoad.reset(new ObjectBuffer(PreCompiledObject.take()));
134   }
135
136   // If the cache did not contain a suitable object, compile the object
137   if (!ObjectToLoad) {
138     ObjectToLoad.reset(emitObject(M));
139     assert(ObjectToLoad.get() && "Compilation did not produce an object.");
140   }
141
142   // Load the object into the dynamic linker.
143   // handing off ownership of the buffer
144   LoadedObject.reset(Dyld.loadObject(ObjectToLoad.take()));
145   if (!LoadedObject)
146     report_fatal_error(Dyld.getErrorString());
147
148   // Resolve any relocations.
149   Dyld.resolveRelocations();
150
151   // FIXME: Make this optional, maybe even move it to a JIT event listener
152   LoadedObject->registerWithDebugger();
153
154   NotifyObjectEmitted(*LoadedObject);
155
156   // FIXME: Add support for per-module compilation state
157   IsLoaded = true;
158 }
159
160 // FIXME: Add a parameter to identify which object is being finalized when
161 // MCJIT supports multiple modules.
162 // FIXME: Provide a way to separate code emission, relocations and page 
163 // protection in the interface.
164 void MCJIT::finalizeObject() {
165   // If the module hasn't been compiled, just do that.
166   if (!IsLoaded) {
167     // If the call to Dyld.resolveRelocations() is removed from loadObject()
168     // we'll need to do that here.
169     loadObject(M);
170
171     // Set page permissions.
172     MemMgr->applyPermissions();
173
174     return;
175   }
176
177   // Resolve any relocations.
178   Dyld.resolveRelocations();
179
180   // Set page permissions.
181   MemMgr->applyPermissions();
182 }
183
184 void *MCJIT::getPointerToBasicBlock(BasicBlock *BB) {
185   report_fatal_error("not yet implemented");
186 }
187
188 void *MCJIT::getPointerToFunction(Function *F) {
189   // FIXME: This should really return a uint64_t since it's a pointer in the
190   // target address space, not our local address space. That's part of the
191   // ExecutionEngine interface, though. Fix that when the old JIT finally
192   // dies.
193
194   // FIXME: Add support for per-module compilation state
195   if (!IsLoaded)
196     loadObject(M);
197
198   if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
199     bool AbortOnFailure = !F->hasExternalWeakLinkage();
200     void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
201     addGlobalMapping(F, Addr);
202     return Addr;
203   }
204
205   // FIXME: Should the Dyld be retaining module information? Probably not.
206   // FIXME: Should we be using the mangler for this? Probably.
207   //
208   // This is the accessor for the target address, so make sure to check the
209   // load address of the symbol, not the local address.
210   StringRef BaseName = F->getName();
211   if (BaseName[0] == '\1')
212     return (void*)Dyld.getSymbolLoadAddress(BaseName.substr(1));
213   return (void*)Dyld.getSymbolLoadAddress((TM->getMCAsmInfo()->getGlobalPrefix()
214                                        + BaseName).str());
215 }
216
217 void *MCJIT::recompileAndRelinkFunction(Function *F) {
218   report_fatal_error("not yet implemented");
219 }
220
221 void MCJIT::freeMachineCodeForFunction(Function *F) {
222   report_fatal_error("not yet implemented");
223 }
224
225 GenericValue MCJIT::runFunction(Function *F,
226                                 const std::vector<GenericValue> &ArgValues) {
227   assert(F && "Function *F was null at entry to run()");
228
229   void *FPtr = getPointerToFunction(F);
230   assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
231   FunctionType *FTy = F->getFunctionType();
232   Type *RetTy = FTy->getReturnType();
233
234   assert((FTy->getNumParams() == ArgValues.size() ||
235           (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
236          "Wrong number of arguments passed into function!");
237   assert(FTy->getNumParams() == ArgValues.size() &&
238          "This doesn't support passing arguments through varargs (yet)!");
239
240   // Handle some common cases first.  These cases correspond to common `main'
241   // prototypes.
242   if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
243     switch (ArgValues.size()) {
244     case 3:
245       if (FTy->getParamType(0)->isIntegerTy(32) &&
246           FTy->getParamType(1)->isPointerTy() &&
247           FTy->getParamType(2)->isPointerTy()) {
248         int (*PF)(int, char **, const char **) =
249           (int(*)(int, char **, const char **))(intptr_t)FPtr;
250
251         // Call the function.
252         GenericValue rv;
253         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
254                                  (char **)GVTOP(ArgValues[1]),
255                                  (const char **)GVTOP(ArgValues[2])));
256         return rv;
257       }
258       break;
259     case 2:
260       if (FTy->getParamType(0)->isIntegerTy(32) &&
261           FTy->getParamType(1)->isPointerTy()) {
262         int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
263
264         // Call the function.
265         GenericValue rv;
266         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
267                                  (char **)GVTOP(ArgValues[1])));
268         return rv;
269       }
270       break;
271     case 1:
272       if (FTy->getNumParams() == 1 &&
273           FTy->getParamType(0)->isIntegerTy(32)) {
274         GenericValue rv;
275         int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
276         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
277         return rv;
278       }
279       break;
280     }
281   }
282
283   // Handle cases where no arguments are passed first.
284   if (ArgValues.empty()) {
285     GenericValue rv;
286     switch (RetTy->getTypeID()) {
287     default: llvm_unreachable("Unknown return type for function call!");
288     case Type::IntegerTyID: {
289       unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
290       if (BitWidth == 1)
291         rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
292       else if (BitWidth <= 8)
293         rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
294       else if (BitWidth <= 16)
295         rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
296       else if (BitWidth <= 32)
297         rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
298       else if (BitWidth <= 64)
299         rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
300       else
301         llvm_unreachable("Integer types > 64 bits not supported");
302       return rv;
303     }
304     case Type::VoidTyID:
305       rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
306       return rv;
307     case Type::FloatTyID:
308       rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
309       return rv;
310     case Type::DoubleTyID:
311       rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
312       return rv;
313     case Type::X86_FP80TyID:
314     case Type::FP128TyID:
315     case Type::PPC_FP128TyID:
316       llvm_unreachable("long double not supported yet");
317     case Type::PointerTyID:
318       return PTOGV(((void*(*)())(intptr_t)FPtr)());
319     }
320   }
321
322   llvm_unreachable("Full-featured argument passing not supported yet!");
323 }
324
325 void *MCJIT::getPointerToNamedFunction(const std::string &Name,
326                                        bool AbortOnFailure) {
327   // FIXME: Add support for per-module compilation state
328   if (!IsLoaded)
329     loadObject(M);
330
331   if (!isSymbolSearchingDisabled() && MemMgr) {
332     void *ptr = MemMgr->getPointerToNamedFunction(Name, false);
333     if (ptr)
334       return ptr;
335   }
336
337   /// If a LazyFunctionCreator is installed, use it to get/create the function.
338   if (LazyFunctionCreator)
339     if (void *RP = LazyFunctionCreator(Name))
340       return RP;
341
342   if (AbortOnFailure) {
343     report_fatal_error("Program used external function '"+Name+
344                        "' which could not be resolved!");
345   }
346   return 0;
347 }
348
349 void MCJIT::RegisterJITEventListener(JITEventListener *L) {
350   if (L == NULL)
351     return;
352   MutexGuard locked(lock);
353   EventListeners.push_back(L);
354 }
355 void MCJIT::UnregisterJITEventListener(JITEventListener *L) {
356   if (L == NULL)
357     return;
358   MutexGuard locked(lock);
359   SmallVector<JITEventListener*, 2>::reverse_iterator I=
360       std::find(EventListeners.rbegin(), EventListeners.rend(), L);
361   if (I != EventListeners.rend()) {
362     std::swap(*I, EventListeners.back());
363     EventListeners.pop_back();
364   }
365 }
366 void MCJIT::NotifyObjectEmitted(const ObjectImage& Obj) {
367   MutexGuard locked(lock);
368   for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
369     EventListeners[I]->NotifyObjectEmitted(Obj);
370   }
371 }
372 void MCJIT::NotifyFreeingObject(const ObjectImage& Obj) {
373   MutexGuard locked(lock);
374   for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
375     EventListeners[I]->NotifyFreeingObject(Obj);
376   }
377 }