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
136 module Opcode = struct
138 | Invalid (* not an instruction *)
139 (* Terminator Instructions *)
147 (* Standard Binary Operators *)
160 (* Logical Operators *)
167 (* Memory Operators *)
185 (* Other Operators *)
207 module ValueKind = struct
216 | ConstantAggregateZero
221 | ConstantPointerNull
228 | Instruction of Opcode.t
231 exception IoError of string
233 external register_exns : exn -> unit = "llvm_register_core_exns"
234 let _ = register_exns (IoError "")
236 type ('a, 'b) llpos =
240 type ('a, 'b) llrev_pos =
244 (*===-- Contexts ----------------------------------------------------------===*)
245 external create_context : unit -> llcontext = "llvm_create_context"
246 external dispose_context : llcontext -> unit = "llvm_dispose_context"
247 external global_context : unit -> llcontext = "llvm_global_context"
248 external mdkind_id : llcontext -> string -> int = "llvm_mdkind_id"
250 (*===-- Modules -----------------------------------------------------------===*)
251 external create_module : llcontext -> string -> llmodule = "llvm_create_module"
252 external dispose_module : llmodule -> unit = "llvm_dispose_module"
253 external target_triple: llmodule -> string
254 = "llvm_target_triple"
255 external set_target_triple: string -> llmodule -> unit
256 = "llvm_set_target_triple"
257 external data_layout: llmodule -> string
259 external set_data_layout: string -> llmodule -> unit
260 = "llvm_set_data_layout"
261 external dump_module : llmodule -> unit = "llvm_dump_module"
262 external set_module_inline_asm : llmodule -> string -> unit
263 = "llvm_set_module_inline_asm"
265 (*===-- Types -------------------------------------------------------------===*)
266 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
267 external type_context : lltype -> llcontext = "llvm_type_context"
268 external type_is_sized : lltype -> bool = "llvm_type_is_sized"
270 (*--... Operations on integer types ........................................--*)
271 external i1_type : llcontext -> lltype = "llvm_i1_type"
272 external i8_type : llcontext -> lltype = "llvm_i8_type"
273 external i16_type : llcontext -> lltype = "llvm_i16_type"
274 external i32_type : llcontext -> lltype = "llvm_i32_type"
275 external i64_type : llcontext -> lltype = "llvm_i64_type"
277 external integer_type : llcontext -> int -> lltype = "llvm_integer_type"
278 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
280 (*--... Operations on real types ...........................................--*)
281 external float_type : llcontext -> lltype = "llvm_float_type"
282 external double_type : llcontext -> lltype = "llvm_double_type"
283 external x86fp80_type : llcontext -> lltype = "llvm_x86fp80_type"
284 external fp128_type : llcontext -> lltype = "llvm_fp128_type"
285 external ppc_fp128_type : llcontext -> lltype = "llvm_ppc_fp128_type"
287 (*--... Operations on function types .......................................--*)
288 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
289 external var_arg_function_type : lltype -> lltype array -> lltype
290 = "llvm_var_arg_function_type"
291 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
292 external return_type : lltype -> lltype = "LLVMGetReturnType"
293 external param_types : lltype -> lltype array = "llvm_param_types"
295 (*--... Operations on struct types .........................................--*)
296 external struct_type : llcontext -> lltype array -> lltype = "llvm_struct_type"
297 external packed_struct_type : llcontext -> lltype array -> lltype
298 = "llvm_packed_struct_type"
299 external struct_name : lltype -> string option = "llvm_struct_name"
300 external named_struct_type : llcontext -> string -> lltype =
301 "llvm_named_struct_type"
302 external struct_set_body : lltype -> lltype array -> bool -> unit =
303 "llvm_struct_set_body"
304 external struct_element_types : lltype -> lltype array
305 = "llvm_struct_element_types"
306 external is_packed : lltype -> bool = "llvm_is_packed"
307 external is_opaque : lltype -> bool = "llvm_is_opaque"
309 (*--... Operations on pointer, vector, and array types .....................--*)
310 external array_type : lltype -> int -> lltype = "llvm_array_type"
311 external pointer_type : lltype -> lltype = "llvm_pointer_type"
312 external qualified_pointer_type : lltype -> int -> lltype
313 = "llvm_qualified_pointer_type"
314 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
316 external element_type : lltype -> lltype = "LLVMGetElementType"
317 external array_length : lltype -> int = "llvm_array_length"
318 external address_space : lltype -> int = "llvm_address_space"
319 external vector_size : lltype -> int = "llvm_vector_size"
321 (*--... Operations on other types ..........................................--*)
322 external void_type : llcontext -> lltype = "llvm_void_type"
323 external label_type : llcontext -> lltype = "llvm_label_type"
325 external classify_value : llvalue -> ValueKind.t = "llvm_classify_value"
326 (*===-- Values ------------------------------------------------------------===*)
327 external type_of : llvalue -> lltype = "llvm_type_of"
328 external value_name : llvalue -> string = "llvm_value_name"
329 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
330 external dump_value : llvalue -> unit = "llvm_dump_value"
331 external replace_all_uses_with : llvalue -> llvalue -> unit
332 = "LLVMReplaceAllUsesWith"
334 (*--... Operations on uses .................................................--*)
335 external use_begin : llvalue -> lluse option = "llvm_use_begin"
336 external use_succ : lluse -> lluse option = "llvm_use_succ"
337 external user : lluse -> llvalue = "llvm_user"
338 external used_value : lluse -> llvalue = "llvm_used_value"
341 let rec aux = function
349 let fold_left_uses f init v =
353 | Some u -> aux (f init u) (use_succ u)
355 aux init (use_begin v)
357 let fold_right_uses f v init =
361 | Some u -> f u (aux (use_succ u) init)
363 aux (use_begin v) init
366 (*--... Operations on users ................................................--*)
367 external operand : llvalue -> int -> llvalue = "llvm_operand"
368 external set_operand : llvalue -> int -> llvalue -> unit = "llvm_set_operand"
369 external num_operands : llvalue -> int = "llvm_num_operands"
371 (*--... Operations on constants of (mostly) any type .......................--*)
372 external is_constant : llvalue -> bool = "llvm_is_constant"
373 external const_null : lltype -> llvalue = "LLVMConstNull"
374 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
375 external const_pointer_null : lltype -> llvalue = "LLVMConstPointerNull"
376 external undef : lltype -> llvalue = "LLVMGetUndef"
377 external is_null : llvalue -> bool = "llvm_is_null"
378 external is_undef : llvalue -> bool = "llvm_is_undef"
379 external constexpr_opcode : llvalue -> Opcode.t = "llvm_constexpr_get_opcode"
381 (*--... Operations on instructions .........................................--*)
382 external has_metadata : llvalue -> bool = "llvm_has_metadata"
383 external metadata : llvalue -> int -> llvalue option = "llvm_metadata"
384 external set_metadata : llvalue -> int -> llvalue -> unit = "llvm_set_metadata"
385 external clear_metadata : llvalue -> int -> unit = "llvm_clear_metadata"
387 (*--... Operations on metadata .......,.....................................--*)
388 external mdstring : llcontext -> string -> llvalue = "llvm_mdstring"
389 external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode"
390 external get_mdstring : llvalue -> string option = "llvm_get_mdstring"
391 external get_named_metadata : llmodule -> string -> llvalue array = "llvm_get_namedmd"
393 (*--... Operations on scalar constants .....................................--*)
394 external const_int : lltype -> int -> llvalue = "llvm_const_int"
395 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
396 = "llvm_const_of_int64"
397 external int64_of_const : llvalue -> Int64.t option
398 = "llvm_int64_of_const"
399 external const_int_of_string : lltype -> string -> int -> llvalue
400 = "llvm_const_int_of_string"
401 external const_float : lltype -> float -> llvalue = "llvm_const_float"
402 external const_float_of_string : lltype -> string -> llvalue
403 = "llvm_const_float_of_string"
405 (*--... Operations on composite constants ..................................--*)
406 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
407 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
408 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
409 external const_struct : llcontext -> llvalue array -> llvalue
410 = "llvm_const_struct"
411 external const_named_struct : lltype -> llvalue array -> llvalue
412 = "llvm_const_named_struct"
413 external const_packed_struct : llcontext -> llvalue array -> llvalue
414 = "llvm_const_packed_struct"
415 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
417 (*--... Constant expressions ...............................................--*)
418 external align_of : lltype -> llvalue = "LLVMAlignOf"
419 external size_of : lltype -> llvalue = "LLVMSizeOf"
420 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
421 external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg"
422 external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg"
423 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
424 external const_not : llvalue -> llvalue = "LLVMConstNot"
425 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
426 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
427 external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd"
428 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
429 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
430 external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub"
431 external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub"
432 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
433 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
434 external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul"
435 external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul"
436 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
437 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
438 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
439 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
440 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
441 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
442 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
443 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
444 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
445 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
446 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
447 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
449 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
451 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
452 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
453 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
454 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
455 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
456 = "llvm_const_in_bounds_gep"
457 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
458 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
459 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
460 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
461 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
462 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
463 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
464 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
465 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
466 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
467 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
468 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
469 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
470 = "LLVMConstZExtOrBitCast"
471 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
472 = "LLVMConstSExtOrBitCast"
473 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
474 = "LLVMConstTruncOrBitCast"
475 external const_pointercast : llvalue -> lltype -> llvalue
476 = "LLVMConstPointerCast"
477 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
478 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
479 external const_select : llvalue -> llvalue -> llvalue -> llvalue
481 external const_extractelement : llvalue -> llvalue -> llvalue
482 = "LLVMConstExtractElement"
483 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
484 = "LLVMConstInsertElement"
485 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
486 = "LLVMConstShuffleVector"
487 external const_extractvalue : llvalue -> int array -> llvalue
488 = "llvm_const_extractvalue"
489 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
490 = "llvm_const_insertvalue"
491 external const_inline_asm : lltype -> string -> string -> bool -> bool ->
493 = "llvm_const_inline_asm"
494 external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress"
496 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
497 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
498 external is_declaration : llvalue -> bool = "llvm_is_declaration"
499 external linkage : llvalue -> Linkage.t = "llvm_linkage"
500 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
501 external section : llvalue -> string = "llvm_section"
502 external set_section : string -> llvalue -> unit = "llvm_set_section"
503 external visibility : llvalue -> Visibility.t = "llvm_visibility"
504 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
505 external alignment : llvalue -> int = "llvm_alignment"
506 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
507 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
508 external set_global_constant : bool -> llvalue -> unit
509 = "llvm_set_global_constant"
511 (*--... Operations on global variables .....................................--*)
512 external declare_global : lltype -> string -> llmodule -> llvalue
513 = "llvm_declare_global"
514 external declare_qualified_global : lltype -> string -> int -> llmodule ->
516 = "llvm_declare_qualified_global"
517 external define_global : string -> llvalue -> llmodule -> llvalue
518 = "llvm_define_global"
519 external define_qualified_global : string -> llvalue -> int -> llmodule ->
521 = "llvm_define_qualified_global"
522 external lookup_global : string -> llmodule -> llvalue option
523 = "llvm_lookup_global"
524 external delete_global : llvalue -> unit = "llvm_delete_global"
525 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
526 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
527 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
528 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
529 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
530 external global_begin : llmodule -> (llmodule, llvalue) llpos
531 = "llvm_global_begin"
532 external global_succ : llvalue -> (llmodule, llvalue) llpos
534 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
536 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
539 let rec iter_global_range f i e =
540 if i = e then () else
542 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
545 iter_global_range f (global_succ bb) e
547 let iter_globals f m =
548 iter_global_range f (global_begin m) (At_end m)
550 let rec fold_left_global_range f init i e =
551 if i = e then init else
553 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
554 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
556 let fold_left_globals f init m =
557 fold_left_global_range f init (global_begin m) (At_end m)
559 let rec rev_iter_global_range f i e =
560 if i = e then () else
562 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
565 rev_iter_global_range f (global_pred bb) e
567 let rev_iter_globals f m =
568 rev_iter_global_range f (global_end m) (At_start m)
570 let rec fold_right_global_range f i e init =
571 if i = e then init else
573 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
574 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
576 let fold_right_globals f m init =
577 fold_right_global_range f (global_end m) (At_start m) init
579 (*--... Operations on aliases ..............................................--*)
580 external add_alias : llmodule -> lltype -> llvalue -> string -> llvalue
583 (*--... Operations on functions ............................................--*)
584 external declare_function : string -> lltype -> llmodule -> llvalue
585 = "llvm_declare_function"
586 external define_function : string -> lltype -> llmodule -> llvalue
587 = "llvm_define_function"
588 external lookup_function : string -> llmodule -> llvalue option
589 = "llvm_lookup_function"
590 external delete_function : llvalue -> unit = "llvm_delete_function"
591 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
592 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
593 external set_function_call_conv : int -> llvalue -> unit
594 = "llvm_set_function_call_conv"
595 external gc : llvalue -> string option = "llvm_gc"
596 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
597 external function_begin : llmodule -> (llmodule, llvalue) llpos
598 = "llvm_function_begin"
599 external function_succ : llvalue -> (llmodule, llvalue) llpos
600 = "llvm_function_succ"
601 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
602 = "llvm_function_end"
603 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
604 = "llvm_function_pred"
606 let rec iter_function_range f i e =
607 if i = e then () else
609 | At_end _ -> raise (Invalid_argument "Invalid function range.")
612 iter_function_range f (function_succ fn) e
614 let iter_functions f m =
615 iter_function_range f (function_begin m) (At_end m)
617 let rec fold_left_function_range f init i e =
618 if i = e then init else
620 | At_end _ -> raise (Invalid_argument "Invalid function range.")
621 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
623 let fold_left_functions f init m =
624 fold_left_function_range f init (function_begin m) (At_end m)
626 let rec rev_iter_function_range f i e =
627 if i = e then () else
629 | At_start _ -> raise (Invalid_argument "Invalid function range.")
632 rev_iter_function_range f (function_pred fn) e
634 let rev_iter_functions f m =
635 rev_iter_function_range f (function_end m) (At_start m)
637 let rec fold_right_function_range f i e init =
638 if i = e then init else
640 | At_start _ -> raise (Invalid_argument "Invalid function range.")
641 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
643 let fold_right_functions f m init =
644 fold_right_function_range f (function_end m) (At_start m) init
646 external llvm_add_function_attr : llvalue -> int32 -> unit
647 = "llvm_add_function_attr"
648 external llvm_remove_function_attr : llvalue -> int32 -> unit
649 = "llvm_remove_function_attr"
650 external llvm_function_attr : llvalue -> int32 = "llvm_function_attr"
652 let pack_attr (attr:Attribute.t) : int32 =
654 Attribute.Zext -> Int32.shift_left 1l 0
655 | Attribute.Sext -> Int32.shift_left 1l 1
656 | Attribute.Noreturn -> Int32.shift_left 1l 2
657 | Attribute.Inreg -> Int32.shift_left 1l 3
658 | Attribute.Structret -> Int32.shift_left 1l 4
659 | Attribute.Nounwind -> Int32.shift_left 1l 5
660 | Attribute.Noalias -> Int32.shift_left 1l 6
661 | Attribute.Byval -> Int32.shift_left 1l 7
662 | Attribute.Nest -> Int32.shift_left 1l 8
663 | Attribute.Readnone -> Int32.shift_left 1l 9
664 | Attribute.Readonly -> Int32.shift_left 1l 10
665 | Attribute.Noinline -> Int32.shift_left 1l 11
666 | Attribute.Alwaysinline -> Int32.shift_left 1l 12
667 | Attribute.Optsize -> Int32.shift_left 1l 13
668 | Attribute.Ssp -> Int32.shift_left 1l 14
669 | Attribute.Sspreq -> Int32.shift_left 1l 15
670 | Attribute.Alignment n -> Int32.shift_left (Int32.of_int n) 16
671 | Attribute.Nocapture -> Int32.shift_left 1l 21
672 | Attribute.Noredzone -> Int32.shift_left 1l 22
673 | Attribute.Noimplicitfloat -> Int32.shift_left 1l 23
674 | Attribute.Naked -> Int32.shift_left 1l 24
675 | Attribute.Inlinehint -> Int32.shift_left 1l 25
676 | Attribute.Stackalignment n -> Int32.shift_left (Int32.of_int n) 26
677 | Attribute.ReturnsTwice -> Int32.shift_left 1l 29
678 | Attribute.UWTable -> Int32.shift_left 1l 30
679 | Attribute.NonLazyBind -> Int32.shift_left 1l 31
681 let unpack_attr (a : int32) : Attribute.t list =
684 Int32.logand (pack_attr attr) a in
686 if (check attr) <> 0l then begin
690 checkattr Attribute.Zext;
691 checkattr Attribute.Sext;
692 checkattr Attribute.Noreturn;
693 checkattr Attribute.Inreg;
694 checkattr Attribute.Structret;
695 checkattr Attribute.Nounwind;
696 checkattr Attribute.Noalias;
697 checkattr Attribute.Byval;
698 checkattr Attribute.Nest;
699 checkattr Attribute.Readnone;
700 checkattr Attribute.Readonly;
701 checkattr Attribute.Noinline;
702 checkattr Attribute.Alwaysinline;
703 checkattr Attribute.Optsize;
704 checkattr Attribute.Ssp;
705 checkattr Attribute.Sspreq;
706 let align = Int32.logand (Int32.shift_right_logical a 16) 31l in
708 l := Attribute.Alignment (Int32.to_int align) :: !l;
709 checkattr Attribute.Nocapture;
710 checkattr Attribute.Noredzone;
711 checkattr Attribute.Noimplicitfloat;
712 checkattr Attribute.Naked;
713 checkattr Attribute.Inlinehint;
714 let stackalign = Int32.logand (Int32.shift_right_logical a 26) 7l in
715 if stackalign <> 0l then
716 l := Attribute.Stackalignment (Int32.to_int stackalign) :: !l;
717 checkattr Attribute.ReturnsTwice;
718 checkattr Attribute.UWTable;
719 checkattr Attribute.NonLazyBind;
722 let add_function_attr llval attr =
723 llvm_add_function_attr llval (pack_attr attr)
725 let remove_function_attr llval attr =
726 llvm_remove_function_attr llval (pack_attr attr)
728 let function_attr f = unpack_attr (llvm_function_attr f)
730 (*--... Operations on params ...............................................--*)
731 external params : llvalue -> llvalue array = "llvm_params"
732 external param : llvalue -> int -> llvalue = "llvm_param"
733 external llvm_param_attr : llvalue -> int32 = "llvm_param_attr"
734 let param_attr p = unpack_attr (llvm_param_attr p)
735 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
736 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
737 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
738 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
739 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
741 let rec iter_param_range f i e =
742 if i = e then () else
744 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
747 iter_param_range f (param_succ p) e
749 let iter_params f fn =
750 iter_param_range f (param_begin fn) (At_end fn)
752 let rec fold_left_param_range f init i e =
753 if i = e then init else
755 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
756 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
758 let fold_left_params f init fn =
759 fold_left_param_range f init (param_begin fn) (At_end fn)
761 let rec rev_iter_param_range f i e =
762 if i = e then () else
764 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
767 rev_iter_param_range f (param_pred p) e
769 let rev_iter_params f fn =
770 rev_iter_param_range f (param_end fn) (At_start fn)
772 let rec fold_right_param_range f init i e =
773 if i = e then init else
775 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
776 | After p -> fold_right_param_range f (f p init) (param_pred p) e
778 let fold_right_params f fn init =
779 fold_right_param_range f init (param_end fn) (At_start fn)
781 external llvm_add_param_attr : llvalue -> int32 -> unit
782 = "llvm_add_param_attr"
783 external llvm_remove_param_attr : llvalue -> int32 -> unit
784 = "llvm_remove_param_attr"
786 let add_param_attr llval attr =
787 llvm_add_param_attr llval (pack_attr attr)
789 let remove_param_attr llval attr =
790 llvm_remove_param_attr llval (pack_attr attr)
792 external set_param_alignment : llvalue -> int -> unit
793 = "llvm_set_param_alignment"
795 (*--... Operations on basic blocks .........................................--*)
796 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
797 external value_is_block : llvalue -> bool = "llvm_value_is_block"
798 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
799 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
800 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
801 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
802 external delete_block : llbasicblock -> unit = "llvm_delete_block"
803 external append_block : llcontext -> string -> llvalue -> llbasicblock
804 = "llvm_append_block"
805 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
806 = "llvm_insert_block"
807 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
809 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
811 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
813 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
816 let rec iter_block_range f i e =
817 if i = e then () else
819 | At_end _ -> raise (Invalid_argument "Invalid block range.")
822 iter_block_range f (block_succ bb) e
824 let iter_blocks f fn =
825 iter_block_range f (block_begin fn) (At_end fn)
827 let rec fold_left_block_range f init i e =
828 if i = e then init else
830 | At_end _ -> raise (Invalid_argument "Invalid block range.")
831 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
833 let fold_left_blocks f init fn =
834 fold_left_block_range f init (block_begin fn) (At_end fn)
836 let rec rev_iter_block_range f i e =
837 if i = e then () else
839 | At_start _ -> raise (Invalid_argument "Invalid block range.")
842 rev_iter_block_range f (block_pred bb) e
844 let rev_iter_blocks f fn =
845 rev_iter_block_range f (block_end fn) (At_start fn)
847 let rec fold_right_block_range f init i e =
848 if i = e then init else
850 | At_start _ -> raise (Invalid_argument "Invalid block range.")
851 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
853 let fold_right_blocks f fn init =
854 fold_right_block_range f init (block_end fn) (At_start fn)
856 (*--... Operations on instructions .........................................--*)
857 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
858 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
860 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
862 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
864 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
867 external instr_opcode : llvalue -> Opcode.t = "llvm_instr_get_opcode"
868 external icmp_predicate : llvalue -> Icmp.t option = "llvm_instr_icmp_predicate"
870 external icmp_predicate : llvalue -> Icmp.t option = "llvm_instr_icmp_predicate"
872 let rec iter_instrs_range f i e =
873 if i = e then () else
875 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
878 iter_instrs_range f (instr_succ i) e
880 let iter_instrs f bb =
881 iter_instrs_range f (instr_begin bb) (At_end bb)
883 let rec fold_left_instrs_range f init i e =
884 if i = e then init else
886 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
887 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
889 let fold_left_instrs f init bb =
890 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
892 let rec rev_iter_instrs_range f i e =
893 if i = e then () else
895 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
898 rev_iter_instrs_range f (instr_pred i) e
900 let rev_iter_instrs f bb =
901 rev_iter_instrs_range f (instr_end bb) (At_start bb)
903 let rec fold_right_instr_range f i e init =
904 if i = e then init else
906 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
907 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
909 let fold_right_instrs f bb init =
910 fold_right_instr_range f (instr_end bb) (At_start bb) init
913 (*--... Operations on call sites ...........................................--*)
914 external instruction_call_conv: llvalue -> int
915 = "llvm_instruction_call_conv"
916 external set_instruction_call_conv: int -> llvalue -> unit
917 = "llvm_set_instruction_call_conv"
919 external llvm_add_instruction_param_attr : llvalue -> int -> int32 -> unit
920 = "llvm_add_instruction_param_attr"
921 external llvm_remove_instruction_param_attr : llvalue -> int -> int32 -> unit
922 = "llvm_remove_instruction_param_attr"
924 let add_instruction_param_attr llval i attr =
925 llvm_add_instruction_param_attr llval i (pack_attr attr)
927 let remove_instruction_param_attr llval i attr =
928 llvm_remove_instruction_param_attr llval i (pack_attr attr)
930 (*--... Operations on call instructions (only) .............................--*)
931 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
932 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
934 (*--... Operations on phi nodes ............................................--*)
935 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
936 = "llvm_add_incoming"
937 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
940 (*===-- Instruction builders ----------------------------------------------===*)
941 external builder : llcontext -> llbuilder = "llvm_builder"
942 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
943 = "llvm_position_builder"
944 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
945 external insert_into_builder : llvalue -> string -> llbuilder -> unit
946 = "llvm_insert_into_builder"
948 let builder_at context ip =
949 let b = builder context in
950 position_builder ip b;
953 let builder_before context i = builder_at context (Before i)
954 let builder_at_end context bb = builder_at context (At_end bb)
956 let position_before i = position_builder (Before i)
957 let position_at_end bb = position_builder (At_end bb)
960 (*--... Metadata ...........................................................--*)
961 external set_current_debug_location : llbuilder -> llvalue -> unit
962 = "llvm_set_current_debug_location"
963 external clear_current_debug_location : llbuilder -> unit
964 = "llvm_clear_current_debug_location"
965 external current_debug_location : llbuilder -> llvalue option
966 = "llvm_current_debug_location"
967 external set_inst_debug_location : llbuilder -> llvalue -> unit
968 = "llvm_set_inst_debug_location"
971 (*--... Terminators ........................................................--*)
972 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
973 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
974 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
975 = "llvm_build_aggregate_ret"
976 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
977 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
978 llvalue = "llvm_build_cond_br"
979 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
980 = "llvm_build_switch"
981 external add_case : llvalue -> llvalue -> llbasicblock -> unit
983 external build_indirect_br : llvalue -> int -> llbuilder -> llvalue
984 = "llvm_build_indirect_br"
985 external add_destination : llvalue -> llbasicblock -> unit
986 = "llvm_add_destination"
987 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
988 llbasicblock -> string -> llbuilder -> llvalue
989 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
990 external build_landingpad : lltype -> llvalue -> int -> string -> llbuilder ->
991 llvalue = "llvm_build_landingpad"
992 external set_cleanup : llvalue -> bool -> unit = "llvm_set_cleanup"
993 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
995 (*--... Arithmetic .........................................................--*)
996 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
998 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
999 = "llvm_build_nsw_add"
1000 external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
1001 = "llvm_build_nuw_add"
1002 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
1004 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1006 external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1007 = "llvm_build_nsw_sub"
1008 external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1009 = "llvm_build_nuw_sub"
1010 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
1012 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1014 external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1015 = "llvm_build_nsw_mul"
1016 external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1017 = "llvm_build_nuw_mul"
1018 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
1020 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1022 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1024 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1025 = "llvm_build_exact_sdiv"
1026 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
1028 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
1030 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
1032 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
1034 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
1036 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
1038 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
1040 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
1042 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
1044 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
1046 external build_neg : llvalue -> string -> llbuilder -> llvalue
1048 external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
1049 = "llvm_build_nsw_neg"
1050 external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
1051 = "llvm_build_nuw_neg"
1052 external build_fneg : llvalue -> string -> llbuilder -> llvalue
1054 external build_not : llvalue -> string -> llbuilder -> llvalue
1057 (*--... Memory .............................................................--*)
1058 external build_alloca : lltype -> string -> llbuilder -> llvalue
1059 = "llvm_build_alloca"
1060 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
1061 llvalue = "llvm_build_array_alloca"
1062 external build_load : llvalue -> string -> llbuilder -> llvalue
1064 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
1065 = "llvm_build_store"
1066 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
1068 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
1069 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
1070 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
1071 = "llvm_build_struct_gep"
1073 external build_global_string : string -> string -> llbuilder -> llvalue
1074 = "llvm_build_global_string"
1075 external build_global_stringptr : string -> string -> llbuilder -> llvalue
1076 = "llvm_build_global_stringptr"
1078 (*--... Casts ..............................................................--*)
1079 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
1080 = "llvm_build_trunc"
1081 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
1083 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
1085 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
1086 = "llvm_build_fptoui"
1087 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
1088 = "llvm_build_fptosi"
1089 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
1090 = "llvm_build_uitofp"
1091 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
1092 = "llvm_build_sitofp"
1093 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
1094 = "llvm_build_fptrunc"
1095 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
1096 = "llvm_build_fpext"
1097 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
1098 = "llvm_build_prttoint"
1099 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
1100 = "llvm_build_inttoptr"
1101 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1102 = "llvm_build_bitcast"
1103 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1104 llvalue = "llvm_build_zext_or_bitcast"
1105 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1106 llvalue = "llvm_build_sext_or_bitcast"
1107 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
1108 llvalue = "llvm_build_trunc_or_bitcast"
1109 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
1110 = "llvm_build_pointercast"
1111 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1112 = "llvm_build_intcast"
1113 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
1114 = "llvm_build_fpcast"
1116 (*--... Comparisons ........................................................--*)
1117 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
1118 llbuilder -> llvalue = "llvm_build_icmp"
1119 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
1120 llbuilder -> llvalue = "llvm_build_fcmp"
1122 (*--... Miscellaneous instructions .........................................--*)
1123 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
1124 llvalue = "llvm_build_phi"
1125 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
1127 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
1128 llvalue = "llvm_build_select"
1129 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
1130 = "llvm_build_va_arg"
1131 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
1132 llvalue = "llvm_build_extractelement"
1133 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
1134 llbuilder -> llvalue = "llvm_build_insertelement"
1135 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
1136 llbuilder -> llvalue = "llvm_build_shufflevector"
1137 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
1138 = "llvm_build_extractvalue"
1139 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
1140 llvalue = "llvm_build_insertvalue"
1142 external build_is_null : llvalue -> string -> llbuilder -> llvalue
1143 = "llvm_build_is_null"
1144 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
1145 = "llvm_build_is_not_null"
1146 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
1147 = "llvm_build_ptrdiff"
1150 (*===-- Memory buffers ----------------------------------------------------===*)
1152 module MemoryBuffer = struct
1153 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
1154 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
1155 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
1159 (*===-- Pass Manager ------------------------------------------------------===*)
1161 module PassManager = struct
1163 type any = [ `Module | `Function ]
1164 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
1165 external create_function : llmodule -> [ `Function ] t
1166 = "LLVMCreateFunctionPassManager"
1167 external run_module : llmodule -> [ `Module ] t -> bool
1168 = "llvm_passmanager_run_module"
1169 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
1170 external run_function : llvalue -> [ `Function ] t -> bool
1171 = "llvm_passmanager_run_function"
1172 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
1173 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
1177 (*===-- Non-Externs -------------------------------------------------------===*)
1178 (* These functions are built using the externals, so must be declared late. *)
1180 let concat2 sep arr =
1182 if 0 < Array.length arr then begin
1184 for i = 1 to (Array.length arr) - 1 do
1185 s := !s ^ sep ^ arr.(i)
1190 let rec string_of_lltype ty =
1191 (* FIXME: stop infinite recursion! :) *)
1192 match classify_type ty with
1193 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
1194 | TypeKind.Pointer ->
1195 (let ety = element_type ty in
1196 match classify_type ety with
1197 | TypeKind.Struct ->
1198 (match struct_name ety with
1199 | None -> (string_of_lltype ety)
1200 | Some s -> s) ^ "*"
1201 | _ -> (string_of_lltype (element_type ty)) ^ "*")
1202 | TypeKind.Struct ->
1203 let s = "{ " ^ (concat2 ", " (
1204 Array.map string_of_lltype (struct_element_types ty)
1209 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
1210 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
1211 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
1212 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
1213 | TypeKind.Function -> string_of_lltype (return_type ty) ^
1214 " (" ^ (concat2 ", " (
1215 Array.map string_of_lltype (param_types ty)
1217 | TypeKind.Label -> "label"
1218 | TypeKind.Ppc_fp128 -> "ppc_fp128"
1219 | TypeKind.Fp128 -> "fp128"
1220 | TypeKind.X86fp80 -> "x86_fp80"
1221 | TypeKind.Double -> "double"
1222 | TypeKind.Float -> "float"
1223 | TypeKind.Void -> "void"
1224 | TypeKind.Metadata -> "metadata"