X-Git-Url: http://plrg.eecs.uci.edu/git/?p=oota-llvm.git;a=blobdiff_plain;f=bindings%2Focaml%2Fllvm%2Fllvm.mli;h=f70fd60b34fe9215551579682a48c7961a8a11dc;hp=0f1e9a901707c198b70a9245d89c8655194e7ba6;hb=c8ac229cc8349685117f68bc6f1da04f98015cd6;hpb=ff12c99d131789ccb9e8739963f4d8e0e95667d4 diff --git a/bindings/ocaml/llvm/llvm.mli b/bindings/ocaml/llvm/llvm.mli index 0f1e9a90170..f70fd60b34f 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. *) @@ -53,6 +53,7 @@ type llmemorybuffer module TypeKind : sig type t = Void + | Half | Float | Double | X86fp80 @@ -66,6 +67,7 @@ module TypeKind : sig | Pointer | Vector | Metadata + | X86_mmx end (** The linkage of a global value, accessed with {!linkage} and @@ -76,6 +78,7 @@ module Linkage : sig | Available_externally | Link_once | Link_once_odr + | Link_once_odr_auto_hide | Weak | Weak_odr | Appending @@ -87,6 +90,7 @@ module Linkage : sig | Ghost | Common | Linker_private + | Linker_private_weak end (** The linker visibility of a global value, accessed with {!visibility} and @@ -114,6 +118,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,6 +145,9 @@ module Attribute : sig | Naked | Inlinehint | Stackalignment of int + | ReturnsTwice + | UWTable + | NonLazyBind end (** The predicate for an integer comparison ([icmp]) instruction. @@ -179,6 +188,154 @@ module Fcmp : sig | True end +(** The opcodes for LLVM instructions and constant expressions. *) +module Opcode : sig + type t = + | Invalid (* not an instruction *) + (* Terminator Instructions *) + | Ret + | Br + | Switch + | IndirectBr + | Invoke + | Invalid2 + | Unreachable + (* Standard Binary Operators *) + | Add + | FAdd + | Sub + | FSub + | Mul + | FMul + | UDiv + | SDiv + | FDiv + | URem + | SRem + | FRem + (* Logical Operators *) + | Shl + | LShr + | AShr + | And + | Or + | Xor + (* Memory Operators *) + | Alloca + | Load + | Store + | GetElementPtr + (* Cast Operators *) + | Trunc + | ZExt + | SExt + | FPToUI + | FPToSI + | UIToFP + | SIToFP + | FPTrunc + | FPExt + | PtrToInt + | IntToPtr + | BitCast + (* Other Operators *) + | ICmp + | FCmp + | PHI + | Call + | Select + | UserOp1 + | UserOp2 + | VAArg + | ExtractElement + | InsertElement + | ShuffleVector + | ExtractValue + | InsertValue + | Fence + | AtomicCmpXchg + | AtomicRMW + | Resume + | LandingPad +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. *) +module ValueKind : sig + type t = + | NullValue + | Argument + | BasicBlock + | InlineAsm + | MDNode + | MDString + | BlockAddress + | ConstantAggregateZero + | ConstantArray + | ConstantExpr + | ConstantFP + | ConstantInt + | ConstantPointerNull + | ConstantStruct + | ConstantVector + | Function + | GlobalAlias + | GlobalVariable + | UndefValue + | Instruction of Opcode.t +end + (** {6 Iteration} *) @@ -239,18 +396,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 @@ -259,10 +413,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} *) @@ -272,17 +437,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 @@ -350,7 +520,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 @@ -371,26 +540,37 @@ 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]. *) +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]. *) +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 +(** [is_opaque sty] returns [true] if the structure type [sty] is opaque. + [false] otherwise. See the method [llvm::StructType::isOpaque]. *) +val is_opaque : lltype -> bool + (** {7 Operations on pointer, vector, and array types} *) @@ -408,7 +588,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 @@ -440,12 +619,25 @@ val void_type : llcontext -> lltype [llvm::Type::LabelTy]. *) val label_type : llcontext -> lltype +(** [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 the symbol name. For instructions and basic blocks, it is the SSA register name. It is meaningless for constants. @@ -461,11 +653,10 @@ val set_value_name : string -> llvalue -> unit val dump_value : llvalue -> unit (** [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} *) (** [use_begin v] returns the first position in the use list for the value [v]. @@ -513,6 +704,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] @@ -543,6 +735,10 @@ 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} *) @@ -577,14 +773,22 @@ val mdstring : llcontext -> string -> llvalue val mdnode : llcontext -> llvalue array -> 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]. @@ -595,12 +799,15 @@ val const_int : lltype -> int -> llvalue [i]. See the method [llvm::ConstantInt::get]. *) 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].*) +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 @@ -610,7 +817,6 @@ val const_float : lltype -> float -> llvalue 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 @@ -635,9 +841,14 @@ val const_array : lltype -> llvalue array -> llvalue (** [const_struct context elts] returns the structured constant of type [struct_type (Array.map type_of elts)] and containing the values [elts] in the context [context]. This value can in turn be used as the initializer - for a global variable. See the method [llvm::ConstantStruct::get]. *) + for a global variable. See the method [llvm::ConstantStruct::getAnon]. *) val const_struct : llcontext -> llvalue array -> llvalue +(** [const_named_struct namedty elts] returns the structured constant of type + [namedty] (which must be a named structure type) 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]. *) +val const_named_struct : lltype -> llvalue array -> llvalue (** [const_packed_struct context elts] returns the structured constant of type {!packed_struct_type} [(Array.map type_of elts)] and containing the @@ -646,7 +857,6 @@ val const_struct : llcontext -> 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]. *) @@ -798,13 +1008,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]. *) @@ -830,7 +1038,6 @@ val const_gep : llvalue -> llvalue array -> llvalue 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]. *) @@ -896,50 +1103,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 @@ -948,31 +1149,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]. *) @@ -1014,7 +1209,6 @@ val visibility : llvalue -> Visibility.t [v]. See the method [llvm::GlobalValue::setVisibility]. *) val set_visibility : Visibility.t -> llvalue -> unit - (** [alignment g] returns the required alignment of the global value [g]. See the method [llvm::GlobalValue::getAlignment]. *) val alignment : llvalue -> int @@ -1032,15 +1226,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 @@ -1048,21 +1239,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 @@ -1073,13 +1260,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 @@ -1094,13 +1279,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 @@ -1119,7 +1302,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 @@ -1144,6 +1326,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} *) @@ -1153,7 +1355,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 @@ -1162,20 +1363,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 @@ -1186,13 +1384,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 @@ -1207,12 +1403,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 @@ -1234,7 +1428,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]. *) @@ -1248,10 +1441,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]. @@ -1262,6 +1464,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 @@ -1295,7 +1502,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 @@ -1328,18 +1534,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 @@ -1350,13 +1566,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 @@ -1371,11 +1585,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. *) @@ -1403,18 +1618,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 @@ -1429,19 +1646,23 @@ 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 + (** {7 Operations on call sites} *) (** [instruction_call_conv ci] is the calling convention for the call or invoke @@ -1450,7 +1671,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}. @@ -1458,7 +1678,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. *) @@ -1469,7 +1688,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. @@ -1481,13 +1701,28 @@ 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 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 @@ -1519,7 +1754,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 @@ -1547,18 +1781,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]. *) @@ -1585,7 +1816,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]. @@ -1606,12 +1836,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] @@ -1620,13 +1868,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]. @@ -1645,6 +1891,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]. @@ -1660,175 +1915,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]. @@ -1836,7 +2066,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]. @@ -1844,7 +2073,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]. @@ -1852,7 +2080,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]. @@ -1860,7 +2087,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]. @@ -1869,7 +2095,6 @@ val build_fneg : llvalue -> string -> llbuilder -> llvalue val build_not : llvalue -> string -> llbuilder -> llvalue - (** {7 Memory} *) (** [build_alloca ty name b] creates a @@ -1878,7 +2103,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]. @@ -1892,13 +2116,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...] @@ -1906,7 +2136,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]. @@ -1926,7 +2155,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]. @@ -1934,7 +2162,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 @@ -1943,84 +2170,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]. *) @@ -2044,20 +2259,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 @@ -2091,7 +2303,6 @@ val build_phi : (llvalue * llbasicblock) list -> string -> llbuilder -> 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]. @@ -2105,7 +2316,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]. @@ -2147,14 +2357,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]. @@ -2162,7 +2370,6 @@ val build_is_not_null : llvalue -> string -> llbuilder -> llvalue val build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue - (** {6 Memory buffers} *) module MemoryBuffer : sig @@ -2171,9 +2378,16 @@ module MemoryBuffer : sig 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 @@ -2200,14 +2414,12 @@ 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. @@ -2219,7 +2431,6 @@ module PassManager : sig 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