1 (*===-- llvm_executionengine.mli - LLVM Ocaml Interface ---------*- 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 *===----------------------------------------------------------------------===*)
12 This interface provides an ocaml API for LLVM execution engine (JIT/
13 interpreter), the classes in the ExecutionEngine library. *)
15 exception Error of string
17 module GenericValue: sig
18 (** [GenericValue.t] is a boxed union type used to portably pass arguments to
19 and receive values from the execution engine. It supports only a limited
20 selection of types; for more complex argument types, it is necessary to
21 generate a stub function by hand or to pass parameters by reference.
22 See the struct [llvm::GenericValue]. *)
25 (** [of_float fpty n] boxes the float [n] in a float-valued generic value
26 according to the floating point type [fpty]. See the fields
27 [llvm::GenericValue::DoubleVal] and [llvm::GenericValue::FloatVal]. *)
28 external of_float : Llvm.lltype -> float -> t = "llvm_genericvalue_of_float"
30 (** [of_pointer v] boxes the pointer value [v] in a generic value. See the
31 field [llvm::GenericValue::PointerVal]. *)
32 external of_pointer : 'a -> t = "llvm_genericvalue_of_pointer"
34 (** [of_int32 n w] boxes the int32 [i] in a generic value with the bitwidth
35 [w]. See the field [llvm::GenericValue::IntVal]. *)
36 external of_int32 : Llvm.lltype -> int32 -> t = "llvm_genericvalue_of_int32"
38 (** [of_int n w] boxes the int [i] in a generic value with the bitwidth
39 [w]. See the field [llvm::GenericValue::IntVal]. *)
40 external of_int : Llvm.lltype -> int -> t = "llvm_genericvalue_of_int"
42 (** [of_natint n w] boxes the native int [i] in a generic value with the
43 bitwidth [w]. See the field [llvm::GenericValue::IntVal]. *)
44 external of_nativeint : Llvm.lltype -> nativeint -> t
45 = "llvm_genericvalue_of_nativeint"
47 (** [of_int64 n w] boxes the int64 [i] in a generic value with the bitwidth
48 [w]. See the field [llvm::GenericValue::IntVal]. *)
49 external of_int64 : Llvm.lltype -> int64 -> t = "llvm_genericvalue_of_int64"
51 (** [as_float fpty gv] unboxes the floating point-valued generic value [gv] of
52 floating point type [fpty]. See the fields [llvm::GenericValue::DoubleVal]
53 and [llvm::GenericValue::FloatVal]. *)
54 external as_float : Llvm.lltype -> t -> float = "llvm_genericvalue_as_float"
56 (** [as_pointer gv] unboxes the pointer-valued generic value [gv]. See the
57 field [llvm::GenericValue::PointerVal]. *)
58 external as_pointer : t -> 'a = "llvm_genericvalue_as_pointer"
60 (** [as_int32 gv] unboxes the integer-valued generic value [gv] as an [int32].
61 Is invalid if [gv] has a bitwidth greater than 32 bits. See the field
62 [llvm::GenericValue::IntVal]. *)
63 external as_int32 : t -> int32 = "llvm_genericvalue_as_int32"
65 (** [as_int gv] unboxes the integer-valued generic value [gv] as an [int].
66 Is invalid if [gv] has a bitwidth greater than the host bit width (but the
67 most significant bit may be lost). See the field
68 [llvm::GenericValue::IntVal]. *)
69 external as_int : t -> int = "llvm_genericvalue_as_int"
71 (** [as_natint gv] unboxes the integer-valued generic value [gv] as a
72 [nativeint]. Is invalid if [gv] has a bitwidth greater than
73 [nativeint]. See the field [llvm::GenericValue::IntVal]. *)
74 external as_nativeint : t -> nativeint = "llvm_genericvalue_as_nativeint"
76 (** [as_int64 gv] returns the integer-valued generic value [gv] as an [int64].
77 Is invalid if [gv] has a bitwidth greater than [int64]. See the field
78 [llvm::GenericValue::IntVal]. *)
79 external as_int64 : t -> int64 = "llvm_genericvalue_as_int64"
83 module ExecutionEngine: sig
84 (** An execution engine is either a JIT compiler or an interpreter, capable of
85 directly loading an LLVM module and executing its functions without first
86 invoking a static compiler and generating a native executable. *)
89 (** [create m] creates a new execution engine, taking ownership of the
90 module [m] if successful. Creates a JIT if possible, else falls back to an
91 interpreter. Raises [Error msg] if an error occurrs. The execution engine
92 is not garbage collected and must be destroyed with [dispose ee].
93 See the function [llvm::EngineBuilder::create]. *)
94 external create : Llvm.llmodule -> t = "llvm_ee_create"
96 (** [create_interpreter m] creates a new interpreter, taking ownership of the
97 module [m] if successful. Raises [Error msg] if an error occurrs. The
98 execution engine is not garbage collected and must be destroyed with
100 See the function [llvm::EngineBuilder::create]. *)
101 external create_interpreter : Llvm.llmodule -> t = "llvm_ee_create_interpreter"
103 (** [create_jit m optlevel] creates a new JIT (just-in-time compiler), taking
104 ownership of the module [m] if successful with the desired optimization
105 level [optlevel]. Raises [Error msg] if an error occurrs. The execution
106 engine is not garbage collected and must be destroyed with [dispose ee].
107 See the function [llvm::EngineBuilder::create]. *)
108 external create_jit : Llvm.llmodule -> int -> t = "llvm_ee_create_jit"
110 (** [dispose ee] releases the memory used by the execution engine and must be
111 invoked to avoid memory leaks. *)
112 external dispose : t -> unit = "llvm_ee_dispose"
114 (** [add_module m ee] adds the module [m] to the execution engine [ee]. *)
115 external add_module : Llvm.llmodule -> t -> unit = "llvm_ee_add_module"
117 (** [remove_module m ee] removes the module [m] from the execution engine
118 [ee], disposing of [m] and the module referenced by [mp]. Raises
119 [Error msg] if an error occurs. *)
120 external remove_module : Llvm.llmodule -> t -> Llvm.llmodule
121 = "llvm_ee_remove_module"
123 (** [find_function n ee] finds the function named [n] defined in any of the
124 modules owned by the execution engine [ee]. Returns [None] if the function
125 is not found and [Some f] otherwise. *)
126 external find_function : string -> t -> Llvm.llvalue option
127 = "llvm_ee_find_function"
129 (** [run_function f args ee] synchronously executes the function [f] with the
130 arguments [args], which must be compatible with the parameter types. *)
131 external run_function : Llvm.llvalue -> GenericValue.t array -> t ->
133 = "llvm_ee_run_function"
135 (** [run_static_ctors ee] executes the static constructors of each module in
136 the execution engine [ee]. *)
137 external run_static_ctors : t -> unit = "llvm_ee_run_static_ctors"
139 (** [run_static_dtors ee] executes the static destructors of each module in
140 the execution engine [ee]. *)
141 external run_static_dtors : t -> unit = "llvm_ee_run_static_dtors"
143 (** [run_function_as_main f args env ee] executes the function [f] as a main
144 function, passing it [argv] and [argc] according to the string array
145 [args], and [envp] as specified by the array [env]. Returns the integer
146 return value of the function. *)
147 external run_function_as_main : Llvm.llvalue -> string array ->
148 (string * string) array -> t -> int
149 = "llvm_ee_run_function_as_main"
151 (** [free_machine_code f ee] releases the memory in the execution engine [ee]
152 used to store the machine code for the function [f]. *)
153 external free_machine_code : Llvm.llvalue -> t -> unit
154 = "llvm_ee_free_machine_code"
156 (** [target_data ee] is the target data owned by the execution engine
158 external target_data : t -> Llvm_target.TargetData.t
159 = "LLVMGetExecutionEngineTargetData"
162 external initialize_native_target : unit -> bool
163 = "llvm_initialize_native_target"