1 //===-- ExecutionEngineBindings.cpp - C bindings for EEs ------------------===//
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 // This file defines the C bindings for the ExecutionEngine library.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm-c/ExecutionEngine.h"
15 #include "llvm/ExecutionEngine/ExecutionEngine.h"
16 #include "llvm/ExecutionEngine/GenericValue.h"
17 #include "llvm/ExecutionEngine/RTDyldMemoryManager.h"
18 #include "llvm/IR/DerivedTypes.h"
19 #include "llvm/IR/Module.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include <cstring>
22 
23 using namespace llvm;
24 
25 #define DEBUG_TYPE "jit"
26 
27 // Wrapping the C bindings types.
28 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(GenericValue, LLVMGenericValueRef)
29 
30 
31 inline LLVMTargetMachineRef wrap(const TargetMachine *P) {
32   return
33   reinterpret_cast<LLVMTargetMachineRef>(const_cast<TargetMachine*>(P));
34 }
35 
36 /*===-- Operations on generic values --------------------------------------===*/
37 
38 LLVMGenericValueRef LLVMCreateGenericValueOfInt(LLVMTypeRef Ty,
39                                                 unsigned long long N,
40                                                 LLVMBool IsSigned) {
41   GenericValue *GenVal = new GenericValue();
42   GenVal->IntVal = APInt(unwrap<IntegerType>(Ty)->getBitWidth(), N, IsSigned);
43   return wrap(GenVal);
44 }
45 
46 LLVMGenericValueRef LLVMCreateGenericValueOfPointer(void *P) {
47   GenericValue *GenVal = new GenericValue();
48   GenVal->PointerVal = P;
49   return wrap(GenVal);
50 }
51 
52 LLVMGenericValueRef LLVMCreateGenericValueOfFloat(LLVMTypeRef TyRef, double N) {
53   GenericValue *GenVal = new GenericValue();
54   switch (unwrap(TyRef)->getTypeID()) {
55   case Type::FloatTyID:
56     GenVal->FloatVal = N;
57     break;
58   case Type::DoubleTyID:
59     GenVal->DoubleVal = N;
60     break;
61   default:
62     llvm_unreachable("LLVMGenericValueToFloat supports only float and double.");
63   }
64   return wrap(GenVal);
65 }
66 
67 unsigned LLVMGenericValueIntWidth(LLVMGenericValueRef GenValRef) {
68   return unwrap(GenValRef)->IntVal.getBitWidth();
69 }
70 
71 unsigned long long LLVMGenericValueToInt(LLVMGenericValueRef GenValRef,
72                                          LLVMBool IsSigned) {
73   GenericValue *GenVal = unwrap(GenValRef);
74   if (IsSigned)
75     return GenVal->IntVal.getSExtValue();
76   else
77     return GenVal->IntVal.getZExtValue();
78 }
79 
80 void *LLVMGenericValueToPointer(LLVMGenericValueRef GenVal) {
81   return unwrap(GenVal)->PointerVal;
82 }
83 
84 double LLVMGenericValueToFloat(LLVMTypeRef TyRef, LLVMGenericValueRef GenVal) {
85   switch (unwrap(TyRef)->getTypeID()) {
86   case Type::FloatTyID:
87     return unwrap(GenVal)->FloatVal;
88   case Type::DoubleTyID:
89     return unwrap(GenVal)->DoubleVal;
90   default:
91     llvm_unreachable("LLVMGenericValueToFloat supports only float and double.");
92   }
93 }
94 
95 void LLVMDisposeGenericValue(LLVMGenericValueRef GenVal) {
96   delete unwrap(GenVal);
97 }
98 
99 /*===-- Operations on execution engines -----------------------------------===*/
100 
101 LLVMBool LLVMCreateExecutionEngineForModule(LLVMExecutionEngineRef *OutEE,
102                                             LLVMModuleRef M,
103                                             char **OutError) {
104   std::string Error;
105   EngineBuilder builder(std::unique_ptr<Module>(unwrap(M)));
106   builder.setEngineKind(EngineKind::Either)
107          .setErrorStr(&Error);
108   if (ExecutionEngine *EE = builder.create()){
109     *OutEE = wrap(EE);
110     return 0;
111   }
112   *OutError = strdup(Error.c_str());
113   return 1;
114 }
115 
116 LLVMBool LLVMCreateInterpreterForModule(LLVMExecutionEngineRef *OutInterp,
117                                         LLVMModuleRef M,
118                                         char **OutError) {
119   std::string Error;
120   EngineBuilder builder(std::unique_ptr<Module>(unwrap(M)));
121   builder.setEngineKind(EngineKind::Interpreter)
122          .setErrorStr(&Error);
123   if (ExecutionEngine *Interp = builder.create()) {
124     *OutInterp = wrap(Interp);
125     return 0;
126   }
127   *OutError = strdup(Error.c_str());
128   return 1;
129 }
130 
131 LLVMBool LLVMCreateJITCompilerForModule(LLVMExecutionEngineRef *OutJIT,
132                                         LLVMModuleRef M,
133                                         unsigned OptLevel,
134                                         char **OutError) {
135   std::string Error;
136   EngineBuilder builder(std::unique_ptr<Module>(unwrap(M)));
137   builder.setEngineKind(EngineKind::JIT)
138          .setErrorStr(&Error)
139          .setOptLevel((CodeGenOpt::Level)OptLevel);
140   if (ExecutionEngine *JIT = builder.create()) {
141     *OutJIT = wrap(JIT);
142     return 0;
143   }
144   *OutError = strdup(Error.c_str());
145   return 1;
146 }
147 
148 void LLVMInitializeMCJITCompilerOptions(LLVMMCJITCompilerOptions *PassedOptions,
149                                         size_t SizeOfPassedOptions) {
150   LLVMMCJITCompilerOptions options;
151   memset(&options, 0, sizeof(options)); // Most fields are zero by default.
152   options.CodeModel = LLVMCodeModelJITDefault;
153 
154   memcpy(PassedOptions, &options,
155          std::min(sizeof(options), SizeOfPassedOptions));
156 }
157 
158 LLVMBool LLVMCreateMCJITCompilerForModule(
159     LLVMExecutionEngineRef *OutJIT, LLVMModuleRef M,
160     LLVMMCJITCompilerOptions *PassedOptions, size_t SizeOfPassedOptions,
161     char **OutError) {
162   LLVMMCJITCompilerOptions options;
163   // If the user passed a larger sized options struct, then they were compiled
164   // against a newer LLVM. Tell them that something is wrong.
165   if (SizeOfPassedOptions > sizeof(options)) {
166     *OutError = strdup(
167       "Refusing to use options struct that is larger than my own; assuming "
168       "LLVM library mismatch.");
169     return 1;
170   }
171 
172   // Defend against the user having an old version of the API by ensuring that
173   // any fields they didn't see are cleared. We must defend against fields being
174   // set to the bitwise equivalent of zero, and assume that this means "do the
175   // default" as if that option hadn't been available.
176   LLVMInitializeMCJITCompilerOptions(&options, sizeof(options));
177   memcpy(&options, PassedOptions, SizeOfPassedOptions);
178 
179   TargetOptions targetOptions;
180   targetOptions.NoFramePointerElim = options.NoFramePointerElim;
181   targetOptions.EnableFastISel = options.EnableFastISel;
182 
183   std::string Error;
184   EngineBuilder builder(std::unique_ptr<Module>(unwrap(M)));
185   builder.setEngineKind(EngineKind::JIT)
186          .setErrorStr(&Error)
187          .setUseMCJIT(true)
188          .setOptLevel((CodeGenOpt::Level)options.OptLevel)
189          .setCodeModel(unwrap(options.CodeModel))
190          .setTargetOptions(targetOptions);
191   if (options.MCJMM)
192     builder.setMCJITMemoryManager(unwrap(options.MCJMM));
193   if (ExecutionEngine *JIT = builder.create()) {
194     *OutJIT = wrap(JIT);
195     return 0;
196   }
197   *OutError = strdup(Error.c_str());
198   return 1;
199 }
200 
201 LLVMBool LLVMCreateExecutionEngine(LLVMExecutionEngineRef *OutEE,
202                                    LLVMModuleProviderRef MP,
203                                    char **OutError) {
204   /* The module provider is now actually a module. */
205   return LLVMCreateExecutionEngineForModule(OutEE,
206                                             reinterpret_cast<LLVMModuleRef>(MP),
207                                             OutError);
208 }
209 
210 LLVMBool LLVMCreateInterpreter(LLVMExecutionEngineRef *OutInterp,
211                                LLVMModuleProviderRef MP,
212                                char **OutError) {
213   /* The module provider is now actually a module. */
214   return LLVMCreateInterpreterForModule(OutInterp,
215                                         reinterpret_cast<LLVMModuleRef>(MP),
216                                         OutError);
217 }
218 
219 LLVMBool LLVMCreateJITCompiler(LLVMExecutionEngineRef *OutJIT,
220                                LLVMModuleProviderRef MP,
221                                unsigned OptLevel,
222                                char **OutError) {
223   /* The module provider is now actually a module. */
224   return LLVMCreateJITCompilerForModule(OutJIT,
225                                         reinterpret_cast<LLVMModuleRef>(MP),
226                                         OptLevel, OutError);
227 }
228 
229 
230 void LLVMDisposeExecutionEngine(LLVMExecutionEngineRef EE) {
231   delete unwrap(EE);
232 }
233 
234 void LLVMRunStaticConstructors(LLVMExecutionEngineRef EE) {
235   unwrap(EE)->runStaticConstructorsDestructors(false);
236 }
237 
238 void LLVMRunStaticDestructors(LLVMExecutionEngineRef EE) {
239   unwrap(EE)->runStaticConstructorsDestructors(true);
240 }
241 
242 int LLVMRunFunctionAsMain(LLVMExecutionEngineRef EE, LLVMValueRef F,
243                           unsigned ArgC, const char * const *ArgV,
244                           const char * const *EnvP) {
245   unwrap(EE)->finalizeObject();
246 
247   std::vector<std::string> ArgVec;
248   for (unsigned I = 0; I != ArgC; ++I)
249     ArgVec.push_back(ArgV[I]);
250 
251   return unwrap(EE)->runFunctionAsMain(unwrap<Function>(F), ArgVec, EnvP);
252 }
253 
254 LLVMGenericValueRef LLVMRunFunction(LLVMExecutionEngineRef EE, LLVMValueRef F,
255                                     unsigned NumArgs,
256                                     LLVMGenericValueRef *Args) {
257   unwrap(EE)->finalizeObject();
258 
259   std::vector<GenericValue> ArgVec;
260   ArgVec.reserve(NumArgs);
261   for (unsigned I = 0; I != NumArgs; ++I)
262     ArgVec.push_back(*unwrap(Args[I]));
263 
264   GenericValue *Result = new GenericValue();
265   *Result = unwrap(EE)->runFunction(unwrap<Function>(F), ArgVec);
266   return wrap(Result);
267 }
268 
269 void LLVMFreeMachineCodeForFunction(LLVMExecutionEngineRef EE, LLVMValueRef F) {
270   unwrap(EE)->freeMachineCodeForFunction(unwrap<Function>(F));
271 }
272 
273 void LLVMAddModule(LLVMExecutionEngineRef EE, LLVMModuleRef M){
274   unwrap(EE)->addModule(std::unique_ptr<Module>(unwrap(M)));
275 }
276 
277 void LLVMAddModuleProvider(LLVMExecutionEngineRef EE, LLVMModuleProviderRef MP){
278   /* The module provider is now actually a module. */
279   LLVMAddModule(EE, reinterpret_cast<LLVMModuleRef>(MP));
280 }
281 
282 LLVMBool LLVMRemoveModule(LLVMExecutionEngineRef EE, LLVMModuleRef M,
283                           LLVMModuleRef *OutMod, char **OutError) {
284   Module *Mod = unwrap(M);
285   unwrap(EE)->removeModule(Mod);
286   *OutMod = wrap(Mod);
287   return 0;
288 }
289 
290 LLVMBool LLVMRemoveModuleProvider(LLVMExecutionEngineRef EE,
291                                   LLVMModuleProviderRef MP,
292                                   LLVMModuleRef *OutMod, char **OutError) {
293   /* The module provider is now actually a module. */
294   return LLVMRemoveModule(EE, reinterpret_cast<LLVMModuleRef>(MP), OutMod,
295                           OutError);
296 }
297 
298 LLVMBool LLVMFindFunction(LLVMExecutionEngineRef EE, const char *Name,
299                           LLVMValueRef *OutFn) {
300   if (Function *F = unwrap(EE)->FindFunctionNamed(Name)) {
301     *OutFn = wrap(F);
302     return 0;
303   }
304   return 1;
305 }
306 
307 void *LLVMRecompileAndRelinkFunction(LLVMExecutionEngineRef EE,
308                                      LLVMValueRef Fn) {
309   return unwrap(EE)->recompileAndRelinkFunction(unwrap<Function>(Fn));
310 }
311 
312 LLVMTargetDataRef LLVMGetExecutionEngineTargetData(LLVMExecutionEngineRef EE) {
313   return wrap(unwrap(EE)->getDataLayout());
314 }
315 
316 LLVMTargetMachineRef
317 LLVMGetExecutionEngineTargetMachine(LLVMExecutionEngineRef EE) {
318   return wrap(unwrap(EE)->getTargetMachine());
319 }
320 
321 void LLVMAddGlobalMapping(LLVMExecutionEngineRef EE, LLVMValueRef Global,
322                           void* Addr) {
323   unwrap(EE)->addGlobalMapping(unwrap<GlobalValue>(Global), Addr);
324 }
325 
326 void *LLVMGetPointerToGlobal(LLVMExecutionEngineRef EE, LLVMValueRef Global) {
327   unwrap(EE)->finalizeObject();
328 
329   return unwrap(EE)->getPointerToGlobal(unwrap<GlobalValue>(Global));
330 }
331 
332 /*===-- Operations on memory managers -------------------------------------===*/
333 
334 namespace {
335 
336 struct SimpleBindingMMFunctions {
337   LLVMMemoryManagerAllocateCodeSectionCallback AllocateCodeSection;
338   LLVMMemoryManagerAllocateDataSectionCallback AllocateDataSection;
339   LLVMMemoryManagerFinalizeMemoryCallback FinalizeMemory;
340   LLVMMemoryManagerDestroyCallback Destroy;
341 };
342 
343 class SimpleBindingMemoryManager : public RTDyldMemoryManager {
344 public:
345   SimpleBindingMemoryManager(const SimpleBindingMMFunctions& Functions,
346                              void *Opaque);
347   virtual ~SimpleBindingMemoryManager();
348 
349   uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
350                                unsigned SectionID,
351                                StringRef SectionName) override;
352 
353   uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
354                                unsigned SectionID, StringRef SectionName,
355                                bool isReadOnly) override;
356 
357   bool finalizeMemory(std::string *ErrMsg) override;
358 
359 private:
360   SimpleBindingMMFunctions Functions;
361   void *Opaque;
362 };
363 
364 SimpleBindingMemoryManager::SimpleBindingMemoryManager(
365   const SimpleBindingMMFunctions& Functions,
366   void *Opaque)
367   : Functions(Functions), Opaque(Opaque) {
368   assert(Functions.AllocateCodeSection &&
369          "No AllocateCodeSection function provided!");
370   assert(Functions.AllocateDataSection &&
371          "No AllocateDataSection function provided!");
372   assert(Functions.FinalizeMemory &&
373          "No FinalizeMemory function provided!");
374   assert(Functions.Destroy &&
375          "No Destroy function provided!");
376 }
377 
378 SimpleBindingMemoryManager::~SimpleBindingMemoryManager() {
379   Functions.Destroy(Opaque);
380 }
381 
382 uint8_t *SimpleBindingMemoryManager::allocateCodeSection(
383   uintptr_t Size, unsigned Alignment, unsigned SectionID,
384   StringRef SectionName) {
385   return Functions.AllocateCodeSection(Opaque, Size, Alignment, SectionID,
386                                        SectionName.str().c_str());
387 }
388 
389 uint8_t *SimpleBindingMemoryManager::allocateDataSection(
390   uintptr_t Size, unsigned Alignment, unsigned SectionID,
391   StringRef SectionName, bool isReadOnly) {
392   return Functions.AllocateDataSection(Opaque, Size, Alignment, SectionID,
393                                        SectionName.str().c_str(),
394                                        isReadOnly);
395 }
396 
397 bool SimpleBindingMemoryManager::finalizeMemory(std::string *ErrMsg) {
398   char *errMsgCString = nullptr;
399   bool result = Functions.FinalizeMemory(Opaque, &errMsgCString);
400   assert((result || !errMsgCString) &&
401          "Did not expect an error message if FinalizeMemory succeeded");
402   if (errMsgCString) {
403     if (ErrMsg)
404       *ErrMsg = errMsgCString;
405     free(errMsgCString);
406   }
407   return result;
408 }
409 
410 } // anonymous namespace
411 
412 LLVMMCJITMemoryManagerRef LLVMCreateSimpleMCJITMemoryManager(
413   void *Opaque,
414   LLVMMemoryManagerAllocateCodeSectionCallback AllocateCodeSection,
415   LLVMMemoryManagerAllocateDataSectionCallback AllocateDataSection,
416   LLVMMemoryManagerFinalizeMemoryCallback FinalizeMemory,
417   LLVMMemoryManagerDestroyCallback Destroy) {
418 
419   if (!AllocateCodeSection || !AllocateDataSection || !FinalizeMemory ||
420       !Destroy)
421     return nullptr;
422 
423   SimpleBindingMMFunctions functions;
424   functions.AllocateCodeSection = AllocateCodeSection;
425   functions.AllocateDataSection = AllocateDataSection;
426   functions.FinalizeMemory = FinalizeMemory;
427   functions.Destroy = Destroy;
428   return wrap(new SimpleBindingMemoryManager(functions, Opaque));
429 }
430 
431 void LLVMDisposeMCJITMemoryManager(LLVMMCJITMemoryManagerRef MM) {
432   delete unwrap(MM);
433 }
434 
435