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