1 //===-- ExecutionEngineBindings.cpp - C bindings for EEs ------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the C bindings for the ExecutionEngine library.
12 //===----------------------------------------------------------------------===//
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"
25 #define DEBUG_TYPE "jit"
27 // Wrapping the C bindings types.
28 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(GenericValue, LLVMGenericValueRef)
31 inline LLVMTargetMachineRef wrap(const TargetMachine *P) {
33 reinterpret_cast<LLVMTargetMachineRef>(const_cast<TargetMachine*>(P));
36 /*===-- Operations on generic values --------------------------------------===*/
38 LLVMGenericValueRef LLVMCreateGenericValueOfInt(LLVMTypeRef Ty,
41 GenericValue *GenVal = new GenericValue();
42 GenVal->IntVal = APInt(unwrap<IntegerType>(Ty)->getBitWidth(), N, IsSigned);
46 LLVMGenericValueRef LLVMCreateGenericValueOfPointer(void *P) {
47 GenericValue *GenVal = new GenericValue();
48 GenVal->PointerVal = P;
52 LLVMGenericValueRef LLVMCreateGenericValueOfFloat(LLVMTypeRef TyRef, double N) {
53 GenericValue *GenVal = new GenericValue();
54 switch (unwrap(TyRef)->getTypeID()) {
58 case Type::DoubleTyID:
59 GenVal->DoubleVal = N;
62 llvm_unreachable("LLVMGenericValueToFloat supports only float and double.");
67 unsigned LLVMGenericValueIntWidth(LLVMGenericValueRef GenValRef) {
68 return unwrap(GenValRef)->IntVal.getBitWidth();
71 unsigned long long LLVMGenericValueToInt(LLVMGenericValueRef GenValRef,
73 GenericValue *GenVal = unwrap(GenValRef);
75 return GenVal->IntVal.getSExtValue();
77 return GenVal->IntVal.getZExtValue();
80 void *LLVMGenericValueToPointer(LLVMGenericValueRef GenVal) {
81 return unwrap(GenVal)->PointerVal;
84 double LLVMGenericValueToFloat(LLVMTypeRef TyRef, LLVMGenericValueRef GenVal) {
85 switch (unwrap(TyRef)->getTypeID()) {
87 return unwrap(GenVal)->FloatVal;
88 case Type::DoubleTyID:
89 return unwrap(GenVal)->DoubleVal;
91 llvm_unreachable("LLVMGenericValueToFloat supports only float and double.");
95 void LLVMDisposeGenericValue(LLVMGenericValueRef GenVal) {
96 delete unwrap(GenVal);
99 /*===-- Operations on execution engines -----------------------------------===*/
101 LLVMBool LLVMCreateExecutionEngineForModule(LLVMExecutionEngineRef *OutEE,
105 EngineBuilder builder(std::unique_ptr<Module>(unwrap(M)));
106 builder.setEngineKind(EngineKind::Either)
107 .setErrorStr(&Error);
108 if (ExecutionEngine *EE = builder.create()){
112 *OutError = strdup(Error.c_str());
116 LLVMBool LLVMCreateInterpreterForModule(LLVMExecutionEngineRef *OutInterp,
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);
127 *OutError = strdup(Error.c_str());
131 LLVMBool LLVMCreateJITCompilerForModule(LLVMExecutionEngineRef *OutJIT,
136 EngineBuilder builder(std::unique_ptr<Module>(unwrap(M)));
137 builder.setEngineKind(EngineKind::JIT)
139 .setOptLevel((CodeGenOpt::Level)OptLevel);
140 if (ExecutionEngine *JIT = builder.create()) {
144 *OutError = strdup(Error.c_str());
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;
154 memcpy(PassedOptions, &options,
155 std::min(sizeof(options), SizeOfPassedOptions));
158 LLVMBool LLVMCreateMCJITCompilerForModule(
159 LLVMExecutionEngineRef *OutJIT, LLVMModuleRef M,
160 LLVMMCJITCompilerOptions *PassedOptions, size_t SizeOfPassedOptions,
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)) {
167 "Refusing to use options struct that is larger than my own; assuming "
168 "LLVM library mismatch.");
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);
179 TargetOptions targetOptions;
180 targetOptions.NoFramePointerElim = options.NoFramePointerElim;
181 targetOptions.EnableFastISel = options.EnableFastISel;
182 std::unique_ptr<Module> Mod(unwrap(M));
185 // Set function attribute "no-frame-pointer-elim" based on
186 // NoFramePointerElim.
187 setFunctionAttributes(/* CPU */ "", /* Features */ "", targetOptions, *Mod,
188 /* AlwaysRecordAttrs */ true);
191 EngineBuilder builder(std::move(Mod));
192 builder.setEngineKind(EngineKind::JIT)
194 .setOptLevel((CodeGenOpt::Level)options.OptLevel)
195 .setCodeModel(unwrap(options.CodeModel))
196 .setTargetOptions(targetOptions);
198 builder.setMCJITMemoryManager(
199 std::unique_ptr<RTDyldMemoryManager>(unwrap(options.MCJMM)));
200 if (ExecutionEngine *JIT = builder.create()) {
204 *OutError = strdup(Error.c_str());
208 LLVMBool LLVMCreateExecutionEngine(LLVMExecutionEngineRef *OutEE,
209 LLVMModuleProviderRef MP,
211 /* The module provider is now actually a module. */
212 return LLVMCreateExecutionEngineForModule(OutEE,
213 reinterpret_cast<LLVMModuleRef>(MP),
217 LLVMBool LLVMCreateInterpreter(LLVMExecutionEngineRef *OutInterp,
218 LLVMModuleProviderRef MP,
220 /* The module provider is now actually a module. */
221 return LLVMCreateInterpreterForModule(OutInterp,
222 reinterpret_cast<LLVMModuleRef>(MP),
226 LLVMBool LLVMCreateJITCompiler(LLVMExecutionEngineRef *OutJIT,
227 LLVMModuleProviderRef MP,
230 /* The module provider is now actually a module. */
231 return LLVMCreateJITCompilerForModule(OutJIT,
232 reinterpret_cast<LLVMModuleRef>(MP),
237 void LLVMDisposeExecutionEngine(LLVMExecutionEngineRef EE) {
241 void LLVMRunStaticConstructors(LLVMExecutionEngineRef EE) {
242 unwrap(EE)->runStaticConstructorsDestructors(false);
245 void LLVMRunStaticDestructors(LLVMExecutionEngineRef EE) {
246 unwrap(EE)->runStaticConstructorsDestructors(true);
249 int LLVMRunFunctionAsMain(LLVMExecutionEngineRef EE, LLVMValueRef F,
250 unsigned ArgC, const char * const *ArgV,
251 const char * const *EnvP) {
252 unwrap(EE)->finalizeObject();
254 std::vector<std::string> ArgVec;
255 for (unsigned I = 0; I != ArgC; ++I)
256 ArgVec.push_back(ArgV[I]);
258 return unwrap(EE)->runFunctionAsMain(unwrap<Function>(F), ArgVec, EnvP);
261 LLVMGenericValueRef LLVMRunFunction(LLVMExecutionEngineRef EE, LLVMValueRef F,
263 LLVMGenericValueRef *Args) {
264 unwrap(EE)->finalizeObject();
266 std::vector<GenericValue> ArgVec;
267 ArgVec.reserve(NumArgs);
268 for (unsigned I = 0; I != NumArgs; ++I)
269 ArgVec.push_back(*unwrap(Args[I]));
271 GenericValue *Result = new GenericValue();
272 *Result = unwrap(EE)->runFunction(unwrap<Function>(F), ArgVec);
276 void LLVMFreeMachineCodeForFunction(LLVMExecutionEngineRef EE, LLVMValueRef F) {
279 void LLVMAddModule(LLVMExecutionEngineRef EE, LLVMModuleRef M){
280 unwrap(EE)->addModule(std::unique_ptr<Module>(unwrap(M)));
283 void LLVMAddModuleProvider(LLVMExecutionEngineRef EE, LLVMModuleProviderRef MP){
284 /* The module provider is now actually a module. */
285 LLVMAddModule(EE, reinterpret_cast<LLVMModuleRef>(MP));
288 LLVMBool LLVMRemoveModule(LLVMExecutionEngineRef EE, LLVMModuleRef M,
289 LLVMModuleRef *OutMod, char **OutError) {
290 Module *Mod = unwrap(M);
291 unwrap(EE)->removeModule(Mod);
296 LLVMBool LLVMRemoveModuleProvider(LLVMExecutionEngineRef EE,
297 LLVMModuleProviderRef MP,
298 LLVMModuleRef *OutMod, char **OutError) {
299 /* The module provider is now actually a module. */
300 return LLVMRemoveModule(EE, reinterpret_cast<LLVMModuleRef>(MP), OutMod,
304 LLVMBool LLVMFindFunction(LLVMExecutionEngineRef EE, const char *Name,
305 LLVMValueRef *OutFn) {
306 if (Function *F = unwrap(EE)->FindFunctionNamed(Name)) {
313 void *LLVMRecompileAndRelinkFunction(LLVMExecutionEngineRef EE,
318 LLVMTargetDataRef LLVMGetExecutionEngineTargetData(LLVMExecutionEngineRef EE) {
319 return wrap(unwrap(EE)->getDataLayout());
323 LLVMGetExecutionEngineTargetMachine(LLVMExecutionEngineRef EE) {
324 return wrap(unwrap(EE)->getTargetMachine());
327 void LLVMAddGlobalMapping(LLVMExecutionEngineRef EE, LLVMValueRef Global,
329 unwrap(EE)->addGlobalMapping(unwrap<GlobalValue>(Global), Addr);
332 void *LLVMGetPointerToGlobal(LLVMExecutionEngineRef EE, LLVMValueRef Global) {
333 unwrap(EE)->finalizeObject();
335 return unwrap(EE)->getPointerToGlobal(unwrap<GlobalValue>(Global));
338 uint64_t LLVMGetGlobalValueAddress(LLVMExecutionEngineRef EE, const char *Name) {
339 return unwrap(EE)->getGlobalValueAddress(Name);
342 uint64_t LLVMGetFunctionAddress(LLVMExecutionEngineRef EE, const char *Name) {
343 return unwrap(EE)->getFunctionAddress(Name);
346 /*===-- Operations on memory managers -------------------------------------===*/
350 struct SimpleBindingMMFunctions {
351 LLVMMemoryManagerAllocateCodeSectionCallback AllocateCodeSection;
352 LLVMMemoryManagerAllocateDataSectionCallback AllocateDataSection;
353 LLVMMemoryManagerFinalizeMemoryCallback FinalizeMemory;
354 LLVMMemoryManagerDestroyCallback Destroy;
357 class SimpleBindingMemoryManager : public RTDyldMemoryManager {
359 SimpleBindingMemoryManager(const SimpleBindingMMFunctions& Functions,
361 ~SimpleBindingMemoryManager() override;
363 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
365 StringRef SectionName) override;
367 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
368 unsigned SectionID, StringRef SectionName,
369 bool isReadOnly) override;
371 bool finalizeMemory(std::string *ErrMsg) override;
374 SimpleBindingMMFunctions Functions;
378 SimpleBindingMemoryManager::SimpleBindingMemoryManager(
379 const SimpleBindingMMFunctions& Functions,
381 : Functions(Functions), Opaque(Opaque) {
382 assert(Functions.AllocateCodeSection &&
383 "No AllocateCodeSection function provided!");
384 assert(Functions.AllocateDataSection &&
385 "No AllocateDataSection function provided!");
386 assert(Functions.FinalizeMemory &&
387 "No FinalizeMemory function provided!");
388 assert(Functions.Destroy &&
389 "No Destroy function provided!");
392 SimpleBindingMemoryManager::~SimpleBindingMemoryManager() {
393 Functions.Destroy(Opaque);
396 uint8_t *SimpleBindingMemoryManager::allocateCodeSection(
397 uintptr_t Size, unsigned Alignment, unsigned SectionID,
398 StringRef SectionName) {
399 return Functions.AllocateCodeSection(Opaque, Size, Alignment, SectionID,
400 SectionName.str().c_str());
403 uint8_t *SimpleBindingMemoryManager::allocateDataSection(
404 uintptr_t Size, unsigned Alignment, unsigned SectionID,
405 StringRef SectionName, bool isReadOnly) {
406 return Functions.AllocateDataSection(Opaque, Size, Alignment, SectionID,
407 SectionName.str().c_str(),
411 bool SimpleBindingMemoryManager::finalizeMemory(std::string *ErrMsg) {
412 char *errMsgCString = nullptr;
413 bool result = Functions.FinalizeMemory(Opaque, &errMsgCString);
414 assert((result || !errMsgCString) &&
415 "Did not expect an error message if FinalizeMemory succeeded");
418 *ErrMsg = errMsgCString;
424 } // anonymous namespace
426 LLVMMCJITMemoryManagerRef LLVMCreateSimpleMCJITMemoryManager(
428 LLVMMemoryManagerAllocateCodeSectionCallback AllocateCodeSection,
429 LLVMMemoryManagerAllocateDataSectionCallback AllocateDataSection,
430 LLVMMemoryManagerFinalizeMemoryCallback FinalizeMemory,
431 LLVMMemoryManagerDestroyCallback Destroy) {
433 if (!AllocateCodeSection || !AllocateDataSection || !FinalizeMemory ||
437 SimpleBindingMMFunctions functions;
438 functions.AllocateCodeSection = AllocateCodeSection;
439 functions.AllocateDataSection = AllocateDataSection;
440 functions.FinalizeMemory = FinalizeMemory;
441 functions.Destroy = Destroy;
442 return wrap(new SimpleBindingMemoryManager(functions, Opaque));
445 void LLVMDisposeMCJITMemoryManager(LLVMMCJITMemoryManagerRef MM) {