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 LLVM global data. See the
21 [llvm::LLVMContext] class. *)
24 (** The top-level container for all other LLVM Intermediate Representation (IR)
25 objects. See the [llvm::Module] class. *)
28 (** Each value in the LLVM IR has a type, an instance of [lltype]. See the
29 [llvm::Type] class. *)
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. *)
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. *)
42 (** A basic block in LLVM IR. See the [llvm::BasicBlock] class. *)
45 (** Used to generate instructions in the LLVM IR. See the [llvm::LLVMBuilder]
49 (** Used to provide a module to JIT or interpreter.
50 See the [llvm::ModuleProvider] class. *)
53 (** Used to efficiently handle large buffers of read-only binary data.
54 See the [llvm::MemoryBuffer] class. *)
57 (** The kind of an [lltype], the result of [classify_type ty]. See the
58 [llvm::Type::TypeID] enumeration. *)
79 (** The linkage of a global value, accessed with {!linkage} and
80 {!set_linkage}. See [llvm::GlobalValue::LinkageTypes]. *)
84 | Available_externally
100 (** The linker visibility of a global value, accessed with {!visibility} and
101 {!set_visibility}. See [llvm::GlobalValue::VisibilityTypes]. *)
102 module Visibility : sig
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. *)
112 module 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
117 val cold : int (** [cold] is the calling convention for
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. *)
125 module Attribute : sig
150 (** The predicate for an integer comparison ([icmp]) instruction.
151 See the [llvm::ICmpInst::Predicate] enumeration. *)
166 (** The predicate for a floating-point comparison ([fcmp]) instruction.
167 See the [llvm::FCmpInst::Predicate] enumeration. *)
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. *)
194 type ('a, 'b) llpos =
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. *)
201 type ('a, 'b) llrev_pos =
206 (** {6 Exceptions} *)
208 exception IoError of string
213 (** [create_context ()] creates a context for storing the "global" state in
214 LLVM. See the constructor [llvm::LLVMContext]. *)
215 external create_context : unit -> llcontext = "llvm_create_context"
217 (** [destroy_context ()] destroys a context. See the destructor
218 [llvm::LLVMContext::~LLVMContext]. *)
219 external dispose_context : llcontext -> unit = "llvm_dispose_context"
221 (** See the function [llvm::getGlobalContext]. *)
222 external global_context : unit -> llcontext = "llvm_global_context"
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]. *)
227 external mdkind_id : llcontext -> string -> int = "llvm_mdkind_id"
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]. *)
236 external create_module : llcontext -> string -> llmodule = "llvm_create_module"
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]. *)
242 external dispose_module : llmodule -> unit = "llvm_dispose_module"
244 (** [target_triple m] is the target specifier for the module [m], something like
245 [i686-apple-darwin8]. See the method [llvm::Module::getTargetTriple]. *)
246 external target_triple: llmodule -> string
247 = "llvm_target_triple"
249 (** [target_triple triple m] changes the target specifier for the module [m] to
250 the string [triple]. See the method [llvm::Module::setTargetTriple]. *)
251 external set_target_triple: string -> llmodule -> unit
252 = "llvm_set_target_triple"
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]. *)
257 external data_layout: llmodule -> string
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]. *)
262 external set_data_layout: string -> llmodule -> unit
263 = "llvm_set_data_layout"
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]
269 external define_type_name : string -> lltype -> llmodule -> bool
270 = "llvm_add_type_name"
272 (** [delete_type_name name] removes a type name from the module's symbol
274 external delete_type_name : string -> llmodule -> unit
275 = "llvm_delete_type_name"
277 (** [type_by_name m n] returns the type in the module [m] named [n], or [None]
278 if it does not exist. See the method [llvm::Module::getTypeByName]. *)
279 external type_by_name : llmodule -> string -> lltype option
280 = "llvm_type_by_name"
282 (** [dump_module m] prints the .ll representation of the module [m] to standard
283 error. See the method [llvm::Module::dump]. *)
284 external dump_module : llmodule -> unit = "llvm_dump_module"
289 (** [classify_type ty] returns the {!TypeKind.t} corresponding to the type [ty].
290 See the method [llvm::Type::getTypeID]. *)
291 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
293 (** [type_context ty] returns the {!llcontext} corresponding to the type [ty].
294 See the method [llvm::Type::getContext]. *)
295 external type_context : lltype -> llcontext = "llvm_type_context"
297 (** [string_of_lltype ty] returns a string describing the type [ty]. *)
298 val string_of_lltype : lltype -> string
300 (** {7 Operations on integer types} *)
302 (** [i1_type c] returns an integer type of bitwidth 1 in the context [c]. See
303 [llvm::Type::Int1Ty]. *)
304 external i1_type : llcontext -> lltype = "llvm_i1_type"
306 (** [i8_type c] returns an integer type of bitwidth 8 in the context [c]. See
307 [llvm::Type::Int8Ty]. *)
308 external i8_type : llcontext -> lltype = "llvm_i8_type"
310 (** [i16_type c] returns an integer type of bitwidth 16 in the context [c]. See
311 [llvm::Type::Int16Ty]. *)
312 external i16_type : llcontext -> lltype = "llvm_i16_type"
314 (** [i32_type c] returns an integer type of bitwidth 32 in the context [c]. See
315 [llvm::Type::Int32Ty]. *)
316 external i32_type : llcontext -> lltype = "llvm_i32_type"
318 (** [i64_type c] returns an integer type of bitwidth 64 in the context [c]. See
319 [llvm::Type::Int64Ty]. *)
320 external i64_type : llcontext -> lltype = "llvm_i64_type"
322 (** [integer_type c n] returns an integer type of bitwidth [n] in the context
323 [c]. See the method [llvm::IntegerType::get]. *)
324 external integer_type : llcontext -> int -> lltype = "llvm_integer_type"
326 (** [integer_bitwidth c ty] returns the number of bits in the integer type [ty]
327 in the context [c]. See the method [llvm::IntegerType::getBitWidth]. *)
328 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
331 (** {7 Operations on real types} *)
333 (** [float_type c] returns the IEEE 32-bit floating point type in the context
334 [c]. See [llvm::Type::FloatTy]. *)
335 external float_type : llcontext -> lltype = "llvm_float_type"
337 (** [double_type c] returns the IEEE 64-bit floating point type in the context
338 [c]. See [llvm::Type::DoubleTy]. *)
339 external double_type : llcontext -> lltype = "llvm_double_type"
341 (** [x86fp80_type c] returns the x87 80-bit floating point type in the context
342 [c]. See [llvm::Type::X86_FP80Ty]. *)
343 external x86fp80_type : llcontext -> lltype = "llvm_x86fp80_type"
345 (** [fp128_type c] returns the IEEE 128-bit floating point type in the context
346 [c]. See [llvm::Type::FP128Ty]. *)
347 external fp128_type : llcontext -> lltype = "llvm_fp128_type"
349 (** [ppc_fp128_type c] returns the PowerPC 128-bit floating point type in the
350 context [c]. See [llvm::Type::PPC_FP128Ty]. *)
351 external ppc_fp128_type : llcontext -> lltype = "llvm_ppc_fp128_type"
354 (** {7 Operations on function types} *)
356 (** [function_type ret_ty param_tys] returns the function type returning
357 [ret_ty] and taking [param_tys] as parameters.
358 See the method [llvm::FunctionType::get]. *)
359 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
361 (** [va_arg_function_type ret_ty param_tys] is just like
362 [function_type ret_ty param_tys] except that it returns the function type
363 which also takes a variable number of arguments.
364 See the method [llvm::FunctionType::get]. *)
365 external var_arg_function_type : lltype -> lltype array -> lltype
366 = "llvm_var_arg_function_type"
368 (** [is_var_arg fty] returns [true] if [fty] is a varargs function type, [false]
369 otherwise. See the method [llvm::FunctionType::isVarArg]. *)
370 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
372 (** [return_type fty] gets the return type of the function type [fty].
373 See the method [llvm::FunctionType::getReturnType]. *)
374 external return_type : lltype -> lltype = "LLVMGetReturnType"
376 (** [param_types fty] gets the parameter types of the function type [fty].
377 See the method [llvm::FunctionType::getParamType]. *)
378 external param_types : lltype -> lltype array = "llvm_param_types"
381 (** {7 Operations on struct types} *)
383 (** [struct_type context tys] returns the structure type in the context
384 [context] containing in the types in the array [tys]. See the method
385 [llvm::StructType::get]. *)
386 external struct_type : llcontext -> lltype array -> lltype
389 (** [packed_struct_type context ys] returns the packed structure type in the
390 context [context] containing in the types in the array [tys]. See the method
391 [llvm::StructType::get]. *)
392 external packed_struct_type : llcontext -> lltype array -> lltype
393 = "llvm_packed_struct_type"
395 (** [struct_element_types sty] returns the constituent types of the struct type
396 [sty]. See the method [llvm::StructType::getElementType]. *)
397 external struct_element_types : lltype -> lltype array
398 = "llvm_struct_element_types"
400 (** [is_packed sty] returns [true] if the structure type [sty] is packed,
401 [false] otherwise. See the method [llvm::StructType::isPacked]. *)
402 external is_packed : lltype -> bool = "llvm_is_packed"
405 (** {7 Operations on union types} *)
407 (** [union_type context tys] returns the union type in the context [context]
408 containing the types in the array [tys]. See the method
409 [llvm::UnionType::get] *)
410 external union_type : llcontext -> lltype array -> lltype = "llvm_union_type"
412 (** [union_element_types uty] returns the constituent types of the union type
413 [uty]. See the method [llvm::UnionType::getElementType]. *)
414 external union_element_types : lltype -> lltype array
415 = "llvm_union_element_types"
418 (** {7 Operations on pointer, vector, and array types} *)
420 (** [array_type ty n] returns the array type containing [n] elements of type
421 [ty]. See the method [llvm::ArrayType::get]. *)
422 external array_type : lltype -> int -> lltype = "llvm_array_type"
424 (** [pointer_type ty] returns the pointer type referencing objects of type
425 [ty] in the default address space (0).
426 See the method [llvm::PointerType::getUnqual]. *)
427 external pointer_type : lltype -> lltype = "llvm_pointer_type"
429 (** [qualified_pointer_type ty as] returns the pointer type referencing objects
430 of type [ty] in address space [as].
431 See the method [llvm::PointerType::get]. *)
432 external qualified_pointer_type : lltype -> int -> lltype
433 = "llvm_qualified_pointer_type"
435 (** [vector_type ty n] returns the array type containing [n] elements of the
436 primitive type [ty]. See the method [llvm::ArrayType::get]. *)
437 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
439 (** [element_type ty] returns the element type of the pointer, vector, or array
440 type [ty]. See the method [llvm::SequentialType::get]. *)
441 external element_type : lltype -> lltype = "LLVMGetElementType"
443 (** [element_type aty] returns the element count of the array type [aty].
444 See the method [llvm::ArrayType::getNumElements]. *)
445 external array_length : lltype -> int = "llvm_array_length"
447 (** [address_space pty] returns the address space qualifier of the pointer type
448 [pty]. See the method [llvm::PointerType::getAddressSpace]. *)
449 external address_space : lltype -> int = "llvm_address_space"
451 (** [element_type ty] returns the element count of the vector type [ty].
452 See the method [llvm::VectorType::getNumElements]. *)
453 external vector_size : lltype -> int = "llvm_vector_size"
456 (** {7 Operations on other types} *)
458 (** [opaque_type c] creates a new opaque type distinct from any other in the
459 context [c]. Opaque types are useful for building recursive types in
460 combination with {!refine_type}. See [llvm::OpaqueType::get]. *)
461 external opaque_type : llcontext -> lltype = "llvm_opaque_type"
463 (** [void_type c] creates a type of a function which does not return any
464 value in the context [c]. See [llvm::Type::VoidTy]. *)
465 external void_type : llcontext -> lltype = "llvm_void_type"
467 (** [label_type c] creates a type of a basic block in the context [c]. See
468 [llvm::Type::LabelTy]. *)
469 external label_type : llcontext -> lltype = "llvm_label_type"
471 (** {7 Operations on type handles} *)
473 (** [handle_to_type ty] creates a handle to the type [ty]. If [ty] is later
474 refined as a result of a call to {!refine_type}, the handle will be updated;
475 any bare [lltype] references will become invalid.
476 See the class [llvm::PATypeHolder]. *)
477 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
479 (** [type_of_handle tyh] resolves the type handle [tyh].
480 See the method [llvm::PATypeHolder::get()]. *)
481 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
483 (** [refine_type opaque_ty ty] replaces the abstract type [opaque_ty] with the
484 concrete type [ty] in all users. Warning: This may invalidate {!lltype}
485 values! Use {!lltypehandle} to manipulate potentially abstract types. See
486 the method [llvm::Type::refineAbstractType]. *)
487 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
492 (** [type_of v] returns the type of the value [v].
493 See the method [llvm::Value::getType]. *)
494 external type_of : llvalue -> lltype = "llvm_type_of"
496 (** [value_name v] returns the name of the value [v]. For global values, this is
497 the symbol name. For instructions and basic blocks, it is the SSA register
498 name. It is meaningless for constants.
499 See the method [llvm::Value::getName]. *)
500 external value_name : llvalue -> string = "llvm_value_name"
502 (** [set_value_name n v] sets the name of the value [v] to [n]. See the method
503 [llvm::Value::setName]. *)
504 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
506 (** [dump_value v] prints the .ll representation of the value [v] to standard
507 error. See the method [llvm::Value::dump]. *)
508 external dump_value : llvalue -> unit = "llvm_dump_value"
510 (** [replace_all_uses_with old new] replaces all uses of the value [old]
511 * with the value [new]. See the method [llvm::Value::replaceAllUsesWith]. *)
512 external replace_all_uses_with : llvalue -> llvalue -> unit
513 = "LLVMReplaceAllUsesWith"
516 (** {7 Operations on constants of (mostly) any type} *)
518 (** [is_constant v] returns [true] if the value [v] is a constant, [false]
519 otherwise. Similar to [llvm::isa<Constant>]. *)
520 external is_constant : llvalue -> bool = "llvm_is_constant"
522 (** [const_null ty] returns the constant null (zero) of the type [ty].
523 See the method [llvm::Constant::getNullValue]. *)
524 external const_null : lltype -> llvalue = "LLVMConstNull"
526 (** [const_all_ones ty] returns the constant '-1' of the integer or vector type
527 [ty]. See the method [llvm::Constant::getAllOnesValue]. *)
528 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
530 (** [const_pointer_null ty] returns the constant null (zero) pointer of the type
531 [ty]. See the method [llvm::ConstantPointerNull::get]. *)
532 external const_pointer_null : lltype -> llvalue = "LLVMConstPointerNull"
534 (** [undef ty] returns the undefined value of the type [ty].
535 See the method [llvm::UndefValue::get]. *)
536 external undef : lltype -> llvalue = "LLVMGetUndef"
538 (** [is_null v] returns [true] if the value [v] is the null (zero) value.
539 See the method [llvm::Constant::isNullValue]. *)
540 external is_null : llvalue -> bool = "llvm_is_null"
542 (** [is_undef v] returns [true] if the value [v] is an undefined value, [false]
543 otherwise. Similar to [llvm::isa<UndefValue>]. *)
544 external is_undef : llvalue -> bool = "llvm_is_undef"
547 (** {7 Operations on instructions} *)
549 (** [has_metadata i] returns whether or not the instruction [i] has any
550 metadata attached to it. See the function
551 [llvm::Instruction::hasMetadata]. *)
552 external has_metadata : llvalue -> bool = "llvm_has_metadata"
554 (** [metadata i kind] optionally returns the metadata associated with the
555 kind [kind] in the instruction [i] See the function
556 [llvm::Instruction::getMetadata]. *)
557 external metadata : llvalue -> int -> llvalue option = "llvm_metadata"
559 (** [set_metadata i kind md] sets the metadata [md] of kind [kind] in the
560 instruction [i]. See the function [llvm::Instruction::setMetadata]. *)
561 external set_metadata : llvalue -> int -> llvalue -> unit = "llvm_set_metadata"
563 (** [clear_metadata i kind] clears the metadata of kind [kind] in the
564 instruction [i]. See the function [llvm::Instruction::setMetadata]. *)
565 external clear_metadata : llvalue -> int -> unit = "llvm_clear_metadata"
568 (** {7 Operations on metadata} *)
570 (** [mdstring c s] returns the MDString of the string [s] in the context [c].
571 See the method [llvm::MDNode::get]. *)
572 external mdstring : llcontext -> string -> llvalue = "llvm_mdstring"
574 (** [mdnode c elts] returns the MDNode containing the values [elts] in the
576 See the method [llvm::MDNode::get]. *)
577 external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode"
580 (** {7 Operations on scalar constants} *)
582 (** [const_int ty i] returns the integer constant of type [ty] and value [i].
583 See the method [llvm::ConstantInt::get]. *)
584 external const_int : lltype -> int -> llvalue = "llvm_const_int"
586 (** [const_of_int64 ty i] returns the integer constant of type [ty] and value
587 [i]. See the method [llvm::ConstantInt::get]. *)
588 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
589 = "llvm_const_of_int64"
591 (** [const_int_of_string ty s r] returns the integer constant of type [ty] and
592 * value [s], with the radix [r]. See the method [llvm::ConstantInt::get]. *)
593 external const_int_of_string : lltype -> string -> int -> llvalue
594 = "llvm_const_int_of_string"
596 (** [const_float ty n] returns the floating point constant of type [ty] and
597 value [n]. See the method [llvm::ConstantFP::get]. *)
598 external const_float : lltype -> float -> llvalue = "llvm_const_float"
600 (** [const_float_of_string ty s] returns the floating point constant of type
601 [ty] and value [n]. See the method [llvm::ConstantFP::get]. *)
602 external const_float_of_string : lltype -> string -> llvalue
603 = "llvm_const_float_of_string"
606 (** {7 Operations on composite constants} *)
608 (** [const_string c s] returns the constant [i8] array with the values of the
609 characters in the string [s] in the context [c]. The array is not
610 null-terminated (but see {!const_stringz}). This value can in turn be used
611 as the initializer for a global variable. See the method
612 [llvm::ConstantArray::get]. *)
613 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
615 (** [const_stringz c s] returns the constant [i8] array with the values of the
616 characters in the string [s] and a null terminator in the context [c]. This
617 value can in turn be used as the initializer for a global variable.
618 See the method [llvm::ConstantArray::get]. *)
619 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
621 (** [const_array ty elts] returns the constant array of type
622 [array_type ty (Array.length elts)] and containing the values [elts].
623 This value can in turn be used as the initializer for a global variable.
624 See the method [llvm::ConstantArray::get]. *)
625 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
627 (** [const_struct context elts] returns the structured constant of type
628 [struct_type (Array.map type_of elts)] and containing the values [elts]
629 in the context [context]. This value can in turn be used as the initializer
630 for a global variable. See the method [llvm::ConstantStruct::get]. *)
631 external const_struct : llcontext -> llvalue array -> llvalue
632 = "llvm_const_struct"
634 (** [const_packed_struct context elts] returns the structured constant of
635 type {!packed_struct_type} [(Array.map type_of elts)] and containing the
636 values [elts] in the context [context]. This value can in turn be used as
637 the initializer for a global variable. See the method
638 [llvm::ConstantStruct::get]. *)
639 external const_packed_struct : llcontext -> llvalue array -> llvalue
640 = "llvm_const_packed_struct"
642 (** [const_vector elts] returns the vector constant of type
643 [vector_type (type_of elts.(0)) (Array.length elts)] and containing the
644 values [elts]. See the method [llvm::ConstantVector::get]. *)
645 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
647 (** [const_union ty v] returns the union constant of type [union_type tys] and
648 containing the value [v]. See the method [llvm::ConstantUnion::get]. *)
649 external const_union : lltype -> llvalue -> llvalue = "LLVMConstUnion"
652 (** {7 Constant expressions} *)
654 (** [align_of ty] returns the alignof constant for the type [ty]. This is
655 equivalent to [const_ptrtoint (const_gep (const_null (pointer_type {i8,ty}))
656 (const_int i32_type 0) (const_int i32_type 1)) i32_type], but considerably
657 more readable. See the method [llvm::ConstantExpr::getAlignOf]. *)
658 external align_of : lltype -> llvalue = "LLVMAlignOf"
660 (** [size_of ty] returns the sizeof constant for the type [ty]. This is
661 equivalent to [const_ptrtoint (const_gep (const_null (pointer_type ty))
662 (const_int i32_type 1)) i64_type], but considerably more readable.
663 See the method [llvm::ConstantExpr::getSizeOf]. *)
664 external size_of : lltype -> llvalue = "LLVMSizeOf"
666 (** [const_neg c] returns the arithmetic negation of the constant [c].
667 See the method [llvm::ConstantExpr::getNeg]. *)
668 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
670 (** [const_nsw_neg c] returns the arithmetic negation of the constant [c] with
671 no signed wrapping. The result is undefined if the negation overflows.
672 See the method [llvm::ConstantExpr::getNSWNeg]. *)
673 external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg"
675 (** [const_nuw_neg c] returns the arithmetic negation of the constant [c] with
676 no unsigned wrapping. The result is undefined if the negation overflows.
677 See the method [llvm::ConstantExpr::getNUWNeg]. *)
678 external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg"
680 (** [const_fneg c] returns the arithmetic negation of the constant float [c].
681 See the method [llvm::ConstantExpr::getFNeg]. *)
682 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
684 (** [const_not c] returns the bitwise inverse of the constant [c].
685 See the method [llvm::ConstantExpr::getNot]. *)
686 external const_not : llvalue -> llvalue = "LLVMConstNot"
688 (** [const_add c1 c2] returns the constant sum of two constants.
689 See the method [llvm::ConstantExpr::getAdd]. *)
690 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
692 (** [const_nsw_add c1 c2] returns the constant sum of two constants with no
693 signed wrapping. The result is undefined if the sum overflows.
694 See the method [llvm::ConstantExpr::getNSWAdd]. *)
695 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
697 (** [const_nuw_add c1 c2] returns the constant sum of two constants with no
698 unsigned wrapping. The result is undefined if the sum overflows.
699 See the method [llvm::ConstantExpr::getNSWAdd]. *)
700 external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd"
702 (** [const_fadd c1 c2] returns the constant sum of two constant floats.
703 See the method [llvm::ConstantExpr::getFAdd]. *)
704 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
706 (** [const_sub c1 c2] returns the constant difference, [c1 - c2], of two
707 constants. See the method [llvm::ConstantExpr::getSub]. *)
708 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
710 (** [const_nsw_sub c1 c2] returns the constant difference of two constants with
711 no signed wrapping. The result is undefined if the sum overflows.
712 See the method [llvm::ConstantExpr::getNSWSub]. *)
713 external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub"
715 (** [const_nuw_sub c1 c2] returns the constant difference of two constants with
716 no unsigned wrapping. The result is undefined if the sum overflows.
717 See the method [llvm::ConstantExpr::getNSWSub]. *)
718 external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub"
720 (** [const_fsub c1 c2] returns the constant difference, [c1 - c2], of two
721 constant floats. See the method [llvm::ConstantExpr::getFSub]. *)
722 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
724 (** [const_mul c1 c2] returns the constant product of two constants.
725 See the method [llvm::ConstantExpr::getMul]. *)
726 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
728 (** [const_nsw_mul c1 c2] returns the constant product of two constants with
729 no signed wrapping. The result is undefined if the sum overflows.
730 See the method [llvm::ConstantExpr::getNSWMul]. *)
731 external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul"
733 (** [const_nuw_mul c1 c2] returns the constant product of two constants with
734 no unsigned wrapping. The result is undefined if the sum overflows.
735 See the method [llvm::ConstantExpr::getNSWMul]. *)
736 external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul"
738 (** [const_fmul c1 c2] returns the constant product of two constants floats.
739 See the method [llvm::ConstantExpr::getFMul]. *)
740 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
742 (** [const_udiv c1 c2] returns the constant quotient [c1 / c2] of two unsigned
744 See the method [llvm::ConstantExpr::getUDiv]. *)
745 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
747 (** [const_sdiv c1 c2] returns the constant quotient [c1 / c2] of two signed
749 See the method [llvm::ConstantExpr::getSDiv]. *)
750 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
752 (** [const_exact_sdiv c1 c2] returns the constant quotient [c1 / c2] of two
753 signed integer constants. The result is undefined if the result is rounded
754 or overflows. See the method [llvm::ConstantExpr::getExactSDiv]. *)
755 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
757 (** [const_fdiv c1 c2] returns the constant quotient [c1 / c2] of two floating
759 See the method [llvm::ConstantExpr::getFDiv]. *)
760 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
762 (** [const_urem c1 c2] returns the constant remainder [c1 MOD c2] of two
763 unsigned integer constants.
764 See the method [llvm::ConstantExpr::getURem]. *)
765 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
767 (** [const_srem c1 c2] returns the constant remainder [c1 MOD c2] of two
768 signed integer constants.
769 See the method [llvm::ConstantExpr::getSRem]. *)
770 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
772 (** [const_frem c1 c2] returns the constant remainder [c1 MOD c2] of two
773 signed floating point constants.
774 See the method [llvm::ConstantExpr::getFRem]. *)
775 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
777 (** [const_and c1 c2] returns the constant bitwise [AND] of two integer
779 See the method [llvm::ConstantExpr::getAnd]. *)
780 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
782 (** [const_or c1 c2] returns the constant bitwise [OR] of two integer
784 See the method [llvm::ConstantExpr::getOr]. *)
785 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
787 (** [const_xor c1 c2] returns the constant bitwise [XOR] of two integer
789 See the method [llvm::ConstantExpr::getXor]. *)
790 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
792 (** [const_icmp pred c1 c2] returns the constant comparison of two integer
793 constants, [c1 pred c2].
794 See the method [llvm::ConstantExpr::getICmp]. *)
795 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
798 (** [const_fcmp pred c1 c2] returns the constant comparison of two floating
799 point constants, [c1 pred c2].
800 See the method [llvm::ConstantExpr::getFCmp]. *)
801 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
804 (** [const_shl c1 c2] returns the constant integer [c1] left-shifted by the
805 constant integer [c2].
806 See the method [llvm::ConstantExpr::getShl]. *)
807 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
809 (** [const_lshr c1 c2] returns the constant integer [c1] right-shifted by the
810 constant integer [c2] with zero extension.
811 See the method [llvm::ConstantExpr::getLShr]. *)
812 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
814 (** [const_ashr c1 c2] returns the constant integer [c1] right-shifted by the
815 constant integer [c2] with sign extension.
816 See the method [llvm::ConstantExpr::getAShr]. *)
817 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
819 (** [const_gep pc indices] returns the constant [getElementPtr] of [p1] with the
820 constant integers indices from the array [indices].
821 See the method [llvm::ConstantExpr::getGetElementPtr]. *)
822 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
824 (** [const_in_bounds_gep pc indices] returns the constant [getElementPtr] of [p1]
825 with the constant integers indices from the array [indices].
826 See the method [llvm::ConstantExpr::getInBoundsGetElementPtr]. *)
827 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
828 = "llvm_const_in_bounds_gep"
830 (** [const_trunc c ty] returns the constant truncation of integer constant [c]
831 to the smaller integer type [ty].
832 See the method [llvm::ConstantExpr::getTrunc]. *)
833 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
835 (** [const_sext c ty] returns the constant sign extension of integer constant
836 [c] to the larger integer type [ty].
837 See the method [llvm::ConstantExpr::getSExt]. *)
838 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
840 (** [const_zext c ty] returns the constant zero extension of integer constant
841 [c] to the larger integer type [ty].
842 See the method [llvm::ConstantExpr::getZExt]. *)
843 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
845 (** [const_fptrunc c ty] returns the constant truncation of floating point
846 constant [c] to the smaller floating point type [ty].
847 See the method [llvm::ConstantExpr::getFPTrunc]. *)
848 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
850 (** [const_fpext c ty] returns the constant extension of floating point constant
851 [c] to the larger floating point type [ty].
852 See the method [llvm::ConstantExpr::getFPExt]. *)
853 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
855 (** [const_uitofp c ty] returns the constant floating point conversion of
856 unsigned integer constant [c] to the floating point type [ty].
857 See the method [llvm::ConstantExpr::getUIToFP]. *)
858 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
860 (** [const_sitofp c ty] returns the constant floating point conversion of
861 signed integer constant [c] to the floating point type [ty].
862 See the method [llvm::ConstantExpr::getSIToFP]. *)
863 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
865 (** [const_fptoui c ty] returns the constant unsigned integer conversion of
866 floating point constant [c] to integer type [ty].
867 See the method [llvm::ConstantExpr::getFPToUI]. *)
868 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
870 (** [const_fptoui c ty] returns the constant unsigned integer conversion of
871 floating point constant [c] to integer type [ty].
872 See the method [llvm::ConstantExpr::getFPToSI]. *)
873 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
875 (** [const_ptrtoint c ty] returns the constant integer conversion of
876 pointer constant [c] to integer type [ty].
877 See the method [llvm::ConstantExpr::getPtrToInt]. *)
878 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
880 (** [const_inttoptr c ty] returns the constant pointer conversion of
881 integer constant [c] to pointer type [ty].
882 See the method [llvm::ConstantExpr::getIntToPtr]. *)
883 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
885 (** [const_bitcast c ty] returns the constant bitwise conversion of constant [c]
886 to type [ty] of equal size.
887 See the method [llvm::ConstantExpr::getBitCast]. *)
888 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
890 (** [const_zext_or_bitcast c ty] returns a constant zext or bitwise cast
891 conversion of constant [c] to type [ty].
892 See the method [llvm::ConstantExpr::getZExtOrBitCast]. *)
893 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
894 = "LLVMConstZExtOrBitCast"
896 (** [const_sext_or_bitcast c ty] returns a constant sext or bitwise cast
897 conversion of constant [c] to type [ty].
898 See the method [llvm::ConstantExpr::getSExtOrBitCast]. *)
899 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
900 = "LLVMConstSExtOrBitCast"
902 (** [const_trunc_or_bitcast c ty] returns a constant trunc or bitwise cast
903 conversion of constant [c] to type [ty].
904 See the method [llvm::ConstantExpr::getTruncOrBitCast]. *)
905 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
906 = "LLVMConstTruncOrBitCast"
908 (** [const_pointercast c ty] returns a constant bitcast or a pointer-to-int
909 cast conversion of constant [c] to type [ty] of equal size.
910 See the method [llvm::ConstantExpr::getPointerCast]. *)
911 external const_pointercast : llvalue -> lltype -> llvalue
912 = "LLVMConstPointerCast"
914 (** [const_intcast c ty] returns a constant zext, bitcast, or trunc for integer
915 -> integer casts of constant [c] to type [ty].
916 See the method [llvm::ConstantExpr::getIntCast]. *)
917 external const_intcast : llvalue -> lltype -> llvalue
920 (** [const_fpcast c ty] returns a constant fpext, bitcast, or fptrunc for fp ->
921 fp casts of constant [c] to type [ty].
922 See the method [llvm::ConstantExpr::getFPCast]. *)
923 external const_fpcast : llvalue -> lltype -> llvalue
926 (** [const_select cond t f] returns the constant conditional which returns value
927 [t] if the boolean constant [cond] is true and the value [f] otherwise.
928 See the method [llvm::ConstantExpr::getSelect]. *)
929 external const_select : llvalue -> llvalue -> llvalue -> llvalue
932 (** [const_extractelement vec i] returns the constant [i]th element of
933 constant vector [vec]. [i] must be a constant [i32] value unsigned less than
934 the size of the vector.
935 See the method [llvm::ConstantExpr::getExtractElement]. *)
936 external const_extractelement : llvalue -> llvalue -> llvalue
937 = "LLVMConstExtractElement"
939 (** [const_insertelement vec v i] returns the constant vector with the same
940 elements as constant vector [v] but the [i]th element replaced by the
941 constant [v]. [v] must be a constant value with the type of the vector
942 elements. [i] must be a constant [i32] value unsigned less than the size
944 See the method [llvm::ConstantExpr::getInsertElement]. *)
945 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
946 = "LLVMConstInsertElement"
948 (** [const_shufflevector a b mask] returns a constant [shufflevector].
949 See the LLVM Language Reference for details on the [sufflevector]
951 See the method [llvm::ConstantExpr::getShuffleVector]. *)
952 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
953 = "LLVMConstShuffleVector"
955 (** [const_extractvalue agg idxs] returns the constant [idxs]th value of
956 constant aggregate [agg]. Each [idxs] must be less than the size of the
957 aggregate. See the method [llvm::ConstantExpr::getExtractValue]. *)
958 external const_extractvalue : llvalue -> int array -> llvalue
959 = "llvm_const_extractvalue"
961 (** [const_insertvalue agg val idxs] inserts the value [val] in the specified
962 indexs [idxs] in the aggegate [agg]. Each [idxs] must be less than the size
963 of the aggregate. See the method [llvm::ConstantExpr::getInsertValue]. *)
964 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
965 = "llvm_const_insertvalue"
967 (** [const_inline_asm ty asm con side align] inserts a inline assembly string.
968 See the method [llvm::InlineAsm::get]. *)
969 external const_inline_asm : lltype -> string -> string -> bool -> bool ->
971 = "llvm_const_inline_asm"
973 (** [block_address f bb] returns the address of the basic block [bb] in the
974 function [f]. See the method [llvm::BasicBlock::get]. *)
975 external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress"
978 (** {7 Operations on global variables, functions, and aliases (globals)} *)
980 (** [global_parent g] is the enclosing module of the global value [g].
981 See the method [llvm::GlobalValue::getParent]. *)
982 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
984 (** [is_declaration g] returns [true] if the global value [g] is a declaration
985 only. Returns [false] otherwise.
986 See the method [llvm::GlobalValue::isDeclaration]. *)
987 external is_declaration : llvalue -> bool = "llvm_is_declaration"
989 (** [linkage g] returns the linkage of the global value [g].
990 See the method [llvm::GlobalValue::getLinkage]. *)
991 external linkage : llvalue -> Linkage.t = "llvm_linkage"
993 (** [set_linkage l g] sets the linkage of the global value [g] to [l].
994 See the method [llvm::GlobalValue::setLinkage]. *)
995 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
997 (** [section g] returns the linker section of the global value [g].
998 See the method [llvm::GlobalValue::getSection]. *)
999 external section : llvalue -> string = "llvm_section"
1001 (** [set_section s g] sets the linker section of the global value [g] to [s].
1002 See the method [llvm::GlobalValue::setSection]. *)
1003 external set_section : string -> llvalue -> unit = "llvm_set_section"
1005 (** [visibility g] returns the linker visibility of the global value [g].
1006 See the method [llvm::GlobalValue::getVisibility]. *)
1007 external visibility : llvalue -> Visibility.t = "llvm_visibility"
1009 (** [set_visibility v g] sets the linker visibility of the global value [g] to
1010 [v]. See the method [llvm::GlobalValue::setVisibility]. *)
1011 external set_visibility : Visibility.t -> llvalue -> unit
1012 = "llvm_set_visibility"
1014 (** [alignment g] returns the required alignment of the global value [g].
1015 See the method [llvm::GlobalValue::getAlignment]. *)
1016 external alignment : llvalue -> int = "llvm_alignment"
1018 (** [set_alignment n g] sets the required alignment of the global value [g] to
1019 [n] bytes. See the method [llvm::GlobalValue::setAlignment]. *)
1020 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
1023 (** {7 Operations on global variables} *)
1025 (** [declare_global ty name m] returns a new global variable of type [ty] and
1026 with name [name] in module [m] in the default address space (0). If such a
1027 global variable already exists, it is returned. If the type of the existing
1028 global differs, then a bitcast to [ty] is returned. *)
1029 external declare_global : lltype -> string -> llmodule -> llvalue
1030 = "llvm_declare_global"
1032 (** [declare_qualified_global ty name as m] returns a new global variable of
1033 type [ty] and with name [name] in module [m] in the address space [as]. If
1034 such a global variable already exists, it is returned. If the type of the
1035 existing global differs, then a bitcast to [ty] is returned. *)
1036 external declare_qualified_global : lltype -> string -> int -> llmodule ->
1038 = "llvm_declare_qualified_global"
1040 (** [define_global name init m] returns a new global with name [name] and
1041 initializer [init] in module [m] in the default address space (0). If the
1042 named global already exists, it is renamed.
1043 See the constructor of [llvm::GlobalVariable]. *)
1044 external define_global : string -> llvalue -> llmodule -> llvalue
1045 = "llvm_define_global"
1047 (** [define_qualified_global name init as m] returns a new global with name
1048 [name] and initializer [init] in module [m] in the address space [as]. If
1049 the named global already exists, it is renamed.
1050 See the constructor of [llvm::GlobalVariable]. *)
1051 external define_qualified_global : string -> llvalue -> int -> llmodule ->
1053 = "llvm_define_qualified_global"
1055 (** [lookup_global name m] returns [Some g] if a global variable with name
1056 [name] exists in module [m]. If no such global exists, returns [None].
1057 See the [llvm::GlobalVariable] constructor. *)
1058 external lookup_global : string -> llmodule -> llvalue option
1059 = "llvm_lookup_global"
1061 (** [delete_global gv] destroys the global variable [gv].
1062 See the method [llvm::GlobalVariable::eraseFromParent]. *)
1063 external delete_global : llvalue -> unit = "llvm_delete_global"
1065 (** [global_begin m] returns the first position in the global variable list of
1066 the module [m]. [global_begin] and [global_succ] can be used to iterate
1067 over the global list in order.
1068 See the method [llvm::Module::global_begin]. *)
1069 external global_begin : llmodule -> (llmodule, llvalue) llpos
1070 = "llvm_global_begin"
1072 (** [global_succ gv] returns the global variable list position succeeding
1074 See the method [llvm::Module::global_iterator::operator++]. *)
1075 external global_succ : llvalue -> (llmodule, llvalue) llpos
1076 = "llvm_global_succ"
1078 (** [iter_globals f m] applies function [f] to each of the global variables of
1079 module [m] in order. Tail recursive. *)
1080 val iter_globals : (llvalue -> unit) -> llmodule -> unit
1082 (** [fold_left_globals f init m] is [f (... (f init g1) ...) gN] where
1083 [g1,...,gN] are the global variables of module [m]. Tail recursive. *)
1084 val fold_left_globals : ('a -> llvalue -> 'a) -> 'a -> llmodule -> 'a
1086 (** [global_end m] returns the last position in the global variable list of the
1087 module [m]. [global_end] and [global_pred] can be used to iterate over the
1088 global list in reverse.
1089 See the method [llvm::Module::global_end]. *)
1090 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
1093 (** [global_pred gv] returns the global variable list position preceding
1095 See the method [llvm::Module::global_iterator::operator--]. *)
1096 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
1097 = "llvm_global_pred"
1099 (** [rev_iter_globals f m] applies function [f] to each of the global variables
1100 of module [m] in reverse order. Tail recursive. *)
1101 val rev_iter_globals : (llvalue -> unit) -> llmodule -> unit
1103 (** [fold_right_globals f m init] is [f g1 (... (f gN init) ...)] where
1104 [g1,...,gN] are the global variables of module [m]. Tail recursive. *)
1105 val fold_right_globals : (llvalue -> 'a -> 'a) -> llmodule -> 'a -> 'a
1107 (** [is_global_constant gv] returns [true] if the global variabile [gv] is a
1108 constant. Returns [false] otherwise.
1109 See the method [llvm::GlobalVariable::isConstant]. *)
1110 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
1112 (** [set_global_constant c gv] sets the global variable [gv] to be a constant if
1113 [c] is [true] and not if [c] is [false].
1114 See the method [llvm::GlobalVariable::setConstant]. *)
1115 external set_global_constant : bool -> llvalue -> unit
1116 = "llvm_set_global_constant"
1118 (** [global_initializer gv] returns the initializer for the global variable
1119 [gv]. See the method [llvm::GlobalVariable::getInitializer]. *)
1120 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
1122 (** [set_initializer c gv] sets the initializer for the global variable
1123 [gv] to the constant [c].
1124 See the method [llvm::GlobalVariable::setInitializer]. *)
1125 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
1127 (** [remove_initializer gv] unsets the initializer for the global variable
1129 See the method [llvm::GlobalVariable::setInitializer]. *)
1130 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
1132 (** [is_thread_local gv] returns [true] if the global variable [gv] is
1133 thread-local and [false] otherwise.
1134 See the method [llvm::GlobalVariable::isThreadLocal]. *)
1135 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
1137 (** [set_thread_local c gv] sets the global variable [gv] to be thread local if
1138 [c] is [true] and not otherwise.
1139 See the method [llvm::GlobalVariable::setThreadLocal]. *)
1140 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
1143 (** {7 Operations on functions} *)
1145 (** [declare_function name ty m] returns a new function of type [ty] and
1146 with name [name] in module [m]. If such a function already exists,
1147 it is returned. If the type of the existing function differs, then a bitcast
1148 to [ty] is returned. *)
1149 external declare_function : string -> lltype -> llmodule -> llvalue
1150 = "llvm_declare_function"
1152 (** [define_function name ty m] creates a new function with name [name] and
1153 type [ty] in module [m]. If the named function already exists, it is
1154 renamed. An entry basic block is created in the function.
1155 See the constructor of [llvm::GlobalVariable]. *)
1156 external define_function : string -> lltype -> llmodule -> llvalue
1157 = "llvm_define_function"
1159 (** [lookup_function name m] returns [Some f] if a function with name
1160 [name] exists in module [m]. If no such function exists, returns [None].
1161 See the method [llvm::Module] constructor. *)
1162 external lookup_function : string -> llmodule -> llvalue option
1163 = "llvm_lookup_function"
1165 (** [delete_function f] destroys the function [f].
1166 See the method [llvm::Function::eraseFromParent]. *)
1167 external delete_function : llvalue -> unit = "llvm_delete_function"
1169 (** [function_begin m] returns the first position in the function list of the
1170 module [m]. [function_begin] and [function_succ] can be used to iterate over
1171 the function list in order.
1172 See the method [llvm::Module::begin]. *)
1173 external function_begin : llmodule -> (llmodule, llvalue) llpos
1174 = "llvm_function_begin"
1176 (** [function_succ gv] returns the function list position succeeding
1178 See the method [llvm::Module::iterator::operator++]. *)
1179 external function_succ : llvalue -> (llmodule, llvalue) llpos
1180 = "llvm_function_succ"
1182 (** [iter_functions f m] applies function [f] to each of the functions of module
1183 [m] in order. Tail recursive. *)
1184 val iter_functions : (llvalue -> unit) -> llmodule -> unit
1186 (** [fold_left_function f init m] is [f (... (f init f1) ...) fN] where
1187 [f1,...,fN] are the functions of module [m]. Tail recursive. *)
1188 val fold_left_functions : ('a -> llvalue -> 'a) -> 'a -> llmodule -> 'a
1190 (** [function_end m] returns the last position in the function list of
1191 the module [m]. [function_end] and [function_pred] can be used to iterate
1192 over the function list in reverse.
1193 See the method [llvm::Module::end]. *)
1194 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
1195 = "llvm_function_end"
1197 (** [function_pred gv] returns the function list position preceding [After gv].
1198 See the method [llvm::Module::iterator::operator--]. *)
1199 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
1200 = "llvm_function_pred"
1202 (** [rev_iter_functions f fn] applies function [f] to each of the functions of
1203 module [m] in reverse order. Tail recursive. *)
1204 val rev_iter_functions : (llvalue -> unit) -> llmodule -> unit
1206 (** [fold_right_functions f m init] is [f (... (f init fN) ...) f1] where
1207 [f1,...,fN] are the functions of module [m]. Tail recursive. *)
1208 val fold_right_functions : (llvalue -> 'a -> 'a) -> llmodule -> 'a -> 'a
1210 (** [is_intrinsic f] returns true if the function [f] is an intrinsic.
1211 See the method [llvm::Function::isIntrinsic]. *)
1212 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
1214 (** [function_call_conv f] returns the calling convention of the function [f].
1215 See the method [llvm::Function::getCallingConv]. *)
1216 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
1218 (** [set_function_call_conv cc f] sets the calling convention of the function
1219 [f] to the calling convention numbered [cc].
1220 See the method [llvm::Function::setCallingConv]. *)
1221 external set_function_call_conv : int -> llvalue -> unit
1222 = "llvm_set_function_call_conv"
1224 (** [gc f] returns [Some name] if the function [f] has a garbage
1225 collection algorithm specified and [None] otherwise.
1226 See the method [llvm::Function::getGC]. *)
1227 external gc : llvalue -> string option = "llvm_gc"
1229 (** [set_gc gc f] sets the collection algorithm for the function [f] to
1230 [gc]. See the method [llvm::Function::setGC]. *)
1231 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
1233 (** [add_function_attr f a] adds attribute [a] to the return type of function
1235 external add_function_attr : llvalue -> Attribute.t -> unit
1236 = "llvm_add_function_attr"
1238 (** [remove_function_attr f a] removes attribute [a] from the return type of
1240 external remove_function_attr : llvalue -> Attribute.t -> unit
1241 = "llvm_remove_function_attr"
1243 (** {7 Operations on params} *)
1245 (** [params f] returns the parameters of function [f].
1246 See the method [llvm::Function::getArgumentList]. *)
1247 external params : llvalue -> llvalue array = "llvm_params"
1249 (** [param f n] returns the [n]th parameter of function [f].
1250 See the method [llvm::Function::getArgumentList]. *)
1251 external param : llvalue -> int -> llvalue = "llvm_param"
1253 (** [param_parent p] returns the parent function that owns the parameter.
1254 See the method [llvm::Argument::getParent]. *)
1255 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
1257 (** [param_begin f] returns the first position in the parameter list of the
1258 function [f]. [param_begin] and [param_succ] can be used to iterate over
1259 the parameter list in order.
1260 See the method [llvm::Function::arg_begin]. *)
1261 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
1263 (** [param_succ bb] returns the parameter list position succeeding
1265 See the method [llvm::Function::arg_iterator::operator++]. *)
1266 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
1268 (** [iter_params f fn] applies function [f] to each of the parameters
1269 of function [fn] in order. Tail recursive. *)
1270 val iter_params : (llvalue -> unit) -> llvalue -> unit
1272 (** [fold_left_params f init fn] is [f (... (f init b1) ...) bN] where
1273 [b1,...,bN] are the parameters of function [fn]. Tail recursive. *)
1274 val fold_left_params : ('a -> llvalue -> 'a) -> 'a -> llvalue -> 'a
1276 (** [param_end f] returns the last position in the parameter list of
1277 the function [f]. [param_end] and [param_pred] can be used to iterate
1278 over the parameter list in reverse.
1279 See the method [llvm::Function::arg_end]. *)
1280 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
1282 (** [param_pred gv] returns the function list position preceding [After gv].
1283 See the method [llvm::Function::arg_iterator::operator--]. *)
1284 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos
1287 (** [rev_iter_params f fn] applies function [f] to each of the parameters
1288 of function [fn] in reverse order. Tail recursive. *)
1289 val rev_iter_params : (llvalue -> unit) -> llvalue -> unit
1291 (** [fold_right_params f fn init] is [f (... (f init bN) ...) b1] where
1292 [b1,...,bN] are the parameters of function [fn]. Tail recursive. *)
1293 val fold_right_params : (llvalue -> 'a -> 'a) -> llvalue -> 'a -> 'a
1295 (** [add_param p a] adds attribute [a] to parameter [p]. *)
1296 external add_param_attr : llvalue -> Attribute.t -> unit = "llvm_add_param_attr"
1298 (** [remove_param_attr p a] removes attribute [a] from parameter [p]. *)
1299 external remove_param_attr : llvalue -> Attribute.t -> unit
1300 = "llvm_remove_param_attr"
1302 (** [set_param_alignment p a] set the alignment of parameter [p] to [a]. *)
1303 external set_param_alignment : llvalue -> int -> unit
1304 = "llvm_set_param_alignment"
1306 (** {7 Operations on basic blocks} *)
1308 (** [basic_blocks fn] returns the basic blocks of the function [f].
1309 See the method [llvm::Function::getBasicBlockList]. *)
1310 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
1312 (** [entry_block fn] returns the entry basic block of the function [f].
1313 See the method [llvm::Function::getEntryBlock]. *)
1314 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
1316 (** [delete_block bb] deletes the basic block [bb].
1317 See the method [llvm::BasicBlock::eraseFromParent]. *)
1318 external delete_block : llbasicblock -> unit = "llvm_delete_block"
1320 (** [append_block c name f] creates a new basic block named [name] at the end of
1321 function [f] in the context [c].
1322 See the constructor of [llvm::BasicBlock]. *)
1323 external append_block : llcontext -> string -> llvalue -> llbasicblock
1324 = "llvm_append_block"
1326 (** [insert_block c name bb] creates a new basic block named [name] before the
1327 basic block [bb] in the context [c].
1328 See the constructor of [llvm::BasicBlock]. *)
1329 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
1330 = "llvm_insert_block"
1332 (** [block_parent bb] returns the parent function that owns the basic block.
1333 See the method [llvm::BasicBlock::getParent]. *)
1334 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
1336 (** [block_begin f] returns the first position in the basic block list of the
1337 function [f]. [block_begin] and [block_succ] can be used to iterate over
1338 the basic block list in order.
1339 See the method [llvm::Function::begin]. *)
1340 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
1341 = "llvm_block_begin"
1343 (** [block_succ bb] returns the basic block list position succeeding
1345 See the method [llvm::Function::iterator::operator++]. *)
1346 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
1349 (** [iter_blocks f fn] applies function [f] to each of the basic blocks
1350 of function [fn] in order. Tail recursive. *)
1351 val iter_blocks : (llbasicblock -> unit) -> llvalue -> unit
1353 (** [fold_left_blocks f init fn] is [f (... (f init b1) ...) bN] where
1354 [b1,...,bN] are the basic blocks of function [fn]. Tail recursive. *)
1355 val fold_left_blocks : ('a -> llbasicblock -> 'a) -> 'a -> llvalue -> 'a
1357 (** [block_end f] returns the last position in the basic block list of
1358 the function [f]. [block_end] and [block_pred] can be used to iterate
1359 over the basic block list in reverse.
1360 See the method [llvm::Function::end]. *)
1361 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
1364 (** [block_pred gv] returns the function list position preceding [After gv].
1365 See the method [llvm::Function::iterator::operator--]. *)
1366 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
1369 (** [rev_iter_blocks f fn] applies function [f] to each of the basic blocks
1370 of function [fn] in reverse order. Tail recursive. *)
1371 val rev_iter_blocks : (llbasicblock -> unit) -> llvalue -> unit
1373 (** [fold_right_blocks f fn init] is [f (... (f init bN) ...) b1] where
1374 [b1,...,bN] are the basic blocks of function [fn]. Tail recursive. *)
1375 val fold_right_blocks : (llbasicblock -> 'a -> 'a) -> llvalue -> 'a -> 'a
1377 (** [value_of_block bb] losslessly casts [bb] to an [llvalue]. *)
1378 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
1380 (** [value_is_block v] returns [true] if the value [v] is a basic block and
1382 Similar to [llvm::isa<BasicBlock>]. *)
1383 external value_is_block : llvalue -> bool = "llvm_value_is_block"
1385 (** [block_of_value v] losslessly casts [v] to an [llbasicblock]. *)
1386 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
1389 (** {7 Operations on instructions} *)
1391 (** [instr_parent i] is the enclosing basic block of the instruction [i].
1392 See the method [llvm::Instruction::getParent]. *)
1393 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
1395 (** [instr_begin bb] returns the first position in the instruction list of the
1396 basic block [bb]. [instr_begin] and [instr_succ] can be used to iterate over
1397 the instruction list in order.
1398 See the method [llvm::BasicBlock::begin]. *)
1399 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
1400 = "llvm_instr_begin"
1402 (** [instr_succ i] returns the instruction list position succeeding [Before i].
1403 See the method [llvm::BasicBlock::iterator::operator++]. *)
1404 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
1407 (** [iter_instrs f bb] applies function [f] to each of the instructions of basic
1408 block [bb] in order. Tail recursive. *)
1409 val iter_instrs: (llvalue -> unit) -> llbasicblock -> unit
1411 (** [fold_left_instrs f init bb] is [f (... (f init g1) ...) gN] where
1412 [g1,...,gN] are the instructions of basic block [bb]. Tail recursive. *)
1413 val fold_left_instrs: ('a -> llvalue -> 'a) -> 'a -> llbasicblock -> 'a
1415 (** [instr_end bb] returns the last position in the instruction list of the
1416 basic block [bb]. [instr_end] and [instr_pred] can be used to iterate over
1417 the instruction list in reverse.
1418 See the method [llvm::BasicBlock::end]. *)
1419 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
1422 (** [instr_pred i] returns the instruction list position preceding [After i].
1423 See the method [llvm::BasicBlock::iterator::operator--]. *)
1424 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
1427 (** [fold_right_instrs f bb init] is [f (... (f init fN) ...) f1] where
1428 [f1,...,fN] are the instructions of basic block [bb]. Tail recursive. *)
1429 val fold_right_instrs: (llvalue -> 'a -> 'a) -> llbasicblock -> 'a -> 'a
1432 (** {7 Operations on call sites} *)
1434 (** [instruction_call_conv ci] is the calling convention for the call or invoke
1435 instruction [ci], which may be one of the values from the module
1436 {!CallConv}. See the method [llvm::CallInst::getCallingConv] and
1437 [llvm::InvokeInst::getCallingConv]. *)
1438 external instruction_call_conv: llvalue -> int
1439 = "llvm_instruction_call_conv"
1441 (** [set_instruction_call_conv cc ci] sets the calling convention for the call
1442 or invoke instruction [ci] to the integer [cc], which can be one of the
1443 values from the module {!CallConv}.
1444 See the method [llvm::CallInst::setCallingConv]
1445 and [llvm::InvokeInst::setCallingConv]. *)
1446 external set_instruction_call_conv: int -> llvalue -> unit
1447 = "llvm_set_instruction_call_conv"
1449 (** [add_instruction_param_attr ci i a] adds attribute [a] to the [i]th
1450 parameter of the call or invoke instruction [ci]. [i]=0 denotes the return
1452 external add_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
1453 = "llvm_add_instruction_param_attr"
1455 (** [remove_instruction_param_attr ci i a] removes attribute [a] from the
1456 [i]th parameter of the call or invoke instruction [ci]. [i]=0 denotes the
1458 external remove_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
1459 = "llvm_remove_instruction_param_attr"
1461 (** {Operations on call instructions (only)} *)
1463 (** [is_tail_call ci] is [true] if the call instruction [ci] is flagged as
1464 eligible for tail call optimization, [false] otherwise.
1465 See the method [llvm::CallInst::isTailCall]. *)
1466 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
1468 (** [set_tail_call tc ci] flags the call instruction [ci] as eligible for tail
1469 call optimization if [tc] is [true], clears otherwise.
1470 See the method [llvm::CallInst::setTailCall]. *)
1471 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
1473 (** {7 Operations on phi nodes} *)
1475 (** [add_incoming (v, bb) pn] adds the value [v] to the phi node [pn] for use
1476 with branches from [bb]. See the method [llvm::PHINode::addIncoming]. *)
1477 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
1478 = "llvm_add_incoming"
1480 (** [incoming pn] returns the list of value-block pairs for phi node [pn].
1481 See the method [llvm::PHINode::getIncomingValue]. *)
1482 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
1486 (** {6 Instruction builders} *)
1488 (** [builder context] creates an instruction builder with no position in
1489 the context [context]. It is invalid to use this builder until its position
1490 is set with {!position_before} or {!position_at_end}. See the constructor
1491 for [llvm::LLVMBuilder]. *)
1492 external builder : llcontext -> llbuilder = "llvm_builder"
1494 (** [builder_at ip] creates an instruction builder positioned at [ip].
1495 See the constructor for [llvm::LLVMBuilder]. *)
1496 val builder_at : llcontext -> (llbasicblock, llvalue) llpos -> llbuilder
1498 (** [builder_before ins] creates an instruction builder positioned before the
1499 instruction [isn]. See the constructor for [llvm::LLVMBuilder]. *)
1500 val builder_before : llcontext -> llvalue -> llbuilder
1502 (** [builder_at_end bb] creates an instruction builder positioned at the end of
1503 the basic block [bb]. See the constructor for [llvm::LLVMBuilder]. *)
1504 val builder_at_end : llcontext -> llbasicblock -> llbuilder
1506 (** [position_builder ip bb] moves the instruction builder [bb] to the position
1508 See the constructor for [llvm::LLVMBuilder]. *)
1509 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
1510 = "llvm_position_builder"
1512 (** [position_before ins b] moves the instruction builder [b] to before the
1513 instruction [isn]. See the method [llvm::LLVMBuilder::SetInsertPoint]. *)
1514 val position_before : llvalue -> llbuilder -> unit
1516 (** [position_at_end bb b] moves the instruction builder [b] to the end of the
1517 basic block [bb]. See the method [llvm::LLVMBuilder::SetInsertPoint]. *)
1518 val position_at_end : llbasicblock -> llbuilder -> unit
1520 (** [insertion_block b] returns the basic block that the builder [b] is
1521 positioned to insert into. Raises [Not_Found] if the instruction builder is
1523 See the method [llvm::LLVMBuilder::GetInsertBlock]. *)
1524 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
1526 (** [insert_into_builder i name b] inserts the specified instruction [i] at the
1527 position specified by the instruction builder [b].
1528 See the method [llvm::LLVMBuilder::Insert]. *)
1529 external insert_into_builder : llvalue -> string -> llbuilder -> unit
1530 = "llvm_insert_into_builder"
1534 (** [set_current_debug_location b md] sets the current debug location [md] in
1536 See the method [llvm::IRBuilder::SetDebugLocation]. *)
1537 external set_current_debug_location : llbuilder -> llvalue -> unit
1538 = "llvm_set_current_debug_location"
1540 (** [clear_current_debug_location b] clears the current debug location in the
1542 external clear_current_debug_location : llbuilder -> unit
1543 = "llvm_clear_current_debug_location"
1545 (** [current_debug_location b] returns the current debug location, or None
1546 if none is currently set.
1547 See the method [llvm::IRBuilder::GetDebugLocation]. *)
1548 external current_debug_location : llbuilder -> llvalue option
1549 = "llvm_current_debug_location"
1551 (** [set_inst_debug_location b i] sets the current debug location of the builder
1552 [b] to the instruction [i].
1553 See the method [llvm::IRBuilder::SetInstDebugLocation]. *)
1554 external set_inst_debug_location : llbuilder -> llvalue -> unit
1555 = "llvm_set_inst_debug_location"
1557 (** {7 Terminators} *)
1559 (** [build_ret_void b] creates a
1561 instruction at the position specified by the instruction builder [b].
1562 See the method [llvm::LLVMBuilder::CreateRetVoid]. *)
1563 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
1565 (** [build_ret v b] creates a
1567 instruction at the position specified by the instruction builder [b].
1568 See the method [llvm::LLVMBuilder::CreateRet]. *)
1569 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
1571 (** [build_aggregate_ret vs b] creates a
1572 [ret {...} { %v1, %v2, ... } ]
1573 instruction at the position specified by the instruction builder [b].
1574 See the method [llvm::LLVMBuilder::CreateAggregateRet]. *)
1575 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
1576 = "llvm_build_aggregate_ret"
1578 (** [build_br bb b] creates a
1580 instruction at the position specified by the instruction builder [b].
1581 See the method [llvm::LLVMBuilder::CreateBr]. *)
1582 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
1584 (** [build_cond_br cond tbb fbb b] creates a
1585 [br %cond, %tbb, %fbb]
1586 instruction at the position specified by the instruction builder [b].
1587 See the method [llvm::LLVMBuilder::CreateCondBr]. *)
1588 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
1589 llvalue = "llvm_build_cond_br"
1591 (** [build_switch case elsebb count b] creates an empty
1592 [switch %case, %elsebb]
1593 instruction at the position specified by the instruction builder [b] with
1594 space reserved for [count] cases.
1595 See the method [llvm::LLVMBuilder::CreateSwitch]. *)
1596 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
1597 = "llvm_build_switch"
1599 (** [add_case sw onval bb] causes switch instruction [sw] to branch to [bb]
1600 when its input matches the constant [onval].
1601 See the method [llvm::SwitchInst::addCase]. **)
1602 external add_case : llvalue -> llvalue -> llbasicblock -> unit
1605 (** [build_indirect_br addr count b] creates a
1607 instruction at the position specified by the instruction builder [b] with
1608 space reserved for [count] destinations.
1609 See the method [llvm::LLVMBuilder::CreateIndirectBr]. *)
1610 external build_indirect_br : llvalue -> int -> llbuilder -> llvalue
1611 = "llvm_build_indirect_br"
1613 (** [add_destination br bb] adds the basic block [bb] as a possible branch
1614 location for the indirectbr instruction [br].
1615 See the method [llvm::IndirectBrInst::addDestination]. **)
1616 external add_destination : llvalue -> llbasicblock -> unit
1617 = "llvm_add_destination"
1619 (** [build_invoke fn args tobb unwindbb name b] creates an
1620 [%name = invoke %fn(args) to %tobb unwind %unwindbb]
1621 instruction at the position specified by the instruction builder [b].
1622 See the method [llvm::LLVMBuilder::CreateInvoke]. *)
1623 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
1624 llbasicblock -> string -> llbuilder -> llvalue
1625 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
1627 (** [build_unwind b] creates an
1629 instruction at the position specified by the instruction builder [b].
1630 See the method [llvm::LLVMBuilder::CreateUnwind]. *)
1631 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
1633 (** [build_unreachable b] creates an
1635 instruction at the position specified by the instruction builder [b].
1636 See the method [llvm::LLVMBuilder::CreateUnwind]. *)
1637 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
1640 (** {7 Arithmetic} *)
1642 (** [build_add x y name b] creates a
1643 [%name = add %x, %y]
1644 instruction at the position specified by the instruction builder [b].
1645 See the method [llvm::LLVMBuilder::CreateAdd]. *)
1646 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
1649 (** [build_nsw_add x y name b] creates a
1650 [%name = nsw add %x, %y]
1651 instruction at the position specified by the instruction builder [b].
1652 See the method [llvm::LLVMBuilder::CreateNSWAdd]. *)
1653 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
1654 = "llvm_build_nsw_add"
1656 (** [build_nuw_add x y name b] creates a
1657 [%name = nuw add %x, %y]
1658 instruction at the position specified by the instruction builder [b].
1659 See the method [llvm::LLVMBuilder::CreateNUWAdd]. *)
1660 external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
1661 = "llvm_build_nuw_add"
1663 (** [build_fadd x y name b] creates a
1664 [%name = fadd %x, %y]
1665 instruction at the position specified by the instruction builder [b].
1666 See the method [llvm::LLVMBuilder::CreateFAdd]. *)
1667 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
1670 (** [build_sub x y name b] creates a
1671 [%name = sub %x, %y]
1672 instruction at the position specified by the instruction builder [b].
1673 See the method [llvm::LLVMBuilder::CreateSub]. *)
1674 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1677 (** [build_nsw_sub x y name b] creates a
1678 [%name = nsw sub %x, %y]
1679 instruction at the position specified by the instruction builder [b].
1680 See the method [llvm::LLVMBuilder::CreateNSWSub]. *)
1681 external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1682 = "llvm_build_nsw_sub"
1684 (** [build_nuw_sub x y name b] creates a
1685 [%name = nuw sub %x, %y]
1686 instruction at the position specified by the instruction builder [b].
1687 See the method [llvm::LLVMBuilder::CreateNUWSub]. *)
1688 external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1689 = "llvm_build_nuw_sub"
1691 (** [build_fsub x y name b] creates a
1692 [%name = fsub %x, %y]
1693 instruction at the position specified by the instruction builder [b].
1694 See the method [llvm::LLVMBuilder::CreateFSub]. *)
1695 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1698 (** [build_mul x y name b] creates a
1699 [%name = mul %x, %y]
1700 instruction at the position specified by the instruction builder [b].
1701 See the method [llvm::LLVMBuilder::CreateMul]. *)
1702 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1705 (** [build_nsw_mul x y name b] creates a
1706 [%name = nsw mul %x, %y]
1707 instruction at the position specified by the instruction builder [b].
1708 See the method [llvm::LLVMBuilder::CreateNSWMul]. *)
1709 external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1710 = "llvm_build_nsw_mul"
1712 (** [build_nuw_mul x y name b] creates a
1713 [%name = nuw mul %x, %y]
1714 instruction at the position specified by the instruction builder [b].
1715 See the method [llvm::LLVMBuilder::CreateNUWMul]. *)
1716 external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1717 = "llvm_build_nuw_mul"
1719 (** [build_fmul x y name b] creates a
1720 [%name = fmul %x, %y]
1721 instruction at the position specified by the instruction builder [b].
1722 See the method [llvm::LLVMBuilder::CreateFMul]. *)
1723 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1726 (** [build_udiv x y name b] creates a
1727 [%name = udiv %x, %y]
1728 instruction at the position specified by the instruction builder [b].
1729 See the method [llvm::LLVMBuilder::CreateUDiv]. *)
1730 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1733 (** [build_sdiv x y name b] creates a
1734 [%name = sdiv %x, %y]
1735 instruction at the position specified by the instruction builder [b].
1736 See the method [llvm::LLVMBuilder::CreateSDiv]. *)
1737 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1740 (** [build_exact_sdiv x y name b] creates a
1741 [%name = exact sdiv %x, %y]
1742 instruction at the position specified by the instruction builder [b].
1743 See the method [llvm::LLVMBuilder::CreateExactSDiv]. *)
1744 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1745 = "llvm_build_exact_sdiv"
1747 (** [build_fdiv x y name b] creates a
1748 [%name = fdiv %x, %y]
1749 instruction at the position specified by the instruction builder [b].
1750 See the method [llvm::LLVMBuilder::CreateFDiv]. *)
1751 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1754 (** [build_urem x y name b] creates a
1755 [%name = urem %x, %y]
1756 instruction at the position specified by the instruction builder [b].
1757 See the method [llvm::LLVMBuilder::CreateURem]. *)
1758 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
1761 (** [build_SRem x y name b] creates a
1762 [%name = srem %x, %y]
1763 instruction at the position specified by the instruction builder [b].
1764 See the method [llvm::LLVMBuilder::CreateSRem]. *)
1765 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
1768 (** [build_frem x y name b] creates a
1769 [%name = frem %x, %y]
1770 instruction at the position specified by the instruction builder [b].
1771 See the method [llvm::LLVMBuilder::CreateFRem]. *)
1772 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
1775 (** [build_shl x y name b] creates a
1776 [%name = shl %x, %y]
1777 instruction at the position specified by the instruction builder [b].
1778 See the method [llvm::LLVMBuilder::CreateShl]. *)
1779 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
1782 (** [build_lshr x y name b] creates a
1783 [%name = lshr %x, %y]
1784 instruction at the position specified by the instruction builder [b].
1785 See the method [llvm::LLVMBuilder::CreateLShr]. *)
1786 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
1789 (** [build_ashr x y name b] creates a
1790 [%name = ashr %x, %y]
1791 instruction at the position specified by the instruction builder [b].
1792 See the method [llvm::LLVMBuilder::CreateAShr]. *)
1793 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
1796 (** [build_and x y name b] creates a
1797 [%name = and %x, %y]
1798 instruction at the position specified by the instruction builder [b].
1799 See the method [llvm::LLVMBuilder::CreateAnd]. *)
1800 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
1803 (** [build_or x y name b] creates a
1805 instruction at the position specified by the instruction builder [b].
1806 See the method [llvm::LLVMBuilder::CreateOr]. *)
1807 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
1810 (** [build_xor x y name b] creates a
1811 [%name = xor %x, %y]
1812 instruction at the position specified by the instruction builder [b].
1813 See the method [llvm::LLVMBuilder::CreateXor]. *)
1814 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
1817 (** [build_neg x name b] creates a
1819 instruction at the position specified by the instruction builder [b].
1820 [-0.0] is used for floating point types to compute the correct sign.
1821 See the method [llvm::LLVMBuilder::CreateNeg]. *)
1822 external build_neg : llvalue -> string -> llbuilder -> llvalue
1825 (** [build_nsw_neg x name b] creates a
1826 [%name = nsw sub 0, %x]
1827 instruction at the position specified by the instruction builder [b].
1828 [-0.0] is used for floating point types to compute the correct sign.
1829 See the method [llvm::LLVMBuilder::CreateNeg]. *)
1830 external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
1831 = "llvm_build_nsw_neg"
1833 (** [build_nuw_neg x name b] creates a
1834 [%name = nuw sub 0, %x]
1835 instruction at the position specified by the instruction builder [b].
1836 [-0.0] is used for floating point types to compute the correct sign.
1837 See the method [llvm::LLVMBuilder::CreateNeg]. *)
1838 external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
1839 = "llvm_build_nuw_neg"
1841 (** [build_fneg x name b] creates a
1842 [%name = fsub 0, %x]
1843 instruction at the position specified by the instruction builder [b].
1844 [-0.0] is used for floating point types to compute the correct sign.
1845 See the method [llvm::LLVMBuilder::CreateFNeg]. *)
1846 external build_fneg : llvalue -> string -> llbuilder -> llvalue
1849 (** [build_xor x name b] creates a
1850 [%name = xor %x, -1]
1851 instruction at the position specified by the instruction builder [b].
1852 [-1] is the correct "all ones" value for the type of [x].
1853 See the method [llvm::LLVMBuilder::CreateXor]. *)
1854 external build_not : llvalue -> string -> llbuilder -> llvalue
1860 (** [build_alloca ty name b] creates a
1861 [%name = alloca %ty]
1862 instruction at the position specified by the instruction builder [b].
1863 See the method [llvm::LLVMBuilder::CreateAlloca]. *)
1864 external build_alloca : lltype -> string -> llbuilder -> llvalue
1865 = "llvm_build_alloca"
1867 (** [build_array_alloca ty n name b] creates a
1868 [%name = alloca %ty, %n]
1869 instruction at the position specified by the instruction builder [b].
1870 See the method [llvm::LLVMBuilder::CreateAlloca]. *)
1871 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
1872 llvalue = "llvm_build_array_alloca"
1874 (** [build_load v name b] creates a
1876 instruction at the position specified by the instruction builder [b].
1877 See the method [llvm::LLVMBuilder::CreateLoad]. *)
1878 external build_load : llvalue -> string -> llbuilder -> llvalue
1881 (** [build_store v p b] creates a
1883 instruction at the position specified by the instruction builder [b].
1884 See the method [llvm::LLVMBuilder::CreateStore]. *)
1885 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
1886 = "llvm_build_store"
1888 (** [build_gep p indices name b] creates a
1889 [%name = getelementptr %p, indices...]
1890 instruction at the position specified by the instruction builder [b].
1891 See the method [llvm::LLVMBuilder::CreateGetElementPtr]. *)
1892 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
1895 (** [build_in_bounds_gep p indices name b] creates a
1896 [%name = gelementptr inbounds %p, indices...]
1897 instruction at the position specified by the instruction builder [b].
1898 See the method [llvm::LLVMBuilder::CreateInBoundsGetElementPtr]. *)
1899 external build_in_bounds_gep : llvalue -> llvalue array -> string -> llbuilder ->
1900 llvalue = "llvm_build_in_bounds_gep"
1902 (** [build_struct_gep p idx name b] creates a
1903 [%name = getelementptr %p, 0, idx]
1904 instruction at the position specified by the instruction builder [b].
1905 See the method [llvm::LLVMBuilder::CreateStructGetElementPtr]. *)
1906 external build_struct_gep : llvalue -> int -> string -> llbuilder ->
1907 llvalue = "llvm_build_struct_gep"
1909 (** [build_global_string str name b] creates a series of instructions that adds
1910 a global string at the position specified by the instruction builder [b].
1911 See the method [llvm::LLVMBuilder::CreateGlobalString]. *)
1912 external build_global_string : string -> string -> llbuilder -> llvalue
1913 = "llvm_build_global_string"
1915 (** [build_global_stringptr str name b] creates a series of instructions that
1916 adds a global string pointer at the position specified by the instruction
1918 See the method [llvm::LLVMBuilder::CreateGlobalStringPtr]. *)
1919 external build_global_stringptr : string -> string -> llbuilder -> llvalue
1920 = "llvm_build_global_stringptr"
1925 (** [build_trunc v ty name b] creates a
1926 [%name = trunc %p to %ty]
1927 instruction at the position specified by the instruction builder [b].
1928 See the method [llvm::LLVMBuilder::CreateTrunc]. *)
1929 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
1930 = "llvm_build_trunc"
1932 (** [build_zext v ty name b] creates a
1933 [%name = zext %p to %ty]
1934 instruction at the position specified by the instruction builder [b].
1935 See the method [llvm::LLVMBuilder::CreateZExt]. *)
1936 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
1939 (** [build_sext v ty name b] creates a
1940 [%name = sext %p to %ty]
1941 instruction at the position specified by the instruction builder [b].
1942 See the method [llvm::LLVMBuilder::CreateSExt]. *)
1943 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
1946 (** [build_fptoui v ty name b] creates a
1947 [%name = fptoui %p to %ty]
1948 instruction at the position specified by the instruction builder [b].
1949 See the method [llvm::LLVMBuilder::CreateFPToUI]. *)
1950 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
1951 = "llvm_build_fptoui"
1953 (** [build_fptosi v ty name b] creates a
1954 [%name = fptosi %p to %ty]
1955 instruction at the position specified by the instruction builder [b].
1956 See the method [llvm::LLVMBuilder::CreateFPToSI]. *)
1957 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
1958 = "llvm_build_fptosi"
1960 (** [build_uitofp v ty name b] creates a
1961 [%name = uitofp %p to %ty]
1962 instruction at the position specified by the instruction builder [b].
1963 See the method [llvm::LLVMBuilder::CreateUIToFP]. *)
1964 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
1965 = "llvm_build_uitofp"
1967 (** [build_sitofp v ty name b] creates a
1968 [%name = sitofp %p to %ty]
1969 instruction at the position specified by the instruction builder [b].
1970 See the method [llvm::LLVMBuilder::CreateSIToFP]. *)
1971 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
1972 = "llvm_build_sitofp"
1974 (** [build_fptrunc v ty name b] creates a
1975 [%name = fptrunc %p to %ty]
1976 instruction at the position specified by the instruction builder [b].
1977 See the method [llvm::LLVMBuilder::CreateFPTrunc]. *)
1978 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
1979 = "llvm_build_fptrunc"
1981 (** [build_fpext v ty name b] creates a
1982 [%name = fpext %p to %ty]
1983 instruction at the position specified by the instruction builder [b].
1984 See the method [llvm::LLVMBuilder::CreateFPExt]. *)
1985 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
1986 = "llvm_build_fpext"
1988 (** [build_ptrtoint v ty name b] creates a
1989 [%name = prtotint %p to %ty]
1990 instruction at the position specified by the instruction builder [b].
1991 See the method [llvm::LLVMBuilder::CreatePtrToInt]. *)
1992 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
1993 = "llvm_build_prttoint"
1995 (** [build_inttoptr v ty name b] creates a
1996 [%name = inttoptr %p to %ty]
1997 instruction at the position specified by the instruction builder [b].
1998 See the method [llvm::LLVMBuilder::CreateIntToPtr]. *)
1999 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
2000 = "llvm_build_inttoptr"
2002 (** [build_bitcast v ty name b] creates a
2003 [%name = bitcast %p to %ty]
2004 instruction at the position specified by the instruction builder [b].
2005 See the method [llvm::LLVMBuilder::CreateBitCast]. *)
2006 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
2007 = "llvm_build_bitcast"
2009 (** [build_zext_or_bitcast v ty name b] creates a zext or bitcast
2010 instruction at the position specified by the instruction builder [b].
2011 See the method [llvm::LLVMBuilder::CreateZExtOrBitCast]. *)
2012 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
2013 llvalue = "llvm_build_zext_or_bitcast"
2015 (** [build_sext_or_bitcast v ty name b] creates a sext or bitcast
2016 instruction at the position specified by the instruction builder [b].
2017 See the method [llvm::LLVMBuilder::CreateSExtOrBitCast]. *)
2018 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
2019 llvalue = "llvm_build_sext_or_bitcast"
2021 (** [build_trunc_or_bitcast v ty name b] creates a trunc or bitcast
2022 instruction at the position specified by the instruction builder [b].
2023 See the method [llvm::LLVMBuilder::CreateZExtOrBitCast]. *)
2024 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
2025 llvalue = "llvm_build_trunc_or_bitcast"
2027 (** [build_pointercast v ty name b] creates a bitcast or pointer-to-int
2028 instruction at the position specified by the instruction builder [b].
2029 See the method [llvm::LLVMBuilder::CreatePointerCast]. *)
2030 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
2031 = "llvm_build_pointercast"
2033 (** [build_intcast v ty name b] creates a zext, bitcast, or trunc
2034 instruction at the position specified by the instruction builder [b].
2035 See the method [llvm::LLVMBuilder::CreateIntCast]. *)
2036 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
2037 = "llvm_build_intcast"
2039 (** [build_fpcast v ty name b] creates a fpext, bitcast, or fptrunc
2040 instruction at the position specified by the instruction builder [b].
2041 See the method [llvm::LLVMBuilder::CreateFPCast]. *)
2042 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
2043 = "llvm_build_fpcast"
2046 (** {7 Comparisons} *)
2048 (** [build_icmp pred x y name b] creates a
2049 [%name = icmp %pred %x, %y]
2050 instruction at the position specified by the instruction builder [b].
2051 See the method [llvm::LLVMBuilder::CreateICmp]. *)
2052 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
2053 llbuilder -> llvalue = "llvm_build_icmp"
2055 (** [build_fcmp pred x y name b] creates a
2056 [%name = fcmp %pred %x, %y]
2057 instruction at the position specified by the instruction builder [b].
2058 See the method [llvm::LLVMBuilder::CreateFCmp]. *)
2059 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
2060 llbuilder -> llvalue = "llvm_build_fcmp"
2063 (** {7 Miscellaneous instructions} *)
2065 (** [build_phi incoming name b] creates a
2066 [%name = phi %incoming]
2067 instruction at the position specified by the instruction builder [b].
2068 [incoming] is a list of [(llvalue, llbasicblock)] tuples.
2069 See the method [llvm::LLVMBuilder::CreatePHI]. *)
2070 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
2071 llvalue = "llvm_build_phi"
2073 (** [build_call fn args name b] creates a
2074 [%name = call %fn(args...)]
2075 instruction at the position specified by the instruction builder [b].
2076 See the method [llvm::LLVMBuilder::CreateCall]. *)
2077 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
2080 (** [build_select cond thenv elsev name b] creates a
2081 [%name = select %cond, %thenv, %elsev]
2082 instruction at the position specified by the instruction builder [b].
2083 See the method [llvm::LLVMBuilder::CreateSelect]. *)
2084 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
2085 llvalue = "llvm_build_select"
2087 (** [build_va_arg valist argty name b] creates a
2088 [%name = va_arg %valist, %argty]
2089 instruction at the position specified by the instruction builder [b].
2090 See the method [llvm::LLVMBuilder::CreateVAArg]. *)
2091 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
2092 = "llvm_build_va_arg"
2094 (** [build_extractelement vec i name b] creates a
2095 [%name = extractelement %vec, %i]
2096 instruction at the position specified by the instruction builder [b].
2097 See the method [llvm::LLVMBuilder::CreateExtractElement]. *)
2098 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
2099 llvalue = "llvm_build_extractelement"
2101 (** [build_insertelement vec elt i name b] creates a
2102 [%name = insertelement %vec, %elt, %i]
2103 instruction at the position specified by the instruction builder [b].
2104 See the method [llvm::LLVMBuilder::CreateInsertElement]. *)
2105 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
2106 llbuilder -> llvalue = "llvm_build_insertelement"
2108 (** [build_shufflevector veca vecb mask name b] creates a
2109 [%name = shufflevector %veca, %vecb, %mask]
2110 instruction at the position specified by the instruction builder [b].
2111 See the method [llvm::LLVMBuilder::CreateShuffleVector]. *)
2112 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
2113 llbuilder -> llvalue = "llvm_build_shufflevector"
2115 (** [build_insertvalue agg idx name b] creates a
2116 [%name = extractvalue %agg, %idx]
2117 instruction at the position specified by the instruction builder [b].
2118 See the method [llvm::LLVMBuilder::CreateExtractValue]. *)
2119 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
2120 = "llvm_build_extractvalue"
2122 (** [build_insertvalue agg val idx name b] creates a
2123 [%name = insertvalue %agg, %val, %idx]
2124 instruction at the position specified by the instruction builder [b].
2125 See the method [llvm::LLVMBuilder::CreateInsertValue]. *)
2126 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
2127 llvalue = "llvm_build_insertvalue"
2129 (** [build_is_null val name b] creates a
2130 [%name = icmp eq %val, null]
2131 instruction at the position specified by the instruction builder [b].
2132 See the method [llvm::LLVMBuilder::CreateIsNull]. *)
2133 external build_is_null : llvalue -> string -> llbuilder -> llvalue
2134 = "llvm_build_is_null"
2136 (** [build_is_not_null val name b] creates a
2137 [%name = icmp ne %val, null]
2138 instruction at the position specified by the instruction builder [b].
2139 See the method [llvm::LLVMBuilder::CreateIsNotNull]. *)
2140 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
2141 = "llvm_build_is_not_null"
2143 (** [build_ptrdiff lhs rhs name b] creates a series of instructions that measure
2144 the difference between two pointer values at the position specified by the
2145 instruction builder [b].
2146 See the method [llvm::LLVMBuilder::CreatePtrDiff]. *)
2147 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
2148 = "llvm_build_ptrdiff"
2150 (** {6 Module providers} *)
2152 module ModuleProvider : sig
2153 (** [create_module_provider m] encapsulates [m] in a module provider and takes
2154 ownership of the module. See the constructor
2155 [llvm::ExistingModuleProvider::ExistingModuleProvider]. *)
2156 external create : llmodule -> llmoduleprovider
2157 = "LLVMCreateModuleProviderForExistingModule"
2159 (** [dispose_module_provider mp] destroys the module provider [mp] as well as
2160 the contained module. *)
2161 external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider"
2165 (** {6 Memory buffers} *)
2167 module MemoryBuffer : sig
2168 (** [of_file p] is the memory buffer containing the contents of the file at
2169 path [p]. If the file could not be read, then [IoError msg] is
2171 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
2173 (** [stdin ()] is the memory buffer containing the contents of standard input.
2174 If standard input is empty, then [IoError msg] is raised. *)
2175 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
2177 (** Disposes of a memory buffer. *)
2178 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
2182 (** {6 Pass Managers} *)
2184 module PassManager : sig
2187 type any = [ `Module | `Function ]
2189 (** [PassManager.create ()] constructs a new whole-module pass pipeline. This
2190 type of pipeline is suitable for link-time optimization and whole-module
2192 See the constructor of [llvm::PassManager]. *)
2193 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
2195 (** [PassManager.create_function mp] constructs a new function-by-function
2196 pass pipeline over the module provider [mp]. It does not take ownership of
2197 [mp]. This type of pipeline is suitable for code generation and JIT
2199 See the constructor of [llvm::FunctionPassManager]. *)
2200 external create_function : llmoduleprovider -> [ `Function ] t
2201 = "LLVMCreateFunctionPassManager"
2203 (** [run_module m pm] initializes, executes on the module [m], and finalizes
2204 all of the passes scheduled in the pass manager [pm]. Returns [true] if
2205 any of the passes modified the module, [false] otherwise.
2206 See the [llvm::PassManager::run] method. *)
2207 external run_module : llmodule -> [ `Module ] t -> bool
2208 = "llvm_passmanager_run_module"
2210 (** [initialize fpm] initializes all of the function passes scheduled in the
2211 function pass manager [fpm]. Returns [true] if any of the passes modified
2212 the module, [false] otherwise.
2213 See the [llvm::FunctionPassManager::doInitialization] method. *)
2214 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
2216 (** [run_function f fpm] executes all of the function passes scheduled in the
2217 function pass manager [fpm] over the function [f]. Returns [true] if any
2218 of the passes modified [f], [false] otherwise.
2219 See the [llvm::FunctionPassManager::run] method. *)
2220 external run_function : llvalue -> [ `Function ] t -> bool
2221 = "llvm_passmanager_run_function"
2223 (** [finalize fpm] finalizes all of the function passes scheduled in in the
2224 function pass manager [fpm]. Returns [true] if any of the passes
2225 modified the module, [false] otherwise.
2226 See the [llvm::FunctionPassManager::doFinalization] method. *)
2227 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
2229 (** Frees the memory of a pass pipeline. For function pipelines, does not free
2230 the module provider.
2231 See the destructor of [llvm::BasePassManager]. *)
2232 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"