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 named_struct_type : llcontext -> string -> lltype =
298 "llvm_named_struct_type"
299 external struct_set_body : lltype -> lltype array -> bool -> unit =
300 "llvm_struct_set_body"
301 external struct_element_types : lltype -> lltype array
302 = "llvm_struct_element_types"
303 external is_packed : lltype -> bool = "llvm_is_packed"
304 external is_opaque : lltype -> bool = "llvm_is_opaque"
306 (*--... Operations on pointer, vector, and array types .....................--*)
307 external array_type : lltype -> int -> lltype = "llvm_array_type"
308 external pointer_type : lltype -> lltype = "llvm_pointer_type"
309 external qualified_pointer_type : lltype -> int -> lltype
310 = "llvm_qualified_pointer_type"
311 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
313 external element_type : lltype -> lltype = "LLVMGetElementType"
314 external array_length : lltype -> int = "llvm_array_length"
315 external address_space : lltype -> int = "llvm_address_space"
316 external vector_size : lltype -> int = "llvm_vector_size"
318 (*--... Operations on other types ..........................................--*)
319 external void_type : llcontext -> lltype = "llvm_void_type"
320 external label_type : llcontext -> lltype = "llvm_label_type"
322 external classify_value : llvalue -> ValueKind.t = "llvm_classify_value"
323 (*===-- Values ------------------------------------------------------------===*)
324 external type_of : llvalue -> lltype = "llvm_type_of"
325 external value_name : llvalue -> string = "llvm_value_name"
326 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
327 external dump_value : llvalue -> unit = "llvm_dump_value"
328 external replace_all_uses_with : llvalue -> llvalue -> unit
329 = "LLVMReplaceAllUsesWith"
331 (*--... Operations on uses .................................................--*)
332 external use_begin : llvalue -> lluse option = "llvm_use_begin"
333 external use_succ : lluse -> lluse option = "llvm_use_succ"
334 external user : lluse -> llvalue = "llvm_user"
335 external used_value : lluse -> llvalue = "llvm_used_value"
338 let rec aux = function
346 let fold_left_uses f init v =
350 | Some u -> aux (f init u) (use_succ u)
352 aux init (use_begin v)
354 let fold_right_uses f v init =
358 | Some u -> f u (aux (use_succ u) init)
360 aux (use_begin v) init
363 (*--... Operations on users ................................................--*)
364 external operand : llvalue -> int -> llvalue = "llvm_operand"
365 external set_operand : llvalue -> int -> llvalue -> unit = "llvm_set_operand"
366 external num_operands : llvalue -> int = "llvm_num_operands"
368 (*--... Operations on constants of (mostly) any type .......................--*)
369 external is_constant : llvalue -> bool = "llvm_is_constant"
370 external const_null : lltype -> llvalue = "LLVMConstNull"
371 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
372 external const_pointer_null : lltype -> llvalue = "LLVMConstPointerNull"
373 external undef : lltype -> llvalue = "LLVMGetUndef"
374 external is_null : llvalue -> bool = "llvm_is_null"
375 external is_undef : llvalue -> bool = "llvm_is_undef"
376 external constexpr_opcode : llvalue -> Opcode.t = "llvm_constexpr_get_opcode"
378 (*--... Operations on instructions .........................................--*)
379 external has_metadata : llvalue -> bool = "llvm_has_metadata"
380 external metadata : llvalue -> int -> llvalue option = "llvm_metadata"
381 external set_metadata : llvalue -> int -> llvalue -> unit = "llvm_set_metadata"
382 external clear_metadata : llvalue -> int -> unit = "llvm_clear_metadata"
384 (*--... Operations on metadata .......,.....................................--*)
385 external mdstring : llcontext -> string -> llvalue = "llvm_mdstring"
386 external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode"
387 external get_mdstring : llvalue -> string option = "llvm_get_mdstring"
388 external get_named_metadata : llmodule -> string -> llvalue array = "llvm_get_namedmd"
390 (*--... Operations on scalar constants .....................................--*)
391 external const_int : lltype -> int -> llvalue = "llvm_const_int"
392 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
393 = "llvm_const_of_int64"
394 external int64_of_const : llvalue -> Int64.t option
395 = "llvm_int64_of_const"
396 external const_int_of_string : lltype -> string -> int -> llvalue
397 = "llvm_const_int_of_string"
398 external const_float : lltype -> float -> llvalue = "llvm_const_float"
399 external const_float_of_string : lltype -> string -> llvalue
400 = "llvm_const_float_of_string"
402 (*--... Operations on composite constants ..................................--*)
403 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
404 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
405 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
406 external const_struct : llcontext -> llvalue array -> llvalue
407 = "llvm_const_struct"
408 external const_named_struct : lltype -> llvalue array -> llvalue
409 = "llvm_const_named_struct"
410 external const_packed_struct : llcontext -> llvalue array -> llvalue
411 = "llvm_const_packed_struct"
412 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
414 (*--... Constant expressions ...............................................--*)
415 external align_of : lltype -> llvalue = "LLVMAlignOf"
416 external size_of : lltype -> llvalue = "LLVMSizeOf"
417 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
418 external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg"
419 external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg"
420 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
421 external const_not : llvalue -> llvalue = "LLVMConstNot"
422 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
423 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
424 external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd"
425 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
426 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
427 external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub"
428 external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub"
429 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
430 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
431 external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul"
432 external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul"
433 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
434 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
435 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
436 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
437 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
438 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
439 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
440 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
441 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
442 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
443 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
444 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
446 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
448 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
449 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
450 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
451 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
452 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
453 = "llvm_const_in_bounds_gep"
454 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
455 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
456 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
457 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
458 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
459 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
460 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
461 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
462 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
463 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
464 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
465 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
466 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
467 = "LLVMConstZExtOrBitCast"
468 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
469 = "LLVMConstSExtOrBitCast"
470 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
471 = "LLVMConstTruncOrBitCast"
472 external const_pointercast : llvalue -> lltype -> llvalue
473 = "LLVMConstPointerCast"
474 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
475 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
476 external const_select : llvalue -> llvalue -> llvalue -> llvalue
478 external const_extractelement : llvalue -> llvalue -> llvalue
479 = "LLVMConstExtractElement"
480 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
481 = "LLVMConstInsertElement"
482 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
483 = "LLVMConstShuffleVector"
484 external const_extractvalue : llvalue -> int array -> llvalue
485 = "llvm_const_extractvalue"
486 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
487 = "llvm_const_insertvalue"
488 external const_inline_asm : lltype -> string -> string -> bool -> bool ->
490 = "llvm_const_inline_asm"
491 external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress"
493 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
494 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
495 external is_declaration : llvalue -> bool = "llvm_is_declaration"
496 external linkage : llvalue -> Linkage.t = "llvm_linkage"
497 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
498 external section : llvalue -> string = "llvm_section"
499 external set_section : string -> llvalue -> unit = "llvm_set_section"
500 external visibility : llvalue -> Visibility.t = "llvm_visibility"
501 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
502 external alignment : llvalue -> int = "llvm_alignment"
503 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
504 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
505 external set_global_constant : bool -> llvalue -> unit
506 = "llvm_set_global_constant"
508 (*--... Operations on global variables .....................................--*)
509 external declare_global : lltype -> string -> llmodule -> llvalue
510 = "llvm_declare_global"
511 external declare_qualified_global : lltype -> string -> int -> llmodule ->
513 = "llvm_declare_qualified_global"
514 external define_global : string -> llvalue -> llmodule -> llvalue
515 = "llvm_define_global"
516 external define_qualified_global : string -> llvalue -> int -> llmodule ->
518 = "llvm_define_qualified_global"
519 external lookup_global : string -> llmodule -> llvalue option
520 = "llvm_lookup_global"
521 external delete_global : llvalue -> unit = "llvm_delete_global"
522 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
523 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
524 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
525 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
526 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
527 external global_begin : llmodule -> (llmodule, llvalue) llpos
528 = "llvm_global_begin"
529 external global_succ : llvalue -> (llmodule, llvalue) llpos
531 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
533 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
536 let rec iter_global_range f i e =
537 if i = e then () else
539 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
542 iter_global_range f (global_succ bb) e
544 let iter_globals f m =
545 iter_global_range f (global_begin m) (At_end m)
547 let rec fold_left_global_range f init i e =
548 if i = e then init else
550 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
551 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
553 let fold_left_globals f init m =
554 fold_left_global_range f init (global_begin m) (At_end m)
556 let rec rev_iter_global_range f i e =
557 if i = e then () else
559 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
562 rev_iter_global_range f (global_pred bb) e
564 let rev_iter_globals f m =
565 rev_iter_global_range f (global_end m) (At_start m)
567 let rec fold_right_global_range f i e init =
568 if i = e then init else
570 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
571 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
573 let fold_right_globals f m init =
574 fold_right_global_range f (global_end m) (At_start m) init
576 (*--... Operations on aliases ..............................................--*)
577 external add_alias : llmodule -> lltype -> llvalue -> string -> llvalue
580 (*--... Operations on functions ............................................--*)
581 external declare_function : string -> lltype -> llmodule -> llvalue
582 = "llvm_declare_function"
583 external define_function : string -> lltype -> llmodule -> llvalue
584 = "llvm_define_function"
585 external lookup_function : string -> llmodule -> llvalue option
586 = "llvm_lookup_function"
587 external delete_function : llvalue -> unit = "llvm_delete_function"
588 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
589 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
590 external set_function_call_conv : int -> llvalue -> unit
591 = "llvm_set_function_call_conv"
592 external gc : llvalue -> string option = "llvm_gc"
593 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
594 external function_begin : llmodule -> (llmodule, llvalue) llpos
595 = "llvm_function_begin"
596 external function_succ : llvalue -> (llmodule, llvalue) llpos
597 = "llvm_function_succ"
598 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
599 = "llvm_function_end"
600 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
601 = "llvm_function_pred"
603 let rec iter_function_range f i e =
604 if i = e then () else
606 | At_end _ -> raise (Invalid_argument "Invalid function range.")
609 iter_function_range f (function_succ fn) e
611 let iter_functions f m =
612 iter_function_range f (function_begin m) (At_end m)
614 let rec fold_left_function_range f init i e =
615 if i = e then init else
617 | At_end _ -> raise (Invalid_argument "Invalid function range.")
618 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
620 let fold_left_functions f init m =
621 fold_left_function_range f init (function_begin m) (At_end m)
623 let rec rev_iter_function_range f i e =
624 if i = e then () else
626 | At_start _ -> raise (Invalid_argument "Invalid function range.")
629 rev_iter_function_range f (function_pred fn) e
631 let rev_iter_functions f m =
632 rev_iter_function_range f (function_end m) (At_start m)
634 let rec fold_right_function_range f i e init =
635 if i = e then init else
637 | At_start _ -> raise (Invalid_argument "Invalid function range.")
638 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
640 let fold_right_functions f m init =
641 fold_right_function_range f (function_end m) (At_start m) init
643 external llvm_add_function_attr : llvalue -> int -> unit
644 = "llvm_add_function_attr"
645 external llvm_remove_function_attr : llvalue -> int -> unit
646 = "llvm_remove_function_attr"
648 let pack_attr (attr:Attribute.t) : int =
650 Attribute.Zext -> 1 lsl 0
651 | Attribute.Sext -> 1 lsl 1
652 | Attribute.Noreturn -> 1 lsl 2
653 | Attribute.Inreg -> 1 lsl 3
654 | Attribute.Structret -> 1 lsl 4
655 | Attribute.Nounwind -> 1 lsl 5
656 | Attribute.Noalias -> 1 lsl 6
657 | Attribute.Byval -> 1 lsl 7
658 | Attribute.Nest -> 1 lsl 8
659 | Attribute.Readnone -> 1 lsl 9
660 | Attribute.Readonly -> 1 lsl 10
661 | Attribute.Noinline -> 1 lsl 11
662 | Attribute.Alwaysinline -> 1 lsl 12
663 | Attribute.Optsize -> 1 lsl 13
664 | Attribute.Ssp -> 1 lsl 14
665 | Attribute.Sspreq -> 1 lsl 15
666 | Attribute.Alignment n -> n lsl 16
667 | Attribute.Nocapture -> 1 lsl 21
668 | Attribute.Noredzone -> 1 lsl 22
669 | Attribute.Noimplicitfloat -> 1 lsl 23
670 | Attribute.Naked -> 1 lsl 24
671 | Attribute.Inlinehint -> 1 lsl 25
672 | Attribute.Stackalignment n -> n lsl 26
674 let add_function_attr llval attr =
675 llvm_add_function_attr llval (pack_attr attr)
677 let remove_function_attr llval attr =
678 llvm_remove_function_attr llval (pack_attr attr)
680 (*--... Operations on params ...............................................--*)
681 external params : llvalue -> llvalue array = "llvm_params"
682 external param : llvalue -> int -> llvalue = "llvm_param"
683 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
684 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
685 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
686 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
687 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
689 let rec iter_param_range f i e =
690 if i = e then () else
692 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
695 iter_param_range f (param_succ p) e
697 let iter_params f fn =
698 iter_param_range f (param_begin fn) (At_end fn)
700 let rec fold_left_param_range f init i e =
701 if i = e then init else
703 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
704 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
706 let fold_left_params f init fn =
707 fold_left_param_range f init (param_begin fn) (At_end fn)
709 let rec rev_iter_param_range f i e =
710 if i = e then () else
712 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
715 rev_iter_param_range f (param_pred p) e
717 let rev_iter_params f fn =
718 rev_iter_param_range f (param_end fn) (At_start fn)
720 let rec fold_right_param_range f init i e =
721 if i = e then init else
723 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
724 | After p -> fold_right_param_range f (f p init) (param_pred p) e
726 let fold_right_params f fn init =
727 fold_right_param_range f init (param_end fn) (At_start fn)
729 external llvm_add_param_attr : llvalue -> int -> unit
730 = "llvm_add_param_attr"
731 external llvm_remove_param_attr : llvalue -> int -> unit
732 = "llvm_remove_param_attr"
734 let add_param_attr llval attr =
735 llvm_add_param_attr llval (pack_attr attr)
737 let remove_param_attr llval attr =
738 llvm_remove_param_attr llval (pack_attr attr)
740 external set_param_alignment : llvalue -> int -> unit
741 = "llvm_set_param_alignment"
743 (*--... Operations on basic blocks .........................................--*)
744 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
745 external value_is_block : llvalue -> bool = "llvm_value_is_block"
746 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
747 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
748 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
749 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
750 external delete_block : llbasicblock -> unit = "llvm_delete_block"
751 external append_block : llcontext -> string -> llvalue -> llbasicblock
752 = "llvm_append_block"
753 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
754 = "llvm_insert_block"
755 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
757 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
759 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
761 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
764 let rec iter_block_range f i e =
765 if i = e then () else
767 | At_end _ -> raise (Invalid_argument "Invalid block range.")
770 iter_block_range f (block_succ bb) e
772 let iter_blocks f fn =
773 iter_block_range f (block_begin fn) (At_end fn)
775 let rec fold_left_block_range f init i e =
776 if i = e then init else
778 | At_end _ -> raise (Invalid_argument "Invalid block range.")
779 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
781 let fold_left_blocks f init fn =
782 fold_left_block_range f init (block_begin fn) (At_end fn)
784 let rec rev_iter_block_range f i e =
785 if i = e then () else
787 | At_start _ -> raise (Invalid_argument "Invalid block range.")
790 rev_iter_block_range f (block_pred bb) e
792 let rev_iter_blocks f fn =
793 rev_iter_block_range f (block_end fn) (At_start fn)
795 let rec fold_right_block_range f init i e =
796 if i = e then init else
798 | At_start _ -> raise (Invalid_argument "Invalid block range.")
799 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
801 let fold_right_blocks f fn init =
802 fold_right_block_range f init (block_end fn) (At_start fn)
804 (*--... Operations on instructions .........................................--*)
805 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
806 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
808 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
810 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
812 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
815 external instr_opcode : llvalue -> Opcode.t = "llvm_instr_get_opcode"
816 external icmp_predicate : llvalue -> Icmp.t option = "llvm_instr_icmp_predicate"
818 let rec iter_instrs_range f i e =
819 if i = e then () else
821 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
824 iter_instrs_range f (instr_succ i) e
826 let iter_instrs f bb =
827 iter_instrs_range f (instr_begin bb) (At_end bb)
829 let rec fold_left_instrs_range f init i e =
830 if i = e then init else
832 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
833 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
835 let fold_left_instrs f init bb =
836 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
838 let rec rev_iter_instrs_range f i e =
839 if i = e then () else
841 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
844 rev_iter_instrs_range f (instr_pred i) e
846 let rev_iter_instrs f bb =
847 rev_iter_instrs_range f (instr_end bb) (At_start bb)
849 let rec fold_right_instr_range f i e init =
850 if i = e then init else
852 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
853 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
855 let fold_right_instrs f bb init =
856 fold_right_instr_range f (instr_end bb) (At_start bb) init
859 (*--... Operations on call sites ...........................................--*)
860 external instruction_call_conv: llvalue -> int
861 = "llvm_instruction_call_conv"
862 external set_instruction_call_conv: int -> llvalue -> unit
863 = "llvm_set_instruction_call_conv"
865 external llvm_add_instruction_param_attr : llvalue -> int -> int -> unit
866 = "llvm_add_instruction_param_attr"
867 external llvm_remove_instruction_param_attr : llvalue -> int -> int -> unit
868 = "llvm_remove_instruction_param_attr"
870 let add_instruction_param_attr llval i attr =
871 llvm_add_instruction_param_attr llval i (pack_attr attr)
873 let remove_instruction_param_attr llval i attr =
874 llvm_remove_instruction_param_attr llval i (pack_attr attr)
876 (*--... Operations on call instructions (only) .............................--*)
877 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
878 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
880 (*--... Operations on phi nodes ............................................--*)
881 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
882 = "llvm_add_incoming"
883 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
886 (*===-- Instruction builders ----------------------------------------------===*)
887 external builder : llcontext -> llbuilder = "llvm_builder"
888 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
889 = "llvm_position_builder"
890 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
891 external insert_into_builder : llvalue -> string -> llbuilder -> unit
892 = "llvm_insert_into_builder"
894 let builder_at context ip =
895 let b = builder context in
896 position_builder ip b;
899 let builder_before context i = builder_at context (Before i)
900 let builder_at_end context bb = builder_at context (At_end bb)
902 let position_before i = position_builder (Before i)
903 let position_at_end bb = position_builder (At_end bb)
906 (*--... Metadata ...........................................................--*)
907 external set_current_debug_location : llbuilder -> llvalue -> unit
908 = "llvm_set_current_debug_location"
909 external clear_current_debug_location : llbuilder -> unit
910 = "llvm_clear_current_debug_location"
911 external current_debug_location : llbuilder -> llvalue option
912 = "llvm_current_debug_location"
913 external set_inst_debug_location : llbuilder -> llvalue -> unit
914 = "llvm_set_inst_debug_location"
917 (*--... Terminators ........................................................--*)
918 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
919 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
920 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
921 = "llvm_build_aggregate_ret"
922 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
923 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
924 llvalue = "llvm_build_cond_br"
925 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
926 = "llvm_build_switch"
927 external add_case : llvalue -> llvalue -> llbasicblock -> unit
929 external build_indirect_br : llvalue -> int -> llbuilder -> llvalue
930 = "llvm_build_indirect_br"
931 external add_destination : llvalue -> llbasicblock -> unit
932 = "llvm_add_destination"
933 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
934 llbasicblock -> string -> llbuilder -> llvalue
935 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
936 external build_landingpad : lltype -> llvalue -> int -> string -> llbuilder ->
937 llvalue = "llvm_build_landingpad"
938 external set_cleanup : llvalue -> bool -> unit = "llvm_set_cleanup"
939 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
941 (*--... Arithmetic .........................................................--*)
942 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
944 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
945 = "llvm_build_nsw_add"
946 external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
947 = "llvm_build_nuw_add"
948 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
950 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
952 external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
953 = "llvm_build_nsw_sub"
954 external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
955 = "llvm_build_nuw_sub"
956 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
958 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
960 external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
961 = "llvm_build_nsw_mul"
962 external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
963 = "llvm_build_nuw_mul"
964 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
966 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
968 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
970 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
971 = "llvm_build_exact_sdiv"
972 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
974 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
976 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
978 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
980 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
982 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
984 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
986 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
988 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
990 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
992 external build_neg : llvalue -> string -> llbuilder -> llvalue
994 external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
995 = "llvm_build_nsw_neg"
996 external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
997 = "llvm_build_nuw_neg"
998 external build_fneg : llvalue -> string -> llbuilder -> llvalue
1000 external build_not : llvalue -> string -> llbuilder -> llvalue
1003 (*--... Memory .............................................................--*)
1004 external build_alloca : lltype -> string -> llbuilder -> llvalue
1005 = "llvm_build_alloca"
1006 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
1007 llvalue = "llvm_build_array_alloca"
1008 external build_load : llvalue -> string -> llbuilder -> llvalue
1010 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
1011 = "llvm_build_store"
1012 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
1014 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
1015 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
1016 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
1017 = "llvm_build_struct_gep"
1019 external build_global_string : string -> string -> llbuilder -> llvalue
1020 = "llvm_build_global_string"
1021 external build_global_stringptr : string -> string -> llbuilder -> llvalue
1022 = "llvm_build_global_stringptr"
1024 (*--... Casts ..............................................................--*)
1025 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
1026 = "llvm_build_trunc"
1027 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
1029 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
1031 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
1032 = "llvm_build_fptoui"
1033 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
1034 = "llvm_build_fptosi"
1035 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
1036 = "llvm_build_uitofp"
1037 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
1038 = "llvm_build_sitofp"
1039 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
1040 = "llvm_build_fptrunc"
1041 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
1042 = "llvm_build_fpext"
1043 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
1044 = "llvm_build_prttoint"
1045 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
1046 = "llvm_build_inttoptr"
1047 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1048 = "llvm_build_bitcast"
1049 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1050 llvalue = "llvm_build_zext_or_bitcast"
1051 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1052 llvalue = "llvm_build_sext_or_bitcast"
1053 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1054 llvalue = "llvm_build_trunc_or_bitcast"
1055 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
1056 = "llvm_build_pointercast"
1057 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1058 = "llvm_build_intcast"
1059 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1060 = "llvm_build_fpcast"
1062 (*--... Comparisons ........................................................--*)
1063 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
1064 llbuilder -> llvalue = "llvm_build_icmp"
1065 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
1066 llbuilder -> llvalue = "llvm_build_fcmp"
1068 (*--... Miscellaneous instructions .........................................--*)
1069 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
1070 llvalue = "llvm_build_phi"
1071 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
1073 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
1074 llvalue = "llvm_build_select"
1075 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
1076 = "llvm_build_va_arg"
1077 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
1078 llvalue = "llvm_build_extractelement"
1079 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
1080 llbuilder -> llvalue = "llvm_build_insertelement"
1081 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
1082 llbuilder -> llvalue = "llvm_build_shufflevector"
1083 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
1084 = "llvm_build_extractvalue"
1085 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
1086 llvalue = "llvm_build_insertvalue"
1088 external build_is_null : llvalue -> string -> llbuilder -> llvalue
1089 = "llvm_build_is_null"
1090 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
1091 = "llvm_build_is_not_null"
1092 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
1093 = "llvm_build_ptrdiff"
1096 (*===-- Memory buffers ----------------------------------------------------===*)
1098 module MemoryBuffer = struct
1099 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
1100 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
1101 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
1105 (*===-- Pass Manager ------------------------------------------------------===*)
1107 module PassManager = struct
1109 type any = [ `Module | `Function ]
1110 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
1111 external create_function : llmodule -> [ `Function ] t
1112 = "LLVMCreateFunctionPassManager"
1113 external run_module : llmodule -> [ `Module ] t -> bool
1114 = "llvm_passmanager_run_module"
1115 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
1116 external run_function : llvalue -> [ `Function ] t -> bool
1117 = "llvm_passmanager_run_function"
1118 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
1119 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
1123 (*===-- Non-Externs -------------------------------------------------------===*)
1124 (* These functions are built using the externals, so must be declared late. *)
1126 let concat2 sep arr =
1128 if 0 < Array.length arr then begin
1130 for i = 1 to (Array.length arr) - 1 do
1131 s := !s ^ sep ^ arr.(i)
1136 let rec string_of_lltype ty =
1137 (* FIXME: stop infinite recursion! :) *)
1138 match classify_type ty with
1139 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
1140 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
1141 | TypeKind.Struct ->
1142 let s = "{ " ^ (concat2 ", " (
1143 Array.map string_of_lltype (struct_element_types ty)
1148 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
1149 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
1150 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
1151 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
1152 | TypeKind.Function -> string_of_lltype (return_type ty) ^
1153 " (" ^ (concat2 ", " (
1154 Array.map string_of_lltype (param_types ty)
1156 | TypeKind.Label -> "label"
1157 | TypeKind.Ppc_fp128 -> "ppc_fp128"
1158 | TypeKind.Fp128 -> "fp128"
1159 | TypeKind.X86fp80 -> "x86_fp80"
1160 | TypeKind.Double -> "double"
1161 | TypeKind.Float -> "float"
1162 | TypeKind.Void -> "void"
1163 | TypeKind.Metadata -> "metadata"