llvm.mli revision 8e130b1d0d53346e05d0a1161a52c6d62de163c4
1(*===-- llvm/llvm.mli - LLVM Ocaml Interface -------------------------------===* 2 * 3 * The LLVM Compiler Infrastructure 4 * 5 * This file is distributed under the University of Illinois Open Source 6 * License. See LICENSE.TXT for details. 7 * 8 *===----------------------------------------------------------------------===*) 9 10(** Core API. 11 12 This interface provides an ocaml API for the LLVM intermediate 13 representation, the classes in the VMCore library. *) 14 15 16(** {6 Abstract types} 17 18 These abstract types correlate directly to the LLVM VMCore classes. *) 19 20(** The top-level container for all LLVM global data. See the 21 [llvm::LLVMContext] class. *) 22type llcontext 23 24(** The top-level container for all other LLVM Intermediate Representation (IR) 25 objects. See the [llvm::Module] class. *) 26type llmodule 27 28(** Each value in the LLVM IR has a type, an instance of [lltype]. See the 29 [llvm::Type] class. *) 30type lltype 31 32(** When building recursive types using {!refine_type}, [lltype] values may 33 become invalid; use [lltypehandle] to resolve this problem. See the 34 [llvm::AbstractTypeHolder] class. *) 35type lltypehandle 36 37(** Any value in the LLVM IR. Functions, instructions, global variables, 38 constants, and much more are all [llvalues]. See the [llvm::Value] class. 39 This type covers a wide range of subclasses. *) 40type llvalue 41 42(** A basic block in LLVM IR. See the [llvm::BasicBlock] class. *) 43type llbasicblock 44 45(** Used to generate instructions in the LLVM IR. See the [llvm::LLVMBuilder] 46 class. *) 47type llbuilder 48 49(** Used to provide a module to JIT or interpreter. 50 See the [llvm::ModuleProvider] class. *) 51type llmoduleprovider 52 53(** Used to efficiently handle large buffers of read-only binary data. 54 See the [llvm::MemoryBuffer] class. *) 55type llmemorybuffer 56 57(** The kind of an [lltype], the result of [classify_type ty]. See the 58 [llvm::Type::TypeID] enumeration. *) 59module TypeKind : sig 60 type t = 61 Void 62 | Float 63 | Double 64 | X86fp80 65 | Fp128 66 | Ppc_fp128 67 | Label 68 | Integer 69 | Function 70 | Struct 71 | Array 72 | Pointer 73 | Opaque 74 | Vector 75 | Metadata 76 | Union 77end 78 79(** The linkage of a global value, accessed with {!linkage} and 80 {!set_linkage}. See [llvm::GlobalValue::LinkageTypes]. *) 81module Linkage : sig 82 type t = 83 External 84 | Available_externally 85 | Link_once 86 | Link_once_odr 87 | Weak 88 | Weak_odr 89 | Appending 90 | Internal 91 | Private 92 | Dllimport 93 | Dllexport 94 | External_weak 95 | Ghost 96 | Common 97 | Linker_private 98end 99 100(** The linker visibility of a global value, accessed with {!visibility} and 101 {!set_visibility}. See [llvm::GlobalValue::VisibilityTypes]. *) 102module Visibility : sig 103 type t = 104 Default 105 | Hidden 106 | Protected 107end 108 109(** The following calling convention values may be accessed with 110 {!function_call_conv} and {!set_function_call_conv}. Calling 111 conventions are open-ended. *) 112module CallConv : sig 113 val c : int (** [c] is the C calling convention. *) 114 val fast : int (** [fast] is the calling convention to allow LLVM 115 maximum optimization opportunities. Use only with 116 internal linkage. *) 117 val cold : int (** [cold] is the calling convention for 118 callee-save. *) 119 val x86_stdcall : int (** [x86_stdcall] is the familiar stdcall calling 120 convention from C. *) 121 val x86_fastcall : int (** [x86_fastcall] is the familiar fastcall calling 122 convention from C. *) 123end 124 125module Attribute : sig 126 type t = 127 | Zext 128 | Sext 129 | Noreturn 130 | Inreg 131 | Structret 132 | Nounwind 133 | Noalias 134 | Byval 135 | Nest 136 | Readnone 137 | Readonly 138 | Noinline 139 | Alwaysinline 140 | Optsize 141 | Ssp 142 | Sspreq 143 | Nocapture 144 | Noredzone 145 | Noimplicitfloat 146 | Naked 147 | Inlinehint 148end 149 150(** The predicate for an integer comparison ([icmp]) instruction. 151 See the [llvm::ICmpInst::Predicate] enumeration. *) 152module Icmp : sig 153 type t = 154 | Eq 155 | Ne 156 | Ugt 157 | Uge 158 | Ult 159 | Ule 160 | Sgt 161 | Sge 162 | Slt 163 | Sle 164end 165 166(** The predicate for a floating-point comparison ([fcmp]) instruction. 167 See the [llvm::FCmpInst::Predicate] enumeration. *) 168module Fcmp : sig 169 type t = 170 | False 171 | Oeq 172 | Ogt 173 | Oge 174 | Olt 175 | Ole 176 | One 177 | Ord 178 | Uno 179 | Ueq 180 | Ugt 181 | Uge 182 | Ult 183 | Ule 184 | Une 185 | True 186end 187 188 189(** {6 Iteration} *) 190 191(** [Before b] and [At_end a] specify positions from the start of the ['b] list 192 of [a]. [llpos] is used to specify positions in and for forward iteration 193 through the various value lists maintained by the LLVM IR. *) 194type ('a, 'b) llpos = 195| At_end of 'a 196| Before of 'b 197 198(** [After b] and [At_start a] specify positions from the end of the ['b] list 199 of [a]. [llrev_pos] is used for reverse iteration through the various value 200 lists maintained by the LLVM IR. *) 201type ('a, 'b) llrev_pos = 202| At_start of 'a 203| After of 'b 204 205 206(** {6 Exceptions} *) 207 208exception IoError of string 209 210 211(** {6 Contexts} *) 212 213(** [create_context ()] creates a context for storing the "global" state in 214 LLVM. See the constructor [llvm::LLVMContext]. *) 215external create_context : unit -> llcontext = "llvm_create_context" 216 217(** [destroy_context ()] destroys a context. See the destructor 218 [llvm::LLVMContext::~LLVMContext]. *) 219external dispose_context : llcontext -> unit = "llvm_dispose_context" 220 221(** See the function [llvm::getGlobalContext]. *) 222external global_context : unit -> llcontext = "llvm_global_context" 223 224(** [mdkind_id context name] returns the MDKind ID that corresponds to the 225 name [name] in the context [context]. See the function 226 [llvm::LLVMContext::getMDKindID]. *) 227external mdkind_id : llcontext -> string -> int = "llvm_mdkind_id" 228 229 230(** {6 Modules} *) 231 232(** [create_module context id] creates a module with the supplied module ID in 233 the context [context]. Modules are not garbage collected; it is mandatory 234 to call {!dispose_module} to free memory. See the constructor 235 [llvm::Module::Module]. *) 236external create_module : llcontext -> string -> llmodule = "llvm_create_module" 237 238(** [dispose_module m] destroys a module [m] and all of the IR objects it 239 contained. All references to subordinate objects are invalidated; 240 referencing them will invoke undefined behavior. See the destructor 241 [llvm::Module::~Module]. *) 242external dispose_module : llmodule -> unit = "llvm_dispose_module" 243 244(** [target_triple m] is the target specifier for the module [m], something like 245 [i686-apple-darwin8]. See the method [llvm::Module::getTargetTriple]. *) 246external target_triple: llmodule -> string 247 = "llvm_target_triple" 248 249(** [target_triple triple m] changes the target specifier for the module [m] to 250 the string [triple]. See the method [llvm::Module::setTargetTriple]. *) 251external set_target_triple: string -> llmodule -> unit 252 = "llvm_set_target_triple" 253 254(** [data_layout m] is the data layout specifier for the module [m], something 255 like [e-p:32:32:32-i1:8:8-i8:8:8-i16:16:16-...-a0:0:64-f80:128:128]. See the 256 method [llvm::Module::getDataLayout]. *) 257external data_layout: llmodule -> string 258 = "llvm_data_layout" 259 260(** [set_data_layout s m] changes the data layout specifier for the module [m] 261 to the string [s]. See the method [llvm::Module::setDataLayout]. *) 262external set_data_layout: string -> llmodule -> unit 263 = "llvm_set_data_layout" 264 265(** [define_type_name name ty m] adds a named type to the module's symbol table. 266 Returns [true] if successful. If such a name already exists, then no entry 267 is added and [false] is returned. See the [llvm::Module::addTypeName] 268 method. *) 269external define_type_name : string -> lltype -> llmodule -> bool 270 = "llvm_add_type_name" 271 272(** [delete_type_name name] removes a type name from the module's symbol 273 table. *) 274external delete_type_name : string -> llmodule -> unit 275 = "llvm_delete_type_name" 276 277(** [dump_module m] prints the .ll representation of the module [m] to standard 278 error. See the method [llvm::Module::dump]. *) 279external dump_module : llmodule -> unit = "llvm_dump_module" 280 281 282(** {6 Types} *) 283 284(** [classify_type ty] returns the {!TypeKind.t} corresponding to the type [ty]. 285 See the method [llvm::Type::getTypeID]. *) 286external classify_type : lltype -> TypeKind.t = "llvm_classify_type" 287 288(** [type_context ty] returns the {!llcontext} corresponding to the type [ty]. 289 See the method [llvm::Type::getContext]. *) 290external type_context : lltype -> llcontext = "llvm_type_context" 291 292(** [string_of_lltype ty] returns a string describing the type [ty]. *) 293val string_of_lltype : lltype -> string 294 295(** {7 Operations on integer types} *) 296 297(** [i1_type c] returns an integer type of bitwidth 1 in the context [c]. See 298 [llvm::Type::Int1Ty]. *) 299external i1_type : llcontext -> lltype = "llvm_i1_type" 300 301(** [i8_type c] returns an integer type of bitwidth 8 in the context [c]. See 302 [llvm::Type::Int8Ty]. *) 303external i8_type : llcontext -> lltype = "llvm_i8_type" 304 305(** [i16_type c] returns an integer type of bitwidth 16 in the context [c]. See 306 [llvm::Type::Int16Ty]. *) 307external i16_type : llcontext -> lltype = "llvm_i16_type" 308 309(** [i32_type c] returns an integer type of bitwidth 32 in the context [c]. See 310 [llvm::Type::Int32Ty]. *) 311external i32_type : llcontext -> lltype = "llvm_i32_type" 312 313(** [i64_type c] returns an integer type of bitwidth 64 in the context [c]. See 314 [llvm::Type::Int64Ty]. *) 315external i64_type : llcontext -> lltype = "llvm_i64_type" 316 317(** [integer_type c n] returns an integer type of bitwidth [n] in the context 318 [c]. See the method [llvm::IntegerType::get]. *) 319external integer_type : llcontext -> int -> lltype = "llvm_integer_type" 320 321(** [integer_bitwidth c ty] returns the number of bits in the integer type [ty] 322 in the context [c]. See the method [llvm::IntegerType::getBitWidth]. *) 323external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth" 324 325 326(** {7 Operations on real types} *) 327 328(** [float_type c] returns the IEEE 32-bit floating point type in the context 329 [c]. See [llvm::Type::FloatTy]. *) 330external float_type : llcontext -> lltype = "llvm_float_type" 331 332(** [double_type c] returns the IEEE 64-bit floating point type in the context 333 [c]. See [llvm::Type::DoubleTy]. *) 334external double_type : llcontext -> lltype = "llvm_double_type" 335 336(** [x86fp80_type c] returns the x87 80-bit floating point type in the context 337 [c]. See [llvm::Type::X86_FP80Ty]. *) 338external x86fp80_type : llcontext -> lltype = "llvm_x86fp80_type" 339 340(** [fp128_type c] returns the IEEE 128-bit floating point type in the context 341 [c]. See [llvm::Type::FP128Ty]. *) 342external fp128_type : llcontext -> lltype = "llvm_fp128_type" 343 344(** [ppc_fp128_type c] returns the PowerPC 128-bit floating point type in the 345 context [c]. See [llvm::Type::PPC_FP128Ty]. *) 346external ppc_fp128_type : llcontext -> lltype = "llvm_ppc_fp128_type" 347 348 349(** {7 Operations on function types} *) 350 351(** [function_type ret_ty param_tys] returns the function type returning 352 [ret_ty] and taking [param_tys] as parameters. 353 See the method [llvm::FunctionType::get]. *) 354external function_type : lltype -> lltype array -> lltype = "llvm_function_type" 355 356(** [va_arg_function_type ret_ty param_tys] is just like 357 [function_type ret_ty param_tys] except that it returns the function type 358 which also takes a variable number of arguments. 359 See the method [llvm::FunctionType::get]. *) 360external var_arg_function_type : lltype -> lltype array -> lltype 361 = "llvm_var_arg_function_type" 362 363(** [is_var_arg fty] returns [true] if [fty] is a varargs function type, [false] 364 otherwise. See the method [llvm::FunctionType::isVarArg]. *) 365external is_var_arg : lltype -> bool = "llvm_is_var_arg" 366 367(** [return_type fty] gets the return type of the function type [fty]. 368 See the method [llvm::FunctionType::getReturnType]. *) 369external return_type : lltype -> lltype = "LLVMGetReturnType" 370 371(** [param_types fty] gets the parameter types of the function type [fty]. 372 See the method [llvm::FunctionType::getParamType]. *) 373external param_types : lltype -> lltype array = "llvm_param_types" 374 375 376(** {7 Operations on struct types} *) 377 378(** [struct_type context tys] returns the structure type in the context 379 [context] containing in the types in the array [tys]. See the method 380 [llvm::StructType::get]. *) 381external struct_type : llcontext -> lltype array -> lltype 382 = "llvm_struct_type" 383 384(** [packed_struct_type context ys] returns the packed structure type in the 385 context [context] containing in the types in the array [tys]. See the method 386 [llvm::StructType::get]. *) 387external packed_struct_type : llcontext -> lltype array -> lltype 388 = "llvm_packed_struct_type" 389 390(** [struct_element_types sty] returns the constituent types of the struct type 391 [sty]. See the method [llvm::StructType::getElementType]. *) 392external struct_element_types : lltype -> lltype array 393 = "llvm_struct_element_types" 394 395(** [is_packed sty] returns [true] if the structure type [sty] is packed, 396 [false] otherwise. See the method [llvm::StructType::isPacked]. *) 397external is_packed : lltype -> bool = "llvm_is_packed" 398 399 400(** {7 Operations on union types} *) 401 402(** [union_type context tys] returns the union type in the context [context] 403 containing the types in the array [tys]. See the method 404 [llvm::UnionType::get] *) 405external union_type : llcontext -> lltype array -> lltype = "llvm_union_type" 406 407(** [union_element_types uty] returns the constituent types of the union type 408 [uty]. See the method [llvm::UnionType::getElementType]. *) 409external union_element_types : lltype -> lltype array 410 = "llvm_union_element_types" 411 412 413(** {7 Operations on pointer, vector, and array types} *) 414 415(** [array_type ty n] returns the array type containing [n] elements of type 416 [ty]. See the method [llvm::ArrayType::get]. *) 417external array_type : lltype -> int -> lltype = "llvm_array_type" 418 419(** [pointer_type ty] returns the pointer type referencing objects of type 420 [ty] in the default address space (0). 421 See the method [llvm::PointerType::getUnqual]. *) 422external pointer_type : lltype -> lltype = "llvm_pointer_type" 423 424(** [qualified_pointer_type ty as] returns the pointer type referencing objects 425 of type [ty] in address space [as]. 426 See the method [llvm::PointerType::get]. *) 427external qualified_pointer_type : lltype -> int -> lltype 428 = "llvm_qualified_pointer_type" 429 430(** [vector_type ty n] returns the array type containing [n] elements of the 431 primitive type [ty]. See the method [llvm::ArrayType::get]. *) 432external vector_type : lltype -> int -> lltype = "llvm_vector_type" 433 434(** [element_type ty] returns the element type of the pointer, vector, or array 435 type [ty]. See the method [llvm::SequentialType::get]. *) 436external element_type : lltype -> lltype = "LLVMGetElementType" 437 438(** [element_type aty] returns the element count of the array type [aty]. 439 See the method [llvm::ArrayType::getNumElements]. *) 440external array_length : lltype -> int = "llvm_array_length" 441 442(** [address_space pty] returns the address space qualifier of the pointer type 443 [pty]. See the method [llvm::PointerType::getAddressSpace]. *) 444external address_space : lltype -> int = "llvm_address_space" 445 446(** [element_type ty] returns the element count of the vector type [ty]. 447 See the method [llvm::VectorType::getNumElements]. *) 448external vector_size : lltype -> int = "llvm_vector_size" 449 450 451(** {7 Operations on other types} *) 452 453(** [opaque_type c] creates a new opaque type distinct from any other in the 454 context [c]. Opaque types are useful for building recursive types in 455 combination with {!refine_type}. See [llvm::OpaqueType::get]. *) 456external opaque_type : llcontext -> lltype = "llvm_opaque_type" 457 458(** [void_type c] creates a type of a function which does not return any 459 value in the context [c]. See [llvm::Type::VoidTy]. *) 460external void_type : llcontext -> lltype = "llvm_void_type" 461 462(** [label_type c] creates a type of a basic block in the context [c]. See 463 [llvm::Type::LabelTy]. *) 464external label_type : llcontext -> lltype = "llvm_label_type" 465 466(** {7 Operations on type handles} *) 467 468(** [handle_to_type ty] creates a handle to the type [ty]. If [ty] is later 469 refined as a result of a call to {!refine_type}, the handle will be updated; 470 any bare [lltype] references will become invalid. 471 See the class [llvm::PATypeHolder]. *) 472external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type" 473 474(** [type_of_handle tyh] resolves the type handle [tyh]. 475 See the method [llvm::PATypeHolder::get()]. *) 476external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle" 477 478(** [refine_type opaque_ty ty] replaces the abstract type [opaque_ty] with the 479 concrete type [ty] in all users. Warning: This may invalidate {!lltype} 480 values! Use {!lltypehandle} to manipulate potentially abstract types. See 481 the method [llvm::Type::refineAbstractType]. *) 482external refine_type : lltype -> lltype -> unit = "llvm_refine_type" 483 484 485(* {6 Values} *) 486 487(** [type_of v] returns the type of the value [v]. 488 See the method [llvm::Value::getType]. *) 489external type_of : llvalue -> lltype = "llvm_type_of" 490 491(** [value_name v] returns the name of the value [v]. For global values, this is 492 the symbol name. For instructions and basic blocks, it is the SSA register 493 name. It is meaningless for constants. 494 See the method [llvm::Value::getName]. *) 495external value_name : llvalue -> string = "llvm_value_name" 496 497(** [set_value_name n v] sets the name of the value [v] to [n]. See the method 498 [llvm::Value::setName]. *) 499external set_value_name : string -> llvalue -> unit = "llvm_set_value_name" 500 501(** [dump_value v] prints the .ll representation of the value [v] to standard 502 error. See the method [llvm::Value::dump]. *) 503external dump_value : llvalue -> unit = "llvm_dump_value" 504 505 506(** {7 Operations on constants of (mostly) any type} *) 507 508(** [is_constant v] returns [true] if the value [v] is a constant, [false] 509 otherwise. Similar to [llvm::isa<Constant>]. *) 510external is_constant : llvalue -> bool = "llvm_is_constant" 511 512(** [const_null ty] returns the constant null (zero) of the type [ty]. 513 See the method [llvm::Constant::getNullValue]. *) 514external const_null : lltype -> llvalue = "LLVMConstNull" 515 516(** [const_all_ones ty] returns the constant '-1' of the integer or vector type 517 [ty]. See the method [llvm::Constant::getAllOnesValue]. *) 518external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes" 519 520(** [undef ty] returns the undefined value of the type [ty]. 521 See the method [llvm::UndefValue::get]. *) 522external undef : lltype -> llvalue = "LLVMGetUndef" 523 524(** [is_null v] returns [true] if the value [v] is the null (zero) value. 525 See the method [llvm::Constant::isNullValue]. *) 526external is_null : llvalue -> bool = "llvm_is_null" 527 528(** [is_undef v] returns [true] if the value [v] is an undefined value, [false] 529 otherwise. Similar to [llvm::isa<UndefValue>]. *) 530external is_undef : llvalue -> bool = "llvm_is_undef" 531 532 533(** {7 Operations on instructions} *) 534 535(** [has_metadata i] returns whether or not the instruction [i] has any 536 metadata attached to it. See the function 537 [llvm::Instruction::hasMetadata]. *) 538external has_metadata : llvalue -> bool = "llvm_has_metadata" 539 540(** [metadata i kind] optionally returns the metadata associated with the 541 kind [kind] in the instruction [i] See the function 542 [llvm::Instruction::getMetadata]. *) 543external metadata : llvalue -> int -> llvalue option = "llvm_metadata" 544 545(** [set_metadata i kind md] sets the metadata [md] of kind [kind] in the 546 instruction [i]. See the function [llvm::Instruction::setMetadata]. *) 547external set_metadata : llvalue -> int -> llvalue -> unit = "llvm_set_metadata" 548 549(** [clear_metadata i kind] clears the metadata of kind [kind] in the 550 instruction [i]. See the function [llvm::Instruction::setMetadata]. *) 551external clear_metadata : llvalue -> int -> unit = "llvm_clear_metadata" 552 553 554(** {7 Operations on metadata} *) 555 556(** [mdstring c s] returns the MDString of the string [s] in the context [c]. 557 See the method [llvm::MDNode::get]. *) 558external mdstring : llcontext -> string -> llvalue = "llvm_mdstring" 559 560(** [mdnode c elts] returns the MDNode containing the values [elts] in the 561 context [c]. 562 See the method [llvm::MDNode::get]. *) 563external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode" 564 565 566(** {7 Operations on scalar constants} *) 567 568(** [const_int ty i] returns the integer constant of type [ty] and value [i]. 569 See the method [llvm::ConstantInt::get]. *) 570external const_int : lltype -> int -> llvalue = "llvm_const_int" 571 572(** [const_of_int64 ty i] returns the integer constant of type [ty] and value 573 [i]. See the method [llvm::ConstantInt::get]. *) 574external const_of_int64 : lltype -> Int64.t -> bool -> llvalue 575 = "llvm_const_of_int64" 576 577(** [const_int_of_string ty s r] returns the integer constant of type [ty] and 578 * value [s], with the radix [r]. See the method [llvm::ConstantInt::get]. *) 579external const_int_of_string : lltype -> string -> int -> llvalue 580 = "llvm_const_int_of_string" 581 582(** [const_float ty n] returns the floating point constant of type [ty] and 583 value [n]. See the method [llvm::ConstantFP::get]. *) 584external const_float : lltype -> float -> llvalue = "llvm_const_float" 585 586(** [const_float_of_string ty s] returns the floating point constant of type 587 [ty] and value [n]. See the method [llvm::ConstantFP::get]. *) 588external const_float_of_string : lltype -> string -> llvalue 589 = "llvm_const_float_of_string" 590 591 592(** {7 Operations on composite constants} *) 593 594(** [const_string c s] returns the constant [i8] array with the values of the 595 characters in the string [s] in the context [c]. The array is not 596 null-terminated (but see {!const_stringz}). This value can in turn be used 597 as the initializer for a global variable. See the method 598 [llvm::ConstantArray::get]. *) 599external const_string : llcontext -> string -> llvalue = "llvm_const_string" 600 601(** [const_stringz c s] returns the constant [i8] array with the values of the 602 characters in the string [s] and a null terminator in the context [c]. This 603 value can in turn be used as the initializer for a global variable. 604 See the method [llvm::ConstantArray::get]. *) 605external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz" 606 607(** [const_array ty elts] returns the constant array of type 608 [array_type ty (Array.length elts)] and containing the values [elts]. 609 This value can in turn be used as the initializer for a global variable. 610 See the method [llvm::ConstantArray::get]. *) 611external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array" 612 613(** [const_struct context elts] returns the structured constant of type 614 [struct_type (Array.map type_of elts)] and containing the values [elts] 615 in the context [context]. This value can in turn be used as the initializer 616 for a global variable. See the method [llvm::ConstantStruct::get]. *) 617external const_struct : llcontext -> llvalue array -> llvalue 618 = "llvm_const_struct" 619 620(** [const_packed_struct context elts] returns the structured constant of 621 type {!packed_struct_type} [(Array.map type_of elts)] and containing the 622 values [elts] in the context [context]. This value can in turn be used as 623 the initializer for a global variable. See the method 624 [llvm::ConstantStruct::get]. *) 625external const_packed_struct : llcontext -> llvalue array -> llvalue 626 = "llvm_const_packed_struct" 627 628(** [const_vector elts] returns the vector constant of type 629 [vector_type (type_of elts.(0)) (Array.length elts)] and containing the 630 values [elts]. See the method [llvm::ConstantVector::get]. *) 631external const_vector : llvalue array -> llvalue = "llvm_const_vector" 632 633(** [const_union ty v] returns the union constant of type [union_type tys] and 634 containing the value [v]. See the method [llvm::ConstantUnion::get]. *) 635external const_union : lltype -> llvalue -> llvalue = "LLVMConstUnion" 636 637 638(** {7 Constant expressions} *) 639 640(** [align_of ty] returns the alignof constant for the type [ty]. This is 641 equivalent to [const_ptrtoint (const_gep (const_null (pointer_type {i8,ty})) 642 (const_int i32_type 0) (const_int i32_type 1)) i32_type], but considerably 643 more readable. See the method [llvm::ConstantExpr::getAlignOf]. *) 644external align_of : lltype -> llvalue = "LLVMAlignOf" 645 646(** [size_of ty] returns the sizeof constant for the type [ty]. This is 647 equivalent to [const_ptrtoint (const_gep (const_null (pointer_type ty)) 648 (const_int i32_type 1)) i64_type], but considerably more readable. 649 See the method [llvm::ConstantExpr::getSizeOf]. *) 650external size_of : lltype -> llvalue = "LLVMSizeOf" 651 652(** [const_neg c] returns the arithmetic negation of the constant [c]. 653 See the method [llvm::ConstantExpr::getNeg]. *) 654external const_neg : llvalue -> llvalue = "LLVMConstNeg" 655 656(** [const_nsw_neg c] returns the arithmetic negation of the constant [c] with 657 no signed wrapping. The result is undefined if the negation overflows. 658 See the method [llvm::ConstantExpr::getNSWNeg]. *) 659external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg" 660 661(** [const_nuw_neg c] returns the arithmetic negation of the constant [c] with 662 no unsigned wrapping. The result is undefined if the negation overflows. 663 See the method [llvm::ConstantExpr::getNUWNeg]. *) 664external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg" 665 666(** [const_fneg c] returns the arithmetic negation of the constant float [c]. 667 See the method [llvm::ConstantExpr::getFNeg]. *) 668external const_fneg : llvalue -> llvalue = "LLVMConstFNeg" 669 670(** [const_not c] returns the bitwise inverse of the constant [c]. 671 See the method [llvm::ConstantExpr::getNot]. *) 672external const_not : llvalue -> llvalue = "LLVMConstNot" 673 674(** [const_add c1 c2] returns the constant sum of two constants. 675 See the method [llvm::ConstantExpr::getAdd]. *) 676external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd" 677 678(** [const_nsw_add c1 c2] returns the constant sum of two constants with no 679 signed wrapping. The result is undefined if the sum overflows. 680 See the method [llvm::ConstantExpr::getNSWAdd]. *) 681external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd" 682 683(** [const_nuw_add c1 c2] returns the constant sum of two constants with no 684 unsigned wrapping. The result is undefined if the sum overflows. 685 See the method [llvm::ConstantExpr::getNSWAdd]. *) 686external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd" 687 688(** [const_fadd c1 c2] returns the constant sum of two constant floats. 689 See the method [llvm::ConstantExpr::getFAdd]. *) 690external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd" 691 692(** [const_sub c1 c2] returns the constant difference, [c1 - c2], of two 693 constants. See the method [llvm::ConstantExpr::getSub]. *) 694external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub" 695 696(** [const_nsw_sub c1 c2] returns the constant difference of two constants with 697 no signed wrapping. The result is undefined if the sum overflows. 698 See the method [llvm::ConstantExpr::getNSWSub]. *) 699external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub" 700 701(** [const_nuw_sub c1 c2] returns the constant difference of two constants with 702 no unsigned wrapping. The result is undefined if the sum overflows. 703 See the method [llvm::ConstantExpr::getNSWSub]. *) 704external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub" 705 706(** [const_fsub c1 c2] returns the constant difference, [c1 - c2], of two 707 constant floats. See the method [llvm::ConstantExpr::getFSub]. *) 708external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub" 709 710(** [const_mul c1 c2] returns the constant product of two constants. 711 See the method [llvm::ConstantExpr::getMul]. *) 712external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul" 713 714(** [const_nsw_mul c1 c2] returns the constant product of two constants with 715 no signed wrapping. The result is undefined if the sum overflows. 716 See the method [llvm::ConstantExpr::getNSWMul]. *) 717external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul" 718 719(** [const_nuw_mul c1 c2] returns the constant product of two constants with 720 no unsigned wrapping. The result is undefined if the sum overflows. 721 See the method [llvm::ConstantExpr::getNSWMul]. *) 722external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul" 723 724(** [const_fmul c1 c2] returns the constant product of two constants floats. 725 See the method [llvm::ConstantExpr::getFMul]. *) 726external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul" 727 728(** [const_udiv c1 c2] returns the constant quotient [c1 / c2] of two unsigned 729 integer constants. 730 See the method [llvm::ConstantExpr::getUDiv]. *) 731external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv" 732 733(** [const_sdiv c1 c2] returns the constant quotient [c1 / c2] of two signed 734 integer constants. 735 See the method [llvm::ConstantExpr::getSDiv]. *) 736external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv" 737 738(** [const_exact_sdiv c1 c2] returns the constant quotient [c1 / c2] of two 739 signed integer constants. The result is undefined if the result is rounded 740 or overflows. See the method [llvm::ConstantExpr::getExactSDiv]. *) 741external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv" 742 743(** [const_fdiv c1 c2] returns the constant quotient [c1 / c2] of two floating 744 point constants. 745 See the method [llvm::ConstantExpr::getFDiv]. *) 746external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv" 747 748(** [const_urem c1 c2] returns the constant remainder [c1 MOD c2] of two 749 unsigned integer constants. 750 See the method [llvm::ConstantExpr::getURem]. *) 751external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem" 752 753(** [const_srem c1 c2] returns the constant remainder [c1 MOD c2] of two 754 signed integer constants. 755 See the method [llvm::ConstantExpr::getSRem]. *) 756external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem" 757 758(** [const_frem c1 c2] returns the constant remainder [c1 MOD c2] of two 759 signed floating point constants. 760 See the method [llvm::ConstantExpr::getFRem]. *) 761external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem" 762 763(** [const_and c1 c2] returns the constant bitwise [AND] of two integer 764 constants. 765 See the method [llvm::ConstantExpr::getAnd]. *) 766external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd" 767 768(** [const_or c1 c2] returns the constant bitwise [OR] of two integer 769 constants. 770 See the method [llvm::ConstantExpr::getOr]. *) 771external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr" 772 773(** [const_xor c1 c2] returns the constant bitwise [XOR] of two integer 774 constants. 775 See the method [llvm::ConstantExpr::getXor]. *) 776external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor" 777 778(** [const_icmp pred c1 c2] returns the constant comparison of two integer 779 constants, [c1 pred c2]. 780 See the method [llvm::ConstantExpr::getICmp]. *) 781external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue 782 = "llvm_const_icmp" 783 784(** [const_fcmp pred c1 c2] returns the constant comparison of two floating 785 point constants, [c1 pred c2]. 786 See the method [llvm::ConstantExpr::getFCmp]. *) 787external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue 788 = "llvm_const_fcmp" 789 790(** [const_shl c1 c2] returns the constant integer [c1] left-shifted by the 791 constant integer [c2]. 792 See the method [llvm::ConstantExpr::getShl]. *) 793external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl" 794 795(** [const_lshr c1 c2] returns the constant integer [c1] right-shifted by the 796 constant integer [c2] with zero extension. 797 See the method [llvm::ConstantExpr::getLShr]. *) 798external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr" 799 800(** [const_ashr c1 c2] returns the constant integer [c1] right-shifted by the 801 constant integer [c2] with sign extension. 802 See the method [llvm::ConstantExpr::getAShr]. *) 803external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr" 804 805(** [const_gep pc indices] returns the constant [getElementPtr] of [p1] with the 806 constant integers indices from the array [indices]. 807 See the method [llvm::ConstantExpr::getGetElementPtr]. *) 808external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep" 809 810(** [const_in_bounds_gep pc indices] returns the constant [getElementPtr] of [p1] 811 with the constant integers indices from the array [indices]. 812 See the method [llvm::ConstantExpr::getInBoundsGetElementPtr]. *) 813external const_in_bounds_gep : llvalue -> llvalue array -> llvalue 814 = "llvm_const_in_bounds_gep" 815 816(** [const_trunc c ty] returns the constant truncation of integer constant [c] 817 to the smaller integer type [ty]. 818 See the method [llvm::ConstantExpr::getTrunc]. *) 819external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc" 820 821(** [const_sext c ty] returns the constant sign extension of integer constant 822 [c] to the larger integer type [ty]. 823 See the method [llvm::ConstantExpr::getSExt]. *) 824external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt" 825 826(** [const_zext c ty] returns the constant zero extension of integer constant 827 [c] to the larger integer type [ty]. 828 See the method [llvm::ConstantExpr::getZExt]. *) 829external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt" 830 831(** [const_fptrunc c ty] returns the constant truncation of floating point 832 constant [c] to the smaller floating point type [ty]. 833 See the method [llvm::ConstantExpr::getFPTrunc]. *) 834external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc" 835 836(** [const_fpext c ty] returns the constant extension of floating point constant 837 [c] to the larger floating point type [ty]. 838 See the method [llvm::ConstantExpr::getFPExt]. *) 839external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt" 840 841(** [const_uitofp c ty] returns the constant floating point conversion of 842 unsigned integer constant [c] to the floating point type [ty]. 843 See the method [llvm::ConstantExpr::getUIToFP]. *) 844external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP" 845 846(** [const_sitofp c ty] returns the constant floating point conversion of 847 signed integer constant [c] to the floating point type [ty]. 848 See the method [llvm::ConstantExpr::getSIToFP]. *) 849external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP" 850 851(** [const_fptoui c ty] returns the constant unsigned integer conversion of 852 floating point constant [c] to integer type [ty]. 853 See the method [llvm::ConstantExpr::getFPToUI]. *) 854external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI" 855 856(** [const_fptoui c ty] returns the constant unsigned integer conversion of 857 floating point constant [c] to integer type [ty]. 858 See the method [llvm::ConstantExpr::getFPToSI]. *) 859external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI" 860 861(** [const_ptrtoint c ty] returns the constant integer conversion of 862 pointer constant [c] to integer type [ty]. 863 See the method [llvm::ConstantExpr::getPtrToInt]. *) 864external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt" 865 866(** [const_inttoptr c ty] returns the constant pointer conversion of 867 integer constant [c] to pointer type [ty]. 868 See the method [llvm::ConstantExpr::getIntToPtr]. *) 869external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr" 870 871(** [const_bitcast c ty] returns the constant bitwise conversion of constant [c] 872 to type [ty] of equal size. 873 See the method [llvm::ConstantExpr::getBitCast]. *) 874external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast" 875 876(** [const_zext_or_bitcast c ty] returns a constant zext or bitwise cast 877 conversion of constant [c] to type [ty]. 878 See the method [llvm::ConstantExpr::getZExtOrBitCast]. *) 879external const_zext_or_bitcast : llvalue -> lltype -> llvalue 880 = "LLVMConstZExtOrBitCast" 881 882(** [const_sext_or_bitcast c ty] returns a constant sext or bitwise cast 883 conversion of constant [c] to type [ty]. 884 See the method [llvm::ConstantExpr::getSExtOrBitCast]. *) 885external const_sext_or_bitcast : llvalue -> lltype -> llvalue 886 = "LLVMConstSExtOrBitCast" 887 888(** [const_trunc_or_bitcast c ty] returns a constant trunc or bitwise cast 889 conversion of constant [c] to type [ty]. 890 See the method [llvm::ConstantExpr::getTruncOrBitCast]. *) 891external const_trunc_or_bitcast : llvalue -> lltype -> llvalue 892 = "LLVMConstTruncOrBitCast" 893 894(** [const_pointercast c ty] returns a constant bitcast or a pointer-to-int 895 cast conversion of constant [c] to type [ty] of equal size. 896 See the method [llvm::ConstantExpr::getPointerCast]. *) 897external const_pointercast : llvalue -> lltype -> llvalue 898 = "LLVMConstPointerCast" 899 900(** [const_intcast c ty] returns a constant zext, bitcast, or trunc for integer 901 -> integer casts of constant [c] to type [ty]. 902 See the method [llvm::ConstantExpr::getIntCast]. *) 903external const_intcast : llvalue -> lltype -> llvalue 904 = "LLVMConstIntCast" 905 906(** [const_fpcast c ty] returns a constant fpext, bitcast, or fptrunc for fp -> 907 fp casts of constant [c] to type [ty]. 908 See the method [llvm::ConstantExpr::getFPCast]. *) 909external const_fpcast : llvalue -> lltype -> llvalue 910 = "LLVMConstFPCast" 911 912(** [const_select cond t f] returns the constant conditional which returns value 913 [t] if the boolean constant [cond] is true and the value [f] otherwise. 914 See the method [llvm::ConstantExpr::getSelect]. *) 915external const_select : llvalue -> llvalue -> llvalue -> llvalue 916 = "LLVMConstSelect" 917 918(** [const_extractelement vec i] returns the constant [i]th element of 919 constant vector [vec]. [i] must be a constant [i32] value unsigned less than 920 the size of the vector. 921 See the method [llvm::ConstantExpr::getExtractElement]. *) 922external const_extractelement : llvalue -> llvalue -> llvalue 923 = "LLVMConstExtractElement" 924 925(** [const_insertelement vec v i] returns the constant vector with the same 926 elements as constant vector [v] but the [i]th element replaced by the 927 constant [v]. [v] must be a constant value with the type of the vector 928 elements. [i] must be a constant [i32] value unsigned less than the size 929 of the vector. 930 See the method [llvm::ConstantExpr::getInsertElement]. *) 931external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue 932 = "LLVMConstInsertElement" 933 934(** [const_shufflevector a b mask] returns a constant [shufflevector]. 935 See the LLVM Language Reference for details on the [sufflevector] 936 instruction. 937 See the method [llvm::ConstantExpr::getShuffleVector]. *) 938external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue 939 = "LLVMConstShuffleVector" 940 941(** [const_extractvalue agg idxs] returns the constant [idxs]th value of 942 constant aggregate [agg]. Each [idxs] must be less than the size of the 943 aggregate. See the method [llvm::ConstantExpr::getExtractValue]. *) 944external const_extractvalue : llvalue -> int array -> llvalue 945 = "llvm_const_extractvalue" 946 947(** [const_insertvalue agg val idxs] inserts the value [val] in the specified 948 indexs [idxs] in the aggegate [agg]. Each [idxs] must be less than the size 949 of the aggregate. See the method [llvm::ConstantExpr::getInsertValue]. *) 950external const_insertvalue : llvalue -> llvalue -> int array -> llvalue 951 = "llvm_const_insertvalue" 952 953(** [block_address f bb] returns the address of the basic block [bb] in the 954 function [f]. See the method [llvm::BasicBlock::get]. *) 955external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress" 956 957 958(** {7 Operations on global variables, functions, and aliases (globals)} *) 959 960(** [global_parent g] is the enclosing module of the global value [g]. 961 See the method [llvm::GlobalValue::getParent]. *) 962external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent" 963 964(** [is_declaration g] returns [true] if the global value [g] is a declaration 965 only. Returns [false] otherwise. 966 See the method [llvm::GlobalValue::isDeclaration]. *) 967external is_declaration : llvalue -> bool = "llvm_is_declaration" 968 969(** [linkage g] returns the linkage of the global value [g]. 970 See the method [llvm::GlobalValue::getLinkage]. *) 971external linkage : llvalue -> Linkage.t = "llvm_linkage" 972 973(** [set_linkage l g] sets the linkage of the global value [g] to [l]. 974 See the method [llvm::GlobalValue::setLinkage]. *) 975external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage" 976 977(** [section g] returns the linker section of the global value [g]. 978 See the method [llvm::GlobalValue::getSection]. *) 979external section : llvalue -> string = "llvm_section" 980 981(** [set_section s g] sets the linker section of the global value [g] to [s]. 982 See the method [llvm::GlobalValue::setSection]. *) 983external set_section : string -> llvalue -> unit = "llvm_set_section" 984 985(** [visibility g] returns the linker visibility of the global value [g]. 986 See the method [llvm::GlobalValue::getVisibility]. *) 987external visibility : llvalue -> Visibility.t = "llvm_visibility" 988 989(** [set_visibility v g] sets the linker visibility of the global value [g] to 990 [v]. See the method [llvm::GlobalValue::setVisibility]. *) 991external set_visibility : Visibility.t -> llvalue -> unit 992 = "llvm_set_visibility" 993 994(** [alignment g] returns the required alignment of the global value [g]. 995 See the method [llvm::GlobalValue::getAlignment]. *) 996external alignment : llvalue -> int = "llvm_alignment" 997 998(** [set_alignment n g] sets the required alignment of the global value [g] to 999 [n] bytes. See the method [llvm::GlobalValue::setAlignment]. *) 1000external set_alignment : int -> llvalue -> unit = "llvm_set_alignment" 1001 1002 1003(** {7 Operations on global variables} *) 1004 1005(** [declare_global ty name m] returns a new global variable of type [ty] and 1006 with name [name] in module [m] in the default address space (0). If such a 1007 global variable already exists, it is returned. If the type of the existing 1008 global differs, then a bitcast to [ty] is returned. *) 1009external declare_global : lltype -> string -> llmodule -> llvalue 1010 = "llvm_declare_global" 1011 1012(** [declare_qualified_global ty name as m] returns a new global variable of 1013 type [ty] and with name [name] in module [m] in the address space [as]. If 1014 such a global variable already exists, it is returned. If the type of the 1015 existing global differs, then a bitcast to [ty] is returned. *) 1016external declare_qualified_global : lltype -> string -> int -> llmodule -> 1017 llvalue 1018 = "llvm_declare_qualified_global" 1019 1020(** [define_global name init m] returns a new global with name [name] and 1021 initializer [init] in module [m] in the default address space (0). If the 1022 named global already exists, it is renamed. 1023 See the constructor of [llvm::GlobalVariable]. *) 1024external define_global : string -> llvalue -> llmodule -> llvalue 1025 = "llvm_define_global" 1026 1027(** [define_qualified_global name init as m] returns a new global with name 1028 [name] and initializer [init] in module [m] in the address space [as]. If 1029 the named global already exists, it is renamed. 1030 See the constructor of [llvm::GlobalVariable]. *) 1031external define_qualified_global : string -> llvalue -> int -> llmodule -> 1032 llvalue 1033 = "llvm_define_qualified_global" 1034 1035(** [lookup_global name m] returns [Some g] if a global variable with name 1036 [name] exists in module [m]. If no such global exists, returns [None]. 1037 See the [llvm::GlobalVariable] constructor. *) 1038external lookup_global : string -> llmodule -> llvalue option 1039 = "llvm_lookup_global" 1040 1041(** [delete_global gv] destroys the global variable [gv]. 1042 See the method [llvm::GlobalVariable::eraseFromParent]. *) 1043external delete_global : llvalue -> unit = "llvm_delete_global" 1044 1045(** [global_begin m] returns the first position in the global variable list of 1046 the module [m]. [global_begin] and [global_succ] can be used to iterate 1047 over the global list in order. 1048 See the method [llvm::Module::global_begin]. *) 1049external global_begin : llmodule -> (llmodule, llvalue) llpos 1050 = "llvm_global_begin" 1051 1052(** [global_succ gv] returns the global variable list position succeeding 1053 [Before gv]. 1054 See the method [llvm::Module::global_iterator::operator++]. *) 1055external global_succ : llvalue -> (llmodule, llvalue) llpos 1056 = "llvm_global_succ" 1057 1058(** [iter_globals f m] applies function [f] to each of the global variables of 1059 module [m] in order. Tail recursive. *) 1060val iter_globals : (llvalue -> unit) -> llmodule -> unit 1061 1062(** [fold_left_globals f init m] is [f (... (f init g1) ...) gN] where 1063 [g1,...,gN] are the global variables of module [m]. Tail recursive. *) 1064val fold_left_globals : ('a -> llvalue -> 'a) -> 'a -> llmodule -> 'a 1065 1066(** [global_end m] returns the last position in the global variable list of the 1067 module [m]. [global_end] and [global_pred] can be used to iterate over the 1068 global list in reverse. 1069 See the method [llvm::Module::global_end]. *) 1070external global_end : llmodule -> (llmodule, llvalue) llrev_pos 1071 = "llvm_global_end" 1072 1073(** [global_pred gv] returns the global variable list position preceding 1074 [After gv]. 1075 See the method [llvm::Module::global_iterator::operator--]. *) 1076external global_pred : llvalue -> (llmodule, llvalue) llrev_pos 1077 = "llvm_global_pred" 1078 1079(** [rev_iter_globals f m] applies function [f] to each of the global variables 1080 of module [m] in reverse order. Tail recursive. *) 1081val rev_iter_globals : (llvalue -> unit) -> llmodule -> unit 1082 1083(** [fold_right_globals f m init] is [f g1 (... (f gN init) ...)] where 1084 [g1,...,gN] are the global variables of module [m]. Tail recursive. *) 1085val fold_right_globals : (llvalue -> 'a -> 'a) -> llmodule -> 'a -> 'a 1086 1087(** [is_global_constant gv] returns [true] if the global variabile [gv] is a 1088 constant. Returns [false] otherwise. 1089 See the method [llvm::GlobalVariable::isConstant]. *) 1090external is_global_constant : llvalue -> bool = "llvm_is_global_constant" 1091 1092(** [set_global_constant c gv] sets the global variable [gv] to be a constant if 1093 [c] is [true] and not if [c] is [false]. 1094 See the method [llvm::GlobalVariable::setConstant]. *) 1095external set_global_constant : bool -> llvalue -> unit 1096 = "llvm_set_global_constant" 1097 1098(** [global_initializer gv] returns the initializer for the global variable 1099 [gv]. See the method [llvm::GlobalVariable::getInitializer]. *) 1100external global_initializer : llvalue -> llvalue = "LLVMGetInitializer" 1101 1102(** [set_initializer c gv] sets the initializer for the global variable 1103 [gv] to the constant [c]. 1104 See the method [llvm::GlobalVariable::setInitializer]. *) 1105external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer" 1106 1107(** [remove_initializer gv] unsets the initializer for the global variable 1108 [gv]. 1109 See the method [llvm::GlobalVariable::setInitializer]. *) 1110external remove_initializer : llvalue -> unit = "llvm_remove_initializer" 1111 1112(** [is_thread_local gv] returns [true] if the global variable [gv] is 1113 thread-local and [false] otherwise. 1114 See the method [llvm::GlobalVariable::isThreadLocal]. *) 1115external is_thread_local : llvalue -> bool = "llvm_is_thread_local" 1116 1117(** [set_thread_local c gv] sets the global variable [gv] to be thread local if 1118 [c] is [true] and not otherwise. 1119 See the method [llvm::GlobalVariable::setThreadLocal]. *) 1120external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local" 1121 1122 1123(** {7 Operations on functions} *) 1124 1125(** [declare_function name ty m] returns a new function of type [ty] and 1126 with name [name] in module [m]. If such a function already exists, 1127 it is returned. If the type of the existing function differs, then a bitcast 1128 to [ty] is returned. *) 1129external declare_function : string -> lltype -> llmodule -> llvalue 1130 = "llvm_declare_function" 1131 1132(** [define_function name ty m] creates a new function with name [name] and 1133 type [ty] in module [m]. If the named function already exists, it is 1134 renamed. An entry basic block is created in the function. 1135 See the constructor of [llvm::GlobalVariable]. *) 1136external define_function : string -> lltype -> llmodule -> llvalue 1137 = "llvm_define_function" 1138 1139(** [lookup_function name m] returns [Some f] if a function with name 1140 [name] exists in module [m]. If no such function exists, returns [None]. 1141 See the method [llvm::Module] constructor. *) 1142external lookup_function : string -> llmodule -> llvalue option 1143 = "llvm_lookup_function" 1144 1145(** [delete_function f] destroys the function [f]. 1146 See the method [llvm::Function::eraseFromParent]. *) 1147external delete_function : llvalue -> unit = "llvm_delete_function" 1148 1149(** [function_begin m] returns the first position in the function list of the 1150 module [m]. [function_begin] and [function_succ] can be used to iterate over 1151 the function list in order. 1152 See the method [llvm::Module::begin]. *) 1153external function_begin : llmodule -> (llmodule, llvalue) llpos 1154 = "llvm_function_begin" 1155 1156(** [function_succ gv] returns the function list position succeeding 1157 [Before gv]. 1158 See the method [llvm::Module::iterator::operator++]. *) 1159external function_succ : llvalue -> (llmodule, llvalue) llpos 1160 = "llvm_function_succ" 1161 1162(** [iter_functions f m] applies function [f] to each of the functions of module 1163 [m] in order. Tail recursive. *) 1164val iter_functions : (llvalue -> unit) -> llmodule -> unit 1165 1166(** [fold_left_function f init m] is [f (... (f init f1) ...) fN] where 1167 [f1,...,fN] are the functions of module [m]. Tail recursive. *) 1168val fold_left_functions : ('a -> llvalue -> 'a) -> 'a -> llmodule -> 'a 1169 1170(** [function_end m] returns the last position in the function list of 1171 the module [m]. [function_end] and [function_pred] can be used to iterate 1172 over the function list in reverse. 1173 See the method [llvm::Module::end]. *) 1174external function_end : llmodule -> (llmodule, llvalue) llrev_pos 1175 = "llvm_function_end" 1176 1177(** [function_pred gv] returns the function list position preceding [After gv]. 1178 See the method [llvm::Module::iterator::operator--]. *) 1179external function_pred : llvalue -> (llmodule, llvalue) llrev_pos 1180 = "llvm_function_pred" 1181 1182(** [rev_iter_functions f fn] applies function [f] to each of the functions of 1183 module [m] in reverse order. Tail recursive. *) 1184val rev_iter_functions : (llvalue -> unit) -> llmodule -> unit 1185 1186(** [fold_right_functions f m init] is [f (... (f init fN) ...) f1] where 1187 [f1,...,fN] are the functions of module [m]. Tail recursive. *) 1188val fold_right_functions : (llvalue -> 'a -> 'a) -> llmodule -> 'a -> 'a 1189 1190(** [is_intrinsic f] returns true if the function [f] is an intrinsic. 1191 See the method [llvm::Function::isIntrinsic]. *) 1192external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic" 1193 1194(** [function_call_conv f] returns the calling convention of the function [f]. 1195 See the method [llvm::Function::getCallingConv]. *) 1196external function_call_conv : llvalue -> int = "llvm_function_call_conv" 1197 1198(** [set_function_call_conv cc f] sets the calling convention of the function 1199 [f] to the calling convention numbered [cc]. 1200 See the method [llvm::Function::setCallingConv]. *) 1201external set_function_call_conv : int -> llvalue -> unit 1202 = "llvm_set_function_call_conv" 1203 1204(** [gc f] returns [Some name] if the function [f] has a garbage 1205 collection algorithm specified and [None] otherwise. 1206 See the method [llvm::Function::getGC]. *) 1207external gc : llvalue -> string option = "llvm_gc" 1208 1209(** [set_gc gc f] sets the collection algorithm for the function [f] to 1210 [gc]. See the method [llvm::Function::setGC]. *) 1211external set_gc : string option -> llvalue -> unit = "llvm_set_gc" 1212 1213(** [add_function_attr f a] adds attribute [a] to the return type of function 1214 [f]. *) 1215external add_function_attr : llvalue -> Attribute.t -> unit 1216 = "llvm_add_function_attr" 1217 1218(** [remove_function_attr f a] removes attribute [a] from the return type of 1219 function [f]. *) 1220external remove_function_attr : llvalue -> Attribute.t -> unit 1221 = "llvm_remove_function_attr" 1222 1223(** {7 Operations on params} *) 1224 1225(** [params f] returns the parameters of function [f]. 1226 See the method [llvm::Function::getArgumentList]. *) 1227external params : llvalue -> llvalue array = "llvm_params" 1228 1229(** [param f n] returns the [n]th parameter of function [f]. 1230 See the method [llvm::Function::getArgumentList]. *) 1231external param : llvalue -> int -> llvalue = "llvm_param" 1232 1233(** [param_parent p] returns the parent function that owns the parameter. 1234 See the method [llvm::Argument::getParent]. *) 1235external param_parent : llvalue -> llvalue = "LLVMGetParamParent" 1236 1237(** [param_begin f] returns the first position in the parameter list of the 1238 function [f]. [param_begin] and [param_succ] can be used to iterate over 1239 the parameter list in order. 1240 See the method [llvm::Function::arg_begin]. *) 1241external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin" 1242 1243(** [param_succ bb] returns the parameter list position succeeding 1244 [Before bb]. 1245 See the method [llvm::Function::arg_iterator::operator++]. *) 1246external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ" 1247 1248(** [iter_params f fn] applies function [f] to each of the parameters 1249 of function [fn] in order. Tail recursive. *) 1250val iter_params : (llvalue -> unit) -> llvalue -> unit 1251 1252(** [fold_left_params f init fn] is [f (... (f init b1) ...) bN] where 1253 [b1,...,bN] are the parameters of function [fn]. Tail recursive. *) 1254val fold_left_params : ('a -> llvalue -> 'a) -> 'a -> llvalue -> 'a 1255 1256(** [param_end f] returns the last position in the parameter list of 1257 the function [f]. [param_end] and [param_pred] can be used to iterate 1258 over the parameter list in reverse. 1259 See the method [llvm::Function::arg_end]. *) 1260external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end" 1261 1262(** [param_pred gv] returns the function list position preceding [After gv]. 1263 See the method [llvm::Function::arg_iterator::operator--]. *) 1264external param_pred : llvalue -> (llvalue, llvalue) llrev_pos 1265 = "llvm_param_pred" 1266 1267(** [rev_iter_params f fn] applies function [f] to each of the parameters 1268 of function [fn] in reverse order. Tail recursive. *) 1269val rev_iter_params : (llvalue -> unit) -> llvalue -> unit 1270 1271(** [fold_right_params f fn init] is [f (... (f init bN) ...) b1] where 1272 [b1,...,bN] are the parameters of function [fn]. Tail recursive. *) 1273val fold_right_params : (llvalue -> 'a -> 'a) -> llvalue -> 'a -> 'a 1274 1275(** [add_param p a] adds attribute [a] to parameter [p]. *) 1276external add_param_attr : llvalue -> Attribute.t -> unit = "llvm_add_param_attr" 1277 1278(** [remove_param_attr p a] removes attribute [a] from parameter [p]. *) 1279external remove_param_attr : llvalue -> Attribute.t -> unit 1280 = "llvm_remove_param_attr" 1281 1282(** [set_param_alignment p a] set the alignment of parameter [p] to [a]. *) 1283external set_param_alignment : llvalue -> int -> unit 1284 = "llvm_set_param_alignment" 1285 1286(** {7 Operations on basic blocks} *) 1287 1288(** [basic_blocks fn] returns the basic blocks of the function [f]. 1289 See the method [llvm::Function::getBasicBlockList]. *) 1290external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks" 1291 1292(** [entry_block fn] returns the entry basic block of the function [f]. 1293 See the method [llvm::Function::getEntryBlock]. *) 1294external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock" 1295 1296(** [delete_block bb] deletes the basic block [bb]. 1297 See the method [llvm::BasicBlock::eraseFromParent]. *) 1298external delete_block : llbasicblock -> unit = "llvm_delete_block" 1299 1300(** [append_block c name f] creates a new basic block named [name] at the end of 1301 function [f] in the context [c]. 1302 See the constructor of [llvm::BasicBlock]. *) 1303external append_block : llcontext -> string -> llvalue -> llbasicblock 1304 = "llvm_append_block" 1305 1306(** [insert_block c name bb] creates a new basic block named [name] before the 1307 basic block [bb] in the context [c]. 1308 See the constructor of [llvm::BasicBlock]. *) 1309external insert_block : llcontext -> string -> llbasicblock -> llbasicblock 1310 = "llvm_insert_block" 1311 1312(** [block_parent bb] returns the parent function that owns the basic block. 1313 See the method [llvm::BasicBlock::getParent]. *) 1314external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent" 1315 1316(** [block_begin f] returns the first position in the basic block list of the 1317 function [f]. [block_begin] and [block_succ] can be used to iterate over 1318 the basic block list in order. 1319 See the method [llvm::Function::begin]. *) 1320external block_begin : llvalue -> (llvalue, llbasicblock) llpos 1321 = "llvm_block_begin" 1322 1323(** [block_succ bb] returns the basic block list position succeeding 1324 [Before bb]. 1325 See the method [llvm::Function::iterator::operator++]. *) 1326external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos 1327 = "llvm_block_succ" 1328 1329(** [iter_blocks f fn] applies function [f] to each of the basic blocks 1330 of function [fn] in order. Tail recursive. *) 1331val iter_blocks : (llbasicblock -> unit) -> llvalue -> unit 1332 1333(** [fold_left_blocks f init fn] is [f (... (f init b1) ...) bN] where 1334 [b1,...,bN] are the basic blocks of function [fn]. Tail recursive. *) 1335val fold_left_blocks : ('a -> llbasicblock -> 'a) -> 'a -> llvalue -> 'a 1336 1337(** [block_end f] returns the last position in the basic block list of 1338 the function [f]. [block_end] and [block_pred] can be used to iterate 1339 over the basic block list in reverse. 1340 See the method [llvm::Function::end]. *) 1341external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos 1342 = "llvm_block_end" 1343 1344(** [block_pred gv] returns the function list position preceding [After gv]. 1345 See the method [llvm::Function::iterator::operator--]. *) 1346external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos 1347 = "llvm_block_pred" 1348 1349(** [rev_iter_blocks f fn] applies function [f] to each of the basic blocks 1350 of function [fn] in reverse order. Tail recursive. *) 1351val rev_iter_blocks : (llbasicblock -> unit) -> llvalue -> unit 1352 1353(** [fold_right_blocks f fn init] is [f (... (f init bN) ...) b1] where 1354 [b1,...,bN] are the basic blocks of function [fn]. Tail recursive. *) 1355val fold_right_blocks : (llbasicblock -> 'a -> 'a) -> llvalue -> 'a -> 'a 1356 1357(** [value_of_block bb] losslessly casts [bb] to an [llvalue]. *) 1358external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue" 1359 1360(** [value_is_block v] returns [true] if the value [v] is a basic block and 1361 [false] otherwise. 1362 Similar to [llvm::isa<BasicBlock>]. *) 1363external value_is_block : llvalue -> bool = "llvm_value_is_block" 1364 1365(** [block_of_value v] losslessly casts [v] to an [llbasicblock]. *) 1366external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock" 1367 1368 1369(** {7 Operations on instructions} *) 1370 1371(** [instr_parent i] is the enclosing basic block of the instruction [i]. 1372 See the method [llvm::Instruction::getParent]. *) 1373external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent" 1374 1375(** [instr_begin bb] returns the first position in the instruction list of the 1376 basic block [bb]. [instr_begin] and [instr_succ] can be used to iterate over 1377 the instruction list in order. 1378 See the method [llvm::BasicBlock::begin]. *) 1379external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos 1380 = "llvm_instr_begin" 1381 1382(** [instr_succ i] returns the instruction list position succeeding [Before i]. 1383 See the method [llvm::BasicBlock::iterator::operator++]. *) 1384external instr_succ : llvalue -> (llbasicblock, llvalue) llpos 1385 = "llvm_instr_succ" 1386 1387(** [iter_instrs f bb] applies function [f] to each of the instructions of basic 1388 block [bb] in order. Tail recursive. *) 1389val iter_instrs: (llvalue -> unit) -> llbasicblock -> unit 1390 1391(** [fold_left_instrs f init bb] is [f (... (f init g1) ...) gN] where 1392 [g1,...,gN] are the instructions of basic block [bb]. Tail recursive. *) 1393val fold_left_instrs: ('a -> llvalue -> 'a) -> 'a -> llbasicblock -> 'a 1394 1395(** [instr_end bb] returns the last position in the instruction list of the 1396 basic block [bb]. [instr_end] and [instr_pred] can be used to iterate over 1397 the instruction list in reverse. 1398 See the method [llvm::BasicBlock::end]. *) 1399external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos 1400 = "llvm_instr_end" 1401 1402(** [instr_pred i] returns the instruction list position preceding [After i]. 1403 See the method [llvm::BasicBlock::iterator::operator--]. *) 1404external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos 1405 = "llvm_instr_pred" 1406 1407(** [fold_right_instrs f bb init] is [f (... (f init fN) ...) f1] where 1408 [f1,...,fN] are the instructions of basic block [bb]. Tail recursive. *) 1409val fold_right_instrs: (llvalue -> 'a -> 'a) -> llbasicblock -> 'a -> 'a 1410 1411 1412(** {7 Operations on call sites} *) 1413 1414(** [instruction_call_conv ci] is the calling convention for the call or invoke 1415 instruction [ci], which may be one of the values from the module 1416 {!CallConv}. See the method [llvm::CallInst::getCallingConv] and 1417 [llvm::InvokeInst::getCallingConv]. *) 1418external instruction_call_conv: llvalue -> int 1419 = "llvm_instruction_call_conv" 1420 1421(** [set_instruction_call_conv cc ci] sets the calling convention for the call 1422 or invoke instruction [ci] to the integer [cc], which can be one of the 1423 values from the module {!CallConv}. 1424 See the method [llvm::CallInst::setCallingConv] 1425 and [llvm::InvokeInst::setCallingConv]. *) 1426external set_instruction_call_conv: int -> llvalue -> unit 1427 = "llvm_set_instruction_call_conv" 1428 1429(** [add_instruction_param_attr ci i a] adds attribute [a] to the [i]th 1430 parameter of the call or invoke instruction [ci]. [i]=0 denotes the return 1431 value. *) 1432external add_instruction_param_attr : llvalue -> int -> Attribute.t -> unit 1433 = "llvm_add_instruction_param_attr" 1434 1435(** [remove_instruction_param_attr ci i a] removes attribute [a] from the 1436 [i]th parameter of the call or invoke instruction [ci]. [i]=0 denotes the 1437 return value. *) 1438external remove_instruction_param_attr : llvalue -> int -> Attribute.t -> unit 1439 = "llvm_remove_instruction_param_attr" 1440 1441(** {Operations on call instructions (only)} *) 1442 1443(** [is_tail_call ci] is [true] if the call instruction [ci] is flagged as 1444 eligible for tail call optimization, [false] otherwise. 1445 See the method [llvm::CallInst::isTailCall]. *) 1446external is_tail_call : llvalue -> bool = "llvm_is_tail_call" 1447 1448(** [set_tail_call tc ci] flags the call instruction [ci] as eligible for tail 1449 call optimization if [tc] is [true], clears otherwise. 1450 See the method [llvm::CallInst::setTailCall]. *) 1451external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call" 1452 1453(** {7 Operations on phi nodes} *) 1454 1455(** [add_incoming (v, bb) pn] adds the value [v] to the phi node [pn] for use 1456 with branches from [bb]. See the method [llvm::PHINode::addIncoming]. *) 1457external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit 1458 = "llvm_add_incoming" 1459 1460(** [incoming pn] returns the list of value-block pairs for phi node [pn]. 1461 See the method [llvm::PHINode::getIncomingValue]. *) 1462external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming" 1463 1464 1465 1466(** {6 Instruction builders} *) 1467 1468(** [builder context] creates an instruction builder with no position in 1469 the context [context]. It is invalid to use this builder until its position 1470 is set with {!position_before} or {!position_at_end}. See the constructor 1471 for [llvm::LLVMBuilder]. *) 1472external builder : llcontext -> llbuilder = "llvm_builder" 1473 1474(** [builder_at ip] creates an instruction builder positioned at [ip]. 1475 See the constructor for [llvm::LLVMBuilder]. *) 1476val builder_at : llcontext -> (llbasicblock, llvalue) llpos -> llbuilder 1477 1478(** [builder_before ins] creates an instruction builder positioned before the 1479 instruction [isn]. See the constructor for [llvm::LLVMBuilder]. *) 1480val builder_before : llcontext -> llvalue -> llbuilder 1481 1482(** [builder_at_end bb] creates an instruction builder positioned at the end of 1483 the basic block [bb]. See the constructor for [llvm::LLVMBuilder]. *) 1484val builder_at_end : llcontext -> llbasicblock -> llbuilder 1485 1486(** [position_builder ip bb] moves the instruction builder [bb] to the position 1487 [ip]. 1488 See the constructor for [llvm::LLVMBuilder]. *) 1489external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit 1490 = "llvm_position_builder" 1491 1492(** [position_before ins b] moves the instruction builder [b] to before the 1493 instruction [isn]. See the method [llvm::LLVMBuilder::SetInsertPoint]. *) 1494val position_before : llvalue -> llbuilder -> unit 1495 1496(** [position_at_end bb b] moves the instruction builder [b] to the end of the 1497 basic block [bb]. See the method [llvm::LLVMBuilder::SetInsertPoint]. *) 1498val position_at_end : llbasicblock -> llbuilder -> unit 1499 1500(** [insertion_block b] returns the basic block that the builder [b] is 1501 positioned to insert into. Raises [Not_Found] if the instruction builder is 1502 uninitialized. 1503 See the method [llvm::LLVMBuilder::GetInsertBlock]. *) 1504external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block" 1505 1506(** [insert_into_builder i name b] inserts the specified instruction [i] at the 1507 position specified by the instruction builder [b]. 1508 See the method [llvm::LLVMBuilder::Insert]. *) 1509external insert_into_builder : llvalue -> string -> llbuilder -> unit 1510 = "llvm_insert_into_builder" 1511 1512(** {7 Metadata} *) 1513 1514(** [set_current_debug_location b md] sets the current debug location [md] in 1515 the builder [b]. 1516 See the method [llvm::IRBuilder::SetDebugLocation]. *) 1517external set_current_debug_location : llbuilder -> llvalue -> unit 1518 = "llvm_set_current_debug_location" 1519 1520(** [clear_current_debug_location b] clears the current debug location in the 1521 builder [b]. *) 1522external clear_current_debug_location : llbuilder -> unit 1523 = "llvm_clear_current_debug_location" 1524 1525(** [current_debug_location b] returns the current debug location, or None 1526 if none is currently set. 1527 See the method [llvm::IRBuilder::GetDebugLocation]. *) 1528external current_debug_location : llbuilder -> llvalue option 1529 = "llvm_current_debug_location" 1530 1531(** [set_inst_debug_location b i] sets the current debug location of the builder 1532 [b] to the instruction [i]. 1533 See the method [llvm::IRBuilder::SetInstDebugLocation]. *) 1534external set_inst_debug_location : llbuilder -> llvalue -> unit 1535 = "llvm_set_inst_debug_location" 1536 1537(** {7 Terminators} *) 1538 1539(** [build_ret_void b] creates a 1540 [ret void] 1541 instruction at the position specified by the instruction builder [b]. 1542 See the method [llvm::LLVMBuilder::CreateRetVoid]. *) 1543external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void" 1544 1545(** [build_ret v b] creates a 1546 [ret %v] 1547 instruction at the position specified by the instruction builder [b]. 1548 See the method [llvm::LLVMBuilder::CreateRet]. *) 1549external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret" 1550 1551(** [build_aggregate_ret vs b] creates a 1552 [ret {...} { %v1, %v2, ... } ] 1553 instruction at the position specified by the instruction builder [b]. 1554 See the method [llvm::LLVMBuilder::CreateAggregateRet]. *) 1555external build_aggregate_ret : llvalue array -> llbuilder -> llvalue 1556 = "llvm_build_aggregate_ret" 1557 1558(** [build_br bb b] creates a 1559 [br %bb] 1560 instruction at the position specified by the instruction builder [b]. 1561 See the method [llvm::LLVMBuilder::CreateBr]. *) 1562external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br" 1563 1564(** [build_cond_br cond tbb fbb b] creates a 1565 [br %cond, %tbb, %fbb] 1566 instruction at the position specified by the instruction builder [b]. 1567 See the method [llvm::LLVMBuilder::CreateCondBr]. *) 1568external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder -> 1569 llvalue = "llvm_build_cond_br" 1570 1571(** [build_switch case elsebb count b] creates an empty 1572 [switch %case, %elsebb] 1573 instruction at the position specified by the instruction builder [b] with 1574 space reserved for [count] cases. 1575 See the method [llvm::LLVMBuilder::CreateSwitch]. *) 1576external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue 1577 = "llvm_build_switch" 1578 1579(** [add_case sw onval bb] causes switch instruction [sw] to branch to [bb] 1580 when its input matches the constant [onval]. 1581 See the method [llvm::SwitchInst::addCase]. **) 1582external add_case : llvalue -> llvalue -> llbasicblock -> unit 1583 = "llvm_add_case" 1584 1585(** [build_indirect_br addr count b] creates a 1586 [indirectbr %addr] 1587 instruction at the position specified by the instruction builder [b] with 1588 space reserved for [count] destinations. 1589 See the method [llvm::LLVMBuilder::CreateIndirectBr]. *) 1590external build_indirect_br : llvalue -> int -> llbuilder -> llvalue 1591 = "llvm_build_indirect_br" 1592 1593(** [add_destination br bb] adds the basic block [bb] as a possible branch 1594 location for the indirectbr instruction [br]. 1595 See the method [llvm::IndirectBrInst::addDestination]. **) 1596external add_destination : llvalue -> llbasicblock -> unit 1597 = "llvm_add_destination" 1598 1599(** [build_invoke fn args tobb unwindbb name b] creates an 1600 [%name = invoke %fn(args) to %tobb unwind %unwindbb] 1601 instruction at the position specified by the instruction builder [b]. 1602 See the method [llvm::LLVMBuilder::CreateInvoke]. *) 1603external build_invoke : llvalue -> llvalue array -> llbasicblock -> 1604 llbasicblock -> string -> llbuilder -> llvalue 1605 = "llvm_build_invoke_bc" "llvm_build_invoke_nat" 1606 1607(** [build_unwind b] creates an 1608 [unwind] 1609 instruction at the position specified by the instruction builder [b]. 1610 See the method [llvm::LLVMBuilder::CreateUnwind]. *) 1611external build_unwind : llbuilder -> llvalue = "llvm_build_unwind" 1612 1613(** [build_unreachable b] creates an 1614 [unreachable] 1615 instruction at the position specified by the instruction builder [b]. 1616 See the method [llvm::LLVMBuilder::CreateUnwind]. *) 1617external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable" 1618 1619 1620(** {7 Arithmetic} *) 1621 1622(** [build_add x y name b] creates a 1623 [%name = add %x, %y] 1624 instruction at the position specified by the instruction builder [b]. 1625 See the method [llvm::LLVMBuilder::CreateAdd]. *) 1626external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue 1627 = "llvm_build_add" 1628 1629(** [build_nsw_add x y name b] creates a 1630 [%name = nsw add %x, %y] 1631 instruction at the position specified by the instruction builder [b]. 1632 See the method [llvm::LLVMBuilder::CreateNSWAdd]. *) 1633external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue 1634 = "llvm_build_nsw_add" 1635 1636(** [build_nuw_add x y name b] creates a 1637 [%name = nuw add %x, %y] 1638 instruction at the position specified by the instruction builder [b]. 1639 See the method [llvm::LLVMBuilder::CreateNUWAdd]. *) 1640external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue 1641 = "llvm_build_nuw_add" 1642 1643(** [build_fadd x y name b] creates a 1644 [%name = fadd %x, %y] 1645 instruction at the position specified by the instruction builder [b]. 1646 See the method [llvm::LLVMBuilder::CreateFAdd]. *) 1647external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue 1648 = "llvm_build_fadd" 1649 1650(** [build_sub x y name b] creates a 1651 [%name = sub %x, %y] 1652 instruction at the position specified by the instruction builder [b]. 1653 See the method [llvm::LLVMBuilder::CreateSub]. *) 1654external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue 1655 = "llvm_build_sub" 1656 1657(** [build_nsw_sub x y name b] creates a 1658 [%name = nsw sub %x, %y] 1659 instruction at the position specified by the instruction builder [b]. 1660 See the method [llvm::LLVMBuilder::CreateNSWSub]. *) 1661external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue 1662 = "llvm_build_nsw_sub" 1663 1664(** [build_nuw_sub x y name b] creates a 1665 [%name = nuw sub %x, %y] 1666 instruction at the position specified by the instruction builder [b]. 1667 See the method [llvm::LLVMBuilder::CreateNUWSub]. *) 1668external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue 1669 = "llvm_build_nuw_sub" 1670 1671(** [build_fsub x y name b] creates a 1672 [%name = fsub %x, %y] 1673 instruction at the position specified by the instruction builder [b]. 1674 See the method [llvm::LLVMBuilder::CreateFSub]. *) 1675external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue 1676 = "llvm_build_fsub" 1677 1678(** [build_mul x y name b] creates a 1679 [%name = mul %x, %y] 1680 instruction at the position specified by the instruction builder [b]. 1681 See the method [llvm::LLVMBuilder::CreateMul]. *) 1682external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue 1683 = "llvm_build_mul" 1684 1685(** [build_nsw_mul x y name b] creates a 1686 [%name = nsw mul %x, %y] 1687 instruction at the position specified by the instruction builder [b]. 1688 See the method [llvm::LLVMBuilder::CreateNSWMul]. *) 1689external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue 1690 = "llvm_build_nsw_mul" 1691 1692(** [build_nuw_mul x y name b] creates a 1693 [%name = nuw mul %x, %y] 1694 instruction at the position specified by the instruction builder [b]. 1695 See the method [llvm::LLVMBuilder::CreateNUWMul]. *) 1696external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue 1697 = "llvm_build_nuw_mul" 1698 1699(** [build_fmul x y name b] creates a 1700 [%name = fmul %x, %y] 1701 instruction at the position specified by the instruction builder [b]. 1702 See the method [llvm::LLVMBuilder::CreateFMul]. *) 1703external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue 1704 = "llvm_build_fmul" 1705 1706(** [build_udiv x y name b] creates a 1707 [%name = udiv %x, %y] 1708 instruction at the position specified by the instruction builder [b]. 1709 See the method [llvm::LLVMBuilder::CreateUDiv]. *) 1710external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue 1711 = "llvm_build_udiv" 1712 1713(** [build_sdiv x y name b] creates a 1714 [%name = sdiv %x, %y] 1715 instruction at the position specified by the instruction builder [b]. 1716 See the method [llvm::LLVMBuilder::CreateSDiv]. *) 1717external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue 1718 = "llvm_build_sdiv" 1719 1720(** [build_exact_sdiv x y name b] creates a 1721 [%name = exact sdiv %x, %y] 1722 instruction at the position specified by the instruction builder [b]. 1723 See the method [llvm::LLVMBuilder::CreateExactSDiv]. *) 1724external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue 1725 = "llvm_build_exact_sdiv" 1726 1727(** [build_fdiv x y name b] creates a 1728 [%name = fdiv %x, %y] 1729 instruction at the position specified by the instruction builder [b]. 1730 See the method [llvm::LLVMBuilder::CreateFDiv]. *) 1731external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue 1732 = "llvm_build_fdiv" 1733 1734(** [build_urem x y name b] creates a 1735 [%name = urem %x, %y] 1736 instruction at the position specified by the instruction builder [b]. 1737 See the method [llvm::LLVMBuilder::CreateURem]. *) 1738external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue 1739 = "llvm_build_urem" 1740 1741(** [build_SRem x y name b] creates a 1742 [%name = srem %x, %y] 1743 instruction at the position specified by the instruction builder [b]. 1744 See the method [llvm::LLVMBuilder::CreateSRem]. *) 1745external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue 1746 = "llvm_build_srem" 1747 1748(** [build_frem x y name b] creates a 1749 [%name = frem %x, %y] 1750 instruction at the position specified by the instruction builder [b]. 1751 See the method [llvm::LLVMBuilder::CreateFRem]. *) 1752external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue 1753 = "llvm_build_frem" 1754 1755(** [build_shl x y name b] creates a 1756 [%name = shl %x, %y] 1757 instruction at the position specified by the instruction builder [b]. 1758 See the method [llvm::LLVMBuilder::CreateShl]. *) 1759external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue 1760 = "llvm_build_shl" 1761 1762(** [build_lshr x y name b] creates a 1763 [%name = lshr %x, %y] 1764 instruction at the position specified by the instruction builder [b]. 1765 See the method [llvm::LLVMBuilder::CreateLShr]. *) 1766external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue 1767 = "llvm_build_lshr" 1768 1769(** [build_ashr x y name b] creates a 1770 [%name = ashr %x, %y] 1771 instruction at the position specified by the instruction builder [b]. 1772 See the method [llvm::LLVMBuilder::CreateAShr]. *) 1773external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue 1774 = "llvm_build_ashr" 1775 1776(** [build_and x y name b] creates a 1777 [%name = and %x, %y] 1778 instruction at the position specified by the instruction builder [b]. 1779 See the method [llvm::LLVMBuilder::CreateAnd]. *) 1780external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue 1781 = "llvm_build_and" 1782 1783(** [build_or x y name b] creates a 1784 [%name = or %x, %y] 1785 instruction at the position specified by the instruction builder [b]. 1786 See the method [llvm::LLVMBuilder::CreateOr]. *) 1787external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue 1788 = "llvm_build_or" 1789 1790(** [build_xor x y name b] creates a 1791 [%name = xor %x, %y] 1792 instruction at the position specified by the instruction builder [b]. 1793 See the method [llvm::LLVMBuilder::CreateXor]. *) 1794external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue 1795 = "llvm_build_xor" 1796 1797(** [build_neg x name b] creates a 1798 [%name = sub 0, %x] 1799 instruction at the position specified by the instruction builder [b]. 1800 [-0.0] is used for floating point types to compute the correct sign. 1801 See the method [llvm::LLVMBuilder::CreateNeg]. *) 1802external build_neg : llvalue -> string -> llbuilder -> llvalue 1803 = "llvm_build_neg" 1804 1805(** [build_nsw_neg x name b] creates a 1806 [%name = nsw sub 0, %x] 1807 instruction at the position specified by the instruction builder [b]. 1808 [-0.0] is used for floating point types to compute the correct sign. 1809 See the method [llvm::LLVMBuilder::CreateNeg]. *) 1810external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue 1811 = "llvm_build_nsw_neg" 1812 1813(** [build_nuw_neg x name b] creates a 1814 [%name = nuw sub 0, %x] 1815 instruction at the position specified by the instruction builder [b]. 1816 [-0.0] is used for floating point types to compute the correct sign. 1817 See the method [llvm::LLVMBuilder::CreateNeg]. *) 1818external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue 1819 = "llvm_build_nuw_neg" 1820 1821(** [build_fneg x name b] creates a 1822 [%name = fsub 0, %x] 1823 instruction at the position specified by the instruction builder [b]. 1824 [-0.0] is used for floating point types to compute the correct sign. 1825 See the method [llvm::LLVMBuilder::CreateFNeg]. *) 1826external build_fneg : llvalue -> string -> llbuilder -> llvalue 1827 = "llvm_build_fneg" 1828 1829(** [build_xor x name b] creates a 1830 [%name = xor %x, -1] 1831 instruction at the position specified by the instruction builder [b]. 1832 [-1] is the correct "all ones" value for the type of [x]. 1833 See the method [llvm::LLVMBuilder::CreateXor]. *) 1834external build_not : llvalue -> string -> llbuilder -> llvalue 1835 = "llvm_build_not" 1836 1837 1838(** {7 Memory} *) 1839 1840(** [build_alloca ty name b] creates a 1841 [%name = alloca %ty] 1842 instruction at the position specified by the instruction builder [b]. 1843 See the method [llvm::LLVMBuilder::CreateAlloca]. *) 1844external build_alloca : lltype -> string -> llbuilder -> llvalue 1845 = "llvm_build_alloca" 1846 1847(** [build_array_alloca ty n name b] creates a 1848 [%name = alloca %ty, %n] 1849 instruction at the position specified by the instruction builder [b]. 1850 See the method [llvm::LLVMBuilder::CreateAlloca]. *) 1851external build_array_alloca : lltype -> llvalue -> string -> llbuilder -> 1852 llvalue = "llvm_build_array_alloca" 1853 1854(** [build_load v name b] creates a 1855 [%name = load %v] 1856 instruction at the position specified by the instruction builder [b]. 1857 See the method [llvm::LLVMBuilder::CreateLoad]. *) 1858external build_load : llvalue -> string -> llbuilder -> llvalue 1859 = "llvm_build_load" 1860 1861(** [build_store v p b] creates a 1862 [store %v, %p] 1863 instruction at the position specified by the instruction builder [b]. 1864 See the method [llvm::LLVMBuilder::CreateStore]. *) 1865external build_store : llvalue -> llvalue -> llbuilder -> llvalue 1866 = "llvm_build_store" 1867 1868(** [build_gep p indices name b] creates a 1869 [%name = getelementptr %p, indices...] 1870 instruction at the position specified by the instruction builder [b]. 1871 See the method [llvm::LLVMBuilder::CreateGetElementPtr]. *) 1872external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue 1873 = "llvm_build_gep" 1874 1875(** [build_in_bounds_gep p indices name b] creates a 1876 [%name = gelementptr inbounds %p, indices...] 1877 instruction at the position specified by the instruction builder [b]. 1878 See the method [llvm::LLVMBuilder::CreateInBoundsGetElementPtr]. *) 1879external build_in_bounds_gep : llvalue -> llvalue array -> string -> llbuilder -> 1880 llvalue = "llvm_build_in_bounds_gep" 1881 1882(** [build_struct_gep p idx name b] creates a 1883 [%name = getelementptr %p, 0, idx] 1884 instruction at the position specified by the instruction builder [b]. 1885 See the method [llvm::LLVMBuilder::CreateStructGetElementPtr]. *) 1886external build_struct_gep : llvalue -> int -> string -> llbuilder -> 1887 llvalue = "llvm_build_struct_gep" 1888 1889(** [build_global_string str name b] creates a series of instructions that adds 1890 a global string at the position specified by the instruction builder [b]. 1891 See the method [llvm::LLVMBuilder::CreateGlobalString]. *) 1892external build_global_string : string -> string -> llbuilder -> llvalue 1893 = "llvm_build_global_string" 1894 1895(** [build_global_stringptr str name b] creates a series of instructions that 1896 adds a global string pointer at the position specified by the instruction 1897 builder [b]. 1898 See the method [llvm::LLVMBuilder::CreateGlobalStringPtr]. *) 1899external build_global_stringptr : string -> string -> llbuilder -> llvalue 1900 = "llvm_build_global_stringptr" 1901 1902 1903(** {7 Casts} *) 1904 1905(** [build_trunc v ty name b] creates a 1906 [%name = trunc %p to %ty] 1907 instruction at the position specified by the instruction builder [b]. 1908 See the method [llvm::LLVMBuilder::CreateTrunc]. *) 1909external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue 1910 = "llvm_build_trunc" 1911 1912(** [build_zext v ty name b] creates a 1913 [%name = zext %p to %ty] 1914 instruction at the position specified by the instruction builder [b]. 1915 See the method [llvm::LLVMBuilder::CreateZExt]. *) 1916external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue 1917 = "llvm_build_zext" 1918 1919(** [build_sext v ty name b] creates a 1920 [%name = sext %p to %ty] 1921 instruction at the position specified by the instruction builder [b]. 1922 See the method [llvm::LLVMBuilder::CreateSExt]. *) 1923external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue 1924 = "llvm_build_sext" 1925 1926(** [build_fptoui v ty name b] creates a 1927 [%name = fptoui %p to %ty] 1928 instruction at the position specified by the instruction builder [b]. 1929 See the method [llvm::LLVMBuilder::CreateFPToUI]. *) 1930external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue 1931 = "llvm_build_fptoui" 1932 1933(** [build_fptosi v ty name b] creates a 1934 [%name = fptosi %p to %ty] 1935 instruction at the position specified by the instruction builder [b]. 1936 See the method [llvm::LLVMBuilder::CreateFPToSI]. *) 1937external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue 1938 = "llvm_build_fptosi" 1939 1940(** [build_uitofp v ty name b] creates a 1941 [%name = uitofp %p to %ty] 1942 instruction at the position specified by the instruction builder [b]. 1943 See the method [llvm::LLVMBuilder::CreateUIToFP]. *) 1944external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue 1945 = "llvm_build_uitofp" 1946 1947(** [build_sitofp v ty name b] creates a 1948 [%name = sitofp %p to %ty] 1949 instruction at the position specified by the instruction builder [b]. 1950 See the method [llvm::LLVMBuilder::CreateSIToFP]. *) 1951external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue 1952 = "llvm_build_sitofp" 1953 1954(** [build_fptrunc v ty name b] creates a 1955 [%name = fptrunc %p to %ty] 1956 instruction at the position specified by the instruction builder [b]. 1957 See the method [llvm::LLVMBuilder::CreateFPTrunc]. *) 1958external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue 1959 = "llvm_build_fptrunc" 1960 1961(** [build_fpext v ty name b] creates a 1962 [%name = fpext %p to %ty] 1963 instruction at the position specified by the instruction builder [b]. 1964 See the method [llvm::LLVMBuilder::CreateFPExt]. *) 1965external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue 1966 = "llvm_build_fpext" 1967 1968(** [build_ptrtoint v ty name b] creates a 1969 [%name = prtotint %p to %ty] 1970 instruction at the position specified by the instruction builder [b]. 1971 See the method [llvm::LLVMBuilder::CreatePtrToInt]. *) 1972external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue 1973 = "llvm_build_prttoint" 1974 1975(** [build_inttoptr v ty name b] creates a 1976 [%name = inttoptr %p to %ty] 1977 instruction at the position specified by the instruction builder [b]. 1978 See the method [llvm::LLVMBuilder::CreateIntToPtr]. *) 1979external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue 1980 = "llvm_build_inttoptr" 1981 1982(** [build_bitcast v ty name b] creates a 1983 [%name = bitcast %p to %ty] 1984 instruction at the position specified by the instruction builder [b]. 1985 See the method [llvm::LLVMBuilder::CreateBitCast]. *) 1986external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue 1987 = "llvm_build_bitcast" 1988 1989(** [build_zext_or_bitcast v ty name b] creates a zext or bitcast 1990 instruction at the position specified by the instruction builder [b]. 1991 See the method [llvm::LLVMBuilder::CreateZExtOrBitCast]. *) 1992external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder -> 1993 llvalue = "llvm_build_zext_or_bitcast" 1994 1995(** [build_sext_or_bitcast v ty name b] creates a sext or bitcast 1996 instruction at the position specified by the instruction builder [b]. 1997 See the method [llvm::LLVMBuilder::CreateSExtOrBitCast]. *) 1998external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder -> 1999 llvalue = "llvm_build_sext_or_bitcast" 2000 2001(** [build_trunc_or_bitcast v ty name b] creates a trunc or bitcast 2002 instruction at the position specified by the instruction builder [b]. 2003 See the method [llvm::LLVMBuilder::CreateZExtOrBitCast]. *) 2004external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder -> 2005 llvalue = "llvm_build_trunc_or_bitcast" 2006 2007(** [build_pointercast v ty name b] creates a bitcast or pointer-to-int 2008 instruction at the position specified by the instruction builder [b]. 2009 See the method [llvm::LLVMBuilder::CreatePointerCast]. *) 2010external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue 2011 = "llvm_build_pointercast" 2012 2013(** [build_intcast v ty name b] creates a zext, bitcast, or trunc 2014 instruction at the position specified by the instruction builder [b]. 2015 See the method [llvm::LLVMBuilder::CreateIntCast]. *) 2016external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue 2017 = "llvm_build_intcast" 2018 2019(** [build_fpcast v ty name b] creates a fpext, bitcast, or fptrunc 2020 instruction at the position specified by the instruction builder [b]. 2021 See the method [llvm::LLVMBuilder::CreateFPCast]. *) 2022external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue 2023 = "llvm_build_fpcast" 2024 2025 2026(** {7 Comparisons} *) 2027 2028(** [build_icmp pred x y name b] creates a 2029 [%name = icmp %pred %x, %y] 2030 instruction at the position specified by the instruction builder [b]. 2031 See the method [llvm::LLVMBuilder::CreateICmp]. *) 2032external build_icmp : Icmp.t -> llvalue -> llvalue -> string -> 2033 llbuilder -> llvalue = "llvm_build_icmp" 2034 2035(** [build_fcmp pred x y name b] creates a 2036 [%name = fcmp %pred %x, %y] 2037 instruction at the position specified by the instruction builder [b]. 2038 See the method [llvm::LLVMBuilder::CreateFCmp]. *) 2039external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string -> 2040 llbuilder -> llvalue = "llvm_build_fcmp" 2041 2042 2043(** {7 Miscellaneous instructions} *) 2044 2045(** [build_phi incoming name b] creates a 2046 [%name = phi %incoming] 2047 instruction at the position specified by the instruction builder [b]. 2048 [incoming] is a list of [(llvalue, llbasicblock)] tuples. 2049 See the method [llvm::LLVMBuilder::CreatePHI]. *) 2050external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder -> 2051 llvalue = "llvm_build_phi" 2052 2053(** [build_call fn args name b] creates a 2054 [%name = call %fn(args...)] 2055 instruction at the position specified by the instruction builder [b]. 2056 See the method [llvm::LLVMBuilder::CreateCall]. *) 2057external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue 2058 = "llvm_build_call" 2059 2060(** [build_select cond thenv elsev name b] creates a 2061 [%name = select %cond, %thenv, %elsev] 2062 instruction at the position specified by the instruction builder [b]. 2063 See the method [llvm::LLVMBuilder::CreateSelect]. *) 2064external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder -> 2065 llvalue = "llvm_build_select" 2066 2067(** [build_va_arg valist argty name b] creates a 2068 [%name = va_arg %valist, %argty] 2069 instruction at the position specified by the instruction builder [b]. 2070 See the method [llvm::LLVMBuilder::CreateVAArg]. *) 2071external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue 2072 = "llvm_build_va_arg" 2073 2074(** [build_extractelement vec i name b] creates a 2075 [%name = extractelement %vec, %i] 2076 instruction at the position specified by the instruction builder [b]. 2077 See the method [llvm::LLVMBuilder::CreateExtractElement]. *) 2078external build_extractelement : llvalue -> llvalue -> string -> llbuilder -> 2079 llvalue = "llvm_build_extractelement" 2080 2081(** [build_insertelement vec elt i name b] creates a 2082 [%name = insertelement %vec, %elt, %i] 2083 instruction at the position specified by the instruction builder [b]. 2084 See the method [llvm::LLVMBuilder::CreateInsertElement]. *) 2085external build_insertelement : llvalue -> llvalue -> llvalue -> string -> 2086 llbuilder -> llvalue = "llvm_build_insertelement" 2087 2088(** [build_shufflevector veca vecb mask name b] creates a 2089 [%name = shufflevector %veca, %vecb, %mask] 2090 instruction at the position specified by the instruction builder [b]. 2091 See the method [llvm::LLVMBuilder::CreateShuffleVector]. *) 2092external build_shufflevector : llvalue -> llvalue -> llvalue -> string -> 2093 llbuilder -> llvalue = "llvm_build_shufflevector" 2094 2095(** [build_insertvalue agg idx name b] creates a 2096 [%name = extractvalue %agg, %idx] 2097 instruction at the position specified by the instruction builder [b]. 2098 See the method [llvm::LLVMBuilder::CreateExtractValue]. *) 2099external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue 2100 = "llvm_build_extractvalue" 2101 2102(** [build_insertvalue agg val idx name b] creates a 2103 [%name = insertvalue %agg, %val, %idx] 2104 instruction at the position specified by the instruction builder [b]. 2105 See the method [llvm::LLVMBuilder::CreateInsertValue]. *) 2106external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder -> 2107 llvalue = "llvm_build_insertvalue" 2108 2109(** [build_is_null val name b] creates a 2110 [%name = icmp eq %val, null] 2111 instruction at the position specified by the instruction builder [b]. 2112 See the method [llvm::LLVMBuilder::CreateIsNull]. *) 2113external build_is_null : llvalue -> string -> llbuilder -> llvalue 2114 = "llvm_build_is_null" 2115 2116(** [build_is_not_null val name b] creates a 2117 [%name = icmp ne %val, null] 2118 instruction at the position specified by the instruction builder [b]. 2119 See the method [llvm::LLVMBuilder::CreateIsNotNull]. *) 2120external build_is_not_null : llvalue -> string -> llbuilder -> llvalue 2121 = "llvm_build_is_not_null" 2122 2123(** [build_ptrdiff lhs rhs name b] creates a series of instructions that measure 2124 the difference between two pointer values at the position specified by the 2125 instruction builder [b]. 2126 See the method [llvm::LLVMBuilder::CreatePtrDiff]. *) 2127external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue 2128 = "llvm_build_ptrdiff" 2129 2130(** {6 Module providers} *) 2131 2132module ModuleProvider : sig 2133 (** [create_module_provider m] encapsulates [m] in a module provider and takes 2134 ownership of the module. See the constructor 2135 [llvm::ExistingModuleProvider::ExistingModuleProvider]. *) 2136 external create : llmodule -> llmoduleprovider 2137 = "LLVMCreateModuleProviderForExistingModule" 2138 2139 (** [dispose_module_provider mp] destroys the module provider [mp] as well as 2140 the contained module. *) 2141 external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider" 2142end 2143 2144 2145(** {6 Memory buffers} *) 2146 2147module MemoryBuffer : sig 2148 (** [of_file p] is the memory buffer containing the contents of the file at 2149 path [p]. If the file could not be read, then [IoError msg] is 2150 raised. *) 2151 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file" 2152 2153 (** [stdin ()] is the memory buffer containing the contents of standard input. 2154 If standard input is empty, then [IoError msg] is raised. *) 2155 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin" 2156 2157 (** Disposes of a memory buffer. *) 2158 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose" 2159end 2160 2161 2162(** {6 Pass Managers} *) 2163 2164module PassManager : sig 2165 (** *) 2166 type 'a t 2167 type any = [ `Module | `Function ] 2168 2169 (** [PassManager.create ()] constructs a new whole-module pass pipeline. This 2170 type of pipeline is suitable for link-time optimization and whole-module 2171 transformations. 2172 See the constructor of [llvm::PassManager]. *) 2173 external create : unit -> [ `Module ] t = "llvm_passmanager_create" 2174 2175 (** [PassManager.create_function mp] constructs a new function-by-function 2176 pass pipeline over the module provider [mp]. It does not take ownership of 2177 [mp]. This type of pipeline is suitable for code generation and JIT 2178 compilation tasks. 2179 See the constructor of [llvm::FunctionPassManager]. *) 2180 external create_function : llmoduleprovider -> [ `Function ] t 2181 = "LLVMCreateFunctionPassManager" 2182 2183 (** [run_module m pm] initializes, executes on the module [m], and finalizes 2184 all of the passes scheduled in the pass manager [pm]. Returns [true] if 2185 any of the passes modified the module, [false] otherwise. 2186 See the [llvm::PassManager::run] method. *) 2187 external run_module : llmodule -> [ `Module ] t -> bool 2188 = "llvm_passmanager_run_module" 2189 2190 (** [initialize fpm] initializes all of the function passes scheduled in the 2191 function pass manager [fpm]. Returns [true] if any of the passes modified 2192 the module, [false] otherwise. 2193 See the [llvm::FunctionPassManager::doInitialization] method. *) 2194 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize" 2195 2196 (** [run_function f fpm] executes all of the function passes scheduled in the 2197 function pass manager [fpm] over the function [f]. Returns [true] if any 2198 of the passes modified [f], [false] otherwise. 2199 See the [llvm::FunctionPassManager::run] method. *) 2200 external run_function : llvalue -> [ `Function ] t -> bool 2201 = "llvm_passmanager_run_function" 2202 2203 (** [finalize fpm] finalizes all of the function passes scheduled in in the 2204 function pass manager [fpm]. Returns [true] if any of the passes 2205 modified the module, [false] otherwise. 2206 See the [llvm::FunctionPassManager::doFinalization] method. *) 2207 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize" 2208 2209 (** Frees the memory of a pass pipeline. For function pipelines, does not free 2210 the module provider. 2211 See the destructor of [llvm::BasePassManager]. *) 2212 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose" 2213end 2214