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