X-Git-Url: http://plrg.eecs.uci.edu/git/?p=oota-llvm.git;a=blobdiff_plain;f=bindings%2Focaml%2Fllvm%2Fllvm.mli;h=541c35a2a229d24f0a34ff6497f77a0cc95a5612;hp=f5538f4897e92858a3abdb7a05e7b72f6a7f3590;hb=7d30a2ed8bbfb77386e3198a74f0288aec52e874;hpb=6b228e506f42972c003599f4873a24910f8a530a diff --git a/bindings/ocaml/llvm/llvm.mli b/bindings/ocaml/llvm/llvm.mli index f5538f4897e..541c35a2a22 100644 --- a/bindings/ocaml/llvm/llvm.mli +++ b/bindings/ocaml/llvm/llvm.mli @@ -1,4 +1,4 @@ -(*===-- llvm/llvm.mli - LLVM Ocaml Interface -------------------------------===* +(*===-- llvm/llvm.mli - LLVM OCaml Interface ------------------------------===* * * The LLVM Compiler Infrastructure * @@ -9,7 +9,7 @@ (** Core API. - This interface provides an ocaml API for the LLVM intermediate + This interface provides an OCaml API for the LLVM intermediate representation, the classes in the VMCore library. *) @@ -48,11 +48,15 @@ type llbuilder See the [llvm::MemoryBuffer] class. *) type llmemorybuffer +(** The kind id of metadata attached to an instruction. *) +type llmdkind + (** The kind of an [lltype], the result of [classify_type ty]. See the [llvm::Type::TypeID] enumeration. *) module TypeKind : sig type t = Void + | Half | Float | Double | X86fp80 @@ -66,6 +70,7 @@ module TypeKind : sig | Pointer | Vector | Metadata + | X86_mmx end (** The linkage of a global value, accessed with {!linkage} and @@ -76,6 +81,7 @@ module Linkage : sig | Available_externally | Link_once | Link_once_odr + | Link_once_odr_auto_hide | Weak | Weak_odr | Appending @@ -87,6 +93,7 @@ module Linkage : sig | Ghost | Common | Linker_private + | Linker_private_weak end (** The linker visibility of a global value, accessed with {!visibility} and @@ -98,6 +105,15 @@ module Visibility : sig | Protected end +(** The DLL storage class of a global value, accessed with {!dll_storage_class} and + {!set_dll_storage_class}. See [llvm::GlobalValue::DLLStorageClassTypes]. *) +module DLLStorageClass : sig + type t = + | Default + | DLLImport + | DLLExport +end + (** The following calling convention values may be accessed with {!function_call_conv} and {!set_function_call_conv}. Calling conventions are open-ended. *) @@ -114,6 +130,8 @@ module CallConv : sig convention from C. *) end +(** The attribute kind of a function parameter, result or the function itself. + See [llvm::Attribute::AttrKind]. *) module Attribute : sig type t = | Zext @@ -139,60 +157,65 @@ module Attribute : sig | Naked | Inlinehint | Stackalignment of int + | ReturnsTwice + | UWTable + | NonLazyBind end (** The predicate for an integer comparison ([icmp]) instruction. See the [llvm::ICmpInst::Predicate] enumeration. *) module Icmp : sig type t = - | Eq - | Ne - | Ugt - | Uge - | Ult - | Ule - | Sgt - | Sge - | Slt - | Sle + | Eq (** Equal *) + | Ne (** Not equal *) + | Ugt (** Unsigned greater than *) + | Uge (** Unsigned greater or equal *) + | Ult (** Unsigned less than *) + | Ule (** Unsigned less or equal *) + | Sgt (** Signed greater than *) + | Sge (** Signed greater or equal *) + | Slt (** Signed less than *) + | Sle (** Signed less or equal *) end (** The predicate for a floating-point comparison ([fcmp]) instruction. + Ordered means that neither operand is a QNAN while unordered means + that either operand may be a QNAN. See the [llvm::FCmpInst::Predicate] enumeration. *) module Fcmp : sig type t = - | False - | Oeq - | Ogt - | Oge - | Olt - | Ole - | One - | Ord - | Uno - | Ueq - | Ugt - | Uge - | Ult - | Ule - | Une - | True + | False (** Always false *) + | Oeq (** Ordered and equal *) + | Ogt (** Ordered and greater than *) + | Oge (** Ordered and greater or equal *) + | Olt (** Ordered and less than *) + | Ole (** Ordered and less or equal *) + | One (** Ordered and not equal *) + | Ord (** Ordered (no operand is NaN) *) + | Uno (** Unordered (one operand at least is NaN) *) + | Ueq (** Unordered and equal *) + | Ugt (** Unordered and greater than *) + | Uge (** Unordered and greater or equal *) + | Ult (** Unordered and less than *) + | Ule (** Unordered and less or equal *) + | Une (** Unordered and not equal *) + | True (** Always true *) end (** The opcodes for LLVM instructions and constant expressions. *) module Opcode : sig type t = - | Invalid (* not an instruction *) - (* Terminator Instructions *) - | Ret + | Invalid (** Not an instruction *) + + | Ret (** Terminator Instructions *) | Br | Switch | IndirectBr | Invoke | Invalid2 | Unreachable - (* Standard Binary Operators *) - | Add + + | Add (** Standard Binary Operators *) | FAdd | Sub | FSub @@ -204,20 +227,20 @@ module Opcode : sig | URem | SRem | FRem - (* Logical Operators *) - | Shl + + | Shl (** Logical Operators *) | LShr | AShr | And | Or | Xor - (* Memory Operators *) - | Alloca + + | Alloca (** Memory Operators *) | Load | Store | GetElementPtr - (* Cast Operators *) - | Trunc + + | Trunc (** Cast Operators *) | ZExt | SExt | FPToUI @@ -229,8 +252,8 @@ module Opcode : sig | PtrToInt | IntToPtr | BitCast - (* Other Operators *) - | ICmp + + | ICmp (** Other Operators *) | FCmp | PHI | Call @@ -248,11 +271,61 @@ module Opcode : sig | AtomicRMW | Resume | LandingPad - | Unwind +end + +(** The type of a clause of a [landingpad] instruction. + See [llvm::LandingPadInst::ClauseType]. *) +module LandingPadClauseTy : sig + type t = + | Catch + | Filter +end + +(** The thread local mode of a global value, accessed with {!thread_local_mode} + and {!set_thread_local_mode}. + See [llvm::GlobalVariable::ThreadLocalMode]. *) +module ThreadLocalMode : sig + type t = + | None + | GeneralDynamic + | LocalDynamic + | InitialExec + | LocalExec +end + +(** The ordering of an atomic [load], [store], [cmpxchg], [atomicrmw] or + [fence] instruction. See [llvm::AtomicOrdering]. *) +module AtomicOrdering : sig + type t = + | NotAtomic + | Unordered + | Monotonic + | Invalid (** removed due to API changes *) + | Acquire + | Release + | AcqiureRelease + | SequentiallyConsistent +end + +(** The opcode of an [atomicrmw] instruction. + See [llvm::AtomicRMWInst::BinOp]. *) +module AtomicRMWBinOp : sig + type t = + | Xchg + | Add + | Sub + | And + | Nand + | Or + | Xor + | Max + | Min + | UMax + | UMin end (** The kind of an [llvalue], the result of [classify_value v]. - * See the various [LLVMIsA*] functions. *) + See the various [LLVMIsA*] functions. *) module ValueKind : sig type t = | NullValue @@ -264,6 +337,8 @@ module ValueKind : sig | BlockAddress | ConstantAggregateZero | ConstantArray + | ConstantDataArray + | ConstantDataVector | ConstantExpr | ConstantFP | ConstantInt @@ -277,6 +352,7 @@ module ValueKind : sig | Instruction of Opcode.t end + (** {6 Iteration} *) (** [Before b] and [At_end a] specify positions from the start of the ['b] list @@ -299,6 +375,29 @@ type ('a, 'b) llrev_pos = exception IoError of string +(** {6 Global configuration} *) + +(** [enable_pretty_stacktraces ()] enables LLVM's built-in stack trace code. + This intercepts the OS's crash signals and prints which component of LLVM + you were in at the time of the crash. *) +val enable_pretty_stacktrace : unit -> unit + +(** [install_fatal_error_handler f] installs [f] as LLVM's fatal error handler. + The handler will receive the reason for termination as a string. After + the handler has been executed, LLVM calls [exit(1)]. *) +val install_fatal_error_handler : (string -> unit) -> unit + +(** [reset_fatal_error_handler ()] resets LLVM's fatal error handler. *) +val reset_fatal_error_handler : unit -> unit + +(** [parse_command_line_options ?overview args] parses [args] using + the LLVM command line parser. Note that the only stable thing about this + function is its signature; you cannot rely on any particular set of command + line arguments being interpreted the same way across LLVM versions. + + See the function [llvm::cl::ParseCommandLineOptions()]. *) +val parse_command_line_options : ?overview:string -> string array -> unit + (** {6 Contexts} *) (** [create_context ()] creates a context for storing the "global" state in @@ -315,7 +414,7 @@ val global_context : unit -> llcontext (** [mdkind_id context name] returns the MDKind ID that corresponds to the name [name] in the context [context]. See the function [llvm::LLVMContext::getMDKindID]. *) -val mdkind_id : llcontext -> string -> int +val mdkind_id : llcontext -> string -> llmdkind (** {6 Modules} *) @@ -336,18 +435,15 @@ val dispose_module : llmodule -> unit [i686-apple-darwin8]. See the method [llvm::Module::getTargetTriple]. *) val target_triple: llmodule -> string - (** [target_triple triple m] changes the target specifier for the module [m] to the string [triple]. See the method [llvm::Module::setTargetTriple]. *) val set_target_triple: string -> llmodule -> unit - (** [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]. *) val data_layout: llmodule -> string - (** [set_data_layout s m] changes the data layout specifier for the module [m] to the string [s]. See the method [llvm::Module::setDataLayout]. *) val set_data_layout: string -> llmodule -> unit @@ -356,10 +452,21 @@ val set_data_layout: string -> llmodule -> unit error. See the method [llvm::Module::dump]. *) val dump_module : llmodule -> unit +(** [print_module f m] prints the .ll representation of the module [m] + to file [f]. See the method [llvm::Module::print]. *) +val print_module : string -> llmodule -> unit + +(** [string_of_llmodule m] returns the .ll representation of the module [m] + as a string. See the method [llvm::Module::print]. *) +val string_of_llmodule : llmodule -> string + (** [set_module_inline_asm m asm] sets the inline assembler for the module. See the method [llvm::Module::setModuleInlineAsm]. *) val set_module_inline_asm : llmodule -> string -> unit +(** [module_context m] returns the context of the specified module. + See the method [llvm::Module::getContext] *) +val module_context : llmodule -> llcontext (** {6 Types} *) @@ -369,17 +476,22 @@ val set_module_inline_asm : llmodule -> string -> unit val classify_type : lltype -> TypeKind.t (** [type_is_sized ty] returns whether the type has a size or not. - * If it doesn't then it is not safe to call the [TargetData::] methods on it. - * *) + If it doesn't then it is not safe to call the [DataLayout::] methods on it. + *) val type_is_sized : lltype -> bool (** [type_context ty] returns the {!llcontext} corresponding to the type [ty]. See the method [llvm::Type::getContext]. *) val type_context : lltype -> llcontext +(** [dump_type ty] prints the .ll representation of the type [ty] to standard + error. See the method [llvm::Type::dump]. *) +val dump_type : lltype -> unit + (** [string_of_lltype ty] returns a string describing the type [ty]. *) val string_of_lltype : lltype -> string + (** {7 Operations on integer types} *) (** [i1_type c] returns an integer type of bitwidth 1 in the context [c]. See @@ -447,7 +559,6 @@ val function_type : lltype -> lltype array -> lltype See the method [llvm::FunctionType::get]. *) val var_arg_function_type : lltype -> lltype array -> lltype - (** [is_var_arg fty] returns [true] if [fty] is a varargs function type, [false] otherwise. See the method [llvm::FunctionType::isVarArg]. *) val is_var_arg : lltype -> bool @@ -468,31 +579,29 @@ val param_types : lltype -> lltype array [llvm::StructType::get]. *) val struct_type : llcontext -> lltype array -> lltype - (** [packed_struct_type context ys] returns the packed structure type in the context [context] containing in the types in the array [tys]. See the method [llvm::StructType::get]. *) val packed_struct_type : llcontext -> lltype array -> lltype (** [struct_name ty] returns the name of the named structure type [ty], - * or None if the structure type is not named *) + or None if the structure type is not named *) val struct_name : lltype -> string option (** [named_struct_type context name] returns the named structure type [name] - * in the context [context]. - * See the method [llvm::StructType::get]. *) + in the context [context]. + See the method [llvm::StructType::get]. *) val named_struct_type : llcontext -> string -> lltype (** [struct_set_body ty elts ispacked] sets the body of the named struct [ty] - * to the [elts] elements. - * See the moethd [llvm::StructType::setBody]. *) + to the [elts] elements. + See the moethd [llvm::StructType::setBody]. *) val struct_set_body : lltype -> lltype array -> bool -> unit (** [struct_element_types sty] returns the constituent types of the struct type [sty]. See the method [llvm::StructType::getElementType]. *) val struct_element_types : lltype -> lltype array - (** [is_packed sty] returns [true] if the structure type [sty] is packed, [false] otherwise. See the method [llvm::StructType::isPacked]. *) val is_packed : lltype -> bool @@ -501,6 +610,7 @@ val is_packed : lltype -> bool [false] otherwise. See the method [llvm::StructType::isOpaque]. *) val is_opaque : lltype -> bool + (** {7 Operations on pointer, vector, and array types} *) (** [array_type ty n] returns the array type containing [n] elements of type @@ -517,7 +627,6 @@ val pointer_type : lltype -> lltype See the method [llvm::PointerType::get]. *) val qualified_pointer_type : lltype -> int -> lltype - (** [vector_type ty n] returns the array type containing [n] elements of the primitive type [ty]. See the method [llvm::ArrayType::get]. *) val vector_type : lltype -> int -> lltype @@ -549,12 +658,23 @@ val void_type : llcontext -> lltype [llvm::Type::LabelTy]. *) val label_type : llcontext -> lltype -(* {6 Values} *) +(** [x86_mmx_type c] returns the x86 64-bit MMX register type in the + context [c]. See [llvm::Type::X86_MMXTy]. *) +val x86_mmx_type : llcontext -> lltype + +(** [type_by_name m name] returns the specified type from the current module + if it exists. + See the method [llvm::Module::getTypeByName] *) +val type_by_name : llmodule -> string -> lltype option + + +(** {6 Values} *) (** [type_of v] returns the type of the value [v]. See the method [llvm::Value::getType]. *) val type_of : llvalue -> lltype +(** [classify_value v] returns the kind of the value [v]. *) val classify_value : llvalue -> ValueKind.t (** [value_name v] returns the name of the value [v]. For global values, this is @@ -571,13 +691,15 @@ val set_value_name : string -> llvalue -> unit error. See the method [llvm::Value::dump]. *) val dump_value : llvalue -> unit +(** [string_of_llvalue v] returns a string describing the value [v]. *) +val string_of_llvalue : llvalue -> string + (** [replace_all_uses_with old new] replaces all uses of the value [old] - * with the value [new]. See the method [llvm::Value::replaceAllUsesWith]. *) + with the value [new]. See the method [llvm::Value::replaceAllUsesWith]. *) val replace_all_uses_with : llvalue -> llvalue -> unit - -(* {6 Uses} *) +(** {6 Uses} *) (** [use_begin v] returns the first position in the use list for the value [v]. [use_begin] and [use_succ] can e used to iterate over the use list in order. @@ -609,12 +731,17 @@ val fold_left_uses : ('a -> lluse -> 'a) -> 'a -> llvalue -> 'a val fold_right_uses : (lluse -> 'a -> 'a) -> llvalue -> 'a -> 'a -(* {6 Users} *) +(** {6 Users} *) (** [operand v i] returns the operand at index [i] for the value [v]. See the method [llvm::User::getOperand]. *) val operand : llvalue -> int -> llvalue +(** [operand_use v i] returns the use of the operand at index [i] for the value [v]. See the + method [llvm::User::getOperandUse]. *) +val operand_use : llvalue -> int -> lluse + + (** [set_operand v i o] sets the operand of the value [v] at the index [i] to the value [o]. See the method [llvm::User::setOperand]. *) @@ -624,6 +751,7 @@ val set_operand : llvalue -> int -> llvalue -> unit See the method [llvm::User::getNumOperands]. *) val num_operands : llvalue -> int + (** {7 Operations on constants of (mostly) any type} *) (** [is_constant v] returns [true] if the value [v] is a constant, [false] @@ -654,7 +782,11 @@ val is_null : llvalue -> bool otherwise. Similar to [llvm::isa]. *) val is_undef : llvalue -> bool +(** [constexpr_opcode v] returns an [Opcode.t] corresponding to constexpr + value [v], or [Opcode.Invalid] if [v] is not a constexpr. *) val constexpr_opcode : llvalue -> Opcode.t + + (** {7 Operations on instructions} *) (** [has_metadata i] returns whether or not the instruction [i] has any @@ -665,15 +797,15 @@ val has_metadata : llvalue -> bool (** [metadata i kind] optionally returns the metadata associated with the kind [kind] in the instruction [i] See the function [llvm::Instruction::getMetadata]. *) -val metadata : llvalue -> int -> llvalue option +val metadata : llvalue -> llmdkind -> llvalue option (** [set_metadata i kind md] sets the metadata [md] of kind [kind] in the instruction [i]. See the function [llvm::Instruction::setMetadata]. *) -val set_metadata : llvalue -> int -> llvalue -> unit +val set_metadata : llvalue -> llmdkind -> llvalue -> unit (** [clear_metadata i kind] clears the metadata of kind [kind] in the instruction [i]. See the function [llvm::Instruction::setMetadata]. *) -val clear_metadata : llvalue -> int -> unit +val clear_metadata : llvalue -> llmdkind -> unit (** {7 Operations on metadata} *) @@ -687,15 +819,26 @@ val mdstring : llcontext -> string -> llvalue See the method [llvm::MDNode::get]. *) val mdnode : llcontext -> llvalue array -> llvalue +(** [mdnull c ] returns a null MDNode in context [c]. *) +val mdnull : llcontext -> llvalue + (** [get_mdstring v] returns the MDString. - * See the method [llvm::MDString::getString] *) + See the method [llvm::MDString::getString] *) val get_mdstring : llvalue -> string option -(** [get_named_metadata m name] return all the MDNodes belonging to the named - * metadata (if any). - * See the method [llvm::NamedMDNode::getOperand]. *) +(** [get_named_metadata m name] returns all the MDNodes belonging to the named + metadata (if any). + See the method [llvm::NamedMDNode::getOperand]. *) val get_named_metadata : llmodule -> string -> llvalue array +(** [add_named_metadata_operand m name v] adds [v] as the last operand of + metadata named [name] in module [m]. If the metadata does not exist, + it is created. + See the methods [llvm::Module::getNamedMetadata()] and + [llvm::MDNode::addOperand()]. *) +val add_named_metadata_operand : llmodule -> string -> llvalue -> unit + + (** {7 Operations on scalar constants} *) (** [const_int ty i] returns the integer constant of type [ty] and value [i]. @@ -707,29 +850,31 @@ val const_int : lltype -> int -> llvalue val const_of_int64 : lltype -> Int64.t -> bool -> llvalue (** [int64_of_const c] returns the int64 value of the [c] constant integer. - * None is returned if this is not an integer constant, or bitwidth exceeds 64. - * See the method [llvm::ConstantInt::getSExtValue].*) + None is returned if this is not an integer constant, or bitwidth exceeds 64. + See the method [llvm::ConstantInt::getSExtValue].*) val int64_of_const : llvalue -> Int64.t option (** [const_int_of_string ty s r] returns the integer constant of type [ty] and - * value [s], with the radix [r]. See the method [llvm::ConstantInt::get]. *) + value [s], with the radix [r]. See the method [llvm::ConstantInt::get]. *) val const_int_of_string : lltype -> string -> int -> llvalue - (** [const_float ty n] returns the floating point constant of type [ty] and value [n]. See the method [llvm::ConstantFP::get]. *) val const_float : lltype -> float -> llvalue +(** [float_of_const c] returns the float value of the [c] constant float. + None is returned if this is not an float constant. + See the method [llvm::ConstantFP::getDoubleValue].*) +val float_of_const : llvalue -> float option + (** [const_float_of_string ty s] returns the floating point constant of type [ty] and value [n]. See the method [llvm::ConstantFP::get]. *) val const_float_of_string : lltype -> string -> llvalue - - (** {7 Operations on composite constants} *) (** [const_string c s] returns the constant [i8] array with the values of the - characters in the string [s] in the context [c]. The array is not + characters in the string [s] in the context [c]. 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]. *) @@ -766,12 +911,19 @@ val const_named_struct : lltype -> llvalue array -> llvalue [llvm::ConstantStruct::get]. *) val const_packed_struct : llcontext -> llvalue array -> llvalue - (** [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]. *) val const_vector : llvalue array -> llvalue +(** [string_of_const c] returns [Some str] if [c] is a string constant, + or [None] if this is not a string constant. *) +val string_of_const : llvalue -> string option + +(** [const_element c] returns a constant for a specified index's element. + See the method ConstantDataSequential::getElementAsConstant. *) +val const_element : llvalue -> int -> llvalue + (** {7 Constant expressions} *) @@ -918,13 +1070,11 @@ val const_xor : llvalue -> llvalue -> llvalue See the method [llvm::ConstantExpr::getICmp]. *) val const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue - (** [const_fcmp pred c1 c2] returns the constant comparison of two floating point constants, [c1 pred c2]. See the method [llvm::ConstantExpr::getFCmp]. *) val const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue - (** [const_shl c1 c2] returns the constant integer [c1] left-shifted by the constant integer [c2]. See the method [llvm::ConstantExpr::getShl]. *) @@ -940,17 +1090,16 @@ val const_lshr : llvalue -> llvalue -> llvalue See the method [llvm::ConstantExpr::getAShr]. *) val const_ashr : llvalue -> llvalue -> llvalue -(** [const_gep pc indices] returns the constant [getElementPtr] of [p1] with the +(** [const_gep pc indices] returns the constant [getElementPtr] of [pc] with the constant integers indices from the array [indices]. See the method [llvm::ConstantExpr::getGetElementPtr]. *) val const_gep : llvalue -> llvalue array -> llvalue -(** [const_in_bounds_gep pc indices] returns the constant [getElementPtr] of [p1] +(** [const_in_bounds_gep pc indices] returns the constant [getElementPtr] of [pc] with the constant integers indices from the array [indices]. See the method [llvm::ConstantExpr::getInBoundsGetElementPtr]. *) val const_in_bounds_gep : llvalue -> llvalue array -> llvalue - (** [const_trunc c ty] returns the constant truncation of integer constant [c] to the smaller integer type [ty]. See the method [llvm::ConstantExpr::getTrunc]. *) @@ -1016,50 +1165,44 @@ val const_bitcast : llvalue -> lltype -> llvalue See the method [llvm::ConstantExpr::getZExtOrBitCast]. *) val const_zext_or_bitcast : llvalue -> lltype -> llvalue - (** [const_sext_or_bitcast c ty] returns a constant sext or bitwise cast conversion of constant [c] to type [ty]. See the method [llvm::ConstantExpr::getSExtOrBitCast]. *) val const_sext_or_bitcast : llvalue -> lltype -> llvalue - (** [const_trunc_or_bitcast c ty] returns a constant trunc or bitwise cast conversion of constant [c] to type [ty]. See the method [llvm::ConstantExpr::getTruncOrBitCast]. *) val const_trunc_or_bitcast : llvalue -> lltype -> llvalue - (** [const_pointercast c ty] returns a constant bitcast or a pointer-to-int cast conversion of constant [c] to type [ty] of equal size. See the method [llvm::ConstantExpr::getPointerCast]. *) val const_pointercast : llvalue -> lltype -> llvalue - -(** [const_intcast c ty] returns a constant zext, bitcast, or trunc for integer - -> integer casts of constant [c] to type [ty]. - See the method [llvm::ConstantExpr::getIntCast]. *) -val const_intcast : llvalue -> lltype -> llvalue - +(** [const_intcast c ty ~is_signed] returns a constant sext/zext, bitcast, + or trunc for integer -> integer casts of constant [c] to type [ty]. + When converting a narrower value to a wider one, whether sext or zext + will be used is controlled by [is_signed]. + See the method [llvm::ConstantExpr::getIntegerCast]. *) +val const_intcast : llvalue -> lltype -> is_signed:bool -> llvalue (** [const_fpcast c ty] returns a constant fpext, bitcast, or fptrunc for fp -> fp casts of constant [c] to type [ty]. See the method [llvm::ConstantExpr::getFPCast]. *) val const_fpcast : llvalue -> lltype -> llvalue - (** [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]. *) val const_select : llvalue -> llvalue -> llvalue -> llvalue - (** [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]. *) val const_extractelement : llvalue -> llvalue -> llvalue - (** [const_insertelement vec v i] returns the constant vector with the same elements as constant vector [v] but the [i]th element replaced by the constant [v]. [v] must be a constant value with the type of the vector @@ -1068,31 +1211,25 @@ val const_extractelement : llvalue -> llvalue -> llvalue See the method [llvm::ConstantExpr::getInsertElement]. *) val const_insertelement : llvalue -> llvalue -> llvalue -> llvalue - (** [const_shufflevector a b mask] returns a constant [shufflevector]. See the LLVM Language Reference for details on the [shufflevector] instruction. See the method [llvm::ConstantExpr::getShuffleVector]. *) val const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue - (** [const_extractvalue agg idxs] returns the constant [idxs]th value of constant aggregate [agg]. Each [idxs] must be less than the size of the aggregate. See the method [llvm::ConstantExpr::getExtractValue]. *) val const_extractvalue : llvalue -> int array -> llvalue - (** [const_insertvalue agg val idxs] inserts the value [val] in the specified indexs [idxs] in the aggegate [agg]. Each [idxs] must be less than the size of the aggregate. See the method [llvm::ConstantExpr::getInsertValue]. *) val const_insertvalue : llvalue -> llvalue -> int array -> llvalue - (** [const_inline_asm ty asm con side align] inserts a inline assembly string. See the method [llvm::InlineAsm::get]. *) -val const_inline_asm : lltype -> string -> string -> bool -> bool -> - llvalue - +val const_inline_asm : lltype -> string -> string -> bool -> bool -> llvalue (** [block_address f bb] returns the address of the basic block [bb] in the function [f]. See the method [llvm::BasicBlock::get]. *) @@ -1118,6 +1255,16 @@ val linkage : llvalue -> Linkage.t See the method [llvm::GlobalValue::setLinkage]. *) val set_linkage : Linkage.t -> llvalue -> unit +(** [unnamed_addr g] returns [true] if the global value [g] has the unnamed_addr + attribute. Returns [false] otherwise. + See the method [llvm::GlobalValue::getUnnamedAddr]. *) +val unnamed_addr : llvalue -> bool + +(** [set_unnamed_addr b g] if [b] is [true], sets the unnamed_addr attribute of + the global value [g]. Unset it otherwise. + See the method [llvm::GlobalValue::setUnnamedAddr]. *) +val set_unnamed_addr : bool -> llvalue -> unit + (** [section g] returns the linker section of the global value [g]. See the method [llvm::GlobalValue::getSection]. *) val section : llvalue -> string @@ -1134,6 +1281,13 @@ val visibility : llvalue -> Visibility.t [v]. See the method [llvm::GlobalValue::setVisibility]. *) val set_visibility : Visibility.t -> llvalue -> unit +(** [dll_storage_class g] returns the DLL storage class of the global value [g]. + See the method [llvm::GlobalValue::getDLLStorageClass]. *) +val dll_storage_class : llvalue -> DLLStorageClass.t + +(** [set_dll_storage_class v g] sets the DLL storage class of the global value [g] to + [v]. See the method [llvm::GlobalValue::setDLLStorageClass]. *) +val set_dll_storage_class : DLLStorageClass.t -> llvalue -> unit (** [alignment g] returns the required alignment of the global value [g]. See the method [llvm::GlobalValue::getAlignment]. *) @@ -1152,15 +1306,12 @@ val set_alignment : int -> llvalue -> unit global differs, then a bitcast to [ty] is returned. *) val declare_global : lltype -> string -> llmodule -> llvalue - (** [declare_qualified_global ty name addrspace m] returns a new global variable of type [ty] and with name [name] in module [m] in the address space [addrspace]. 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. *) -val declare_qualified_global : lltype -> string -> int -> llmodule -> - llvalue - +val declare_qualified_global : lltype -> string -> int -> llmodule -> llvalue (** [define_global name init m] returns a new global with name [name] and initializer [init] in module [m] in the default address space (0). If the @@ -1168,21 +1319,17 @@ val declare_qualified_global : lltype -> string -> int -> llmodule -> See the constructor of [llvm::GlobalVariable]. *) val define_global : string -> llvalue -> llmodule -> llvalue - (** [define_qualified_global name init addrspace m] returns a new global with name [name] and initializer [init] in module [m] in the address space [addrspace]. If the named global already exists, it is renamed. See the constructor of [llvm::GlobalVariable]. *) -val define_qualified_global : string -> llvalue -> int -> llmodule -> - llvalue - +val define_qualified_global : string -> llvalue -> int -> llmodule -> llvalue (** [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. *) val lookup_global : string -> llmodule -> llvalue option - (** [delete_global gv] destroys the global variable [gv]. See the method [llvm::GlobalVariable::eraseFromParent]. *) val delete_global : llvalue -> unit @@ -1193,13 +1340,11 @@ val delete_global : llvalue -> unit See the method [llvm::Module::global_begin]. *) val global_begin : llmodule -> (llmodule, llvalue) llpos - (** [global_succ gv] returns the global variable list position succeeding [Before gv]. See the method [llvm::Module::global_iterator::operator++]. *) val global_succ : llvalue -> (llmodule, llvalue) llpos - (** [iter_globals f m] applies function [f] to each of the global variables of module [m] in order. Tail recursive. *) val iter_globals : (llvalue -> unit) -> llmodule -> unit @@ -1214,13 +1359,11 @@ val fold_left_globals : ('a -> llvalue -> 'a) -> 'a -> llmodule -> 'a See the method [llvm::Module::global_end]. *) val global_end : llmodule -> (llmodule, llvalue) llrev_pos - (** [global_pred gv] returns the global variable list position preceding [After gv]. See the method [llvm::Module::global_iterator::operator--]. *) val global_pred : llvalue -> (llmodule, llvalue) llrev_pos - (** [rev_iter_globals f m] applies function [f] to each of the global variables of module [m] in reverse order. Tail recursive. *) val rev_iter_globals : (llvalue -> unit) -> llmodule -> unit @@ -1239,7 +1382,6 @@ val is_global_constant : llvalue -> bool See the method [llvm::GlobalVariable::setConstant]. *) val set_global_constant : bool -> llvalue -> unit - (** [global_initializer gv] returns the initializer for the global variable [gv]. See the method [llvm::GlobalVariable::getInitializer]. *) val global_initializer : llvalue -> llvalue @@ -1264,6 +1406,26 @@ val is_thread_local : llvalue -> bool See the method [llvm::GlobalVariable::setThreadLocal]. *) val set_thread_local : bool -> llvalue -> unit +(** [is_thread_local gv] returns the thread local mode of the global + variable [gv]. + See the method [llvm::GlobalVariable::getThreadLocalMode]. *) +val thread_local_mode : llvalue -> ThreadLocalMode.t + +(** [set_thread_local c gv] sets the thread local mode of the global + variable [gv]. + See the method [llvm::GlobalVariable::setThreadLocalMode]. *) +val set_thread_local_mode : ThreadLocalMode.t -> llvalue -> unit + +(** [is_externally_initialized gv] returns [true] if the global + variable [gv] is externally initialized and [false] otherwise. + See the method [llvm::GlobalVariable::isExternallyInitialized]. *) +val is_externally_initialized : llvalue -> bool + +(** [set_externally_initialized c gv] sets the global variable [gv] to be + externally initialized if [c] is [true] and not otherwise. + See the method [llvm::GlobalVariable::setExternallyInitialized]. *) +val set_externally_initialized : bool -> llvalue -> unit + (** {7 Operations on aliases} *) @@ -1273,7 +1435,6 @@ val set_thread_local : bool -> llvalue -> unit val add_alias : llmodule -> lltype -> llvalue -> string -> llvalue - (** {7 Operations on functions} *) (** [declare_function name ty m] returns a new function of type [ty] and @@ -1282,20 +1443,17 @@ val add_alias : llmodule -> lltype -> llvalue -> string -> llvalue to [ty] is returned. *) val declare_function : string -> lltype -> llmodule -> llvalue - (** [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]. *) val define_function : string -> lltype -> llmodule -> llvalue - (** [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. *) val lookup_function : string -> llmodule -> llvalue option - (** [delete_function f] destroys the function [f]. See the method [llvm::Function::eraseFromParent]. *) val delete_function : llvalue -> unit @@ -1306,13 +1464,11 @@ val delete_function : llvalue -> unit See the method [llvm::Module::begin]. *) val function_begin : llmodule -> (llmodule, llvalue) llpos - (** [function_succ gv] returns the function list position succeeding [Before gv]. See the method [llvm::Module::iterator::operator++]. *) val function_succ : llvalue -> (llmodule, llvalue) llpos - (** [iter_functions f m] applies function [f] to each of the functions of module [m] in order. Tail recursive. *) val iter_functions : (llvalue -> unit) -> llmodule -> unit @@ -1327,12 +1483,10 @@ val fold_left_functions : ('a -> llvalue -> 'a) -> 'a -> llmodule -> 'a See the method [llvm::Module::end]. *) val function_end : llmodule -> (llmodule, llvalue) llrev_pos - (** [function_pred gv] returns the function list position preceding [After gv]. See the method [llvm::Module::iterator::operator--]. *) val function_pred : llvalue -> (llmodule, llvalue) llrev_pos - (** [rev_iter_functions f fn] applies function [f] to each of the functions of module [m] in reverse order. Tail recursive. *) val rev_iter_functions : (llvalue -> unit) -> llmodule -> unit @@ -1354,7 +1508,6 @@ val function_call_conv : llvalue -> int See the method [llvm::Function::setCallingConv]. *) val set_function_call_conv : int -> llvalue -> unit - (** [gc f] returns [Some name] if the function [f] has a garbage collection algorithm specified and [None] otherwise. See the method [llvm::Function::getGC]. *) @@ -1368,10 +1521,19 @@ val set_gc : string option -> llvalue -> unit [f]. *) val add_function_attr : llvalue -> Attribute.t -> unit +(** [add_target_dependent_function_attr f a] adds target-dependent attribute + [a] to function [f]. *) +val add_target_dependent_function_attr : llvalue -> string -> string -> unit + +(** [function_attr f] returns the function attribute for the function [f]. + See the method [llvm::Function::getAttributes] *) +val function_attr : llvalue -> Attribute.t list + (** [remove_function_attr f a] removes attribute [a] from the return type of function [f]. *) val remove_function_attr : llvalue -> Attribute.t -> unit + (** {7 Operations on params} *) (** [params f] returns the parameters of function [f]. @@ -1382,6 +1544,11 @@ val params : llvalue -> llvalue array See the method [llvm::Function::getArgumentList]. *) val param : llvalue -> int -> llvalue +(** [param_attr p] returns the attributes of parameter [p]. + See the methods [llvm::Function::getAttributes] and + [llvm::Attributes::getParamAttributes] *) +val param_attr : llvalue -> Attribute.t list + (** [param_parent p] returns the parent function that owns the parameter. See the method [llvm::Argument::getParent]. *) val param_parent : llvalue -> llvalue @@ -1415,7 +1582,6 @@ val param_end : llvalue -> (llvalue, llvalue) llrev_pos See the method [llvm::Function::arg_iterator::operator--]. *) val param_pred : llvalue -> (llvalue, llvalue) llrev_pos - (** [rev_iter_params f fn] applies function [f] to each of the parameters of function [fn] in reverse order. Tail recursive. *) val rev_iter_params : (llvalue -> unit) -> llvalue -> unit @@ -1448,18 +1614,28 @@ val entry_block : llvalue -> llbasicblock See the method [llvm::BasicBlock::eraseFromParent]. *) val delete_block : llbasicblock -> unit +(** [remove_block bb] removes the basic block [bb] from its parent function. + See the method [llvm::BasicBlock::removeFromParent]. *) +val remove_block : llbasicblock -> unit + +(** [move_block_before pos bb] moves the basic block [bb] before [pos]. + See the method [llvm::BasicBlock::moveBefore]. *) +val move_block_before : llbasicblock -> llbasicblock -> unit + +(** [move_block_after pos bb] moves the basic block [bb] after [pos]. + See the method [llvm::BasicBlock::moveAfter]. *) +val move_block_after : llbasicblock -> llbasicblock -> unit + (** [append_block c name f] creates a new basic block named [name] at the end of function [f] in the context [c]. See the constructor of [llvm::BasicBlock]. *) val append_block : llcontext -> string -> llvalue -> llbasicblock - (** [insert_block c name bb] creates a new basic block named [name] before the basic block [bb] in the context [c]. See the constructor of [llvm::BasicBlock]. *) val insert_block : llcontext -> string -> llbasicblock -> llbasicblock - (** [block_parent bb] returns the parent function that owns the basic block. See the method [llvm::BasicBlock::getParent]. *) val block_parent : llbasicblock -> llvalue @@ -1470,13 +1646,11 @@ val block_parent : llbasicblock -> llvalue See the method [llvm::Function::begin]. *) val block_begin : llvalue -> (llvalue, llbasicblock) llpos - (** [block_succ bb] returns the basic block list position succeeding [Before bb]. See the method [llvm::Function::iterator::operator++]. *) val block_succ : llbasicblock -> (llvalue, llbasicblock) llpos - (** [iter_blocks f fn] applies function [f] to each of the basic blocks of function [fn] in order. Tail recursive. *) val iter_blocks : (llbasicblock -> unit) -> llvalue -> unit @@ -1491,11 +1665,12 @@ val fold_left_blocks : ('a -> llbasicblock -> 'a) -> 'a -> llvalue -> 'a See the method [llvm::Function::end]. *) val block_end : llvalue -> (llvalue, llbasicblock) llrev_pos - -(** [block_pred gv] returns the function list position preceding [After gv]. +(** [block_pred bb] returns the basic block list position preceding [After bb]. See the method [llvm::Function::iterator::operator--]. *) val block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos +(** [block_terminator bb] returns the terminator of the basic block [bb]. *) +val block_terminator : llbasicblock -> llvalue option (** [rev_iter_blocks f fn] applies function [f] to each of the basic blocks of function [fn] in reverse order. Tail recursive. *) @@ -1523,18 +1698,20 @@ val block_of_value : llvalue -> llbasicblock See the method [llvm::Instruction::getParent]. *) val instr_parent : llvalue -> llbasicblock +(** [delete_instruction i] deletes the instruction [i]. + * See the method [llvm::Instruction::eraseFromParent]. *) +val delete_instruction : llvalue -> unit + (** [instr_begin bb] returns the first position in the instruction list of the basic block [bb]. [instr_begin] and [instr_succ] can be used to iterate over the instruction list in order. See the method [llvm::BasicBlock::begin]. *) val instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos - (** [instr_succ i] returns the instruction list position succeeding [Before i]. See the method [llvm::BasicBlock::iterator::operator++]. *) val instr_succ : llvalue -> (llbasicblock, llvalue) llpos - (** [iter_instrs f bb] applies function [f] to each of the instructions of basic block [bb] in order. Tail recursive. *) val iter_instrs: (llvalue -> unit) -> llbasicblock -> unit @@ -1549,20 +1726,32 @@ val fold_left_instrs: ('a -> llvalue -> 'a) -> 'a -> llbasicblock -> 'a See the method [llvm::BasicBlock::end]. *) val instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos - (** [instr_pred i] returns the instruction list position preceding [After i]. See the method [llvm::BasicBlock::iterator::operator--]. *) val instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos - (** [fold_right_instrs f bb init] is [f (... (f init fN) ...) f1] where [f1,...,fN] are the instructions of basic block [bb]. Tail recursive. *) val fold_right_instrs: (llvalue -> 'a -> 'a) -> llbasicblock -> 'a -> 'a +(** [inst_opcode i] returns the [Opcode.t] corresponding to instruction [i], + or [Opcode.Invalid] if [i] is not an instruction. *) val instr_opcode : llvalue -> Opcode.t +(** [icmp_predicate i] returns the [Icmp.t] corresponding to an [icmp] + instruction [i]. *) val icmp_predicate : llvalue -> Icmp.t option +(** [fcmp_predicate i] returns the [fcmp.t] corresponding to an [fcmp] + instruction [i]. *) +val fcmp_predicate : llvalue -> Fcmp.t option + +(** [inst_clone i] returns a copy of instruction [i], + The instruction has no parent, and no name. + See the method [llvm::Instruction::clone]. *) +val instr_clone : llvalue -> llvalue + + (** {7 Operations on call sites} *) (** [instruction_call_conv ci] is the calling convention for the call or invoke @@ -1571,7 +1760,6 @@ val icmp_predicate : llvalue -> Icmp.t option [llvm::InvokeInst::getCallingConv]. *) val instruction_call_conv: llvalue -> int - (** [set_instruction_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}. @@ -1579,7 +1767,6 @@ val instruction_call_conv: llvalue -> int and [llvm::InvokeInst::setCallingConv]. *) val set_instruction_call_conv: int -> llvalue -> unit - (** [add_instruction_param_attr ci i a] adds attribute [a] to the [i]th parameter of the call or invoke instruction [ci]. [i]=0 denotes the return value. *) @@ -1590,7 +1777,8 @@ val add_instruction_param_attr : llvalue -> int -> Attribute.t -> unit return value. *) val remove_instruction_param_attr : llvalue -> int -> Attribute.t -> unit -(** {Operations on call instructions (only)} *) + +(** {7 Operations on call instructions (only)} *) (** [is_tail_call ci] is [true] if the call instruction [ci] is flagged as eligible for tail call optimization, [false] otherwise. @@ -1602,13 +1790,74 @@ val is_tail_call : llvalue -> bool See the method [llvm::CallInst::setTailCall]. *) val set_tail_call : bool -> llvalue -> unit + +(** {7 Operations on load/store instructions (only)} *) + +(** [is_volatile i] is [true] if the load or store instruction [i] is marked + as volatile. + See the methods [llvm::LoadInst::isVolatile] and + [llvm::StoreInst::isVolatile]. *) +val is_volatile : llvalue -> bool + +(** [set_volatile v i] marks the load or store instruction [i] as volatile + if [v] is [true], unmarks otherwise. + See the methods [llvm::LoadInst::setVolatile] and + [llvm::StoreInst::setVolatile]. *) +val set_volatile : bool -> llvalue -> unit + +(** {7 Operations on terminators} *) + +(** [is_terminator v] returns true if the instruction [v] is a terminator. *) +val is_terminator : llvalue -> bool + +(** [successor v i] returns the successor at index [i] for the value [v]. + See the method [llvm::TerminatorInst::getSuccessor]. *) +val successor : llvalue -> int -> llbasicblock + +(** [set_successor v i o] sets the successor of the value [v] at the index [i] to + the value [o]. + See the method [llvm::TerminatorInst::setSuccessor]. *) +val set_successor : llvalue -> int -> llbasicblock -> unit + +(** [num_successors v] returns the number of successors for the value [v]. + See the method [llvm::TerminatorInst::getNumSuccessors]. *) +val num_successors : llvalue -> int + +(** [successors v] returns the successors of [v]. *) +val successors : llvalue -> llbasicblock array + +(** [iter_successors f v] applies function f to each successor [v] in order. Tail recursive. *) +val iter_successors : (llbasicblock -> unit) -> llvalue -> unit + +(** [fold_successors f v init] is [f (... (f init vN) ...) v1] where [v1,...,vN] are the successors of [v]. Tail recursive. *) +val fold_successors : (llbasicblock -> 'a -> 'a) -> llvalue -> 'a -> 'a + +(** {7 Operations on branches} *) + +(** [is_conditional v] returns true if the branch instruction [v] is conditional. + See the method [llvm::BranchInst::isConditional]. *) +val is_conditional : llvalue -> bool + +(** [condition v] return the condition of the branch instruction [v]. + See the method [llvm::BranchInst::getCondition]. *) +val condition : llvalue -> llvalue + +(** [set_condition v c] sets the condition of the branch instruction [v] to the value [c]. + See the method [llvm::BranchInst::setCondition]. *) +val set_condition : llvalue -> llvalue -> unit + +(** [get_branch c] returns a description of the branch instruction [c]. *) +val get_branch : llvalue -> + [ `Conditional of llvalue * llbasicblock * llbasicblock + | `Unconditional of llbasicblock ] + option + (** {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]. *) val add_incoming : (llvalue * llbasicblock) -> llvalue -> unit - (** [incoming pn] returns the list of value-block pairs for phi node [pn]. See the method [llvm::PHINode::getIncomingValue]. *) val incoming : llvalue -> (llvalue * llbasicblock) list @@ -1640,7 +1889,6 @@ val builder_at_end : llcontext -> llbasicblock -> llbuilder See the constructor for [llvm::LLVMBuilder]. *) val position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit - (** [position_before ins b] moves the instruction builder [b] to before the instruction [isn]. See the method [llvm::LLVMBuilder::SetInsertPoint]. *) val position_before : llvalue -> llbuilder -> unit @@ -1668,18 +1916,15 @@ val insert_into_builder : llvalue -> string -> llbuilder -> unit See the method [llvm::IRBuilder::SetDebugLocation]. *) val set_current_debug_location : llbuilder -> llvalue -> unit - (** [clear_current_debug_location b] clears the current debug location in the builder [b]. *) val clear_current_debug_location : llbuilder -> unit - (** [current_debug_location b] returns the current debug location, or None if none is currently set. See the method [llvm::IRBuilder::GetDebugLocation]. *) val current_debug_location : llbuilder -> llvalue option - (** [set_inst_debug_location b i] sets the current debug location of the builder [b] to the instruction [i]. See the method [llvm::IRBuilder::SetInstDebugLocation]. *) @@ -1706,7 +1951,6 @@ val build_ret : llvalue -> llbuilder -> llvalue See the method [llvm::LLVMBuilder::CreateAggregateRet]. *) val build_aggregate_ret : llvalue array -> llbuilder -> llvalue - (** [build_br bb b] creates a [br %bb] instruction at the position specified by the instruction builder [b]. @@ -1727,12 +1971,30 @@ val build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder -> See the method [llvm::LLVMBuilder::CreateSwitch]. *) val build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue +(** [build_malloc ty name b] creates an [malloc] + instruction at the position specified by the instruction builder [b]. + See the method [llvm::CallInst::CreateMalloc]. *) +val build_malloc : lltype -> string -> llbuilder -> llvalue + +(** [build_array_malloc ty val name b] creates an [array malloc] + instruction at the position specified by the instruction builder [b]. + See the method [llvm::CallInst::CreateArrayMalloc]. *) +val build_array_malloc : lltype -> llvalue -> string -> llbuilder -> llvalue + +(** [build_free p b] creates a [free] + instruction at the position specified by the instruction builder [b]. + See the method [llvm::LLVMBuilder::CreateFree]. *) +val build_free : llvalue -> llbuilder -> llvalue (** [add_case sw onval bb] causes switch instruction [sw] to branch to [bb] when its input matches the constant [onval]. See the method [llvm::SwitchInst::addCase]. **) val add_case : llvalue -> llvalue -> llbasicblock -> unit +(** [switch_default_dest sw] returns the default destination of the [switch] + instruction. + See the method [llvm:;SwitchInst::getDefaultDest]. **) +val switch_default_dest : llvalue -> llbasicblock (** [build_indirect_br addr count b] creates a [indirectbr %addr] @@ -1741,13 +2003,11 @@ val add_case : llvalue -> llvalue -> llbasicblock -> unit See the method [llvm::LLVMBuilder::CreateIndirectBr]. *) val build_indirect_br : llvalue -> int -> llbuilder -> llvalue - (** [add_destination br bb] adds the basic block [bb] as a possible branch location for the indirectbr instruction [br]. See the method [llvm::IndirectBrInst::addDestination]. **) val add_destination : llvalue -> llbasicblock -> unit - (** [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]. @@ -1766,6 +2026,15 @@ val build_landingpad : lltype -> llvalue -> int -> string -> llbuilder -> See the method [llvm::LandingPadInst::setCleanup]. *) val set_cleanup : llvalue -> bool -> unit +(** [add_clause lp clause] adds the clause to the [landingpad]instruction. + See the method [llvm::LandingPadInst::addClause]. *) +val add_clause : llvalue -> llvalue -> unit + +(** [build_resume exn b] builds a [resume exn] instruction + at the position specified by the instruction builder [b]. + See the method [llvm::LLVMBuilder::CreateResume] *) +val build_resume : llvalue -> llbuilder -> llvalue + (** [build_unreachable b] creates an [unreachable] instruction at the position specified by the instruction builder [b]. @@ -1781,175 +2050,150 @@ val build_unreachable : llbuilder -> llvalue See the method [llvm::LLVMBuilder::CreateAdd]. *) val build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [build_nsw_add x y name b] creates a [%name = nsw add %x, %y] instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateNSWAdd]. *) val build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [build_nuw_add x y name b] creates a [%name = nuw add %x, %y] instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateNUWAdd]. *) val build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [build_fadd x y name b] creates a [%name = fadd %x, %y] instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateFAdd]. *) val build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [build_nsw_sub x y name b] creates a [%name = nsw sub %x, %y] instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateNSWSub]. *) val build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [build_nuw_sub x y name b] creates a [%name = nuw sub %x, %y] instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateNUWSub]. *) val build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [build_fsub x y name b] creates a [%name = fsub %x, %y] instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateFSub]. *) val build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [build_nsw_mul x y name b] creates a [%name = nsw mul %x, %y] instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateNSWMul]. *) val build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [build_nuw_mul x y name b] creates a [%name = nuw mul %x, %y] instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateNUWMul]. *) val build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [build_fmul x y name b] creates a [%name = fmul %x, %y] instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateFMul]. *) val build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [build_exact_sdiv x y name b] creates a [%name = exact sdiv %x, %y] instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateExactSDiv]. *) val build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** [build_neg x name b] creates a [%name = sub 0, %x] instruction at the position specified by the instruction builder [b]. @@ -1957,7 +2201,6 @@ val build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue See the method [llvm::LLVMBuilder::CreateNeg]. *) val build_neg : llvalue -> string -> llbuilder -> llvalue - (** [build_nsw_neg x name b] creates a [%name = nsw sub 0, %x] instruction at the position specified by the instruction builder [b]. @@ -1965,7 +2208,6 @@ val build_neg : llvalue -> string -> llbuilder -> llvalue See the method [llvm::LLVMBuilder::CreateNeg]. *) val build_nsw_neg : llvalue -> string -> llbuilder -> llvalue - (** [build_nuw_neg x name b] creates a [%name = nuw sub 0, %x] instruction at the position specified by the instruction builder [b]. @@ -1973,7 +2215,6 @@ val build_nsw_neg : llvalue -> string -> llbuilder -> llvalue See the method [llvm::LLVMBuilder::CreateNeg]. *) val build_nuw_neg : llvalue -> string -> llbuilder -> llvalue - (** [build_fneg x name b] creates a [%name = fsub 0, %x] instruction at the position specified by the instruction builder [b]. @@ -1981,7 +2222,6 @@ val build_nuw_neg : llvalue -> string -> llbuilder -> llvalue See the method [llvm::LLVMBuilder::CreateFNeg]. *) val build_fneg : llvalue -> string -> llbuilder -> llvalue - (** [build_xor x name b] creates a [%name = xor %x, -1] instruction at the position specified by the instruction builder [b]. @@ -1990,7 +2230,6 @@ val build_fneg : llvalue -> string -> llbuilder -> llvalue val build_not : llvalue -> string -> llbuilder -> llvalue - (** {7 Memory} *) (** [build_alloca ty name b] creates a @@ -1999,7 +2238,6 @@ val build_not : llvalue -> string -> llbuilder -> llvalue See the method [llvm::LLVMBuilder::CreateAlloca]. *) val build_alloca : lltype -> string -> llbuilder -> llvalue - (** [build_array_alloca ty n name b] creates a [%name = alloca %ty, %n] instruction at the position specified by the instruction builder [b]. @@ -2013,13 +2251,19 @@ val build_array_alloca : lltype -> llvalue -> string -> llbuilder -> See the method [llvm::LLVMBuilder::CreateLoad]. *) val build_load : llvalue -> string -> llbuilder -> llvalue - (** [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]. *) val build_store : llvalue -> llvalue -> llbuilder -> llvalue +(** [build_atomicrmw op ptr val o st b] creates an [atomicrmw] instruction with + operation [op] performed on pointer [ptr] and value [val] with ordering [o] + and singlethread flag set to [st] at the position specified by + the instruction builder [b]. + See the method [llvm::IRBuilder::CreateAtomicRMW]. *) +val build_atomicrmw : AtomicRMWBinOp.t -> llvalue -> llvalue -> + AtomicOrdering.t -> bool -> string -> llbuilder -> llvalue (** [build_gep p indices name b] creates a [%name = getelementptr %p, indices...] @@ -2027,7 +2271,6 @@ val build_store : llvalue -> llvalue -> llbuilder -> llvalue See the method [llvm::LLVMBuilder::CreateGetElementPtr]. *) val build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue - (** [build_in_bounds_gep p indices name b] creates a [%name = gelementptr inbounds %p, indices...] instruction at the position specified by the instruction builder [b]. @@ -2047,7 +2290,6 @@ val build_struct_gep : llvalue -> int -> string -> llbuilder -> See the method [llvm::LLVMBuilder::CreateGlobalString]. *) val build_global_string : string -> string -> llbuilder -> llvalue - (** [build_global_stringptr str name b] creates a series of instructions that adds a global string pointer at the position specified by the instruction builder [b]. @@ -2055,7 +2297,6 @@ val build_global_string : string -> string -> llbuilder -> llvalue val build_global_stringptr : string -> string -> llbuilder -> llvalue - (** {7 Casts} *) (** [build_trunc v ty name b] creates a @@ -2064,84 +2305,72 @@ val build_global_stringptr : string -> string -> llbuilder -> llvalue See the method [llvm::LLVMBuilder::CreateTrunc]. *) val build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [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]. *) val build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [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]. *) val build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [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]. *) val build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [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]. *) val build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [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]. *) val build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [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]. *) val build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [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]. *) val build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [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]. *) val build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [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]. *) val build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [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]. *) val build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [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]. *) val build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [build_zext_or_bitcast v ty name b] creates a zext or bitcast instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateZExtOrBitCast]. *) @@ -2165,20 +2394,17 @@ val build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder -> See the method [llvm::LLVMBuilder::CreatePointerCast]. *) val build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [build_intcast v ty name b] creates a zext, bitcast, or trunc instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateIntCast]. *) val build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [build_fpcast v ty name b] creates a fpext, bitcast, or fptrunc instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateFPCast]. *) val build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue - (** {7 Comparisons} *) (** [build_icmp pred x y name b] creates a @@ -2206,13 +2432,18 @@ val build_fcmp : Fcmp.t -> llvalue -> llvalue -> string -> val build_phi : (llvalue * llbasicblock) list -> string -> llbuilder -> llvalue +(** [build_empty_phi ty name b] creates a + [%name = phi %ty] instruction at the position specified by + the instruction builder [b]. [ty] is the type of the instruction. + See the method [llvm::LLVMBuilder::CreatePHI]. *) +val build_empty_phi : lltype -> string -> llbuilder -> llvalue + (** [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]. *) val build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue - (** [build_select cond thenv elsev name b] creates a [%name = select %cond, %thenv, %elsev] instruction at the position specified by the instruction builder [b]. @@ -2226,7 +2457,6 @@ val build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder -> See the method [llvm::LLVMBuilder::CreateVAArg]. *) val build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue - (** [build_extractelement vec i name b] creates a [%name = extractelement %vec, %i] instruction at the position specified by the instruction builder [b]. @@ -2248,7 +2478,7 @@ val build_insertelement : llvalue -> llvalue -> llvalue -> string -> val build_shufflevector : llvalue -> llvalue -> llvalue -> string -> llbuilder -> llvalue -(** [build_insertvalue agg idx name b] creates a +(** [build_extractvalue agg idx name b] creates a [%name = extractvalue %agg, %idx] instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateExtractValue]. *) @@ -2268,14 +2498,12 @@ val build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder -> See the method [llvm::LLVMBuilder::CreateIsNull]. *) val build_is_null : llvalue -> string -> llbuilder -> llvalue - (** [build_is_not_null val name b] creates a [%name = icmp ne %val, null] instruction at the position specified by the instruction builder [b]. See the method [llvm::LLVMBuilder::CreateIsNotNull]. *) val build_is_not_null : llvalue -> string -> llbuilder -> llvalue - (** [build_ptrdiff lhs rhs name b] creates a series of instructions that measure the difference between two pointer values at the position specified by the instruction builder [b]. @@ -2283,7 +2511,6 @@ val build_is_not_null : llvalue -> string -> llbuilder -> llvalue val build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** {6 Memory buffers} *) module MemoryBuffer : sig @@ -2291,11 +2518,18 @@ module MemoryBuffer : sig path [p]. If the file could not be read, then [IoError msg] is raised. *) val of_file : string -> llmemorybuffer - - (** [stdin ()] is the memory buffer containing the contents of standard input. + + (** [of_stdin ()] is the memory buffer containing the contents of standard input. If standard input is empty, then [IoError msg] is raised. *) val of_stdin : unit -> llmemorybuffer - + + (** [of_string ~name s] is the memory buffer containing the contents of string [s]. + The name of memory buffer is set to [name] if it is provided. *) + val of_string : ?name:string -> string -> llmemorybuffer + + (** [as_string mb] is the string containing the contents of memory buffer [mb]. *) + val as_string : llmemorybuffer -> string + (** Disposes of a memory buffer. *) val dispose : llmemorybuffer -> unit end @@ -2307,13 +2541,13 @@ module PassManager : sig (** *) type 'a t type any = [ `Module | `Function ] - + (** [PassManager.create ()] constructs a new whole-module pass pipeline. This type of pipeline is suitable for link-time optimization and whole-module transformations. See the constructor of [llvm::PassManager]. *) val create : unit -> [ `Module ] t - + (** [PassManager.create_function m] constructs a new function-by-function pass pipeline over the module [m]. It does not take ownership of [m]. This type of pipeline is suitable for code generation and JIT compilation @@ -2321,33 +2555,30 @@ module PassManager : sig See the constructor of [llvm::FunctionPassManager]. *) val create_function : llmodule -> [ `Function ] t - (** [run_module m pm] initializes, executes on the module [m], and finalizes all of the passes scheduled in the pass manager [pm]. Returns [true] if any of the passes modified the module, [false] otherwise. See the [llvm::PassManager::run] method. *) val run_module : llmodule -> [ `Module ] t -> bool - (** [initialize fpm] initializes all of the function passes scheduled in the function pass manager [fpm]. Returns [true] if any of the passes modified the module, [false] otherwise. See the [llvm::FunctionPassManager::doInitialization] method. *) val initialize : [ `Function ] t -> bool - + (** [run_function f fpm] executes all of the function passes scheduled in the function pass manager [fpm] over the function [f]. Returns [true] if any of the passes modified [f], [false] otherwise. See the [llvm::FunctionPassManager::run] method. *) val run_function : llvalue -> [ `Function ] t -> bool - (** [finalize fpm] finalizes all of the function passes scheduled in in the function pass manager [fpm]. Returns [true] if any of the passes modified the module, [false] otherwise. See the [llvm::FunctionPassManager::doFinalization] method. *) val finalize : [ `Function ] t -> bool - + (** Frees the memory of a pass pipeline. For function pipelines, does not free the module. See the destructor of [llvm::BasePassManager]. *)