1 (*===-- llvm/llvm.mli - LLVM Ocaml Interface -------------------------------===*
3 * The LLVM Compiler Infrastructure
5 * This file is distributed under the University of Illinois Open Source
6 * License. See LICENSE.TXT for details.
8 *===----------------------------------------------------------------------===*)
12 This interface provides an ocaml API for the LLVM intermediate
13 representation, the classes in the VMCore library. *)
16 (** {6 Abstract types}
18 These abstract types correlate directly to the LLVM VMCore classes. *)
20 (** The top-level container for all other LLVM Intermediate Representation (IR)
21 objects. See the [llvm::Module] class. *)
24 (** Each value in the LLVM IR has a type, an instance of [lltype]. See the
25 [llvm::Type] class. *)
28 (** When building recursive types using {!refine_type}, [lltype] values may
29 become invalid; use [lltypehandle] to resolve this problem. See the
30 [llvm::AbstractTypeHolder] class. *)
33 (** Any value in the LLVM IR. Functions, instructions, global variables,
34 constants, and much more are all [llvalues]. See the [llvm::Value] class.
35 This type covers a wide range of subclasses. *)
38 (** A basic block in LLVM IR. See the [llvm::BasicBlock] class. *)
41 (** Used to generate instructions in the LLVM IR. See the [llvm::LLVMBuilder]
45 (** Used to provide a module to JIT or interpreter.
46 See the [llvm::ModuleProvider] class. *)
49 (** Used to efficiently handle large buffers of read-only binary data.
50 See the [llvm::MemoryBuffer] class. *)
53 (** The kind of an [lltype], the result of [classify_type ty]. See the
54 [llvm::Type::TypeID] enumeration. *)
74 (** The linkage of a global value, accessed with {!linkage} and
75 {!set_linkage}. See [llvm::GlobalValue::LinkageTypes]. *)
79 | Available_externally
90 (** The linker visibility of a global value, accessed with {!visibility} and
91 {!set_visibility}. See [llvm::GlobalValue::VisibilityTypes]. *)
92 module Visibility : sig
99 (** The following calling convention values may be accessed with
100 {!function_call_conv} and {!set_function_call_conv}. Calling
101 conventions are open-ended. *)
102 module CallConv : sig
103 val c : int (** [c] is the C calling convention. *)
104 val fast : int (** [fast] is the calling convention to allow LLVM
105 maximum optimization opportunities. Use only with
107 val cold : int (** [cold] is the calling convention for
109 val x86_stdcall : int (** [x86_stdcall] is the familiar stdcall calling
110 convention from C. *)
111 val x86_fastcall : int (** [x86_fastcall] is the familiar fastcall calling
112 convention from C. *)
115 module Attribute : sig
130 (** The predicate for an integer comparison ([icmp]) instruction.
131 See the [llvm::ICmpInst::Predicate] enumeration. *)
146 (** The predicate for a floating-point comparison ([fcmp]) instruction.
147 See the [llvm::FCmpInst::Predicate] enumeration. *)
171 (** [Before b] and [At_end a] specify positions from the start of the ['b] list
172 of [a]. [llpos] is used to specify positions in and for forward iteration
173 through the various value lists maintained by the LLVM IR. *)
174 type ('a, 'b) llpos =
178 (** [After b] and [At_start a] specify positions from the end of the ['b] list
179 of [a]. [llrev_pos] is used for reverse iteration through the various value
180 lists maintained by the LLVM IR. *)
181 type ('a, 'b) llrev_pos =
186 (** {6 Exceptions} *)
188 exception IoError of string
193 (** [create_module id] creates a module with the supplied module ID. Modules are
194 not garbage collected; it is mandatory to call {!dispose_module} to free
195 memory. See the constructor [llvm::Module::Module]. *)
196 external create_module : string -> llmodule = "llvm_create_module"
198 (** [dispose_module m] destroys a module [m] and all of the IR objects it
199 contained. All references to subordinate objects are invalidated;
200 referencing them will invoke undefined behavior. See the destructor
201 [llvm::Module::~Module]. *)
202 external dispose_module : llmodule -> unit = "llvm_dispose_module"
204 (** [target_triple m] is the target specifier for the module [m], something like
205 [i686-apple-darwin8]. See the method [llvm::Module::getTargetTriple]. *)
206 external target_triple: llmodule -> string
207 = "llvm_target_triple"
209 (** [target_triple triple m] changes the target specifier for the module [m] to
210 the string [triple]. See the method [llvm::Module::setTargetTriple]. *)
211 external set_target_triple: string -> llmodule -> unit
212 = "llvm_set_target_triple"
214 (** [data_layout m] is the data layout specifier for the module [m], something
215 like [e-p:32:32:32-i1:8:8-i8:8:8-i16:16:16-...-a0:0:64-f80:128:128]. See the
216 method [llvm::Module::getDataLayout]. *)
217 external data_layout: llmodule -> string
220 (** [set_data_layout s m] changes the data layout specifier for the module [m]
221 to the string [s]. See the method [llvm::Module::setDataLayout]. *)
222 external set_data_layout: string -> llmodule -> unit
223 = "llvm_set_data_layout"
225 (** [define_type_name name ty m] adds a named type to the module's symbol table.
226 Returns [true] if successful. If such a name already exists, then no entry
227 is added and [false] is returned. See the [llvm::Module::addTypeName]
229 external define_type_name : string -> lltype -> llmodule -> bool
230 = "llvm_add_type_name"
232 (** [delete_type_name name] removes a type name from the module's symbol
234 external delete_type_name : string -> llmodule -> unit
235 = "llvm_delete_type_name"
237 (** [dump_module m] prints the .ll representation of the module [m] to standard
238 error. See the method [llvm::Module::dump]. *)
239 external dump_module : llmodule -> unit = "llvm_dump_module"
244 (** [classify_type ty] returns the {!TypeKind.t} corresponding to the type [ty].
245 See the method [llvm::Type::getTypeID]. *)
246 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
248 (** [string_of_lltype ty] returns a string describing the type [ty]. *)
249 val string_of_lltype : lltype -> string
251 (** {7 Operations on integer types} *)
253 (** The 1-bit integer type. See [llvm::Type::Int1Ty]. *)
256 (** The 8-bit integer type. See [llvm::Type::Int8Ty]. *)
259 (** The 16-bit integer type. See [llvm::Type::Int16Ty]. *)
260 val i16_type : lltype
262 (** The 32-bit integer type. See [llvm::Type::Int32Ty]. *)
263 val i32_type : lltype
265 (** The 64-bit integer type. See [llvm::Type::Int64Ty]. *)
266 val i64_type : lltype
268 (** [integer_type n] returns an integer type of bitwidth [n].
269 See the method [llvm::IntegerType::get]. *)
270 external integer_type : int -> lltype = "llvm_integer_type"
272 (** [integer_bitwidth ty] returns the number of bits in the integer type [ty].
273 See the method [llvm::IntegerType::getBitWidth]. *)
274 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
277 (** {7 Operations on real types} *)
279 (** The IEEE 32-bit floating point type. See [llvm::Type::FloatTy]. *)
280 val float_type : lltype
282 (** The IEEE 64-bit floating point type. See [llvm::Type::DoubleTy]. *)
283 val double_type : lltype
285 (** The x87 80-bit floating point type. See [llvm::Type::X86_FP80Ty]. *)
286 val x86fp80_type : lltype
288 (** The IEEE 128-bit floating point type. See [llvm::Type::FP128Ty]. *)
289 val fp128_type : lltype
291 (** The PowerPC 128-bit floating point type. See [llvm::Type::PPC_FP128Ty]. *)
292 val ppc_fp128_type : lltype
295 (** {7 Operations on function types} *)
297 (** [function_type ret_ty param_tys] returns the function type returning
298 [ret_ty] and taking [param_tys] as parameters.
299 See the method [llvm::FunctionType::get]. *)
300 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
302 (** [va_arg_function_type ret_ty param_tys] is just like
303 [function_type ret_ty param_tys] except that it returns the function type
304 which also takes a variable number of arguments.
305 See the method [llvm::FunctionType::get]. *)
306 external var_arg_function_type : lltype -> lltype array -> lltype
307 = "llvm_var_arg_function_type"
309 (** [is_var_arg fty] returns [true] if [fty] is a varargs function type, [false]
310 otherwise. See the method [llvm::FunctionType::isVarArg]. *)
311 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
313 (** [return_type fty] gets the return type of the function type [fty].
314 See the method [llvm::FunctionType::getReturnType]. *)
315 external return_type : lltype -> lltype = "LLVMGetReturnType"
317 (** [param_types fty] gets the parameter types of the function type [fty].
318 See the method [llvm::FunctionType::getParamType]. *)
319 external param_types : lltype -> lltype array = "llvm_param_types"
322 (** {7 Operations on struct types} *)
324 (** [struct_type tys] returns the structure type containing in the types in the
325 array [tys]. See the method [llvm::StructType::get]. *)
326 external struct_type : lltype array -> lltype = "llvm_struct_type"
328 (** [packed_struct_type tys] returns the packed structure type containing in the
329 types in the array [tys]. See the method [llvm::StructType::get]. *)
330 external packed_struct_type : lltype array -> lltype = "llvm_packed_struct_type"
332 (** [element_types sty] returns the constituent types of the struct type [sty].
333 See the method [llvm::StructType::getElementType]. *)
334 external element_types : lltype -> lltype array = "llvm_element_types"
336 (** [is_packed sty] returns [true] if the structure type [sty] is packed,
337 [false] otherwise. See the method [llvm::StructType::isPacked]. *)
338 external is_packed : lltype -> bool = "llvm_is_packed"
341 (** {7 Operations on pointer, vector, and array types} *)
343 (** [array_type ty n] returns the array type containing [n] elements of type
344 [ty]. See the method [llvm::ArrayType::get]. *)
345 external array_type : lltype -> int -> lltype = "llvm_array_type"
347 (** [pointer_type ty] returns the pointer type referencing objects of type
348 [ty] in the default address space (0).
349 See the method [llvm::PointerType::getUnqual]. *)
350 external pointer_type : lltype -> lltype = "llvm_pointer_type"
352 (** [qualified_pointer_type ty as] returns the pointer type referencing objects
353 of type [ty] in address space [as].
354 See the method [llvm::PointerType::get]. *)
355 external qualified_pointer_type : lltype -> int -> lltype
356 = "llvm_qualified_pointer_type"
358 (** [vector_type ty n] returns the array type containing [n] elements of the
359 primitive type [ty]. See the method [llvm::ArrayType::get]. *)
360 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
362 (** [element_type ty] returns the element type of the pointer, vector, or array
363 type [ty]. See the method [llvm::SequentialType::get]. *)
364 external element_type : lltype -> lltype = "LLVMGetElementType"
366 (** [element_type aty] returns the element count of the array type [aty].
367 See the method [llvm::ArrayType::getNumElements]. *)
368 external array_length : lltype -> int = "llvm_array_length"
370 (** [address_space pty] returns the address space qualifier of the pointer type
371 [pty]. See the method [llvm::PointerType::getAddressSpace]. *)
372 external address_space : lltype -> int = "llvm_address_space"
374 (** [element_type ty] returns the element count of the vector type [ty].
375 See the method [llvm::VectorType::getNumElements]. *)
376 external vector_size : lltype -> int = "llvm_vector_size"
379 (** {7 Operations on other types} *)
381 (** [opaque_type ()] creates a new opaque type distinct from any other.
382 Opaque types are useful for building recursive types in combination with
384 See [llvm::OpaqueType::get]. *)
385 external opaque_type : unit -> lltype = "llvm_opaque_type"
387 (** [void_type] is the type of a function which does not return any value.
388 See [llvm::Type::VoidTy]. *)
389 val void_type : lltype
391 (** [label_type] is the type of a basic block. See [llvm::Type::LabelTy]. *)
392 val label_type : lltype
394 (** {7 Operations on type handles} *)
396 (** [handle_to_type ty] creates a handle to the type [ty]. If [ty] is later
397 refined as a result of a call to {!refine_type}, the handle will be updated;
398 any bare [lltype] references will become invalid.
399 See the class [llvm::PATypeHolder]. *)
400 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
402 (** [type_of_handle tyh] resolves the type handle [tyh].
403 See the method [llvm::PATypeHolder::get()]. *)
404 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
406 (** [refine_type opaque_ty ty] replaces the abstract type [opaque_ty] with the
407 concrete type [ty] in all users. Warning: This may invalidate {!lltype}
408 values! Use {!lltypehandle} to manipulate potentially abstract types. See
409 the method [llvm::Type::refineAbstractType]. *)
410 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
415 (** [type_of v] returns the type of the value [v].
416 See the method [llvm::Value::getType]. *)
417 external type_of : llvalue -> lltype = "llvm_type_of"
419 (** [value_name v] returns the name of the value [v]. For global values, this is
420 the symbol name. For instructions and basic blocks, it is the SSA register
421 name. It is meaningless for constants.
422 See the method [llvm::Value::getName]. *)
423 external value_name : llvalue -> string = "llvm_value_name"
425 (** [set_value_name n v] sets the name of the value [v] to [n]. See the method
426 [llvm::Value::setName]. *)
427 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
429 (** [dump_value v] prints the .ll representation of the value [v] to standard
430 error. See the method [llvm::Value::dump]. *)
431 external dump_value : llvalue -> unit = "llvm_dump_value"
434 (** {7 Operations on constants of (mostly) any type} *)
436 (** [is_constant v] returns [true] if the value [v] is a constant, [false]
437 otherwise. Similar to [llvm::isa<Constant>]. *)
438 external is_constant : llvalue -> bool = "llvm_is_constant"
440 (** [const_null ty] returns the constant null (zero) of the type [ty].
441 See the method [llvm::Constant::getNullValue]. *)
442 external const_null : lltype -> llvalue = "LLVMConstNull"
444 (** [const_all_ones ty] returns the constant '-1' of the integer or vector type
445 [ty]. See the method [llvm::Constant::getAllOnesValue]. *)
446 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
448 (** [undef ty] returns the undefined value of the type [ty].
449 See the method [llvm::UndefValue::get]. *)
450 external undef : lltype -> llvalue = "LLVMGetUndef"
452 (** [is_null v] returns [true] if the value [v] is the null (zero) value.
453 See the method [llvm::Constant::isNullValue]. *)
454 external is_null : llvalue -> bool = "llvm_is_null"
456 (** [is_undef v] returns [true] if the value [v] is an undefined value, [false]
457 otherwise. Similar to [llvm::isa<UndefValue>]. *)
458 external is_undef : llvalue -> bool = "llvm_is_undef"
461 (** {7 Operations on scalar constants} *)
463 (** [const_int ty i] returns the integer constant of type [ty] and value [i].
464 See the method [llvm::ConstantInt::get]. *)
465 external const_int : lltype -> int -> llvalue = "llvm_const_int"
467 (** [const_of_int64 ty i] returns the integer constant of type [ty] and value
468 [i]. See the method [llvm::ConstantInt::get]. *)
469 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
470 = "llvm_const_of_int64"
472 (** [const_float ty n] returns the floating point constant of type [ty] and
473 value [n]. See the method [llvm::ConstantFP::get]. *)
474 external const_float : lltype -> float -> llvalue = "llvm_const_float"
477 (** {7 Operations on composite constants} *)
479 (** [const_string s] returns the constant [i8] array with the values of the
480 characters in the string [s]. The array is not null-terminated (but see
481 {!const_stringz}). This value can in turn be used as the initializer for a
482 global variable. See the method [llvm::ConstantArray::get]. *)
483 external const_string : string -> llvalue = "llvm_const_string"
485 (** [const_stringz s] returns the constant [i8] array with the values of the
486 characters in the string [s] and a null terminator. This value can in turn
487 be used as the initializer for a global variable.
488 See the method [llvm::ConstantArray::get]. *)
489 external const_stringz : string -> llvalue = "llvm_const_stringz"
491 (** [const_array ty elts] returns the constant array of type
492 [array_type ty (Array.length elts)] and containing the values [elts].
493 This value can in turn be used as the initializer for a global variable.
494 See the method [llvm::ConstantArray::get]. *)
495 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
497 (** [const_struct elts] returns the structured constant of type
498 [struct_type (Array.map type_of elts)] and containing the values [elts].
499 This value can in turn be used as the initializer for a global variable.
500 See the method [llvm::ConstantStruct::get]. *)
501 external const_struct : llvalue array -> llvalue = "llvm_const_struct"
503 (** [const_packed_struct elts] returns the structured constant of type
504 {!packed_struct_type} [(Array.map type_of elts)] and containing the values
505 [elts]. This value can in turn be used as the initializer for a global
506 variable. See the method [llvm::ConstantStruct::get]. *)
507 external const_packed_struct : llvalue array -> llvalue
508 = "llvm_const_packed_struct"
510 (** [const_vector elts] returns the vector constant of type
511 [vector_type (type_of elts.(0)) (Array.length elts)] and containing the
512 values [elts]. See the method [llvm::ConstantVector::get]. *)
513 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
516 (** {7 Constant expressions} *)
518 (** [align_of ty] returns the alignof constant for the type [ty]. This is
519 equivalent to [const_ptrtoint (const_gep (const_null (pointer_type {i8,ty}))
520 (const_int i32_type 0) (const_int i32_type 1)) i32_type], but considerably
521 more readable. See the method [llvm::ConstantExpr::getAlignOf]. *)
522 external align_of : lltype -> llvalue = "LLVMAlignOf"
524 (** [size_of ty] returns the sizeof constant for the type [ty]. This is
525 equivalent to [const_ptrtoint (const_gep (const_null (pointer_type ty))
526 (const_int i32_type 1)) i64_type], but considerably more readable.
527 See the method [llvm::ConstantExpr::getSizeOf]. *)
528 external size_of : lltype -> llvalue = "LLVMSizeOf"
530 (** [const_neg c] returns the arithmetic negation of the constant [c].
531 See the method [llvm::ConstantExpr::getNeg]. *)
532 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
534 (** [const_fneg c] returns the arithmetic negation of the constant float [c].
535 See the method [llvm::ConstantExpr::getFNeg]. *)
536 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
538 (** [const_not c] returns the bitwise inverse of the constant [c].
539 See the method [llvm::ConstantExpr::getNot]. *)
540 external const_not : llvalue -> llvalue = "LLVMConstNot"
542 (** [const_add c1 c2] returns the constant sum of two constants.
543 See the method [llvm::ConstantExpr::getAdd]. *)
544 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
546 (** [const_nsw_add c1 c2] returns the constant sum of two constants with no
547 signed wrapping. The result is undefined if the sum overflows.
548 See the method [llvm::ConstantExpr::getNSWAdd]. *)
549 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
551 (** [const_fadd c1 c2] returns the constant sum of two constant floats.
552 See the method [llvm::ConstantExpr::getFAdd]. *)
553 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
555 (** [const_sub c1 c2] returns the constant difference, [c1 - c2], of two
556 constants. See the method [llvm::ConstantExpr::getSub]. *)
557 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
559 (** [const_fsub c1 c2] returns the constant difference, [c1 - c2], of two
560 constant floats. See the method [llvm::ConstantExpr::getFSub]. *)
561 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
563 (** [const_mul c1 c2] returns the constant product of two constants.
564 See the method [llvm::ConstantExpr::getMul]. *)
565 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
567 (** [const_fmul c1 c2] returns the constant product of two constants floats.
568 See the method [llvm::ConstantExpr::getFMul]. *)
569 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
571 (** [const_udiv c1 c2] returns the constant quotient [c1 / c2] of two unsigned
573 See the method [llvm::ConstantExpr::getUDiv]. *)
574 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
576 (** [const_sdiv c1 c2] returns the constant quotient [c1 / c2] of two signed
578 See the method [llvm::ConstantExpr::getSDiv]. *)
579 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
581 (** [const_exact_sdiv c1 c2] returns the constant quotient [c1 / c2] of two
582 signed integer constants. The result is undefined if the result is rounded
583 or overflows. See the method [llvm::ConstantExpr::getExactSDiv]. *)
584 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
586 (** [const_fdiv c1 c2] returns the constant quotient [c1 / c2] of two floating
588 See the method [llvm::ConstantExpr::getFDiv]. *)
589 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
591 (** [const_urem c1 c2] returns the constant remainder [c1 MOD c2] of two
592 unsigned integer constants.
593 See the method [llvm::ConstantExpr::getURem]. *)
594 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
596 (** [const_srem c1 c2] returns the constant remainder [c1 MOD c2] of two
597 signed integer constants.
598 See the method [llvm::ConstantExpr::getSRem]. *)
599 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
601 (** [const_frem c1 c2] returns the constant remainder [c1 MOD c2] of two
602 signed floating point constants.
603 See the method [llvm::ConstantExpr::getFRem]. *)
604 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
606 (** [const_and c1 c2] returns the constant bitwise [AND] of two integer
608 See the method [llvm::ConstantExpr::getAnd]. *)
609 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
611 (** [const_or c1 c2] returns the constant bitwise [OR] of two integer
613 See the method [llvm::ConstantExpr::getOr]. *)
614 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
616 (** [const_xor c1 c2] returns the constant bitwise [XOR] of two integer
618 See the method [llvm::ConstantExpr::getXor]. *)
619 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
621 (** [const_icmp pred c1 c2] returns the constant comparison of two integer
622 constants, [c1 pred c2].
623 See the method [llvm::ConstantExpr::getICmp]. *)
624 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
627 (** [const_fcmp pred c1 c2] returns the constant comparison of two floating
628 point constants, [c1 pred c2].
629 See the method [llvm::ConstantExpr::getFCmp]. *)
630 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
633 (** [const_shl c1 c2] returns the constant integer [c1] left-shifted by the
634 constant integer [c2].
635 See the method [llvm::ConstantExpr::getShl]. *)
636 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
638 (** [const_lshr c1 c2] returns the constant integer [c1] right-shifted by the
639 constant integer [c2] with zero extension.
640 See the method [llvm::ConstantExpr::getLShr]. *)
641 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
643 (** [const_ashr c1 c2] returns the constant integer [c1] right-shifted by the
644 constant integer [c2] with sign extension.
645 See the method [llvm::ConstantExpr::getAShr]. *)
646 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
648 (** [const_gep pc indices] returns the constant [getElementPtr] of [p1] with the
649 constant integers indices from the array [indices].
650 See the method [llvm::ConstantExpr::getGetElementPtr]. *)
651 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
653 (** [const_in_bounds_gep pc indices] returns the constant [getElementPtr] of [p1]
654 with the constant integers indices from the array [indices].
655 See the method [llvm::ConstantExpr::getInBoundsGetElementPtr]. *)
656 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
657 = "llvm_const_in_bounds_gep"
659 (** [const_trunc c ty] returns the constant truncation of integer constant [c]
660 to the smaller integer type [ty].
661 See the method [llvm::ConstantExpr::getTrunc]. *)
662 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
664 (** [const_sext c ty] returns the constant sign extension of integer constant
665 [c] to the larger integer type [ty].
666 See the method [llvm::ConstantExpr::getSExt]. *)
667 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
669 (** [const_zext c ty] returns the constant zero extension of integer constant
670 [c] to the larger integer type [ty].
671 See the method [llvm::ConstantExpr::getZExt]. *)
672 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
674 (** [const_fptrunc c ty] returns the constant truncation of floating point
675 constant [c] to the smaller floating point type [ty].
676 See the method [llvm::ConstantExpr::getFPTrunc]. *)
677 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
679 (** [const_fpext c ty] returns the constant extension of floating point constant
680 [c] to the larger floating point type [ty].
681 See the method [llvm::ConstantExpr::getFPExt]. *)
682 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
684 (** [const_uitofp c ty] returns the constant floating point conversion of
685 unsigned integer constant [c] to the floating point type [ty].
686 See the method [llvm::ConstantExpr::getUIToFP]. *)
687 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
689 (** [const_sitofp c ty] returns the constant floating point conversion of
690 signed integer constant [c] to the floating point type [ty].
691 See the method [llvm::ConstantExpr::getSIToFP]. *)
692 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
694 (** [const_fptoui c ty] returns the constant unsigned integer conversion of
695 floating point constant [c] to integer type [ty].
696 See the method [llvm::ConstantExpr::getFPToUI]. *)
697 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
699 (** [const_fptoui c ty] returns the constant unsigned integer conversion of
700 floating point constant [c] to integer type [ty].
701 See the method [llvm::ConstantExpr::getFPToSI]. *)
702 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
704 (** [const_ptrtoint c ty] returns the constant integer conversion of
705 pointer constant [c] to integer type [ty].
706 See the method [llvm::ConstantExpr::getPtrToInt]. *)
707 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
709 (** [const_inttoptr c ty] returns the constant pointer conversion of
710 integer constant [c] to pointer type [ty].
711 See the method [llvm::ConstantExpr::getIntToPtr]. *)
712 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
714 (** [const_bitcast c ty] returns the constant bitwise conversion of constant [c]
715 to type [ty] of equal size.
716 See the method [llvm::ConstantExpr::getBitCast]. *)
717 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
719 (** [const_zext_or_bitcast c ty] returns a constant zext or bitwise cast
720 conversion of constant [c] to type [ty].
721 See the method [llvm::ConstantExpr::getZExtOrBitCast]. *)
722 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
723 = "LLVMConstZExtOrBitCast"
725 (** [const_sext_or_bitcast c ty] returns a constant sext or bitwise cast
726 conversion of constant [c] to type [ty].
727 See the method [llvm::ConstantExpr::getSExtOrBitCast]. *)
728 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
729 = "LLVMConstSExtOrBitCast"
731 (** [const_trunc_or_bitcast c ty] returns a constant trunc or bitwise cast
732 conversion of constant [c] to type [ty].
733 See the method [llvm::ConstantExpr::getTruncOrBitCast]. *)
734 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
735 = "LLVMConstTruncOrBitCast"
737 (** [const_pointercast c ty] returns a constant bitcast or a pointer-to-int
738 cast conversion of constant [c] to type [ty] of equal size.
739 See the method [llvm::ConstantExpr::getPointerCast]. *)
740 external const_pointercast : llvalue -> lltype -> llvalue
741 = "LLVMConstPointerCast"
743 (** [const_intcast c ty] returns a constant zext, bitcast, or trunc for integer
744 -> integer casts of constant [c] to type [ty].
745 See the method [llvm::ConstantExpr::getIntCast]. *)
746 external const_intcast : llvalue -> lltype -> llvalue
749 (** [const_fpcast c ty] returns a constant fpext, bitcast, or fptrunc for fp ->
750 fp casts of constant [c] to type [ty].
751 See the method [llvm::ConstantExpr::getFPCast]. *)
752 external const_fpcast : llvalue -> lltype -> llvalue
755 (** [const_select cond t f] returns the constant conditional which returns value
756 [t] if the boolean constant [cond] is true and the value [f] otherwise.
757 See the method [llvm::ConstantExpr::getSelect]. *)
758 external const_select : llvalue -> llvalue -> llvalue -> llvalue
761 (** [const_extractelement vec i] returns the constant [i]th element of
762 constant vector [vec]. [i] must be a constant [i32] value unsigned less than
763 the size of the vector.
764 See the method [llvm::ConstantExpr::getExtractElement]. *)
765 external const_extractelement : llvalue -> llvalue -> llvalue
766 = "LLVMConstExtractElement"
768 (** [const_insertelement vec v i] returns the constant vector with the same
769 elements as constant vector [v] but the [i]th element replaced by the
770 constant [v]. [v] must be a constant value with the type of the vector
771 elements. [i] must be a constant [i32] value unsigned less than the size
773 See the method [llvm::ConstantExpr::getInsertElement]. *)
774 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
775 = "LLVMConstInsertElement"
777 (** [const_shufflevector a b mask] returns a constant [shufflevector].
778 See the LLVM Language Reference for details on the [sufflevector]
780 See the method [llvm::ConstantExpr::getShuffleVector]. *)
781 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
782 = "LLVMConstShuffleVector"
784 (** [const_extractvalue agg idxs] returns the constant [idxs]th value of
785 constant aggregate [agg]. Each [idxs] must be less than the size of the
786 aggregate. See the method [llvm::ConstantExpr::getExtractValue]. *)
787 external const_extractvalue : llvalue -> int array -> llvalue
788 = "llvm_const_extractvalue"
790 (** [const_insertvalue agg val idxs] inserts the value [val] in the specified
791 indexs [idxs] in the aggegate [agg]. Each [idxs] must be less than the size
792 of the aggregate. See the method [llvm::ConstantExpr::getInsertValue]. *)
793 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
794 = "llvm_const_insertvalue"
797 (** {7 Operations on global variables, functions, and aliases (globals)} *)
799 (** [global_parent g] is the enclosing module of the global value [g].
800 See the method [llvm::GlobalValue::getParent]. *)
801 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
803 (** [is_declaration g] returns [true] if the global value [g] is a declaration
804 only. Returns [false] otherwise.
805 See the method [llvm::GlobalValue::isDeclaration]. *)
806 external is_declaration : llvalue -> bool = "llvm_is_declaration"
808 (** [linkage g] returns the linkage of the global value [g].
809 See the method [llvm::GlobalValue::getLinkage]. *)
810 external linkage : llvalue -> Linkage.t = "llvm_linkage"
812 (** [set_linkage l g] sets the linkage of the global value [g] to [l].
813 See the method [llvm::GlobalValue::setLinkage]. *)
814 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
816 (** [section g] returns the linker section of the global value [g].
817 See the method [llvm::GlobalValue::getSection]. *)
818 external section : llvalue -> string = "llvm_section"
820 (** [set_section s g] sets the linker section of the global value [g] to [s].
821 See the method [llvm::GlobalValue::setSection]. *)
822 external set_section : string -> llvalue -> unit = "llvm_set_section"
824 (** [visibility g] returns the linker visibility of the global value [g].
825 See the method [llvm::GlobalValue::getVisibility]. *)
826 external visibility : llvalue -> Visibility.t = "llvm_visibility"
828 (** [set_visibility v g] sets the linker visibility of the global value [g] to
829 [v]. See the method [llvm::GlobalValue::setVisibility]. *)
830 external set_visibility : Visibility.t -> llvalue -> unit
831 = "llvm_set_visibility"
833 (** [alignment g] returns the required alignment of the global value [g].
834 See the method [llvm::GlobalValue::getAlignment]. *)
835 external alignment : llvalue -> int = "llvm_alignment"
837 (** [set_alignment n g] sets the required alignment of the global value [g] to
838 [n] bytes. See the method [llvm::GlobalValue::setAlignment]. *)
839 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
842 (** {7 Operations on global variables} *)
844 (** [declare_global ty name m] returns a new global variable of type [ty] and
845 with name [name] in module [m]. If such a global variable already exists,
846 it is returned. If the type of the existing global differs, then a bitcast
847 to [ty] is returned. *)
848 external declare_global : lltype -> string -> llmodule -> llvalue
849 = "llvm_declare_global"
851 (** [define_global name init m] returns a new global with name [name] and
852 initializer [init] in module [m]. If the named global already exists, it is
854 See the constructor of [llvm::GlobalVariable]. *)
855 external define_global : string -> llvalue -> llmodule -> llvalue
856 = "llvm_define_global"
858 (** [lookup_global name m] returns [Some g] if a global variable with name
859 [name] exists in module [m]. If no such global exists, returns [None].
860 See the [llvm::GlobalVariable] constructor. *)
861 external lookup_global : string -> llmodule -> llvalue option
862 = "llvm_lookup_global"
864 (** [delete_global gv] destroys the global variable [gv].
865 See the method [llvm::GlobalVariable::eraseFromParent]. *)
866 external delete_global : llvalue -> unit = "llvm_delete_global"
868 (** [global_begin m] returns the first position in the global variable list of
869 the module [m]. [global_begin] and [global_succ] can be used to iterate
870 over the global list in order.
871 See the method [llvm::Module::global_begin]. *)
872 external global_begin : llmodule -> (llmodule, llvalue) llpos
873 = "llvm_global_begin"
875 (** [global_succ gv] returns the global variable list position succeeding
877 See the method [llvm::Module::global_iterator::operator++]. *)
878 external global_succ : llvalue -> (llmodule, llvalue) llpos
881 (** [iter_globals f m] applies function [f] to each of the global variables of
882 module [m] in order. Tail recursive. *)
883 val iter_globals : (llvalue -> unit) -> llmodule -> unit
885 (** [fold_left_globals f init m] is [f (... (f init g1) ...) gN] where
886 [g1,...,gN] are the global variables of module [m]. Tail recursive. *)
887 val fold_left_globals : ('a -> llvalue -> 'a) -> 'a -> llmodule -> 'a
889 (** [global_end m] returns the last position in the global variable list of the
890 module [m]. [global_end] and [global_pred] can be used to iterate over the
891 global list in reverse.
892 See the method [llvm::Module::global_end]. *)
893 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
896 (** [global_pred gv] returns the global variable list position preceding
898 See the method [llvm::Module::global_iterator::operator--]. *)
899 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
902 (** [rev_iter_globals f m] applies function [f] to each of the global variables
903 of module [m] in reverse order. Tail recursive. *)
904 val rev_iter_globals : (llvalue -> unit) -> llmodule -> unit
906 (** [fold_right_globals f m init] is [f g1 (... (f gN init) ...)] where
907 [g1,...,gN] are the global variables of module [m]. Tail recursive. *)
908 val fold_right_globals : (llvalue -> 'a -> 'a) -> llmodule -> 'a -> 'a
910 (** [is_global_constant gv] returns [true] if the global variabile [gv] is a
911 constant. Returns [false] otherwise.
912 See the method [llvm::GlobalVariable::isConstant]. *)
913 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
915 (** [set_global_constant c gv] sets the global variable [gv] to be a constant if
916 [c] is [true] and not if [c] is [false].
917 See the method [llvm::GlobalVariable::setConstant]. *)
918 external set_global_constant : bool -> llvalue -> unit
919 = "llvm_set_global_constant"
921 (** [global_initializer gv] returns the initializer for the global variable
922 [gv]. See the method [llvm::GlobalVariable::getInitializer]. *)
923 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
925 (** [set_initializer c gv] sets the initializer for the global variable
926 [gv] to the constant [c].
927 See the method [llvm::GlobalVariable::setInitializer]. *)
928 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
930 (** [remove_initializer gv] unsets the initializer for the global variable
932 See the method [llvm::GlobalVariable::setInitializer]. *)
933 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
935 (** [is_thread_local gv] returns [true] if the global variable [gv] is
936 thread-local and [false] otherwise.
937 See the method [llvm::GlobalVariable::isThreadLocal]. *)
938 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
940 (** [set_thread_local c gv] sets the global variable [gv] to be thread local if
941 [c] is [true] and not otherwise.
942 See the method [llvm::GlobalVariable::setThreadLocal]. *)
943 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
946 (** {7 Operations on functions} *)
948 (** [declare_function name ty m] returns a new function of type [ty] and
949 with name [name] in module [m]. If such a function already exists,
950 it is returned. If the type of the existing function differs, then a bitcast
951 to [ty] is returned. *)
952 external declare_function : string -> lltype -> llmodule -> llvalue
953 = "llvm_declare_function"
955 (** [define_function name ty m] creates a new function with name [name] and
956 type [ty] in module [m]. If the named function already exists, it is
957 renamed. An entry basic block is created in the function.
958 See the constructor of [llvm::GlobalVariable]. *)
959 external define_function : string -> lltype -> llmodule -> llvalue
960 = "llvm_define_function"
962 (** [lookup_function name m] returns [Some f] if a function with name
963 [name] exists in module [m]. If no such function exists, returns [None].
964 See the method [llvm::Module] constructor. *)
965 external lookup_function : string -> llmodule -> llvalue option
966 = "llvm_lookup_function"
968 (** [delete_function f] destroys the function [f].
969 See the method [llvm::Function::eraseFromParent]. *)
970 external delete_function : llvalue -> unit = "llvm_delete_function"
972 (** [function_begin m] returns the first position in the function list of the
973 module [m]. [function_begin] and [function_succ] can be used to iterate over
974 the function list in order.
975 See the method [llvm::Module::begin]. *)
976 external function_begin : llmodule -> (llmodule, llvalue) llpos
977 = "llvm_function_begin"
979 (** [function_succ gv] returns the function list position succeeding
981 See the method [llvm::Module::iterator::operator++]. *)
982 external function_succ : llvalue -> (llmodule, llvalue) llpos
983 = "llvm_function_succ"
985 (** [iter_functions f m] applies function [f] to each of the functions of module
986 [m] in order. Tail recursive. *)
987 val iter_functions : (llvalue -> unit) -> llmodule -> unit
989 (** [fold_left_function f init m] is [f (... (f init f1) ...) fN] where
990 [f1,...,fN] are the functions of module [m]. Tail recursive. *)
991 val fold_left_functions : ('a -> llvalue -> 'a) -> 'a -> llmodule -> 'a
993 (** [function_end m] returns the last position in the function list of
994 the module [m]. [function_end] and [function_pred] can be used to iterate
995 over the function list in reverse.
996 See the method [llvm::Module::end]. *)
997 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
998 = "llvm_function_end"
1000 (** [function_pred gv] returns the function list position preceding [After gv].
1001 See the method [llvm::Module::iterator::operator--]. *)
1002 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
1003 = "llvm_function_pred"
1005 (** [rev_iter_functions f fn] applies function [f] to each of the functions of
1006 module [m] in reverse order. Tail recursive. *)
1007 val rev_iter_functions : (llvalue -> unit) -> llmodule -> unit
1009 (** [fold_right_functions f m init] is [f (... (f init fN) ...) f1] where
1010 [f1,...,fN] are the functions of module [m]. Tail recursive. *)
1011 val fold_right_functions : (llvalue -> 'a -> 'a) -> llmodule -> 'a -> 'a
1013 (** [is_intrinsic f] returns true if the function [f] is an intrinsic.
1014 See the method [llvm::Function::isIntrinsic]. *)
1015 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
1017 (** [function_call_conv f] returns the calling convention of the function [f].
1018 See the method [llvm::Function::getCallingConv]. *)
1019 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
1021 (** [set_function_call_conv cc f] sets the calling convention of the function
1022 [f] to the calling convention numbered [cc].
1023 See the method [llvm::Function::setCallingConv]. *)
1024 external set_function_call_conv : int -> llvalue -> unit
1025 = "llvm_set_function_call_conv"
1027 (** [gc f] returns [Some name] if the function [f] has a garbage
1028 collection algorithm specified and [None] otherwise.
1029 See the method [llvm::Function::getGC]. *)
1030 external gc : llvalue -> string option = "llvm_gc"
1032 (** [set_gc gc f] sets the collection algorithm for the function [f] to
1033 [gc]. See the method [llvm::Function::setGC]. *)
1034 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
1036 (** [add_function_attr f a] adds attribute [a] to the return type of function
1038 external add_function_attr : llvalue -> Attribute.t -> unit
1039 = "llvm_add_function_attr"
1041 (** [remove_function_attr f a] removes attribute [a] from the return type of
1043 external remove_function_attr : llvalue -> Attribute.t -> unit
1044 = "llvm_remove_function_attr"
1046 (** {7 Operations on params} *)
1048 (** [params f] returns the parameters of function [f].
1049 See the method [llvm::Function::getArgumentList]. *)
1050 external params : llvalue -> llvalue array = "llvm_params"
1052 (** [param f n] returns the [n]th parameter of function [f].
1053 See the method [llvm::Function::getArgumentList]. *)
1054 external param : llvalue -> int -> llvalue = "llvm_param"
1056 (** [param_parent p] returns the parent function that owns the parameter.
1057 See the method [llvm::Argument::getParent]. *)
1058 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
1060 (** [param_begin f] returns the first position in the parameter list of the
1061 function [f]. [param_begin] and [param_succ] can be used to iterate over
1062 the parameter list in order.
1063 See the method [llvm::Function::arg_begin]. *)
1064 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
1066 (** [param_succ bb] returns the parameter list position succeeding
1068 See the method [llvm::Function::arg_iterator::operator++]. *)
1069 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
1071 (** [iter_params f fn] applies function [f] to each of the parameters
1072 of function [fn] in order. Tail recursive. *)
1073 val iter_params : (llvalue -> unit) -> llvalue -> unit
1075 (** [fold_left_params f init fn] is [f (... (f init b1) ...) bN] where
1076 [b1,...,bN] are the parameters of function [fn]. Tail recursive. *)
1077 val fold_left_params : ('a -> llvalue -> 'a) -> 'a -> llvalue -> 'a
1079 (** [param_end f] returns the last position in the parameter list of
1080 the function [f]. [param_end] and [param_pred] can be used to iterate
1081 over the parameter list in reverse.
1082 See the method [llvm::Function::arg_end]. *)
1083 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
1085 (** [param_pred gv] returns the function list position preceding [After gv].
1086 See the method [llvm::Function::arg_iterator::operator--]. *)
1087 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos
1090 (** [rev_iter_params f fn] applies function [f] to each of the parameters
1091 of function [fn] in reverse order. Tail recursive. *)
1092 val rev_iter_params : (llvalue -> unit) -> llvalue -> unit
1094 (** [fold_right_params f fn init] is [f (... (f init bN) ...) b1] where
1095 [b1,...,bN] are the parameters of function [fn]. Tail recursive. *)
1096 val fold_right_params : (llvalue -> 'a -> 'a) -> llvalue -> 'a -> 'a
1098 (** [add_param p a] adds attribute [a] to parameter [p]. *)
1099 external add_param_attr : llvalue -> Attribute.t -> unit = "llvm_add_param_attr"
1101 (** [remove_param_attr p a] removes attribute [a] from parameter [p]. *)
1102 external remove_param_attr : llvalue -> Attribute.t -> unit
1103 = "llvm_remove_param_attr"
1105 (** [set_param_alignment p a] set the alignment of parameter [p] to [a]. *)
1106 external set_param_alignment : llvalue -> int -> unit
1107 = "llvm_set_param_alignment"
1109 (** {7 Operations on basic blocks} *)
1111 (** [basic_blocks fn] returns the basic blocks of the function [f].
1112 See the method [llvm::Function::getBasicBlockList]. *)
1113 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
1115 (** [entry_block fn] returns the entry basic block of the function [f].
1116 See the method [llvm::Function::getEntryBlock]. *)
1117 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
1119 (** [delete_block bb] deletes the basic block [bb].
1120 See the method [llvm::BasicBlock::eraseFromParent]. *)
1121 external delete_block : llbasicblock -> unit = "llvm_delete_block"
1123 (** [append_block name f] creates a new basic block named [name] at the end of
1125 See the constructor of [llvm::BasicBlock]. *)
1126 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
1128 (** [insert_block name bb] creates a new basic block named [name] before the
1130 See the constructor of [llvm::BasicBlock]. *)
1131 external insert_block : string -> llbasicblock -> llbasicblock
1132 = "llvm_insert_block"
1134 (** [block_parent bb] returns the parent function that owns the basic block.
1135 See the method [llvm::BasicBlock::getParent]. *)
1136 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
1138 (** [block_begin f] returns the first position in the basic block list of the
1139 function [f]. [block_begin] and [block_succ] can be used to iterate over
1140 the basic block list in order.
1141 See the method [llvm::Function::begin]. *)
1142 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
1143 = "llvm_block_begin"
1145 (** [block_succ bb] returns the basic block list position succeeding
1147 See the method [llvm::Function::iterator::operator++]. *)
1148 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
1151 (** [iter_blocks f fn] applies function [f] to each of the basic blocks
1152 of function [fn] in order. Tail recursive. *)
1153 val iter_blocks : (llbasicblock -> unit) -> llvalue -> unit
1155 (** [fold_left_blocks f init fn] is [f (... (f init b1) ...) bN] where
1156 [b1,...,bN] are the basic blocks of function [fn]. Tail recursive. *)
1157 val fold_left_blocks : ('a -> llbasicblock -> 'a) -> 'a -> llvalue -> 'a
1159 (** [block_end f] returns the last position in the basic block list of
1160 the function [f]. [block_end] and [block_pred] can be used to iterate
1161 over the basic block list in reverse.
1162 See the method [llvm::Function::end]. *)
1163 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
1166 (** [block_pred gv] returns the function list position preceding [After gv].
1167 See the method [llvm::Function::iterator::operator--]. *)
1168 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
1171 (** [rev_iter_blocks f fn] applies function [f] to each of the basic blocks
1172 of function [fn] in reverse order. Tail recursive. *)
1173 val rev_iter_blocks : (llbasicblock -> unit) -> llvalue -> unit
1175 (** [fold_right_blocks f fn init] is [f (... (f init bN) ...) b1] where
1176 [b1,...,bN] are the basic blocks of function [fn]. Tail recursive. *)
1177 val fold_right_blocks : (llbasicblock -> 'a -> 'a) -> llvalue -> 'a -> 'a
1179 (** [value_of_block bb] losslessly casts [bb] to an [llvalue]. *)
1180 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
1182 (** [value_is_block v] returns [true] if the value [v] is a basic block and
1184 Similar to [llvm::isa<BasicBlock>]. *)
1185 external value_is_block : llvalue -> bool = "llvm_value_is_block"
1187 (** [block_of_value v] losslessly casts [v] to an [llbasicblock]. *)
1188 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
1191 (** {7 Operations on instructions} *)
1193 (** [instr_parent i] is the enclosing basic block of the instruction [i].
1194 See the method [llvm::Instruction::getParent]. *)
1195 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
1197 (** [instr_begin bb] returns the first position in the instruction list of the
1198 basic block [bb]. [instr_begin] and [instr_succ] can be used to iterate over
1199 the instruction list in order.
1200 See the method [llvm::BasicBlock::begin]. *)
1201 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
1202 = "llvm_instr_begin"
1204 (** [instr_succ i] returns the instruction list position succeeding [Before i].
1205 See the method [llvm::BasicBlock::iterator::operator++]. *)
1206 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
1209 (** [iter_instrs f bb] applies function [f] to each of the instructions of basic
1210 block [bb] in order. Tail recursive. *)
1211 val iter_instrs: (llvalue -> unit) -> llbasicblock -> unit
1213 (** [fold_left_instrs f init bb] is [f (... (f init g1) ...) gN] where
1214 [g1,...,gN] are the instructions of basic block [bb]. Tail recursive. *)
1215 val fold_left_instrs: ('a -> llvalue -> 'a) -> 'a -> llbasicblock -> 'a
1217 (** [instr_end bb] returns the last position in the instruction list of the
1218 basic block [bb]. [instr_end] and [instr_pred] can be used to iterate over
1219 the instruction list in reverse.
1220 See the method [llvm::BasicBlock::end]. *)
1221 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
1224 (** [instr_pred i] returns the instruction list position preceding [After i].
1225 See the method [llvm::BasicBlock::iterator::operator--]. *)
1226 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
1229 (** [fold_right_instrs f bb init] is [f (... (f init fN) ...) f1] where
1230 [f1,...,fN] are the instructions of basic block [bb]. Tail recursive. *)
1231 val fold_right_instrs: (llvalue -> 'a -> 'a) -> llbasicblock -> 'a -> 'a
1234 (** {7 Operations on call sites} *)
1236 (** [instruction_call_conv ci] is the calling convention for the call or invoke
1237 instruction [ci], which may be one of the values from the module
1238 {!CallConv}. See the method [llvm::CallInst::getCallingConv] and
1239 [llvm::InvokeInst::getCallingConv]. *)
1240 external instruction_call_conv: llvalue -> int
1241 = "llvm_instruction_call_conv"
1243 (** [set_instruction_call_conv cc ci] sets the calling convention for the call
1244 or invoke instruction [ci] to the integer [cc], which can be one of the
1245 values from the module {!CallConv}.
1246 See the method [llvm::CallInst::setCallingConv]
1247 and [llvm::InvokeInst::setCallingConv]. *)
1248 external set_instruction_call_conv: int -> llvalue -> unit
1249 = "llvm_set_instruction_call_conv"
1251 (** [add_instruction_param_attr ci i a] adds attribute [a] to the [i]th
1252 parameter of the call or invoke instruction [ci]. [i]=0 denotes the return
1254 external add_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
1255 = "llvm_add_instruction_param_attr"
1257 (** [remove_instruction_param_attr ci i a] removes attribute [a] from the
1258 [i]th parameter of the call or invoke instruction [ci]. [i]=0 denotes the
1260 external remove_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
1261 = "llvm_remove_instruction_param_attr"
1263 (** {Operations on call instructions (only)} *)
1265 (** [is_tail_call ci] is [true] if the call instruction [ci] is flagged as
1266 eligible for tail call optimization, [false] otherwise.
1267 See the method [llvm::CallInst::isTailCall]. *)
1268 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
1270 (** [set_tail_call tc ci] flags the call instruction [ci] as eligible for tail
1271 call optimization if [tc] is [true], clears otherwise.
1272 See the method [llvm::CallInst::setTailCall]. *)
1273 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
1275 (** {7 Operations on phi nodes} *)
1277 (** [add_incoming (v, bb) pn] adds the value [v] to the phi node [pn] for use
1278 with branches from [bb]. See the method [llvm::PHINode::addIncoming]. *)
1279 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
1280 = "llvm_add_incoming"
1282 (** [incoming pn] returns the list of value-block pairs for phi node [pn].
1283 See the method [llvm::PHINode::getIncomingValue]. *)
1284 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
1288 (** {6 Instruction builders} *)
1290 (** [builder ()] creates an instruction builder with no position. It is invalid
1291 to use this builder until its position is set with {!position_before} or
1292 {!position_at_end}. See the constructor for [llvm::LLVMBuilder]. *)
1293 external builder : unit -> llbuilder = "llvm_builder"
1295 (** [builder_at ip] creates an instruction builder positioned at [ip].
1296 See the constructor for [llvm::LLVMBuilder]. *)
1297 val builder_at : (llbasicblock, llvalue) llpos -> llbuilder
1299 (** [builder_before ins] creates an instruction builder positioned before the
1300 instruction [isn]. See the constructor for [llvm::LLVMBuilder]. *)
1301 val builder_before : llvalue -> llbuilder
1303 (** [builder_at_end bb] creates an instruction builder positioned at the end of
1304 the basic block [bb]. See the constructor for [llvm::LLVMBuilder]. *)
1305 val builder_at_end : llbasicblock -> llbuilder
1307 (** [position_builder ip bb] moves the instruction builder [bb] to the position
1309 See the constructor for [llvm::LLVMBuilder]. *)
1310 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
1311 = "llvm_position_builder"
1313 (** [position_before ins b] moves the instruction builder [b] to before the
1314 instruction [isn]. See the method [llvm::LLVMBuilder::SetInsertPoint]. *)
1315 val position_before : llvalue -> llbuilder -> unit
1317 (** [position_at_end bb b] moves the instruction builder [b] to the end of the
1318 basic block [bb]. See the method [llvm::LLVMBuilder::SetInsertPoint]. *)
1319 val position_at_end : llbasicblock -> llbuilder -> unit
1321 (** [insertion_block b] returns the basic block that the builder [b] is
1322 positioned to insert into. Raises [Not_Found] if the instruction builder is
1324 See the method [llvm::LLVMBuilder::GetInsertBlock]. *)
1325 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
1327 (** [insert_into_builder i name b] inserts the specified instruction [i] at the
1328 position specified by the instruction builder [b].
1329 See the method [llvm::LLVMBuilder::Insert]. *)
1330 external insert_into_builder : llvalue -> string -> llbuilder -> unit
1331 = "llvm_insert_into_builder"
1334 (** {7 Terminators} *)
1336 (** [build_ret_void b] creates a
1338 instruction at the position specified by the instruction builder [b].
1339 See the method [llvm::LLVMBuilder::CreateRetVoid]. *)
1340 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
1342 (** [build_ret v b] creates a
1344 instruction at the position specified by the instruction builder [b].
1345 See the method [llvm::LLVMBuilder::CreateRet]. *)
1346 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
1348 (** [build_aggregate_ret vs b] creates a
1349 [ret {...} { %v1, %v2, ... } ]
1350 instruction at the position specified by the instruction builder [b].
1351 See the method [llvm::LLVMBuilder::CreateAggregateRet]. *)
1352 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
1353 = "llvm_build_aggregate_ret"
1355 (** [build_br bb b] creates a
1357 instruction at the position specified by the instruction builder [b].
1358 See the method [llvm::LLVMBuilder::CreateBr]. *)
1359 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
1361 (** [build_cond_br cond tbb fbb b] creates a
1362 [b %cond, %tbb, %fbb]
1363 instruction at the position specified by the instruction builder [b].
1364 See the method [llvm::LLVMBuilder::CreateCondBr]. *)
1365 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
1366 llvalue = "llvm_build_cond_br"
1368 (** [build_switch case elsebb count b] creates an empty
1369 [switch %case, %elsebb]
1370 instruction at the position specified by the instruction builder [b] with
1371 space reserved for [count] cases.
1372 See the method [llvm::LLVMBuilder::CreateSwitch]. *)
1373 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
1374 = "llvm_build_switch"
1376 (** [add_case sw onval bb] causes switch instruction [sw] to branch to [bb]
1377 when its input matches the constant [onval].
1378 See the method [llvm::SwitchInst::addCase]. **)
1379 external add_case : llvalue -> llvalue -> llbasicblock -> unit
1382 (** [build_invoke fn args tobb unwindbb name b] creates an
1383 [%name = invoke %fn(args) to %tobb unwind %unwindbb]
1384 instruction at the position specified by the instruction builder [b].
1385 See the method [llvm::LLVMBuilder::CreateInvoke]. *)
1386 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
1387 llbasicblock -> string -> llbuilder -> llvalue
1388 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
1390 (** [build_unwind b] creates an
1392 instruction at the position specified by the instruction builder [b].
1393 See the method [llvm::LLVMBuilder::CreateUnwind]. *)
1394 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
1396 (** [build_unreachable b] creates an
1398 instruction at the position specified by the instruction builder [b].
1399 See the method [llvm::LLVMBuilder::CreateUnwind]. *)
1400 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
1403 (** {7 Arithmetic} *)
1405 (** [build_add x y name b] creates a
1406 [%name = add %x, %y]
1407 instruction at the position specified by the instruction builder [b].
1408 See the method [llvm::LLVMBuilder::CreateAdd]. *)
1409 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
1412 (** [build_nswadd x y name b] creates a
1413 [%name = nsw add %x, %y]
1414 instruction at the position specified by the instruction builder [b].
1415 See the method [llvm::LLVMBuilder::CreateNSWAdd]. *)
1416 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
1417 = "llvm_build_nsw_add"
1419 (** [build_fadd x y name b] creates a
1420 [%name = fadd %x, %y]
1421 instruction at the position specified by the instruction builder [b].
1422 See the method [llvm::LLVMBuilder::CreateFAdd]. *)
1423 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
1426 (** [build_sub x y name b] creates a
1427 [%name = sub %x, %y]
1428 instruction at the position specified by the instruction builder [b].
1429 See the method [llvm::LLVMBuilder::CreateSub]. *)
1430 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1433 (** [build_fsub x y name b] creates a
1434 [%name = fsub %x, %y]
1435 instruction at the position specified by the instruction builder [b].
1436 See the method [llvm::LLVMBuilder::CreateFSub]. *)
1437 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1440 (** [build_mul x y name b] creates a
1441 [%name = mul %x, %y]
1442 instruction at the position specified by the instruction builder [b].
1443 See the method [llvm::LLVMBuilder::CreateMul]. *)
1444 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1447 (** [build_fmul x y name b] creates a
1448 [%name = fmul %x, %y]
1449 instruction at the position specified by the instruction builder [b].
1450 See the method [llvm::LLVMBuilder::CreateFMul]. *)
1451 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1454 (** [build_udiv x y name b] creates a
1455 [%name = udiv %x, %y]
1456 instruction at the position specified by the instruction builder [b].
1457 See the method [llvm::LLVMBuilder::CreateUDiv]. *)
1458 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1461 (** [build_sdiv x y name b] creates a
1462 [%name = sdiv %x, %y]
1463 instruction at the position specified by the instruction builder [b].
1464 See the method [llvm::LLVMBuilder::CreateSDiv]. *)
1465 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1468 (** [build_exact_sdiv x y name b] creates a
1469 [%name = exact sdiv %x, %y]
1470 instruction at the position specified by the instruction builder [b].
1471 See the method [llvm::LLVMBuilder::CreateExactSDiv]. *)
1472 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1473 = "llvm_build_exact_sdiv"
1475 (** [build_fdiv x y name b] creates a
1476 [%name = fdiv %x, %y]
1477 instruction at the position specified by the instruction builder [b].
1478 See the method [llvm::LLVMBuilder::CreateFDiv]. *)
1479 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1482 (** [build_urem x y name b] creates a
1483 [%name = urem %x, %y]
1484 instruction at the position specified by the instruction builder [b].
1485 See the method [llvm::LLVMBuilder::CreateURem]. *)
1486 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
1489 (** [build_SRem x y name b] creates a
1490 [%name = srem %x, %y]
1491 instruction at the position specified by the instruction builder [b].
1492 See the method [llvm::LLVMBuilder::CreateSRem]. *)
1493 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
1496 (** [build_frem x y name b] creates a
1497 [%name = frem %x, %y]
1498 instruction at the position specified by the instruction builder [b].
1499 See the method [llvm::LLVMBuilder::CreateFRem]. *)
1500 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
1503 (** [build_shl x y name b] creates a
1504 [%name = shl %x, %y]
1505 instruction at the position specified by the instruction builder [b].
1506 See the method [llvm::LLVMBuilder::CreateShl]. *)
1507 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
1510 (** [build_lshr x y name b] creates a
1511 [%name = lshr %x, %y]
1512 instruction at the position specified by the instruction builder [b].
1513 See the method [llvm::LLVMBuilder::CreateLShr]. *)
1514 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
1517 (** [build_ashr x y name b] creates a
1518 [%name = ashr %x, %y]
1519 instruction at the position specified by the instruction builder [b].
1520 See the method [llvm::LLVMBuilder::CreateAShr]. *)
1521 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
1524 (** [build_and x y name b] creates a
1525 [%name = and %x, %y]
1526 instruction at the position specified by the instruction builder [b].
1527 See the method [llvm::LLVMBuilder::CreateAnd]. *)
1528 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
1531 (** [build_or x y name b] creates a
1533 instruction at the position specified by the instruction builder [b].
1534 See the method [llvm::LLVMBuilder::CreateOr]. *)
1535 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
1538 (** [build_xor x y name b] creates a
1539 [%name = xor %x, %y]
1540 instruction at the position specified by the instruction builder [b].
1541 See the method [llvm::LLVMBuilder::CreateXor]. *)
1542 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
1545 (** [build_neg x name b] creates a
1547 instruction at the position specified by the instruction builder [b].
1548 [-0.0] is used for floating point types to compute the correct sign.
1549 See the method [llvm::LLVMBuilder::CreateNeg]. *)
1550 external build_neg : llvalue -> string -> llbuilder -> llvalue
1553 (** [build_xor x name b] creates a
1554 [%name = xor %x, -1]
1555 instruction at the position specified by the instruction builder [b].
1556 [-1] is the correct "all ones" value for the type of [x].
1557 See the method [llvm::LLVMBuilder::CreateXor]. *)
1558 external build_not : llvalue -> string -> llbuilder -> llvalue
1564 (** [build_malloc ty name b] creates a
1565 [%name = malloc %ty]
1566 instruction at the position specified by the instruction builder [b].
1567 See the method [llvm::LLVMBuilder::CreateAlloca]. *)
1568 external build_malloc : lltype -> string -> llbuilder -> llvalue
1569 = "llvm_build_malloc"
1571 (** [build_array_malloc ty n name b] creates a
1572 [%name = malloc %ty, %n]
1573 instruction at the position specified by the instruction builder [b].
1574 See the method [llvm::LLVMBuilder::CreateMalloc]. *)
1575 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
1576 llvalue = "llvm_build_array_malloc"
1578 (** [build_alloca ty name b] creates a
1579 [%name = alloca %ty]
1580 instruction at the position specified by the instruction builder [b].
1581 See the method [llvm::LLVMBuilder::CreateAlloca]. *)
1582 external build_alloca : lltype -> string -> llbuilder -> llvalue
1583 = "llvm_build_alloca"
1585 (** [build_array_alloca ty n name b] creates a
1586 [%name = alloca %ty, %n]
1587 instruction at the position specified by the instruction builder [b].
1588 See the method [llvm::LLVMBuilder::CreateAlloca]. *)
1589 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
1590 llvalue = "llvm_build_array_alloca"
1592 (** [build_free v b] creates a
1594 instruction at the position specified by the instruction builder [b].
1595 See the method [llvm::LLVMBuilder::CreateFree]. *)
1596 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
1598 (** [build_load v name b] creates a
1600 instruction at the position specified by the instruction builder [b].
1601 See the method [llvm::LLVMBuilder::CreateLoad]. *)
1602 external build_load : llvalue -> string -> llbuilder -> llvalue
1605 (** [build_store v p b] creates a
1607 instruction at the position specified by the instruction builder [b].
1608 See the method [llvm::LLVMBuilder::CreateStore]. *)
1609 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
1610 = "llvm_build_store"
1612 (** [build_gep p indices name b] creates a
1613 [%name = getelementptr %p, indices...]
1614 instruction at the position specified by the instruction builder [b].
1615 See the method [llvm::LLVMBuilder::CreateGetElementPtr]. *)
1616 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
1619 (** [build_in_bounds_gep p indices name b] creates a
1620 [%name = gelementptr inbounds %p, indices...]
1621 instruction at the position specified by the instruction builder [b].
1622 See the method [llvm::LLVMBuilder::CreateInBoundsGetElementPtr]. *)
1623 external build_in_bounds_gep : llvalue -> llvalue array -> string -> llbuilder ->
1624 llvalue = "llvm_build_in_bounds_gep"
1626 (** [build_struct_gep p idx name b] creates a
1627 [%name = getelementptr %p, 0, idx]
1628 instruction at the position specified by the instruction builder [b].
1629 See the method [llvm::LLVMBuilder::CreateStructGetElementPtr]. *)
1630 external build_struct_gep : llvalue -> int -> string -> llbuilder ->
1631 llvalue = "llvm_build_struct_gep"
1633 (** [build_global_string str name b] creates a series of instructions that adds
1634 a global string at the position specified by the instruction builder [b].
1635 See the method [llvm::LLVMBuilder::CreateGlobalString]. *)
1636 external build_global_string : string -> string -> llbuilder -> llvalue
1637 = "llvm_build_global_string"
1639 (** [build_global_stringptr str name b] creates a series of instructions that
1640 adds a global string pointer at the position specified by the instruction
1642 See the method [llvm::LLVMBuilder::CreateGlobalStringPtr]. *)
1643 external build_global_stringptr : string -> string -> llbuilder -> llvalue
1644 = "llvm_build_global_stringptr"
1649 (** [build_trunc v ty name b] creates a
1650 [%name = trunc %p to %ty]
1651 instruction at the position specified by the instruction builder [b].
1652 See the method [llvm::LLVMBuilder::CreateTrunc]. *)
1653 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
1654 = "llvm_build_trunc"
1656 (** [build_zext v ty name b] creates a
1657 [%name = zext %p to %ty]
1658 instruction at the position specified by the instruction builder [b].
1659 See the method [llvm::LLVMBuilder::CreateZExt]. *)
1660 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
1663 (** [build_sext v ty name b] creates a
1664 [%name = sext %p to %ty]
1665 instruction at the position specified by the instruction builder [b].
1666 See the method [llvm::LLVMBuilder::CreateSExt]. *)
1667 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
1670 (** [build_fptoui v ty name b] creates a
1671 [%name = fptoui %p to %ty]
1672 instruction at the position specified by the instruction builder [b].
1673 See the method [llvm::LLVMBuilder::CreateFPToUI]. *)
1674 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
1675 = "llvm_build_fptoui"
1677 (** [build_fptosi v ty name b] creates a
1678 [%name = fptosi %p to %ty]
1679 instruction at the position specified by the instruction builder [b].
1680 See the method [llvm::LLVMBuilder::CreateFPToSI]. *)
1681 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
1682 = "llvm_build_fptosi"
1684 (** [build_uitofp v ty name b] creates a
1685 [%name = uitofp %p to %ty]
1686 instruction at the position specified by the instruction builder [b].
1687 See the method [llvm::LLVMBuilder::CreateUIToFP]. *)
1688 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
1689 = "llvm_build_uitofp"
1691 (** [build_sitofp v ty name b] creates a
1692 [%name = sitofp %p to %ty]
1693 instruction at the position specified by the instruction builder [b].
1694 See the method [llvm::LLVMBuilder::CreateSIToFP]. *)
1695 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
1696 = "llvm_build_sitofp"
1698 (** [build_fptrunc v ty name b] creates a
1699 [%name = fptrunc %p to %ty]
1700 instruction at the position specified by the instruction builder [b].
1701 See the method [llvm::LLVMBuilder::CreateFPTrunc]. *)
1702 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
1703 = "llvm_build_fptrunc"
1705 (** [build_fpext v ty name b] creates a
1706 [%name = fpext %p to %ty]
1707 instruction at the position specified by the instruction builder [b].
1708 See the method [llvm::LLVMBuilder::CreateFPExt]. *)
1709 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
1710 = "llvm_build_fpext"
1712 (** [build_ptrtoint v ty name b] creates a
1713 [%name = prtotint %p to %ty]
1714 instruction at the position specified by the instruction builder [b].
1715 See the method [llvm::LLVMBuilder::CreatePtrToInt]. *)
1716 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
1717 = "llvm_build_prttoint"
1719 (** [build_inttoptr v ty name b] creates a
1720 [%name = inttoptr %p to %ty]
1721 instruction at the position specified by the instruction builder [b].
1722 See the method [llvm::LLVMBuilder::CreateIntToPtr]. *)
1723 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
1724 = "llvm_build_inttoptr"
1726 (** [build_bitcast v ty name b] creates a
1727 [%name = bitcast %p to %ty]
1728 instruction at the position specified by the instruction builder [b].
1729 See the method [llvm::LLVMBuilder::CreateBitCast]. *)
1730 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1731 = "llvm_build_bitcast"
1733 (** [build_zext_or_bitcast v ty name b] creates a zext or bitcast
1734 instruction at the position specified by the instruction builder [b].
1735 See the method [llvm::LLVMBuilder::CreateZExtOrBitCast]. *)
1736 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1737 llvalue = "llvm_build_zext_or_bitcast"
1739 (** [build_sext_or_bitcast v ty name b] creates a sext or bitcast
1740 instruction at the position specified by the instruction builder [b].
1741 See the method [llvm::LLVMBuilder::CreateSExtOrBitCast]. *)
1742 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1743 llvalue = "llvm_build_sext_or_bitcast"
1745 (** [build_trunc_or_bitcast v ty name b] creates a trunc or bitcast
1746 instruction at the position specified by the instruction builder [b].
1747 See the method [llvm::LLVMBuilder::CreateZExtOrBitCast]. *)
1748 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1749 llvalue = "llvm_build_trunc_or_bitcast"
1751 (** [build_pointercast v ty name b] creates a bitcast or pointer-to-int
1752 instruction at the position specified by the instruction builder [b].
1753 See the method [llvm::LLVMBuilder::CreatePointerCast]. *)
1754 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
1755 = "llvm_build_pointercast"
1757 (** [build_intcast v ty name b] creates a zext, bitcast, or trunc
1758 instruction at the position specified by the instruction builder [b].
1759 See the method [llvm::LLVMBuilder::CreateIntCast]. *)
1760 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1761 = "llvm_build_intcast"
1763 (** [build_fpcast v ty name b] creates a fpext, bitcast, or fptrunc
1764 instruction at the position specified by the instruction builder [b].
1765 See the method [llvm::LLVMBuilder::CreateFPCast]. *)
1766 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1767 = "llvm_build_fpcast"
1770 (** {7 Comparisons} *)
1772 (** [build_icmp pred x y name b] creates a
1773 [%name = icmp %pred %x, %y]
1774 instruction at the position specified by the instruction builder [b].
1775 See the method [llvm::LLVMBuilder::CreateICmp]. *)
1776 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
1777 llbuilder -> llvalue = "llvm_build_icmp"
1779 (** [build_fcmp pred x y name b] creates a
1780 [%name = fcmp %pred %x, %y]
1781 instruction at the position specified by the instruction builder [b].
1782 See the method [llvm::LLVMBuilder::CreateFCmp]. *)
1783 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
1784 llbuilder -> llvalue = "llvm_build_fcmp"
1787 (** {7 Miscellaneous instructions} *)
1789 (** [build_phi incoming name b] creates a
1790 [%name = phi %incoming]
1791 instruction at the position specified by the instruction builder [b].
1792 [incoming] is a list of [(llvalue, llbasicblock)] tuples.
1793 See the method [llvm::LLVMBuilder::CreatePHI]. *)
1794 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
1795 llvalue = "llvm_build_phi"
1797 (** [build_call fn args name b] creates a
1798 [%name = call %fn(args...)]
1799 instruction at the position specified by the instruction builder [b].
1800 See the method [llvm::LLVMBuilder::CreateCall]. *)
1801 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
1804 (** [build_select cond thenv elsev name b] creates a
1805 [%name = select %cond, %thenv, %elsev]
1806 instruction at the position specified by the instruction builder [b].
1807 See the method [llvm::LLVMBuilder::CreateSelect]. *)
1808 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
1809 llvalue = "llvm_build_select"
1811 (** [build_va_arg valist argty name b] creates a
1812 [%name = va_arg %valist, %argty]
1813 instruction at the position specified by the instruction builder [b].
1814 See the method [llvm::LLVMBuilder::CreateVAArg]. *)
1815 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
1816 = "llvm_build_va_arg"
1818 (** [build_extractelement vec i name b] creates a
1819 [%name = extractelement %vec, %i]
1820 instruction at the position specified by the instruction builder [b].
1821 See the method [llvm::LLVMBuilder::CreateExtractElement]. *)
1822 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
1823 llvalue = "llvm_build_extractelement"
1825 (** [build_insertelement vec elt i name b] creates a
1826 [%name = insertelement %vec, %elt, %i]
1827 instruction at the position specified by the instruction builder [b].
1828 See the method [llvm::LLVMBuilder::CreateInsertElement]. *)
1829 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
1830 llbuilder -> llvalue = "llvm_build_insertelement"
1832 (** [build_shufflevector veca vecb mask name b] creates a
1833 [%name = shufflevector %veca, %vecb, %mask]
1834 instruction at the position specified by the instruction builder [b].
1835 See the method [llvm::LLVMBuilder::CreateShuffleVector]. *)
1836 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
1837 llbuilder -> llvalue = "llvm_build_shufflevector"
1839 (** [build_insertvalue agg idx name b] creates a
1840 [%name = extractvalue %agg, %idx]
1841 instruction at the position specified by the instruction builder [b].
1842 See the method [llvm::LLVMBuilder::CreateExtractValue]. *)
1843 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
1844 = "llvm_build_extractvalue"
1846 (** [build_insertvalue agg val idx name b] creates a
1847 [%name = insertvalue %agg, %val, %idx]
1848 instruction at the position specified by the instruction builder [b].
1849 See the method [llvm::LLVMBuilder::CreateInsertValue]. *)
1850 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
1851 llvalue = "llvm_build_insertvalue"
1853 (** [build_is_null val name b] creates a
1854 [%name = icmp eq %val, null]
1855 instruction at the position specified by the instruction builder [b].
1856 See the method [llvm::LLVMBuilder::CreateIsNull]. *)
1857 external build_is_null : llvalue -> string -> llbuilder -> llvalue
1858 = "llvm_build_is_null"
1860 (** [build_is_not_null val name b] creates a
1861 [%name = icmp ne %val, null]
1862 instruction at the position specified by the instruction builder [b].
1863 See the method [llvm::LLVMBuilder::CreateIsNotNull]. *)
1864 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
1865 = "llvm_build_is_not_null"
1867 (** [build_ptrdiff lhs rhs name b] creates a series of instructions that measure
1868 the difference between two pointer values at the position specified by the
1869 instruction builder [b].
1870 See the method [llvm::LLVMBuilder::CreatePtrDiff]. *)
1871 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
1872 = "llvm_build_ptrdiff"
1874 (** {6 Module providers} *)
1876 module ModuleProvider : sig
1877 (** [create_module_provider m] encapsulates [m] in a module provider and takes
1878 ownership of the module. See the constructor
1879 [llvm::ExistingModuleProvider::ExistingModuleProvider]. *)
1880 external create : llmodule -> llmoduleprovider
1881 = "LLVMCreateModuleProviderForExistingModule"
1883 (** [dispose_module_provider mp] destroys the module provider [mp] as well as
1884 the contained module. *)
1885 external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider"
1889 (** {6 Memory buffers} *)
1891 module MemoryBuffer : sig
1892 (** [of_file p] is the memory buffer containing the contents of the file at
1893 path [p]. If the file could not be read, then [IoError msg] is
1895 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
1897 (** [stdin ()] is the memory buffer containing the contents of standard input.
1898 If standard input is empty, then [IoError msg] is raised. *)
1899 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
1901 (** Disposes of a memory buffer. *)
1902 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
1906 (** {6 Pass Managers} *)
1908 module PassManager : sig
1911 type any = [ `Module | `Function ]
1913 (** [PassManager.create ()] constructs a new whole-module pass pipeline. This
1914 type of pipeline is suitable for link-time optimization and whole-module
1916 See the constructor of [llvm::PassManager]. *)
1917 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
1919 (** [PassManager.create_function mp] constructs a new function-by-function
1920 pass pipeline over the module provider [mp]. It does not take ownership of
1921 [mp]. This type of pipeline is suitable for code generation and JIT
1923 See the constructor of [llvm::FunctionPassManager]. *)
1924 external create_function : llmoduleprovider -> [ `Function ] t
1925 = "LLVMCreateFunctionPassManager"
1927 (** [run_module m pm] initializes, executes on the module [m], and finalizes
1928 all of the passes scheduled in the pass manager [pm]. Returns [true] if
1929 any of the passes modified the module, [false] otherwise.
1930 See the [llvm::PassManager::run] method. *)
1931 external run_module : llmodule -> [ `Module ] t -> bool
1932 = "llvm_passmanager_run_module"
1934 (** [initialize fpm] initializes all of the function passes scheduled in the
1935 function pass manager [fpm]. Returns [true] if any of the passes modified
1936 the module, [false] otherwise.
1937 See the [llvm::FunctionPassManager::doInitialization] method. *)
1938 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
1940 (** [run_function f fpm] executes all of the function passes scheduled in the
1941 function pass manager [fpm] over the function [f]. Returns [true] if any
1942 of the passes modified [f], [false] otherwise.
1943 See the [llvm::FunctionPassManager::run] method. *)
1944 external run_function : llvalue -> [ `Function ] t -> bool
1945 = "llvm_passmanager_run_function"
1947 (** [finalize fpm] finalizes all of the function passes scheduled in in the
1948 function pass manager [fpm]. Returns [true] if any of the passes
1949 modified the module, [false] otherwise.
1950 See the [llvm::FunctionPassManager::doFinalization] method. *)
1951 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
1953 (** Frees the memory of a pass pipeline. For function pipelines, does not free
1954 the module provider.
1955 See the destructor of [llvm::BasePassManager]. *)
1956 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"