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