54d070fb04316fe076c1c4fd5e37c4d8700c517b
[oota-llvm.git] / bindings / ocaml / llvm / llvm.mli
1 (*===-- llvm/llvm.mli - LLVM OCaml Interface ------------------------------===*
2  *
3  *                     The LLVM Compiler Infrastructure
4  *
5  * This file is distributed under the University of Illinois Open Source
6  * License. See LICENSE.TXT for details.
7  *
8  *===----------------------------------------------------------------------===*)
9
10 (** Core API.
11
12     This interface provides an OCaml API for the LLVM intermediate
13     representation, the classes in the VMCore library. *)
14
15
16 (** {6 Abstract types}
17
18     These abstract types correlate directly to the LLVM VMCore classes. *)
19
20 (** The top-level container for all LLVM global data. See the
21     [llvm::LLVMContext] class. *)
22 type llcontext
23
24 (** The top-level container for all other LLVM Intermediate Representation (IR)
25     objects. See the [llvm::Module] class. *)
26 type llmodule
27
28 (** Each value in the LLVM IR has a type, an instance of [lltype]. See the
29     [llvm::Type] class. *)
30 type lltype
31
32 (** Any value in the LLVM IR. Functions, instructions, global variables,
33     constants, and much more are all [llvalues]. See the [llvm::Value] class.
34     This type covers a wide range of subclasses. *)
35 type llvalue
36
37 (** Used to store users and usees of values. See the [llvm::Use] class. *)
38 type lluse
39
40 (** A basic block in LLVM IR. See the [llvm::BasicBlock] class. *)
41 type llbasicblock
42
43 (** Used to generate instructions in the LLVM IR. See the [llvm::LLVMBuilder]
44     class. *)
45 type llbuilder
46
47 (** Used to efficiently handle large buffers of read-only binary data.
48     See the [llvm::MemoryBuffer] class. *)
49 type llmemorybuffer
50
51 (** The kind id of metadata attached to an instruction. *)
52 type llmdkind
53
54 (** The kind of an [lltype], the result of [classify_type ty]. See the
55     [llvm::Type::TypeID] enumeration. *)
56 module TypeKind : sig
57   type t =
58     Void
59   | Half
60   | Float
61   | Double
62   | X86fp80
63   | Fp128
64   | Ppc_fp128
65   | Label
66   | Integer
67   | Function
68   | Struct
69   | Array
70   | Pointer
71   | Vector
72   | Metadata
73   | X86_mmx
74 end
75
76 (** The linkage of a global value, accessed with {!linkage} and
77     {!set_linkage}. See [llvm::GlobalValue::LinkageTypes]. *)
78 module Linkage : sig
79   type t =
80     External
81   | Available_externally
82   | Link_once
83   | Link_once_odr
84   | Link_once_odr_auto_hide
85   | Weak
86   | Weak_odr
87   | Appending
88   | Internal
89   | Private
90   | Dllimport
91   | Dllexport
92   | External_weak
93   | Ghost
94   | Common
95   | Linker_private
96   | Linker_private_weak
97 end
98
99 (** The linker visibility of a global value, accessed with {!visibility} and
100     {!set_visibility}. See [llvm::GlobalValue::VisibilityTypes]. *)
101 module Visibility : sig
102   type t =
103     Default
104   | Hidden
105   | Protected
106 end
107
108 (** The following calling convention values may be accessed with
109     {!function_call_conv} and {!set_function_call_conv}. Calling
110     conventions are open-ended. *)
111 module CallConv : sig
112   val c : int             (** [c] is the C calling convention. *)
113   val fast : int          (** [fast] is the calling convention to allow LLVM
114                               maximum optimization opportunities. Use only with
115                               internal linkage. *)
116   val cold : int          (** [cold] is the calling convention for
117                               callee-save. *)
118   val x86_stdcall : int   (** [x86_stdcall] is the familiar stdcall calling
119                               convention from C. *)
120   val x86_fastcall : int  (** [x86_fastcall] is the familiar fastcall calling
121                               convention from C. *)
122 end
123
124 (** The attribute kind of a function parameter, result or the function itself.
125     See [llvm::Attribute::AttrKind]. *)
126 module Attribute : sig
127   type t =
128   | Zext
129   | Sext
130   | Noreturn
131   | Inreg
132   | Structret
133   | Nounwind
134   | Noalias
135   | Byval
136   | Nest
137   | Readnone
138   | Readonly
139   | Noinline
140   | Alwaysinline
141   | Optsize
142   | Ssp
143   | Sspreq
144   | Alignment of int
145   | Nocapture
146   | Noredzone
147   | Noimplicitfloat
148   | Naked
149   | Inlinehint
150   | Stackalignment of int
151   | ReturnsTwice
152   | UWTable
153   | NonLazyBind
154 end
155
156 (** The predicate for an integer comparison ([icmp]) instruction.
157     See the [llvm::ICmpInst::Predicate] enumeration. *)
158 module Icmp : sig
159   type t =
160   | Eq  (* Equal *)
161   | Ne  (* Not equal *)
162   | Ugt (* Unsigned greater than *)
163   | Uge (* Unsigned greater or equal *)
164   | Ult (* Unsigned less than *)
165   | Ule (* Unsigned less or equal *)
166   | Sgt (* Signed greater than *)
167   | Sge (* Signed greater or equal *)
168   | Slt (* Signed less than *)
169   | Sle (* Signed less or equal *)
170 end
171
172 (** The predicate for a floating-point comparison ([fcmp]) instruction.
173     Ordered means that neither operand is a QNAN while unordered means
174     that either operand may be a QNAN.
175     See the [llvm::FCmpInst::Predicate] enumeration. *)
176 module Fcmp : sig
177   type t =
178   | False (* Always false *)
179   | Oeq   (* Ordered and equal *)
180   | Ogt   (* Ordered and greater than *)
181   | Oge   (* Ordered and greater or equal *)
182   | Olt   (* Ordered and less than *)
183   | Ole   (* Ordered and less or equal *)
184   | One   (* Ordered and not equal *)
185   | Ord   (* Ordered (no operand is NaN) *)
186   | Uno   (* Unordered (one operand at least is NaN) *)
187   | Ueq   (* Unordered and equal *)
188   | Ugt   (* Unordered and greater than *)
189   | Uge   (* Unordered and greater or equal *)
190   | Ult   (* Unordered and less than *)
191   | Ule   (* Unordered and less or equal *)
192   | Une   (* Unordered and not equal *)
193   | True  (* Always true *)
194 end
195
196 (** The opcodes for LLVM instructions and constant expressions. *)
197 module Opcode : sig
198   type t =
199   | Invalid (* not an instruction *)
200   (* Terminator Instructions *)
201   | Ret
202   | Br
203   | Switch
204   | IndirectBr
205   | Invoke
206   | Invalid2
207   | Unreachable
208   (* Standard Binary Operators *)
209   | Add
210   | FAdd
211   | Sub
212   | FSub
213   | Mul
214   | FMul
215   | UDiv
216   | SDiv
217   | FDiv
218   | URem
219   | SRem
220   | FRem
221   (* Logical Operators *)
222   | Shl
223   | LShr
224   | AShr
225   | And
226   | Or
227   | Xor
228   (* Memory Operators *)
229   | Alloca
230   | Load
231   | Store
232   | GetElementPtr
233   (* Cast Operators *)
234   | Trunc
235   | ZExt
236   | SExt
237   | FPToUI
238   | FPToSI
239   | UIToFP
240   | SIToFP
241   | FPTrunc
242   | FPExt
243   | PtrToInt
244   | IntToPtr
245   | BitCast
246   (* Other Operators *)
247   | ICmp
248   | FCmp
249   | PHI
250   | Call
251   | Select
252   | UserOp1
253   | UserOp2
254   | VAArg
255   | ExtractElement
256   | InsertElement
257   | ShuffleVector
258   | ExtractValue
259   | InsertValue
260   | Fence
261   | AtomicCmpXchg
262   | AtomicRMW
263   | Resume
264   | LandingPad
265 end
266
267 (** The type of a clause of a [landingpad] instruction.
268     See [llvm::LandingPadInst::ClauseType]. *)
269 module LandingPadClauseTy : sig
270   type t =
271   | Catch
272   | Filter
273 end
274
275 (** The thread local mode of a global value, accessed with {!thread_local_mode}
276     and {!set_thread_local_mode}.
277     See [llvm::GlobalVariable::ThreadLocalMode]. *)
278 module ThreadLocalMode : sig
279   type t =
280   | None
281   | GeneralDynamic
282   | LocalDynamic
283   | InitialExec
284   | LocalExec
285 end
286
287 (** The ordering of an atomic [load], [store], [cmpxchg], [atomicrmw] or
288     [fence] instruction. See [llvm::AtomicOrdering]. *)
289 module AtomicOrdering : sig
290   type t =
291   | NotAtomic
292   | Unordered
293   | Monotonic
294   | Invalid (* removed due to API changes *)
295   | Acquire
296   | Release
297   | AcqiureRelease
298   | SequentiallyConsistent
299 end
300
301 (** The opcode of an [atomicrmw] instruction.
302     See [llvm::AtomicRMWInst::BinOp]. *)
303 module AtomicRMWBinOp : sig
304   type t =
305   | Xchg
306   | Add
307   | Sub
308   | And
309   | Nand
310   | Or
311   | Xor
312   | Max
313   | Min
314   | UMax
315   | UMin
316 end
317
318 (** The kind of an [llvalue], the result of [classify_value v].
319     See the various [LLVMIsA*] functions. *)
320 module ValueKind : sig
321   type t =
322   | NullValue
323   | Argument
324   | BasicBlock
325   | InlineAsm
326   | MDNode
327   | MDString
328   | BlockAddress
329   | ConstantAggregateZero
330   | ConstantArray
331   | ConstantDataArray
332   | ConstantDataVector
333   | ConstantExpr
334   | ConstantFP
335   | ConstantInt
336   | ConstantPointerNull
337   | ConstantStruct
338   | ConstantVector
339   | Function
340   | GlobalAlias
341   | GlobalVariable
342   | UndefValue
343   | Instruction of Opcode.t
344 end
345
346
347 (** {6 Iteration} *)
348
349 (** [Before b] and [At_end a] specify positions from the start of the ['b] list
350     of [a]. [llpos] is used to specify positions in and for forward iteration
351     through the various value lists maintained by the LLVM IR. *)
352 type ('a, 'b) llpos =
353 | At_end of 'a
354 | Before of 'b
355
356 (** [After b] and [At_start a] specify positions from the end of the ['b] list
357     of [a]. [llrev_pos] is used for reverse iteration through the various value
358     lists maintained by the LLVM IR. *)
359 type ('a, 'b) llrev_pos =
360 | At_start of 'a
361 | After of 'b
362
363
364 (** {6 Exceptions} *)
365
366 exception IoError of string
367
368
369 (** {6 Global configuration} *)
370
371 (** [enable_pretty_stacktraces ()] enables LLVM's built-in stack trace code.
372     This intercepts the OS's crash signals and prints which component of LLVM
373     you were in at the time of the crash. *)
374 val enable_pretty_stacktrace : unit -> unit
375
376 (** [install_fatal_error_handler f] installs [f] as LLVM's fatal error handler.
377     The handler will receive the reason for termination as a string. After
378     the handler has been executed, LLVM calls [exit(1)]. *)
379 val install_fatal_error_handler : (string -> unit) -> unit
380
381 (** [reset_fatal_error_handler ()] resets LLVM's fatal error handler. *)
382 val reset_fatal_error_handler : unit -> unit
383
384 (** {6 Contexts} *)
385
386 (** [create_context ()] creates a context for storing the "global" state in
387     LLVM. See the constructor [llvm::LLVMContext]. *)
388 val create_context : unit -> llcontext
389
390 (** [destroy_context ()] destroys a context. See the destructor
391     [llvm::LLVMContext::~LLVMContext]. *)
392 val dispose_context : llcontext -> unit
393
394 (** See the function [llvm::getGlobalContext]. *)
395 val global_context : unit -> llcontext
396
397 (** [mdkind_id context name] returns the MDKind ID that corresponds to the
398     name [name] in the context [context].  See the function
399     [llvm::LLVMContext::getMDKindID]. *)
400 val mdkind_id : llcontext -> string -> llmdkind
401
402
403 (** {6 Modules} *)
404
405 (** [create_module context id] creates a module with the supplied module ID in
406     the context [context].  Modules are not garbage collected; it is mandatory
407     to call {!dispose_module} to free memory. See the constructor
408     [llvm::Module::Module]. *)
409 val create_module : llcontext -> string -> llmodule
410
411 (** [dispose_module m] destroys a module [m] and all of the IR objects it
412     contained. All references to subordinate objects are invalidated;
413     referencing them will invoke undefined behavior. See the destructor
414     [llvm::Module::~Module]. *)
415 val dispose_module : llmodule -> unit
416
417 (** [target_triple m] is the target specifier for the module [m], something like
418     [i686-apple-darwin8]. See the method [llvm::Module::getTargetTriple]. *)
419 val target_triple: llmodule -> string
420
421 (** [target_triple triple m] changes the target specifier for the module [m] to
422     the string [triple]. See the method [llvm::Module::setTargetTriple]. *)
423 val set_target_triple: string -> llmodule -> unit
424
425 (** [data_layout m] is the data layout specifier for the module [m], something
426     like [e-p:32:32:32-i1:8:8-i8:8:8-i16:16:16-...-a0:0:64-f80:128:128]. See the
427     method [llvm::Module::getDataLayout]. *)
428 val data_layout: llmodule -> string
429
430 (** [set_data_layout s m] changes the data layout specifier for the module [m]
431     to the string [s]. See the method [llvm::Module::setDataLayout]. *)
432 val set_data_layout: string -> llmodule -> unit
433
434 (** [dump_module m] prints the .ll representation of the module [m] to standard
435     error. See the method [llvm::Module::dump]. *)
436 val dump_module : llmodule -> unit
437
438 (** [print_module f m] prints the .ll representation of the module [m]
439     to file [f]. See the method [llvm::Module::print]. *)
440 val print_module : string -> llmodule -> unit
441
442 (** [string_of_llmodule m] returns the .ll representation of the module [m]
443     as a string. See the method [llvm::Module::print]. *)
444 val string_of_llmodule : llmodule -> string
445
446 (** [set_module_inline_asm m asm] sets the inline assembler for the module. See
447     the method [llvm::Module::setModuleInlineAsm]. *)
448 val set_module_inline_asm : llmodule -> string -> unit
449
450 (** [module_context m] returns the context of the specified module.
451     See the method [llvm::Module::getContext] *)
452 val module_context : llmodule -> llcontext
453
454
455 (** {6 Types} *)
456
457 (** [classify_type ty] returns the {!TypeKind.t} corresponding to the type [ty].
458     See the method [llvm::Type::getTypeID]. *)
459 val classify_type : lltype -> TypeKind.t
460
461 (** [type_is_sized ty] returns whether the type has a size or not.
462     If it doesn't then it is not safe to call the [DataLayout::] methods on it.
463     *)
464 val type_is_sized : lltype -> bool
465
466 (** [type_context ty] returns the {!llcontext} corresponding to the type [ty].
467     See the method [llvm::Type::getContext]. *)
468 val type_context : lltype -> llcontext
469
470 (** [dump_type ty] prints the .ll representation of the type [ty] to standard
471     error. See the method [llvm::Type::dump]. *)
472 val dump_type : lltype -> unit
473
474 (** [string_of_lltype ty] returns a string describing the type [ty]. *)
475 val string_of_lltype : lltype -> string
476
477
478 (** {7 Operations on integer types} *)
479
480 (** [i1_type c] returns an integer type of bitwidth 1 in the context [c]. See
481     [llvm::Type::Int1Ty]. *)
482 val i1_type : llcontext -> lltype
483
484 (** [i8_type c] returns an integer type of bitwidth 8 in the context [c]. See
485     [llvm::Type::Int8Ty]. *)
486 val i8_type : llcontext -> lltype
487
488 (** [i16_type c] returns an integer type of bitwidth 16 in the context [c]. See
489     [llvm::Type::Int16Ty]. *)
490 val i16_type : llcontext -> lltype
491
492 (** [i32_type c] returns an integer type of bitwidth 32 in the context [c]. See
493     [llvm::Type::Int32Ty]. *)
494 val i32_type : llcontext -> lltype
495
496 (** [i64_type c] returns an integer type of bitwidth 64 in the context [c]. See
497     [llvm::Type::Int64Ty]. *)
498 val i64_type : llcontext -> lltype
499
500 (** [integer_type c n] returns an integer type of bitwidth [n] in the context
501     [c]. See the method [llvm::IntegerType::get]. *)
502 val integer_type : llcontext -> int -> lltype
503
504 (** [integer_bitwidth c ty] returns the number of bits in the integer type [ty]
505     in the context [c].  See the method [llvm::IntegerType::getBitWidth]. *)
506 val integer_bitwidth : lltype -> int
507
508
509 (** {7 Operations on real types} *)
510
511 (** [float_type c] returns the IEEE 32-bit floating point type in the context
512     [c]. See [llvm::Type::FloatTy]. *)
513 val float_type : llcontext -> lltype
514
515 (** [double_type c] returns the IEEE 64-bit floating point type in the context
516     [c]. See [llvm::Type::DoubleTy]. *)
517 val double_type : llcontext -> lltype
518
519 (** [x86fp80_type c] returns the x87 80-bit floating point type in the context
520     [c]. See [llvm::Type::X86_FP80Ty]. *)
521 val x86fp80_type : llcontext -> lltype
522
523 (** [fp128_type c] returns the IEEE 128-bit floating point type in the context
524     [c]. See [llvm::Type::FP128Ty]. *)
525 val fp128_type : llcontext -> lltype
526
527 (** [ppc_fp128_type c] returns the PowerPC 128-bit floating point type in the
528     context [c]. See [llvm::Type::PPC_FP128Ty]. *)
529 val ppc_fp128_type : llcontext -> lltype
530
531
532 (** {7 Operations on function types} *)
533
534 (** [function_type ret_ty param_tys] returns the function type returning
535     [ret_ty] and taking [param_tys] as parameters.
536     See the method [llvm::FunctionType::get]. *)
537 val function_type : lltype -> lltype array -> lltype
538
539 (** [var_arg_function_type ret_ty param_tys] is just like
540     [function_type ret_ty param_tys] except that it returns the function type
541     which also takes a variable number of arguments.
542     See the method [llvm::FunctionType::get]. *)
543 val var_arg_function_type : lltype -> lltype array -> lltype
544
545 (** [is_var_arg fty] returns [true] if [fty] is a varargs function type, [false]
546     otherwise. See the method [llvm::FunctionType::isVarArg]. *)
547 val is_var_arg : lltype -> bool
548
549 (** [return_type fty] gets the return type of the function type [fty].
550     See the method [llvm::FunctionType::getReturnType]. *)
551 val return_type : lltype -> lltype
552
553 (** [param_types fty] gets the parameter types of the function type [fty].
554     See the method [llvm::FunctionType::getParamType]. *)
555 val param_types : lltype -> lltype array
556
557
558 (** {7 Operations on struct types} *)
559
560 (** [struct_type context tys] returns the structure type in the context
561     [context] containing in the types in the array [tys]. See the method
562     [llvm::StructType::get]. *)
563 val struct_type : llcontext -> lltype array -> lltype
564
565 (** [packed_struct_type context ys] returns the packed structure type in the
566     context [context] containing in the types in the array [tys]. See the method
567     [llvm::StructType::get]. *)
568 val packed_struct_type : llcontext -> lltype array -> lltype
569
570 (** [struct_name ty] returns the name of the named structure type [ty],
571     or None if the structure type is not named *)
572 val struct_name : lltype -> string option
573
574 (** [named_struct_type context name] returns the named structure type [name]
575     in the context [context].
576     See the method [llvm::StructType::get]. *)
577 val named_struct_type : llcontext -> string -> lltype
578
579 (** [struct_set_body ty elts ispacked] sets the body of the named struct [ty]
580     to the [elts] elements.
581     See the moethd [llvm::StructType::setBody]. *)
582 val struct_set_body : lltype -> lltype array -> bool -> unit
583
584 (** [struct_element_types sty] returns the constituent types of the struct type
585     [sty]. See the method [llvm::StructType::getElementType]. *)
586 val struct_element_types : lltype -> lltype array
587
588 (** [is_packed sty] returns [true] if the structure type [sty] is packed,
589     [false] otherwise. See the method [llvm::StructType::isPacked]. *)
590 val is_packed : lltype -> bool
591
592 (** [is_opaque sty] returns [true] if the structure type [sty] is opaque.
593     [false] otherwise. See the method [llvm::StructType::isOpaque]. *)
594 val is_opaque : lltype -> bool
595
596
597 (** {7 Operations on pointer, vector, and array types} *)
598
599 (** [array_type ty n] returns the array type containing [n] elements of type
600     [ty]. See the method [llvm::ArrayType::get]. *)
601 val array_type : lltype -> int -> lltype
602
603 (** [pointer_type ty] returns the pointer type referencing objects of type
604     [ty] in the default address space (0).
605     See the method [llvm::PointerType::getUnqual]. *)
606 val pointer_type : lltype -> lltype
607
608 (** [qualified_pointer_type ty as] returns the pointer type referencing objects
609     of type [ty] in address space [as].
610     See the method [llvm::PointerType::get]. *)
611 val qualified_pointer_type : lltype -> int -> lltype
612
613 (** [vector_type ty n] returns the array type containing [n] elements of the
614     primitive type [ty]. See the method [llvm::ArrayType::get]. *)
615 val vector_type : lltype -> int -> lltype
616
617 (** [element_type ty] returns the element type of the pointer, vector, or array
618     type [ty]. See the method [llvm::SequentialType::get]. *)
619 val element_type : lltype -> lltype
620
621 (** [element_type aty] returns the element count of the array type [aty].
622     See the method [llvm::ArrayType::getNumElements]. *)
623 val array_length : lltype -> int
624
625 (** [address_space pty] returns the address space qualifier of the pointer type
626     [pty]. See the method [llvm::PointerType::getAddressSpace]. *)
627 val address_space : lltype -> int
628
629 (** [element_type ty] returns the element count of the vector type [ty].
630     See the method [llvm::VectorType::getNumElements]. *)
631 val vector_size : lltype -> int
632
633
634 (** {7 Operations on other types} *)
635
636 (** [void_type c] creates a type of a function which does not return any
637     value in the context [c]. See [llvm::Type::VoidTy]. *)
638 val void_type : llcontext -> lltype
639
640 (** [label_type c] creates a type of a basic block in the context [c]. See
641     [llvm::Type::LabelTy]. *)
642 val label_type : llcontext -> lltype
643
644 (** [x86_mmx_type c] returns the x86 64-bit MMX register type in the
645     context [c]. See [llvm::Type::X86_MMXTy]. *)
646 val x86_mmx_type : llcontext -> lltype
647
648 (** [type_by_name m name] returns the specified type from the current module
649     if it exists.
650     See the method [llvm::Module::getTypeByName] *)
651 val type_by_name : llmodule -> string -> lltype option
652
653
654 (* {6 Values} *)
655
656 (** [type_of v] returns the type of the value [v].
657     See the method [llvm::Value::getType]. *)
658 val type_of : llvalue -> lltype
659
660 (** [classify_value v] returns the kind of the value [v]. *)
661 val classify_value : llvalue -> ValueKind.t
662
663 (** [value_name v] returns the name of the value [v]. For global values, this is
664     the symbol name. For instructions and basic blocks, it is the SSA register
665     name. It is meaningless for constants.
666     See the method [llvm::Value::getName]. *)
667 val value_name : llvalue -> string
668
669 (** [set_value_name n v] sets the name of the value [v] to [n]. See the method
670     [llvm::Value::setName]. *)
671 val set_value_name : string -> llvalue -> unit
672
673 (** [dump_value v] prints the .ll representation of the value [v] to standard
674     error. See the method [llvm::Value::dump]. *)
675 val dump_value : llvalue -> unit
676
677 (** [string_of_llvalue v] returns a string describing the value [v]. *)
678 val string_of_llvalue : llvalue -> string
679
680 (** [replace_all_uses_with old new] replaces all uses of the value [old]
681     with the value [new]. See the method [llvm::Value::replaceAllUsesWith]. *)
682 val replace_all_uses_with : llvalue -> llvalue -> unit
683
684
685 (* {6 Uses} *)
686
687 (** [use_begin v] returns the first position in the use list for the value [v].
688     [use_begin] and [use_succ] can e used to iterate over the use list in order.
689     See the method [llvm::Value::use_begin]. *)
690 val use_begin : llvalue -> lluse option
691
692 (** [use_succ u] returns the use list position succeeding [u].
693     See the method [llvm::use_value_iterator::operator++]. *)
694 val use_succ : lluse -> lluse option
695
696 (** [user u] returns the user of the use [u].
697     See the method [llvm::Use::getUser]. *)
698 val user : lluse -> llvalue
699
700 (** [used_value u] returns the usee of the use [u].
701     See the method [llvm::Use::getUsedValue]. *)
702 val used_value : lluse -> llvalue
703
704 (** [iter_uses f v] applies function [f] to each of the users of the value [v]
705     in order. Tail recursive. *)
706 val iter_uses : (lluse -> unit) -> llvalue -> unit
707
708 (** [fold_left_uses f init v] is [f (... (f init u1) ...) uN] where
709     [u1,...,uN] are the users of the value [v]. Tail recursive. *)
710 val fold_left_uses : ('a -> lluse -> 'a) -> 'a -> llvalue -> 'a
711
712 (** [fold_right_uses f v init] is [f u1 (... (f uN init) ...)] where
713     [u1,...,uN] are the users of the value [v]. Not tail recursive. *)
714 val fold_right_uses : (lluse -> 'a -> 'a) -> llvalue -> 'a -> 'a
715
716
717 (* {6 Users} *)
718
719 (** [operand v i] returns the operand at index [i] for the value [v]. See the
720     method [llvm::User::getOperand]. *)
721 val operand : llvalue -> int -> llvalue
722
723 (** [operand_use v i] returns the use of the operand at index [i] for the value [v]. See the
724     method [llvm::User::getOperandUse]. *)
725 val operand_use : llvalue -> int -> lluse
726
727
728 (** [set_operand v i o] sets the operand of the value [v] at the index [i] to
729     the value [o].
730     See the method [llvm::User::setOperand]. *)
731 val set_operand : llvalue -> int -> llvalue -> unit
732
733 (** [num_operands v] returns the number of operands for the value [v].
734     See the method [llvm::User::getNumOperands]. *)
735 val num_operands : llvalue -> int
736
737
738 (** {7 Operations on constants of (mostly) any type} *)
739
740 (** [is_constant v] returns [true] if the value [v] is a constant, [false]
741     otherwise. Similar to [llvm::isa<Constant>]. *)
742 val is_constant : llvalue -> bool
743
744 (** [const_null ty] returns the constant null (zero) of the type [ty].
745     See the method [llvm::Constant::getNullValue]. *)
746 val const_null : lltype -> llvalue
747
748 (** [const_all_ones ty] returns the constant '-1' of the integer or vector type
749     [ty]. See the method [llvm::Constant::getAllOnesValue]. *)
750 val const_all_ones : (*int|vec*)lltype -> llvalue
751
752 (** [const_pointer_null ty] returns the constant null (zero) pointer of the type
753     [ty]. See the method [llvm::ConstantPointerNull::get]. *)
754 val const_pointer_null : lltype -> llvalue
755
756 (** [undef ty] returns the undefined value of the type [ty].
757     See the method [llvm::UndefValue::get]. *)
758 val undef : lltype -> llvalue
759
760 (** [is_null v] returns [true] if the value [v] is the null (zero) value.
761     See the method [llvm::Constant::isNullValue]. *)
762 val is_null : llvalue -> bool
763
764 (** [is_undef v] returns [true] if the value [v] is an undefined value, [false]
765     otherwise. Similar to [llvm::isa<UndefValue>]. *)
766 val is_undef : llvalue -> bool
767
768 (** [constexpr_opcode v] returns an [Opcode.t] corresponding to constexpr
769     value [v], or [Opcode.Invalid] if [v] is not a constexpr. *)
770 val constexpr_opcode : llvalue -> Opcode.t
771
772
773 (** {7 Operations on instructions} *)
774
775 (** [has_metadata i] returns whether or not the instruction [i] has any
776     metadata attached to it. See the function
777     [llvm::Instruction::hasMetadata]. *)
778 val has_metadata : llvalue -> bool
779
780 (** [metadata i kind] optionally returns the metadata associated with the
781     kind [kind] in the instruction [i] See the function
782     [llvm::Instruction::getMetadata]. *)
783 val metadata : llvalue -> llmdkind -> llvalue option
784
785 (** [set_metadata i kind md] sets the metadata [md] of kind [kind] in the
786     instruction [i]. See the function [llvm::Instruction::setMetadata]. *)
787 val set_metadata : llvalue -> llmdkind -> llvalue -> unit
788
789 (** [clear_metadata i kind] clears the metadata of kind [kind] in the
790     instruction [i]. See the function [llvm::Instruction::setMetadata]. *)
791 val clear_metadata : llvalue -> llmdkind -> unit
792
793
794 (** {7 Operations on metadata} *)
795
796 (** [mdstring c s] returns the MDString of the string [s] in the context [c].
797     See the method [llvm::MDNode::get]. *)
798 val mdstring : llcontext -> string -> llvalue
799
800 (** [mdnode c elts] returns the MDNode containing the values [elts] in the
801     context [c].
802     See the method [llvm::MDNode::get]. *)
803 val mdnode : llcontext -> llvalue array -> llvalue
804
805 (** [get_mdstring v] returns the MDString.
806     See the method [llvm::MDString::getString] *)
807 val get_mdstring : llvalue -> string option
808
809 (** [get_named_metadata m name] returns all the MDNodes belonging to the named
810     metadata (if any).
811     See the method [llvm::NamedMDNode::getOperand]. *)
812 val get_named_metadata : llmodule -> string -> llvalue array
813
814 (** [add_named_metadata_operand m name v] adds [v] as the last operand of
815     metadata named [name] in module [m]. If the metadata does not exist,
816     it is created.
817     See the methods [llvm::Module::getNamedMetadata()] and
818     [llvm::MDNode::addOperand()]. *)
819 val add_named_metadata_operand : llmodule -> string -> llvalue -> unit
820
821
822 (** {7 Operations on scalar constants} *)
823
824 (** [const_int ty i] returns the integer constant of type [ty] and value [i].
825     See the method [llvm::ConstantInt::get]. *)
826 val const_int : lltype -> int -> llvalue
827
828 (** [const_of_int64 ty i] returns the integer constant of type [ty] and value
829     [i]. See the method [llvm::ConstantInt::get]. *)
830 val const_of_int64 : lltype -> Int64.t -> bool -> llvalue
831
832 (** [int64_of_const c] returns the int64 value of the [c] constant integer.
833     None is returned if this is not an integer constant, or bitwidth exceeds 64.
834     See the method [llvm::ConstantInt::getSExtValue].*)
835 val int64_of_const : llvalue -> Int64.t option
836
837 (** [const_int_of_string ty s r] returns the integer constant of type [ty] and
838     value [s], with the radix [r]. See the method [llvm::ConstantInt::get]. *)
839 val const_int_of_string : lltype -> string -> int -> llvalue
840
841 (** [const_float ty n] returns the floating point constant of type [ty] and
842     value [n]. See the method [llvm::ConstantFP::get]. *)
843 val const_float : lltype -> float -> llvalue
844
845 (** [const_float_of_string ty s] returns the floating point constant of type
846     [ty] and value [n]. See the method [llvm::ConstantFP::get]. *)
847 val const_float_of_string : lltype -> string -> llvalue
848
849 (** {7 Operations on composite constants} *)
850
851 (** [const_string c s] returns the constant [i8] array with the values of the
852     characters in the string [s] in the context [c]. The array is not 
853     null-terminated (but see {!const_stringz}). This value can in turn be used
854     as the initializer for a global variable. See the method
855     [llvm::ConstantArray::get]. *)
856 val const_string : llcontext -> string -> llvalue
857
858 (** [const_stringz c s] returns the constant [i8] array with the values of the
859     characters in the string [s] and a null terminator in the context [c]. This
860     value can in turn be used as the initializer for a global variable.
861     See the method [llvm::ConstantArray::get]. *)
862 val const_stringz : llcontext -> string -> llvalue
863
864 (** [const_array ty elts] returns the constant array of type
865     [array_type ty (Array.length elts)] and containing the values [elts].
866     This value can in turn be used as the initializer for a global variable.
867     See the method [llvm::ConstantArray::get]. *)
868 val const_array : lltype -> llvalue array -> llvalue
869
870 (** [const_struct context elts] returns the structured constant of type
871     [struct_type (Array.map type_of elts)] and containing the values [elts]
872     in the context [context]. This value can in turn be used as the initializer
873     for a global variable. See the method [llvm::ConstantStruct::getAnon]. *)
874 val const_struct : llcontext -> llvalue array -> llvalue
875
876 (** [const_named_struct namedty elts] returns the structured constant of type
877     [namedty] (which must be a named structure type) and containing the values [elts].
878     This value can in turn be used as the initializer
879     for a global variable. See the method [llvm::ConstantStruct::get]. *)
880 val const_named_struct : lltype -> llvalue array -> llvalue
881
882 (** [const_packed_struct context elts] returns the structured constant of
883     type {!packed_struct_type} [(Array.map type_of elts)] and containing the
884     values [elts] in the context [context]. This value can in turn be used as
885     the initializer for a global variable. See the method
886     [llvm::ConstantStruct::get]. *)
887 val const_packed_struct : llcontext -> llvalue array -> llvalue
888
889 (** [const_vector elts] returns the vector constant of type
890     [vector_type (type_of elts.(0)) (Array.length elts)] and containing the
891     values [elts]. See the method [llvm::ConstantVector::get]. *)
892 val const_vector : llvalue array -> llvalue
893
894 (** [string_of_const c] returns [Some str] if [c] is a string constant,
895     or [None] if this is not a string constant. *)
896 val string_of_const : llvalue -> string option
897
898 (** [const_element c] returns a constant for a specified index's element.
899     See the method ConstantDataSequential::getElementAsConstant. *)
900 val const_element : llvalue -> int -> llvalue
901
902
903 (** {7 Constant expressions} *)
904
905 (** [align_of ty] returns the alignof constant for the type [ty]. This is
906     equivalent to [const_ptrtoint (const_gep (const_null (pointer_type {i8,ty}))
907     (const_int i32_type 0) (const_int i32_type 1)) i32_type], but considerably
908     more readable.  See the method [llvm::ConstantExpr::getAlignOf]. *)
909 val align_of : lltype -> llvalue
910
911 (** [size_of ty] returns the sizeof constant for the type [ty]. This is
912     equivalent to [const_ptrtoint (const_gep (const_null (pointer_type ty))
913     (const_int i32_type 1)) i64_type], but considerably more readable.
914     See the method [llvm::ConstantExpr::getSizeOf]. *)
915 val size_of : lltype -> llvalue
916
917 (** [const_neg c] returns the arithmetic negation of the constant [c].
918     See the method [llvm::ConstantExpr::getNeg]. *)
919 val const_neg : llvalue -> llvalue
920
921 (** [const_nsw_neg c] returns the arithmetic negation of the constant [c] with
922     no signed wrapping. The result is undefined if the negation overflows.
923     See the method [llvm::ConstantExpr::getNSWNeg]. *)
924 val const_nsw_neg : llvalue -> llvalue
925
926 (** [const_nuw_neg c] returns the arithmetic negation of the constant [c] with
927     no unsigned wrapping. The result is undefined if the negation overflows.
928     See the method [llvm::ConstantExpr::getNUWNeg]. *)
929 val const_nuw_neg : llvalue -> llvalue
930
931 (** [const_fneg c] returns the arithmetic negation of the constant float [c].
932     See the method [llvm::ConstantExpr::getFNeg]. *)
933 val const_fneg : llvalue -> llvalue
934
935 (** [const_not c] returns the bitwise inverse of the constant [c].
936     See the method [llvm::ConstantExpr::getNot]. *)
937 val const_not : llvalue -> llvalue
938
939 (** [const_add c1 c2] returns the constant sum of two constants.
940     See the method [llvm::ConstantExpr::getAdd]. *)
941 val const_add : llvalue -> llvalue -> llvalue
942
943 (** [const_nsw_add c1 c2] returns the constant sum of two constants with no
944     signed wrapping. The result is undefined if the sum overflows.
945     See the method [llvm::ConstantExpr::getNSWAdd]. *)
946 val const_nsw_add : llvalue -> llvalue -> llvalue
947
948 (** [const_nuw_add c1 c2] returns the constant sum of two constants with no
949     unsigned wrapping. The result is undefined if the sum overflows.
950     See the method [llvm::ConstantExpr::getNSWAdd]. *)
951 val const_nuw_add : llvalue -> llvalue -> llvalue
952
953 (** [const_fadd c1 c2] returns the constant sum of two constant floats.
954     See the method [llvm::ConstantExpr::getFAdd]. *)
955 val const_fadd : llvalue -> llvalue -> llvalue
956
957 (** [const_sub c1 c2] returns the constant difference, [c1 - c2], of two
958     constants. See the method [llvm::ConstantExpr::getSub]. *)
959 val const_sub : llvalue -> llvalue -> llvalue
960
961 (** [const_nsw_sub c1 c2] returns the constant difference of two constants with
962     no signed wrapping. The result is undefined if the sum overflows.
963     See the method [llvm::ConstantExpr::getNSWSub]. *)
964 val const_nsw_sub : llvalue -> llvalue -> llvalue
965
966 (** [const_nuw_sub c1 c2] returns the constant difference of two constants with
967     no unsigned wrapping. The result is undefined if the sum overflows.
968     See the method [llvm::ConstantExpr::getNSWSub]. *)
969 val const_nuw_sub : llvalue -> llvalue -> llvalue
970
971 (** [const_fsub c1 c2] returns the constant difference, [c1 - c2], of two
972     constant floats. See the method [llvm::ConstantExpr::getFSub]. *)
973 val const_fsub : llvalue -> llvalue -> llvalue
974
975 (** [const_mul c1 c2] returns the constant product of two constants.
976     See the method [llvm::ConstantExpr::getMul]. *)
977 val const_mul : llvalue -> llvalue -> llvalue
978
979 (** [const_nsw_mul c1 c2] returns the constant product of two constants with
980     no signed wrapping. The result is undefined if the sum overflows.
981     See the method [llvm::ConstantExpr::getNSWMul]. *)
982 val const_nsw_mul : llvalue -> llvalue -> llvalue
983
984 (** [const_nuw_mul c1 c2] returns the constant product of two constants with
985     no unsigned wrapping. The result is undefined if the sum overflows.
986     See the method [llvm::ConstantExpr::getNSWMul]. *)
987 val const_nuw_mul : llvalue -> llvalue -> llvalue
988
989 (** [const_fmul c1 c2] returns the constant product of two constants floats.
990     See the method [llvm::ConstantExpr::getFMul]. *)
991 val const_fmul : llvalue -> llvalue -> llvalue
992
993 (** [const_udiv c1 c2] returns the constant quotient [c1 / c2] of two unsigned
994     integer constants.
995     See the method [llvm::ConstantExpr::getUDiv]. *)
996 val const_udiv : llvalue -> llvalue -> llvalue
997
998 (** [const_sdiv c1 c2] returns the constant quotient [c1 / c2] of two signed
999     integer constants.
1000     See the method [llvm::ConstantExpr::getSDiv]. *)
1001 val const_sdiv : llvalue -> llvalue -> llvalue
1002
1003 (** [const_exact_sdiv c1 c2] returns the constant quotient [c1 / c2] of two
1004     signed integer constants. The result is undefined if the result is rounded
1005     or overflows. See the method [llvm::ConstantExpr::getExactSDiv]. *)
1006 val const_exact_sdiv : llvalue -> llvalue -> llvalue
1007
1008 (** [const_fdiv c1 c2] returns the constant quotient [c1 / c2] of two floating
1009     point constants.
1010     See the method [llvm::ConstantExpr::getFDiv]. *)
1011 val const_fdiv : llvalue -> llvalue -> llvalue
1012
1013 (** [const_urem c1 c2] returns the constant remainder [c1 MOD c2] of two
1014     unsigned integer constants.
1015     See the method [llvm::ConstantExpr::getURem]. *)
1016 val const_urem : llvalue -> llvalue -> llvalue
1017
1018 (** [const_srem c1 c2] returns the constant remainder [c1 MOD c2] of two
1019     signed integer constants.
1020     See the method [llvm::ConstantExpr::getSRem]. *)
1021 val const_srem : llvalue -> llvalue -> llvalue
1022
1023 (** [const_frem c1 c2] returns the constant remainder [c1 MOD c2] of two
1024     signed floating point constants.
1025     See the method [llvm::ConstantExpr::getFRem]. *)
1026 val const_frem : llvalue -> llvalue -> llvalue
1027
1028 (** [const_and c1 c2] returns the constant bitwise [AND] of two integer
1029     constants.
1030     See the method [llvm::ConstantExpr::getAnd]. *)
1031 val const_and : llvalue -> llvalue -> llvalue
1032
1033 (** [const_or c1 c2] returns the constant bitwise [OR] of two integer
1034     constants.
1035     See the method [llvm::ConstantExpr::getOr]. *)
1036 val const_or : llvalue -> llvalue -> llvalue
1037
1038 (** [const_xor c1 c2] returns the constant bitwise [XOR] of two integer
1039     constants.
1040     See the method [llvm::ConstantExpr::getXor]. *)
1041 val const_xor : llvalue -> llvalue -> llvalue
1042
1043 (** [const_icmp pred c1 c2] returns the constant comparison of two integer
1044     constants, [c1 pred c2].
1045     See the method [llvm::ConstantExpr::getICmp]. *)
1046 val const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
1047
1048 (** [const_fcmp pred c1 c2] returns the constant comparison of two floating
1049     point constants, [c1 pred c2].
1050     See the method [llvm::ConstantExpr::getFCmp]. *)
1051 val const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
1052
1053 (** [const_shl c1 c2] returns the constant integer [c1] left-shifted by the
1054     constant integer [c2].
1055     See the method [llvm::ConstantExpr::getShl]. *)
1056 val const_shl : llvalue -> llvalue -> llvalue
1057
1058 (** [const_lshr c1 c2] returns the constant integer [c1] right-shifted by the
1059     constant integer [c2] with zero extension.
1060     See the method [llvm::ConstantExpr::getLShr]. *)
1061 val const_lshr : llvalue -> llvalue -> llvalue
1062
1063 (** [const_ashr c1 c2] returns the constant integer [c1] right-shifted by the
1064     constant integer [c2] with sign extension.
1065     See the method [llvm::ConstantExpr::getAShr]. *)
1066 val const_ashr : llvalue -> llvalue -> llvalue
1067
1068 (** [const_gep pc indices] returns the constant [getElementPtr] of [pc] with the
1069     constant integers indices from the array [indices].
1070     See the method [llvm::ConstantExpr::getGetElementPtr]. *)
1071 val const_gep : llvalue -> llvalue array -> llvalue
1072
1073 (** [const_in_bounds_gep pc indices] returns the constant [getElementPtr] of [pc]
1074     with the constant integers indices from the array [indices].
1075     See the method [llvm::ConstantExpr::getInBoundsGetElementPtr]. *)
1076 val const_in_bounds_gep : llvalue -> llvalue array -> llvalue
1077
1078 (** [const_trunc c ty] returns the constant truncation of integer constant [c]
1079     to the smaller integer type [ty].
1080     See the method [llvm::ConstantExpr::getTrunc]. *)
1081 val const_trunc : llvalue -> lltype -> llvalue
1082
1083 (** [const_sext c ty] returns the constant sign extension of integer constant
1084     [c] to the larger integer type [ty].
1085     See the method [llvm::ConstantExpr::getSExt]. *)
1086 val const_sext : llvalue -> lltype -> llvalue
1087
1088 (** [const_zext c ty] returns the constant zero extension of integer constant
1089     [c] to the larger integer type [ty].
1090     See the method [llvm::ConstantExpr::getZExt]. *)
1091 val const_zext : llvalue -> lltype -> llvalue
1092
1093 (** [const_fptrunc c ty] returns the constant truncation of floating point
1094     constant [c] to the smaller floating point type [ty].
1095     See the method [llvm::ConstantExpr::getFPTrunc]. *)
1096 val const_fptrunc : llvalue -> lltype -> llvalue
1097
1098 (** [const_fpext c ty] returns the constant extension of floating point constant
1099     [c] to the larger floating point type [ty].
1100     See the method [llvm::ConstantExpr::getFPExt]. *)
1101 val const_fpext : llvalue -> lltype -> llvalue
1102
1103 (** [const_uitofp c ty] returns the constant floating point conversion of
1104     unsigned integer constant [c] to the floating point type [ty].
1105     See the method [llvm::ConstantExpr::getUIToFP]. *)
1106 val const_uitofp : llvalue -> lltype -> llvalue
1107
1108 (** [const_sitofp c ty] returns the constant floating point conversion of
1109     signed integer constant [c] to the floating point type [ty].
1110     See the method [llvm::ConstantExpr::getSIToFP]. *)
1111 val const_sitofp : llvalue -> lltype -> llvalue
1112
1113 (** [const_fptoui c ty] returns the constant unsigned integer conversion of
1114     floating point constant [c] to integer type [ty].
1115     See the method [llvm::ConstantExpr::getFPToUI]. *)
1116 val const_fptoui : llvalue -> lltype -> llvalue
1117
1118 (** [const_fptoui c ty] returns the constant unsigned integer conversion of
1119     floating point constant [c] to integer type [ty].
1120     See the method [llvm::ConstantExpr::getFPToSI]. *)
1121 val const_fptosi : llvalue -> lltype -> llvalue
1122
1123 (** [const_ptrtoint c ty] returns the constant integer conversion of
1124     pointer constant [c] to integer type [ty].
1125     See the method [llvm::ConstantExpr::getPtrToInt]. *)
1126 val const_ptrtoint : llvalue -> lltype -> llvalue
1127
1128 (** [const_inttoptr c ty] returns the constant pointer conversion of
1129     integer constant [c] to pointer type [ty].
1130     See the method [llvm::ConstantExpr::getIntToPtr]. *)
1131 val const_inttoptr : llvalue -> lltype -> llvalue
1132
1133 (** [const_bitcast c ty] returns the constant bitwise conversion of constant [c]
1134     to type [ty] of equal size.
1135     See the method [llvm::ConstantExpr::getBitCast]. *)
1136 val const_bitcast : llvalue -> lltype -> llvalue
1137
1138 (** [const_zext_or_bitcast c ty] returns a constant zext or bitwise cast
1139     conversion of constant [c] to type [ty].
1140     See the method [llvm::ConstantExpr::getZExtOrBitCast]. *)
1141 val const_zext_or_bitcast : llvalue -> lltype -> llvalue
1142
1143 (** [const_sext_or_bitcast c ty] returns a constant sext or bitwise cast
1144     conversion of constant [c] to type [ty].
1145     See the method [llvm::ConstantExpr::getSExtOrBitCast]. *)
1146 val const_sext_or_bitcast : llvalue -> lltype -> llvalue
1147
1148 (** [const_trunc_or_bitcast c ty] returns a constant trunc or bitwise cast
1149     conversion of constant [c] to type [ty].
1150     See the method [llvm::ConstantExpr::getTruncOrBitCast]. *)
1151 val const_trunc_or_bitcast : llvalue -> lltype -> llvalue
1152
1153 (** [const_pointercast c ty] returns a constant bitcast or a pointer-to-int
1154     cast conversion of constant [c] to type [ty] of equal size.
1155     See the method [llvm::ConstantExpr::getPointerCast]. *)
1156 val const_pointercast : llvalue -> lltype -> llvalue
1157
1158 (** [const_intcast c ty ~is_signed] returns a constant sext/zext, bitcast,
1159     or trunc for integer -> integer casts of constant [c] to type [ty].
1160     When converting a narrower value to a wider one, whether sext or zext
1161     will be used is controlled by [is_signed].
1162     See the method [llvm::ConstantExpr::getIntegerCast]. *)
1163 val const_intcast : llvalue -> lltype -> is_signed:bool -> llvalue
1164
1165 (** [const_fpcast c ty] returns a constant fpext, bitcast, or fptrunc for fp ->
1166     fp casts of constant [c] to type [ty].
1167     See the method [llvm::ConstantExpr::getFPCast]. *)
1168 val const_fpcast : llvalue -> lltype -> llvalue
1169
1170 (** [const_select cond t f] returns the constant conditional which returns value
1171     [t] if the boolean constant [cond] is true and the value [f] otherwise.
1172     See the method [llvm::ConstantExpr::getSelect]. *)
1173 val const_select : llvalue -> llvalue -> llvalue -> llvalue
1174
1175 (** [const_extractelement vec i] returns the constant [i]th element of
1176     constant vector [vec]. [i] must be a constant [i32] value unsigned less than
1177     the size of the vector.
1178     See the method [llvm::ConstantExpr::getExtractElement]. *)
1179 val const_extractelement : llvalue -> llvalue -> llvalue
1180
1181 (** [const_insertelement vec v i] returns the constant vector with the same
1182     elements as constant vector [v] but the [i]th element replaced by the
1183     constant [v]. [v] must be a constant value with the type of the vector
1184     elements. [i] must be a constant [i32] value unsigned less than the size
1185     of the vector.
1186     See the method [llvm::ConstantExpr::getInsertElement]. *)
1187 val const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
1188
1189 (** [const_shufflevector a b mask] returns a constant [shufflevector].
1190     See the LLVM Language Reference for details on the [shufflevector]
1191     instruction.
1192     See the method [llvm::ConstantExpr::getShuffleVector]. *)
1193 val const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
1194
1195 (** [const_extractvalue agg idxs] returns the constant [idxs]th value of
1196     constant aggregate [agg]. Each [idxs] must be less than the size of the
1197     aggregate.  See the method [llvm::ConstantExpr::getExtractValue]. *)
1198 val const_extractvalue : llvalue -> int array -> llvalue
1199
1200 (** [const_insertvalue agg val idxs] inserts the value [val] in the specified
1201     indexs [idxs] in the aggegate [agg]. Each [idxs] must be less than the size
1202     of the aggregate. See the method [llvm::ConstantExpr::getInsertValue]. *)
1203 val const_insertvalue : llvalue -> llvalue -> int array -> llvalue
1204
1205 (** [const_inline_asm ty asm con side align] inserts a inline assembly string.
1206     See the method [llvm::InlineAsm::get]. *)
1207 val const_inline_asm : lltype -> string -> string -> bool -> bool -> llvalue
1208
1209 (** [block_address f bb] returns the address of the basic block [bb] in the
1210     function [f]. See the method [llvm::BasicBlock::get]. *)
1211 val block_address : llvalue -> llbasicblock -> llvalue
1212
1213
1214 (** {7 Operations on global variables, functions, and aliases (globals)} *)
1215
1216 (** [global_parent g] is the enclosing module of the global value [g].
1217     See the method [llvm::GlobalValue::getParent]. *)
1218 val global_parent : llvalue -> llmodule
1219
1220 (** [is_declaration g] returns [true] if the global value [g] is a declaration
1221     only. Returns [false] otherwise.
1222     See the method [llvm::GlobalValue::isDeclaration]. *)
1223 val is_declaration : llvalue -> bool
1224
1225 (** [linkage g] returns the linkage of the global value [g].
1226     See the method [llvm::GlobalValue::getLinkage]. *)
1227 val linkage : llvalue -> Linkage.t
1228
1229 (** [set_linkage l g] sets the linkage of the global value [g] to [l].
1230     See the method [llvm::GlobalValue::setLinkage]. *)
1231 val set_linkage : Linkage.t -> llvalue -> unit
1232
1233 (** [section g] returns the linker section of the global value [g].
1234     See the method [llvm::GlobalValue::getSection]. *)
1235 val section : llvalue -> string
1236
1237 (** [set_section s g] sets the linker section of the global value [g] to [s].
1238     See the method [llvm::GlobalValue::setSection]. *)
1239 val set_section : string -> llvalue -> unit
1240
1241 (** [visibility g] returns the linker visibility of the global value [g].
1242     See the method [llvm::GlobalValue::getVisibility]. *)
1243 val visibility : llvalue -> Visibility.t
1244
1245 (** [set_visibility v g] sets the linker visibility of the global value [g] to
1246     [v]. See the method [llvm::GlobalValue::setVisibility]. *)
1247 val set_visibility : Visibility.t -> llvalue -> unit
1248
1249 (** [alignment g] returns the required alignment of the global value [g].
1250     See the method [llvm::GlobalValue::getAlignment]. *)
1251 val alignment : llvalue -> int
1252
1253 (** [set_alignment n g] sets the required alignment of the global value [g] to
1254     [n] bytes. See the method [llvm::GlobalValue::setAlignment]. *)
1255 val set_alignment : int -> llvalue -> unit
1256
1257
1258 (** {7 Operations on global variables} *)
1259
1260 (** [declare_global ty name m] returns a new global variable of type [ty] and
1261     with name [name] in module [m] in the default address space (0). If such a
1262     global variable already exists, it is returned. If the type of the existing
1263     global differs, then a bitcast to [ty] is returned. *)
1264 val declare_global : lltype -> string -> llmodule -> llvalue
1265
1266 (** [declare_qualified_global ty name addrspace m] returns a new global variable
1267     of type [ty] and with name [name] in module [m] in the address space
1268     [addrspace]. If such a global variable already exists, it is returned. If
1269     the type of the existing global differs, then a bitcast to [ty] is
1270     returned. *)
1271 val declare_qualified_global : lltype -> string -> int -> llmodule -> llvalue
1272
1273 (** [define_global name init m] returns a new global with name [name] and
1274     initializer [init] in module [m] in the default address space (0). If the
1275     named global already exists, it is renamed.
1276     See the constructor of [llvm::GlobalVariable]. *)
1277 val define_global : string -> llvalue -> llmodule -> llvalue
1278
1279 (** [define_qualified_global name init addrspace m] returns a new global with
1280     name [name] and initializer [init] in module [m] in the address space
1281     [addrspace]. If the named global already exists, it is renamed.
1282     See the constructor of [llvm::GlobalVariable]. *)
1283 val define_qualified_global : string -> llvalue -> int -> llmodule -> llvalue
1284
1285 (** [lookup_global name m] returns [Some g] if a global variable with name
1286     [name] exists in module [m]. If no such global exists, returns [None].
1287     See the [llvm::GlobalVariable] constructor. *)
1288 val lookup_global : string -> llmodule -> llvalue option
1289
1290 (** [delete_global gv] destroys the global variable [gv].
1291     See the method [llvm::GlobalVariable::eraseFromParent]. *)
1292 val delete_global : llvalue -> unit
1293
1294 (** [global_begin m] returns the first position in the global variable list of
1295     the module [m]. [global_begin] and [global_succ] can be used to iterate
1296     over the global list in order.
1297     See the method [llvm::Module::global_begin]. *)
1298 val global_begin : llmodule -> (llmodule, llvalue) llpos
1299
1300 (** [global_succ gv] returns the global variable list position succeeding
1301     [Before gv].
1302     See the method [llvm::Module::global_iterator::operator++]. *)
1303 val global_succ : llvalue -> (llmodule, llvalue) llpos
1304
1305 (** [iter_globals f m] applies function [f] to each of the global variables of
1306     module [m] in order. Tail recursive. *)
1307 val iter_globals : (llvalue -> unit) -> llmodule -> unit
1308
1309 (** [fold_left_globals f init m] is [f (... (f init g1) ...) gN] where
1310     [g1,...,gN] are the global variables of module [m]. Tail recursive. *)
1311 val fold_left_globals : ('a -> llvalue -> 'a) -> 'a -> llmodule -> 'a
1312
1313 (** [global_end m] returns the last position in the global variable list of the
1314     module [m]. [global_end] and [global_pred] can be used to iterate over the
1315     global list in reverse.
1316     See the method [llvm::Module::global_end]. *)
1317 val global_end : llmodule -> (llmodule, llvalue) llrev_pos
1318
1319 (** [global_pred gv] returns the global variable list position preceding
1320     [After gv].
1321     See the method [llvm::Module::global_iterator::operator--]. *)
1322 val global_pred : llvalue -> (llmodule, llvalue) llrev_pos
1323
1324 (** [rev_iter_globals f m] applies function [f] to each of the global variables
1325     of module [m] in reverse order. Tail recursive. *)
1326 val rev_iter_globals : (llvalue -> unit) -> llmodule -> unit
1327
1328 (** [fold_right_globals f m init] is [f g1 (... (f gN init) ...)] where
1329     [g1,...,gN] are the global variables of module [m]. Tail recursive. *)
1330 val fold_right_globals : (llvalue -> 'a -> 'a) -> llmodule -> 'a -> 'a
1331
1332 (** [is_global_constant gv] returns [true] if the global variabile [gv] is a
1333     constant. Returns [false] otherwise.
1334     See the method [llvm::GlobalVariable::isConstant]. *)
1335 val is_global_constant : llvalue -> bool
1336
1337 (** [set_global_constant c gv] sets the global variable [gv] to be a constant if
1338     [c] is [true] and not if [c] is [false].
1339     See the method [llvm::GlobalVariable::setConstant]. *)
1340 val set_global_constant : bool -> llvalue -> unit
1341
1342 (** [global_initializer gv] returns the initializer for the global variable
1343     [gv]. See the method [llvm::GlobalVariable::getInitializer]. *)
1344 val global_initializer : llvalue -> llvalue
1345
1346 (** [set_initializer c gv] sets the initializer for the global variable
1347     [gv] to the constant [c].
1348     See the method [llvm::GlobalVariable::setInitializer]. *)
1349 val set_initializer : llvalue -> llvalue -> unit
1350
1351 (** [remove_initializer gv] unsets the initializer for the global variable
1352     [gv].
1353     See the method [llvm::GlobalVariable::setInitializer]. *)
1354 val remove_initializer : llvalue -> unit
1355
1356 (** [is_thread_local gv] returns [true] if the global variable [gv] is
1357     thread-local and [false] otherwise.
1358     See the method [llvm::GlobalVariable::isThreadLocal]. *)
1359 val is_thread_local : llvalue -> bool
1360
1361 (** [set_thread_local c gv] sets the global variable [gv] to be thread local if
1362     [c] is [true] and not otherwise.
1363     See the method [llvm::GlobalVariable::setThreadLocal]. *)
1364 val set_thread_local : bool -> llvalue -> unit
1365
1366 (** [is_thread_local gv] returns the thread local mode of the global
1367     variable [gv].
1368     See the method [llvm::GlobalVariable::getThreadLocalMode]. *)
1369 val thread_local_mode : llvalue -> ThreadLocalMode.t
1370
1371 (** [set_thread_local c gv] sets the thread local mode of the global
1372     variable [gv].
1373     See the method [llvm::GlobalVariable::setThreadLocalMode]. *)
1374 val set_thread_local_mode : ThreadLocalMode.t -> llvalue -> unit
1375
1376 (** [is_externally_initialized gv] returns [true] if the global
1377     variable [gv] is externally initialized and [false] otherwise.
1378     See the method [llvm::GlobalVariable::isExternallyInitialized]. *)
1379 val is_externally_initialized : llvalue -> bool
1380
1381 (** [set_externally_initialized c gv] sets the global variable [gv] to be
1382     externally initialized if [c] is [true] and not otherwise.
1383     See the method [llvm::GlobalVariable::setExternallyInitialized]. *)
1384 val set_externally_initialized : bool -> llvalue -> unit
1385
1386
1387 (** {7 Operations on aliases} *)
1388
1389 (** [add_alias m t a n] inserts an alias in the module [m] with the type [t] and
1390     the aliasee [a] with the name [n].
1391     See the constructor for [llvm::GlobalAlias]. *)
1392 val add_alias : llmodule -> lltype -> llvalue -> string -> llvalue
1393
1394
1395 (** {7 Operations on functions} *)
1396
1397 (** [declare_function name ty m] returns a new function of type [ty] and
1398     with name [name] in module [m]. If such a function already exists,
1399     it is returned. If the type of the existing function differs, then a bitcast
1400     to [ty] is returned. *)
1401 val declare_function : string -> lltype -> llmodule -> llvalue
1402
1403 (** [define_function name ty m] creates a new function with name [name] and
1404     type [ty] in module [m]. If the named function already exists, it is
1405     renamed. An entry basic block is created in the function.
1406     See the constructor of [llvm::GlobalVariable]. *)
1407 val define_function : string -> lltype -> llmodule -> llvalue
1408
1409 (** [lookup_function name m] returns [Some f] if a function with name
1410     [name] exists in module [m]. If no such function exists, returns [None].
1411     See the method [llvm::Module] constructor. *)
1412 val lookup_function : string -> llmodule -> llvalue option
1413
1414 (** [delete_function f] destroys the function [f].
1415     See the method [llvm::Function::eraseFromParent]. *)
1416 val delete_function : llvalue -> unit
1417
1418 (** [function_begin m] returns the first position in the function list of the
1419     module [m]. [function_begin] and [function_succ] can be used to iterate over
1420     the function list in order.
1421     See the method [llvm::Module::begin]. *)
1422 val function_begin : llmodule -> (llmodule, llvalue) llpos
1423
1424 (** [function_succ gv] returns the function list position succeeding
1425     [Before gv].
1426     See the method [llvm::Module::iterator::operator++]. *)
1427 val function_succ : llvalue -> (llmodule, llvalue) llpos
1428
1429 (** [iter_functions f m] applies function [f] to each of the functions of module
1430     [m] in order. Tail recursive. *)
1431 val iter_functions : (llvalue -> unit) -> llmodule -> unit
1432
1433 (** [fold_left_function f init m] is [f (... (f init f1) ...) fN] where
1434     [f1,...,fN] are the functions of module [m]. Tail recursive. *)
1435 val fold_left_functions : ('a -> llvalue -> 'a) -> 'a -> llmodule -> 'a
1436
1437 (** [function_end m] returns the last position in the function list of
1438     the module [m]. [function_end] and [function_pred] can be used to iterate
1439     over the function list in reverse.
1440     See the method [llvm::Module::end]. *)
1441 val function_end : llmodule -> (llmodule, llvalue) llrev_pos
1442
1443 (** [function_pred gv] returns the function list position preceding [After gv].
1444     See the method [llvm::Module::iterator::operator--]. *)
1445 val function_pred : llvalue -> (llmodule, llvalue) llrev_pos
1446
1447 (** [rev_iter_functions f fn] applies function [f] to each of the functions of
1448     module [m] in reverse order. Tail recursive. *)
1449 val rev_iter_functions : (llvalue -> unit) -> llmodule -> unit
1450
1451 (** [fold_right_functions f m init] is [f (... (f init fN) ...) f1] where
1452     [f1,...,fN] are the functions of module [m]. Tail recursive. *)
1453 val fold_right_functions : (llvalue -> 'a -> 'a) -> llmodule -> 'a -> 'a
1454
1455 (** [is_intrinsic f] returns true if the function [f] is an intrinsic.
1456     See the method [llvm::Function::isIntrinsic]. *)
1457 val is_intrinsic : llvalue -> bool
1458
1459 (** [function_call_conv f] returns the calling convention of the function [f].
1460     See the method [llvm::Function::getCallingConv]. *)
1461 val function_call_conv : llvalue -> int
1462
1463 (** [set_function_call_conv cc f] sets the calling convention of the function
1464     [f] to the calling convention numbered [cc].
1465     See the method [llvm::Function::setCallingConv]. *)
1466 val set_function_call_conv : int -> llvalue -> unit
1467
1468 (** [gc f] returns [Some name] if the function [f] has a garbage
1469     collection algorithm specified and [None] otherwise.
1470     See the method [llvm::Function::getGC]. *)
1471 val gc : llvalue -> string option
1472
1473 (** [set_gc gc f] sets the collection algorithm for the function [f] to
1474     [gc]. See the method [llvm::Function::setGC]. *)
1475 val set_gc : string option -> llvalue -> unit
1476
1477 (** [add_function_attr f a] adds attribute [a] to the return type of function
1478     [f]. *)
1479 val add_function_attr : llvalue -> Attribute.t -> unit
1480
1481 (** [add_target_dependent_function_attr f a] adds target-dependent attribute
1482     [a] to function [f]. *)
1483 val add_target_dependent_function_attr : llvalue -> string -> string -> unit
1484
1485 (** [function_attr f] returns the function attribute for the function [f].
1486     See the method [llvm::Function::getAttributes] *)
1487 val function_attr : llvalue -> Attribute.t list
1488
1489 (** [remove_function_attr f a] removes attribute [a] from the return type of
1490     function [f]. *)
1491 val remove_function_attr : llvalue -> Attribute.t -> unit
1492
1493
1494 (** {7 Operations on params} *)
1495
1496 (** [params f] returns the parameters of function [f].
1497     See the method [llvm::Function::getArgumentList]. *)
1498 val params : llvalue -> llvalue array
1499
1500 (** [param f n] returns the [n]th parameter of function [f].
1501     See the method [llvm::Function::getArgumentList]. *)
1502 val param : llvalue -> int -> llvalue
1503
1504 (** [param_attr p] returns the attributes of parameter [p].
1505     See the methods [llvm::Function::getAttributes] and
1506     [llvm::Attributes::getParamAttributes] *)
1507 val param_attr : llvalue -> Attribute.t list
1508
1509 (** [param_parent p] returns the parent function that owns the parameter.
1510     See the method [llvm::Argument::getParent]. *)
1511 val param_parent : llvalue -> llvalue
1512
1513 (** [param_begin f] returns the first position in the parameter list of the
1514     function [f]. [param_begin] and [param_succ] can be used to iterate over
1515     the parameter list in order.
1516     See the method [llvm::Function::arg_begin]. *)
1517 val param_begin : llvalue -> (llvalue, llvalue) llpos
1518
1519 (** [param_succ bb] returns the parameter list position succeeding
1520     [Before bb].
1521     See the method [llvm::Function::arg_iterator::operator++]. *)
1522 val param_succ : llvalue -> (llvalue, llvalue) llpos
1523
1524 (** [iter_params f fn] applies function [f] to each of the parameters
1525     of function [fn] in order. Tail recursive. *)
1526 val iter_params : (llvalue -> unit) -> llvalue -> unit
1527
1528 (** [fold_left_params f init fn] is [f (... (f init b1) ...) bN] where
1529     [b1,...,bN] are the parameters of function [fn]. Tail recursive. *)
1530 val fold_left_params : ('a -> llvalue -> 'a) -> 'a -> llvalue -> 'a
1531
1532 (** [param_end f] returns the last position in the parameter list of
1533     the function [f]. [param_end] and [param_pred] can be used to iterate
1534     over the parameter list in reverse.
1535     See the method [llvm::Function::arg_end]. *)
1536 val param_end : llvalue -> (llvalue, llvalue) llrev_pos
1537
1538 (** [param_pred gv] returns the function list position preceding [After gv].
1539     See the method [llvm::Function::arg_iterator::operator--]. *)
1540 val param_pred : llvalue -> (llvalue, llvalue) llrev_pos
1541
1542 (** [rev_iter_params f fn] applies function [f] to each of the parameters
1543     of function [fn] in reverse order. Tail recursive. *)
1544 val rev_iter_params : (llvalue -> unit) -> llvalue -> unit
1545
1546 (** [fold_right_params f fn init] is [f (... (f init bN) ...) b1] where
1547     [b1,...,bN] are the parameters of function [fn]. Tail recursive. *)
1548 val fold_right_params : (llvalue -> 'a -> 'a) -> llvalue -> 'a -> 'a
1549
1550 (** [add_param p a] adds attribute [a] to parameter [p]. *)
1551 val add_param_attr : llvalue -> Attribute.t -> unit
1552
1553 (** [remove_param_attr p a] removes attribute [a] from parameter [p]. *)
1554 val remove_param_attr : llvalue -> Attribute.t -> unit
1555
1556 (** [set_param_alignment p a] set the alignment of parameter [p] to [a]. *)
1557 val set_param_alignment : llvalue -> int -> unit
1558
1559
1560 (** {7 Operations on basic blocks} *)
1561
1562 (** [basic_blocks fn] returns the basic blocks of the function [f].
1563     See the method [llvm::Function::getBasicBlockList]. *)
1564 val basic_blocks : llvalue -> llbasicblock array
1565
1566 (** [entry_block fn] returns the entry basic block of the function [f].
1567     See the method [llvm::Function::getEntryBlock]. *)
1568 val entry_block : llvalue -> llbasicblock
1569
1570 (** [delete_block bb] deletes the basic block [bb].
1571     See the method [llvm::BasicBlock::eraseFromParent]. *)
1572 val delete_block : llbasicblock -> unit
1573
1574 (** [remove_block bb] removes the basic block [bb] from its parent function.
1575     See the method [llvm::BasicBlock::removeFromParent]. *)
1576 val remove_block : llbasicblock -> unit
1577
1578 (** [move_block_before pos bb] moves the basic block [bb] before [pos].
1579     See the method [llvm::BasicBlock::moveBefore]. *)
1580 val move_block_before : llbasicblock -> llbasicblock -> unit
1581
1582 (** [move_block_after pos bb] moves the basic block [bb] after [pos].
1583     See the method [llvm::BasicBlock::moveAfter]. *)
1584 val move_block_after : llbasicblock -> llbasicblock -> unit
1585
1586 (** [append_block c name f] creates a new basic block named [name] at the end of
1587     function [f] in the context [c].
1588     See the constructor of [llvm::BasicBlock]. *)
1589 val append_block : llcontext -> string -> llvalue -> llbasicblock
1590
1591 (** [insert_block c name bb] creates a new basic block named [name] before the
1592     basic block [bb] in the context [c].
1593     See the constructor of [llvm::BasicBlock]. *)
1594 val insert_block : llcontext -> string -> llbasicblock -> llbasicblock
1595
1596 (** [block_parent bb] returns the parent function that owns the basic block.
1597     See the method [llvm::BasicBlock::getParent]. *)
1598 val block_parent : llbasicblock -> llvalue
1599
1600 (** [block_begin f] returns the first position in the basic block list of the
1601     function [f]. [block_begin] and [block_succ] can be used to iterate over
1602     the basic block list in order.
1603     See the method [llvm::Function::begin]. *)
1604 val block_begin : llvalue -> (llvalue, llbasicblock) llpos
1605
1606 (** [block_succ bb] returns the basic block list position succeeding
1607     [Before bb].
1608     See the method [llvm::Function::iterator::operator++]. *)
1609 val block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
1610
1611 (** [iter_blocks f fn] applies function [f] to each of the basic blocks
1612     of function [fn] in order. Tail recursive. *)
1613 val iter_blocks : (llbasicblock -> unit) -> llvalue -> unit
1614
1615 (** [fold_left_blocks f init fn] is [f (... (f init b1) ...) bN] where
1616     [b1,...,bN] are the basic blocks of function [fn]. Tail recursive. *)
1617 val fold_left_blocks : ('a -> llbasicblock -> 'a) -> 'a -> llvalue -> 'a
1618
1619 (** [block_end f] returns the last position in the basic block list of
1620     the function [f]. [block_end] and [block_pred] can be used to iterate
1621     over the basic block list in reverse.
1622     See the method [llvm::Function::end]. *)
1623 val block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
1624
1625 (** [block_pred bb] returns the basic block list position preceding [After bb].
1626     See the method [llvm::Function::iterator::operator--]. *)
1627 val block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
1628
1629 (** [block_terminator bb] returns the terminator of the basic block [bb]. *)
1630 val block_terminator : llbasicblock -> llvalue option
1631
1632 (** [rev_iter_blocks f fn] applies function [f] to each of the basic blocks
1633     of function [fn] in reverse order. Tail recursive. *)
1634 val rev_iter_blocks : (llbasicblock -> unit) -> llvalue -> unit
1635
1636 (** [fold_right_blocks f fn init] is [f (... (f init bN) ...) b1] where
1637     [b1,...,bN] are the basic blocks of function [fn]. Tail recursive. *)
1638 val fold_right_blocks : (llbasicblock -> 'a -> 'a) -> llvalue -> 'a -> 'a
1639
1640 (** [value_of_block bb] losslessly casts [bb] to an [llvalue]. *)
1641 val value_of_block : llbasicblock -> llvalue
1642
1643 (** [value_is_block v] returns [true] if the value [v] is a basic block and
1644     [false] otherwise.
1645     Similar to [llvm::isa<BasicBlock>]. *)
1646 val value_is_block : llvalue -> bool
1647
1648 (** [block_of_value v] losslessly casts [v] to an [llbasicblock]. *)
1649 val block_of_value : llvalue -> llbasicblock
1650
1651
1652 (** {7 Operations on instructions} *)
1653
1654 (** [instr_parent i] is the enclosing basic block of the instruction [i].
1655     See the method [llvm::Instruction::getParent]. *)
1656 val instr_parent : llvalue -> llbasicblock
1657
1658 (** [delete_instruction i] deletes the instruction [i].
1659  * See the method [llvm::Instruction::eraseFromParent]. *)
1660 val delete_instruction : llvalue -> unit
1661
1662 (** [instr_begin bb] returns the first position in the instruction list of the
1663     basic block [bb]. [instr_begin] and [instr_succ] can be used to iterate over
1664     the instruction list in order.
1665     See the method [llvm::BasicBlock::begin]. *)
1666 val instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
1667
1668 (** [instr_succ i] returns the instruction list position succeeding [Before i].
1669     See the method [llvm::BasicBlock::iterator::operator++]. *)
1670 val instr_succ : llvalue -> (llbasicblock, llvalue) llpos
1671
1672 (** [iter_instrs f bb] applies function [f] to each of the instructions of basic
1673     block [bb] in order. Tail recursive. *)
1674 val iter_instrs: (llvalue -> unit) -> llbasicblock -> unit
1675
1676 (** [fold_left_instrs f init bb] is [f (... (f init g1) ...) gN] where
1677     [g1,...,gN] are the instructions of basic block [bb]. Tail recursive. *)
1678 val fold_left_instrs: ('a -> llvalue -> 'a) -> 'a -> llbasicblock -> 'a
1679
1680 (** [instr_end bb] returns the last position in the instruction list of the
1681     basic block [bb]. [instr_end] and [instr_pred] can be used to iterate over
1682     the instruction list in reverse.
1683     See the method [llvm::BasicBlock::end]. *)
1684 val instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
1685
1686 (** [instr_pred i] returns the instruction list position preceding [After i].
1687     See the method [llvm::BasicBlock::iterator::operator--]. *)
1688 val instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
1689
1690 (** [fold_right_instrs f bb init] is [f (... (f init fN) ...) f1] where
1691     [f1,...,fN] are the instructions of basic block [bb]. Tail recursive. *)
1692 val fold_right_instrs: (llvalue -> 'a -> 'a) -> llbasicblock -> 'a -> 'a
1693
1694 (** [inst_opcode i] returns the [Opcode.t] corresponding to instruction [i],
1695     or [Opcode.Invalid] if [i] is not an instruction. *)
1696 val instr_opcode : llvalue -> Opcode.t
1697
1698 (** [icmp_predicate i] returns the [Icmp.t] corresponding to an [icmp]
1699     instruction [i]. *)
1700 val icmp_predicate : llvalue -> Icmp.t option
1701
1702 (** [inst_clone i] returns a copy of instruction [i],
1703     The instruction has no parent, and no name.
1704     See the method [llvm::Instruction::clone]. *)
1705 val instr_clone : llvalue -> llvalue
1706
1707
1708 (** {7 Operations on call sites} *)
1709
1710 (** [instruction_call_conv ci] is the calling convention for the call or invoke
1711     instruction [ci], which may be one of the values from the module
1712     {!CallConv}. See the method [llvm::CallInst::getCallingConv] and
1713     [llvm::InvokeInst::getCallingConv]. *)
1714 val instruction_call_conv: llvalue -> int
1715
1716 (** [set_instruction_call_conv cc ci] sets the calling convention for the call
1717     or invoke instruction [ci] to the integer [cc], which can be one of the
1718     values from the module {!CallConv}.
1719     See the method [llvm::CallInst::setCallingConv]
1720     and [llvm::InvokeInst::setCallingConv]. *)
1721 val set_instruction_call_conv: int -> llvalue -> unit
1722
1723 (** [add_instruction_param_attr ci i a] adds attribute [a] to the [i]th
1724     parameter of the call or invoke instruction [ci]. [i]=0 denotes the return
1725     value. *)
1726 val add_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
1727
1728 (** [remove_instruction_param_attr ci i a] removes attribute [a] from the
1729     [i]th parameter of the call or invoke instruction [ci]. [i]=0 denotes the
1730     return value. *)
1731 val remove_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
1732
1733
1734 (** {7 Operations on call instructions (only)} *)
1735
1736 (** [is_tail_call ci] is [true] if the call instruction [ci] is flagged as
1737     eligible for tail call optimization, [false] otherwise.
1738     See the method [llvm::CallInst::isTailCall]. *)
1739 val is_tail_call : llvalue -> bool
1740
1741 (** [set_tail_call tc ci] flags the call instruction [ci] as eligible for tail
1742     call optimization if [tc] is [true], clears otherwise.
1743     See the method [llvm::CallInst::setTailCall]. *)
1744 val set_tail_call : bool -> llvalue -> unit
1745
1746
1747 (** {7 Operations on load/store instructions (only)} *)
1748
1749 (** [is_volatile i] is [true] if the load or store instruction [i] is marked
1750     as volatile.
1751     See the methods [llvm::LoadInst::isVolatile] and
1752     [llvm::StoreInst::isVolatile]. *)
1753 val is_volatile : llvalue -> bool
1754
1755 (** [set_volatile v i] marks the load or store instruction [i] as volatile
1756     if [v] is [true], unmarks otherwise.
1757     See the methods [llvm::LoadInst::setVolatile] and
1758     [llvm::StoreInst::setVolatile]. *)
1759 val set_volatile : bool -> llvalue -> unit
1760
1761
1762 (** {7 Operations on phi nodes} *)
1763
1764 (** [add_incoming (v, bb) pn] adds the value [v] to the phi node [pn] for use
1765     with branches from [bb]. See the method [llvm::PHINode::addIncoming]. *)
1766 val add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
1767
1768 (** [incoming pn] returns the list of value-block pairs for phi node [pn].
1769     See the method [llvm::PHINode::getIncomingValue]. *)
1770 val incoming : llvalue -> (llvalue * llbasicblock) list
1771
1772
1773
1774 (** {6 Instruction builders} *)
1775
1776 (** [builder context] creates an instruction builder with no position in
1777     the context [context]. It is invalid to use this builder until its position
1778     is set with {!position_before} or {!position_at_end}. See the constructor
1779     for [llvm::LLVMBuilder]. *)
1780 val builder : llcontext -> llbuilder
1781
1782 (** [builder_at ip] creates an instruction builder positioned at [ip].
1783     See the constructor for [llvm::LLVMBuilder]. *)
1784 val builder_at : llcontext -> (llbasicblock, llvalue) llpos -> llbuilder
1785
1786 (** [builder_before ins] creates an instruction builder positioned before the
1787     instruction [isn]. See the constructor for [llvm::LLVMBuilder]. *)
1788 val builder_before : llcontext -> llvalue -> llbuilder
1789
1790 (** [builder_at_end bb] creates an instruction builder positioned at the end of
1791     the basic block [bb]. See the constructor for [llvm::LLVMBuilder]. *)
1792 val builder_at_end : llcontext -> llbasicblock -> llbuilder
1793
1794 (** [position_builder ip bb] moves the instruction builder [bb] to the position
1795     [ip].
1796     See the constructor for [llvm::LLVMBuilder]. *)
1797 val position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
1798
1799 (** [position_before ins b] moves the instruction builder [b] to before the
1800     instruction [isn]. See the method [llvm::LLVMBuilder::SetInsertPoint]. *)
1801 val position_before : llvalue -> llbuilder -> unit
1802
1803 (** [position_at_end bb b] moves the instruction builder [b] to the end of the
1804     basic block [bb]. See the method [llvm::LLVMBuilder::SetInsertPoint]. *)
1805 val position_at_end : llbasicblock -> llbuilder -> unit
1806
1807 (** [insertion_block b] returns the basic block that the builder [b] is
1808     positioned to insert into. Raises [Not_Found] if the instruction builder is
1809     uninitialized.
1810     See the method [llvm::LLVMBuilder::GetInsertBlock]. *)
1811 val insertion_block : llbuilder -> llbasicblock
1812
1813 (** [insert_into_builder i name b] inserts the specified instruction [i] at the
1814     position specified by the instruction builder [b].
1815     See the method [llvm::LLVMBuilder::Insert]. *)
1816 val insert_into_builder : llvalue -> string -> llbuilder -> unit
1817
1818
1819 (** {7 Metadata} *)
1820
1821 (** [set_current_debug_location b md] sets the current debug location [md] in
1822     the builder [b].
1823     See the method [llvm::IRBuilder::SetDebugLocation]. *)
1824 val set_current_debug_location : llbuilder -> llvalue -> unit
1825
1826 (** [clear_current_debug_location b] clears the current debug location in the
1827     builder [b]. *)
1828 val clear_current_debug_location : llbuilder -> unit
1829
1830 (** [current_debug_location b] returns the current debug location, or None
1831     if none is currently set.
1832     See the method [llvm::IRBuilder::GetDebugLocation]. *)
1833 val current_debug_location : llbuilder -> llvalue option
1834
1835 (** [set_inst_debug_location b i] sets the current debug location of the builder
1836     [b] to the instruction [i].
1837     See the method [llvm::IRBuilder::SetInstDebugLocation]. *)
1838 val set_inst_debug_location : llbuilder -> llvalue -> unit
1839
1840
1841 (** {7 Terminators} *)
1842
1843 (** [build_ret_void b] creates a
1844     [ret void]
1845     instruction at the position specified by the instruction builder [b].
1846     See the method [llvm::LLVMBuilder::CreateRetVoid]. *)
1847 val build_ret_void : llbuilder -> llvalue
1848
1849 (** [build_ret v b] creates a
1850     [ret %v]
1851     instruction at the position specified by the instruction builder [b].
1852     See the method [llvm::LLVMBuilder::CreateRet]. *)
1853 val build_ret : llvalue -> llbuilder -> llvalue
1854
1855 (** [build_aggregate_ret vs b] creates a
1856     [ret {...} { %v1, %v2, ... } ]
1857     instruction at the position specified by the instruction builder [b].
1858     See the method [llvm::LLVMBuilder::CreateAggregateRet]. *)
1859 val build_aggregate_ret : llvalue array -> llbuilder -> llvalue
1860
1861 (** [build_br bb b] creates a
1862     [br %bb]
1863     instruction at the position specified by the instruction builder [b].
1864     See the method [llvm::LLVMBuilder::CreateBr]. *)
1865 val build_br : llbasicblock -> llbuilder -> llvalue
1866
1867 (** [build_cond_br cond tbb fbb b] creates a
1868     [br %cond, %tbb, %fbb]
1869     instruction at the position specified by the instruction builder [b].
1870     See the method [llvm::LLVMBuilder::CreateCondBr]. *)
1871 val build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
1872                          llvalue
1873
1874 (** [build_switch case elsebb count b] creates an empty
1875     [switch %case, %elsebb]
1876     instruction at the position specified by the instruction builder [b] with
1877     space reserved for [count] cases.
1878     See the method [llvm::LLVMBuilder::CreateSwitch]. *)
1879 val build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
1880
1881 (** [build_malloc ty name b] creates an [malloc]
1882     instruction at the position specified by the instruction builder [b].
1883     See the method [llvm::CallInst::CreateMalloc]. *)
1884 val build_malloc : lltype -> string -> llbuilder -> llvalue
1885
1886 (** [build_array_malloc ty val name b] creates an [array malloc]
1887     instruction at the position specified by the instruction builder [b].
1888     See the method [llvm::CallInst::CreateArrayMalloc]. *)
1889 val build_array_malloc : lltype -> llvalue -> string -> llbuilder -> llvalue
1890
1891 (** [build_free p b] creates a [free]
1892     instruction at the position specified by the instruction builder [b].
1893     See the method [llvm::LLVMBuilder::CreateFree]. *)
1894 val build_free : llvalue -> llbuilder -> llvalue
1895
1896 (** [add_case sw onval bb] causes switch instruction [sw] to branch to [bb]
1897     when its input matches the constant [onval].
1898     See the method [llvm::SwitchInst::addCase]. **)
1899 val add_case : llvalue -> llvalue -> llbasicblock -> unit
1900
1901 (** [switch_default_dest sw] returns the default destination of the [switch]
1902     instruction.
1903     See the method [llvm:;SwitchInst::getDefaultDest]. **)
1904 val switch_default_dest : llvalue -> llbasicblock
1905
1906 (** [build_indirect_br addr count b] creates a
1907     [indirectbr %addr]
1908     instruction at the position specified by the instruction builder [b] with
1909     space reserved for [count] destinations.
1910     See the method [llvm::LLVMBuilder::CreateIndirectBr]. *)
1911 val build_indirect_br : llvalue -> int -> llbuilder -> llvalue
1912
1913 (** [add_destination br bb] adds the basic block [bb] as a possible branch
1914     location for the indirectbr instruction [br].
1915     See the method [llvm::IndirectBrInst::addDestination]. **)
1916 val add_destination : llvalue -> llbasicblock -> unit
1917
1918 (** [build_invoke fn args tobb unwindbb name b] creates an
1919     [%name = invoke %fn(args) to %tobb unwind %unwindbb]
1920     instruction at the position specified by the instruction builder [b].
1921     See the method [llvm::LLVMBuilder::CreateInvoke]. *)
1922 val build_invoke : llvalue -> llvalue array -> llbasicblock ->
1923                         llbasicblock -> string -> llbuilder -> llvalue
1924
1925 (** [build_landingpad ty persfn numclauses name b] creates an
1926     [landingpad]
1927     instruction at the position specified by the instruction builder [b].
1928     See the method [llvm::LLVMBuilder::CreateLandingPad]. *)
1929 val build_landingpad : lltype -> llvalue -> int -> string -> llbuilder ->
1930                          llvalue
1931
1932 (** [set_cleanup lp] sets the cleanup flag in the [landingpad]instruction.
1933     See the method [llvm::LandingPadInst::setCleanup]. *)
1934 val set_cleanup : llvalue -> bool -> unit
1935
1936 (** [add_clause lp clause] adds the clause to the [landingpad]instruction.
1937     See the method [llvm::LandingPadInst::addClause]. *)
1938 val add_clause : llvalue -> llvalue -> unit
1939
1940 (** [build_resume exn b] builds a [resume exn] instruction
1941     at the position specified by the instruction builder [b].
1942     See the method [llvm::LLVMBuilder::CreateResume] *)
1943 val build_resume : llvalue -> llbuilder -> llvalue
1944
1945 (** [build_unreachable b] creates an
1946     [unreachable]
1947     instruction at the position specified by the instruction builder [b].
1948     See the method [llvm::LLVMBuilder::CreateUnwind]. *)
1949 val build_unreachable : llbuilder -> llvalue
1950
1951
1952 (** {7 Arithmetic} *)
1953
1954 (** [build_add x y name b] creates a
1955     [%name = add %x, %y]
1956     instruction at the position specified by the instruction builder [b].
1957     See the method [llvm::LLVMBuilder::CreateAdd]. *)
1958 val build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
1959
1960 (** [build_nsw_add x y name b] creates a
1961     [%name = nsw add %x, %y]
1962     instruction at the position specified by the instruction builder [b].
1963     See the method [llvm::LLVMBuilder::CreateNSWAdd]. *)
1964 val build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
1965
1966 (** [build_nuw_add x y name b] creates a
1967     [%name = nuw add %x, %y]
1968     instruction at the position specified by the instruction builder [b].
1969     See the method [llvm::LLVMBuilder::CreateNUWAdd]. *)
1970 val build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
1971
1972 (** [build_fadd x y name b] creates a
1973     [%name = fadd %x, %y]
1974     instruction at the position specified by the instruction builder [b].
1975     See the method [llvm::LLVMBuilder::CreateFAdd]. *)
1976 val build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
1977
1978 (** [build_sub x y name b] creates a
1979     [%name = sub %x, %y]
1980     instruction at the position specified by the instruction builder [b].
1981     See the method [llvm::LLVMBuilder::CreateSub]. *)
1982 val build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1983
1984 (** [build_nsw_sub x y name b] creates a
1985     [%name = nsw sub %x, %y]
1986     instruction at the position specified by the instruction builder [b].
1987     See the method [llvm::LLVMBuilder::CreateNSWSub]. *)
1988 val build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1989
1990 (** [build_nuw_sub x y name b] creates a
1991     [%name = nuw sub %x, %y]
1992     instruction at the position specified by the instruction builder [b].
1993     See the method [llvm::LLVMBuilder::CreateNUWSub]. *)
1994 val build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1995
1996 (** [build_fsub x y name b] creates a
1997     [%name = fsub %x, %y]
1998     instruction at the position specified by the instruction builder [b].
1999     See the method [llvm::LLVMBuilder::CreateFSub]. *)
2000 val build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
2001
2002 (** [build_mul x y name b] creates a
2003     [%name = mul %x, %y]
2004     instruction at the position specified by the instruction builder [b].
2005     See the method [llvm::LLVMBuilder::CreateMul]. *)
2006 val build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
2007
2008 (** [build_nsw_mul x y name b] creates a
2009     [%name = nsw mul %x, %y]
2010     instruction at the position specified by the instruction builder [b].
2011     See the method [llvm::LLVMBuilder::CreateNSWMul]. *)
2012 val build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
2013
2014 (** [build_nuw_mul x y name b] creates a
2015     [%name = nuw mul %x, %y]
2016     instruction at the position specified by the instruction builder [b].
2017     See the method [llvm::LLVMBuilder::CreateNUWMul]. *)
2018 val build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
2019
2020 (** [build_fmul x y name b] creates a
2021     [%name = fmul %x, %y]
2022     instruction at the position specified by the instruction builder [b].
2023     See the method [llvm::LLVMBuilder::CreateFMul]. *)
2024 val build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
2025
2026 (** [build_udiv x y name b] creates a
2027     [%name = udiv %x, %y]
2028     instruction at the position specified by the instruction builder [b].
2029     See the method [llvm::LLVMBuilder::CreateUDiv]. *)
2030 val build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
2031
2032 (** [build_sdiv x y name b] creates a
2033     [%name = sdiv %x, %y]
2034     instruction at the position specified by the instruction builder [b].
2035     See the method [llvm::LLVMBuilder::CreateSDiv]. *)
2036 val build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
2037
2038 (** [build_exact_sdiv x y name b] creates a
2039     [%name = exact sdiv %x, %y]
2040     instruction at the position specified by the instruction builder [b].
2041     See the method [llvm::LLVMBuilder::CreateExactSDiv]. *)
2042 val build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
2043
2044 (** [build_fdiv x y name b] creates a
2045     [%name = fdiv %x, %y]
2046     instruction at the position specified by the instruction builder [b].
2047     See the method [llvm::LLVMBuilder::CreateFDiv]. *)
2048 val build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
2049
2050 (** [build_urem x y name b] creates a
2051     [%name = urem %x, %y]
2052     instruction at the position specified by the instruction builder [b].
2053     See the method [llvm::LLVMBuilder::CreateURem]. *)
2054 val build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
2055
2056 (** [build_SRem x y name b] creates a
2057     [%name = srem %x, %y]
2058     instruction at the position specified by the instruction builder [b].
2059     See the method [llvm::LLVMBuilder::CreateSRem]. *)
2060 val build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
2061
2062 (** [build_frem x y name b] creates a
2063     [%name = frem %x, %y]
2064     instruction at the position specified by the instruction builder [b].
2065     See the method [llvm::LLVMBuilder::CreateFRem]. *)
2066 val build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
2067
2068 (** [build_shl x y name b] creates a
2069     [%name = shl %x, %y]
2070     instruction at the position specified by the instruction builder [b].
2071     See the method [llvm::LLVMBuilder::CreateShl]. *)
2072 val build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
2073
2074 (** [build_lshr x y name b] creates a
2075     [%name = lshr %x, %y]
2076     instruction at the position specified by the instruction builder [b].
2077     See the method [llvm::LLVMBuilder::CreateLShr]. *)
2078 val build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
2079
2080 (** [build_ashr x y name b] creates a
2081     [%name = ashr %x, %y]
2082     instruction at the position specified by the instruction builder [b].
2083     See the method [llvm::LLVMBuilder::CreateAShr]. *)
2084 val build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
2085
2086 (** [build_and x y name b] creates a
2087     [%name = and %x, %y]
2088     instruction at the position specified by the instruction builder [b].
2089     See the method [llvm::LLVMBuilder::CreateAnd]. *)
2090 val build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
2091
2092 (** [build_or x y name b] creates a
2093     [%name = or %x, %y]
2094     instruction at the position specified by the instruction builder [b].
2095     See the method [llvm::LLVMBuilder::CreateOr]. *)
2096 val build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
2097
2098 (** [build_xor x y name b] creates a
2099     [%name = xor %x, %y]
2100     instruction at the position specified by the instruction builder [b].
2101     See the method [llvm::LLVMBuilder::CreateXor]. *)
2102 val build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
2103
2104 (** [build_neg x name b] creates a
2105     [%name = sub 0, %x]
2106     instruction at the position specified by the instruction builder [b].
2107     [-0.0] is used for floating point types to compute the correct sign.
2108     See the method [llvm::LLVMBuilder::CreateNeg]. *)
2109 val build_neg : llvalue -> string -> llbuilder -> llvalue
2110
2111 (** [build_nsw_neg x name b] creates a
2112     [%name = nsw sub 0, %x]
2113     instruction at the position specified by the instruction builder [b].
2114     [-0.0] is used for floating point types to compute the correct sign.
2115     See the method [llvm::LLVMBuilder::CreateNeg]. *)
2116 val build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
2117
2118 (** [build_nuw_neg x name b] creates a
2119     [%name = nuw sub 0, %x]
2120     instruction at the position specified by the instruction builder [b].
2121     [-0.0] is used for floating point types to compute the correct sign.
2122     See the method [llvm::LLVMBuilder::CreateNeg]. *)
2123 val build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
2124
2125 (** [build_fneg x name b] creates a
2126     [%name = fsub 0, %x]
2127     instruction at the position specified by the instruction builder [b].
2128     [-0.0] is used for floating point types to compute the correct sign.
2129     See the method [llvm::LLVMBuilder::CreateFNeg]. *)
2130 val build_fneg : llvalue -> string -> llbuilder -> llvalue
2131
2132 (** [build_xor x name b] creates a
2133     [%name = xor %x, -1]
2134     instruction at the position specified by the instruction builder [b].
2135     [-1] is the correct "all ones" value for the type of [x].
2136     See the method [llvm::LLVMBuilder::CreateXor]. *)
2137 val build_not : llvalue -> string -> llbuilder -> llvalue
2138
2139
2140 (** {7 Memory} *)
2141
2142 (** [build_alloca ty name b] creates a
2143     [%name = alloca %ty]
2144     instruction at the position specified by the instruction builder [b].
2145     See the method [llvm::LLVMBuilder::CreateAlloca]. *)
2146 val build_alloca : lltype -> string -> llbuilder -> llvalue
2147
2148 (** [build_array_alloca ty n name b] creates a
2149     [%name = alloca %ty, %n]
2150     instruction at the position specified by the instruction builder [b].
2151     See the method [llvm::LLVMBuilder::CreateAlloca]. *)
2152 val build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
2153                               llvalue
2154
2155 (** [build_load v name b] creates a
2156     [%name = load %v]
2157     instruction at the position specified by the instruction builder [b].
2158     See the method [llvm::LLVMBuilder::CreateLoad]. *)
2159 val build_load : llvalue -> string -> llbuilder -> llvalue
2160
2161 (** [build_store v p b] creates a
2162     [store %v, %p]
2163     instruction at the position specified by the instruction builder [b].
2164     See the method [llvm::LLVMBuilder::CreateStore]. *)
2165 val build_store : llvalue -> llvalue -> llbuilder -> llvalue
2166
2167 (** [build_atomicrmw op ptr val o st b] creates an [atomicrmw] instruction with
2168     operation [op] performed on pointer [ptr] and value [val] with ordering [o]
2169     and singlethread flag set to [st] at the position specified by
2170     the instruction builder [b].
2171     See the method [llvm::IRBuilder::CreateAtomicRMW]. *)
2172 val build_atomicrmw : AtomicRMWBinOp.t -> llvalue -> llvalue ->
2173                       AtomicOrdering.t -> bool -> string -> llbuilder -> llvalue
2174
2175 (** [build_gep p indices name b] creates a
2176     [%name = getelementptr %p, indices...]
2177     instruction at the position specified by the instruction builder [b].
2178     See the method [llvm::LLVMBuilder::CreateGetElementPtr]. *)
2179 val build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
2180
2181 (** [build_in_bounds_gep p indices name b] creates a
2182     [%name = gelementptr inbounds %p, indices...]
2183     instruction at the position specified by the instruction builder [b].
2184     See the method [llvm::LLVMBuilder::CreateInBoundsGetElementPtr]. *)
2185 val build_in_bounds_gep : llvalue -> llvalue array -> string -> llbuilder ->
2186                                llvalue
2187
2188 (** [build_struct_gep p idx name b] creates a
2189     [%name = getelementptr %p, 0, idx]
2190     instruction at the position specified by the instruction builder [b].
2191     See the method [llvm::LLVMBuilder::CreateStructGetElementPtr]. *)
2192 val build_struct_gep : llvalue -> int -> string -> llbuilder ->
2193                             llvalue
2194
2195 (** [build_global_string str name b] creates a series of instructions that adds
2196     a global string at the position specified by the instruction builder [b].
2197     See the method [llvm::LLVMBuilder::CreateGlobalString]. *)
2198 val build_global_string : string -> string -> llbuilder -> llvalue
2199
2200 (** [build_global_stringptr str name b] creates a series of instructions that
2201     adds a global string pointer at the position specified by the instruction
2202     builder [b].
2203     See the method [llvm::LLVMBuilder::CreateGlobalStringPtr]. *)
2204 val build_global_stringptr : string -> string -> llbuilder -> llvalue
2205
2206
2207 (** {7 Casts} *)
2208
2209 (** [build_trunc v ty name b] creates a
2210     [%name = trunc %p to %ty]
2211     instruction at the position specified by the instruction builder [b].
2212     See the method [llvm::LLVMBuilder::CreateTrunc]. *)
2213 val build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
2214
2215 (** [build_zext v ty name b] creates a
2216     [%name = zext %p to %ty]
2217     instruction at the position specified by the instruction builder [b].
2218     See the method [llvm::LLVMBuilder::CreateZExt]. *)
2219 val build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
2220
2221 (** [build_sext v ty name b] creates a
2222     [%name = sext %p to %ty]
2223     instruction at the position specified by the instruction builder [b].
2224     See the method [llvm::LLVMBuilder::CreateSExt]. *)
2225 val build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
2226
2227 (** [build_fptoui v ty name b] creates a
2228     [%name = fptoui %p to %ty]
2229     instruction at the position specified by the instruction builder [b].
2230     See the method [llvm::LLVMBuilder::CreateFPToUI]. *)
2231 val build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
2232
2233 (** [build_fptosi v ty name b] creates a
2234     [%name = fptosi %p to %ty]
2235     instruction at the position specified by the instruction builder [b].
2236     See the method [llvm::LLVMBuilder::CreateFPToSI]. *)
2237 val build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
2238
2239 (** [build_uitofp v ty name b] creates a
2240     [%name = uitofp %p to %ty]
2241     instruction at the position specified by the instruction builder [b].
2242     See the method [llvm::LLVMBuilder::CreateUIToFP]. *)
2243 val build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
2244
2245 (** [build_sitofp v ty name b] creates a
2246     [%name = sitofp %p to %ty]
2247     instruction at the position specified by the instruction builder [b].
2248     See the method [llvm::LLVMBuilder::CreateSIToFP]. *)
2249 val build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
2250
2251 (** [build_fptrunc v ty name b] creates a
2252     [%name = fptrunc %p to %ty]
2253     instruction at the position specified by the instruction builder [b].
2254     See the method [llvm::LLVMBuilder::CreateFPTrunc]. *)
2255 val build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
2256
2257 (** [build_fpext v ty name b] creates a
2258     [%name = fpext %p to %ty]
2259     instruction at the position specified by the instruction builder [b].
2260     See the method [llvm::LLVMBuilder::CreateFPExt]. *)
2261 val build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
2262
2263 (** [build_ptrtoint v ty name b] creates a
2264     [%name = prtotint %p to %ty]
2265     instruction at the position specified by the instruction builder [b].
2266     See the method [llvm::LLVMBuilder::CreatePtrToInt]. *)
2267 val build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
2268
2269 (** [build_inttoptr v ty name b] creates a
2270     [%name = inttoptr %p to %ty]
2271     instruction at the position specified by the instruction builder [b].
2272     See the method [llvm::LLVMBuilder::CreateIntToPtr]. *)
2273 val build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
2274
2275 (** [build_bitcast v ty name b] creates a
2276     [%name = bitcast %p to %ty]
2277     instruction at the position specified by the instruction builder [b].
2278     See the method [llvm::LLVMBuilder::CreateBitCast]. *)
2279 val build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
2280
2281 (** [build_zext_or_bitcast v ty name b] creates a zext or bitcast
2282     instruction at the position specified by the instruction builder [b].
2283     See the method [llvm::LLVMBuilder::CreateZExtOrBitCast]. *)
2284 val build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
2285                                  llvalue
2286
2287 (** [build_sext_or_bitcast v ty name b] creates a sext or bitcast
2288     instruction at the position specified by the instruction builder [b].
2289     See the method [llvm::LLVMBuilder::CreateSExtOrBitCast]. *)
2290 val build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
2291                                  llvalue
2292
2293 (** [build_trunc_or_bitcast v ty name b] creates a trunc or bitcast
2294     instruction at the position specified by the instruction builder [b].
2295     See the method [llvm::LLVMBuilder::CreateZExtOrBitCast]. *)
2296 val build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
2297                                   llvalue
2298
2299 (** [build_pointercast v ty name b] creates a bitcast or pointer-to-int
2300     instruction at the position specified by the instruction builder [b].
2301     See the method [llvm::LLVMBuilder::CreatePointerCast]. *)
2302 val build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
2303
2304 (** [build_intcast v ty name b] creates a zext, bitcast, or trunc
2305     instruction at the position specified by the instruction builder [b].
2306     See the method [llvm::LLVMBuilder::CreateIntCast]. *)
2307 val build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
2308
2309 (** [build_fpcast v ty name b] creates a fpext, bitcast, or fptrunc
2310     instruction at the position specified by the instruction builder [b].
2311     See the method [llvm::LLVMBuilder::CreateFPCast]. *)
2312 val build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
2313
2314
2315 (** {7 Comparisons} *)
2316
2317 (** [build_icmp pred x y name b] creates a
2318     [%name = icmp %pred %x, %y]
2319     instruction at the position specified by the instruction builder [b].
2320     See the method [llvm::LLVMBuilder::CreateICmp]. *)
2321 val build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
2322                       llbuilder -> llvalue
2323
2324 (** [build_fcmp pred x y name b] creates a
2325     [%name = fcmp %pred %x, %y]
2326     instruction at the position specified by the instruction builder [b].
2327     See the method [llvm::LLVMBuilder::CreateFCmp]. *)
2328 val build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
2329                       llbuilder -> llvalue
2330
2331
2332 (** {7 Miscellaneous instructions} *)
2333
2334 (** [build_phi incoming name b] creates a
2335     [%name = phi %incoming]
2336     instruction at the position specified by the instruction builder [b].
2337     [incoming] is a list of [(llvalue, llbasicblock)] tuples.
2338     See the method [llvm::LLVMBuilder::CreatePHI]. *)
2339 val build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
2340                      llvalue
2341
2342 (** [build_call fn args name b] creates a
2343     [%name = call %fn(args...)]
2344     instruction at the position specified by the instruction builder [b].
2345     See the method [llvm::LLVMBuilder::CreateCall]. *)
2346 val build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
2347
2348 (** [build_select cond thenv elsev name b] creates a
2349     [%name = select %cond, %thenv, %elsev]
2350     instruction at the position specified by the instruction builder [b].
2351     See the method [llvm::LLVMBuilder::CreateSelect]. *)
2352 val build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
2353                         llvalue
2354
2355 (** [build_va_arg valist argty name b] creates a
2356     [%name = va_arg %valist, %argty]
2357     instruction at the position specified by the instruction builder [b].
2358     See the method [llvm::LLVMBuilder::CreateVAArg]. *)
2359 val build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
2360
2361 (** [build_extractelement vec i name b] creates a
2362     [%name = extractelement %vec, %i]
2363     instruction at the position specified by the instruction builder [b].
2364     See the method [llvm::LLVMBuilder::CreateExtractElement]. *)
2365 val build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
2366                                 llvalue
2367
2368 (** [build_insertelement vec elt i name b] creates a
2369     [%name = insertelement %vec, %elt, %i]
2370     instruction at the position specified by the instruction builder [b].
2371     See the method [llvm::LLVMBuilder::CreateInsertElement]. *)
2372 val build_insertelement : llvalue -> llvalue -> llvalue -> string ->
2373                                llbuilder -> llvalue
2374
2375 (** [build_shufflevector veca vecb mask name b] creates a
2376     [%name = shufflevector %veca, %vecb, %mask]
2377     instruction at the position specified by the instruction builder [b].
2378     See the method [llvm::LLVMBuilder::CreateShuffleVector]. *)
2379 val build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
2380                                llbuilder -> llvalue
2381
2382 (** [build_extractvalue agg idx name b] creates a
2383     [%name = extractvalue %agg, %idx]
2384     instruction at the position specified by the instruction builder [b].
2385     See the method [llvm::LLVMBuilder::CreateExtractValue]. *)
2386 val build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
2387
2388
2389 (** [build_insertvalue agg val idx name b] creates a
2390     [%name = insertvalue %agg, %val, %idx]
2391     instruction at the position specified by the instruction builder [b].
2392     See the method [llvm::LLVMBuilder::CreateInsertValue]. *)
2393 val build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
2394                              llvalue
2395
2396 (** [build_is_null val name b] creates a
2397     [%name = icmp eq %val, null]
2398     instruction at the position specified by the instruction builder [b].
2399     See the method [llvm::LLVMBuilder::CreateIsNull]. *)
2400 val build_is_null : llvalue -> string -> llbuilder -> llvalue
2401
2402 (** [build_is_not_null val name b] creates a
2403     [%name = icmp ne %val, null]
2404     instruction at the position specified by the instruction builder [b].
2405     See the method [llvm::LLVMBuilder::CreateIsNotNull]. *)
2406 val build_is_not_null : llvalue -> string -> llbuilder -> llvalue
2407
2408 (** [build_ptrdiff lhs rhs name b] creates a series of instructions that measure
2409     the difference between two pointer values at the position specified by the
2410     instruction builder [b].
2411     See the method [llvm::LLVMBuilder::CreatePtrDiff]. *)
2412 val build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
2413
2414
2415 (** {6 Memory buffers} *)
2416
2417 module MemoryBuffer : sig
2418   (** [of_file p] is the memory buffer containing the contents of the file at
2419       path [p]. If the file could not be read, then [IoError msg] is
2420       raised. *)
2421   val of_file : string -> llmemorybuffer
2422   
2423   (** [of_stdin ()] is the memory buffer containing the contents of standard input.
2424       If standard input is empty, then [IoError msg] is raised. *)
2425   val of_stdin : unit -> llmemorybuffer
2426
2427   (** [of_string ~name s] is the memory buffer containing the contents of string [s].
2428       The name of memory buffer is set to [name] if it is provided. *)
2429   val of_string : ?name:string -> string -> llmemorybuffer
2430
2431   (** [as_string mb] is the string containing the contents of memory buffer [mb]. *)
2432   val as_string : llmemorybuffer -> string
2433   
2434   (** Disposes of a memory buffer. *)
2435   val dispose : llmemorybuffer -> unit
2436 end
2437
2438
2439 (** {6 Pass Managers} *)
2440
2441 module PassManager : sig
2442   (**  *)
2443   type 'a t
2444   type any = [ `Module | `Function ]
2445   
2446   (** [PassManager.create ()] constructs a new whole-module pass pipeline. This
2447       type of pipeline is suitable for link-time optimization and whole-module
2448       transformations.
2449       See the constructor of [llvm::PassManager]. *)
2450   val create : unit -> [ `Module ] t
2451   
2452   (** [PassManager.create_function m] constructs a new function-by-function
2453       pass pipeline over the module [m]. It does not take ownership of [m].
2454       This type of pipeline is suitable for code generation and JIT compilation
2455       tasks.
2456       See the constructor of [llvm::FunctionPassManager]. *)
2457   val create_function : llmodule -> [ `Function ] t
2458
2459   (** [run_module m pm] initializes, executes on the module [m], and finalizes
2460       all of the passes scheduled in the pass manager [pm]. Returns [true] if
2461       any of the passes modified the module, [false] otherwise.
2462       See the [llvm::PassManager::run] method. *)
2463   val run_module : llmodule -> [ `Module ] t -> bool
2464
2465   (** [initialize fpm] initializes all of the function passes scheduled in the
2466       function pass manager [fpm]. Returns [true] if any of the passes modified
2467       the module, [false] otherwise.
2468       See the [llvm::FunctionPassManager::doInitialization] method. *)
2469   val initialize : [ `Function ] t -> bool
2470   
2471   (** [run_function f fpm] executes all of the function passes scheduled in the
2472       function pass manager [fpm] over the function [f]. Returns [true] if any
2473       of the passes modified [f], [false] otherwise.
2474       See the [llvm::FunctionPassManager::run] method. *)
2475   val run_function : llvalue -> [ `Function ] t -> bool
2476   
2477   (** [finalize fpm] finalizes all of the function passes scheduled in in the
2478       function pass manager [fpm]. Returns [true] if any of the passes
2479       modified the module, [false] otherwise.
2480       See the [llvm::FunctionPassManager::doFinalization] method. *)
2481   val finalize : [ `Function ] t -> bool
2482   
2483   (** Frees the memory of a pass pipeline. For function pipelines, does not free
2484       the module.
2485       See the destructor of [llvm::BasePassManager]. *)
2486   val dispose : [< any ] t -> unit
2487 end