Adding a collector name attribute to Function in the IR. These
[oota-llvm.git] / 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
11 type llmodule
12 type lltype
13 type lltypehandle
14 type llvalue
15 type llbasicblock
16 type llbuilder
17
18 type type_kind =
19   Void_type
20 | Float_type
21 | Double_type
22 | X86fp80_type
23 | Fp128_type
24 | Ppc_fp128_type
25 | Label_type
26 | Integer_type
27 | Function_type
28 | Struct_type
29 | Array_type
30 | Pointer_type 
31 | Opaque_type
32 | Vector_type
33
34 type linkage =
35   External_linkage
36 | Link_once_linkage
37 | Weak_linkage
38 | Appending_linkage
39 | Internal_linkage
40 | Dllimport_linkage
41 | Dllexport_linkage
42 | External_weak_linkage
43 | Ghost_linkage
44
45 type visibility =
46   Default_visibility
47 | Hidden_visibility
48 | Protected_visibility
49
50 let ccc = 0
51 let fastcc = 8
52 let coldcc = 9
53 let x86_stdcallcc = 64
54 let x86_fastcallcc = 65
55
56 type int_predicate =
57   Icmp_eq
58 | Icmp_ne
59 | Icmp_ugt
60 | Icmp_uge
61 | Icmp_ult
62 | Icmp_ule
63 | Icmp_sgt
64 | Icmp_sge
65 | Icmp_slt
66 | Icmp_sle
67
68 type real_predicate =
69   Fcmp_false
70 | Fcmp_oeq
71 | Fcmp_ogt
72 | Fcmp_oge
73 | Fcmp_olt
74 | Fcmp_ole
75 | Fcmp_one
76 | Fcmp_ord
77 | Fcmp_uno
78 | Fcmp_ueq
79 | Fcmp_ugt
80 | Fcmp_uge
81 | Fcmp_ult
82 | Fcmp_ule
83 | Fcmp_une
84 | Fcmp_true
85
86
87 (*===-- Modules -----------------------------------------------------------===*)
88
89 external create_module : string -> llmodule = "llvm_create_module"
90 external dispose_module : llmodule -> unit = "llvm_dispose_module"
91 external define_type_name : string -> lltype -> llmodule -> bool
92                           = "llvm_add_type_name"
93 external delete_type_name : string -> llmodule -> unit
94                           = "llvm_delete_type_name"
95
96
97 (*===-- Types -------------------------------------------------------------===*)
98
99 external classify_type : lltype -> type_kind = "llvm_classify_type"
100
101 (*--... Operations on integer types ........................................--*)
102 external _i1_type : unit -> lltype = "llvm_i1_type"
103 external _i8_type : unit -> lltype = "llvm_i8_type"
104 external _i16_type : unit -> lltype = "llvm_i16_type"
105 external _i32_type : unit -> lltype = "llvm_i32_type"
106 external _i64_type : unit -> lltype = "llvm_i64_type"
107
108 let i1_type = _i1_type ()
109 let i8_type = _i8_type ()
110 let i16_type = _i16_type ()
111 let i32_type = _i32_type ()
112 let i64_type = _i64_type ()
113
114 external integer_type : int -> lltype = "llvm_integer_type"
115 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
116
117 (*--... Operations on real types ...........................................--*)
118 external _float_type : unit -> lltype = "llvm_float_type"
119 external _double_type : unit -> lltype = "llvm_double_type"
120 external _x86fp80_type : unit -> lltype = "llvm_x86fp80_type"
121 external _fp128_type : unit -> lltype = "llvm_fp128_type"
122 external _ppc_fp128_type : unit -> lltype = "llvm_ppc_fp128_type"
123
124 let float_type = _float_type ()
125 let double_type = _double_type ()
126 let x86fp80_type = _x86fp80_type ()
127 let fp128_type = _fp128_type ()
128 let ppc_fp128_type = _ppc_fp128_type ()
129
130 (*--... Operations on function types .......................................--*)
131 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
132 external var_arg_function_type : lltype -> lltype array -> lltype
133                                = "llvm_var_arg_function_type"
134 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
135 external return_type : lltype -> lltype = "LLVMGetReturnType"
136 external param_types : lltype -> lltype array = "llvm_param_types"
137
138 (*--... Operations on struct types .........................................--*)
139 external struct_type : lltype array -> lltype = "llvm_struct_type"
140 external packed_struct_type : lltype array -> lltype = "llvm_packed_struct_type"
141 external element_types : lltype -> lltype array = "llvm_element_types"
142 external is_packed : lltype -> bool = "llvm_is_packed"
143
144 (*--... Operations on pointer, vector, and array types .....................--*)
145 external array_type : lltype -> int -> lltype = "llvm_array_type"
146 external pointer_type : lltype -> lltype = "LLVMPointerType"
147 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
148
149 external element_type : lltype -> lltype = "LLVMGetElementType"
150 external array_length : lltype -> int = "llvm_array_length"
151 external vector_size : lltype -> int = "llvm_vector_size"
152
153 (*--... Operations on other types ..........................................--*)
154 external opaque_type : unit -> lltype = "llvm_opaque_type"
155 external _void_type : unit -> lltype = "llvm_void_type"
156 external _label_type : unit -> lltype = "llvm_label_type"
157
158 let void_type = _void_type ()
159 let label_type = _label_type ()
160
161 (*--... Operations on type handles .........................................--*)
162 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
163 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
164 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
165
166
167 (*===-- Values ------------------------------------------------------------===*)
168
169 external type_of : llvalue -> lltype = "llvm_type_of"
170 external value_name : llvalue -> string = "llvm_value_name"
171 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
172 external dump_value : llvalue -> unit = "llvm_dump_value"
173
174 (*--... Operations on constants of (mostly) any type .......................--*)
175 external is_constant : llvalue -> bool = "llvm_is_constant"
176 external const_null : lltype -> llvalue = "LLVMConstNull"
177 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
178 external undef : lltype -> llvalue = "LLVMGetUndef"
179 external is_null : llvalue -> bool = "llvm_is_null"
180 external is_undef : llvalue -> bool = "llvm_is_undef"
181
182 (*--... Operations on scalar constants .....................................--*)
183 external const_int : lltype -> int -> llvalue = "llvm_const_int"
184 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
185                         = "llvm_const_of_int64"
186 external const_float : lltype -> float -> llvalue = "llvm_const_float"
187
188 (*--... Operations on composite constants ..................................--*)
189 external const_string : string -> llvalue = "llvm_const_string"
190 external const_stringz : string -> llvalue = "llvm_const_stringz"
191 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
192 external const_struct : llvalue array -> llvalue = "llvm_const_struct"
193 external const_packed_struct : llvalue array -> llvalue
194                              = "llvm_const_packed_struct"
195 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
196
197 (*--... Constant expressions ...............................................--*)
198 external size_of : lltype -> llvalue = "LLVMSizeOf"
199 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
200 external const_not : llvalue -> llvalue = "LLVMConstNot"
201 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
202 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
203 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
204 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
205 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
206 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
207 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
208 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
209 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
210 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
211 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
212 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
213 external const_icmp : int_predicate -> llvalue -> llvalue -> llvalue
214                     = "llvm_const_icmp"
215 external const_fcmp : real_predicate -> llvalue -> llvalue -> llvalue
216                     = "llvm_const_fcmp"
217 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
218 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
219 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
220 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
221 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
222 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
223 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
224 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
225 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
226 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
227 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
228 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
229 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
230 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
231 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
232 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
233 external const_select : llvalue -> llvalue -> llvalue -> llvalue
234                       = "LLVMConstSelect"
235 external const_extractelement : llvalue -> llvalue -> llvalue
236                               = "LLVMConstExtractElement"
237 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
238                              = "LLVMConstInsertElement"
239 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
240                              = "LLVMConstShuffleVector"
241
242 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
243 external is_declaration : llvalue -> bool = "llvm_is_declaration"
244 external linkage : llvalue -> linkage = "llvm_linkage"
245 external set_linkage : linkage -> llvalue -> unit = "llvm_set_linkage"
246 external section : llvalue -> string = "llvm_section"
247 external set_section : string -> llvalue -> unit = "llvm_set_section"
248 external visibility : llvalue -> visibility = "llvm_visibility"
249 external set_visibility : visibility -> llvalue -> unit = "llvm_set_visibility"
250 external alignment : llvalue -> int = "llvm_alignment"
251 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
252 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
253 external set_global_constant : bool -> llvalue -> unit
254                              = "llvm_set_global_constant"
255
256 (*--... Operations on global variables .....................................--*)
257 external declare_global : lltype -> string -> llmodule -> llvalue
258                         = "llvm_declare_global"
259 external define_global : string -> llvalue -> llmodule -> llvalue
260                        = "llvm_define_global"
261 external lookup_global : string -> llmodule -> llvalue option
262                        = "llvm_lookup_global"
263 external delete_global : llvalue -> unit = "llvm_delete_global"
264 external has_initializer : llvalue -> bool = "llvm_has_initializer"
265 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
266 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
267 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
268 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
269 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
270
271 (*--... Operations on functions ............................................--*)
272 external declare_function : string -> lltype -> llmodule -> llvalue
273                           = "llvm_declare_function"
274 external define_function : string -> lltype -> llmodule -> llvalue
275                          = "llvm_define_function"
276 external lookup_function : string -> llmodule -> llvalue option
277                          = "llvm_lookup_function"
278 external delete_function : llvalue -> unit = "llvm_delete_function"
279 external params : llvalue -> llvalue array = "llvm_params"
280 external param : llvalue -> int -> llvalue = "llvm_param"
281 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
282 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
283 external set_function_call_conv : int -> llvalue -> unit
284                                 = "llvm_set_function_call_conv"
285 external collector : llvalue -> string option = "llvm_collector"
286 external set_collector : string option -> llvalue -> unit = "llvm_set_collector"
287
288 (* TODO: param attrs *)
289
290 (*--... Operations on basic blocks .........................................--*)
291 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
292 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
293 external delete_block : llbasicblock -> unit = "llvm_delete_block"
294 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
295 external insert_block : string -> llbasicblock -> llbasicblock
296                       = "llvm_insert_block"
297 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
298 external value_is_block : llvalue -> bool = "llvm_value_is_block"
299 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
300
301 (*--... Operations on phi nodes ............................................--*)
302 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
303                       = "llvm_add_incoming"
304 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
305
306
307 (*===-- Instruction builders ----------------------------------------------===*)
308 external builder_before : llvalue -> llbuilder = "llvm_builder_before"
309 external builder_at_end : llbasicblock -> llbuilder = "llvm_builder_at_end"
310 external position_before : llvalue -> llbuilder -> unit = "llvm_position_before"
311 external position_at_end : llbasicblock -> llbuilder -> unit
312                          = "llvm_position_at_end"
313
314 (*--... Terminators ........................................................--*)
315 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
316 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
317 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
318 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
319                          llvalue = "llvm_build_cond_br"
320 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
321                       = "llvm_build_switch"
322 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
323                         llbasicblock -> string -> llbuilder -> llvalue
324                       = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
325 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
326 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
327
328 (*--... Arithmetic .........................................................--*)
329 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
330                    = "llvm_build_add"
331 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
332                    = "llvm_build_sub"
333 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
334                    = "llvm_build_mul"
335 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
336                     = "llvm_build_udiv"
337 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
338                     = "llvm_build_sdiv"
339 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
340                     = "llvm_build_fdiv"
341 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
342                     = "llvm_build_urem"
343 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
344                     = "llvm_build_srem"
345 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
346                     = "llvm_build_frem"
347 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
348                    = "llvm_build_shl"
349 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
350                     = "llvm_build_lshr"
351 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
352                     = "llvm_build_ashr"
353 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
354                    = "llvm_build_and"
355 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
356                   = "llvm_build_or"
357 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
358                    = "llvm_build_xor"
359 external build_neg : llvalue -> string -> llbuilder -> llvalue
360                    = "llvm_build_neg"
361 external build_not : llvalue -> string -> llbuilder -> llvalue
362                    = "llvm_build_not"
363
364 (*--... Memory .............................................................--*)
365 external build_malloc : lltype -> string -> llbuilder -> llvalue
366                       = "llvm_build_malloc"
367 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
368                               llvalue = "llvm_build_array_malloc"
369 external build_alloca : lltype -> string -> llbuilder -> llvalue
370                       = "llvm_build_alloca"
371 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
372                               llvalue = "llvm_build_array_alloca"
373 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
374 external build_load : llvalue -> string -> llbuilder -> llvalue
375                     = "llvm_build_load"
376 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
377                      = "llvm_build_store"
378 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
379                    = "llvm_build_gep"
380
381 (*--... Casts ..............................................................--*)
382 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
383                      = "llvm_build_trunc"
384 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
385                     = "llvm_build_zext"
386 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
387                     = "llvm_build_sext"
388 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
389                       = "llvm_build_fptoui"
390 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
391                       = "llvm_build_fptosi"
392 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
393                       = "llvm_build_uitofp"
394 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
395                       = "llvm_build_sitofp"
396 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
397                        = "llvm_build_fptrunc"
398 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
399                      = "llvm_build_fpext"
400 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
401                         = "llvm_build_prttoint"
402 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
403                         = "llvm_build_inttoptr"
404 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
405                        = "llvm_build_bitcast"
406
407 (*--... Comparisons ........................................................--*)
408 external build_icmp : int_predicate -> llvalue -> llvalue -> string ->
409                       llbuilder -> llvalue = "llvm_build_icmp"
410 external build_fcmp : real_predicate -> llvalue -> llvalue -> string ->
411                       llbuilder -> llvalue = "llvm_build_fcmp"
412
413 (*--... Miscellaneous instructions .........................................--*)
414 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
415                      llvalue = "llvm_build_phi"
416 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
417                     = "llvm_build_call"
418 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
419                         llvalue = "llvm_build_select"
420 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
421                       = "llvm_build_va_arg"
422 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
423                                 llvalue = "llvm_build_extractelement"
424 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
425                                llbuilder -> llvalue = "llvm_build_insertelement"
426 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
427                                llbuilder -> llvalue = "llvm_build_shufflevector"
428
429
430 (*===-- Non-Externs -------------------------------------------------------===*)
431 (* These functions are built using the externals, so must be declared late.   *)
432
433 let concat2 sep arr =
434   let s = ref "" in
435   if 0 < Array.length arr then begin
436     s := !s ^ arr.(0);
437     for i = 1 to (Array.length arr) - 1 do
438       s := !s ^ sep ^ arr.(i)
439     done
440   end;
441   !s
442
443 let rec string_of_lltype ty =
444   (* FIXME: stop infinite recursion! :) *)
445   match classify_type ty with
446     Integer_type -> "i" ^ string_of_int (integer_bitwidth ty)
447   | Pointer_type -> (string_of_lltype (element_type ty)) ^ "*"
448   | Struct_type ->
449       let s = "{ " ^ (concat2 ", " (
450                 Array.map string_of_lltype (element_types ty)
451               )) ^ " }" in
452       if is_packed ty
453         then "<" ^ s ^ ">"
454         else s
455   | Array_type -> "["   ^ (string_of_int (array_length ty)) ^
456                   " x " ^ (string_of_lltype (element_type ty)) ^ "]"
457   | Vector_type -> "<"   ^ (string_of_int (vector_size ty)) ^
458                    " x " ^ (string_of_lltype (element_type ty)) ^ ">"
459   | Opaque_type -> "opaque"
460   | Function_type -> string_of_lltype (return_type ty) ^
461                      " (" ^ (concat2 ", " (
462                        Array.map string_of_lltype (param_types ty)
463                      )) ^ ")"
464   | Label_type -> "label"
465   | Ppc_fp128_type -> "ppc_fp128"
466   | Fp128_type -> "fp128"
467   | X86fp80_type -> "x86_fp80"
468   | Double_type -> "double"
469   | Float_type -> "float"
470   | Void_type -> "void"