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_fneg : llvalue -> llvalue = "LLVMConstFNeg"
 274 external const_not : llvalue -> llvalue = "LLVMConstNot"
 275 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
 276 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
 277 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
 278 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
 279 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
 280 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
 281 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
 282 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
 283 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
 284 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
 285 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
 286 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
 287 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
 288 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
 289 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
 290 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
 291 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
 292 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
 293                     = "llvm_const_icmp"
 294 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
 295                     = "llvm_const_fcmp"
 296 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
 297 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
 298 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
 299 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
 300 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
 301                             = "llvm_const_in_bounds_gep"
 302 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
 303 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
 304 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
 305 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
 306 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
 307 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
 308 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
 309 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
 310 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
 311 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
 312 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
 313 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
 314 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
 315                              = "LLVMConstZExtOrBitCast"
 316 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
 317                              = "LLVMConstSExtOrBitCast"
 318 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
 319                               = "LLVMConstTruncOrBitCast"
 320 external const_pointercast : llvalue -> lltype -> llvalue
 321                            = "LLVMConstPointerCast"
 322 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
 323 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
 324 external const_select : llvalue -> llvalue -> llvalue -> llvalue
 325                       = "LLVMConstSelect"
 326 external const_extractelement : llvalue -> llvalue -> llvalue
 327                               = "LLVMConstExtractElement"
 328 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
 329                              = "LLVMConstInsertElement"
 330 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
 331                              = "LLVMConstShuffleVector"
 332 external const_extractvalue : llvalue -> int array -> llvalue
 333                             = "llvm_const_extractvalue"
 334 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
 335                            = "llvm_const_insertvalue"
 336
 337 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
 338 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
 339 external is_declaration : llvalue -> bool = "llvm_is_declaration"
 340 external linkage : llvalue -> Linkage.t = "llvm_linkage"
 341 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
 342 external section : llvalue -> string = "llvm_section"
 343 external set_section : string -> llvalue -> unit = "llvm_set_section"
 344 external visibility : llvalue -> Visibility.t = "llvm_visibility"
 345 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
 346 external alignment : llvalue -> int = "llvm_alignment"
 347 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
 348 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
 349 external set_global_constant : bool -> llvalue -> unit
 350                              = "llvm_set_global_constant"
 351
 352 (*--... Operations on global variables .....................................--*)
 353 external declare_global : lltype -> string -> llmodule -> llvalue
 354                         = "llvm_declare_global"
 355 external define_global : string -> llvalue -> llmodule -> llvalue
 356                        = "llvm_define_global"
 357 external lookup_global : string -> llmodule -> llvalue option
 358                        = "llvm_lookup_global"
 359 external delete_global : llvalue -> unit = "llvm_delete_global"
 360 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
 361 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
 362 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
 363 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
 364 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
 365 external global_begin : llmodule -> (llmodule, llvalue) llpos
 366                       = "llvm_global_begin"
 367 external global_succ : llvalue -> (llmodule, llvalue) llpos
 368                      = "llvm_global_succ"
 369 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
 370                     = "llvm_global_end"
 371 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
 372                      = "llvm_global_pred"
 373
 374 let rec iter_global_range f i e =
 375   if i = e then () else
 376   match i with
 377   | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
 378   | Before bb ->
 379       f bb;
 380       iter_global_range f (global_succ bb) e
 381
 382 let iter_globals f m =
 383   iter_global_range f (global_begin m) (At_end m)
 384
 385 let rec fold_left_global_range f init i e =
 386   if i = e then init else
 387   match i with
 388   | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
 389   | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
 390
 391 let fold_left_globals f init m =
 392   fold_left_global_range f init (global_begin m) (At_end m)
 393
 394 let rec rev_iter_global_range f i e =
 395   if i = e then () else
 396   match i with
 397   | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
 398   | After bb ->
 399       f bb;
 400       rev_iter_global_range f (global_pred bb) e
 401
 402 let rev_iter_globals f m =
 403   rev_iter_global_range f (global_end m) (At_start m)
 404
 405 let rec fold_right_global_range f i e init =
 406   if i = e then init else
 407   match i with
 408   | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
 409   | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
 410
 411 let fold_right_globals f m init =
 412   fold_right_global_range f (global_end m) (At_start m) init
 413
 414 (*--... Operations on functions ............................................--*)
 415 external declare_function : string -> lltype -> llmodule -> llvalue
 416                           = "llvm_declare_function"
 417 external define_function : string -> lltype -> llmodule -> llvalue
 418                          = "llvm_define_function"
 419 external lookup_function : string -> llmodule -> llvalue option
 420                          = "llvm_lookup_function"
 421 external delete_function : llvalue -> unit = "llvm_delete_function"
 422 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
 423 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
 424 external set_function_call_conv : int -> llvalue -> unit
 425                                 = "llvm_set_function_call_conv"
 426 external gc : llvalue -> string option = "llvm_gc"
 427 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
 428 external function_begin : llmodule -> (llmodule, llvalue) llpos
 429                         = "llvm_function_begin"
 430 external function_succ : llvalue -> (llmodule, llvalue) llpos
 431                        = "llvm_function_succ"
 432 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
 433                       = "llvm_function_end"
 434 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
 435                        = "llvm_function_pred"
 436
 437 let rec iter_function_range f i e =
 438   if i = e then () else
 439   match i with
 440   | At_end _ -> raise (Invalid_argument "Invalid function range.")
 441   | Before fn ->
 442       f fn;
 443       iter_function_range f (function_succ fn) e
 444
 445 let iter_functions f m =
 446   iter_function_range f (function_begin m) (At_end m)
 447
 448 let rec fold_left_function_range f init i e =
 449   if i = e then init else
 450   match i with
 451   | At_end _ -> raise (Invalid_argument "Invalid function range.")
 452   | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
 453
 454 let fold_left_functions f init m =
 455   fold_left_function_range f init (function_begin m) (At_end m)
 456
 457 let rec rev_iter_function_range f i e =
 458   if i = e then () else
 459   match i with
 460   | At_start _ -> raise (Invalid_argument "Invalid function range.")
 461   | After fn ->
 462       f fn;
 463       rev_iter_function_range f (function_pred fn) e
 464
 465 let rev_iter_functions f m =
 466   rev_iter_function_range f (function_end m) (At_start m)
 467
 468 let rec fold_right_function_range f i e init =
 469   if i = e then init else
 470   match i with
 471   | At_start _ -> raise (Invalid_argument "Invalid function range.")
 472   | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
 473
 474 let fold_right_functions f m init =
 475   fold_right_function_range f (function_end m) (At_start m) init
 476
 477 external add_function_attr : llvalue -> Attribute.t -> unit
 478                            = "llvm_add_function_attr"
 479 external remove_function_attr : llvalue -> Attribute.t -> unit
 480                               = "llvm_remove_function_attr"
 481
 482 (*--... Operations on params ...............................................--*)
 483 external params : llvalue -> llvalue array = "llvm_params"
 484 external param : llvalue -> int -> llvalue = "llvm_param"
 485 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
 486 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
 487 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
 488 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
 489 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
 490
 491 let rec iter_param_range f i e =
 492   if i = e then () else
 493   match i with
 494   | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
 495   | Before p ->
 496       f p;
 497       iter_param_range f (param_succ p) e
 498
 499 let iter_params f fn =
 500   iter_param_range f (param_begin fn) (At_end fn)
 501
 502 let rec fold_left_param_range f init i e =
 503   if i = e then init else
 504   match i with
 505   | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
 506   | Before p -> fold_left_param_range f (f init p) (param_succ p) e
 507
 508 let fold_left_params f init fn =
 509   fold_left_param_range f init (param_begin fn) (At_end fn)
 510
 511 let rec rev_iter_param_range f i e =
 512   if i = e then () else
 513   match i with
 514   | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
 515   | After p ->
 516       f p;
 517       rev_iter_param_range f (param_pred p) e
 518
 519 let rev_iter_params f fn =
 520   rev_iter_param_range f (param_end fn) (At_start fn)
 521
 522 let rec fold_right_param_range f init i e =
 523   if i = e then init else
 524   match i with
 525   | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
 526   | After p -> fold_right_param_range f (f p init) (param_pred p) e
 527
 528 let fold_right_params f fn init =
 529   fold_right_param_range f init (param_end fn) (At_start fn)
 530
 531 external add_param_attr : llvalue -> Attribute.t -> unit
 532                         = "llvm_add_param_attr"
 533 external remove_param_attr : llvalue -> Attribute.t -> unit
 534                            = "llvm_remove_param_attr"
 535 external set_param_alignment : llvalue -> int -> unit
 536                              = "llvm_set_param_alignment"
 537
 538 (*--... Operations on basic blocks .........................................--*)
 539 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
 540 external value_is_block : llvalue -> bool = "llvm_value_is_block"
 541 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
 542 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
 543 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
 544 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
 545 external delete_block : llbasicblock -> unit = "llvm_delete_block"
 546 external append_block : llcontext -> string -> llvalue -> llbasicblock
 547                       = "llvm_append_block"
 548 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
 549                       = "llvm_insert_block"
 550 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
 551                      = "llvm_block_begin"
 552 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
 553                     = "llvm_block_succ"
 554 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
 555                    = "llvm_block_end"
 556 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
 557                     = "llvm_block_pred"
 558
 559 let rec iter_block_range f i e =
 560   if i = e then () else
 561   match i with
 562   | At_end _ -> raise (Invalid_argument "Invalid block range.")
 563   | Before bb ->
 564       f bb;
 565       iter_block_range f (block_succ bb) e
 566
 567 let iter_blocks f fn =
 568   iter_block_range f (block_begin fn) (At_end fn)
 569
 570 let rec fold_left_block_range f init i e =
 571   if i = e then init else
 572   match i with
 573   | At_end _ -> raise (Invalid_argument "Invalid block range.")
 574   | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
 575
 576 let fold_left_blocks f init fn =
 577   fold_left_block_range f init (block_begin fn) (At_end fn)
 578
 579 let rec rev_iter_block_range f i e =
 580   if i = e then () else
 581   match i with
 582   | At_start _ -> raise (Invalid_argument "Invalid block range.")
 583   | After bb ->
 584       f bb;
 585       rev_iter_block_range f (block_pred bb) e
 586
 587 let rev_iter_blocks f fn =
 588   rev_iter_block_range f (block_end fn) (At_start fn)
 589
 590 let rec fold_right_block_range f init i e =
 591   if i = e then init else
 592   match i with
 593   | At_start _ -> raise (Invalid_argument "Invalid block range.")
 594   | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
 595
 596 let fold_right_blocks f fn init =
 597   fold_right_block_range f init (block_end fn) (At_start fn)
 598
 599 (*--... Operations on instructions .........................................--*)
 600 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
 601 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
 602                      = "llvm_instr_begin"
 603 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
 604                      = "llvm_instr_succ"
 605 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
 606                      = "llvm_instr_end"
 607 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
 608                      = "llvm_instr_pred"
 609
 610 let rec iter_instrs_range f i e =
 611   if i = e then () else
 612   match i with
 613   | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
 614   | Before i ->
 615       f i;
 616       iter_instrs_range f (instr_succ i) e
 617
 618 let iter_instrs f bb =
 619   iter_instrs_range f (instr_begin bb) (At_end bb)
 620
 621 let rec fold_left_instrs_range f init i e =
 622   if i = e then init else
 623   match i with
 624   | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
 625   | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
 626
 627 let fold_left_instrs f init bb =
 628   fold_left_instrs_range f init (instr_begin bb) (At_end bb)
 629
 630 let rec rev_iter_instrs_range f i e =
 631   if i = e then () else
 632   match i with
 633   | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
 634   | After i ->
 635       f i;
 636       rev_iter_instrs_range f (instr_pred i) e
 637
 638 let rev_iter_instrs f bb =
 639   rev_iter_instrs_range f (instr_end bb) (At_start bb)
 640
 641 let rec fold_right_instr_range f i e init =
 642   if i = e then init else
 643   match i with
 644   | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
 645   | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
 646
 647 let fold_right_instrs f bb init =
 648   fold_right_instr_range f (instr_end bb) (At_start bb) init
 649
 650
 651 (*--... Operations on call sites ...........................................--*)
 652 external instruction_call_conv: llvalue -> int
 653                               = "llvm_instruction_call_conv"
 654 external set_instruction_call_conv: int -> llvalue -> unit
 655                                   = "llvm_set_instruction_call_conv"
 656 external add_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
 657                                     = "llvm_add_instruction_param_attr"
 658 external remove_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
 659                                        = "llvm_remove_instruction_param_attr"
 660
 661 (*--... Operations on call instructions (only) .............................--*)
 662 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
 663 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
 664
 665 (*--... Operations on phi nodes ............................................--*)
 666 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
 667                       = "llvm_add_incoming"
 668 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
 669
 670
 671 (*===-- Instruction builders ----------------------------------------------===*)
 672 external builder : llcontext -> llbuilder = "llvm_builder"
 673 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
 674                           = "llvm_position_builder"
 675 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
 676 external insert_into_builder : llvalue -> string -> llbuilder -> unit
 677                              = "llvm_insert_into_builder"
 678
 679 let builder_at context ip =
 680   let b = builder context in
 681   position_builder ip b;
 682   b
 683
 684 let builder_before context i = builder_at context (Before i)
 685 let builder_at_end context bb = builder_at context (At_end bb)
 686
 687 let position_before i = position_builder (Before i)
 688 let position_at_end bb = position_builder (At_end bb)
 689
 690
 691 (*--... Terminators ........................................................--*)
 692 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
 693 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
 694 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
 695                              = "llvm_build_aggregate_ret"
 696 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
 697 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
 698                          llvalue = "llvm_build_cond_br"
 699 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
 700                       = "llvm_build_switch"
 701 external add_case : llvalue -> llvalue -> llbasicblock -> unit
 702                   = "llvm_add_case"
 703 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
 704                         llbasicblock -> string -> llbuilder -> llvalue
 705                       = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
 706 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
 707 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
 708
 709 (*--... Arithmetic .........................................................--*)
 710 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
 711                    = "llvm_build_add"
 712 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
 713                        = "llvm_build_nsw_add"
 714 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
 715                     = "llvm_build_fadd"
 716 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
 717                    = "llvm_build_sub"
 718 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
 719                     = "llvm_build_fsub"
 720 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
 721                    = "llvm_build_mul"
 722 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
 723                     = "llvm_build_fmul"
 724 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
 725                     = "llvm_build_udiv"
 726 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
 727                     = "llvm_build_sdiv"
 728 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
 729                           = "llvm_build_exact_sdiv"
 730 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
 731                     = "llvm_build_fdiv"
 732 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
 733                     = "llvm_build_urem"
 734 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
 735                     = "llvm_build_srem"
 736 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
 737                     = "llvm_build_frem"
 738 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
 739                    = "llvm_build_shl"
 740 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
 741                     = "llvm_build_lshr"
 742 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
 743                     = "llvm_build_ashr"
 744 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
 745                    = "llvm_build_and"
 746 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
 747                   = "llvm_build_or"
 748 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
 749                    = "llvm_build_xor"
 750 external build_neg : llvalue -> string -> llbuilder -> llvalue
 751                    = "llvm_build_neg"
 752 external build_not : llvalue -> string -> llbuilder -> llvalue
 753                    = "llvm_build_not"
 754
 755 (*--... Memory .............................................................--*)
 756 external build_alloca : lltype -> string -> llbuilder -> llvalue
 757                       = "llvm_build_alloca"
 758 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
 759                               llvalue = "llvm_build_array_alloca"
 760 external build_load : llvalue -> string -> llbuilder -> llvalue
 761                     = "llvm_build_load"
 762 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
 763                      = "llvm_build_store"
 764 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
 765                    = "llvm_build_gep"
 766 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
 767                              llbuilder -> llvalue = "llvm_build_in_bounds_gep"
 768 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
 769                          = "llvm_build_struct_gep"
 770
 771 external build_global_string : string -> string -> llbuilder -> llvalue
 772                              = "llvm_build_global_string"
 773 external build_global_stringptr  : string -> string -> llbuilder -> llvalue
 774                                  = "llvm_build_global_stringptr"
 775
 776 (*--... Casts ..............................................................--*)
 777 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
 778                      = "llvm_build_trunc"
 779 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
 780                     = "llvm_build_zext"
 781 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
 782                     = "llvm_build_sext"
 783 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
 784                       = "llvm_build_fptoui"
 785 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
 786                       = "llvm_build_fptosi"
 787 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
 788                       = "llvm_build_uitofp"
 789 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
 790                       = "llvm_build_sitofp"
 791 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
 792                        = "llvm_build_fptrunc"
 793 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
 794                      = "llvm_build_fpext"
 795 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
 796                         = "llvm_build_prttoint"
 797 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
 798                         = "llvm_build_inttoptr"
 799 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
 800                        = "llvm_build_bitcast"
 801 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
 802                                  llvalue = "llvm_build_zext_or_bitcast"
 803 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
 804                                  llvalue = "llvm_build_sext_or_bitcast"
 805 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
 806                                   llvalue = "llvm_build_trunc_or_bitcast"
 807 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
 808                            = "llvm_build_pointercast"
 809 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
 810                        = "llvm_build_intcast"
 811 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
 812                       = "llvm_build_fpcast"
 813
 814 (*--... Comparisons ........................................................--*)
 815 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
 816                       llbuilder -> llvalue = "llvm_build_icmp"
 817 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
 818                       llbuilder -> llvalue = "llvm_build_fcmp"
 819
 820 (*--... Miscellaneous instructions .........................................--*)
 821 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
 822                      llvalue = "llvm_build_phi"
 823 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
 824                     = "llvm_build_call"
 825 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
 826                         llvalue = "llvm_build_select"
 827 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
 828                       = "llvm_build_va_arg"
 829 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
 830                                 llvalue = "llvm_build_extractelement"
 831 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
 832                                llbuilder -> llvalue = "llvm_build_insertelement"
 833 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
 834                                llbuilder -> llvalue = "llvm_build_shufflevector"
 835 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
 836                             = "llvm_build_extractvalue"
 837 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
 838                              llvalue = "llvm_build_insertvalue"
 839
 840 external build_is_null : llvalue -> string -> llbuilder -> llvalue
 841                        = "llvm_build_is_null"
 842 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
 843                            = "llvm_build_is_not_null"
 844 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
 845                        = "llvm_build_ptrdiff"
 846
 847 (*===-- Module providers --------------------------------------------------===*)
 848
 849 module ModuleProvider = struct
 850   external create : llmodule -> llmoduleprovider
 851                   = "LLVMCreateModuleProviderForExistingModule"
 852   external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider"
 853 end
 854
 855
 856 (*===-- Memory buffers ----------------------------------------------------===*)
 857
 858 module MemoryBuffer = struct
 859   external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
 860   external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
 861   external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
 862 end
 863
 864
 865 (*===-- Pass Manager ------------------------------------------------------===*)
 866
 867 module PassManager = struct
 868   type 'a t
 869   type any = [ `Module | `Function ]
 870   external create : unit -> [ `Module ] t = "llvm_passmanager_create"
 871   external create_function : llmoduleprovider -> [ `Function ] t
 872                            = "LLVMCreateFunctionPassManager"
 873   external run_module : llmodule -> [ `Module ] t -> bool
 874                       = "llvm_passmanager_run_module"
 875   external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
 876   external run_function : llvalue -> [ `Function ] t -> bool
 877                         = "llvm_passmanager_run_function"
 878   external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
 879   external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
 880 end
 881
 882
 883 (*===-- Non-Externs -------------------------------------------------------===*)
 884 (* These functions are built using the externals, so must be declared late.   *)
 885
 886 let concat2 sep arr =
 887   let s = ref "" in
 888   if 0 < Array.length arr then begin
 889     s := !s ^ arr.(0);
 890     for i = 1 to (Array.length arr) - 1 do
 891       s := !s ^ sep ^ arr.(i)
 892     done
 893   end;
 894   !s
 895
 896 let rec string_of_lltype ty =
 897   (* FIXME: stop infinite recursion! :) *)
 898   match classify_type ty with
 899     TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
 900   | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
 901   | TypeKind.Struct ->
 902       let s = "{ " ^ (concat2 ", " (
 903                 Array.map string_of_lltype (struct_element_types ty)
 904               )) ^ " }" in
 905       if is_packed ty
 906         then "<" ^ s ^ ">"
 907         else s
 908   | TypeKind.Union -> "union { " ^ (concat2 ", " (
 909                         Array.map string_of_lltype (union_element_types ty)
 910                       )) ^ " }"
 911   | TypeKind.Array -> "["   ^ (string_of_int (array_length ty)) ^
 912                       " x " ^ (string_of_lltype (element_type ty)) ^ "]"
 913   | TypeKind.Vector -> "<"   ^ (string_of_int (vector_size ty)) ^
 914                        " x " ^ (string_of_lltype (element_type ty)) ^ ">"
 915   | TypeKind.Opaque -> "opaque"
 916   | TypeKind.Function -> string_of_lltype (return_type ty) ^
 917                          " (" ^ (concat2 ", " (
 918                            Array.map string_of_lltype (param_types ty)
 919                          )) ^ ")"
 920   | TypeKind.Label -> "label"
 921   | TypeKind.Ppc_fp128 -> "ppc_fp128"
 922   | TypeKind.Fp128 -> "fp128"
 923   | TypeKind.X86fp80 -> "x86_fp80"
 924   | TypeKind.Double -> "double"
 925   | TypeKind.Float -> "float"
 926   | TypeKind.Void -> "void"
 927   | TypeKind.Metadata -> "metadata"