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 val of_float: Llvm.lltype -> float -> t
30 (** [of_pointer v] boxes the pointer value [v] in a generic value. See the
31 field [llvm::GenericValue::PointerVal]. *)
32 val of_pointer: 'a -> t
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 val of_int32: Llvm.lltype -> int32 -> t
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 val of_int: Llvm.lltype -> int -> t
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 val of_nativeint: Llvm.lltype -> nativeint -> t
46 (** [of_int64 n w] boxes the int64 [i] in a generic value with the bitwidth
47 [w]. See the field [llvm::GenericValue::IntVal]. *)
48 val of_int64: Llvm.lltype -> int64 -> t
50 (** [as_float fpty gv] unboxes the floating point-valued generic value [gv] of
51 floating point type [fpty]. See the fields [llvm::GenericValue::DoubleVal]
52 and [llvm::GenericValue::FloatVal]. *)
53 val as_float: Llvm.lltype -> t -> float
55 (** [as_pointer gv] unboxes the pointer-valued generic value [gv]. See the
56 field [llvm::GenericValue::PointerVal]. *)
57 val as_pointer: t -> 'a
59 (** [as_int32 gv] unboxes the integer-valued generic value [gv] as an [int32].
60 Is invalid if [gv] has a bitwidth greater than 32 bits. See the field
61 [llvm::GenericValue::IntVal]. *)
62 val as_int32: t -> int32
64 (** [as_int gv] unboxes the integer-valued generic value [gv] as an [int].
65 Is invalid if [gv] has a bitwidth greater than the host bit width (but the
66 most significant bit may be lost). See the field
67 [llvm::GenericValue::IntVal]. *)
70 (** [as_natint gv] unboxes the integer-valued generic value [gv] as a
71 [nativeint]. Is invalid if [gv] has a bitwidth greater than
72 [nativeint]. See the field [llvm::GenericValue::IntVal]. *)
73 val as_nativeint: t -> nativeint
75 (** [as_int64 gv] returns the integer-valued generic value [gv] as an [int64].
76 Is invalid if [gv] has a bitwidth greater than [int64]. See the field
77 [llvm::GenericValue::IntVal]. *)
78 val as_int64: t -> int64
82 module ExecutionEngine: sig
83 (** An execution engine is either a JIT compiler or an interpreter, capable of
84 directly loading an LLVM module and executing its functions without first
85 invoking a static compiler and generating a native executable. *)
88 (** [create m] creates a new execution engine, taking ownership of the
89 module [m] if successful. Creates a JIT if possible, else falls back to an
90 interpreter. Raises [Error msg] if an error occurrs. The execution engine
91 is not garbage collected and must be destroyed with [dispose ee].
92 See the function [llvm::EngineBuilder::create]. *)
93 val create: Llvm.llmodule -> t
95 (** [create_interpreter m] creates a new interpreter, taking ownership of the
96 module [m] if successful. Raises [Error msg] if an error occurrs. The
97 execution engine is not garbage collected and must be destroyed with
99 See the function [llvm::EngineBuilder::create]. *)
100 val create_interpreter: Llvm.llmodule -> t
102 (** [create_jit m] creates a new JIT (just-in-time compiler), taking
103 ownership of the module [m] if successful. This function creates a JIT
104 which favors code quality over compilation speed. Raises [Error msg] if an
105 error occurrs. The execution engine is not garbage collected and must be
106 destroyed with [dispose ee].
107 See the function [llvm::EngineBuilder::create]. *)
108 val create_jit: Llvm.llmodule -> t
110 (** [create_fast_jit m] creates a new JIT (just-in-time compiler) which
111 favors compilation speed over code quality. It takes ownership of the
112 module [m] if successful. Raises [Error msg] if an error occurrs. The
113 execution engine is not garbage collected and must be destroyed with
115 See the function [llvm::EngineBuilder::create]. *)
116 val create_fast_jit: Llvm.llmodule -> t
118 (** [dispose ee] releases the memory used by the execution engine and must be
119 invoked to avoid memory leaks. *)
120 val dispose: t -> unit
122 (** [add_module m ee] adds the module [m] to the execution engine [ee]. *)
123 val add_module: Llvm.llmodule -> t -> unit
125 (** [remove_module m ee] removes the module [m] from the execution engine
126 [ee], disposing of [m] and the module referenced by [mp]. Raises
127 [Error msg] if an error occurs. *)
128 val remove_module: Llvm.llmodule -> t -> Llvm.llmodule
130 (** [find_function n ee] finds the function named [n] defined in any of the
131 modules owned by the execution engine [ee]. Returns [None] if the function
132 is not found and [Some f] otherwise. *)
133 val find_function: string -> t -> Llvm.llvalue option
135 (** [run_function f args ee] synchronously executes the function [f] with the
136 arguments [args], which must be compatible with the parameter types. *)
137 val run_function: Llvm.llvalue -> GenericValue.t array -> t ->
140 (** [run_static_ctors ee] executes the static constructors of each module in
141 the execution engine [ee]. *)
142 val run_static_ctors: t -> unit
144 (** [run_static_dtors ee] executes the static destructors of each module in
145 the execution engine [ee]. *)
146 val run_static_dtors: t -> unit
148 (** [run_function_as_main f args env ee] executes the function [f] as a main
149 function, passing it [argv] and [argc] according to the string array
150 [args], and [envp] as specified by the array [env]. Returns the integer
151 return value of the function. *)
152 val run_function_as_main: Llvm.llvalue -> string array ->
153 (string * string) array -> t -> int
155 (** [free_machine_code f ee] releases the memory in the execution engine [ee]
156 used to store the machine code for the function [f]. *)
157 val free_machine_code: Llvm.llvalue -> t -> unit
159 (** [target_data ee] is the target data owned by the execution engine
161 val target_data: t -> Llvm_target.TargetData.t
164 external initialize_native_target : unit -> bool
165 = "llvm_initialize_native_target"