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