diff options
| author | Gordon Henriksen <gordonhenriksen@mac.com> | 2008-03-09 07:17:38 +0000 |
|---|---|---|
| committer | Gordon Henriksen <gordonhenriksen@mac.com> | 2008-03-09 07:17:38 +0000 |
| commit | 3b646de03668fed630f4e3fa9df56a7332a905e4 (patch) | |
| tree | 15785224d9e8e272182d4bf8976d8b8b4bf23f52 /bindings | |
| parent | afb23f48a4f5f76b4a0fca870ae5a28c27dde028 (diff) | |
| download | llvm-3b646de03668fed630f4e3fa9df56a7332a905e4.tar.gz llvm-3b646de03668fed630f4e3fa9df56a7332a905e4.tar.bz2 llvm-3b646de03668fed630f4e3fa9df56a7332a905e4.tar.xz | |
This patch cleans up the OCaml bindings so that they format nicely with
ocamldoc. It does not yet hook into the build system, though.
Patch by Erick Tryzelaar!
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@48095 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'bindings')
| -rw-r--r-- | bindings/ocaml/analysis/llvm_analysis.mli | 21 | ||||
| -rw-r--r-- | bindings/ocaml/bitreader/llvm_bitreader.mli | 13 | ||||
| -rw-r--r-- | bindings/ocaml/bitwriter/llvm_bitwriter.mli | 11 | ||||
| -rw-r--r-- | bindings/ocaml/executionengine/llvm_executionengine.mli | 70 | ||||
| -rw-r--r-- | bindings/ocaml/llvm/llvm.ml | 1 | ||||
| -rw-r--r-- | bindings/ocaml/llvm/llvm.mli | 606 |
6 files changed, 373 insertions, 349 deletions
diff --git a/bindings/ocaml/analysis/llvm_analysis.mli b/bindings/ocaml/analysis/llvm_analysis.mli index 7992ad1d0d..a97bd7e9e2 100644 --- a/bindings/ocaml/analysis/llvm_analysis.mli +++ b/bindings/ocaml/analysis/llvm_analysis.mli @@ -5,32 +5,31 @@ * This file is distributed under the University of Illinois Open Source * License. See LICENSE.TXT for details. * - *===----------------------------------------------------------------------=== - * - * This interface provides an ocaml API for LLVM IR analyses, the classes in - * the Analysis library. - * *===----------------------------------------------------------------------===*) +(** Intermediate representation analysis. + + This interface provides an ocaml API for LLVM IR analyses, the classes in + the Analysis library. *) (** [verify_module m] returns [None] if the module [m] is valid, and [Some reason] if it is invalid. [reason] is a string containing a - human-readable validation report. See [llvm::verifyModule]. **) + human-readable validation report. See [llvm::verifyModule]. *) external verify_module : Llvm.llmodule -> string option = "llvm_verify_module" (** [verify_function f] returns [None] if the function [f] is valid, and [Some reason] if it is invalid. [reason] is a string containing a - human-readable validation report. See [llvm::verifyFunction]. **) + human-readable validation report. See [llvm::verifyFunction]. *) external verify_function : Llvm.llvalue -> bool = "llvm_verify_function" (** [verify_module m] returns if the module [m] is valid, but prints a - validation report to [stderr] and aborts the program if it is invalid. See - [llvm::verifyModule]. **) + validation report to [stderr] and aborts the program if it is invalid. See + [llvm::verifyModule]. *) external assert_valid_module : Llvm.llmodule -> unit = "llvm_assert_valid_module" (** [verify_function f] returns if the function [f] is valid, but prints a - validation report to [stderr] and aborts the program if it is invalid. See - [llvm::verifyFunction]. **) + validation report to [stderr] and aborts the program if it is invalid. See + [llvm::verifyFunction]. *) external assert_valid_function : Llvm.llvalue -> unit = "llvm_assert_valid_function" diff --git a/bindings/ocaml/bitreader/llvm_bitreader.mli b/bindings/ocaml/bitreader/llvm_bitreader.mli index f6fc7b8dcd..15b389bb83 100644 --- a/bindings/ocaml/bitreader/llvm_bitreader.mli +++ b/bindings/ocaml/bitreader/llvm_bitreader.mli @@ -5,26 +5,25 @@ * This file is distributed under the University of Illinois Open Source * License. See LICENSE.TXT for details. * - *===----------------------------------------------------------------------=== - * - * This interface provides an ocaml API for the LLVM bitcode reader, the - * classes in the Bitreader library. - * *===----------------------------------------------------------------------===*) +(** Bitcode reader. + + This interface provides an ocaml API for the LLVM bitcode reader, the + classes in the Bitreader library. *) exception Error of string (** [read_bitcode_file path] reads the bitcode for a new module [m] from the file at [path]. Returns [Success m] if successful, and [Failure msg] otherwise, where [msg] is a description of the error encountered. - See the function [llvm::getBitcodeModuleProvider]. **) + See the function [llvm::getBitcodeModuleProvider]. *) external get_module_provider : Llvm.llmemorybuffer -> Llvm.llmoduleprovider = "llvm_get_module_provider" (** [parse_bitcode mb] parses the bitcode for a new module [m] from the memory buffer [mb]. Returns [Success m] if successful, and [Failure msg] otherwise, where [msg] is a description of the error encountered. - See the function [llvm::ParseBitcodeFile]. **) + See the function [llvm::ParseBitcodeFile]. *) external parse_bitcode : Llvm.llmemorybuffer -> Llvm.llmodule = "llvm_parse_bitcode" diff --git a/bindings/ocaml/bitwriter/llvm_bitwriter.mli b/bindings/ocaml/bitwriter/llvm_bitwriter.mli index 847eefc247..2f782a1d9f 100644 --- a/bindings/ocaml/bitwriter/llvm_bitwriter.mli +++ b/bindings/ocaml/bitwriter/llvm_bitwriter.mli @@ -5,15 +5,14 @@ * This file is distributed under the University of Illinois Open Source * License. See LICENSE.TXT for details. * - *===----------------------------------------------------------------------=== - * - * This interface provides an ocaml API for the LLVM bitcode writer, the - * classes in the Bitwriter library. - * *===----------------------------------------------------------------------===*) +(** Bitcode writer. + + This interface provides an ocaml API for the LLVM bitcode writer, the + classes in the Bitwriter library. *) (** [write_bitcode_file m path] writes the bitcode for module [m] to the file at - [path]. Returns [true] if successful, [false] otherwise. **) + [path]. Returns [true] if successful, [false] otherwise. *) external write_bitcode_file : Llvm.llmodule -> string -> bool = "llvm_write_bitcode_file" diff --git a/bindings/ocaml/executionengine/llvm_executionengine.mli b/bindings/ocaml/executionengine/llvm_executionengine.mli index 0ce5721ed6..d3037fe856 100644 --- a/bindings/ocaml/executionengine/llvm_executionengine.mli +++ b/bindings/ocaml/executionengine/llvm_executionengine.mli @@ -5,78 +5,76 @@ * This file is distributed under the University of Illinois Open Source * License. See LICENSE.TXT for details. * - *===----------------------------------------------------------------------=== - * - * This interface provides an ocaml API for LLVM execution engine (JIT/ - * interpreter), the classes in the ExecutionEngine library. - * *===----------------------------------------------------------------------===*) +(** JIT Interpreter. -exception Error of string + This interface provides an ocaml API for LLVM execution engine (JIT/ + interpreter), the classes in the ExecutionEngine library. *) +exception Error of string module GenericValue: sig (** [GenericValue.t] is a boxed union type used to portably pass arguments to and receive values from the execution engine. It supports only a limited selection of types; for more complex argument types, it is necessary to generate a stub function by hand or to pass parameters by reference. - See the struct [llvm::GenericValue]. **) + See the struct [llvm::GenericValue]. *) type t (** [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]. **) + according to the floating point type [fpty]. See the fields + [llvm::GenericValue::DoubleVal] and [llvm::GenericValue::FloatVal]. *) val of_float: Llvm.lltype -> float -> t (** [of_pointer v] boxes the pointer value [v] in a generic value. See the - field [llvm::GenericValue::PointerVal]. **) + field [llvm::GenericValue::PointerVal]. *) val of_pointer: 'a -> t (** [of_int32 n w] boxes the int32 [i] in a generic value with the bitwidth - [w]. See the field [llvm::GenericValue::IntVal]. **) + [w]. See the field [llvm::GenericValue::IntVal]. *) val of_int32: Llvm.lltype -> int32 -> t (** [of_int n w] boxes the int [i] in a generic value with the bitwidth - [w]. See the field [llvm::GenericValue::IntVal]. **) + [w]. See the field [llvm::GenericValue::IntVal]. *) val of_int: Llvm.lltype -> int -> t (** [of_natint n w] boxes the native int [i] in a generic value with the - bitwidth [w]. See the field [llvm::GenericValue::IntVal]. **) + bitwidth [w]. See the field [llvm::GenericValue::IntVal]. *) val of_nativeint: Llvm.lltype -> nativeint -> t (** [of_int64 n w] boxes the int64 [i] in a generic value with the bitwidth - [w]. See the field [llvm::GenericValue::IntVal]. **) + [w]. See the field [llvm::GenericValue::IntVal]. *) val of_int64: Llvm.lltype -> int64 -> t (** [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]. **) + and [llvm::GenericValue::FloatVal]. *) val as_float: Llvm.lltype -> t -> float (** [as_pointer gv] unboxes the pointer-valued generic value [gv]. See the - field [llvm::GenericValue::PointerVal]. **) + field [llvm::GenericValue::PointerVal]. *) val as_pointer: t -> 'a (** [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]. **) + [llvm::GenericValue::IntVal]. *) val as_int32: t -> 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]. **) + [llvm::GenericValue::IntVal]. *) val as_int: t -> 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]. **) + [nativeint]. See the field [llvm::GenericValue::IntVal]. *) val as_nativeint: t -> nativeint (** [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]. **) + [llvm::GenericValue::IntVal]. *) val as_int64: t -> int64 end @@ -84,69 +82,69 @@ end module ExecutionEngine: sig (** An execution engine is either a JIT compiler or an interpreter, capable of directly loading an LLVM module and executing its functions without first - invoking a static compiler and generating a native executable. **) + invoking a static compiler and generating a native executable. *) type t (** [create mp] creates a new execution engine, taking ownership of the module provider [mp] if successful. Creates a JIT if possible, else falls back to an 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::ExecutionEngine::create]. **) + [dispose ee]. See the function [llvm::ExecutionEngine::create]. *) val create: Llvm.llmoduleprovider -> t (** [create_interpreter mp] creates a new interpreter, taking ownership of the module provider [mp] 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::ExecutionEngine::create]. **) + See the function [llvm::ExecutionEngine::create]. *) val create_interpreter: Llvm.llmoduleprovider -> t (** [create_jit mp] creates a new JIT (just-in-time compiler), taking ownership of the module provider [mp] 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::ExecutionEngine::create]. **) + See the function [llvm::ExecutionEngine::create]. *) val create_jit: Llvm.llmoduleprovider -> t (** [dispose ee] releases the memory used by the execution engine and must be - invoked to avoid memory leaks. **) + invoked to avoid memory leaks. *) val dispose: t -> unit (** [add_module_provider mp ee] adds the module provider [mp] to the execution - engine [ee]. **) + engine [ee]. *) val add_module_provider: Llvm.llmoduleprovider -> t -> unit (** [remove_module_provider mp ee] removes the module provider [mp] from the execution engine [ee], disposing of [mp] and the module referenced by - [mp]. Raises [Error msg] if an error occurs. **) + [mp]. Raises [Error msg] if an error occurs. *) val remove_module_provider: Llvm.llmoduleprovider -> t -> Llvm.llmodule - (** [find_function n ee] finds the function named [n] defined in any of the + (** [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. **) + is not found and [Some f] otherwise. *) val find_function: string -> t -> Llvm.llvalue option (** [run_function f args ee] synchronously executes the function [f] with the - arguments [args], which must be compatible with the parameter types. **) + arguments [args], which must be compatible with the parameter types. *) val run_function: Llvm.llvalue -> GenericValue.t array -> t -> GenericValue.t (** [run_static_ctors ee] executes the static constructors of each module in - the execution engine [ee]. **) + the execution engine [ee]. *) val run_static_ctors: t -> unit (** [run_static_dtors ee] executes the static destructors of each module in - the execution engine [ee]. **) + the execution engine [ee]. *) val run_static_dtors: t -> unit - (** [run_function_as_main f args env ee] executes the function [f] as a main + (** [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. **) + [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 (** [free_machine_code f ee] releases the memory in the execution engine [ee] - used to store the machine code for the function [f]. **) + used to store the machine code for the function [f]. *) val free_machine_code: Llvm.llvalue -> t -> unit end diff --git a/bindings/ocaml/llvm/llvm.ml b/bindings/ocaml/llvm/llvm.ml index 9d138eb08d..d69487a2df 100644 --- a/bindings/ocaml/llvm/llvm.ml +++ b/bindings/ocaml/llvm/llvm.ml @@ -120,7 +120,6 @@ external define_type_name : string -> lltype -> llmodule -> bool external delete_type_name : string -> llmodule -> unit = "llvm_delete_type_name" - (*===-- Types -------------------------------------------------------------===*) external classify_type : lltype -> TypeKind.t = "llvm_classify_type" diff --git a/bindings/ocaml/llvm/llvm.mli b/bindings/ocaml/llvm/llvm.mli index 3ed9d27329..477a0c6cb8 100644 --- a/bindings/ocaml/llvm/llvm.mli +++ b/bindings/ocaml/llvm/llvm.mli @@ -5,51 +5,53 @@ * This file is distributed under the University of Illinois Open Source * License. See LICENSE.TXT for details. * - *===----------------------------------------------------------------------=== - * - * This interface provides an ocaml API for the LLVM intermediate - * representation, the classes in the VMCore library. - * *===----------------------------------------------------------------------===*) +(** Core API. + + This interface provides an ocaml API for the LLVM intermediate + representation, the classes in the VMCore library. *) + + +(** {6 Abstract types} -(* These abstract types correlate directly to the LLVM VMCore classes. *) + These abstract types correlate directly to the LLVM VMCore classes. *) (** The top-level container for all other LLVM Intermediate Representation (IR) - objects. See the [llvm::Module] class. **) + objects. See the [llvm::Module] class. *) type llmodule (** Each value in the LLVM IR has a type, an instance of [lltype]. See the - [llvm::Type] class. **) -type lltype + [llvm::Type] class. *) +type lltype -(** When building recursive types using [refine_type], [lltype] values may +(** When building recursive types using {!refine_type}, [lltype] values may become invalid; use [lltypehandle] to resolve this problem. See the - [llvm::AbstractTypeHolder] class. **) + [llvm::AbstractTypeHolder] class. *) type lltypehandle (** Any value in the LLVM IR. Functions, instructions, global variables, constants, and much more are all [llvalues]. See the [llvm::Value] class. - This type covers a wide range of subclasses. **) + This type covers a wide range of subclasses. *) type llvalue -(** A basic block in LLVM IR. See the [llvm::BasicBlock] class. **) +(** A basic block in LLVM IR. See the [llvm::BasicBlock] class. *) type llbasicblock (** Used to generate instructions in the LLVM IR. See the [llvm::LLVMBuilder] - class. **) + class. *) type llbuilder (** Used to provide a module to JIT or interpreter. - See the [llvm::ModuleProvider] class. **) + See the [llvm::ModuleProvider] class. *) type llmoduleprovider (** Used to efficiently handle large buffers of read-only binary data. - See the [llvm::MemoryBuffer] class. **) + See the [llvm::MemoryBuffer] class. *) type llmemorybuffer -(** The kind of an [lltype], the result of [classify_type ty]. See the - [llvm::Type::TypeID] enumeration. **) +(** The kind of an [lltype], the result of [classify_type ty]. See the + [llvm::Type::TypeID] enumeration. *) module TypeKind : sig type t = Void @@ -68,8 +70,8 @@ module TypeKind : sig | Vector end -(** The linkage of a global value, accessed with [linkage gv] and - [set_linkage l gv]. See [llvm::GlobalValue::LinkageTypes]. **) +(** The linkage of a global value, accessed with {!linkage} and + {!set_linkage}. See [llvm::GlobalValue::LinkageTypes]. *) module Linkage : sig type t = External @@ -83,8 +85,8 @@ module Linkage : sig | Ghost end -(** The linker visibility of a global value, accessed with [visibility gv] and - [set_visibility v gv]. See [llvm::GlobalValue::VisibilityTypes]. **) +(** The linker visibility of a global value, accessed with {!visibility} and + {!set_visibility}. See [llvm::GlobalValue::VisibilityTypes]. *) module Visibility : sig type t = Default @@ -92,24 +94,24 @@ module Visibility : sig | Protected end -(* The following calling convention values may be accessed with - [function_call_conv f] and [set_function_call_conv conv f]. Calling - conventions are open-ended. *) +(** The following calling convention values may be accessed with + {!function_call_conv} and {!set_function_call_conv}. Calling + conventions are open-ended. *) module CallConv : sig - val c : int (** [c] is the C calling convention. **) + val c : int (** [c] is the C calling convention. *) val fast : int (** [fast] is the calling convention to allow LLVM maximum optimization opportunities. Use only with - internal linkage. **) + internal linkage. *) val cold : int (** [cold] is the calling convention for - callee-save. **) + callee-save. *) val x86_stdcall : int (** [x86_stdcall] is the familiar stdcall calling - convention from C. **) + convention from C. *) val x86_fastcall : int (** [x86_fastcall] is the familiar fastcall calling - convention from C. **) + convention from C. *) end (** The predicate for an integer comparison ([icmp]) instruction. - See the [llvm::ICmpInst::Predicate] enumeration. **) + See the [llvm::ICmpInst::Predicate] enumeration. *) module Icmp : sig type t = | Eq @@ -125,7 +127,7 @@ module Icmp : sig end (** The predicate for a floating-point comparison ([fcmp]) instruction. - See the [llvm::FCmpInst::Predicate] enumeration. **) + See the [llvm::FCmpInst::Predicate] enumeration. *) module Fcmp : sig type t = | False @@ -146,47 +148,50 @@ module Fcmp : sig | True end + +(** {6 Exceptions} *) + exception IoError of string -(*===-- Modules -----------------------------------------------------------===*) +(** {6 Modules} *) (** [create_module id] creates a module with the supplied module ID. Modules are - not garbage collected; it is mandatory to call [dispose_module m] to free + not garbage collected; it is mandatory to call {!dispose_module} to free memory. See the constructor [llvm::Module::Module]. *) external create_module : string -> llmodule = "llvm_create_module" (** [dispose_module m] destroys a module [m] and all of the IR objects it contained. All references to subordinate objects are invalidated; referencing them will invoke undefined behavior. See the destructor - [llvm::Module::~Module]. **) + [llvm::Module::~Module]. *) external dispose_module : llmodule -> unit = "llvm_dispose_module" (** [target_triple m] is the target specifier for the module [m], something like - [i686-apple-darwin8]. See the method [llvm::Module::getTargetTriple]. **) + [i686-apple-darwin8]. See the method [llvm::Module::getTargetTriple]. *) external target_triple: llmodule -> string = "llvm_target_triple" (** [target_triple triple m] changes the target specifier for the module [m] to - the string [triple]. See the method [llvm::Module::setTargetTriple]. **) + the string [triple]. See the method [llvm::Module::setTargetTriple]. *) external set_target_triple: string -> llmodule -> unit = "llvm_set_target_triple" (** [data_layout m] is the data layout specifier for the module [m], something like [e-p:32:32:32-i1:8:8-i8:8:8-i16:16:16-...-a0:0:64-f80:128:128]. See the - method [llvm::Module::getDataLayout]. **) + method [llvm::Module::getDataLayout]. *) external data_layout: llmodule -> string = "llvm_data_layout" (** [set_data_layout s m] changes the data layout specifier for the module [m] - to the string [s]. See the method [llvm::Module::setDataLayout]. **) + to the string [s]. See the method [llvm::Module::setDataLayout]. *) external set_data_layout: string -> llmodule -> unit = "llvm_set_data_layout" (** [define_type_name name ty m] adds a named type to the module's symbol table. Returns [true] if successful. If such a name already exists, then no entry is added and [false] is returned. See the [llvm::Module::addTypeName] - method. **) + method. *) external define_type_name : string -> lltype -> llmodule -> bool = "llvm_add_type_name" @@ -196,446 +201,455 @@ external delete_type_name : string -> llmodule -> unit = "llvm_delete_type_name" -(*===-- Types -------------------------------------------------------------===*) +(** {6 Types} *) -(** [classify_type ty] returns the [type_kind] corresponding to the type [ty]. - See the method [llvm::Type::getTypeID]. **) +(** [classify_type ty] returns the {!TypeKind.t} corresponding to the type [ty]. + See the method [llvm::Type::getTypeID]. *) external classify_type : lltype -> TypeKind.t = "llvm_classify_type" -(** [string_of_lltype ty] returns a string describing the type [ty]. **) +(** [string_of_lltype ty] returns a string describing the type [ty]. *) val string_of_lltype : lltype -> string -(*--... Operations on integer types ........................................--*) +(** {7 Operations on integer types} *) -(** The 1-bit integer type. See [llvm::Type::Int1Ty]. **) -val i1_type : lltype +(** The 1-bit integer type. See [llvm::Type::Int1Ty]. *) +val i1_type : lltype -(** The 8-bit integer type. See [llvm::Type::Int8Ty]. **) -val i8_type : lltype +(** The 8-bit integer type. See [llvm::Type::Int8Ty]. *) +val i8_type : lltype -(** The 16-bit integer type. See [llvm::Type::Int16Ty]. **) +(** The 16-bit integer type. See [llvm::Type::Int16Ty]. *) val i16_type : lltype -(** The 32-bit integer type. See [llvm::Type::Int32Ty]. **) +(** The 32-bit integer type. See [llvm::Type::Int32Ty]. *) val i32_type : lltype -(** The 64-bit integer type. See [llvm::Type::Int64Ty]. **) +(** The 64-bit integer type. See [llvm::Type::Int64Ty]. *) val i64_type : lltype (** [integer_type n] returns an integer type of bitwidth [n]. - See the method [llvm::IntegerType::get]. **) + See the method [llvm::IntegerType::get]. *) external integer_type : int -> lltype = "llvm_integer_type" -(** [integer_bitwidth ty] returns the number of bits in the integer type [ty].. - See the method [llvm::IntegerType::getBitWidth]. **) +(** [integer_bitwidth ty] returns the number of bits in the integer type [ty]. + See the method [llvm::IntegerType::getBitWidth]. *) external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth" -(*--... Operations on real types ...........................................--*) -(** The IEEE 32-bit floating point type. See [llvm::Type::FloatTy]. **) +(** {7 Operations on real types} *) + +(** The IEEE 32-bit floating point type. See [llvm::Type::FloatTy]. *) val float_type : lltype -(** The IEEE 64-bit floating point type. See [llvm::Type::DoubleTy]. **) +(** The IEEE 64-bit floating point type. See [llvm::Type::DoubleTy]. *) val double_type : lltype -(** The x87 80-bit floating point type. See [llvm::Type::X86_FP80Ty]. **) +(** The x87 80-bit floating point type. See [llvm::Type::X86_FP80Ty]. *) val x86fp80_type : lltype -(** The IEEE 128-bit floating point type. See [llvm::Type::FP128Ty]. **) +(** The IEEE 128-bit floating point type. See [llvm::Type::FP128Ty]. *) val fp128_type : lltype -(** The PowerPC 128-bit floating point type. See [llvm::Type::PPC_FP128Ty]. **) +(** The PowerPC 128-bit floating point type. See [llvm::Type::PPC_FP128Ty]. *) val ppc_fp128_type : lltype -(*--... Operations on function types .......................................--*) + +(** {7 Operations on function types} *) (** [function_type ret_ty param_tys] returns the function type returning [ret_ty] and taking [param_tys] as parameters. - See the method [llvm::FunctionType::get]. **) + See the method [llvm::FunctionType::get]. *) external function_type : lltype -> lltype array -> lltype = "llvm_function_type" (** [va_arg_function_type ret_ty param_tys] is just like [function_type ret_ty param_tys] except that it returns the function type which also takes a variable number of arguments. - See the method [llvm::FunctionType::get]. **) + See the method [llvm::FunctionType::get]. *) external var_arg_function_type : lltype -> lltype array -> lltype = "llvm_var_arg_function_type" (** [is_var_arg fty] returns [true] if [fty] is a varargs function type, [false] - otherwise. See the method [llvm::FunctionType::isVarArg]. **) + otherwise. See the method [llvm::FunctionType::isVarArg]. *) external is_var_arg : lltype -> bool = "llvm_is_var_arg" (** [return_type fty] gets the return type of the function type [fty]. - See the method [llvm::FunctionType::getReturnType]. **) + See the method [llvm::FunctionType::getReturnType]. *) external return_type : lltype -> lltype = "LLVMGetReturnType" (** [param_types fty] gets the parameter types of the function type [fty]. - See the method [llvm::FunctionType::getParamType]. **) + See the method [llvm::FunctionType::getParamType]. *) external param_types : lltype -> lltype array = "llvm_param_types" -(*--... Operations on struct types .........................................--*) + +(** {7 Operations on struct types} *) (** [struct_type tys] returns the structure type containing in the types in the - array [tys]. See the method [llvm::StructType::get]. **) + array [tys]. See the method [llvm::StructType::get]. *) external struct_type : lltype array -> lltype = "llvm_struct_type" (** [struct_type tys] returns the packed structure type containing in the types - in the array [tys]. See the method [llvm::StructType::get]. **) + in the array [tys]. See the method [llvm::StructType::get]. *) external packed_struct_type : lltype array -> lltype = "llvm_packed_struct_type" (** [element_types sty] returns the constituent types of the struct type [sty]. - See the method [llvm::StructType::getElementType]. **) + See the method [llvm::StructType::getElementType]. *) external element_types : lltype -> lltype array = "llvm_element_types" (** [is_packed sty] returns [true] if the structure type [sty] is packed, - [false] otherwise. See the method [llvm::StructType::isPacked]. **) + [false] otherwise. See the method [llvm::StructType::isPacked]. *) external is_packed : lltype -> bool = "llvm_is_packed" -(*--... Operations on pointer, vector, and array types .....................--*) + +(** {7 Operations on pointer, vector, and array types} *) (** [array_type ty n] returns the array type containing [n] elements of type - [ty]. See the method [llvm::ArrayType::get]. **) + [ty]. See the method [llvm::ArrayType::get]. *) external array_type : lltype -> int -> lltype = "llvm_array_type" (** [pointer_type ty] returns the pointer type referencing objects of type [ty] in the default address space (0). - See the method [llvm::PointerType::getUnqual]. **) + See the method [llvm::PointerType::getUnqual]. *) external pointer_type : lltype -> lltype = "llvm_pointer_type" (** [qualified_pointer_type ty as] returns the pointer type referencing objects of type [ty] in address space [as]. - See the method [llvm::PointerType::get]. **) + See the method [llvm::PointerType::get]. *) external qualified_pointer_type : lltype -> int -> lltype = "llvm_qualified_pointer_type" (** [vector_type ty n] returns the array type containing [n] elements of the - primitive type [ty]. See the method [llvm::ArrayType::get]. **) + primitive type [ty]. See the method [llvm::ArrayType::get]. *) external vector_type : lltype -> int -> lltype = "llvm_vector_type" (** [element_type ty] returns the element type of the pointer, vector, or array - type [ty]. See the method [llvm::SequentialType::get]. **) + type [ty]. See the method [llvm::SequentialType::get]. *) external element_type : lltype -> lltype = "LLVMGetElementType" (** [element_type aty] returns the element count of the array type [aty]. - See the method [llvm::ArrayType::getNumElements]. **) + See the method [llvm::ArrayType::getNumElements]. *) external array_length : lltype -> int = "llvm_array_length" (** [address_space pty] returns the address space qualifier of the pointer type - [pty]. See the method [llvm::PointerType::getAddressSpace]. **) + [pty]. See the method [llvm::PointerType::getAddressSpace]. *) external address_space : lltype -> int = "llvm_address_space" (** [element_type ty] returns the element count of the vector type [ty]. - See the method [llvm::VectorType::getNumElements]. **) + See the method [llvm::VectorType::getNumElements]. *) external vector_size : lltype -> int = "llvm_vector_size" -(*--... Operations on other types ..........................................--*) + +(** {7 Operations on other types} *) (** [opaque_type ()] creates a new opaque type distinct from any other. Opaque types are useful for building recursive types in combination with - [refine_type opaque_ty ty]. - See [llvm::OpaqueType::get]. **) + {!refine_type} [opaque_ty ty]. + See [llvm::OpaqueType::get]. *) external opaque_type : unit -> lltype = "llvm_opaque_type" (** [void_type] is the type of a function which does not return any value. - See [llvm::Type::VoidTy]. **) + See [llvm::Type::VoidTy]. *) val void_type : lltype -(** [label_type] is the type of a basic block. See [llvm::Type::LabelTy]. **) +(** [label_type] is the type of a basic block. See [llvm::Type::LabelTy]. *) val label_type : lltype -(*--... Operations on type handles .........................................--*) +(** {7 Operations on type handles} *) (** [handle_to_type ty] creates a handle to the type [ty]. If [ty] is later - refined as a result of a call to [refine_type], the handle will be updated; + refined as a result of a call to {!refine_type}, the handle will be updated; any bare [lltype] references will become invalid. - See the class [llvm::PATypeHolder]. **) + See the class [llvm::PATypeHolder]. *) external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type" (** [type_of_handle tyh] resolves the type handle [tyh]. - See the method [llvm::PATypeHolder::get()]. **) + See the method [llvm::PATypeHolder::get()]. *) external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle" (** [refine_type opaque_ty ty] replaces the abstract type [opaque_ty] with the - concrete type [ty] in all users. Warning: This may invalidate [lltype] - values! Use [lltypehandle] to manipulate potentially abstract types. See the - method [llvm::Type::refineAbstractType]. **) + concrete type [ty] in all users. Warning: This may invalidate {!lltype} + values! Use {!lltypehandle} to manipulate potentially abstract types. See + the method [llvm::Type::refineAbstractType]. *) external refine_type : lltype -> lltype -> unit = "llvm_refine_type" -(*===-- Values ------------------------------------------------------------===*) +(* {6 Values} *) (** [type_of v] returns the type of the value [v]. - See the method [llvm::Value::getType]. **) + See the method [llvm::Value::getType]. *) external type_of : llvalue -> lltype = "llvm_type_of" (** [value_name v] returns the name of the value [v]. For global values, this is the symbol name. For instructions and basic blocks, it is the SSA register name. It is meaningless for constants. - See the method [llvm::Value::getName]. **) + See the method [llvm::Value::getName]. *) external value_name : llvalue -> string = "llvm_value_name" -(** [set_value_name n v] sets the name of the value [v] to [n]. See the method - [llvm::Value::setName]. **) +(** [set_value_name n v] sets the name of the value [v] to [n]. See the method + [llvm::Value::setName]. *) external set_value_name : string -> llvalue -> unit = "llvm_set_value_name" (** [dump_value v] prints the .ll representation of the value [v] to standard - error. See the method [llvm::Value::dump]. **) + error. See the method [llvm::Value::dump]. *) external dump_value : llvalue -> unit = "llvm_dump_value" -(*--... Operations on constants of (mostly) any type .......................--*) + +(** {7 Operations on constants of (mostly) any type} *) (** [is_constant v] returns [true] if the value [v] is a constant, [false] - otherwise. Similar to [llvm::isa<Constant>]. **) + otherwise. Similar to [llvm::isa<Constant>]. *) external is_constant : llvalue -> bool = "llvm_is_constant" (** [const_null ty] returns the constant null (zero) of the type [ty]. - See the method [llvm::Constant::getNullValue]. **) + See the method [llvm::Constant::getNullValue]. *) external const_null : lltype -> llvalue = "LLVMConstNull" (** [const_all_ones ty] returns the constant '-1' of the integer or vector type - [ty]. See the method [llvm::Constant::getAllOnesValue]. **) + [ty]. See the method [llvm::Constant::getAllOnesValue]. *) external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes" (** [undef ty] returns the undefined value of the type [ty]. - See the method [llvm::UndefValue::get]. **) + See the method [llvm::UndefValue::get]. *) external undef : lltype -> llvalue = "LLVMGetUndef" (** [is_null v] returns [true] if the value [v] is the null (zero) value. - See the method [llvm::Constant::isNullValue]. **) + See the method [llvm::Constant::isNullValue]. *) external is_null : llvalue -> bool = "llvm_is_null" (** [is_undef v] returns [true] if the value [v] is an undefined value, [false] - otherwise. Similar to [llvm::isa<UndefValue>]. **) + otherwise. Similar to [llvm::isa<UndefValue>]. *) external is_undef : llvalue -> bool = "llvm_is_undef" -(*--... Operations on scalar constants .....................................--*) + +(** {7 Operations on scalar constants} *) (** [const_int ty i] returns the integer constant of type [ty] and value [i]. - See the method [llvm::ConstantInt::get]. **) + See the method [llvm::ConstantInt::get]. *) external const_int : lltype -> int -> llvalue = "llvm_const_int" (** [const_of_int64 ty i] returns the integer constant of type [ty] and value - [i]. See the method [llvm::ConstantInt::get]. **) + [i]. See the method [llvm::ConstantInt::get]. *) external const_of_int64 : lltype -> Int64.t -> bool -> llvalue = "llvm_const_of_int64" (** [const_float ty n] returns the floating point constant of type [ty] and - value [n]. See the method [llvm::ConstantInt::get]. **) + value [n]. See the method [llvm::ConstantInt::get]. *) external const_float : lltype -> float -> llvalue = "llvm_const_float" -(*--... Operations on composite constants ..................................--*) + +(** {7 Operations on composite constants} *) (** [const_string s] returns the constant [i8] array with the values of the characters in the string [s]. The array is not null-terminated (but see - [const_stringz]). This value can in turn be used as the initializer for a - global variable. See the method [llvm::ConstantArray::get]. **) + {!const_stringz}). This value can in turn be used as the initializer for a + global variable. See the method [llvm::ConstantArray::get]. *) external const_string : string -> llvalue = "llvm_const_string" (** [const_stringz s] returns the constant [i8] array with the values of the characters in the string [s] and a null terminator. This value can in turn be used as the initializer for a global variable. - See the method [llvm::ConstantArray::get]. **) + See the method [llvm::ConstantArray::get]. *) external const_stringz : string -> llvalue = "llvm_const_stringz" (** [const_array ty elts] returns the constant array of type [array_type ty (Array.length elts)] and containing the values [elts]. This value can in turn be used as the initializer for a global variable. - See the method [llvm::ConstantArray::get]. **) + See the method [llvm::ConstantArray::get]. *) external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array" (** [const_struct elts] returns the structured constant of type [struct_type (Array.map type_of elts)] and containing the values [elts]. This value can in turn be used as the initializer for a global variable. - See the method [llvm::ConstantStruct::get]. **) + See the method [llvm::ConstantStruct::get]. *) external const_struct : llvalue array -> llvalue = "llvm_const_struct" (** [const_packed_struct elts] returns the structured constant of type - [packed_struct_type (Array.map type_of elts)] and containing the values + {!packed_struct_type} [(Array.map type_of elts)] and containing the values [elts]. This value can in turn be used as the initializer for a global - variable. See the method [llvm::ConstantStruct::get]. **) + variable. See the method [llvm::ConstantStruct::get]. *) external const_packed_struct : llvalue array -> llvalue = "llvm_const_packed_struct" (** [const_vector elts] returns the vector constant of type [vector_type (type_of elts.(0)) (Array.length elts)] and containing the - values [elts]. See the method [llvm::ConstantVector::get]. **) + values [elts]. See the method [llvm::ConstantVector::get]. *) external const_vector : llvalue array -> llvalue = "llvm_const_vector" -(*--... Constant expressions ...............................................--*) + +(** {7 Constant expressions} *) (** [size_of ty] returns the sizeof constant for the type [ty]. This is equivalent to [const_ptrtoint (const_gep (const_null (pointer_type ty)) (const_int i64_type 1)) i64_type], but considerably more readable. - See the method [llvm::ConstantExpr::getSizeOf]. **) + See the method [llvm::ConstantExpr::getSizeOf]. *) external size_of : lltype -> llvalue = "LLVMSizeOf" (** [const_neg c] returns the arithmetic negation of the constant [c]. - See the method [llvm::ConstantExpr::getNeg]. **) + See the method [llvm::ConstantExpr::getNeg]. *) external const_neg : llvalue -> llvalue = "LLVMConstNeg" (** [const_not c] returns the bitwise inverse of the constant [c]. - See the method [llvm::ConstantExpr::getNot]. **) + See the method [llvm::ConstantExpr::getNot]. *) external const_not : llvalue -> llvalue = "LLVMConstNot" (** [const_add c1 c2] returns the constant sum of two constants. - See the method [llvm::ConstantExpr::getAdd]. **) + See the method [llvm::ConstantExpr::getAdd]. *) external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd" (** [const_sub c1 c2] returns the constant difference, [c1 - c2], of two - constants. See the method [llvm::ConstantExpr::getSub]. **) + constants. See the method [llvm::ConstantExpr::getSub]. *) external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub" (** [const_mul c1 c2] returns the constant product of two constants. - See the method [llvm::ConstantExpr::getMul]. **) + See the method [llvm::ConstantExpr::getMul]. *) external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul" (** [const_udiv c1 c2] returns the constant quotient [c1 / c2] of two unsigned integer constants. - See the method [llvm::ConstantExpr::getUDiv]. **) + See the method [llvm::ConstantExpr::getUDiv]. *) external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv" (** [const_sdiv c1 c2] returns the constant quotient [c1 / c2] of two signed integer constants. - See the method [llvm::ConstantExpr::]. **) + See the method [llvm::ConstantExpr::]. *) external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv" (** [const_fdiv c1 c2] returns the constant quotient [c1 / c2] of two floating point constants. - See the method [llvm::ConstantExpr::getFDiv]. **) + See the method [llvm::ConstantExpr::getFDiv]. *) external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv" (** [const_udiv c1 c2] returns the constant remainder [c1 MOD c2] of two unsigned integer constants. - See the method [llvm::ConstantExpr::getURem]. **) + See the method [llvm::ConstantExpr::getURem]. *) external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem" (** [const_sdiv c1 c2] returns the constant remainder [c1 MOD c2] of two signed integer constants. - See the method [llvm::ConstantExpr::getSRem]. **) + See the method [llvm::ConstantExpr::getSRem]. *) external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem" (** [const_frem c1 c2] returns the constant remainder [c1 MOD c2] of two signed floating point constants. - See the method [llvm::ConstantExpr::getFRem]. **) + See the method [llvm::ConstantExpr::getFRem]. *) external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem" (** [const_and c1 c2] returns the constant bitwise [AND] of two integer constants. - See the method [llvm::ConstantExpr::getAnd]. **) + See the method [llvm::ConstantExpr::getAnd]. *) external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd" (** [const_or c1 c2] returns the constant bitwise [OR] of two integer constants. - See the method [llvm::ConstantExpr::getOr]. **) + See the method [llvm::ConstantExpr::getOr]. *) external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr" (** [const_xor c1 c2] returns the constant bitwise [XOR] of two integer constants. - See the method [llvm::ConstantExpr::getXor]. **) + See the method [llvm::ConstantExpr::getXor]. *) external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor" (** [const_icmp pred c1 c2] returns the constant comparison of two integer constants, [c1 pred c2]. - See the method [llvm::ConstantExpr::getICmp]. **) + See the method [llvm::ConstantExpr::getICmp]. *) external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue = "llvm_const_icmp" (** [const_fcmp pred c1 c2] returns the constant comparison of two floating point constants, [c1 pred c2]. - See the method [llvm::ConstantExpr::getFCmp]. **) + See the method [llvm::ConstantExpr::getFCmp]. *) external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue = "llvm_const_fcmp" (** [const_shl c1 c2] returns the constant integer [c1] left-shifted by the constant integer [c2]. - See the method [llvm::ConstantExpr::getShl]. **) + See the method [llvm::ConstantExpr::getShl]. *) external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl" (** [const_lshr c1 c2] returns the constant integer [c1] right-shifted by the constant integer [c2] with zero extension. - See the method [llvm::ConstantExpr::getLShr]. **) + See the method [llvm::ConstantExpr::getLShr]. *) external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr" (** [const_ashr c1 c2] returns the constant integer [c1] right-shifted by the constant integer [c2] with sign extension. - See the method [llvm::ConstantExpr::getAShr]. **) + See the method [llvm::ConstantExpr::getAShr]. *) external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr" (** [const_gep pc indices] returns the constant [getElementPtr] of [p1] with the constant integers indices from the array [indices]. - See the method [llvm::ConstantExpr::getGetElementPtr]. **) + See the method [llvm::ConstantExpr::getGetElementPtr]. *) external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep" (** [const_trunc c ty] returns the constant truncation of integer constant [c] to the smaller integer type [ty]. - See the method [llvm::ConstantExpr::getTrunc]. **) + See the method [llvm::ConstantExpr::getTrunc]. *) external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc" (** [const_sext c ty] returns the constant sign extension of integer constant [c] to the larger integer type [ty]. - See the method [llvm::ConstantExpr::getSExt]. **) + See the method [llvm::ConstantExpr::getSExt]. *) external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt" (** [const_zext c ty] returns the constant zero extension of integer constant [c] to the larger integer type [ty]. - See the method [llvm::ConstantExpr::getZExt]. **) + See the method [llvm::ConstantExpr::getZExt]. *) external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt" (** [const_fptrunc c ty] returns the constant truncation of floating point constant [c] to the smaller floating point type [ty]. - See the method [llvm::ConstantExpr::getFPTrunc]. **) + See the method [llvm::ConstantExpr::getFPTrunc]. *) external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc" (** [const_fpext c ty] returns the constant extension of floating point constant [c] to the larger floating point type [ty]. - See the method [llvm::ConstantExpr::getFPExt]. **) + See the method [llvm::ConstantExpr::getFPExt]. *) external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt" (** [const_uitofp c ty] returns the constant floating point conversion of unsigned integer constant [c] to the floating point type [ty]. - See the method [llvm::ConstantExpr::getUIToFP]. **) + See the method [llvm::ConstantExpr::getUIToFP]. *) external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP" (** [const_sitofp c ty] returns the constant floating point conversion of signed integer constant [c] to the floating point type [ty]. - See the method [llvm::ConstantExpr::getSIToFP]. **) + See the method [llvm::ConstantExpr::getSIToFP]. *) external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP" (** [const_fptoui c ty] returns the constant unsigned integer conversion of floating point constant [c] to integer type [ty]. - See the method [llvm::ConstantExpr::getFPToUI]. **) + See the method [llvm::ConstantExpr::getFPToUI]. *) external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI" (** [const_fptoui c ty] returns the constant unsigned integer conversion of floating point constant [c] to integer type [ty]. - See the method [llvm::ConstantExpr::getFPToSI]. **) + See the method [llvm::ConstantExpr::getFPToSI]. *) external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI" (** [const_ptrtoint c ty] returns the constant integer conversion of pointer constant [c] to integer type [ty]. - See the method [llvm::ConstantExpr::getPtrToInt]. **) + See the method [llvm::ConstantExpr::getPtrToInt]. *) external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt" (** [const_inttoptr c ty] returns the constant pointer conversion of integer constant [c] to pointer type [ty]. - See the method [llvm::ConstantExpr::getIntToPtr]. **) + See the method [llvm::ConstantExpr::getIntToPtr]. *) external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr" (** [const_bitcast c ty] returns the constant bitwise conversion of constant [c] to type [ty] of equal size. - See the method [llvm::ConstantExpr::getBitCast]. **) + See the method [llvm::ConstantExpr::getBitCast]. *) external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast" (** [const_select cond t f] returns the constant conditional which returns value [t] if the boolean constant [cond] is true and the value [f] otherwise. - See the method [llvm::ConstantExpr::getSelect]. **) + See the method [llvm::ConstantExpr::getSelect]. *) external const_select : llvalue -> llvalue -> llvalue -> llvalue = "LLVMConstSelect" (** [const_extractelement vec i] returns the constant [i]th element of constant vector [vec]. [i] must be a constant [i32] value unsigned less than the size of the vector. - See the method [llvm::ConstantExpr::getExtractElement]. **) + See the method [llvm::ConstantExpr::getExtractElement]. *) external const_extractelement : llvalue -> llvalue -> llvalue = "LLVMConstExtractElement" @@ -644,305 +658,315 @@ external const_extractelement : llvalue -> llvalue -> llvalue constant [v]. [v] must be a constant value with the type of the vector elements. [i] must be a constant [i32] value unsigned less than the size of the vector. - See the method [llvm::ConstantExpr::getInsertElement]. **) + See the method [llvm::ConstantExpr::getInsertElement]. *) external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue = "LLVMConstInsertElement" (** [const_shufflevector a b mask] returns a constant [shufflevector]. See the LLVM Language Reference for details on the [sufflevector] instruction. - See the method [llvm::ConstantExpr::getShuffleVector]. **) + See the method [llvm::ConstantExpr::getShuffleVector]. *) external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue = "LLVMConstShuffleVector" -(*--... Operations on global variables, functions, and aliases (globals) ...--*) + +(** {7 Operations on global variables, functions, and aliases (globals)} *) (** [is_declaration g] returns [true] if the global value [g] is a declaration only. Returns [false] otherwise. - See the method [llvm::GlobalValue::isDeclaration]. **) + See the method [llvm::GlobalValue::isDeclaration]. *) external is_declaration : llvalue -> bool = "llvm_is_declaration" (** [linkage g] returns the linkage of the global value [g]. - See the method [llvm::GlobalValue::getLinkage]. **) + See the method [llvm::GlobalValue::getLinkage]. *) external linkage : llvalue -> Linkage.t = "llvm_linkage" (** [set_linkage l g] sets the linkage of the global value [g] to [l]. - See the method [llvm::GlobalValue::setLinkage]. **) + See the method [llvm::GlobalValue::setLinkage]. *) external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage" (** [section g] returns the linker section of the global value [g]. - See the method [llvm::GlobalValue::getSection]. **) + See the method [llvm::GlobalValue::getSection]. *) external section : llvalue -> string = "llvm_section" (** [set_section s g] sets the linker section of the global value [g] to [s]. - See the method [llvm::GlobalValue::setSection]. **) + See the method [llvm::GlobalValue::setSection]. *) external set_section : string -> llvalue -> unit = "llvm_set_section" (** [visibility g] returns the linker visibility of the global value [g]. - See the method [llvm::GlobalValue::getVisibility]. **) + See the method [llvm::GlobalValue::getVisibility]. *) external visibility : llvalue -> Visibility.t = "llvm_visibility" (** [set_visibility v g] sets the linker visibility of the global value [g] to - [v]. See the method [llvm::GlobalValue::setVisibility]. **) + [v]. See the method [llvm::GlobalValue::setVisibility]. *) external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility" (** [alignment g] returns the required alignment of the global value [g]. - See the method [llvm::GlobalValue::getAlignment]. **) + See the method [llvm::GlobalValue::getAlignment]. *) external alignment : llvalue -> int = "llvm_alignment" (** [set_alignment n g] sets the required alignment of the global value [g] to - [n] bytes. See the method [llvm::GlobalValue::setAlignment]. **) + [n] bytes. See the method [llvm::GlobalValue::setAlignment]. *) external set_alignment : int -> llvalue -> unit = "llvm_set_alignment" -(*--... Operations on global variables .....................................--*) + +(** {7 Operations on global variables} *) (** [declare_global ty name m] returns a new global variable of type [ty] and with name [name] in module [m]. If such a global variable already exists, it is returned. If the type of the existing global differs, then a bitcast - to [ty] is returned. **) + to [ty] is returned. *) external declare_global : lltype -> string -> llmodule -> llvalue = "llvm_declare_global" (** [define_global name init m] returns a new global with name [name] and initializer [init] in module [m]. If the named global already exists, it is renamed. - See the constructor of [llvm::GlobalVariable]. **) + See the constructor of [llvm::GlobalVariable]. *) external define_global : string -> llvalue -> llmodule -> llvalue = "llvm_define_global" (** [lookup_global name m] returns [Some g] if a global variable with name [name] exists in module [m]. If no such global exists, returns [None]. - See the [llvm::GlobalVariable] constructor. **) + See the [llvm::GlobalVariable] constructor. *) external lookup_global : string -> llmodule -> llvalue option = "llvm_lookup_global" (** [delete_global gv] destroys the global variable [gv]. - See the method [llvm::GlobalVariable::eraseFromParent]. **) + See the method [llvm::GlobalVariable::eraseFromParent]. *) external delete_global : llvalue -> unit = "llvm_delete_global" (** [is_global_constant gv] returns [true] if the global variabile [gv] is a constant. Returns [false] otherwise. - See the method [llvm::GlobalVariable::isConstant]. **) + See the method [llvm::GlobalVariable::isConstant]. *) external is_global_constant : llvalue -> bool = "llvm_is_global_constant" (** [set_global_constant c gv] sets the global variable [gv] to be a constant if [c] is [true] and not if [c] is [false]. - See the method [llvm::GlobalVariable::setConstant]. **) + See the method [llvm::GlobalVariable::setConstant]. *) external set_global_constant : bool -> llvalue -> unit = "llvm_set_global_constant" (** [has_initializer gv] returns [true] if the global variable [gv] has an initializer and [false] otherwise. - See the method [llvm::GlobalVariable::hasInitializer]. **) + See the method [llvm::GlobalVariable::hasInitializer]. *) external has_initializer : llvalue -> bool = "llvm_has_initializer" (** [global_initializer gv] returns the initializer for the global variable - [gv]. See the method [llvm::GlobalVariable::getInitializer]. **) + [gv]. See the method [llvm::GlobalVariable::getInitializer]. *) external global_initializer : llvalue -> llvalue = "LLVMGetInitializer" (** [set_initializer c gv] sets the initializer for the global variable [gv] to the constant [c]. - See the method [llvm::GlobalVariable::setInitializer]. **) + See the method [llvm::GlobalVariable::setInitializer]. *) external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer" (** [remove_initializer gv] unsets the initializer for the global variable [gv]. - See the method [llvm::GlobalVariable::setInitializer]. **) + See the method [llvm::GlobalVariable::setInitializer]. *) external remove_initializer : llvalue -> unit = "llvm_remove_initializer" (** [is_thread_local gv] returns [true] if the global variable [gv] is thread-local and [false] otherwise. - See the method [llvm::GlobalVariable::isThreadLocal]. **) + See the method [llvm::GlobalVariable::isThreadLocal]. *) external is_thread_local : llvalue -> bool = "llvm_is_thread_local" (** [set_thread_local c gv] sets the global variable [gv] to be thread local if [c] is [true] and not otherwise. - See the method [llvm::GlobalVariable::setThreadLocal]. **) + See the method [llvm::GlobalVariable::setThreadLocal]. *) external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local" -(*--... Operations on functions ............................................--*) + +(** {7 Operations on functions} *) (** [declare_function name ty m] returns a new function of type [ty] and with name [name] in module [m]. If such a function already exists, it is returned. If the type of the existing function differs, then a bitcast - to [ty] is returned. **) + to [ty] is returned. *) external declare_function : string -> lltype -> llmodule -> llvalue = "llvm_declare_function" (** [define_function name ty m] creates a new function with name [name] and type [ty] in module [m]. If the named function already exists, it is renamed. An entry basic block is created in the function. - See the constructor of [llvm::GlobalVariable]. **) + See the constructor of [llvm::GlobalVariable]. *) external define_function : string -> lltype -> llmodule -> llvalue = "llvm_define_function" (** [lookup_function name m] returns [Some f] if a function with name [name] exists in module [m]. If no such function exists, returns [None]. - See the method [llvm::Module] constructor. **) + See the method [llvm::Module] constructor. *) external lookup_function : string -> llmodule -> llvalue option = "llvm_lookup_function" (** [delete_function f] destroys the function [f]. - See the method [llvm::Function::eraseFromParent]. **) + See the method [llvm::Function::eraseFromParent]. *) external delete_function : llvalue -> unit = "llvm_delete_function" (** [params f] returns the parameters of function [f]. - See the method [llvm::Function::getArgumentList]. **) + See the method [llvm::Function::getArgumentList]. *) external params : llvalue -> llvalue array = "llvm_params" (** [param f n] returns the [n]th parameter of function [f]. - See the method [llvm::Function::getArgumentList]. **) + See the method [llvm::Function::getArgumentList]. *) external param : llvalue -> int -> llvalue = "llvm_param" (** [is_intrinsic f] returns true if the function [f] is an intrinsic. - See the method [llvm::Function::isIntrinsic]. **) + See the method [llvm::Function::isIntrinsic]. *) external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic" (** [function_call_conv f] returns the calling convention of the function [f]. - See the method [llvm::Function::getCallingConv]. **) + See the method [llvm::Function::getCallingConv]. *) external function_call_conv : llvalue -> int = "llvm_function_call_conv" (** [set_function_call_conv cc f] sets the calling convention of the function [f] to the calling convention numbered [cc]. - See the method [llvm::Function::setCallingConv]. **) + See the method [llvm::Function::setCallingConv]. *) external set_function_call_conv : int -> llvalue -> unit = "llvm_set_function_call_conv" (** [collector f] returns [Some name] if the function [f] has a garbage collection algorithm specified and [None] otherwise. - See the method [llvm::Function::getCollector]. **) + See the method [llvm::Function::getCollector]. *) external collector : llvalue -> string option = "llvm_collector" (** [set_collector gc f] sets the collection algorithm for the function [f] to - [gc]. See the method [llvm::Function::setCollector]. **) + [gc]. See the method [llvm::Function::setCollector]. *) external set_collector : string option -> llvalue -> unit = "llvm_set_collector" -(*--... Operations on basic blocks .........................................--*) + +(** {7 Operations on basic blocks} *) (** [basic_blocks fn] returns the basic blocks of the function [f]. - See the method [llvm::Function::getBasicBlockList]. **) + See the method [llvm::Function::getBasicBlockList]. *) external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks" (** [entry_block fn] returns the entry basic block of the function [f]. - See the method [llvm::Function::getEntryBlock]. **) + See the method [llvm::Function::getEntryBlock]. *) external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock" (** [delete_block bb] deletes the basic block [bb]. - See the method [llvm::BasicBlock::eraseFromParent]. **) + See the method [llvm::BasicBlock::eraseFromParent]. *) external delete_block : llbasicblock -> unit = "llvm_delete_block" (** [append_block name f] creates a new basic block named [name] at the end of function [f]. - See the constructor of [llvm::BasicBlock]. **) + See the constructor of [llvm::BasicBlock]. *) external append_block : string -> llvalue -> llbasicblock = "llvm_append_block" (** [insert_block name bb] creates a new basic block named [name] before the basic block [bb]. - See the constructor of [llvm::BasicBlock]. **) + See the constructor of [llvm::BasicBlock]. *) external insert_block : string -> llbasicblock -> llbasicblock = "llvm_insert_block" -(** [value_of_block bb] losslessly casts [bb] to an [llvalue]. **) +(** [value_of_block bb] losslessly casts [bb] to an [llvalue]. *) external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue" (** [value_is_block v] returns [true] if the value [v] is a basic block and [false] otherwise. - Similar to [llvm::isa<BasicBlock>]. **) + Similar to [llvm::isa<BasicBlock>]. *) external value_is_block : llvalue -> bool = "llvm_value_is_block" -(** [block_of_value v] losslessly casts [v] to an [llbasicblock]. **) +(** [block_of_value v] losslessly casts [v] to an [llbasicblock]. *) external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock" -(*--... Operations on call sites ...........................................--*) -(** [inst_call_conv ci] is the calling convention for the call or invoke - instruction [ci], which may be one of the values from the module [CallConv]. - See the method [CallSite:: **) +(** {7 Operations on call sites} *) + +(** [instruction_call_conv ci] is the calling convention for the call or invoke + instruction [ci], which may be one of the values from the module + {!CallConv}. See the method [llvm::CallInst::getCallingConv] and + [llvm::InvokeInst::getCallingConv]. *) external instruction_call_conv: llvalue -> int = "llvm_instruction_call_conv" (** [set_inst_call_conv cc ci] sets the calling convention for the call or invoke instruction [ci] to the integer [cc], which can be one of the values - from the module [CallConv]. See the method [CallSite::]. **) + from the module {!CallConv}. See the method [llvm::CallInst::setCallingConv] + and [llvm::InvokeInst::setCallingConv]. *) external set_instruction_call_conv: int -> llvalue -> unit = "llvm_set_instruction_call_conv" -(*--... Operations on phi nodes ............................................--*) + +(** {7 Operations on phi nodes} *) (** [add_incoming (v, bb) pn] adds the value [v] to the phi node [pn] for use - with branches from [bb]. See the method [llvm::PHINode::addIncoming]. **) + with branches from [bb]. See the method [llvm::PHINode::addIncoming]. *) external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit = "llvm_add_incoming" (** [incoming pn] returns the list of value-block pairs for phi node [pn]. - See the method [llvm::PHINode::getIncomingValue]. **) + See the method [llvm::PHINode::getIncomingValue]. *) external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming" -(*===-- Instruction builders ----------------------------------------------===*) + +(** {6 Instruction builders} *) (** [builder] creates an instruction builder with no position. It is invalid to - use this builder until its position is set with [position_before] or - [position_at_end]. See the constructor for [llvm::LLVMBuilder]. **) + use this builder until its position is set with {!position_before} or + {!position_at_end}. See the constructor for [llvm::LLVMBuilder]. *) external builder: unit-> llbuilder = "llvm_builder" (** [builder_before ins] creates an instruction builder positioned before the - instruction [isn]. See the constructor for [llvm::LLVMBuilder]. **) + instruction [isn]. See the constructor for [llvm::LLVMBuilder]. *) external builder_before : llvalue -> llbuilder = "llvm_builder_before" (** [builder_at_end bb] creates an instruction builder positioned at the end of - the basic block [bb]. See the constructor for [llvm::LLVMBuilder]. **) + the basic block [bb]. See the constructor for [llvm::LLVMBuilder]. *) external builder_at_end : llbasicblock -> llbuilder = "llvm_builder_at_end" (** [position_before ins b] moves the instruction builder [b] to before the - instruction [isn]. See the method [llvm::LLVMBuilder::SetInsertPoint]. **) + instruction [isn]. See the method [llvm::LLVMBuilder::SetInsertPoint]. *) external position_before : llvalue -> llbuilder -> unit = "llvm_position_before" (** [position_at_end bb b] moves the instruction builder [b] to the end of the - basic block [bb]. See the method [llvm::LLVMBuilder::SetInsertPoint]. **) + basic block [bb]. See the method [llvm::LLVMBuilder::SetInsertPoint]. *) external position_at_end : llbasicblock -> llbuilder -> unit = "llvm_position_at_end" -(*--... Terminators ........................................................--*) + +(** {7 Terminators} *) (** [build_ret_void b] creates a [ret void] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateRetVoid]. **) + See the method [llvm::LLVMBuilder::CreateRetVoid]. *) external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void" (** [build_ret v b] creates a [ret %v] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateRet]. **) + See the method [llvm::LLVMBuilder::CreateRet]. *) external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret" (** [build_br bb b] creates a [b %bb] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateBr]. **) + See the method [llvm::LLVMBuilder::CreateBr]. *) external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br" (** [build_cond_br cond tbb fbb b] creates a [b %cond, %tbb, %fbb] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateCondBr]. **) + See the method [llvm::LLVMBuilder::CreateCondBr]. *) external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder -> llvalue = "llvm_build_cond_br" (** [build_switch case elsebb b] creates an empty [switch %case, %elsebb] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateSwitch]. **) + See the method [llvm::LLVMBuilder::CreateSwitch]. *) external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue = "llvm_build_switch" (** [build_invoke fn args tobb unwindbb name b] creates an [%name = invoke %fn(args) to %tobb unwind %unwindbb] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateInvoke]. **) + See the method [llvm::LLVMBuilder::CreateInvoke]. *) external build_invoke : llvalue -> llvalue array -> llbasicblock -> llbasicblock -> string -> llbuilder -> llvalue = "llvm_build_invoke_bc" "llvm_build_invoke_nat" @@ -950,119 +974,120 @@ external build_invoke : llvalue -> llvalue array -> llbasicblock -> (** [build_unwind b] creates an [unwind] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateUnwind]. **) + See the method [llvm::LLVMBuilder::CreateUnwind]. *) external build_unwind : llbuilder -> llvalue = "llvm_build_unwind" (** [build_unreachable b] creates an [unreachable] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateUnwind]. **) + See the method [llvm::LLVMBuilder::CreateUnwind]. *) external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable" -(*--... Arithmetic .........................................................--*) + +(** {7 Arithmetic} *) (** [build_add x y name b] creates a [%name = add %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateAdd]. **) + See the method [llvm::LLVMBuilder::CreateAdd]. *) external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_add" (** [build_sub x y name b] creates a [%name = sub %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateSub]. **) + See the method [llvm::LLVMBuilder::CreateSub]. *) external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_sub" (** [build_mul x y name b] creates a [%name = mul %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateMul]. **) + See the method [llvm::LLVMBuilder::CreateMul]. *) external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_mul" (** [build_udiv x y name b] creates a [%name = udiv %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateUDiv]. **) + See the method [llvm::LLVMBuilder::CreateUDiv]. *) external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_udiv" (** [build_sdiv x y name b] creates a [%name = sdiv %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateSDiv]. **) + See the method [llvm::LLVMBuilder::CreateSDiv]. *) external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_sdiv" (** [build_fdiv x y name b] creates a [%name = fdiv %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateFDiv]. **) + See the method [llvm::LLVMBuilder::CreateFDiv]. *) external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_fdiv" (** [build_urem x y name b] creates a [%name = urem %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateURem]. **) + See the method [llvm::LLVMBuilder::CreateURem]. *) external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_urem" (** [build_SRem x y name b] creates a [%name = srem %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateSRem]. **) + See the method [llvm::LLVMBuilder::CreateSRem]. *) external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_srem" (** [build_frem x y name b] creates a [%name = frem %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateFRem]. **) + See the method [llvm::LLVMBuilder::CreateFRem]. *) external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_frem" (** [build_shl x y name b] creates a [%name = shl %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateShl]. **) + See the method [llvm::LLVMBuilder::CreateShl]. *) external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_shl" (** [build_lshr x y name b] creates a [%name = lshr %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateLShr]. **) + See the method [llvm::LLVMBuilder::CreateLShr]. *) external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_lshr" (** [build_ashr x y name b] creates a [%name = ashr %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateAShr]. **) + See the method [llvm::LLVMBuilder::CreateAShr]. *) external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_ashr" (** [build_and x y name b] creates a [%name = and %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateAnd]. **) + See the method [llvm::LLVMBuilder::CreateAnd]. *) external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_and" (** [build_or x y name b] creates a [%name = or %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateOr]. **) + See the method [llvm::LLVMBuilder::CreateOr]. *) external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_or" (** [build_xor x y name b] creates a [%name = xor %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateXor]. **) + See the method [llvm::LLVMBuilder::CreateXor]. *) external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_xor" @@ -1070,7 +1095,7 @@ external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue [%name = sub 0, %x] instruction at the position specified by the instruction builder [b]. [-0.0] is used for floating point types to compute the correct sign. - See the method [llvm::LLVMBuilder::CreateNeg]. **) + See the method [llvm::LLVMBuilder::CreateNeg]. *) external build_neg : llvalue -> string -> llbuilder -> llvalue = "llvm_build_neg" @@ -1078,248 +1103,253 @@ external build_neg : llvalue -> string -> llbuilder -> llvalue [%name = xor %x, -1] instruction at the position specified by the instruction builder [b]. [-1] is the correct "all ones" value for the type of [x]. - See the method [llvm::LLVMBuilder::CreateXor]. **) + See the method [llvm::LLVMBuilder::CreateXor]. *) external build_not : llvalue -> string -> llbuilder -> llvalue = "llvm_build_not" -(*--... Memory .............................................................--*) + +(** {7 Memory} *) (** [build_malloc ty name b] creates a [%name = malloc %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateAlloca]. **) + See the method [llvm::LLVMBuilder::CreateAlloca]. *) external build_malloc : lltype -> string -> llbuilder -> llvalue = "llvm_build_malloc" (** [build_array_malloc ty n name b] creates a [%name = malloc %ty, %n] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateMalloc]. **) + See the method [llvm::LLVMBuilder::CreateMalloc]. *) external build_array_malloc : lltype -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_array_malloc" (** [build_alloca ty name b] creates a [%name = alloca %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateAlloca]. **) + See the method [llvm::LLVMBuilder::CreateAlloca]. *) external build_alloca : lltype -> string -> llbuilder -> llvalue = "llvm_build_alloca" (** [build_array_alloca ty n name b] creates a [%name = alloca %ty, %n] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateAlloca]. **) + See the method [llvm::LLVMBuilder::CreateAlloca]. *) external build_array_alloca : lltype -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_array_alloca" (** [build_free v b] creates a [free %v] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateFree]. **) + See the method [llvm::LLVMBuilder::CreateFree]. *) external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free" (** [build_load v name b] creates a [%name = load %v] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateLoad]. **) + See the method [llvm::LLVMBuilder::CreateLoad]. *) external build_load : llvalue -> string -> llbuilder -> llvalue = "llvm_build_load" (** [build_store v p b] creates a [store %v, %p] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateStore]. **) + See the method [llvm::LLVMBuilder::CreateStore]. *) external build_store : llvalue -> llvalue -> llbuilder -> llvalue = "llvm_build_store" (** [build_gep p indices name b] creates a [%name = gep %p, indices...] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateGetElementPtr]. **) + See the method [llvm::LLVMBuilder::CreateGetElementPtr]. *) external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue = "llvm_build_gep" -(*--... Casts ..............................................................--*) + +(** {7 Casts} *) (** [build_trunc v ty name b] creates a [%name = trunc %p to %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateTrunc]. **) + See the method [llvm::LLVMBuilder::CreateTrunc]. *) external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_trunc" (** [build_zext v ty name b] creates a [%name = zext %p to %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateZExt]. **) + See the method [llvm::LLVMBuilder::CreateZExt]. *) external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_zext" (** [build_sext v ty name b] creates a [%name = sext %p to %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateSExt]. **) + See the method [llvm::LLVMBuilder::CreateSExt]. *) external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_sext" (** [build_fptoui v ty name b] creates a [%name = fptoui %p to %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateFPToUI]. **) + See the method [llvm::LLVMBuilder::CreateFPToUI]. *) external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_fptoui" (** [build_fptosi v ty name b] creates a [%name = fptosi %p to %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateFPToSI]. **) + See the method [llvm::LLVMBuilder::CreateFPToSI]. *) external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_fptosi" (** [build_uitofp v ty name b] creates a [%name = uitofp %p to %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateUIToFP]. **) + See the method [llvm::LLVMBuilder::CreateUIToFP]. *) external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_uitofp" (** [build_sitofp v ty name b] creates a [%name = sitofp %p to %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateSIToFP]. **) + See the method [llvm::LLVMBuilder::CreateSIToFP]. *) external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_sitofp" (** [build_fptrunc v ty name b] creates a [%name = fptrunc %p to %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateFPTrunc]. **) + See the method [llvm::LLVMBuilder::CreateFPTrunc]. *) external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_fptrunc" (** [build_fpext v ty name b] creates a [%name = fpext %p to %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateFPExt]. **) + See the method [llvm::LLVMBuilder::CreateFPExt]. *) external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_fpext" (** [build_ptrtoint v ty name b] creates a [%name = prtotint %p to %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreatePtrToInt]. **) + See the method [llvm::LLVMBuilder::CreatePtrToInt]. *) external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_prttoint" (** [build_inttoptr v ty name b] creates a [%name = inttoptr %p to %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateIntToPtr]. **) + See the method [llvm::LLVMBuilder::CreateIntToPtr]. *) external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_inttoptr" (** [build_bitcast v ty name b] creates a [%name = bitcast %p to %ty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateBitcast]. **) + See the method [llvm::LLVMBuilder::CreateBitcast]. *) external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_bitcast" -(*--... Comparisons ........................................................--*) + +(** {7 Comparisons} *) (** [build_icmp pred x y name b] creates a [%name = icmp %pred %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateICmp]. **) + See the method [llvm::LLVMBuilder::CreateICmp]. *) external build_icmp : Icmp.t -> llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_icmp" (** [build_fcmp pred x y name b] creates a [%name = fcmp %pred %x, %y] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateFCmp]. **) + See the method [llvm::LLVMBuilder::CreateFCmp]. *) external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_fcmp" -(*--... Miscellaneous instructions .........................................--*) + +(** {7 Miscellaneous instructions} *) (** [build_phi incoming name b] creates a [%name = phi %incoming] instruction at the position specified by the instruction builder [b]. - [incoming] is a list of [(llvalue, llbasicblock)] tuples. - See the method [llvm::LLVMBuilder::CreatePHI]. **) + [incoming] is a list of [({!llvalue}, {!llbasicblock})] tuples. + See the method [llvm::LLVMBuilder::CreatePHI]. *) external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder -> llvalue = "llvm_build_phi" (** [build_call fn args name b] creates a [%name = call %fn(args...)] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateCall]. **) + See the method [llvm::LLVMBuilder::CreateCall]. *) external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue = "llvm_build_call" (** [build_select cond thenv elsev name b] creates a [%name = select %cond, %thenv, %elsev] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateSelect]. **) + See the method [llvm::LLVMBuilder::CreateSelect]. *) external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_select" (** [build_va_arg valist argty name b] creates a [%name = va_arg %valist, %argty] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateVAArg]. **) + See the method [llvm::LLVMBuilder::CreateVAArg]. *) external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue = "llvm_build_va_arg" (** [build_extractelement vec i name b] creates a [%name = extractelement %vec, %i] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateExtractElement]. **) + See the method [llvm::LLVMBuilder::CreateExtractElement]. *) external build_extractelement : llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_extractelement" (** [build_insertelement vec elt i name b] creates a [%name = insertelement %vec, %elt, %i] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateInsertElement]. **) + See the method [llvm::LLVMBuilder::CreateInsertElement]. *) external build_insertelement : llvalue -> llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_insertelement" (** [build_shufflevector veca vecb mask name b] creates a [%name = shufflevector %veca, %vecb, %mask] instruction at the position specified by the instruction builder [b]. - See the method [llvm::LLVMBuilder::CreateShuffleVector]. **) + See the method [llvm::LLVMBuilder::CreateShuffleVector]. *) external build_shufflevector : llvalue -> llvalue -> llvalue -> string -> llbuilder -> llvalue = "llvm_build_shufflevector" -(*===-- Module providers --------------------------------------------------===*) +(** {6 Module providers} *) module ModuleProvider : sig (** [create_module_provider m] encapsulates [m] in a module provider and takes - ownership of the module. See the constructor - [llvm::ExistingModuleProvider::ExistingModuleProvider]. **) + ownership of the module. See the constructor + [llvm::ExistingModuleProvider::ExistingModuleProvider]. *) external create : llmodule -> llmoduleprovider = "LLVMCreateModuleProviderForExistingModule" - + (** [dispose_module_provider mp] destroys the module provider [mp] as well as - the contained module. **) + the contained module. *) external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider" end - -(*===-- Memory buffers ----------------------------------------------------===*) + +(** {6 Memory buffers} *) module MemoryBuffer : sig - (** [of_file p] is the memory buffer containing the contents of the file at - path [p]. If the file could not be read, then [IoError msg] is raised. **) + (** [of_file p] is the memory buffer containing the contents of the file at + path [p]. If the file could not be read, then [IoError msg] is + raised. *) external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file" (** [stdin ()] is the memory buffer containing the contents of standard input. - If standard input is empty, then [IoError msg] is raised. **) + If standard input is empty, then [IoError msg] is raised. *) external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin" - (** Disposes of a memory buffer. **) + (** Disposes of a memory buffer. *) external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose" end |