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 lltypehandle
  15 type llvalue
  16 type llbasicblock
  17 type llbuilder
  18 type llmoduleprovider
  19 type llmemorybuffer
  20
  21 module TypeKind = struct
  22   type t =
  23   | Void
  24   | Float
  25   | Double
  26   | X86fp80
  27   | Fp128
  28   | Ppc_fp128
  29   | Label
  30   | Integer
  31   | Function
  32   | Struct
  33   | Array
  34   | Pointer
  35   | Opaque
  36   | Vector
  37   | Metadata
  38 end
  39
  40 module Linkage = struct
  41   type t =
  42   | External
  43   | Available_externally
  44   | Link_once
  45   | Weak
  46   | Appending
  47   | Internal
  48   | Dllimport
  49   | Dllexport
  50   | External_weak
  51   | Ghost
  52 end
  53
  54 module Visibility = struct
  55   type t =
  56   | Default
  57   | Hidden
  58   | Protected
  59 end
  60
  61 module CallConv = struct
  62   let c = 0
  63   let fast = 8
  64   let cold = 9
  65   let x86_stdcall = 64
  66   let x86_fastcall = 65
  67 end
  68
  69 module Attribute = struct
  70   type t =
  71   | Zext
  72   | Sext
  73   | Noreturn
  74   | Inreg
  75   | Structret
  76   | Nounwind
  77   | Noalias
  78   | Byval
  79   | Nest
  80   | Readnone
  81   | Readonly
  82 end
  83
  84 module Icmp = struct
  85   type t =
  86   | Eq
  87   | Ne
  88   | Ugt
  89   | Uge
  90   | Ult
  91   | Ule
  92   | Sgt
  93   | Sge
  94   | Slt
  95   | Sle
  96 end
  97
  98 module Fcmp = struct
  99   type t =
 100   | False
 101   | Oeq
 102   | Ogt
 103   | Oge
 104   | Olt
 105   | Ole
 106   | One
 107   | Ord
 108   | Uno
 109   | Ueq
 110   | Ugt
 111   | Uge
 112   | Ult
 113   | Ule
 114   | Une
 115   | True
 116 end
 117
 118 exception IoError of string
 119
 120 external register_exns : exn -> unit = "llvm_register_core_exns"
 121 let _ = register_exns (IoError "")
 122
 123 type ('a, 'b) llpos =
 124 | At_end of 'a
 125 | Before of 'b
 126
 127 type ('a, 'b) llrev_pos =
 128 | At_start of 'a
 129 | After of 'b
 130
 131 (*===-- Contexts ----------------------------------------------------------===*)
 132 external create_context : unit -> llcontext = "llvm_create_context"
 133 external dispose_context : unit -> llcontext = "llvm_dispose_context"
 134 external global_context : unit -> llcontext = "llvm_global_context"
 135
 136 (*===-- Modules -----------------------------------------------------------===*)
 137 external create_module : llcontext -> string -> llmodule = "llvm_create_module"
 138 external dispose_module : llmodule -> unit = "llvm_dispose_module"
 139 external target_triple: llmodule -> string
 140                       = "llvm_target_triple"
 141 external set_target_triple: string -> llmodule -> unit
 142                           = "llvm_set_target_triple"
 143 external data_layout: llmodule -> string
 144                     = "llvm_data_layout"
 145 external set_data_layout: string -> llmodule -> unit
 146                         = "llvm_set_data_layout"
 147 external define_type_name : string -> lltype -> llmodule -> bool
 148                           = "llvm_add_type_name"
 149 external delete_type_name : string -> llmodule -> unit
 150                           = "llvm_delete_type_name"
 151 external dump_module : llmodule -> unit = "llvm_dump_module"
 152
 153 (*===-- Types -------------------------------------------------------------===*)
 154 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
 155 external type_context : lltype -> llcontext = "llvm_type_context"
 156
 157 (*--... Operations on integer types ........................................--*)
 158 external _i1_type : unit -> lltype = "llvm_i1_type"
 159 external _i8_type : unit -> lltype = "llvm_i8_type"
 160 external _i16_type : unit -> lltype = "llvm_i16_type"
 161 external _i32_type : unit -> lltype = "llvm_i32_type"
 162 external _i64_type : unit -> lltype = "llvm_i64_type"
 163
 164 let i1_type = _i1_type ()
 165 let i8_type = _i8_type ()
 166 let i16_type = _i16_type ()
 167 let i32_type = _i32_type ()
 168 let i64_type = _i64_type ()
 169
 170 external integer_type : int -> lltype = "llvm_integer_type"
 171 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
 172
 173 (*--... Operations on real types ...........................................--*)
 174 external _float_type : unit -> lltype = "llvm_float_type"
 175 external _double_type : unit -> lltype = "llvm_double_type"
 176 external _x86fp80_type : unit -> lltype = "llvm_x86fp80_type"
 177 external _fp128_type : unit -> lltype = "llvm_fp128_type"
 178 external _ppc_fp128_type : unit -> lltype = "llvm_ppc_fp128_type"
 179
 180 let float_type = _float_type ()
 181 let double_type = _double_type ()
 182 let x86fp80_type = _x86fp80_type ()
 183 let fp128_type = _fp128_type ()
 184 let ppc_fp128_type = _ppc_fp128_type ()
 185
 186 (*--... Operations on function types .......................................--*)
 187 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
 188 external var_arg_function_type : lltype -> lltype array -> lltype
 189                                = "llvm_var_arg_function_type"
 190 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
 191 external return_type : lltype -> lltype = "LLVMGetReturnType"
 192 external param_types : lltype -> lltype array = "llvm_param_types"
 193
 194 (*--... Operations on struct types .........................................--*)
 195 external struct_type : llcontext -> lltype array -> lltype = "llvm_struct_type"
 196 external packed_struct_type : llcontext -> lltype array -> lltype
 197                             = "llvm_packed_struct_type"
 198 external element_types : lltype -> lltype array = "llvm_element_types"
 199 external is_packed : lltype -> bool = "llvm_is_packed"
 200
 201 (*--... Operations on pointer, vector, and array types .....................--*)
 202 external array_type : lltype -> int -> lltype = "llvm_array_type"
 203 external pointer_type : lltype -> lltype = "llvm_pointer_type"
 204 external qualified_pointer_type : lltype -> int -> lltype
 205                                 = "llvm_qualified_pointer_type"
 206 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
 207
 208 external element_type : lltype -> lltype = "LLVMGetElementType"
 209 external array_length : lltype -> int = "llvm_array_length"
 210 external address_space : lltype -> int = "llvm_address_space"
 211 external vector_size : lltype -> int = "llvm_vector_size"
 212
 213 (*--... Operations on other types ..........................................--*)
 214 external opaque_type : unit -> lltype = "llvm_opaque_type"
 215 external _void_type : unit -> lltype = "llvm_void_type"
 216 external _label_type : unit -> lltype = "llvm_label_type"
 217
 218 let void_type = _void_type ()
 219 let label_type = _label_type ()
 220
 221 (*--... Operations on type handles .........................................--*)
 222 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
 223 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
 224 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
 225
 226
 227 (*===-- Values ------------------------------------------------------------===*)
 228 external type_of : llvalue -> lltype = "llvm_type_of"
 229 external value_name : llvalue -> string = "llvm_value_name"
 230 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
 231 external dump_value : llvalue -> unit = "llvm_dump_value"
 232
 233 (*--... Operations on constants of (mostly) any type .......................--*)
 234 external is_constant : llvalue -> bool = "llvm_is_constant"
 235 external const_null : lltype -> llvalue = "LLVMConstNull"
 236 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
 237 external undef : lltype -> llvalue = "LLVMGetUndef"
 238 external is_null : llvalue -> bool = "llvm_is_null"
 239 external is_undef : llvalue -> bool = "llvm_is_undef"
 240
 241 (*--... Operations on scalar constants .....................................--*)
 242 external const_int : lltype -> int -> llvalue = "llvm_const_int"
 243 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
 244                         = "llvm_const_of_int64"
 245 external const_int_of_string : lltype -> string -> int -> llvalue
 246                              = "llvm_const_int_of_string"
 247 external const_float : lltype -> float -> llvalue = "llvm_const_float"
 248 external const_float_of_string : lltype -> string -> llvalue
 249                                = "llvm_const_float_of_string"
 250
 251 (*--... Operations on composite constants ..................................--*)
 252 external const_string : string -> llvalue = "llvm_const_string"
 253 external const_stringz : string -> llvalue = "llvm_const_stringz"
 254 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
 255 external const_struct : llcontext -> llvalue array -> llvalue
 256                       = "llvm_const_struct"
 257 external const_packed_struct : llcontext -> llvalue array -> llvalue
 258                              = "llvm_const_packed_struct"
 259 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
 260
 261 (*--... Constant expressions ...............................................--*)
 262 external align_of : lltype -> llvalue = "LLVMAlignOf"
 263 external size_of : lltype -> llvalue = "LLVMSizeOf"
 264 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
 265 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
 266 external const_not : llvalue -> llvalue = "LLVMConstNot"
 267 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
 268 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
 269 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
 270 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
 271 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
 272 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
 273 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
 274 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
 275 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
 276 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
 277 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
 278 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
 279 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
 280 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
 281 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
 282 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
 283 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
 284 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
 285                     = "llvm_const_icmp"
 286 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
 287                     = "llvm_const_fcmp"
 288 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
 289 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
 290 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
 291 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
 292 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
 293                             = "llvm_const_in_bounds_gep"
 294 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
 295 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
 296 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
 297 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
 298 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
 299 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
 300 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
 301 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
 302 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
 303 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
 304 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
 305 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
 306 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
 307                              = "LLVMConstZExtOrBitCast"
 308 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
 309                              = "LLVMConstSExtOrBitCast"
 310 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
 311                               = "LLVMConstTruncOrBitCast"
 312 external const_pointercast : llvalue -> lltype -> llvalue
 313                            = "LLVMConstPointerCast"
 314 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
 315 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
 316 external const_select : llvalue -> llvalue -> llvalue -> llvalue
 317                       = "LLVMConstSelect"
 318 external const_extractelement : llvalue -> llvalue -> llvalue
 319                               = "LLVMConstExtractElement"
 320 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
 321                              = "LLVMConstInsertElement"
 322 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
 323                              = "LLVMConstShuffleVector"
 324 external const_extractvalue : llvalue -> int array -> llvalue
 325                             = "llvm_const_extractvalue"
 326 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
 327                            = "llvm_const_insertvalue"
 328
 329 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
 330 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
 331 external is_declaration : llvalue -> bool = "llvm_is_declaration"
 332 external linkage : llvalue -> Linkage.t = "llvm_linkage"
 333 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
 334 external section : llvalue -> string = "llvm_section"
 335 external set_section : string -> llvalue -> unit = "llvm_set_section"
 336 external visibility : llvalue -> Visibility.t = "llvm_visibility"
 337 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
 338 external alignment : llvalue -> int = "llvm_alignment"
 339 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
 340 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
 341 external set_global_constant : bool -> llvalue -> unit
 342                              = "llvm_set_global_constant"
 343
 344 (*--... Operations on global variables .....................................--*)
 345 external declare_global : lltype -> string -> llmodule -> llvalue
 346                         = "llvm_declare_global"
 347 external define_global : string -> llvalue -> llmodule -> llvalue
 348                        = "llvm_define_global"
 349 external lookup_global : string -> llmodule -> llvalue option
 350                        = "llvm_lookup_global"
 351 external delete_global : llvalue -> unit = "llvm_delete_global"
 352 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
 353 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
 354 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
 355 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
 356 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
 357 external global_begin : llmodule -> (llmodule, llvalue) llpos
 358                       = "llvm_global_begin"
 359 external global_succ : llvalue -> (llmodule, llvalue) llpos
 360                      = "llvm_global_succ"
 361 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
 362                     = "llvm_global_end"
 363 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
 364                      = "llvm_global_pred"
 365
 366 let rec iter_global_range f i e =
 367   if i = e then () else
 368   match i with
 369   | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
 370   | Before bb ->
 371       f bb;
 372       iter_global_range f (global_succ bb) e
 373
 374 let iter_globals f m =
 375   iter_global_range f (global_begin m) (At_end m)
 376
 377 let rec fold_left_global_range f init i e =
 378   if i = e then init else
 379   match i with
 380   | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
 381   | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
 382
 383 let fold_left_globals f init m =
 384   fold_left_global_range f init (global_begin m) (At_end m)
 385
 386 let rec rev_iter_global_range f i e =
 387   if i = e then () else
 388   match i with
 389   | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
 390   | After bb ->
 391       f bb;
 392       rev_iter_global_range f (global_pred bb) e
 393
 394 let rev_iter_globals f m =
 395   rev_iter_global_range f (global_end m) (At_start m)
 396
 397 let rec fold_right_global_range f i e init =
 398   if i = e then init else
 399   match i with
 400   | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
 401   | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
 402
 403 let fold_right_globals f m init =
 404   fold_right_global_range f (global_end m) (At_start m) init
 405
 406 (*--... Operations on functions ............................................--*)
 407 external declare_function : string -> lltype -> llmodule -> llvalue
 408                           = "llvm_declare_function"
 409 external define_function : string -> lltype -> llmodule -> llvalue
 410                          = "llvm_define_function"
 411 external lookup_function : string -> llmodule -> llvalue option
 412                          = "llvm_lookup_function"
 413 external delete_function : llvalue -> unit = "llvm_delete_function"
 414 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
 415 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
 416 external set_function_call_conv : int -> llvalue -> unit
 417                                 = "llvm_set_function_call_conv"
 418 external gc : llvalue -> string option = "llvm_gc"
 419 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
 420 external function_begin : llmodule -> (llmodule, llvalue) llpos
 421                         = "llvm_function_begin"
 422 external function_succ : llvalue -> (llmodule, llvalue) llpos
 423                        = "llvm_function_succ"
 424 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
 425                       = "llvm_function_end"
 426 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
 427                        = "llvm_function_pred"
 428
 429 let rec iter_function_range f i e =
 430   if i = e then () else
 431   match i with
 432   | At_end _ -> raise (Invalid_argument "Invalid function range.")
 433   | Before fn ->
 434       f fn;
 435       iter_function_range f (function_succ fn) e
 436
 437 let iter_functions f m =
 438   iter_function_range f (function_begin m) (At_end m)
 439
 440 let rec fold_left_function_range f init i e =
 441   if i = e then init else
 442   match i with
 443   | At_end _ -> raise (Invalid_argument "Invalid function range.")
 444   | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
 445
 446 let fold_left_functions f init m =
 447   fold_left_function_range f init (function_begin m) (At_end m)
 448
 449 let rec rev_iter_function_range f i e =
 450   if i = e then () else
 451   match i with
 452   | At_start _ -> raise (Invalid_argument "Invalid function range.")
 453   | After fn ->
 454       f fn;
 455       rev_iter_function_range f (function_pred fn) e
 456
 457 let rev_iter_functions f m =
 458   rev_iter_function_range f (function_end m) (At_start m)
 459
 460 let rec fold_right_function_range f i e init =
 461   if i = e then init else
 462   match i with
 463   | At_start _ -> raise (Invalid_argument "Invalid function range.")
 464   | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
 465
 466 let fold_right_functions f m init =
 467   fold_right_function_range f (function_end m) (At_start m) init
 468
 469 external add_function_attr : llvalue -> Attribute.t -> unit
 470                            = "llvm_add_function_attr"
 471 external remove_function_attr : llvalue -> Attribute.t -> unit
 472                               = "llvm_remove_function_attr"
 473
 474 (*--... Operations on params ...............................................--*)
 475 external params : llvalue -> llvalue array = "llvm_params"
 476 external param : llvalue -> int -> llvalue = "llvm_param"
 477 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
 478 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
 479 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
 480 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
 481 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
 482
 483 let rec iter_param_range f i e =
 484   if i = e then () else
 485   match i with
 486   | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
 487   | Before p ->
 488       f p;
 489       iter_param_range f (param_succ p) e
 490
 491 let iter_params f fn =
 492   iter_param_range f (param_begin fn) (At_end fn)
 493
 494 let rec fold_left_param_range f init i e =
 495   if i = e then init else
 496   match i with
 497   | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
 498   | Before p -> fold_left_param_range f (f init p) (param_succ p) e
 499
 500 let fold_left_params f init fn =
 501   fold_left_param_range f init (param_begin fn) (At_end fn)
 502
 503 let rec rev_iter_param_range f i e =
 504   if i = e then () else
 505   match i with
 506   | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
 507   | After p ->
 508       f p;
 509       rev_iter_param_range f (param_pred p) e
 510
 511 let rev_iter_params f fn =
 512   rev_iter_param_range f (param_end fn) (At_start fn)
 513
 514 let rec fold_right_param_range f init i e =
 515   if i = e then init else
 516   match i with
 517   | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
 518   | After p -> fold_right_param_range f (f p init) (param_pred p) e
 519
 520 let fold_right_params f fn init =
 521   fold_right_param_range f init (param_end fn) (At_start fn)
 522
 523 external add_param_attr : llvalue -> Attribute.t -> unit
 524                         = "llvm_add_param_attr"
 525 external remove_param_attr : llvalue -> Attribute.t -> unit
 526                            = "llvm_remove_param_attr"
 527 external set_param_alignment : llvalue -> int -> unit
 528                              = "llvm_set_param_alignment"
 529
 530 (*--... Operations on basic blocks .........................................--*)
 531 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
 532 external value_is_block : llvalue -> bool = "llvm_value_is_block"
 533 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
 534 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
 535 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
 536 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
 537 external delete_block : llbasicblock -> unit = "llvm_delete_block"
 538 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
 539 external insert_block : string -> llbasicblock -> llbasicblock
 540                       = "llvm_insert_block"
 541 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
 542                      = "llvm_block_begin"
 543 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
 544                     = "llvm_block_succ"
 545 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
 546                    = "llvm_block_end"
 547 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
 548                     = "llvm_block_pred"
 549
 550 let rec iter_block_range f i e =
 551   if i = e then () else
 552   match i with
 553   | At_end _ -> raise (Invalid_argument "Invalid block range.")
 554   | Before bb ->
 555       f bb;
 556       iter_block_range f (block_succ bb) e
 557
 558 let iter_blocks f fn =
 559   iter_block_range f (block_begin fn) (At_end fn)
 560
 561 let rec fold_left_block_range f init i e =
 562   if i = e then init else
 563   match i with
 564   | At_end _ -> raise (Invalid_argument "Invalid block range.")
 565   | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
 566
 567 let fold_left_blocks f init fn =
 568   fold_left_block_range f init (block_begin fn) (At_end fn)
 569
 570 let rec rev_iter_block_range f i e =
 571   if i = e then () else
 572   match i with
 573   | At_start _ -> raise (Invalid_argument "Invalid block range.")
 574   | After bb ->
 575       f bb;
 576       rev_iter_block_range f (block_pred bb) e
 577
 578 let rev_iter_blocks f fn =
 579   rev_iter_block_range f (block_end fn) (At_start fn)
 580
 581 let rec fold_right_block_range f init i e =
 582   if i = e then init else
 583   match i with
 584   | At_start _ -> raise (Invalid_argument "Invalid block range.")
 585   | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
 586
 587 let fold_right_blocks f fn init =
 588   fold_right_block_range f init (block_end fn) (At_start fn)
 589
 590 (*--... Operations on instructions .........................................--*)
 591 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
 592 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
 593                      = "llvm_instr_begin"
 594 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
 595                      = "llvm_instr_succ"
 596 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
 597                      = "llvm_instr_end"
 598 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
 599                      = "llvm_instr_pred"
 600
 601 let rec iter_instrs_range f i e =
 602   if i = e then () else
 603   match i with
 604   | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
 605   | Before i ->
 606       f i;
 607       iter_instrs_range f (instr_succ i) e
 608
 609 let iter_instrs f bb =
 610   iter_instrs_range f (instr_begin bb) (At_end bb)
 611
 612 let rec fold_left_instrs_range f init i e =
 613   if i = e then init else
 614   match i with
 615   | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
 616   | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
 617
 618 let fold_left_instrs f init bb =
 619   fold_left_instrs_range f init (instr_begin bb) (At_end bb)
 620
 621 let rec rev_iter_instrs_range f i e =
 622   if i = e then () else
 623   match i with
 624   | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
 625   | After i ->
 626       f i;
 627       rev_iter_instrs_range f (instr_pred i) e
 628
 629 let rev_iter_instrs f bb =
 630   rev_iter_instrs_range f (instr_end bb) (At_start bb)
 631
 632 let rec fold_right_instr_range f i e init =
 633   if i = e then init else
 634   match i with
 635   | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
 636   | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
 637
 638 let fold_right_instrs f bb init =
 639   fold_right_instr_range f (instr_end bb) (At_start bb) init
 640
 641
 642 (*--... Operations on call sites ...........................................--*)
 643 external instruction_call_conv: llvalue -> int
 644                               = "llvm_instruction_call_conv"
 645 external set_instruction_call_conv: int -> llvalue -> unit
 646                                   = "llvm_set_instruction_call_conv"
 647 external add_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
 648                                     = "llvm_add_instruction_param_attr"
 649 external remove_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
 650                                        = "llvm_remove_instruction_param_attr"
 651
 652 (*--... Operations on call instructions (only) .............................--*)
 653 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
 654 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
 655
 656 (*--... Operations on phi nodes ............................................--*)
 657 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
 658                       = "llvm_add_incoming"
 659 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
 660
 661
 662 (*===-- Instruction builders ----------------------------------------------===*)
 663 external builder : llcontext -> llbuilder = "llvm_builder"
 664 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
 665                           = "llvm_position_builder"
 666 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
 667 external insert_into_builder : llvalue -> string -> llbuilder -> unit
 668                              = "llvm_insert_into_builder"
 669
 670 let builder_at context ip =
 671   let b = builder context in
 672   position_builder ip b;
 673   b
 674
 675 let builder_before context i = builder_at context (Before i)
 676 let builder_at_end context bb = builder_at context (At_end bb)
 677
 678 let position_before i = position_builder (Before i)
 679 let position_at_end bb = position_builder (At_end bb)
 680
 681
 682 (*--... Terminators ........................................................--*)
 683 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
 684 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
 685 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
 686                              = "llvm_build_aggregate_ret"
 687 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
 688 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
 689                          llvalue = "llvm_build_cond_br"
 690 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
 691                       = "llvm_build_switch"
 692 external add_case : llvalue -> llvalue -> llbasicblock -> unit
 693                   = "llvm_add_case"
 694 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
 695                         llbasicblock -> string -> llbuilder -> llvalue
 696                       = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
 697 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
 698 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
 699
 700 (*--... Arithmetic .........................................................--*)
 701 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
 702                    = "llvm_build_add"
 703 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
 704                        = "llvm_build_nsw_add"
 705 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
 706                     = "llvm_build_fadd"
 707 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
 708                    = "llvm_build_sub"
 709 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
 710                     = "llvm_build_fsub"
 711 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
 712                    = "llvm_build_mul"
 713 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
 714                     = "llvm_build_fmul"
 715 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
 716                     = "llvm_build_udiv"
 717 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
 718                     = "llvm_build_sdiv"
 719 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
 720                           = "llvm_build_exact_sdiv"
 721 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
 722                     = "llvm_build_fdiv"
 723 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
 724                     = "llvm_build_urem"
 725 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
 726                     = "llvm_build_srem"
 727 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
 728                     = "llvm_build_frem"
 729 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
 730                    = "llvm_build_shl"
 731 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
 732                     = "llvm_build_lshr"
 733 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
 734                     = "llvm_build_ashr"
 735 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
 736                    = "llvm_build_and"
 737 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
 738                   = "llvm_build_or"
 739 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
 740                    = "llvm_build_xor"
 741 external build_neg : llvalue -> string -> llbuilder -> llvalue
 742                    = "llvm_build_neg"
 743 external build_not : llvalue -> string -> llbuilder -> llvalue
 744                    = "llvm_build_not"
 745
 746 (*--... Memory .............................................................--*)
 747 external build_malloc : lltype -> string -> llbuilder -> llvalue
 748                       = "llvm_build_malloc"
 749 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
 750                               llvalue = "llvm_build_array_malloc"
 751 external build_alloca : lltype -> string -> llbuilder -> llvalue
 752                       = "llvm_build_alloca"
 753 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
 754                               llvalue = "llvm_build_array_alloca"
 755 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
 756 external build_load : llvalue -> string -> llbuilder -> llvalue
 757                     = "llvm_build_load"
 758 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
 759                      = "llvm_build_store"
 760 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
 761                    = "llvm_build_gep"
 762 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
 763                              llbuilder -> llvalue = "llvm_build_in_bounds_gep"
 764 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
 765                          = "llvm_build_struct_gep"
 766
 767 external build_global_string : string -> string -> llbuilder -> llvalue
 768                              = "llvm_build_global_string"
 769 external build_global_stringptr  : string -> string -> llbuilder -> llvalue
 770                                  = "llvm_build_global_stringptr"
 771
 772 (*--... Casts ..............................................................--*)
 773 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
 774                      = "llvm_build_trunc"
 775 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
 776                     = "llvm_build_zext"
 777 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
 778                     = "llvm_build_sext"
 779 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
 780                       = "llvm_build_fptoui"
 781 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
 782                       = "llvm_build_fptosi"
 783 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
 784                       = "llvm_build_uitofp"
 785 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
 786                       = "llvm_build_sitofp"
 787 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
 788                        = "llvm_build_fptrunc"
 789 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
 790                      = "llvm_build_fpext"
 791 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
 792                         = "llvm_build_prttoint"
 793 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
 794                         = "llvm_build_inttoptr"
 795 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
 796                        = "llvm_build_bitcast"
 797 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
 798                                  llvalue = "llvm_build_zext_or_bitcast"
 799 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
 800                                  llvalue = "llvm_build_sext_or_bitcast"
 801 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
 802                                   llvalue = "llvm_build_trunc_or_bitcast"
 803 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
 804                            = "llvm_build_pointercast"
 805 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
 806                        = "llvm_build_intcast"
 807 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
 808                       = "llvm_build_fpcast"
 809
 810 (*--... Comparisons ........................................................--*)
 811 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
 812                       llbuilder -> llvalue = "llvm_build_icmp"
 813 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
 814                       llbuilder -> llvalue = "llvm_build_fcmp"
 815
 816 (*--... Miscellaneous instructions .........................................--*)
 817 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
 818                      llvalue = "llvm_build_phi"
 819 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
 820                     = "llvm_build_call"
 821 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
 822                         llvalue = "llvm_build_select"
 823 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
 824                       = "llvm_build_va_arg"
 825 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
 826                                 llvalue = "llvm_build_extractelement"
 827 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
 828                                llbuilder -> llvalue = "llvm_build_insertelement"
 829 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
 830                                llbuilder -> llvalue = "llvm_build_shufflevector"
 831 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
 832                             = "llvm_build_extractvalue"
 833 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
 834                              llvalue = "llvm_build_insertvalue"
 835
 836 external build_is_null : llvalue -> string -> llbuilder -> llvalue
 837                        = "llvm_build_is_null"
 838 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
 839                            = "llvm_build_is_not_null"
 840 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
 841                        = "llvm_build_ptrdiff"
 842
 843 (*===-- Module providers --------------------------------------------------===*)
 844
 845 module ModuleProvider = struct
 846   external create : llmodule -> llmoduleprovider
 847                   = "LLVMCreateModuleProviderForExistingModule"
 848   external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider"
 849 end
 850
 851
 852 (*===-- Memory buffers ----------------------------------------------------===*)
 853
 854 module MemoryBuffer = struct
 855   external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
 856   external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
 857   external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
 858 end
 859
 860
 861 (*===-- Pass Manager ------------------------------------------------------===*)
 862
 863 module PassManager = struct
 864   type 'a t
 865   type any = [ `Module | `Function ]
 866   external create : unit -> [ `Module ] t = "llvm_passmanager_create"
 867   external create_function : llmoduleprovider -> [ `Function ] t
 868                            = "LLVMCreateFunctionPassManager"
 869   external run_module : llmodule -> [ `Module ] t -> bool
 870                       = "llvm_passmanager_run_module"
 871   external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
 872   external run_function : llvalue -> [ `Function ] t -> bool
 873                         = "llvm_passmanager_run_function"
 874   external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
 875   external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
 876 end
 877
 878
 879 (*===-- Non-Externs -------------------------------------------------------===*)
 880 (* These functions are built using the externals, so must be declared late.   *)
 881
 882 let concat2 sep arr =
 883   let s = ref "" in
 884   if 0 < Array.length arr then begin
 885     s := !s ^ arr.(0);
 886     for i = 1 to (Array.length arr) - 1 do
 887       s := !s ^ sep ^ arr.(i)
 888     done
 889   end;
 890   !s
 891
 892 let rec string_of_lltype ty =
 893   (* FIXME: stop infinite recursion! :) *)
 894   match classify_type ty with
 895     TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
 896   | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
 897   | TypeKind.Struct ->
 898       let s = "{ " ^ (concat2 ", " (
 899                 Array.map string_of_lltype (element_types ty)
 900               )) ^ " }" in
 901       if is_packed ty
 902         then "<" ^ s ^ ">"
 903         else s
 904   | TypeKind.Array -> "["   ^ (string_of_int (array_length ty)) ^
 905                       " x " ^ (string_of_lltype (element_type ty)) ^ "]"
 906   | TypeKind.Vector -> "<"   ^ (string_of_int (vector_size ty)) ^
 907                        " x " ^ (string_of_lltype (element_type ty)) ^ ">"
 908   | TypeKind.Opaque -> "opaque"
 909   | TypeKind.Function -> string_of_lltype (return_type ty) ^
 910                          " (" ^ (concat2 ", " (
 911                            Array.map string_of_lltype (param_types ty)
 912                          )) ^ ")"
 913   | TypeKind.Label -> "label"
 914   | TypeKind.Ppc_fp128 -> "ppc_fp128"
 915   | TypeKind.Fp128 -> "fp128"
 916   | TypeKind.X86fp80 -> "x86_fp80"
 917   | TypeKind.Double -> "double"
 918   | TypeKind.Float -> "float"
 919   | TypeKind.Void -> "void"
 920   | TypeKind.Metadata -> "metadata"