1 /*===-- executionengine_ocaml.c - LLVM Ocaml Glue ---------------*- C++ -*-===*\
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 glues LLVM's ocaml interface to its C interface. These functions *|
11 |* are by and large transparent wrappers to the corresponding C functions. *|
13 |* Note that these functions intentionally take liberties with the CAMLparamX *|
14 |* macros, since most of the parameters are not GC heap objects. *|
16 \*===----------------------------------------------------------------------===*/
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"
27 /* Force the LLVM interpreter and JIT to be linked in. */
28 void llvm_initialize(void) {
29 LLVMLinkInInterpreter();
34 CAMLprim value llvm_initialize_native_target(value Unit) {
35 return Val_bool(LLVMInitializeNativeTarget());
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;
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);
48 static void llvm_raise(value Prototype, char *Message) {
49 CAMLparam1(Prototype);
50 CAMLlocal1(CamlMessage);
52 CamlMessage = copy_string(Message);
53 LLVMDisposeMessage(Message);
55 raise_with_arg(Prototype, CamlMessage);
56 abort(); /* NOTREACHED */
58 CAMLnoreturn; /* Silences warnings, but is missing in some versions. */
63 /*--... Operations on generic values .......................................--*/
65 #define Genericvalue_val(v) (*(LLVMGenericValueRef *)(Data_custom_val(v)))
67 static void llvm_finalize_generic_value(value GenVal) {
68 LLVMDisposeGenericValue(Genericvalue_val(GenVal));
71 static struct custom_operations generic_value_ops = {
72 (char *) "LLVMGenericValue",
73 llvm_finalize_generic_value,
74 custom_compare_default,
76 custom_serialize_default,
77 custom_deserialize_default
80 static value alloc_generic_value(LLVMGenericValueRef Ref) {
81 value Val = alloc_custom(&generic_value_ops, sizeof(LLVMGenericValueRef), 0, 1);
82 Genericvalue_val(Val) = Ref;
86 /* Llvm.lltype -> float -> t */
87 CAMLprim value llvm_genericvalue_of_float(LLVMTypeRef Ty, value N) {
89 CAMLreturn(alloc_generic_value(
90 LLVMCreateGenericValueOfFloat(Ty, Double_val(N))));
94 CAMLprim value llvm_genericvalue_of_value(value V) {
96 CAMLreturn(alloc_generic_value(LLVMCreateGenericValueOfPointer(Op_val(V))));
99 /* Llvm.lltype -> int -> t */
100 CAMLprim value llvm_genericvalue_of_int(LLVMTypeRef Ty, value Int) {
101 return alloc_generic_value(LLVMCreateGenericValueOfInt(Ty, Int_val(Int), 1));
104 /* Llvm.lltype -> int32 -> t */
105 CAMLprim value llvm_genericvalue_of_int32(LLVMTypeRef Ty, value Int32) {
107 CAMLreturn(alloc_generic_value(
108 LLVMCreateGenericValueOfInt(Ty, Int32_val(Int32), 1)));
111 /* Llvm.lltype -> nativeint -> t */
112 CAMLprim value llvm_genericvalue_of_nativeint(LLVMTypeRef Ty, value NatInt) {
114 CAMLreturn(alloc_generic_value(
115 LLVMCreateGenericValueOfInt(Ty, Nativeint_val(NatInt), 1)));
118 /* Llvm.lltype -> int64 -> t */
119 CAMLprim value llvm_genericvalue_of_int64(LLVMTypeRef Ty, value Int64) {
121 CAMLreturn(alloc_generic_value(
122 LLVMCreateGenericValueOfInt(Ty, Int64_val(Int64), 1)));
125 /* Llvm.lltype -> t -> float */
126 CAMLprim value llvm_genericvalue_as_float(LLVMTypeRef Ty, value GenVal) {
128 CAMLreturn(copy_double(
129 LLVMGenericValueToFloat(Ty, Genericvalue_val(GenVal))));
133 CAMLprim value llvm_genericvalue_as_value(value GenVal) {
134 return Val_op(LLVMGenericValueToPointer(Genericvalue_val(GenVal)));
138 CAMLprim value llvm_genericvalue_as_int(value GenVal) {
139 assert(LLVMGenericValueIntWidth(Genericvalue_val(GenVal)) <= 8 * sizeof(value)
140 && "Generic value too wide to treat as an int!");
141 return Val_int(LLVMGenericValueToInt(Genericvalue_val(GenVal), 1));
145 CAMLprim value llvm_genericvalue_as_int32(value GenVal) {
147 assert(LLVMGenericValueIntWidth(Genericvalue_val(GenVal)) <= 32
148 && "Generic value too wide to treat as an int32!");
149 CAMLreturn(copy_int32(LLVMGenericValueToInt(Genericvalue_val(GenVal), 1)));
153 CAMLprim value llvm_genericvalue_as_int64(value GenVal) {
155 assert(LLVMGenericValueIntWidth(Genericvalue_val(GenVal)) <= 64
156 && "Generic value too wide to treat as an int64!");
157 CAMLreturn(copy_int64(LLVMGenericValueToInt(Genericvalue_val(GenVal), 1)));
161 CAMLprim value llvm_genericvalue_as_nativeint(value GenVal) {
163 assert(LLVMGenericValueIntWidth(Genericvalue_val(GenVal)) <= 8 * sizeof(value)
164 && "Generic value too wide to treat as a nativeint!");
165 CAMLreturn(copy_nativeint(LLVMGenericValueToInt(Genericvalue_val(GenVal),1)));
169 /*--... Operations on execution engines ....................................--*/
171 /* llmodule -> ExecutionEngine.t */
172 CAMLprim LLVMExecutionEngineRef llvm_ee_create(LLVMModuleRef M) {
173 LLVMExecutionEngineRef Interp;
175 if (LLVMCreateExecutionEngineForModule(&Interp, M, &Error))
176 llvm_raise(llvm_ee_error_exn, Error);
180 /* llmodule -> ExecutionEngine.t */
181 CAMLprim LLVMExecutionEngineRef
182 llvm_ee_create_interpreter(LLVMModuleRef M) {
183 LLVMExecutionEngineRef Interp;
185 if (LLVMCreateInterpreterForModule(&Interp, M, &Error))
186 llvm_raise(llvm_ee_error_exn, Error);
190 /* llmodule -> int -> ExecutionEngine.t */
191 CAMLprim LLVMExecutionEngineRef
192 llvm_ee_create_jit(LLVMModuleRef M, value OptLevel) {
193 LLVMExecutionEngineRef JIT;
195 if (LLVMCreateJITCompilerForModule(&JIT, M, Int_val(OptLevel), &Error))
196 llvm_raise(llvm_ee_error_exn, Error);
200 /* ExecutionEngine.t -> unit */
201 CAMLprim value llvm_ee_dispose(LLVMExecutionEngineRef EE) {
202 LLVMDisposeExecutionEngine(EE);
206 /* llmodule -> ExecutionEngine.t -> unit */
207 CAMLprim value llvm_ee_add_mp(LLVMModuleRef M, LLVMExecutionEngineRef EE) {
208 LLVMAddModule(EE, M);
212 /* llmodule -> ExecutionEngine.t -> llmodule */
213 CAMLprim LLVMModuleRef llvm_ee_remove_mp(LLVMModuleRef M,
214 LLVMExecutionEngineRef EE) {
215 LLVMModuleRef RemovedModule;
217 if (LLVMRemoveModule(EE, M, &RemovedModule, &Error))
218 llvm_raise(llvm_ee_error_exn, Error);
219 return RemovedModule;
222 /* string -> ExecutionEngine.t -> llvalue option */
223 CAMLprim value llvm_ee_find_function(value Name, LLVMExecutionEngineRef EE) {
227 if (LLVMFindFunction(EE, String_val(Name), &Found))
228 CAMLreturn(Val_unit);
229 Option = alloc(1, 1);
230 Field(Option, 0) = Val_op(Found);
234 /* llvalue -> GenericValue.t array -> ExecutionEngine.t -> GenericValue.t */
235 CAMLprim value llvm_ee_run_function(LLVMValueRef F, value Args,
236 LLVMExecutionEngineRef EE) {
238 LLVMGenericValueRef Result, *GVArgs;
241 NumArgs = Wosize_val(Args);
242 GVArgs = (LLVMGenericValueRef*) malloc(NumArgs * sizeof(LLVMGenericValueRef));
243 for (I = 0; I != NumArgs; ++I)
244 GVArgs[I] = Genericvalue_val(Field(Args, I));
246 Result = LLVMRunFunction(EE, F, NumArgs, GVArgs);
249 return alloc_generic_value(Result);
252 /* ExecutionEngine.t -> unit */
253 CAMLprim value llvm_ee_run_static_ctors(LLVMExecutionEngineRef EE) {
254 LLVMRunStaticConstructors(EE);
258 /* ExecutionEngine.t -> unit */
259 CAMLprim value llvm_ee_run_static_dtors(LLVMExecutionEngineRef EE) {
260 LLVMRunStaticDestructors(EE);
264 /* llvalue -> string array -> (string * string) array -> ExecutionEngine.t ->
266 CAMLprim value llvm_ee_run_function_as_main(LLVMValueRef F,
267 value Args, value Env,
268 LLVMExecutionEngineRef EE) {
269 CAMLparam2(Args, Env);
270 int I, NumArgs, NumEnv, EnvSize, Result;
271 const char **CArgs, **CEnv;
274 NumArgs = Wosize_val(Args);
275 NumEnv = Wosize_val(Env);
277 /* Build the environment. */
278 CArgs = (const char **) malloc(NumArgs * sizeof(char*));
279 for (I = 0; I != NumArgs; ++I)
280 CArgs[I] = String_val(Field(Args, I));
282 /* Compute the size of the environment string buffer. */
283 for (I = 0, EnvSize = 0; I != NumEnv; ++I) {
284 EnvSize += strlen(String_val(Field(Field(Env, I), 0))) + 1;
285 EnvSize += strlen(String_val(Field(Field(Env, I), 1))) + 1;
288 /* Build the environment. */
289 CEnv = (const char **) malloc((NumEnv + 1) * sizeof(char*));
290 CEnvBuf = (char*) malloc(EnvSize);
292 for (I = 0; I != NumEnv; ++I) {
293 char *Name = String_val(Field(Field(Env, I), 0)),
294 *Value = String_val(Field(Field(Env, I), 1));
295 int NameLen = strlen(Name),
296 ValueLen = strlen(Value);
299 memcpy(Pos, Name, NameLen);
302 memcpy(Pos, Value, ValueLen);
308 Result = LLVMRunFunctionAsMain(EE, F, NumArgs, CArgs, CEnv);
314 CAMLreturn(Val_int(Result));
317 /* llvalue -> ExecutionEngine.t -> unit */
318 CAMLprim value llvm_ee_free_machine_code(LLVMValueRef F,
319 LLVMExecutionEngineRef EE) {
320 LLVMFreeMachineCodeForFunction(EE, F);