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