bindings/ocaml/llvm/llvm.ml

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