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