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