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 *===----------------------------------------------------------------------===*)
20 module TypeKind = struct
38 module Linkage = struct
41 | Available_externally
57 module Visibility = struct
64 module CallConv = struct
72 module Attribute = struct
96 | Stackalignment of int
133 module Opcode = struct
135 | Invalid (* not an instruction *)
136 (* Terminator Instructions *)
144 (* Standard Binary Operators *)
157 (* Logical Operators *)
164 (* Memory Operators *)
182 (* Other Operators *)
204 module ValueKind = struct
213 | ConstantAggregateZero
218 | ConstantPointerNull
225 | Instruction of Opcode.t
228 exception IoError of string
230 external register_exns : exn -> unit = "llvm_register_core_exns"
231 let _ = register_exns (IoError "")
233 type ('a, 'b) llpos =
237 type ('a, 'b) llrev_pos =
241 (*===-- Contexts ----------------------------------------------------------===*)
242 external create_context : unit -> llcontext = "llvm_create_context"
243 external dispose_context : llcontext -> unit = "llvm_dispose_context"
244 external global_context : unit -> llcontext = "llvm_global_context"
245 external mdkind_id : llcontext -> string -> int = "llvm_mdkind_id"
247 (*===-- Modules -----------------------------------------------------------===*)
248 external create_module : llcontext -> string -> llmodule = "llvm_create_module"
249 external dispose_module : llmodule -> unit = "llvm_dispose_module"
250 external target_triple: llmodule -> string
251 = "llvm_target_triple"
252 external set_target_triple: string -> llmodule -> unit
253 = "llvm_set_target_triple"
254 external data_layout: llmodule -> string
256 external set_data_layout: string -> llmodule -> unit
257 = "llvm_set_data_layout"
258 external dump_module : llmodule -> unit = "llvm_dump_module"
259 external set_module_inline_asm : llmodule -> string -> unit
260 = "llvm_set_module_inline_asm"
262 (*===-- Types -------------------------------------------------------------===*)
263 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
264 external type_context : lltype -> llcontext = "llvm_type_context"
265 external type_is_sized : lltype -> bool = "llvm_type_is_sized"
267 (*--... Operations on integer types ........................................--*)
268 external i1_type : llcontext -> lltype = "llvm_i1_type"
269 external i8_type : llcontext -> lltype = "llvm_i8_type"
270 external i16_type : llcontext -> lltype = "llvm_i16_type"
271 external i32_type : llcontext -> lltype = "llvm_i32_type"
272 external i64_type : llcontext -> lltype = "llvm_i64_type"
274 external integer_type : llcontext -> int -> lltype = "llvm_integer_type"
275 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
277 (*--... Operations on real types ...........................................--*)
278 external float_type : llcontext -> lltype = "llvm_float_type"
279 external double_type : llcontext -> lltype = "llvm_double_type"
280 external x86fp80_type : llcontext -> lltype = "llvm_x86fp80_type"
281 external fp128_type : llcontext -> lltype = "llvm_fp128_type"
282 external ppc_fp128_type : llcontext -> lltype = "llvm_ppc_fp128_type"
284 (*--... Operations on function types .......................................--*)
285 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
286 external var_arg_function_type : lltype -> lltype array -> lltype
287 = "llvm_var_arg_function_type"
288 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
289 external return_type : lltype -> lltype = "LLVMGetReturnType"
290 external param_types : lltype -> lltype array = "llvm_param_types"
292 (*--... Operations on struct types .........................................--*)
293 external struct_type : llcontext -> lltype array -> lltype = "llvm_struct_type"
294 external packed_struct_type : llcontext -> lltype array -> lltype
295 = "llvm_packed_struct_type"
296 external struct_name : lltype -> string option = "llvm_struct_name"
297 external struct_element_types : lltype -> lltype array
298 = "llvm_struct_element_types"
299 external is_packed : lltype -> bool = "llvm_is_packed"
301 (*--... Operations on pointer, vector, and array types .....................--*)
302 external array_type : lltype -> int -> lltype = "llvm_array_type"
303 external pointer_type : lltype -> lltype = "llvm_pointer_type"
304 external qualified_pointer_type : lltype -> int -> lltype
305 = "llvm_qualified_pointer_type"
306 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
308 external element_type : lltype -> lltype = "LLVMGetElementType"
309 external array_length : lltype -> int = "llvm_array_length"
310 external address_space : lltype -> int = "llvm_address_space"
311 external vector_size : lltype -> int = "llvm_vector_size"
313 (*--... Operations on other types ..........................................--*)
314 external void_type : llcontext -> lltype = "llvm_void_type"
315 external label_type : llcontext -> lltype = "llvm_label_type"
317 external classify_value : llvalue -> ValueKind.t = "llvm_classify_value"
318 (*===-- Values ------------------------------------------------------------===*)
319 external type_of : llvalue -> lltype = "llvm_type_of"
320 external value_name : llvalue -> string = "llvm_value_name"
321 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
322 external dump_value : llvalue -> unit = "llvm_dump_value"
323 external replace_all_uses_with : llvalue -> llvalue -> unit
324 = "LLVMReplaceAllUsesWith"
326 (*--... Operations on uses .................................................--*)
327 external use_begin : llvalue -> lluse option = "llvm_use_begin"
328 external use_succ : lluse -> lluse option = "llvm_use_succ"
329 external user : lluse -> llvalue = "llvm_user"
330 external used_value : lluse -> llvalue = "llvm_used_value"
333 let rec aux = function
341 let fold_left_uses f init v =
345 | Some u -> aux (f init u) (use_succ u)
347 aux init (use_begin v)
349 let fold_right_uses f v init =
353 | Some u -> f u (aux (use_succ u) init)
355 aux (use_begin v) init
358 (*--... Operations on users ................................................--*)
359 external operand : llvalue -> int -> llvalue = "llvm_operand"
360 external set_operand : llvalue -> int -> llvalue -> unit = "llvm_set_operand"
361 external num_operands : llvalue -> int = "llvm_num_operands"
363 (*--... Operations on constants of (mostly) any type .......................--*)
364 external is_constant : llvalue -> bool = "llvm_is_constant"
365 external const_null : lltype -> llvalue = "LLVMConstNull"
366 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
367 external const_pointer_null : lltype -> llvalue = "LLVMConstPointerNull"
368 external undef : lltype -> llvalue = "LLVMGetUndef"
369 external is_null : llvalue -> bool = "llvm_is_null"
370 external is_undef : llvalue -> bool = "llvm_is_undef"
371 external constexpr_opcode : llvalue -> Opcode.t = "llvm_constexpr_get_opcode"
373 (*--... Operations on instructions .........................................--*)
374 external has_metadata : llvalue -> bool = "llvm_has_metadata"
375 external metadata : llvalue -> int -> llvalue option = "llvm_metadata"
376 external set_metadata : llvalue -> int -> llvalue -> unit = "llvm_set_metadata"
377 external clear_metadata : llvalue -> int -> unit = "llvm_clear_metadata"
379 (*--... Operations on metadata .......,.....................................--*)
380 external mdstring : llcontext -> string -> llvalue = "llvm_mdstring"
381 external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode"
382 external get_mdstring : llvalue -> string option = "llvm_get_mdstring"
383 external get_named_metadata : llmodule -> string -> llvalue array = "llvm_get_namedmd"
385 (*--... Operations on scalar constants .....................................--*)
386 external const_int : lltype -> int -> llvalue = "llvm_const_int"
387 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
388 = "llvm_const_of_int64"
389 external int64_of_const : llvalue -> Int64.t option
390 = "llvm_int64_of_const"
391 external const_int_of_string : lltype -> string -> int -> llvalue
392 = "llvm_const_int_of_string"
393 external const_float : lltype -> float -> llvalue = "llvm_const_float"
394 external const_float_of_string : lltype -> string -> llvalue
395 = "llvm_const_float_of_string"
397 (*--... Operations on composite constants ..................................--*)
398 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
399 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
400 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
401 external const_struct : llcontext -> llvalue array -> llvalue
402 = "llvm_const_struct"
403 external const_packed_struct : llcontext -> llvalue array -> llvalue
404 = "llvm_const_packed_struct"
405 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
407 (*--... Constant expressions ...............................................--*)
408 external align_of : lltype -> llvalue = "LLVMAlignOf"
409 external size_of : lltype -> llvalue = "LLVMSizeOf"
410 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
411 external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg"
412 external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg"
413 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
414 external const_not : llvalue -> llvalue = "LLVMConstNot"
415 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
416 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
417 external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd"
418 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
419 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
420 external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub"
421 external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub"
422 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
423 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
424 external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul"
425 external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul"
426 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
427 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
428 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
429 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
430 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
431 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
432 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
433 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
434 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
435 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
436 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
437 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
439 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
441 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
442 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
443 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
444 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
445 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
446 = "llvm_const_in_bounds_gep"
447 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
448 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
449 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
450 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
451 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
452 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
453 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
454 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
455 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
456 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
457 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
458 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
459 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
460 = "LLVMConstZExtOrBitCast"
461 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
462 = "LLVMConstSExtOrBitCast"
463 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
464 = "LLVMConstTruncOrBitCast"
465 external const_pointercast : llvalue -> lltype -> llvalue
466 = "LLVMConstPointerCast"
467 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
468 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
469 external const_select : llvalue -> llvalue -> llvalue -> llvalue
471 external const_extractelement : llvalue -> llvalue -> llvalue
472 = "LLVMConstExtractElement"
473 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
474 = "LLVMConstInsertElement"
475 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
476 = "LLVMConstShuffleVector"
477 external const_extractvalue : llvalue -> int array -> llvalue
478 = "llvm_const_extractvalue"
479 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
480 = "llvm_const_insertvalue"
481 external const_inline_asm : lltype -> string -> string -> bool -> bool ->
483 = "llvm_const_inline_asm"
484 external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress"
486 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
487 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
488 external is_declaration : llvalue -> bool = "llvm_is_declaration"
489 external linkage : llvalue -> Linkage.t = "llvm_linkage"
490 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
491 external section : llvalue -> string = "llvm_section"
492 external set_section : string -> llvalue -> unit = "llvm_set_section"
493 external visibility : llvalue -> Visibility.t = "llvm_visibility"
494 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
495 external alignment : llvalue -> int = "llvm_alignment"
496 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
497 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
498 external set_global_constant : bool -> llvalue -> unit
499 = "llvm_set_global_constant"
501 (*--... Operations on global variables .....................................--*)
502 external declare_global : lltype -> string -> llmodule -> llvalue
503 = "llvm_declare_global"
504 external declare_qualified_global : lltype -> string -> int -> llmodule ->
506 = "llvm_declare_qualified_global"
507 external define_global : string -> llvalue -> llmodule -> llvalue
508 = "llvm_define_global"
509 external define_qualified_global : string -> llvalue -> int -> llmodule ->
511 = "llvm_define_qualified_global"
512 external lookup_global : string -> llmodule -> llvalue option
513 = "llvm_lookup_global"
514 external delete_global : llvalue -> unit = "llvm_delete_global"
515 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
516 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
517 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
518 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
519 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
520 external global_begin : llmodule -> (llmodule, llvalue) llpos
521 = "llvm_global_begin"
522 external global_succ : llvalue -> (llmodule, llvalue) llpos
524 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
526 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
529 let rec iter_global_range f i e =
530 if i = e then () else
532 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
535 iter_global_range f (global_succ bb) e
537 let iter_globals f m =
538 iter_global_range f (global_begin m) (At_end m)
540 let rec fold_left_global_range f init i e =
541 if i = e then init else
543 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
544 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
546 let fold_left_globals f init m =
547 fold_left_global_range f init (global_begin m) (At_end m)
549 let rec rev_iter_global_range f i e =
550 if i = e then () else
552 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
555 rev_iter_global_range f (global_pred bb) e
557 let rev_iter_globals f m =
558 rev_iter_global_range f (global_end m) (At_start m)
560 let rec fold_right_global_range f i e init =
561 if i = e then init else
563 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
564 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
566 let fold_right_globals f m init =
567 fold_right_global_range f (global_end m) (At_start m) init
569 (*--... Operations on aliases ..............................................--*)
570 external add_alias : llmodule -> lltype -> llvalue -> string -> llvalue
573 (*--... Operations on functions ............................................--*)
574 external declare_function : string -> lltype -> llmodule -> llvalue
575 = "llvm_declare_function"
576 external define_function : string -> lltype -> llmodule -> llvalue
577 = "llvm_define_function"
578 external lookup_function : string -> llmodule -> llvalue option
579 = "llvm_lookup_function"
580 external delete_function : llvalue -> unit = "llvm_delete_function"
581 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
582 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
583 external set_function_call_conv : int -> llvalue -> unit
584 = "llvm_set_function_call_conv"
585 external gc : llvalue -> string option = "llvm_gc"
586 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
587 external function_begin : llmodule -> (llmodule, llvalue) llpos
588 = "llvm_function_begin"
589 external function_succ : llvalue -> (llmodule, llvalue) llpos
590 = "llvm_function_succ"
591 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
592 = "llvm_function_end"
593 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
594 = "llvm_function_pred"
596 let rec iter_function_range f i e =
597 if i = e then () else
599 | At_end _ -> raise (Invalid_argument "Invalid function range.")
602 iter_function_range f (function_succ fn) e
604 let iter_functions f m =
605 iter_function_range f (function_begin m) (At_end m)
607 let rec fold_left_function_range f init i e =
608 if i = e then init else
610 | At_end _ -> raise (Invalid_argument "Invalid function range.")
611 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
613 let fold_left_functions f init m =
614 fold_left_function_range f init (function_begin m) (At_end m)
616 let rec rev_iter_function_range f i e =
617 if i = e then () else
619 | At_start _ -> raise (Invalid_argument "Invalid function range.")
622 rev_iter_function_range f (function_pred fn) e
624 let rev_iter_functions f m =
625 rev_iter_function_range f (function_end m) (At_start m)
627 let rec fold_right_function_range f i e init =
628 if i = e then init else
630 | At_start _ -> raise (Invalid_argument "Invalid function range.")
631 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
633 let fold_right_functions f m init =
634 fold_right_function_range f (function_end m) (At_start m) init
636 external llvm_add_function_attr : llvalue -> int -> unit
637 = "llvm_add_function_attr"
638 external llvm_remove_function_attr : llvalue -> int -> unit
639 = "llvm_remove_function_attr"
641 let pack_attr (attr:Attribute.t) : int =
643 Attribute.Zext -> 1 lsl 0
644 | Attribute.Sext -> 1 lsl 1
645 | Attribute.Noreturn -> 1 lsl 2
646 | Attribute.Inreg -> 1 lsl 3
647 | Attribute.Structret -> 1 lsl 4
648 | Attribute.Nounwind -> 1 lsl 5
649 | Attribute.Noalias -> 1 lsl 6
650 | Attribute.Byval -> 1 lsl 7
651 | Attribute.Nest -> 1 lsl 8
652 | Attribute.Readnone -> 1 lsl 9
653 | Attribute.Readonly -> 1 lsl 10
654 | Attribute.Noinline -> 1 lsl 11
655 | Attribute.Alwaysinline -> 1 lsl 12
656 | Attribute.Optsize -> 1 lsl 13
657 | Attribute.Ssp -> 1 lsl 14
658 | Attribute.Sspreq -> 1 lsl 15
659 | Attribute.Alignment n -> n lsl 16
660 | Attribute.Nocapture -> 1 lsl 21
661 | Attribute.Noredzone -> 1 lsl 22
662 | Attribute.Noimplicitfloat -> 1 lsl 23
663 | Attribute.Naked -> 1 lsl 24
664 | Attribute.Inlinehint -> 1 lsl 25
665 | Attribute.Stackalignment n -> n lsl 26
667 let add_function_attr llval attr =
668 llvm_add_function_attr llval (pack_attr attr)
670 let remove_function_attr llval attr =
671 llvm_remove_function_attr llval (pack_attr attr)
673 (*--... Operations on params ...............................................--*)
674 external params : llvalue -> llvalue array = "llvm_params"
675 external param : llvalue -> int -> llvalue = "llvm_param"
676 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
677 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
678 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
679 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
680 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
682 let rec iter_param_range f i e =
683 if i = e then () else
685 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
688 iter_param_range f (param_succ p) e
690 let iter_params f fn =
691 iter_param_range f (param_begin fn) (At_end fn)
693 let rec fold_left_param_range f init i e =
694 if i = e then init else
696 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
697 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
699 let fold_left_params f init fn =
700 fold_left_param_range f init (param_begin fn) (At_end fn)
702 let rec rev_iter_param_range f i e =
703 if i = e then () else
705 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
708 rev_iter_param_range f (param_pred p) e
710 let rev_iter_params f fn =
711 rev_iter_param_range f (param_end fn) (At_start fn)
713 let rec fold_right_param_range f init i e =
714 if i = e then init else
716 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
717 | After p -> fold_right_param_range f (f p init) (param_pred p) e
719 let fold_right_params f fn init =
720 fold_right_param_range f init (param_end fn) (At_start fn)
722 external llvm_add_param_attr : llvalue -> int -> unit
723 = "llvm_add_param_attr"
724 external llvm_remove_param_attr : llvalue -> int -> unit
725 = "llvm_remove_param_attr"
727 let add_param_attr llval attr =
728 llvm_add_param_attr llval (pack_attr attr)
730 let remove_param_attr llval attr =
731 llvm_remove_param_attr llval (pack_attr attr)
733 external set_param_alignment : llvalue -> int -> unit
734 = "llvm_set_param_alignment"
736 (*--... Operations on basic blocks .........................................--*)
737 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
738 external value_is_block : llvalue -> bool = "llvm_value_is_block"
739 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
740 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
741 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
742 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
743 external delete_block : llbasicblock -> unit = "llvm_delete_block"
744 external append_block : llcontext -> string -> llvalue -> llbasicblock
745 = "llvm_append_block"
746 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
747 = "llvm_insert_block"
748 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
750 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
752 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
754 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
757 let rec iter_block_range f i e =
758 if i = e then () else
760 | At_end _ -> raise (Invalid_argument "Invalid block range.")
763 iter_block_range f (block_succ bb) e
765 let iter_blocks f fn =
766 iter_block_range f (block_begin fn) (At_end fn)
768 let rec fold_left_block_range f init i e =
769 if i = e then init else
771 | At_end _ -> raise (Invalid_argument "Invalid block range.")
772 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
774 let fold_left_blocks f init fn =
775 fold_left_block_range f init (block_begin fn) (At_end fn)
777 let rec rev_iter_block_range f i e =
778 if i = e then () else
780 | At_start _ -> raise (Invalid_argument "Invalid block range.")
783 rev_iter_block_range f (block_pred bb) e
785 let rev_iter_blocks f fn =
786 rev_iter_block_range f (block_end fn) (At_start fn)
788 let rec fold_right_block_range f init i e =
789 if i = e then init else
791 | At_start _ -> raise (Invalid_argument "Invalid block range.")
792 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
794 let fold_right_blocks f fn init =
795 fold_right_block_range f init (block_end fn) (At_start fn)
797 (*--... Operations on instructions .........................................--*)
798 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
799 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
801 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
803 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
805 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
808 external instr_opcode : llvalue -> Opcode.t = "llvm_instr_get_opcode"
809 external icmp_predicate : llvalue -> Icmp.t option = "llvm_instr_icmp_predicate"
811 let rec iter_instrs_range f i e =
812 if i = e then () else
814 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
817 iter_instrs_range f (instr_succ i) e
819 let iter_instrs f bb =
820 iter_instrs_range f (instr_begin bb) (At_end bb)
822 let rec fold_left_instrs_range f init i e =
823 if i = e then init else
825 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
826 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
828 let fold_left_instrs f init bb =
829 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
831 let rec rev_iter_instrs_range f i e =
832 if i = e then () else
834 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
837 rev_iter_instrs_range f (instr_pred i) e
839 let rev_iter_instrs f bb =
840 rev_iter_instrs_range f (instr_end bb) (At_start bb)
842 let rec fold_right_instr_range f i e init =
843 if i = e then init else
845 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
846 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
848 let fold_right_instrs f bb init =
849 fold_right_instr_range f (instr_end bb) (At_start bb) init
852 (*--... Operations on call sites ...........................................--*)
853 external instruction_call_conv: llvalue -> int
854 = "llvm_instruction_call_conv"
855 external set_instruction_call_conv: int -> llvalue -> unit
856 = "llvm_set_instruction_call_conv"
858 external llvm_add_instruction_param_attr : llvalue -> int -> int -> unit
859 = "llvm_add_instruction_param_attr"
860 external llvm_remove_instruction_param_attr : llvalue -> int -> int -> unit
861 = "llvm_remove_instruction_param_attr"
863 let add_instruction_param_attr llval i attr =
864 llvm_add_instruction_param_attr llval i (pack_attr attr)
866 let remove_instruction_param_attr llval i attr =
867 llvm_remove_instruction_param_attr llval i (pack_attr attr)
869 (*--... Operations on call instructions (only) .............................--*)
870 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
871 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
873 (*--... Operations on phi nodes ............................................--*)
874 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
875 = "llvm_add_incoming"
876 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
879 (*===-- Instruction builders ----------------------------------------------===*)
880 external builder : llcontext -> llbuilder = "llvm_builder"
881 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
882 = "llvm_position_builder"
883 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
884 external insert_into_builder : llvalue -> string -> llbuilder -> unit
885 = "llvm_insert_into_builder"
887 let builder_at context ip =
888 let b = builder context in
889 position_builder ip b;
892 let builder_before context i = builder_at context (Before i)
893 let builder_at_end context bb = builder_at context (At_end bb)
895 let position_before i = position_builder (Before i)
896 let position_at_end bb = position_builder (At_end bb)
899 (*--... Metadata ...........................................................--*)
900 external set_current_debug_location : llbuilder -> llvalue -> unit
901 = "llvm_set_current_debug_location"
902 external clear_current_debug_location : llbuilder -> unit
903 = "llvm_clear_current_debug_location"
904 external current_debug_location : llbuilder -> llvalue option
905 = "llvm_current_debug_location"
906 external set_inst_debug_location : llbuilder -> llvalue -> unit
907 = "llvm_set_inst_debug_location"
910 (*--... Terminators ........................................................--*)
911 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
912 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
913 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
914 = "llvm_build_aggregate_ret"
915 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
916 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
917 llvalue = "llvm_build_cond_br"
918 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
919 = "llvm_build_switch"
920 external add_case : llvalue -> llvalue -> llbasicblock -> unit
922 external build_indirect_br : llvalue -> int -> llbuilder -> llvalue
923 = "llvm_build_indirect_br"
924 external add_destination : llvalue -> llbasicblock -> unit
925 = "llvm_add_destination"
926 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
927 llbasicblock -> string -> llbuilder -> llvalue
928 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
929 external build_landingpad : lltype -> llvalue -> int -> string -> llbuilder ->
930 llvalue = "llvm_build_landingpad"
931 external set_cleanup : llvalue -> bool -> unit = "llvm_set_cleanup"
932 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
934 (*--... Arithmetic .........................................................--*)
935 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
937 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
938 = "llvm_build_nsw_add"
939 external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
940 = "llvm_build_nuw_add"
941 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
943 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
945 external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
946 = "llvm_build_nsw_sub"
947 external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
948 = "llvm_build_nuw_sub"
949 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
951 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
953 external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
954 = "llvm_build_nsw_mul"
955 external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
956 = "llvm_build_nuw_mul"
957 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
959 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
961 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
963 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
964 = "llvm_build_exact_sdiv"
965 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
967 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
969 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
971 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
973 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
975 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
977 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
979 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
981 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
983 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
985 external build_neg : llvalue -> string -> llbuilder -> llvalue
987 external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
988 = "llvm_build_nsw_neg"
989 external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
990 = "llvm_build_nuw_neg"
991 external build_fneg : llvalue -> string -> llbuilder -> llvalue
993 external build_not : llvalue -> string -> llbuilder -> llvalue
996 (*--... Memory .............................................................--*)
997 external build_alloca : lltype -> string -> llbuilder -> llvalue
998 = "llvm_build_alloca"
999 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
1000 llvalue = "llvm_build_array_alloca"
1001 external build_load : llvalue -> string -> llbuilder -> llvalue
1003 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
1004 = "llvm_build_store"
1005 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
1007 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
1008 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
1009 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
1010 = "llvm_build_struct_gep"
1012 external build_global_string : string -> string -> llbuilder -> llvalue
1013 = "llvm_build_global_string"
1014 external build_global_stringptr : string -> string -> llbuilder -> llvalue
1015 = "llvm_build_global_stringptr"
1017 (*--... Casts ..............................................................--*)
1018 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
1019 = "llvm_build_trunc"
1020 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
1022 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
1024 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
1025 = "llvm_build_fptoui"
1026 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
1027 = "llvm_build_fptosi"
1028 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
1029 = "llvm_build_uitofp"
1030 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
1031 = "llvm_build_sitofp"
1032 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
1033 = "llvm_build_fptrunc"
1034 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
1035 = "llvm_build_fpext"
1036 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
1037 = "llvm_build_prttoint"
1038 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
1039 = "llvm_build_inttoptr"
1040 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1041 = "llvm_build_bitcast"
1042 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1043 llvalue = "llvm_build_zext_or_bitcast"
1044 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1045 llvalue = "llvm_build_sext_or_bitcast"
1046 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1047 llvalue = "llvm_build_trunc_or_bitcast"
1048 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
1049 = "llvm_build_pointercast"
1050 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1051 = "llvm_build_intcast"
1052 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1053 = "llvm_build_fpcast"
1055 (*--... Comparisons ........................................................--*)
1056 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
1057 llbuilder -> llvalue = "llvm_build_icmp"
1058 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
1059 llbuilder -> llvalue = "llvm_build_fcmp"
1061 (*--... Miscellaneous instructions .........................................--*)
1062 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
1063 llvalue = "llvm_build_phi"
1064 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
1066 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
1067 llvalue = "llvm_build_select"
1068 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
1069 = "llvm_build_va_arg"
1070 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
1071 llvalue = "llvm_build_extractelement"
1072 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
1073 llbuilder -> llvalue = "llvm_build_insertelement"
1074 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
1075 llbuilder -> llvalue = "llvm_build_shufflevector"
1076 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
1077 = "llvm_build_extractvalue"
1078 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
1079 llvalue = "llvm_build_insertvalue"
1081 external build_is_null : llvalue -> string -> llbuilder -> llvalue
1082 = "llvm_build_is_null"
1083 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
1084 = "llvm_build_is_not_null"
1085 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
1086 = "llvm_build_ptrdiff"
1089 (*===-- Memory buffers ----------------------------------------------------===*)
1091 module MemoryBuffer = struct
1092 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
1093 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
1094 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
1098 (*===-- Pass Manager ------------------------------------------------------===*)
1100 module PassManager = struct
1102 type any = [ `Module | `Function ]
1103 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
1104 external create_function : llmodule -> [ `Function ] t
1105 = "LLVMCreateFunctionPassManager"
1106 external run_module : llmodule -> [ `Module ] t -> bool
1107 = "llvm_passmanager_run_module"
1108 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
1109 external run_function : llvalue -> [ `Function ] t -> bool
1110 = "llvm_passmanager_run_function"
1111 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
1112 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
1116 (*===-- Non-Externs -------------------------------------------------------===*)
1117 (* These functions are built using the externals, so must be declared late. *)
1119 let concat2 sep arr =
1121 if 0 < Array.length arr then begin
1123 for i = 1 to (Array.length arr) - 1 do
1124 s := !s ^ sep ^ arr.(i)
1129 let rec string_of_lltype ty =
1130 (* FIXME: stop infinite recursion! :) *)
1131 match classify_type ty with
1132 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
1133 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
1134 | TypeKind.Struct ->
1135 let s = "{ " ^ (concat2 ", " (
1136 Array.map string_of_lltype (struct_element_types ty)
1141 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
1142 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
1143 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
1144 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
1145 | TypeKind.Function -> string_of_lltype (return_type ty) ^
1146 " (" ^ (concat2 ", " (
1147 Array.map string_of_lltype (param_types ty)
1149 | TypeKind.Label -> "label"
1150 | TypeKind.Ppc_fp128 -> "ppc_fp128"
1151 | TypeKind.Fp128 -> "fp128"
1152 | TypeKind.X86fp80 -> "x86_fp80"
1153 | TypeKind.Double -> "double"
1154 | TypeKind.Float -> "float"
1155 | TypeKind.Void -> "void"
1156 | TypeKind.Metadata -> "metadata"