bindings/ocaml/llvm/llvm.ml

   1 (*===-- llvm/llvm.ml - 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
  11 type llcontext
  12 type llmodule
  13 type lltype
  14 type llvalue
  15 type lluse
  16 type llbasicblock
  17 type llbuilder
  18 type llmemorybuffer
  19 type llmdkind
  20
  21 module TypeKind = struct
  22   type t =
  23   | Void
  24   | Half
  25   | Float
  26   | Double
  27   | X86fp80
  28   | Fp128
  29   | Ppc_fp128
  30   | Label
  31   | Integer
  32   | Function
  33   | Struct
  34   | Array
  35   | Pointer
  36   | Vector
  37   | Metadata
  38   | X86_mmx
  39 end
  40
  41 module Linkage = struct
  42   type t =
  43   | External
  44   | Available_externally
  45   | Link_once
  46   | Link_once_odr
  47   | Link_once_odr_auto_hide
  48   | Weak
  49   | Weak_odr
  50   | Appending
  51   | Internal
  52   | Private
  53   | Dllimport
  54   | Dllexport
  55   | External_weak
  56   | Ghost
  57   | Common
  58   | Linker_private
  59   | Linker_private_weak
  60 end
  61
  62 module Visibility = struct
  63   type t =
  64   | Default
  65   | Hidden
  66   | Protected
  67 end
  68
  69 module CallConv = struct
  70   let c = 0
  71   let fast = 8
  72   let cold = 9
  73   let x86_stdcall = 64
  74   let x86_fastcall = 65
  75 end
  76
  77 module Attribute = struct
  78   type t =
  79   | Zext
  80   | Sext
  81   | Noreturn
  82   | Inreg
  83   | Structret
  84   | Nounwind
  85   | Noalias
  86   | Byval
  87   | Nest
  88   | Readnone
  89   | Readonly
  90   | Noinline
  91   | Alwaysinline
  92   | Optsize
  93   | Ssp
  94   | Sspreq
  95   | Alignment of int
  96   | Nocapture
  97   | Noredzone
  98   | Noimplicitfloat
  99   | Naked
 100   | Inlinehint
 101   | Stackalignment of int
 102   | ReturnsTwice
 103   | UWTable
 104   | NonLazyBind
 105 end
 106
 107 module Icmp = struct
 108   type t =
 109   | Eq
 110   | Ne
 111   | Ugt
 112   | Uge
 113   | Ult
 114   | Ule
 115   | Sgt
 116   | Sge
 117   | Slt
 118   | Sle
 119 end
 120
 121 module Fcmp = struct
 122   type t =
 123   | False
 124   | Oeq
 125   | Ogt
 126   | Oge
 127   | Olt
 128   | Ole
 129   | One
 130   | Ord
 131   | Uno
 132   | Ueq
 133   | Ugt
 134   | Uge
 135   | Ult
 136   | Ule
 137   | Une
 138   | True
 139 end
 140
 141 module Opcode  = struct
 142   type t =
 143   | Invalid (* not an instruction *)
 144   (* Terminator Instructions *)
 145   | Ret
 146   | Br
 147   | Switch
 148   | IndirectBr
 149   | Invoke
 150   | Invalid2
 151   | Unreachable
 152   (* Standard Binary Operators *)
 153   | Add
 154   | FAdd
 155   | Sub
 156   | FSub
 157   | Mul
 158   | FMul
 159   | UDiv
 160   | SDiv
 161   | FDiv
 162   | URem
 163   | SRem
 164   | FRem
 165   (* Logical Operators *)
 166   | Shl
 167   | LShr
 168   | AShr
 169   | And
 170   | Or
 171   | Xor
 172   (* Memory Operators *)
 173   | Alloca
 174   | Load
 175   | Store
 176   | GetElementPtr
 177   (* Cast Operators *)
 178   | Trunc
 179   | ZExt
 180   | SExt
 181   | FPToUI
 182   | FPToSI
 183   | UIToFP
 184   | SIToFP
 185   | FPTrunc
 186   | FPExt
 187   | PtrToInt
 188   | IntToPtr
 189   | BitCast
 190   (* Other Operators *)
 191   | ICmp
 192   | FCmp
 193   | PHI
 194   | Call
 195   | Select
 196   | UserOp1
 197   | UserOp2
 198   | VAArg
 199   | ExtractElement
 200   | InsertElement
 201   | ShuffleVector
 202   | ExtractValue
 203   | InsertValue
 204   | Fence
 205   | AtomicCmpXchg
 206   | AtomicRMW
 207   | Resume
 208   | LandingPad
 209 end
 210
 211 module LandingPadClauseTy = struct
 212   type t =
 213   | Catch
 214   | Filter
 215 end
 216
 217 module ThreadLocalMode = struct
 218   type t =
 219   | None
 220   | GeneralDynamic
 221   | LocalDynamic
 222   | InitialExec
 223   | LocalExec
 224 end
 225
 226 module AtomicOrdering = struct
 227   type t =
 228   | NotAtomic
 229   | Unordered
 230   | Monotonic
 231   | Invalid
 232   | Acquire
 233   | Release
 234   | AcqiureRelease
 235   | SequentiallyConsistent
 236 end
 237
 238 module AtomicRMWBinOp = struct
 239   type t =
 240   | Xchg
 241   | Add
 242   | Sub
 243   | And
 244   | Nand
 245   | Or
 246   | Xor
 247   | Max
 248   | Min
 249   | UMax
 250   | UMin
 251 end
 252
 253 module ValueKind = struct
 254   type t =
 255   | NullValue
 256   | Argument
 257   | BasicBlock
 258   | InlineAsm
 259   | MDNode
 260   | MDString
 261   | BlockAddress
 262   | ConstantAggregateZero
 263   | ConstantArray
 264   | ConstantDataArray
 265   | ConstantDataVector
 266   | ConstantExpr
 267   | ConstantFP
 268   | ConstantInt
 269   | ConstantPointerNull
 270   | ConstantStruct
 271   | ConstantVector
 272   | Function
 273   | GlobalAlias
 274   | GlobalVariable
 275   | UndefValue
 276   | Instruction of Opcode.t
 277 end
 278
 279 exception IoError of string
 280
 281 let () = Callback.register_exception "Llvm.IoError" (IoError "")
 282
 283 external install_fatal_error_handler : (string -> unit) -> unit
 284                                      = "llvm_install_fatal_error_handler"
 285 external reset_fatal_error_handler : unit -> unit
 286                                    = "llvm_reset_fatal_error_handler"
 287 external enable_pretty_stacktrace : unit -> unit
 288                                   = "llvm_enable_pretty_stacktrace"
 289 external parse_command_line_options : ?overview:string -> string array -> unit
 290                                     = "llvm_parse_command_line_options"
 291
 292 type ('a, 'b) llpos =
 293 | At_end of 'a
 294 | Before of 'b
 295
 296 type ('a, 'b) llrev_pos =
 297 | At_start of 'a
 298 | After of 'b
 299
 300 (*===-- Contexts ----------------------------------------------------------===*)
 301 external create_context : unit -> llcontext = "llvm_create_context"
 302 external dispose_context : llcontext -> unit = "llvm_dispose_context"
 303 external global_context : unit -> llcontext = "llvm_global_context"
 304 external mdkind_id : llcontext -> string -> llmdkind = "llvm_mdkind_id"
 305
 306 (*===-- Modules -----------------------------------------------------------===*)
 307 external create_module : llcontext -> string -> llmodule = "llvm_create_module"
 308 external dispose_module : llmodule -> unit = "llvm_dispose_module"
 309 external target_triple: llmodule -> string
 310                       = "llvm_target_triple"
 311 external set_target_triple: string -> llmodule -> unit
 312                           = "llvm_set_target_triple"
 313 external data_layout: llmodule -> string
 314                     = "llvm_data_layout"
 315 external set_data_layout: string -> llmodule -> unit
 316                         = "llvm_set_data_layout"
 317 external dump_module : llmodule -> unit = "llvm_dump_module"
 318 external print_module : string -> llmodule -> unit = "llvm_print_module"
 319 external string_of_llmodule : llmodule -> string = "llvm_string_of_llmodule"
 320 external set_module_inline_asm : llmodule -> string -> unit
 321                                = "llvm_set_module_inline_asm"
 322 external module_context : llmodule -> llcontext = "LLVMGetModuleContext"
 323
 324 (*===-- Types -------------------------------------------------------------===*)
 325 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
 326 external type_context : lltype -> llcontext = "llvm_type_context"
 327 external type_is_sized : lltype -> bool = "llvm_type_is_sized"
 328 external dump_type : lltype -> unit = "llvm_dump_type"
 329 external string_of_lltype : lltype -> string = "llvm_string_of_lltype"
 330
 331 (*--... Operations on integer types ........................................--*)
 332 external i1_type : llcontext -> lltype = "llvm_i1_type"
 333 external i8_type : llcontext -> lltype = "llvm_i8_type"
 334 external i16_type : llcontext -> lltype = "llvm_i16_type"
 335 external i32_type : llcontext -> lltype = "llvm_i32_type"
 336 external i64_type : llcontext -> lltype = "llvm_i64_type"
 337
 338 external integer_type : llcontext -> int -> lltype = "llvm_integer_type"
 339 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
 340
 341 (*--... Operations on real types ...........................................--*)
 342 external float_type : llcontext -> lltype = "llvm_float_type"
 343 external double_type : llcontext -> lltype = "llvm_double_type"
 344 external x86fp80_type : llcontext -> lltype = "llvm_x86fp80_type"
 345 external fp128_type : llcontext -> lltype = "llvm_fp128_type"
 346 external ppc_fp128_type : llcontext -> lltype = "llvm_ppc_fp128_type"
 347
 348 (*--... Operations on function types .......................................--*)
 349 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
 350 external var_arg_function_type : lltype -> lltype array -> lltype
 351                                = "llvm_var_arg_function_type"
 352 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
 353 external return_type : lltype -> lltype = "LLVMGetReturnType"
 354 external param_types : lltype -> lltype array = "llvm_param_types"
 355
 356 (*--... Operations on struct types .........................................--*)
 357 external struct_type : llcontext -> lltype array -> lltype = "llvm_struct_type"
 358 external packed_struct_type : llcontext -> lltype array -> lltype
 359                             = "llvm_packed_struct_type"
 360 external struct_name : lltype -> string option = "llvm_struct_name"
 361 external named_struct_type : llcontext -> string -> lltype =
 362     "llvm_named_struct_type"
 363 external struct_set_body : lltype -> lltype array -> bool -> unit =
 364     "llvm_struct_set_body"
 365 external struct_element_types : lltype -> lltype array
 366                               = "llvm_struct_element_types"
 367 external is_packed : lltype -> bool = "llvm_is_packed"
 368 external is_opaque : lltype -> bool = "llvm_is_opaque"
 369
 370 (*--... Operations on pointer, vector, and array types .....................--*)
 371 external array_type : lltype -> int -> lltype = "llvm_array_type"
 372 external pointer_type : lltype -> lltype = "llvm_pointer_type"
 373 external qualified_pointer_type : lltype -> int -> lltype
 374                                 = "llvm_qualified_pointer_type"
 375 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
 376
 377 external element_type : lltype -> lltype = "LLVMGetElementType"
 378 external array_length : lltype -> int = "llvm_array_length"
 379 external address_space : lltype -> int = "llvm_address_space"
 380 external vector_size : lltype -> int = "llvm_vector_size"
 381
 382 (*--... Operations on other types ..........................................--*)
 383 external void_type : llcontext -> lltype = "llvm_void_type"
 384 external label_type : llcontext -> lltype = "llvm_label_type"
 385 external x86_mmx_type : llcontext -> lltype = "llvm_x86_mmx_type"
 386 external type_by_name : llmodule -> string -> lltype option = "llvm_type_by_name"
 387
 388 external classify_value : llvalue -> ValueKind.t = "llvm_classify_value"
 389 (*===-- Values ------------------------------------------------------------===*)
 390 external type_of : llvalue -> lltype = "llvm_type_of"
 391 external value_name : llvalue -> string = "llvm_value_name"
 392 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
 393 external dump_value : llvalue -> unit = "llvm_dump_value"
 394 external string_of_llvalue : llvalue -> string = "llvm_string_of_llvalue"
 395 external replace_all_uses_with : llvalue -> llvalue -> unit
 396                                = "llvm_replace_all_uses_with"
 397
 398 (*--... Operations on uses .................................................--*)
 399 external use_begin : llvalue -> lluse option = "llvm_use_begin"
 400 external use_succ : lluse -> lluse option = "llvm_use_succ"
 401 external user : lluse -> llvalue = "llvm_user"
 402 external used_value : lluse -> llvalue = "llvm_used_value"
 403
 404 let iter_uses f v =
 405   let rec aux = function
 406     | None -> ()
 407     | Some u ->
 408         f u;
 409         aux (use_succ u)
 410   in
 411   aux (use_begin v)
 412
 413 let fold_left_uses f init v =
 414   let rec aux init u =
 415     match u with
 416     | None -> init
 417     | Some u -> aux (f init u) (use_succ u)
 418   in
 419   aux init (use_begin v)
 420
 421 let fold_right_uses f v init =
 422   let rec aux u init =
 423     match u with
 424     | None -> init
 425     | Some u -> f u (aux (use_succ u) init)
 426   in
 427   aux (use_begin v) init
 428
 429
 430 (*--... Operations on users ................................................--*)
 431 external operand : llvalue -> int -> llvalue = "llvm_operand"
 432 external operand_use : llvalue -> int -> lluse = "llvm_operand_use"
 433 external set_operand : llvalue -> int -> llvalue -> unit = "llvm_set_operand"
 434 external num_operands : llvalue -> int = "llvm_num_operands"
 435
 436 (*--... Operations on constants of (mostly) any type .......................--*)
 437 external is_constant : llvalue -> bool = "llvm_is_constant"
 438 external const_null : lltype -> llvalue = "LLVMConstNull"
 439 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
 440 external const_pointer_null : lltype -> llvalue = "LLVMConstPointerNull"
 441 external undef : lltype -> llvalue = "LLVMGetUndef"
 442 external is_null : llvalue -> bool = "llvm_is_null"
 443 external is_undef : llvalue -> bool = "llvm_is_undef"
 444 external constexpr_opcode : llvalue -> Opcode.t = "llvm_constexpr_get_opcode"
 445
 446 (*--... Operations on instructions .........................................--*)
 447 external has_metadata : llvalue -> bool = "llvm_has_metadata"
 448 external metadata : llvalue -> llmdkind -> llvalue option = "llvm_metadata"
 449 external set_metadata : llvalue -> llmdkind -> llvalue -> unit = "llvm_set_metadata"
 450 external clear_metadata : llvalue -> llmdkind -> unit = "llvm_clear_metadata"
 451
 452 (*--... Operations on metadata .......,.....................................--*)
 453 external mdstring : llcontext -> string -> llvalue = "llvm_mdstring"
 454 external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode"
 455 external get_mdstring : llvalue -> string option = "llvm_get_mdstring"
 456 external get_named_metadata : llmodule -> string -> llvalue array
 457                             = "llvm_get_namedmd"
 458 external add_named_metadata_operand : llmodule -> string -> llvalue -> unit
 459                                     = "llvm_append_namedmd"
 460
 461 (*--... Operations on scalar constants .....................................--*)
 462 external const_int : lltype -> int -> llvalue = "llvm_const_int"
 463 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
 464                         = "llvm_const_of_int64"
 465 external int64_of_const : llvalue -> Int64.t option
 466                         = "llvm_int64_of_const"
 467 external const_int_of_string : lltype -> string -> int -> llvalue
 468                              = "llvm_const_int_of_string"
 469 external const_float : lltype -> float -> llvalue = "llvm_const_float"
 470 external float_of_const : llvalue -> float option
 471                         = "llvm_float_of_const"
 472 external const_float_of_string : lltype -> string -> llvalue
 473                                = "llvm_const_float_of_string"
 474
 475 (*--... Operations on composite constants ..................................--*)
 476 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
 477 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
 478 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
 479 external const_struct : llcontext -> llvalue array -> llvalue
 480                       = "llvm_const_struct"
 481 external const_named_struct : lltype -> llvalue array -> llvalue
 482                       = "llvm_const_named_struct"
 483 external const_packed_struct : llcontext -> llvalue array -> llvalue
 484                              = "llvm_const_packed_struct"
 485 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
 486 external string_of_const : llvalue -> string option = "llvm_string_of_const"
 487 external const_element : llvalue -> int -> llvalue = "llvm_const_element"
 488
 489 (*--... Constant expressions ...............................................--*)
 490 external align_of : lltype -> llvalue = "LLVMAlignOf"
 491 external size_of : lltype -> llvalue = "LLVMSizeOf"
 492 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
 493 external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg"
 494 external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg"
 495 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
 496 external const_not : llvalue -> llvalue = "LLVMConstNot"
 497 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
 498 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
 499 external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd"
 500 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
 501 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
 502 external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub"
 503 external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub"
 504 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
 505 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
 506 external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul"
 507 external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul"
 508 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
 509 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
 510 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
 511 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
 512 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
 513 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
 514 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
 515 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
 516 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
 517 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
 518 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
 519 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
 520                     = "llvm_const_icmp"
 521 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
 522                     = "llvm_const_fcmp"
 523 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
 524 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
 525 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
 526 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
 527 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
 528                             = "llvm_const_in_bounds_gep"
 529 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
 530 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
 531 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
 532 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
 533 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
 534 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
 535 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
 536 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
 537 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
 538 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
 539 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
 540 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
 541 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
 542                              = "LLVMConstZExtOrBitCast"
 543 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
 544                              = "LLVMConstSExtOrBitCast"
 545 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
 546                               = "LLVMConstTruncOrBitCast"
 547 external const_pointercast : llvalue -> lltype -> llvalue
 548                            = "LLVMConstPointerCast"
 549 external const_intcast : llvalue -> lltype -> is_signed:bool -> llvalue
 550                        = "llvm_const_intcast"
 551 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
 552 external const_select : llvalue -> llvalue -> llvalue -> llvalue
 553                       = "LLVMConstSelect"
 554 external const_extractelement : llvalue -> llvalue -> llvalue
 555                               = "LLVMConstExtractElement"
 556 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
 557                              = "LLVMConstInsertElement"
 558 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
 559                              = "LLVMConstShuffleVector"
 560 external const_extractvalue : llvalue -> int array -> llvalue
 561                             = "llvm_const_extractvalue"
 562 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
 563                            = "llvm_const_insertvalue"
 564 external const_inline_asm : lltype -> string -> string -> bool -> bool ->
 565                             llvalue
 566                           = "llvm_const_inline_asm"
 567 external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress"
 568
 569 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
 570 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
 571 external is_declaration : llvalue -> bool = "llvm_is_declaration"
 572 external linkage : llvalue -> Linkage.t = "llvm_linkage"
 573 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
 574 external section : llvalue -> string = "llvm_section"
 575 external set_section : string -> llvalue -> unit = "llvm_set_section"
 576 external visibility : llvalue -> Visibility.t = "llvm_visibility"
 577 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
 578 external alignment : llvalue -> int = "llvm_alignment"
 579 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
 580 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
 581 external set_global_constant : bool -> llvalue -> unit
 582                              = "llvm_set_global_constant"
 583
 584 (*--... Operations on global variables .....................................--*)
 585 external declare_global : lltype -> string -> llmodule -> llvalue
 586                         = "llvm_declare_global"
 587 external declare_qualified_global : lltype -> string -> int -> llmodule ->
 588                                     llvalue
 589                                   = "llvm_declare_qualified_global"
 590 external define_global : string -> llvalue -> llmodule -> llvalue
 591                        = "llvm_define_global"
 592 external define_qualified_global : string -> llvalue -> int -> llmodule ->
 593                                    llvalue
 594                                  = "llvm_define_qualified_global"
 595 external lookup_global : string -> llmodule -> llvalue option
 596                        = "llvm_lookup_global"
 597 external delete_global : llvalue -> unit = "llvm_delete_global"
 598 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
 599 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
 600 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
 601 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
 602 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
 603 external thread_local_mode : llvalue -> ThreadLocalMode.t
 604                            = "llvm_thread_local_mode"
 605 external set_thread_local_mode : ThreadLocalMode.t -> llvalue -> unit
 606                                = "llvm_set_thread_local_mode"
 607 external is_externally_initialized : llvalue -> bool
 608                                    = "llvm_is_externally_initialized"
 609 external set_externally_initialized : bool -> llvalue -> unit
 610                                     = "llvm_set_externally_initialized"
 611 external global_begin : llmodule -> (llmodule, llvalue) llpos
 612                       = "llvm_global_begin"
 613 external global_succ : llvalue -> (llmodule, llvalue) llpos
 614                      = "llvm_global_succ"
 615 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
 616                     = "llvm_global_end"
 617 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
 618                      = "llvm_global_pred"
 619
 620 let rec iter_global_range f i e =
 621   if i = e then () else
 622   match i with
 623   | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
 624   | Before bb ->
 625       f bb;
 626       iter_global_range f (global_succ bb) e
 627
 628 let iter_globals f m =
 629   iter_global_range f (global_begin m) (At_end m)
 630
 631 let rec fold_left_global_range f init i e =
 632   if i = e then init else
 633   match i with
 634   | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
 635   | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
 636
 637 let fold_left_globals f init m =
 638   fold_left_global_range f init (global_begin m) (At_end m)
 639
 640 let rec rev_iter_global_range f i e =
 641   if i = e then () else
 642   match i with
 643   | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
 644   | After bb ->
 645       f bb;
 646       rev_iter_global_range f (global_pred bb) e
 647
 648 let rev_iter_globals f m =
 649   rev_iter_global_range f (global_end m) (At_start m)
 650
 651 let rec fold_right_global_range f i e init =
 652   if i = e then init else
 653   match i with
 654   | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
 655   | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
 656
 657 let fold_right_globals f m init =
 658   fold_right_global_range f (global_end m) (At_start m) init
 659
 660 (*--... Operations on aliases ..............................................--*)
 661 external add_alias : llmodule -> lltype -> llvalue -> string -> llvalue
 662                    = "llvm_add_alias"
 663
 664 (*--... Operations on functions ............................................--*)
 665 external declare_function : string -> lltype -> llmodule -> llvalue
 666                           = "llvm_declare_function"
 667 external define_function : string -> lltype -> llmodule -> llvalue
 668                          = "llvm_define_function"
 669 external lookup_function : string -> llmodule -> llvalue option
 670                          = "llvm_lookup_function"
 671 external delete_function : llvalue -> unit = "llvm_delete_function"
 672 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
 673 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
 674 external set_function_call_conv : int -> llvalue -> unit
 675                                 = "llvm_set_function_call_conv"
 676 external gc : llvalue -> string option = "llvm_gc"
 677 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
 678 external function_begin : llmodule -> (llmodule, llvalue) llpos
 679                         = "llvm_function_begin"
 680 external function_succ : llvalue -> (llmodule, llvalue) llpos
 681                        = "llvm_function_succ"
 682 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
 683                       = "llvm_function_end"
 684 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
 685                        = "llvm_function_pred"
 686
 687 let rec iter_function_range f i e =
 688   if i = e then () else
 689   match i with
 690   | At_end _ -> raise (Invalid_argument "Invalid function range.")
 691   | Before fn ->
 692       f fn;
 693       iter_function_range f (function_succ fn) e
 694
 695 let iter_functions f m =
 696   iter_function_range f (function_begin m) (At_end m)
 697
 698 let rec fold_left_function_range f init i e =
 699   if i = e then init else
 700   match i with
 701   | At_end _ -> raise (Invalid_argument "Invalid function range.")
 702   | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
 703
 704 let fold_left_functions f init m =
 705   fold_left_function_range f init (function_begin m) (At_end m)
 706
 707 let rec rev_iter_function_range f i e =
 708   if i = e then () else
 709   match i with
 710   | At_start _ -> raise (Invalid_argument "Invalid function range.")
 711   | After fn ->
 712       f fn;
 713       rev_iter_function_range f (function_pred fn) e
 714
 715 let rev_iter_functions f m =
 716   rev_iter_function_range f (function_end m) (At_start m)
 717
 718 let rec fold_right_function_range f i e init =
 719   if i = e then init else
 720   match i with
 721   | At_start _ -> raise (Invalid_argument "Invalid function range.")
 722   | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
 723
 724 let fold_right_functions f m init =
 725   fold_right_function_range f (function_end m) (At_start m) init
 726
 727 external llvm_add_function_attr : llvalue -> int32 -> unit
 728                                 = "llvm_add_function_attr"
 729 external llvm_remove_function_attr : llvalue -> int32 -> unit
 730                                    = "llvm_remove_function_attr"
 731 external llvm_function_attr : llvalue -> int32 = "llvm_function_attr"
 732
 733 let pack_attr (attr:Attribute.t) : int32 =
 734   match attr with
 735   Attribute.Zext                  -> Int32.shift_left 1l 0
 736     | Attribute.Sext              -> Int32.shift_left 1l 1
 737     | Attribute.Noreturn          -> Int32.shift_left 1l 2
 738     | Attribute.Inreg             -> Int32.shift_left 1l 3
 739     | Attribute.Structret         -> Int32.shift_left 1l 4
 740     | Attribute.Nounwind          -> Int32.shift_left 1l 5
 741     | Attribute.Noalias           -> Int32.shift_left 1l 6
 742     | Attribute.Byval             -> Int32.shift_left 1l 7
 743     | Attribute.Nest              -> Int32.shift_left 1l 8
 744     | Attribute.Readnone          -> Int32.shift_left 1l 9
 745     | Attribute.Readonly          -> Int32.shift_left 1l 10
 746     | Attribute.Noinline          -> Int32.shift_left 1l 11
 747     | Attribute.Alwaysinline      -> Int32.shift_left 1l 12
 748     | Attribute.Optsize           -> Int32.shift_left 1l 13
 749     | Attribute.Ssp               -> Int32.shift_left 1l 14
 750     | Attribute.Sspreq            -> Int32.shift_left 1l 15
 751     | Attribute.Alignment n       -> Int32.shift_left (Int32.of_int n) 16
 752     | Attribute.Nocapture         -> Int32.shift_left 1l 21
 753     | Attribute.Noredzone         -> Int32.shift_left 1l 22
 754     | Attribute.Noimplicitfloat   -> Int32.shift_left 1l 23
 755     | Attribute.Naked             -> Int32.shift_left 1l 24
 756     | Attribute.Inlinehint        -> Int32.shift_left 1l 25
 757     | Attribute.Stackalignment n  -> Int32.shift_left (Int32.of_int n) 26
 758     | Attribute.ReturnsTwice      -> Int32.shift_left 1l 29
 759     | Attribute.UWTable           -> Int32.shift_left 1l 30
 760     | Attribute.NonLazyBind       -> Int32.shift_left 1l 31
 761
 762 let unpack_attr (a : int32) : Attribute.t list =
 763   let l = ref [] in
 764   let check attr =
 765       Int32.logand (pack_attr attr) a in
 766   let checkattr attr =
 767       if (check attr) <> 0l then begin
 768           l := attr :: !l
 769       end
 770   in
 771   checkattr Attribute.Zext;
 772   checkattr Attribute.Sext;
 773   checkattr Attribute.Noreturn;
 774   checkattr Attribute.Inreg;
 775   checkattr Attribute.Structret;
 776   checkattr Attribute.Nounwind;
 777   checkattr Attribute.Noalias;
 778   checkattr Attribute.Byval;
 779   checkattr Attribute.Nest;
 780   checkattr Attribute.Readnone;
 781   checkattr Attribute.Readonly;
 782   checkattr Attribute.Noinline;
 783   checkattr Attribute.Alwaysinline;
 784   checkattr Attribute.Optsize;
 785   checkattr Attribute.Ssp;
 786   checkattr Attribute.Sspreq;
 787   let align = Int32.logand (Int32.shift_right_logical a 16) 31l in
 788   if align <> 0l then
 789       l := Attribute.Alignment (Int32.to_int align) :: !l;
 790   checkattr Attribute.Nocapture;
 791   checkattr Attribute.Noredzone;
 792   checkattr Attribute.Noimplicitfloat;
 793   checkattr Attribute.Naked;
 794   checkattr Attribute.Inlinehint;
 795   let stackalign = Int32.logand (Int32.shift_right_logical a 26) 7l in
 796   if stackalign <> 0l then
 797       l := Attribute.Stackalignment (Int32.to_int stackalign) :: !l;
 798   checkattr Attribute.ReturnsTwice;
 799   checkattr Attribute.UWTable;
 800   checkattr Attribute.NonLazyBind;
 801   !l;;
 802
 803 let add_function_attr llval attr =
 804   llvm_add_function_attr llval (pack_attr attr)
 805
 806 external add_target_dependent_function_attr
 807     : llvalue -> string -> string -> unit
 808     = "llvm_add_target_dependent_function_attr"
 809
 810 let remove_function_attr llval attr =
 811   llvm_remove_function_attr llval (pack_attr attr)
 812
 813 let function_attr f = unpack_attr (llvm_function_attr f)
 814
 815 (*--... Operations on params ...............................................--*)
 816 external params : llvalue -> llvalue array = "llvm_params"
 817 external param : llvalue -> int -> llvalue = "llvm_param"
 818 external llvm_param_attr : llvalue -> int32 = "llvm_param_attr"
 819 let param_attr p = unpack_attr (llvm_param_attr p)
 820 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
 821 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
 822 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
 823 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
 824 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
 825
 826 let rec iter_param_range f i e =
 827   if i = e then () else
 828   match i with
 829   | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
 830   | Before p ->
 831       f p;
 832       iter_param_range f (param_succ p) e
 833
 834 let iter_params f fn =
 835   iter_param_range f (param_begin fn) (At_end fn)
 836
 837 let rec fold_left_param_range f init i e =
 838   if i = e then init else
 839   match i with
 840   | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
 841   | Before p -> fold_left_param_range f (f init p) (param_succ p) e
 842
 843 let fold_left_params f init fn =
 844   fold_left_param_range f init (param_begin fn) (At_end fn)
 845
 846 let rec rev_iter_param_range f i e =
 847   if i = e then () else
 848   match i with
 849   | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
 850   | After p ->
 851       f p;
 852       rev_iter_param_range f (param_pred p) e
 853
 854 let rev_iter_params f fn =
 855   rev_iter_param_range f (param_end fn) (At_start fn)
 856
 857 let rec fold_right_param_range f init i e =
 858   if i = e then init else
 859   match i with
 860   | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
 861   | After p -> fold_right_param_range f (f p init) (param_pred p) e
 862
 863 let fold_right_params f fn init =
 864   fold_right_param_range f init (param_end fn) (At_start fn)
 865
 866 external llvm_add_param_attr : llvalue -> int32 -> unit
 867                                 = "llvm_add_param_attr"
 868 external llvm_remove_param_attr : llvalue -> int32 -> unit
 869                                 = "llvm_remove_param_attr"
 870
 871 let add_param_attr llval attr =
 872   llvm_add_param_attr llval (pack_attr attr)
 873
 874 let remove_param_attr llval attr =
 875   llvm_remove_param_attr llval (pack_attr attr)
 876
 877 external set_param_alignment : llvalue -> int -> unit
 878                              = "llvm_set_param_alignment"
 879
 880 (*--... Operations on basic blocks .........................................--*)
 881 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
 882 external value_is_block : llvalue -> bool = "llvm_value_is_block"
 883 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
 884 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
 885 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
 886 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
 887 external delete_block : llbasicblock -> unit = "llvm_delete_block"
 888 external remove_block : llbasicblock -> unit = "llvm_remove_block"
 889 external move_block_before : llbasicblock -> llbasicblock -> unit
 890                            = "llvm_move_block_before"
 891 external move_block_after : llbasicblock -> llbasicblock -> unit
 892                           = "llvm_move_block_after"
 893 external append_block : llcontext -> string -> llvalue -> llbasicblock
 894                       = "llvm_append_block"
 895 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
 896                       = "llvm_insert_block"
 897 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
 898                      = "llvm_block_begin"
 899 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
 900                     = "llvm_block_succ"
 901 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
 902                    = "llvm_block_end"
 903 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
 904                     = "llvm_block_pred"
 905 external block_terminator : llbasicblock -> llvalue option =
 906     "llvm_block_terminator"
 907
 908 let rec iter_block_range f i e =
 909   if i = e then () else
 910   match i with
 911   | At_end _ -> raise (Invalid_argument "Invalid block range.")
 912   | Before bb ->
 913       f bb;
 914       iter_block_range f (block_succ bb) e
 915
 916 let iter_blocks f fn =
 917   iter_block_range f (block_begin fn) (At_end fn)
 918
 919 let rec fold_left_block_range f init i e =
 920   if i = e then init else
 921   match i with
 922   | At_end _ -> raise (Invalid_argument "Invalid block range.")
 923   | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
 924
 925 let fold_left_blocks f init fn =
 926   fold_left_block_range f init (block_begin fn) (At_end fn)
 927
 928 let rec rev_iter_block_range f i e =
 929   if i = e then () else
 930   match i with
 931   | At_start _ -> raise (Invalid_argument "Invalid block range.")
 932   | After bb ->
 933       f bb;
 934       rev_iter_block_range f (block_pred bb) e
 935
 936 let rev_iter_blocks f fn =
 937   rev_iter_block_range f (block_end fn) (At_start fn)
 938
 939 let rec fold_right_block_range f init i e =
 940   if i = e then init else
 941   match i with
 942   | At_start _ -> raise (Invalid_argument "Invalid block range.")
 943   | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
 944
 945 let fold_right_blocks f fn init =
 946   fold_right_block_range f init (block_end fn) (At_start fn)
 947
 948 (*--... Operations on instructions .........................................--*)
 949 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
 950 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
 951                      = "llvm_instr_begin"
 952 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
 953                      = "llvm_instr_succ"
 954 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
 955                      = "llvm_instr_end"
 956 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
 957                      = "llvm_instr_pred"
 958
 959 external instr_opcode : llvalue -> Opcode.t = "llvm_instr_get_opcode"
 960 external icmp_predicate : llvalue -> Icmp.t option = "llvm_instr_icmp_predicate"
 961 external fcmp_predicate : llvalue -> Fcmp.t option = "llvm_instr_fcmp_predicate"
 962 external instr_clone : llvalue -> llvalue = "llvm_instr_clone"
 963
 964 let rec iter_instrs_range f i e =
 965   if i = e then () else
 966   match i with
 967   | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
 968   | Before i ->
 969       f i;
 970       iter_instrs_range f (instr_succ i) e
 971
 972 let iter_instrs f bb =
 973   iter_instrs_range f (instr_begin bb) (At_end bb)
 974
 975 let rec fold_left_instrs_range f init i e =
 976   if i = e then init else
 977   match i with
 978   | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
 979   | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
 980
 981 let fold_left_instrs f init bb =
 982   fold_left_instrs_range f init (instr_begin bb) (At_end bb)
 983
 984 let rec rev_iter_instrs_range f i e =
 985   if i = e then () else
 986   match i with
 987   | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
 988   | After i ->
 989       f i;
 990       rev_iter_instrs_range f (instr_pred i) e
 991
 992 let rev_iter_instrs f bb =
 993   rev_iter_instrs_range f (instr_end bb) (At_start bb)
 994
 995 let rec fold_right_instr_range f i e init =
 996   if i = e then init else
 997   match i with
 998   | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
 999   | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
1000
1001 let fold_right_instrs f bb init =
1002   fold_right_instr_range f (instr_end bb) (At_start bb) init
1003
1004
1005 (*--... Operations on call sites ...........................................--*)
1006 external instruction_call_conv: llvalue -> int
1007                               = "llvm_instruction_call_conv"
1008 external set_instruction_call_conv: int -> llvalue -> unit
1009                                   = "llvm_set_instruction_call_conv"
1010
1011 external llvm_add_instruction_param_attr : llvalue -> int -> int32 -> unit
1012                                          = "llvm_add_instruction_param_attr"
1013 external llvm_remove_instruction_param_attr : llvalue -> int -> int32 -> unit
1014                                          = "llvm_remove_instruction_param_attr"
1015
1016 let add_instruction_param_attr llval i attr =
1017   llvm_add_instruction_param_attr llval i (pack_attr attr)
1018
1019 let remove_instruction_param_attr llval i attr =
1020   llvm_remove_instruction_param_attr llval i (pack_attr attr)
1021
1022 (*--... Operations on call instructions (only) .............................--*)
1023 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
1024 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
1025
1026 (*--... Operations on load/store instructions (only) .......................--*)
1027 external is_volatile : llvalue -> bool = "llvm_is_volatile"
1028 external set_volatile : bool -> llvalue -> unit = "llvm_set_volatile"
1029
1030 (*--... Operations on terminators ..........................................--*)
1031
1032 let is_terminator llv =
1033   let open ValueKind in
1034   let open Opcode in
1035   match classify_value llv with
1036     | Instruction (Br | IndirectBr | Invoke | Resume | Ret | Switch | Unreachable)
1037       -> true
1038     | _ -> false
1039
1040 external successor : llvalue -> int -> llbasicblock = "llvm_successor"
1041 external set_successor : llvalue -> int -> llbasicblock -> unit
1042                        = "llvm_set_successor"
1043 external num_successors : llvalue -> int = "llvm_num_successors"
1044
1045 let successors llv =
1046   if not (is_terminator llv) then
1047     raise (Invalid_argument "Llvm.successors can only be used on terminators")
1048   else
1049     Array.init (num_successors llv) (successor llv)
1050
1051 let iter_successors f llv =
1052   if not (is_terminator llv) then
1053     raise (Invalid_argument "Llvm.iter_successors can only be used on terminators")
1054   else
1055     for i = 0 to num_successors llv - 1 do
1056       f (successor llv i)
1057     done
1058
1059 let fold_successors f llv z =
1060   if not (is_terminator llv) then
1061     raise (Invalid_argument "Llvm.fold_successors can only be used on terminators")
1062   else
1063     let n = num_successors llv in
1064     let rec aux i acc =
1065       if i >= n then acc
1066       else begin
1067         let llb = successor llv i in
1068         aux (i+1) (f llb acc)
1069       end
1070     in aux 0 z
1071
1072
1073 (*--... Operations on branches .............................................--*)
1074 external condition : llvalue -> llvalue = "llvm_condition"
1075 external set_condition : llvalue -> llvalue -> unit
1076                        = "llvm_set_condition"
1077 external is_conditional : llvalue -> bool = "llvm_is_conditional"
1078
1079 let get_branch llv =
1080   if classify_value llv <> ValueKind.Instruction Opcode.Br then
1081     None
1082   else if is_conditional llv then
1083     Some (`Conditional (condition llv, successor llv 0, successor llv 1))
1084   else
1085     Some (`Unconditional (successor llv 0))
1086
1087 (*--... Operations on phi nodes ............................................--*)
1088 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
1089                       = "llvm_add_incoming"
1090 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
1091
1092 external delete_instruction : llvalue -> unit = "llvm_delete_instruction"
1093
1094 (*===-- Instruction builders ----------------------------------------------===*)
1095 external builder : llcontext -> llbuilder = "llvm_builder"
1096 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
1097                           = "llvm_position_builder"
1098 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
1099 external insert_into_builder : llvalue -> string -> llbuilder -> unit
1100                              = "llvm_insert_into_builder"
1101
1102 let builder_at context ip =
1103   let b = builder context in
1104   position_builder ip b;
1105   b
1106
1107 let builder_before context i = builder_at context (Before i)
1108 let builder_at_end context bb = builder_at context (At_end bb)
1109
1110 let position_before i = position_builder (Before i)
1111 let position_at_end bb = position_builder (At_end bb)
1112
1113
1114 (*--... Metadata ...........................................................--*)
1115 external set_current_debug_location : llbuilder -> llvalue -> unit
1116                                     = "llvm_set_current_debug_location"
1117 external clear_current_debug_location : llbuilder -> unit
1118                                       = "llvm_clear_current_debug_location"
1119 external current_debug_location : llbuilder -> llvalue option
1120                                     = "llvm_current_debug_location"
1121 external set_inst_debug_location : llbuilder -> llvalue -> unit
1122                                  = "llvm_set_inst_debug_location"
1123
1124
1125 (*--... Terminators ........................................................--*)
1126 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
1127 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
1128 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
1129                              = "llvm_build_aggregate_ret"
1130 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
1131 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
1132                          llvalue = "llvm_build_cond_br"
1133 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
1134                       = "llvm_build_switch"
1135 external build_malloc : lltype -> string -> llbuilder -> llvalue =
1136     "llvm_build_malloc"
1137 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
1138     llvalue = "llvm_build_array_malloc"
1139 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
1140 external add_case : llvalue -> llvalue -> llbasicblock -> unit
1141                   = "llvm_add_case"
1142 external switch_default_dest : llvalue -> llbasicblock =
1143     "LLVMGetSwitchDefaultDest"
1144 external build_indirect_br : llvalue -> int -> llbuilder -> llvalue
1145                            = "llvm_build_indirect_br"
1146 external add_destination : llvalue -> llbasicblock -> unit
1147                          = "llvm_add_destination"
1148 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
1149                         llbasicblock -> string -> llbuilder -> llvalue
1150                       = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
1151 external build_landingpad : lltype -> llvalue -> int -> string -> llbuilder ->
1152                             llvalue = "llvm_build_landingpad"
1153 external set_cleanup : llvalue -> bool -> unit = "llvm_set_cleanup"
1154 external add_clause : llvalue -> llvalue -> unit = "llvm_add_clause"
1155 external build_resume : llvalue -> llbuilder -> llvalue = "llvm_build_resume"
1156 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
1157
1158 (*--... Arithmetic .........................................................--*)
1159 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
1160                    = "llvm_build_add"
1161 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
1162                        = "llvm_build_nsw_add"
1163 external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
1164                        = "llvm_build_nuw_add"
1165 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
1166                     = "llvm_build_fadd"
1167 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1168                    = "llvm_build_sub"
1169 external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1170                        = "llvm_build_nsw_sub"
1171 external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1172                        = "llvm_build_nuw_sub"
1173 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1174                     = "llvm_build_fsub"
1175 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1176                    = "llvm_build_mul"
1177 external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1178                        = "llvm_build_nsw_mul"
1179 external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1180                        = "llvm_build_nuw_mul"
1181 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1182                     = "llvm_build_fmul"
1183 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1184                     = "llvm_build_udiv"
1185 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1186                     = "llvm_build_sdiv"
1187 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1188                           = "llvm_build_exact_sdiv"
1189 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1190                     = "llvm_build_fdiv"
1191 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
1192                     = "llvm_build_urem"
1193 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
1194                     = "llvm_build_srem"
1195 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
1196                     = "llvm_build_frem"
1197 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
1198                    = "llvm_build_shl"
1199 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
1200                     = "llvm_build_lshr"
1201 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
1202                     = "llvm_build_ashr"
1203 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
1204                    = "llvm_build_and"
1205 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
1206                   = "llvm_build_or"
1207 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
1208                    = "llvm_build_xor"
1209 external build_neg : llvalue -> string -> llbuilder -> llvalue
1210                    = "llvm_build_neg"
1211 external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
1212                        = "llvm_build_nsw_neg"
1213 external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
1214                        = "llvm_build_nuw_neg"
1215 external build_fneg : llvalue -> string -> llbuilder -> llvalue
1216                     = "llvm_build_fneg"
1217 external build_not : llvalue -> string -> llbuilder -> llvalue
1218                    = "llvm_build_not"
1219
1220 (*--... Memory .............................................................--*)
1221 external build_alloca : lltype -> string -> llbuilder -> llvalue
1222                       = "llvm_build_alloca"
1223 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
1224                               llvalue = "llvm_build_array_alloca"
1225 external build_load : llvalue -> string -> llbuilder -> llvalue
1226                     = "llvm_build_load"
1227 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
1228                      = "llvm_build_store"
1229 external build_atomicrmw : AtomicRMWBinOp.t -> llvalue -> llvalue ->
1230                            AtomicOrdering.t -> bool -> string -> llbuilder ->
1231                            llvalue
1232                          = "llvm_build_atomicrmw_bytecode"
1233                            "llvm_build_atomicrmw_native"
1234 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
1235                    = "llvm_build_gep"
1236 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
1237                              llbuilder -> llvalue = "llvm_build_in_bounds_gep"
1238 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
1239                          = "llvm_build_struct_gep"
1240
1241 external build_global_string : string -> string -> llbuilder -> llvalue
1242                              = "llvm_build_global_string"
1243 external build_global_stringptr  : string -> string -> llbuilder -> llvalue
1244                                  = "llvm_build_global_stringptr"
1245
1246 (*--... Casts ..............................................................--*)
1247 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
1248                      = "llvm_build_trunc"
1249 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
1250                     = "llvm_build_zext"
1251 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
1252                     = "llvm_build_sext"
1253 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
1254                       = "llvm_build_fptoui"
1255 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
1256                       = "llvm_build_fptosi"
1257 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
1258                       = "llvm_build_uitofp"
1259 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
1260                       = "llvm_build_sitofp"
1261 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
1262                        = "llvm_build_fptrunc"
1263 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
1264                      = "llvm_build_fpext"
1265 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
1266                         = "llvm_build_prttoint"
1267 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
1268                         = "llvm_build_inttoptr"
1269 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1270                        = "llvm_build_bitcast"
1271 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1272                                  llvalue = "llvm_build_zext_or_bitcast"
1273 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1274                                  llvalue = "llvm_build_sext_or_bitcast"
1275 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1276                                   llvalue = "llvm_build_trunc_or_bitcast"
1277 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
1278                            = "llvm_build_pointercast"
1279 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1280                        = "llvm_build_intcast"
1281 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1282                       = "llvm_build_fpcast"
1283
1284 (*--... Comparisons ........................................................--*)
1285 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
1286                       llbuilder -> llvalue = "llvm_build_icmp"
1287 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
1288                       llbuilder -> llvalue = "llvm_build_fcmp"
1289
1290 (*--... Miscellaneous instructions .........................................--*)
1291 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
1292                      llvalue = "llvm_build_phi"
1293 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
1294                     = "llvm_build_call"
1295 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
1296                         llvalue = "llvm_build_select"
1297 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
1298                       = "llvm_build_va_arg"
1299 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
1300                                 llvalue = "llvm_build_extractelement"
1301 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
1302                                llbuilder -> llvalue = "llvm_build_insertelement"
1303 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
1304                                llbuilder -> llvalue = "llvm_build_shufflevector"
1305 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
1306                             = "llvm_build_extractvalue"
1307 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
1308                              llvalue = "llvm_build_insertvalue"
1309
1310 external build_is_null : llvalue -> string -> llbuilder -> llvalue
1311                        = "llvm_build_is_null"
1312 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
1313                            = "llvm_build_is_not_null"
1314 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
1315                        = "llvm_build_ptrdiff"
1316
1317
1318 (*===-- Memory buffers ----------------------------------------------------===*)
1319
1320 module MemoryBuffer = struct
1321   external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
1322   external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
1323   external of_string : ?name:string -> string -> llmemorybuffer
1324                      = "llvm_memorybuffer_of_string"
1325   external as_string : llmemorybuffer -> string = "llvm_memorybuffer_as_string"
1326   external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
1327 end
1328
1329
1330 (*===-- Pass Manager ------------------------------------------------------===*)
1331
1332 module PassManager = struct
1333   type 'a t
1334   type any = [ `Module | `Function ]
1335   external create : unit -> [ `Module ] t = "llvm_passmanager_create"
1336   external create_function : llmodule -> [ `Function ] t
1337                            = "LLVMCreateFunctionPassManager"
1338   external run_module : llmodule -> [ `Module ] t -> bool
1339                       = "llvm_passmanager_run_module"
1340   external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
1341   external run_function : llvalue -> [ `Function ] t -> bool
1342                         = "llvm_passmanager_run_function"
1343   external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
1344   external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
1345 end