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