bindings/ocaml/llvm/llvm.ml

   1 (*===-- tools/ml/llvm.ml - LLVM Ocaml Interface ---------------------------===*
   2  *
   3  *                     The LLVM Compiler Infrastructure
   4  *
   5  * This file was developed by Gordon Henriksen and is distributed under the
   6  * University of Illinois Open Source License. See LICENSE.TXT for details.
   7  *
   8  *===----------------------------------------------------------------------===
   9  *
  10  * This interface provides an ocaml API for the LLVM intermediate
  11  * representation, the classes in the VMCore library.
  12  *
  13  *===----------------------------------------------------------------------===*)
  14
  15
  16 (* These abstract types correlate directly to the LLVM VMCore classes. *)
  17 type llmodule
  18 type lltype
  19 type llvalue
  20 type llbasicblock (* These are actually values, but
  21                      benefit from type checking. *)
  22 type llbuilder
  23
  24 type type_kind =
  25   Void_type
  26 | Float_type
  27 | Double_type
  28 | X86fp80_type
  29 | Fp128_type
  30 | Ppc_fp128_type
  31 | Label_type
  32 | Integer_type
  33 | Function_type
  34 | Struct_type
  35 | Array_type
  36 | Pointer_type
  37 | Opaque_type
  38 | Vector_type
  39
  40 type linkage =
  41   External_linkage
  42 | Link_once_linkage
  43 | Weak_linkage
  44 | Appending_linkage
  45 | Internal_linkage
  46 | Dllimport_linkage
  47 | Dllexport_linkage
  48 | External_weak_linkage
  49 | Ghost_linkage
  50
  51 type visibility =
  52   Default_visibility
  53 | Hidden_visibility
  54 | Protected_visibility
  55
  56 let ccc = 0
  57 let fastcc = 8
  58 let coldcc = 9
  59 let x86_stdcallcc = 64
  60 let x86_fastcallcc = 65
  61
  62 type int_predicate =
  63   Icmp_eq
  64 | Icmp_ne
  65 | Icmp_ugt
  66 | Icmp_uge
  67 | Icmp_ult
  68 | Icmp_ule
  69 | Icmp_sgt
  70 | Icmp_sge
  71 | Icmp_slt
  72 | Icmp_sle
  73
  74 type real_predicate =
  75   Fcmp_false
  76 | Fcmp_oeq
  77 | Fcmp_ogt
  78 | Fcmp_oge
  79 | Fcmp_olt
  80 | Fcmp_ole
  81 | Fcmp_one
  82 | Fcmp_ord
  83 | Fcmp_uno
  84 | Fcmp_ueq
  85 | Fcmp_ugt
  86 | Fcmp_uge
  87 | Fcmp_ult
  88 | Fcmp_ule
  89 | Fcmp_une
  90 | Fcmp_true
  91
  92
  93 (*===-- Modules -----------------------------------------------------------===*)
  94
  95 (* Creates a module with the supplied module ID. Modules are not garbage
  96    collected; it is mandatory to call dispose_module to free memory. *)
  97 external create_module : string -> llmodule = "llvm_create_module"
  98
  99 (* Disposes a module. All references to subordinate objects are invalidated;
 100    referencing them will invoke undefined behavior. *)
 101 external dispose_module : llmodule -> unit = "llvm_dispose_module"
 102
 103 (* Adds a named type to the module's symbol table. Returns true if successful.
 104    If such a name already exists, then no entry is added and returns false. *)
 105 external define_type_name : string -> lltype -> llmodule -> bool
 106                           = "llvm_add_type_name"
 107
 108 external delete_type_name : string -> llmodule -> unit
 109                           = "llvm_delete_type_name"
 110
 111
 112 (*===-- Types -------------------------------------------------------------===*)
 113
 114 external classify_type : lltype -> type_kind = "llvm_classify_type"
 115 external refine_abstract_type : lltype -> lltype -> unit
 116                               = "llvm_refine_abstract_type"
 117
 118 (*--... Operations on integer types ........................................--*)
 119 external _i1_type : unit -> lltype = "llvm_i1_type"
 120 external _i8_type : unit -> lltype = "llvm_i8_type"
 121 external _i16_type : unit -> lltype = "llvm_i16_type"
 122 external _i32_type : unit -> lltype = "llvm_i32_type"
 123 external _i64_type : unit -> lltype = "llvm_i64_type"
 124
 125 let i1_type = _i1_type ()
 126 let i8_type = _i8_type ()
 127 let i16_type = _i16_type ()
 128 let i32_type = _i32_type ()
 129 let i64_type = _i64_type ()
 130
 131 external make_integer_type : int -> lltype = "llvm_make_integer_type"
 132 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
 133
 134 (*--... Operations on real types ...........................................--*)
 135 external _float_type : unit -> lltype = "llvm_float_type"
 136 external _double_type : unit -> lltype = "llvm_double_type"
 137 external _x86fp80_type : unit -> lltype = "llvm_x86fp80_type"
 138 external _fp128_type : unit -> lltype = "llvm_fp128_type"
 139 external _ppc_fp128_type : unit -> lltype = "llvm_ppc_fp128_type"
 140
 141 let float_type = _float_type ()
 142 let double_type = _double_type ()
 143 let x86fp80_type = _x86fp80_type ()
 144 let fp128_type = _fp128_type ()
 145 let ppc_fp128_type = _ppc_fp128_type ()
 146
 147 (*--... Operations on function types .......................................--*)
 148 (* FIXME: handle parameter attributes *)
 149 external make_function_type : lltype -> lltype array -> bool -> lltype
 150                             = "llvm_make_function_type"
 151 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
 152 external return_type : lltype -> lltype = "llvm_return_type"
 153 external param_types : lltype -> lltype array = "llvm_param_types"
 154
 155 (*--... Operations on struct types .........................................--*)
 156 external make_struct_type : lltype array -> bool -> lltype
 157                           = "llvm_make_struct_type"
 158 external element_types : lltype -> lltype array = "llvm_element_types"
 159 external is_packed : lltype -> bool = "llvm_is_packed"
 160
 161 (*--... Operations on pointer, vector, and array types .....................--*)
 162 external make_array_type : lltype -> int -> lltype = "llvm_make_array_type"
 163 external make_pointer_type : lltype -> lltype = "llvm_make_pointer_type"
 164 external make_vector_type : lltype -> int -> lltype = "llvm_make_vector_type"
 165
 166 external element_type : lltype -> lltype = "llvm_element_type"
 167 external array_length : lltype -> int = "llvm_array_length"
 168 external vector_size : lltype -> int = "llvm_vector_size"
 169
 170 (*--... Operations on other types ..........................................--*)
 171 external make_opaque_type : unit -> lltype = "llvm_make_opaque_type"
 172 external _void_type : unit -> lltype = "llvm_void_type"
 173 external _label_type : unit -> lltype = "llvm_label_type"
 174
 175 let void_type = _void_type ()
 176 let label_type = _label_type ()
 177
 178
 179 (*===-- Values ------------------------------------------------------------===*)
 180
 181 external type_of : llvalue -> lltype = "llvm_type_of"
 182 external value_name : llvalue -> string = "llvm_value_name"
 183 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
 184
 185 (*--... Operations on constants of (mostly) any type .......................--*)
 186 external is_constant : llvalue -> bool = "llvm_is_constant"
 187 external make_null : lltype -> llvalue = "LLVMGetNull"
 188 external make_all_ones : (*int|vec*)lltype -> llvalue = "LLVMGetAllOnes"
 189 external make_undef : lltype -> llvalue = "LLVMGetUndef"
 190 external is_null : llvalue -> bool = "llvm_is_null"
 191 external is_undef : llvalue -> bool = "llvm_is_undef"
 192
 193 (*--... Operations on scalar constants .....................................--*)
 194 external make_int_constant : lltype -> int -> bool -> llvalue
 195                            = "llvm_make_int_constant"
 196 external make_int64_constant : lltype -> Int64.t -> bool -> llvalue
 197                              = "llvm_make_int64_constant"
 198 external make_real_constant : lltype -> float -> llvalue
 199                             = "llvm_make_real_constant"
 200
 201 (*--... Operations on composite constants ..................................--*)
 202 external make_string_constant : string -> bool -> llvalue
 203                               = "llvm_make_string_constant"
 204 external make_array_constant : lltype -> llvalue array -> llvalue
 205                              = "llvm_make_array_constant"
 206 external make_struct_constant : llvalue array -> bool -> llvalue
 207                               = "llvm_make_struct_constant"
 208 external make_vector_constant : llvalue array -> llvalue
 209                               = "llvm_make_vector_constant"
 210
 211 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
 212 external is_declaration : llvalue -> bool = "llvm_is_declaration"
 213 external linkage : llvalue -> linkage = "llvm_linkage"
 214 external set_linkage : linkage -> llvalue -> unit = "llvm_set_linkage"
 215 external section : llvalue -> string = "llvm_section"
 216 external set_section : string -> llvalue -> unit = "llvm_set_section"
 217 external visibility : llvalue -> visibility = "llvm_visibility"
 218 external set_visibility : visibility -> llvalue -> unit = "llvm_set_visibility"
 219 external alignment : llvalue -> int = "llvm_alignment"
 220 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
 221
 222 (*--... Operations on global variables .....................................--*)
 223 external declare_global : lltype -> string -> llmodule -> llvalue
 224                         = "llvm_declare_global"
 225 external define_global : string -> llvalue -> llmodule -> llvalue
 226                        = "llvm_define_global"
 227 external delete_global : llvalue -> unit = "llvm_delete_global"
 228 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
 229 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
 230 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
 231 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
 232 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
 233
 234 (*--... Operations on functions ............................................--*)
 235 external declare_function : string -> lltype -> llmodule -> llvalue
 236                           = "llvm_declare_function"
 237 external define_function : string -> lltype -> llmodule -> llvalue
 238                          = "llvm_define_function"
 239 external delete_function : llvalue -> unit = "llvm_delete_function"
 240 external params : llvalue -> llvalue array = "llvm_params"
 241 external param : llvalue -> int -> llvalue = "llvm_param"
 242 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
 243 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
 244 external set_function_call_conv : int -> llvalue -> unit
 245                                 = "llvm_set_function_call_conv"
 246
 247 (* TODO: param attrs *)
 248
 249 (*--... Operations on basic blocks .........................................--*)
 250 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
 251 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
 252 external delete_block : llbasicblock -> unit = "llvm_delete_block"
 253 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
 254 external insert_block : string -> llbasicblock -> llbasicblock
 255                       = "llvm_insert_block"
 256 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
 257 external value_is_block : llvalue -> bool = "llvm_value_is_block"
 258 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
 259
 260
 261 (*===-- Instruction builders ----------------------------------------------===*)
 262 external builder_before : llvalue -> llbuilder = "llvm_builder_before"
 263 external builder_at_end : llbasicblock -> llbuilder = "llvm_builder_at_end"
 264 external position_before : llvalue -> llbuilder -> unit = "llvm_position_before"
 265 external position_at_end : llbasicblock -> llbuilder -> unit
 266                          = "llvm_position_at_end"
 267
 268 (*--... Terminators ........................................................--*)
 269 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
 270 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
 271 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
 272 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
 273                          llvalue = "llvm_build_cond_br"
 274 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
 275                       = "llvm_build_switch"
 276 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
 277                         llbasicblock -> string -> llbuilder -> llvalue
 278                       = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
 279 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
 280 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
 281
 282 (*--... Arithmetic .........................................................--*)
 283 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
 284                    = "llvm_build_add"
 285 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
 286                    = "llvm_build_sub"
 287 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
 288                    = "llvm_build_mul"
 289 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
 290                     = "llvm_build_udiv"
 291 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
 292                     = "llvm_build_sdiv"
 293 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
 294                     = "llvm_build_fdiv"
 295 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
 296                     = "llvm_build_urem"
 297 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
 298                     = "llvm_build_srem"
 299 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
 300                     = "llvm_build_frem"
 301 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
 302                    = "llvm_build_shl"
 303 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
 304                     = "llvm_build_lshr"
 305 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
 306                     = "llvm_build_ashr"
 307 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
 308                    = "llvm_build_and"
 309 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
 310                   = "llvm_build_or"
 311 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
 312                    = "llvm_build_xor"
 313 external build_neg : llvalue -> string -> llbuilder -> llvalue
 314                    = "llvm_build_neg"
 315 external build_not : llvalue -> string -> llbuilder -> llvalue
 316                    = "llvm_build_not"
 317
 318 (*--... Memory .............................................................--*)
 319 external build_malloc : lltype -> string -> llbuilder -> llvalue
 320                       = "llvm_build_malloc"
 321 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
 322                               llvalue = "llvm_build_array_malloc"
 323 external build_alloca : lltype -> string -> llbuilder -> llvalue
 324                       = "llvm_build_alloca"
 325 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
 326                               llvalue = "llvm_build_array_alloca"
 327 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
 328 external build_load : llvalue -> string -> llbuilder -> llvalue
 329                     = "llvm_build_load"
 330 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
 331                      = "llvm_build_store"
 332 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
 333                    = "llvm_build_gep"
 334
 335 (*--... Casts ..............................................................--*)
 336 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
 337                      = "llvm_build_trunc"
 338 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
 339                     = "llvm_build_zext"
 340 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
 341                     = "llvm_build_sext"
 342 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
 343                       = "llvm_build_fptoui"
 344 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
 345                       = "llvm_build_fptosi"
 346 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
 347                       = "llvm_build_uitofp"
 348 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
 349                       = "llvm_build_sitofp"
 350 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
 351                        = "llvm_build_fptrunc"
 352 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
 353                      = "llvm_build_fpext"
 354 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
 355                         = "llvm_build_prttoint"
 356 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
 357                         = "llvm_build_inttoptr"
 358 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
 359                        = "llvm_build_bitcast"
 360
 361 (*--... Comparisons ........................................................--*)
 362 external build_icmp : int_predicate -> llvalue -> llvalue -> string ->
 363                       llbuilder -> llvalue = "llvm_build_icmp"
 364 external build_fcmp : real_predicate -> llvalue -> llvalue -> string ->
 365                       llbuilder -> llvalue = "llvm_build_fcmp"
 366
 367 (*--... Miscellaneous instructions .........................................--*)
 368 external build_phi : lltype -> string -> llbuilder -> llvalue = "llvm_build_phi"
 369 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
 370                     = "llvm_build_call"
 371 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
 372                         llvalue = "llvm_build_select"
 373 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
 374                       = "llvm_build_va_arg"
 375 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
 376                                 llvalue = "llvm_build_extractelement"
 377 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
 378                                llbuilder -> llvalue = "llvm_build_insertelement"
 379 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
 380                                llbuilder -> llvalue = "llvm_build_shufflevector"
 381
 382
 383 (*===-- Non-Externs -------------------------------------------------------===*)
 384 (* These functions are built using the externals, so must be declared late.   *)
 385
 386 let concat2 sep arr =
 387   let s = ref "" in
 388   if 0 < Array.length arr then begin
 389     s := !s ^ arr.(0);
 390     for i = 1 to (Array.length arr) - 1 do
 391       s := !s ^ sep ^ arr.(i)
 392     done
 393   end;
 394   !s
 395
 396 let rec string_of_lltype ty =
 397   match classify_type ty with
 398     Integer_type -> "i" ^ string_of_int (integer_bitwidth ty)
 399   | Pointer_type -> (string_of_lltype (element_type ty)) ^ "*"
 400   | Struct_type ->
 401       let s = "{ " ^ (concat2 ", " (
 402                 Array.map string_of_lltype (element_types ty)
 403               )) ^ " }" in
 404       if is_packed ty
 405         then "<" ^ s ^ ">"
 406         else s
 407   | Array_type -> "["   ^ (string_of_int (array_length ty)) ^
 408                   " x " ^ (string_of_lltype (element_type ty)) ^ "]"
 409   | Vector_type -> "<"   ^ (string_of_int (vector_size ty)) ^
 410                    " x " ^ (string_of_lltype (element_type ty)) ^ ">"
 411   | Opaque_type -> "opaque"
 412   | Function_type -> string_of_lltype (return_type ty) ^
 413                      " (" ^ (concat2 ", " (
 414                        Array.map string_of_lltype (param_types ty)
 415                      )) ^ ")"
 416   | Label_type -> "label"
 417   | Ppc_fp128_type -> "ppc_fp128"
 418   | Fp128_type -> "fp128"
 419   | X86fp80_type -> "x86_fp80"
 420   | Double_type -> "double"
 421   | Float_type -> "float"
 422   | Void_type -> "void"