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