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