Expose the external functions for ocaml's execution engine as an optimization.
[oota-llvm.git] / bindings / ocaml / executionengine / llvm_executionengine.mli
index ac6665b2bc85aec19483ab4b14e59461b738394a..30aa0850e2b32a2cb369a678b69bd0c80dbec2f6 100644 (file)
@@ -25,57 +25,58 @@ module GenericValue: sig
   (** [of_float fpty n] boxes the float [n] in a float-valued generic value
       according to the floating point type [fpty]. See the fields
       [llvm::GenericValue::DoubleVal] and [llvm::GenericValue::FloatVal]. *)
-  val of_float: Llvm.lltype -> float -> t
+  external of_float : Llvm.lltype -> float -> t = "llvm_genericvalue_of_float"
   
   (** [of_pointer v] boxes the pointer value [v] in a generic value. See the
       field [llvm::GenericValue::PointerVal]. *)
-  val of_pointer: 'a -> t
+  external of_pointer : 'a -> t = "llvm_genericvalue_of_value"
   
   (** [of_int32 n w] boxes the int32 [i] in a generic value with the bitwidth
       [w]. See the field [llvm::GenericValue::IntVal]. *)
-  val of_int32: Llvm.lltype -> int32 -> t
+  external of_int32 : Llvm.lltype -> int32 -> t = "llvm_genericvalue_of_int32"
   
   (** [of_int n w] boxes the int [i] in a generic value with the bitwidth
       [w]. See the field [llvm::GenericValue::IntVal]. *)
-  val of_int: Llvm.lltype -> int -> t
+  external of_int : Llvm.lltype -> int -> t = "llvm_genericvalue_of_int"
   
   (** [of_natint n w] boxes the native int [i] in a generic value with the
       bitwidth [w]. See the field [llvm::GenericValue::IntVal]. *)
-  val of_nativeint: Llvm.lltype -> nativeint -> t
-  
+  external of_nativeint : Llvm.lltype -> nativeint -> t
+                        = "llvm_genericvalue_of_nativeint"
+
   (** [of_int64 n w] boxes the int64 [i] in a generic value with the bitwidth
       [w]. See the field [llvm::GenericValue::IntVal]. *)
-  val of_int64: Llvm.lltype -> int64 -> t
-  
+  external of_int64 : Llvm.lltype -> int64 -> t = "llvm_genericvalue_of_int64"
+
   (** [as_float fpty gv] unboxes the floating point-valued generic value [gv] of
       floating point type [fpty]. See the fields [llvm::GenericValue::DoubleVal]
       and [llvm::GenericValue::FloatVal]. *)
-  val as_float: Llvm.lltype -> t -> float
+  external as_float : Llvm.lltype -> t -> float = "llvm_genericvalue_as_float"
   
   (** [as_pointer gv] unboxes the pointer-valued generic value [gv]. See the
       field [llvm::GenericValue::PointerVal]. *)
-  val as_pointer: t -> 'a
+  external as_pointer : t -> 'a = "llvm_genericvalue_as_value"
   
   (** [as_int32 gv] unboxes the integer-valued generic value [gv] as an [int32].
       Is invalid if [gv] has a bitwidth greater than 32 bits. See the field
       [llvm::GenericValue::IntVal]. *)
-  val as_int32: t -> int32
+  external as_int32 : t -> int32 = "llvm_genericvalue_as_int32"
   
   (** [as_int gv] unboxes the integer-valued generic value [gv] as an [int].
       Is invalid if [gv] has a bitwidth greater than the host bit width (but the
       most significant bit may be lost). See the field
       [llvm::GenericValue::IntVal]. *)
-  val as_int: t -> int
+  external as_int : t -> int = "llvm_genericvalue_as_int"
   
   (** [as_natint gv] unboxes the integer-valued generic value [gv] as a
       [nativeint]. Is invalid if [gv] has a bitwidth greater than
       [nativeint]. See the field [llvm::GenericValue::IntVal]. *)
-  val as_nativeint: t -> nativeint
+  external as_nativeint : t -> nativeint = "llvm_genericvalue_as_int"
   
   (** [as_int64 gv] returns the integer-valued generic value [gv] as an [int64].
       Is invalid if [gv] has a bitwidth greater than [int64]. See the field
       [llvm::GenericValue::IntVal]. *)
-  val as_int64: t -> int64
+  external as_int64 : t -> int64 = "llvm_genericvalue_as_int64"
 end
 
 
@@ -90,66 +91,72 @@ module ExecutionEngine: sig
       interpreter. Raises [Error msg] if an error occurrs. The execution engine
       is not garbage collected and must be destroyed with [dispose ee].
       See the function [llvm::EngineBuilder::create]. *)
-  val create: Llvm.llmodule -> t
+  external create : Llvm.llmodule -> t = "llvm_ee_create"
   
   (** [create_interpreter m] creates a new interpreter, taking ownership of the
       module [m] if successful. Raises [Error msg] if an error occurrs. The
       execution engine is not garbage collected and must be destroyed with
       [dispose ee].
       See the function [llvm::EngineBuilder::create]. *)
-  val create_interpreter: Llvm.llmodule -> t
+  external create_interpreter : Llvm.llmodule -> t = "llvm_ee_create_interpreter"
   
   (** [create_jit m optlevel] creates a new JIT (just-in-time compiler), taking
       ownership of the module [m] if successful with the desired optimization
       level [optlevel]. Raises [Error msg] if an error occurrs. The execution
       engine is not garbage collected and must be destroyed with [dispose ee].
       See the function [llvm::EngineBuilder::create]. *)
-  val create_jit : Llvm.llmodule -> int -> t
+  external create_jit : Llvm.llmodule -> int -> t = "llvm_ee_create_jit"
 
   (** [dispose ee] releases the memory used by the execution engine and must be
       invoked to avoid memory leaks. *)
-  val dispose: t -> unit
+  external dispose : t -> unit = "llvm_ee_dispose"
   
   (** [add_module m ee] adds the module [m] to the execution engine [ee]. *)
-  val add_module: Llvm.llmodule -> t -> unit
+  external add_module : Llvm.llmodule -> t -> unit = "llvm_ee_add_mp"
   
   (** [remove_module m ee] removes the module [m] from the execution engine
       [ee], disposing of [m] and the module referenced by [mp]. Raises
       [Error msg] if an error occurs. *)
-  val remove_module: Llvm.llmodule -> t -> Llvm.llmodule
+  external remove_module : Llvm.llmodule -> t -> Llvm.llmodule
+                         = "llvm_ee_remove_module"
   
   (** [find_function n ee] finds the function named [n] defined in any of the
       modules owned by the execution engine [ee]. Returns [None] if the function
       is not found and [Some f] otherwise. *)
-  val find_function: string -> t -> Llvm.llvalue option
+  external find_function : string -> t -> Llvm.llvalue option
+                         = "llvm_ee_find_function"
   
   (** [run_function f args ee] synchronously executes the function [f] with the
       arguments [args], which must be compatible with the parameter types. *)
-  val run_function: Llvm.llvalue -> GenericValue.t array -> t ->
-                    GenericValue.t
+  external run_function : Llvm.llvalue -> GenericValue.t array -> t ->
+                     GenericValue.t
+                   = "llvm_ee_run_function"
   
   (** [run_static_ctors ee] executes the static constructors of each module in
       the execution engine [ee]. *)
-  val run_static_ctors: t -> unit
+  external run_static_ctors : t -> unit = "llvm_ee_run_static_ctors"
   
   (** [run_static_dtors ee] executes the static destructors of each module in
       the execution engine [ee]. *)
-  val run_static_dtors: t -> unit
+  external run_static_dtors : t -> unit = "llvm_ee_run_static_dtors"
   
   (** [run_function_as_main f args env ee] executes the function [f] as a main
       function, passing it [argv] and [argc] according to the string array
       [args], and [envp] as specified by the array [env]. Returns the integer
       return value of the function. *)
-  val run_function_as_main: Llvm.llvalue -> string array ->
-                            (string * string) array -> t -> int
+  external run_function_as_main : Llvm.llvalue -> string array ->
+                                  (string * string) array -> t -> int
+                                = "llvm_ee_run_function_as_main"
   
   (** [free_machine_code f ee] releases the memory in the execution engine [ee]
       used to store the machine code for the function [f]. *)
-  val free_machine_code: Llvm.llvalue -> t -> unit
+  external free_machine_code : Llvm.llvalue -> t -> unit
+                             = "llvm_ee_free_machine_code"
 
   (** [target_data ee] is the target data owned by the execution engine
       [ee]. *)
-  val target_data: t -> Llvm_target.TargetData.t
+  external target_data : t -> Llvm_target.TargetData.t
+                       = "LLVMGetExecutionEngineTargetData"
 end
 
 external initialize_native_target : unit -> bool