lib/ExecutionEngine/ExecutionEngineBindings.cpp

   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 #define DEBUG_TYPE "jit"
  15 #include "llvm-c/ExecutionEngine.h"
  16 #include "llvm/ExecutionEngine/ExecutionEngine.h"
  17 #include "llvm/ExecutionEngine/GenericValue.h"
  18 #include "llvm/Support/ErrorHandling.h"
  19 #include "llvm/Wrap.h"
  20 #include <cstring>
  21
  22 using namespace llvm;
  23
  24 // Wrapping the C bindings types.
  25 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(GenericValue,       LLVMGenericValueRef  )
  26 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ExecutionEngine,    LLVMExecutionEngineRef)
  27
  28 inline DataLayout *unwrap(LLVMTargetDataRef P) {
  29   return reinterpret_cast<DataLayout*>(P);
  30 }
  31
  32 inline LLVMTargetDataRef wrap(const DataLayout *P) {
  33   return reinterpret_cast<LLVMTargetDataRef>(const_cast<DataLayout*>(P));
  34 }
  35
  36 inline TargetLibraryInfo *unwrap(LLVMTargetLibraryInfoRef P) {
  37   return reinterpret_cast<TargetLibraryInfo*>(P);
  38 }
  39
  40 inline LLVMTargetLibraryInfoRef wrap(const TargetLibraryInfo *P) {
  41   TargetLibraryInfo *X = const_cast<TargetLibraryInfo*>(P);
  42   return reinterpret_cast<LLVMTargetLibraryInfoRef>(X);
  43 }
  44
  45 /*===-- Operations on generic values --------------------------------------===*/
  46
  47 LLVMGenericValueRef LLVMCreateGenericValueOfInt(LLVMTypeRef Ty,
  48                                                 unsigned long long N,
  49                                                 LLVMBool IsSigned) {
  50   GenericValue *GenVal = new GenericValue();
  51   GenVal->IntVal = APInt(unwrap<IntegerType>(Ty)->getBitWidth(), N, IsSigned);
  52   return wrap(GenVal);
  53 }
  54
  55 LLVMGenericValueRef LLVMCreateGenericValueOfPointer(void *P) {
  56   GenericValue *GenVal = new GenericValue();
  57   GenVal->PointerVal = P;
  58   return wrap(GenVal);
  59 }
  60
  61 LLVMGenericValueRef LLVMCreateGenericValueOfFloat(LLVMTypeRef TyRef, double N) {
  62   GenericValue *GenVal = new GenericValue();
  63   switch (unwrap(TyRef)->getTypeID()) {
  64   case Type::FloatTyID:
  65     GenVal->FloatVal = N;
  66     break;
  67   case Type::DoubleTyID:
  68     GenVal->DoubleVal = N;
  69     break;
  70   default:
  71     llvm_unreachable("LLVMGenericValueToFloat supports only float and double.");
  72   }
  73   return wrap(GenVal);
  74 }
  75
  76 unsigned LLVMGenericValueIntWidth(LLVMGenericValueRef GenValRef) {
  77   return unwrap(GenValRef)->IntVal.getBitWidth();
  78 }
  79
  80 unsigned long long LLVMGenericValueToInt(LLVMGenericValueRef GenValRef,
  81                                          LLVMBool IsSigned) {
  82   GenericValue *GenVal = unwrap(GenValRef);
  83   if (IsSigned)
  84     return GenVal->IntVal.getSExtValue();
  85   else
  86     return GenVal->IntVal.getZExtValue();
  87 }
  88
  89 void *LLVMGenericValueToPointer(LLVMGenericValueRef GenVal) {
  90   return unwrap(GenVal)->PointerVal;
  91 }
  92
  93 double LLVMGenericValueToFloat(LLVMTypeRef TyRef, LLVMGenericValueRef GenVal) {
  94   switch (unwrap(TyRef)->getTypeID()) {
  95   case Type::FloatTyID:
  96     return unwrap(GenVal)->FloatVal;
  97   case Type::DoubleTyID:
  98     return unwrap(GenVal)->DoubleVal;
  99   default:
 100     llvm_unreachable("LLVMGenericValueToFloat supports only float and double.");
 101   }
 102 }
 103
 104 void LLVMDisposeGenericValue(LLVMGenericValueRef GenVal) {
 105   delete unwrap(GenVal);
 106 }
 107
 108 /*===-- Operations on execution engines -----------------------------------===*/
 109
 110 LLVMBool LLVMCreateExecutionEngineForModule(LLVMExecutionEngineRef *OutEE,
 111                                             LLVMModuleRef M,
 112                                             char **OutError) {
 113   std::string Error;
 114   EngineBuilder builder(unwrap(M));
 115   builder.setEngineKind(EngineKind::Either)
 116          .setErrorStr(&Error);
 117   if (ExecutionEngine *EE = builder.create()){
 118     *OutEE = wrap(EE);
 119     return 0;
 120   }
 121   *OutError = strdup(Error.c_str());
 122   return 1;
 123 }
 124
 125 LLVMBool LLVMCreateInterpreterForModule(LLVMExecutionEngineRef *OutInterp,
 126                                         LLVMModuleRef M,
 127                                         char **OutError) {
 128   std::string Error;
 129   EngineBuilder builder(unwrap(M));
 130   builder.setEngineKind(EngineKind::Interpreter)
 131          .setErrorStr(&Error);
 132   if (ExecutionEngine *Interp = builder.create()) {
 133     *OutInterp = wrap(Interp);
 134     return 0;
 135   }
 136   *OutError = strdup(Error.c_str());
 137   return 1;
 138 }
 139
 140 LLVMBool LLVMCreateJITCompilerForModule(LLVMExecutionEngineRef *OutJIT,
 141                                         LLVMModuleRef M,
 142                                         unsigned OptLevel,
 143                                         char **OutError) {
 144   std::string Error;
 145   EngineBuilder builder(unwrap(M));
 146   builder.setEngineKind(EngineKind::JIT)
 147          .setErrorStr(&Error)
 148          .setOptLevel((CodeGenOpt::Level)OptLevel);
 149   if (ExecutionEngine *JIT = builder.create()) {
 150     *OutJIT = wrap(JIT);
 151     return 0;
 152   }
 153   *OutError = strdup(Error.c_str());
 154   return 1;
 155 }
 156
 157 LLVMBool LLVMCreateExecutionEngine(LLVMExecutionEngineRef *OutEE,
 158                                    LLVMModuleProviderRef MP,
 159                                    char **OutError) {
 160   /* The module provider is now actually a module. */
 161   return LLVMCreateExecutionEngineForModule(OutEE,
 162                                             reinterpret_cast<LLVMModuleRef>(MP),
 163                                             OutError);
 164 }
 165
 166 LLVMBool LLVMCreateInterpreter(LLVMExecutionEngineRef *OutInterp,
 167                                LLVMModuleProviderRef MP,
 168                                char **OutError) {
 169   /* The module provider is now actually a module. */
 170   return LLVMCreateInterpreterForModule(OutInterp,
 171                                         reinterpret_cast<LLVMModuleRef>(MP),
 172                                         OutError);
 173 }
 174
 175 LLVMBool LLVMCreateJITCompiler(LLVMExecutionEngineRef *OutJIT,
 176                                LLVMModuleProviderRef MP,
 177                                unsigned OptLevel,
 178                                char **OutError) {
 179   /* The module provider is now actually a module. */
 180   return LLVMCreateJITCompilerForModule(OutJIT,
 181                                         reinterpret_cast<LLVMModuleRef>(MP),
 182                                         OptLevel, OutError);
 183 }
 184
 185
 186 void LLVMDisposeExecutionEngine(LLVMExecutionEngineRef EE) {
 187   delete unwrap(EE);
 188 }
 189
 190 void LLVMRunStaticConstructors(LLVMExecutionEngineRef EE) {
 191   unwrap(EE)->runStaticConstructorsDestructors(false);
 192 }
 193
 194 void LLVMRunStaticDestructors(LLVMExecutionEngineRef EE) {
 195   unwrap(EE)->runStaticConstructorsDestructors(true);
 196 }
 197
 198 int LLVMRunFunctionAsMain(LLVMExecutionEngineRef EE, LLVMValueRef F,
 199                           unsigned ArgC, const char * const *ArgV,
 200                           const char * const *EnvP) {
 201   std::vector<std::string> ArgVec;
 202   for (unsigned I = 0; I != ArgC; ++I)
 203     ArgVec.push_back(ArgV[I]);
 204
 205   return unwrap(EE)->runFunctionAsMain(unwrap<Function>(F), ArgVec, EnvP);
 206 }
 207
 208 LLVMGenericValueRef LLVMRunFunction(LLVMExecutionEngineRef EE, LLVMValueRef F,
 209                                     unsigned NumArgs,
 210                                     LLVMGenericValueRef *Args) {
 211   std::vector<GenericValue> ArgVec;
 212   ArgVec.reserve(NumArgs);
 213   for (unsigned I = 0; I != NumArgs; ++I)
 214     ArgVec.push_back(*unwrap(Args[I]));
 215
 216   GenericValue *Result = new GenericValue();
 217   *Result = unwrap(EE)->runFunction(unwrap<Function>(F), ArgVec);
 218   return wrap(Result);
 219 }
 220
 221 void LLVMFreeMachineCodeForFunction(LLVMExecutionEngineRef EE, LLVMValueRef F) {
 222   unwrap(EE)->freeMachineCodeForFunction(unwrap<Function>(F));
 223 }
 224
 225 void LLVMAddModule(LLVMExecutionEngineRef EE, LLVMModuleRef M){
 226   unwrap(EE)->addModule(unwrap(M));
 227 }
 228
 229 void LLVMAddModuleProvider(LLVMExecutionEngineRef EE, LLVMModuleProviderRef MP){
 230   /* The module provider is now actually a module. */
 231   LLVMAddModule(EE, reinterpret_cast<LLVMModuleRef>(MP));
 232 }
 233
 234 LLVMBool LLVMRemoveModule(LLVMExecutionEngineRef EE, LLVMModuleRef M,
 235                           LLVMModuleRef *OutMod, char **OutError) {
 236   Module *Mod = unwrap(M);
 237   unwrap(EE)->removeModule(Mod);
 238   *OutMod = wrap(Mod);
 239   return 0;
 240 }
 241
 242 LLVMBool LLVMRemoveModuleProvider(LLVMExecutionEngineRef EE,
 243                                   LLVMModuleProviderRef MP,
 244                                   LLVMModuleRef *OutMod, char **OutError) {
 245   /* The module provider is now actually a module. */
 246   return LLVMRemoveModule(EE, reinterpret_cast<LLVMModuleRef>(MP), OutMod,
 247                           OutError);
 248 }
 249
 250 LLVMBool LLVMFindFunction(LLVMExecutionEngineRef EE, const char *Name,
 251                           LLVMValueRef *OutFn) {
 252   if (Function *F = unwrap(EE)->FindFunctionNamed(Name)) {
 253     *OutFn = wrap(F);
 254     return 0;
 255   }
 256   return 1;
 257 }
 258
 259 void *LLVMRecompileAndRelinkFunction(LLVMExecutionEngineRef EE, LLVMValueRef Fn) {
 260   return unwrap(EE)->recompileAndRelinkFunction(unwrap<Function>(Fn));
 261 }
 262
 263 LLVMTargetDataRef LLVMGetExecutionEngineTargetData(LLVMExecutionEngineRef EE) {
 264   return wrap(unwrap(EE)->getDataLayout());
 265 }
 266
 267 void LLVMAddGlobalMapping(LLVMExecutionEngineRef EE, LLVMValueRef Global,
 268                           void* Addr) {
 269   unwrap(EE)->addGlobalMapping(unwrap<GlobalValue>(Global), Addr);
 270 }
 271
 272 void *LLVMGetPointerToGlobal(LLVMExecutionEngineRef EE, LLVMValueRef Global) {
 273   return unwrap(EE)->getPointerToGlobal(unwrap<GlobalValue>(Global));
 274 }