1 (*===-- llvm/llvm.ml - LLVM Ocaml Interface --------------------------------===*
3 * The LLVM Compiler Infrastructure
5 * This file is distributed under the University of Illinois Open Source
6 * License. See LICENSE.TXT for details.
8 *===----------------------------------------------------------------------===*)
21 module TypeKind = struct
41 module Linkage = struct
44 | Available_externally
60 module Visibility = struct
67 module CallConv = struct
75 module Attribute = struct
134 exception IoError of string
136 external register_exns : exn -> unit = "llvm_register_core_exns"
137 let _ = register_exns (IoError "")
139 type ('a, 'b) llpos =
143 type ('a, 'b) llrev_pos =
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"
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
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"
170 (*===-- Types -------------------------------------------------------------===*)
171 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
172 external type_context : lltype -> llcontext = "llvm_type_context"
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"
181 external integer_type : llcontext -> int -> lltype = "llvm_integer_type"
182 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
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"
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"
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"
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"
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"
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"
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"
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"
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"
241 (*--... Operations on constants of (mostly) any type .......................--*)
242 external is_constant : llvalue -> bool = "llvm_is_constant"
243 external const_null : lltype -> llvalue = "LLVMConstNull"
244 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
245 external undef : lltype -> llvalue = "LLVMGetUndef"
246 external is_null : llvalue -> bool = "llvm_is_null"
247 external is_undef : llvalue -> bool = "llvm_is_undef"
249 (*--... Operations on instructions .........................................--*)
250 external has_metadata : llvalue -> bool = "llvm_has_metadata"
251 external metadata : llvalue -> int -> llvalue option = "llvm_metadata"
252 external set_metadata : llvalue -> int -> llvalue -> unit = "llvm_set_metadata"
253 external clear_metadata : llvalue -> int -> unit = "llvm_clear_metadata"
255 (*--... Operations on metadata .......,.....................................--*)
256 external mdstring : llcontext -> string -> llvalue = "llvm_mdstring"
257 external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode"
259 (*--... Operations on scalar constants .....................................--*)
260 external const_int : lltype -> int -> llvalue = "llvm_const_int"
261 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
262 = "llvm_const_of_int64"
263 external const_int_of_string : lltype -> string -> int -> llvalue
264 = "llvm_const_int_of_string"
265 external const_float : lltype -> float -> llvalue = "llvm_const_float"
266 external const_float_of_string : lltype -> string -> llvalue
267 = "llvm_const_float_of_string"
269 (*--... Operations on composite constants ..................................--*)
270 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
271 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
272 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
273 external const_struct : llcontext -> llvalue array -> llvalue
274 = "llvm_const_struct"
275 external const_packed_struct : llcontext -> llvalue array -> llvalue
276 = "llvm_const_packed_struct"
277 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
278 external const_union : lltype -> llvalue -> llvalue = "LLVMConstUnion"
280 (*--... Constant expressions ...............................................--*)
281 external align_of : lltype -> llvalue = "LLVMAlignOf"
282 external size_of : lltype -> llvalue = "LLVMSizeOf"
283 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
284 external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg"
285 external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg"
286 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
287 external const_not : llvalue -> llvalue = "LLVMConstNot"
288 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
289 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
290 external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd"
291 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
292 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
293 external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub"
294 external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub"
295 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
296 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
297 external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul"
298 external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul"
299 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
300 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
301 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
302 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
303 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
304 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
305 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
306 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
307 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
308 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
309 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
310 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
312 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
314 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
315 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
316 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
317 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
318 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
319 = "llvm_const_in_bounds_gep"
320 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
321 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
322 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
323 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
324 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
325 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
326 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
327 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
328 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
329 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
330 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
331 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
332 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
333 = "LLVMConstZExtOrBitCast"
334 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
335 = "LLVMConstSExtOrBitCast"
336 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
337 = "LLVMConstTruncOrBitCast"
338 external const_pointercast : llvalue -> lltype -> llvalue
339 = "LLVMConstPointerCast"
340 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
341 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
342 external const_select : llvalue -> llvalue -> llvalue -> llvalue
344 external const_extractelement : llvalue -> llvalue -> llvalue
345 = "LLVMConstExtractElement"
346 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
347 = "LLVMConstInsertElement"
348 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
349 = "LLVMConstShuffleVector"
350 external const_extractvalue : llvalue -> int array -> llvalue
351 = "llvm_const_extractvalue"
352 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
353 = "llvm_const_insertvalue"
354 external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress"
356 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
357 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
358 external is_declaration : llvalue -> bool = "llvm_is_declaration"
359 external linkage : llvalue -> Linkage.t = "llvm_linkage"
360 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
361 external section : llvalue -> string = "llvm_section"
362 external set_section : string -> llvalue -> unit = "llvm_set_section"
363 external visibility : llvalue -> Visibility.t = "llvm_visibility"
364 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
365 external alignment : llvalue -> int = "llvm_alignment"
366 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
367 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
368 external set_global_constant : bool -> llvalue -> unit
369 = "llvm_set_global_constant"
371 (*--... Operations on global variables .....................................--*)
372 external declare_global : lltype -> string -> llmodule -> llvalue
373 = "llvm_declare_global"
374 external define_global : string -> llvalue -> llmodule -> llvalue
375 = "llvm_define_global"
376 external lookup_global : string -> llmodule -> llvalue option
377 = "llvm_lookup_global"
378 external delete_global : llvalue -> unit = "llvm_delete_global"
379 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
380 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
381 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
382 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
383 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
384 external global_begin : llmodule -> (llmodule, llvalue) llpos
385 = "llvm_global_begin"
386 external global_succ : llvalue -> (llmodule, llvalue) llpos
388 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
390 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
393 let rec iter_global_range f i e =
394 if i = e then () else
396 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
399 iter_global_range f (global_succ bb) e
401 let iter_globals f m =
402 iter_global_range f (global_begin m) (At_end m)
404 let rec fold_left_global_range f init i e =
405 if i = e then init else
407 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
408 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
410 let fold_left_globals f init m =
411 fold_left_global_range f init (global_begin m) (At_end m)
413 let rec rev_iter_global_range f i e =
414 if i = e then () else
416 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
419 rev_iter_global_range f (global_pred bb) e
421 let rev_iter_globals f m =
422 rev_iter_global_range f (global_end m) (At_start m)
424 let rec fold_right_global_range f i e init =
425 if i = e then init else
427 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
428 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
430 let fold_right_globals f m init =
431 fold_right_global_range f (global_end m) (At_start m) init
433 (*--... Operations on functions ............................................--*)
434 external declare_function : string -> lltype -> llmodule -> llvalue
435 = "llvm_declare_function"
436 external define_function : string -> lltype -> llmodule -> llvalue
437 = "llvm_define_function"
438 external lookup_function : string -> llmodule -> llvalue option
439 = "llvm_lookup_function"
440 external delete_function : llvalue -> unit = "llvm_delete_function"
441 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
442 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
443 external set_function_call_conv : int -> llvalue -> unit
444 = "llvm_set_function_call_conv"
445 external gc : llvalue -> string option = "llvm_gc"
446 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
447 external function_begin : llmodule -> (llmodule, llvalue) llpos
448 = "llvm_function_begin"
449 external function_succ : llvalue -> (llmodule, llvalue) llpos
450 = "llvm_function_succ"
451 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
452 = "llvm_function_end"
453 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
454 = "llvm_function_pred"
456 let rec iter_function_range f i e =
457 if i = e then () else
459 | At_end _ -> raise (Invalid_argument "Invalid function range.")
462 iter_function_range f (function_succ fn) e
464 let iter_functions f m =
465 iter_function_range f (function_begin m) (At_end m)
467 let rec fold_left_function_range f init i e =
468 if i = e then init else
470 | At_end _ -> raise (Invalid_argument "Invalid function range.")
471 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
473 let fold_left_functions f init m =
474 fold_left_function_range f init (function_begin m) (At_end m)
476 let rec rev_iter_function_range f i e =
477 if i = e then () else
479 | At_start _ -> raise (Invalid_argument "Invalid function range.")
482 rev_iter_function_range f (function_pred fn) e
484 let rev_iter_functions f m =
485 rev_iter_function_range f (function_end m) (At_start m)
487 let rec fold_right_function_range f i e init =
488 if i = e then init else
490 | At_start _ -> raise (Invalid_argument "Invalid function range.")
491 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
493 let fold_right_functions f m init =
494 fold_right_function_range f (function_end m) (At_start m) init
496 external add_function_attr : llvalue -> Attribute.t -> unit
497 = "llvm_add_function_attr"
498 external remove_function_attr : llvalue -> Attribute.t -> unit
499 = "llvm_remove_function_attr"
501 (*--... Operations on params ...............................................--*)
502 external params : llvalue -> llvalue array = "llvm_params"
503 external param : llvalue -> int -> llvalue = "llvm_param"
504 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
505 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
506 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
507 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
508 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
510 let rec iter_param_range f i e =
511 if i = e then () else
513 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
516 iter_param_range f (param_succ p) e
518 let iter_params f fn =
519 iter_param_range f (param_begin fn) (At_end fn)
521 let rec fold_left_param_range f init i e =
522 if i = e then init else
524 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
525 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
527 let fold_left_params f init fn =
528 fold_left_param_range f init (param_begin fn) (At_end fn)
530 let rec rev_iter_param_range f i e =
531 if i = e then () else
533 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
536 rev_iter_param_range f (param_pred p) e
538 let rev_iter_params f fn =
539 rev_iter_param_range f (param_end fn) (At_start fn)
541 let rec fold_right_param_range f init i e =
542 if i = e then init else
544 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
545 | After p -> fold_right_param_range f (f p init) (param_pred p) e
547 let fold_right_params f fn init =
548 fold_right_param_range f init (param_end fn) (At_start fn)
550 external add_param_attr : llvalue -> Attribute.t -> unit
551 = "llvm_add_param_attr"
552 external remove_param_attr : llvalue -> Attribute.t -> unit
553 = "llvm_remove_param_attr"
554 external set_param_alignment : llvalue -> int -> unit
555 = "llvm_set_param_alignment"
557 (*--... Operations on basic blocks .........................................--*)
558 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
559 external value_is_block : llvalue -> bool = "llvm_value_is_block"
560 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
561 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
562 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
563 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
564 external delete_block : llbasicblock -> unit = "llvm_delete_block"
565 external append_block : llcontext -> string -> llvalue -> llbasicblock
566 = "llvm_append_block"
567 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
568 = "llvm_insert_block"
569 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
571 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
573 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
575 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
578 let rec iter_block_range f i e =
579 if i = e then () else
581 | At_end _ -> raise (Invalid_argument "Invalid block range.")
584 iter_block_range f (block_succ bb) e
586 let iter_blocks f fn =
587 iter_block_range f (block_begin fn) (At_end fn)
589 let rec fold_left_block_range f init i e =
590 if i = e then init else
592 | At_end _ -> raise (Invalid_argument "Invalid block range.")
593 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
595 let fold_left_blocks f init fn =
596 fold_left_block_range f init (block_begin fn) (At_end fn)
598 let rec rev_iter_block_range f i e =
599 if i = e then () else
601 | At_start _ -> raise (Invalid_argument "Invalid block range.")
604 rev_iter_block_range f (block_pred bb) e
606 let rev_iter_blocks f fn =
607 rev_iter_block_range f (block_end fn) (At_start fn)
609 let rec fold_right_block_range f init i e =
610 if i = e then init else
612 | At_start _ -> raise (Invalid_argument "Invalid block range.")
613 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
615 let fold_right_blocks f fn init =
616 fold_right_block_range f init (block_end fn) (At_start fn)
618 (*--... Operations on instructions .........................................--*)
619 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
620 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
622 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
624 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
626 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
629 let rec iter_instrs_range f i e =
630 if i = e then () else
632 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
635 iter_instrs_range f (instr_succ i) e
637 let iter_instrs f bb =
638 iter_instrs_range f (instr_begin bb) (At_end bb)
640 let rec fold_left_instrs_range f init i e =
641 if i = e then init else
643 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
644 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
646 let fold_left_instrs f init bb =
647 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
649 let rec rev_iter_instrs_range f i e =
650 if i = e then () else
652 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
655 rev_iter_instrs_range f (instr_pred i) e
657 let rev_iter_instrs f bb =
658 rev_iter_instrs_range f (instr_end bb) (At_start bb)
660 let rec fold_right_instr_range f i e init =
661 if i = e then init else
663 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
664 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
666 let fold_right_instrs f bb init =
667 fold_right_instr_range f (instr_end bb) (At_start bb) init
670 (*--... Operations on call sites ...........................................--*)
671 external instruction_call_conv: llvalue -> int
672 = "llvm_instruction_call_conv"
673 external set_instruction_call_conv: int -> llvalue -> unit
674 = "llvm_set_instruction_call_conv"
675 external add_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
676 = "llvm_add_instruction_param_attr"
677 external remove_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
678 = "llvm_remove_instruction_param_attr"
680 (*--... Operations on call instructions (only) .............................--*)
681 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
682 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
684 (*--... Operations on phi nodes ............................................--*)
685 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
686 = "llvm_add_incoming"
687 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
690 (*===-- Instruction builders ----------------------------------------------===*)
691 external builder : llcontext -> llbuilder = "llvm_builder"
692 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
693 = "llvm_position_builder"
694 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
695 external insert_into_builder : llvalue -> string -> llbuilder -> unit
696 = "llvm_insert_into_builder"
698 let builder_at context ip =
699 let b = builder context in
700 position_builder ip b;
703 let builder_before context i = builder_at context (Before i)
704 let builder_at_end context bb = builder_at context (At_end bb)
706 let position_before i = position_builder (Before i)
707 let position_at_end bb = position_builder (At_end bb)
710 (*--... Metadata ...........................................................--*)
711 external set_current_debug_location : llbuilder -> llvalue -> unit
712 = "llvm_set_current_debug_location"
713 external clear_current_debug_location : llbuilder -> unit
714 = "llvm_clear_current_debug_location"
715 external current_debug_location : llbuilder -> llvalue option
716 = "llvm_current_debug_location"
717 external set_inst_debug_location : llbuilder -> llvalue -> unit
718 = "llvm_set_inst_debug_location"
721 (*--... Terminators ........................................................--*)
722 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
723 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
724 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
725 = "llvm_build_aggregate_ret"
726 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
727 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
728 llvalue = "llvm_build_cond_br"
729 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
730 = "llvm_build_switch"
731 external add_case : llvalue -> llvalue -> llbasicblock -> unit
733 external build_indirect_br : llvalue -> int -> llbuilder -> llvalue
734 = "llvm_build_indirect_br"
735 external add_destination : llvalue -> llbasicblock -> unit
736 = "llvm_add_destination"
737 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
738 llbasicblock -> string -> llbuilder -> llvalue
739 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
740 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
741 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
743 (*--... Arithmetic .........................................................--*)
744 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
746 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
747 = "llvm_build_nsw_add"
748 external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
749 = "llvm_build_nuw_add"
750 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
752 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
754 external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
755 = "llvm_build_nsw_sub"
756 external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
757 = "llvm_build_nuw_sub"
758 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
760 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
762 external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
763 = "llvm_build_nsw_mul"
764 external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
765 = "llvm_build_nuw_mul"
766 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
768 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
770 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
772 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
773 = "llvm_build_exact_sdiv"
774 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
776 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
778 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
780 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
782 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
784 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
786 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
788 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
790 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
792 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
794 external build_neg : llvalue -> string -> llbuilder -> llvalue
796 external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
797 = "llvm_build_nsw_neg"
798 external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
799 = "llvm_build_nuw_neg"
800 external build_fneg : llvalue -> string -> llbuilder -> llvalue
802 external build_not : llvalue -> string -> llbuilder -> llvalue
805 (*--... Memory .............................................................--*)
806 external build_alloca : lltype -> string -> llbuilder -> llvalue
807 = "llvm_build_alloca"
808 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
809 llvalue = "llvm_build_array_alloca"
810 external build_load : llvalue -> string -> llbuilder -> llvalue
812 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
814 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
816 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
817 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
818 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
819 = "llvm_build_struct_gep"
821 external build_global_string : string -> string -> llbuilder -> llvalue
822 = "llvm_build_global_string"
823 external build_global_stringptr : string -> string -> llbuilder -> llvalue
824 = "llvm_build_global_stringptr"
826 (*--... Casts ..............................................................--*)
827 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
829 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
831 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
833 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
834 = "llvm_build_fptoui"
835 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
836 = "llvm_build_fptosi"
837 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
838 = "llvm_build_uitofp"
839 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
840 = "llvm_build_sitofp"
841 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
842 = "llvm_build_fptrunc"
843 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
845 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
846 = "llvm_build_prttoint"
847 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
848 = "llvm_build_inttoptr"
849 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
850 = "llvm_build_bitcast"
851 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
852 llvalue = "llvm_build_zext_or_bitcast"
853 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
854 llvalue = "llvm_build_sext_or_bitcast"
855 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
856 llvalue = "llvm_build_trunc_or_bitcast"
857 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
858 = "llvm_build_pointercast"
859 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
860 = "llvm_build_intcast"
861 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
862 = "llvm_build_fpcast"
864 (*--... Comparisons ........................................................--*)
865 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
866 llbuilder -> llvalue = "llvm_build_icmp"
867 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
868 llbuilder -> llvalue = "llvm_build_fcmp"
870 (*--... Miscellaneous instructions .........................................--*)
871 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
872 llvalue = "llvm_build_phi"
873 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
875 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
876 llvalue = "llvm_build_select"
877 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
878 = "llvm_build_va_arg"
879 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
880 llvalue = "llvm_build_extractelement"
881 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
882 llbuilder -> llvalue = "llvm_build_insertelement"
883 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
884 llbuilder -> llvalue = "llvm_build_shufflevector"
885 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
886 = "llvm_build_extractvalue"
887 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
888 llvalue = "llvm_build_insertvalue"
890 external build_is_null : llvalue -> string -> llbuilder -> llvalue
891 = "llvm_build_is_null"
892 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
893 = "llvm_build_is_not_null"
894 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
895 = "llvm_build_ptrdiff"
897 (*===-- Module providers --------------------------------------------------===*)
899 module ModuleProvider = struct
900 external create : llmodule -> llmoduleprovider
901 = "LLVMCreateModuleProviderForExistingModule"
902 external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider"
906 (*===-- Memory buffers ----------------------------------------------------===*)
908 module MemoryBuffer = struct
909 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
910 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
911 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
915 (*===-- Pass Manager ------------------------------------------------------===*)
917 module PassManager = struct
919 type any = [ `Module | `Function ]
920 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
921 external create_function : llmoduleprovider -> [ `Function ] t
922 = "LLVMCreateFunctionPassManager"
923 external run_module : llmodule -> [ `Module ] t -> bool
924 = "llvm_passmanager_run_module"
925 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
926 external run_function : llvalue -> [ `Function ] t -> bool
927 = "llvm_passmanager_run_function"
928 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
929 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
933 (*===-- Non-Externs -------------------------------------------------------===*)
934 (* These functions are built using the externals, so must be declared late. *)
936 let concat2 sep arr =
938 if 0 < Array.length arr then begin
940 for i = 1 to (Array.length arr) - 1 do
941 s := !s ^ sep ^ arr.(i)
946 let rec string_of_lltype ty =
947 (* FIXME: stop infinite recursion! :) *)
948 match classify_type ty with
949 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
950 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
952 let s = "{ " ^ (concat2 ", " (
953 Array.map string_of_lltype (struct_element_types ty)
958 | TypeKind.Union -> "union { " ^ (concat2 ", " (
959 Array.map string_of_lltype (union_element_types ty)
961 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
962 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
963 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
964 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
965 | TypeKind.Opaque -> "opaque"
966 | TypeKind.Function -> string_of_lltype (return_type ty) ^
967 " (" ^ (concat2 ", " (
968 Array.map string_of_lltype (param_types ty)
970 | TypeKind.Label -> "label"
971 | TypeKind.Ppc_fp128 -> "ppc_fp128"
972 | TypeKind.Fp128 -> "fp128"
973 | TypeKind.X86fp80 -> "x86_fp80"
974 | TypeKind.Double -> "double"
975 | TypeKind.Float -> "float"
976 | TypeKind.Void -> "void"
977 | TypeKind.Metadata -> "metadata"