1 (*===-- llvm_executionengine.mli - LLVM Ocaml Interface ---------*- 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 (** JIT Interpreter. 11 12 This interface provides an ocaml API for LLVM execution engine (JIT/ 13 interpreter), the classes in the ExecutionEngine library. *) 14 15 exception Error of string 16 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]. *) 23 type t 24 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 29 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 33 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 37 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 41 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 45 46 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 val of_int64 : Llvm.lltype -> int64 -> t 50 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 val as_float : Llvm.lltype -> t -> float 55 56 (** [as_pointer gv] unboxes the pointer-valued generic value [gv]. See the 57 field [llvm::GenericValue::PointerVal]. *) 58 val as_pointer : t -> 'a 59 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 val as_int32 : t -> int32 64 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 val as_int : t -> int 70 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 val as_nativeint : t -> nativeint 75 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 val as_int64 : t -> int64 80 end 81 82 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. *) 87 type t 88 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 val create : Llvm.llmodule -> t 95 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 99 [dispose ee]. 100 See the function [llvm::EngineBuilder::create]. *) 101 val create_interpreter : Llvm.llmodule -> t 102 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 val create_jit : Llvm.llmodule -> int -> t 109 110 (** [dispose ee] releases the memory used by the execution engine and must be 111 invoked to avoid memory leaks. *) 112 val dispose : t -> unit 113 114 (** [add_module m ee] adds the module [m] to the execution engine [ee]. *) 115 val add_module : Llvm.llmodule -> t -> unit 116 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 val remove_module : Llvm.llmodule -> t -> Llvm.llmodule 121 122 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 val find_function : string -> t -> Llvm.llvalue option 127 128 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 val run_function : Llvm.llvalue -> GenericValue.t array -> t -> 132 GenericValue.t 133 134 135 (** [run_static_ctors ee] executes the static constructors of each module in 136 the execution engine [ee]. *) 137 val run_static_ctors : t -> unit 138 139 (** [run_static_dtors ee] executes the static destructors of each module in 140 the execution engine [ee]. *) 141 val run_static_dtors : t -> unit 142 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 val run_function_as_main : Llvm.llvalue -> string array -> 148 (string * string) array -> t -> int 149 150 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 val free_machine_code : Llvm.llvalue -> t -> unit 154 155 156 (** [target_data ee] is the target data owned by the execution engine 157 [ee]. *) 158 val target_data : t -> Llvm_target.DataLayout.t 159 160 end 161 162 val initialize_native_target : unit -> bool 163 164
