bindings/ocaml/executionengine/executionengine_ocaml.c

   1 /*===-- executionengine_ocaml.c - LLVM OCaml Glue ---------------*- C++ -*-===*\
   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 glues LLVM's OCaml interface to its C interface. These functions *|
  11 |* are by and large transparent wrappers to the corresponding C functions.    *|
  12 |*                                                                            *|
  13 |* Note that these functions intentionally take liberties with the CAMLparamX *|
  14 |* macros, since most of the parameters are not GC heap objects.              *|
  15 |*                                                                            *|
  16 \*===----------------------------------------------------------------------===*/
  17
  18 #include "llvm-c/ExecutionEngine.h"
  19 #include "llvm-c/Target.h"
  20 #include "caml/alloc.h"
  21 #include "caml/custom.h"
  22 #include "caml/fail.h"
  23 #include "caml/memory.h"
  24 #include <string.h>
  25 #include <assert.h>
  26
  27 /* Force the LLVM interpreter and JIT to be linked in. */
  28 void llvm_initialize(void) {
  29   LLVMLinkInInterpreter();
  30   LLVMLinkInMCJIT();
  31 }
  32
  33 /* unit -> bool */
  34 CAMLprim value llvm_initialize_native_target(value Unit) {
  35   return Val_bool(LLVMInitializeNativeTarget());
  36 }
  37
  38 /* Can't use the recommended caml_named_value mechanism for backwards
  39    compatibility reasons. This is largely equivalent. */
  40 static value llvm_ee_error_exn;
  41
  42 CAMLprim value llvm_register_ee_exns(value Error) {
  43   llvm_ee_error_exn = Field(Error, 0);
  44   register_global_root(&llvm_ee_error_exn);
  45   return Val_unit;
  46 }
  47
  48 static void llvm_raise(value Prototype, char *Message) {
  49   CAMLparam1(Prototype);
  50   CAMLlocal1(CamlMessage);
  51
  52   CamlMessage = copy_string(Message);
  53   LLVMDisposeMessage(Message);
  54
  55   raise_with_arg(Prototype, CamlMessage);
  56   abort(); /* NOTREACHED */
  57 #ifdef CAMLnoreturn
  58   CAMLnoreturn; /* Silences warnings, but is missing in some versions. */
  59 #endif
  60 }
  61
  62
  63 /*--... Operations on generic values .......................................--*/
  64
  65 #define Genericvalue_val(v)  (*(LLVMGenericValueRef *)(Data_custom_val(v)))
  66
  67 static void llvm_finalize_generic_value(value GenVal) {
  68   LLVMDisposeGenericValue(Genericvalue_val(GenVal));
  69 }
  70
  71 static struct custom_operations generic_value_ops = {
  72   (char *) "LLVMGenericValue",
  73   llvm_finalize_generic_value,
  74   custom_compare_default,
  75   custom_hash_default,
  76   custom_serialize_default,
  77   custom_deserialize_default
  78 #ifdef custom_compare_ext_default
  79   , custom_compare_ext_default
  80 #endif
  81 };
  82
  83 static value alloc_generic_value(LLVMGenericValueRef Ref) {
  84   value Val = alloc_custom(&generic_value_ops, sizeof(LLVMGenericValueRef), 0, 1);
  85   Genericvalue_val(Val) = Ref;
  86   return Val;
  87 }
  88
  89 /* Llvm.lltype -> float -> t */
  90 CAMLprim value llvm_genericvalue_of_float(LLVMTypeRef Ty, value N) {
  91   CAMLparam1(N);
  92   CAMLreturn(alloc_generic_value(
  93     LLVMCreateGenericValueOfFloat(Ty, Double_val(N))));
  94 }
  95
  96 /* 'a -> t */
  97 CAMLprim value llvm_genericvalue_of_pointer(value V) {
  98   CAMLparam1(V);
  99   CAMLreturn(alloc_generic_value(LLVMCreateGenericValueOfPointer(Op_val(V))));
 100 }
 101
 102 /* Llvm.lltype -> int -> t */
 103 CAMLprim value llvm_genericvalue_of_int(LLVMTypeRef Ty, value Int) {
 104   return alloc_generic_value(LLVMCreateGenericValueOfInt(Ty, Int_val(Int), 1));
 105 }
 106
 107 /* Llvm.lltype -> int32 -> t */
 108 CAMLprim value llvm_genericvalue_of_int32(LLVMTypeRef Ty, value Int32) {
 109   CAMLparam1(Int32);
 110   CAMLreturn(alloc_generic_value(
 111     LLVMCreateGenericValueOfInt(Ty, Int32_val(Int32), 1)));
 112 }
 113
 114 /* Llvm.lltype -> nativeint -> t */
 115 CAMLprim value llvm_genericvalue_of_nativeint(LLVMTypeRef Ty, value NatInt) {
 116   CAMLparam1(NatInt);
 117   CAMLreturn(alloc_generic_value(
 118     LLVMCreateGenericValueOfInt(Ty, Nativeint_val(NatInt), 1)));
 119 }
 120
 121 /* Llvm.lltype -> int64 -> t */
 122 CAMLprim value llvm_genericvalue_of_int64(LLVMTypeRef Ty, value Int64) {
 123   CAMLparam1(Int64);
 124   CAMLreturn(alloc_generic_value(
 125     LLVMCreateGenericValueOfInt(Ty, Int64_val(Int64), 1)));
 126 }
 127
 128 /* Llvm.lltype -> t -> float */
 129 CAMLprim value llvm_genericvalue_as_float(LLVMTypeRef Ty, value GenVal) {
 130   CAMLparam1(GenVal);
 131   CAMLreturn(copy_double(
 132     LLVMGenericValueToFloat(Ty, Genericvalue_val(GenVal))));
 133 }
 134
 135 /* t -> 'a */
 136 CAMLprim value llvm_genericvalue_as_pointer(value GenVal) {
 137   return Val_op(LLVMGenericValueToPointer(Genericvalue_val(GenVal)));
 138 }
 139
 140 /* t -> int */
 141 CAMLprim value llvm_genericvalue_as_int(value GenVal) {
 142   assert(LLVMGenericValueIntWidth(Genericvalue_val(GenVal)) <= 8 * sizeof(value)
 143          && "Generic value too wide to treat as an int!");
 144   return Val_int(LLVMGenericValueToInt(Genericvalue_val(GenVal), 1));
 145 }
 146
 147 /* t -> int32 */
 148 CAMLprim value llvm_genericvalue_as_int32(value GenVal) {
 149   CAMLparam1(GenVal);
 150   assert(LLVMGenericValueIntWidth(Genericvalue_val(GenVal)) <= 32
 151          && "Generic value too wide to treat as an int32!");
 152   CAMLreturn(copy_int32(LLVMGenericValueToInt(Genericvalue_val(GenVal), 1)));
 153 }
 154
 155 /* t -> int64 */
 156 CAMLprim value llvm_genericvalue_as_int64(value GenVal) {
 157   CAMLparam1(GenVal);
 158   assert(LLVMGenericValueIntWidth(Genericvalue_val(GenVal)) <= 64
 159          && "Generic value too wide to treat as an int64!");
 160   CAMLreturn(copy_int64(LLVMGenericValueToInt(Genericvalue_val(GenVal), 1)));
 161 }
 162
 163 /* t -> nativeint */
 164 CAMLprim value llvm_genericvalue_as_nativeint(value GenVal) {
 165   CAMLparam1(GenVal);
 166   assert(LLVMGenericValueIntWidth(Genericvalue_val(GenVal)) <= 8 * sizeof(value)
 167          && "Generic value too wide to treat as a nativeint!");
 168   CAMLreturn(copy_nativeint(LLVMGenericValueToInt(Genericvalue_val(GenVal),1)));
 169 }
 170
 171
 172 /*--... Operations on execution engines ....................................--*/
 173
 174 /* llmodule -> ExecutionEngine.t */
 175 CAMLprim LLVMExecutionEngineRef llvm_ee_create(LLVMModuleRef M) {
 176   LLVMExecutionEngineRef Interp;
 177   char *Error;
 178   if (LLVMCreateExecutionEngineForModule(&Interp, M, &Error))
 179     llvm_raise(llvm_ee_error_exn, Error);
 180   return Interp;
 181 }
 182
 183 /* llmodule -> ExecutionEngine.t */
 184 CAMLprim LLVMExecutionEngineRef
 185 llvm_ee_create_interpreter(LLVMModuleRef M) {
 186   LLVMExecutionEngineRef Interp;
 187   char *Error;
 188   if (LLVMCreateInterpreterForModule(&Interp, M, &Error))
 189     llvm_raise(llvm_ee_error_exn, Error);
 190   return Interp;
 191 }
 192
 193 /* llmodule -> int -> ExecutionEngine.t */
 194 CAMLprim LLVMExecutionEngineRef
 195 llvm_ee_create_jit(LLVMModuleRef M, value OptLevel) {
 196   LLVMExecutionEngineRef JIT;
 197   char *Error;
 198   if (LLVMCreateJITCompilerForModule(&JIT, M, Int_val(OptLevel), &Error))
 199     llvm_raise(llvm_ee_error_exn, Error);
 200   return JIT;
 201 }
 202
 203 /* llmodule -> llcompileroption -> ExecutionEngine.t */
 204 CAMLprim LLVMExecutionEngineRef
 205 llvm_ee_create_mcjit(LLVMModuleRef M, value OptRecord) {
 206   LLVMExecutionEngineRef MCJIT;
 207   char *Error;
 208   struct LLVMMCJITCompilerOptions Options = {
 209          .OptLevel = Int_val(Field(OptRecord, 0)),
 210          .CodeModel = Int_val(Field(OptRecord, 1)),
 211          .NoFramePointerElim = Int_val(Field(OptRecord, 2)),
 212          .EnableFastISel = Int_val(Field(OptRecord, 3)),
 213          .MCJMM = NULL
 214   };
 215   if (LLVMCreateMCJITCompilerForModule(&MCJIT, M, &Options,
 216                                       sizeof(Options), &Error))
 217     llvm_raise(llvm_ee_error_exn, Error);
 218   return MCJIT;
 219 }
 220
 221 /* ExecutionEngine.t -> unit */
 222 CAMLprim value llvm_ee_dispose(LLVMExecutionEngineRef EE) {
 223   LLVMDisposeExecutionEngine(EE);
 224   return Val_unit;
 225 }
 226
 227 /* llmodule -> ExecutionEngine.t -> unit */
 228 CAMLprim value llvm_ee_add_module(LLVMModuleRef M, LLVMExecutionEngineRef EE) {
 229   LLVMAddModule(EE, M);
 230   return Val_unit;
 231 }
 232
 233 /* llmodule -> ExecutionEngine.t -> llmodule */
 234 CAMLprim LLVMModuleRef llvm_ee_remove_module(LLVMModuleRef M,
 235                                              LLVMExecutionEngineRef EE) {
 236   LLVMModuleRef RemovedModule;
 237   char *Error;
 238   if (LLVMRemoveModule(EE, M, &RemovedModule, &Error))
 239     llvm_raise(llvm_ee_error_exn, Error);
 240   return RemovedModule;
 241 }
 242
 243 /* string -> ExecutionEngine.t -> llvalue option */
 244 CAMLprim value llvm_ee_find_function(value Name, LLVMExecutionEngineRef EE) {
 245   CAMLparam1(Name);
 246   CAMLlocal1(Option);
 247   LLVMValueRef Found;
 248   if (LLVMFindFunction(EE, String_val(Name), &Found))
 249     CAMLreturn(Val_unit);
 250   Option = alloc(1, 0);
 251   Field(Option, 0) = Val_op(Found);
 252   CAMLreturn(Option);
 253 }
 254
 255 /* llvalue -> GenericValue.t array -> ExecutionEngine.t -> GenericValue.t */
 256 CAMLprim value llvm_ee_run_function(LLVMValueRef F, value Args,
 257                                     LLVMExecutionEngineRef EE) {
 258   unsigned NumArgs;
 259   LLVMGenericValueRef Result, *GVArgs;
 260   unsigned I;
 261
 262   NumArgs = Wosize_val(Args);
 263   GVArgs = (LLVMGenericValueRef*) malloc(NumArgs * sizeof(LLVMGenericValueRef));
 264   for (I = 0; I != NumArgs; ++I)
 265     GVArgs[I] = Genericvalue_val(Field(Args, I));
 266
 267   Result = LLVMRunFunction(EE, F, NumArgs, GVArgs);
 268
 269   free(GVArgs);
 270   return alloc_generic_value(Result);
 271 }
 272
 273 /* ExecutionEngine.t -> unit */
 274 CAMLprim value llvm_ee_run_static_ctors(LLVMExecutionEngineRef EE) {
 275   LLVMRunStaticConstructors(EE);
 276   return Val_unit;
 277 }
 278
 279 /* ExecutionEngine.t -> unit */
 280 CAMLprim value llvm_ee_run_static_dtors(LLVMExecutionEngineRef EE) {
 281   LLVMRunStaticDestructors(EE);
 282   return Val_unit;
 283 }
 284
 285 /* llvalue -> string array -> (string * string) array -> ExecutionEngine.t ->
 286    int */
 287 CAMLprim value llvm_ee_run_function_as_main(LLVMValueRef F,
 288                                             value Args, value Env,
 289                                             LLVMExecutionEngineRef EE) {
 290   CAMLparam2(Args, Env);
 291   int I, NumArgs, NumEnv, EnvSize, Result;
 292   const char **CArgs, **CEnv;
 293   char *CEnvBuf, *Pos;
 294
 295   NumArgs = Wosize_val(Args);
 296   NumEnv = Wosize_val(Env);
 297
 298   /* Build the environment. */
 299   CArgs = (const char **) malloc(NumArgs * sizeof(char*));
 300   for (I = 0; I != NumArgs; ++I)
 301     CArgs[I] = String_val(Field(Args, I));
 302
 303   /* Compute the size of the environment string buffer. */
 304   for (I = 0, EnvSize = 0; I != NumEnv; ++I) {
 305     EnvSize += strlen(String_val(Field(Field(Env, I), 0))) + 1;
 306     EnvSize += strlen(String_val(Field(Field(Env, I), 1))) + 1;
 307   }
 308
 309   /* Build the environment. */
 310   CEnv = (const char **) malloc((NumEnv + 1) * sizeof(char*));
 311   CEnvBuf = (char*) malloc(EnvSize);
 312   Pos = CEnvBuf;
 313   for (I = 0; I != NumEnv; ++I) {
 314     char *Name  = String_val(Field(Field(Env, I), 0)),
 315          *Value = String_val(Field(Field(Env, I), 1));
 316     int NameLen  = strlen(Name),
 317         ValueLen = strlen(Value);
 318
 319     CEnv[I] = Pos;
 320     memcpy(Pos, Name, NameLen);
 321     Pos += NameLen;
 322     *Pos++ = '=';
 323     memcpy(Pos, Value, ValueLen);
 324     Pos += ValueLen;
 325     *Pos++ = '\0';
 326   }
 327   CEnv[NumEnv] = NULL;
 328
 329   Result = LLVMRunFunctionAsMain(EE, F, NumArgs, CArgs, CEnv);
 330
 331   free(CArgs);
 332   free(CEnv);
 333   free(CEnvBuf);
 334
 335   CAMLreturn(Val_int(Result));
 336 }
 337
 338 /* llvalue -> ExecutionEngine.t -> unit */
 339 CAMLprim value llvm_ee_free_machine_code(LLVMValueRef F,
 340                                          LLVMExecutionEngineRef EE) {
 341   LLVMFreeMachineCodeForFunction(EE, F);
 342   return Val_unit;
 343 }
 344
 345 extern value llvm_alloc_data_layout(LLVMTargetDataRef TargetData);
 346
 347 /* ExecutionEngine.t -> Llvm_target.DataLayout.t */
 348 CAMLprim value llvm_ee_get_data_layout(LLVMExecutionEngineRef EE) {
 349   value DataLayout;
 350   LLVMTargetDataRef OrigDataLayout;
 351   OrigDataLayout = LLVMGetExecutionEngineTargetData(EE);
 352
 353   char* TargetDataCStr;
 354   TargetDataCStr = LLVMCopyStringRepOfTargetData(OrigDataLayout);
 355   DataLayout = llvm_alloc_data_layout(LLVMCreateTargetData(TargetDataCStr));
 356   LLVMDisposeMessage(TargetDataCStr);
 357
 358   return DataLayout;
 359 }