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