bindings/ocaml/target/llvm_target.mli

   1 (*===-- llvm_target.mli - LLVM OCaml Interface -----------------*- OCaml -*-===*
   2  *
   3  *                     The LLVM Compiler Infrastructure
   4  *
   5  * This file is distributed under the University of Illinois Open Source
   6  * License. See LICENSE.TXT for details.
   7  *
   8  *===----------------------------------------------------------------------===*)
   9
  10 (** Target Information.
  11
  12     This interface provides an OCaml API for LLVM target information,
  13     the classes in the Target library. *)
  14
  15 module Endian : sig
  16   type t =
  17   | Big
  18   | Little
  19 end
  20
  21 module DataLayout : sig
  22   type t
  23
  24   (** [DataLayout.create rep] parses the target data string representation [rep].
  25       See the constructor llvm::DataLayout::DataLayout. *)
  26   external create : string -> t = "llvm_targetdata_create"
  27
  28   (** [add_target_data td pm] adds the target data [td] to the pass manager [pm].
  29       Does not take ownership of the target data.
  30       See the method llvm::PassManagerBase::add. *)
  31   external add : t -> [<Llvm.PassManager.any] Llvm.PassManager.t -> unit
  32                = "llvm_targetdata_add"
  33
  34   (** [as_string td] is the string representation of the target data [td].
  35       See the constructor llvm::DataLayout::DataLayout. *)
  36   external as_string : t -> string = "llvm_targetdata_as_string"
  37 end
  38
  39 (** Returns the byte order of a target, either LLVMBigEndian or
  40     LLVMLittleEndian.
  41     See the method llvm::DataLayout::isLittleEndian. *)
  42 external byte_order : DataLayout.t -> Endian.t = "llvm_byte_order"
  43
  44 (** Returns the pointer size in bytes for a target.
  45     See the method llvm::DataLayout::getPointerSize. *)
  46 external pointer_size : DataLayout.t -> int = "llvm_pointer_size"
  47
  48 (** Returns the integer type that is the same size as a pointer on a target.
  49     See the method llvm::DataLayout::getIntPtrType. *)
  50 external intptr_type : DataLayout.t -> Llvm.llcontext -> Llvm.lltype
  51                      = "llvm_intptr_type"
  52
  53 (** Returns the pointer size in bytes for a target in a given address space.
  54     See the method llvm::DataLayout::getPointerSize. *)
  55 external qualified_pointer_size : DataLayout.t -> int -> int
  56                                 = "llvm_qualified_pointer_size"
  57
  58 (** Returns the integer type that is the same size as a pointer on a target
  59     in a given address space.
  60     See the method llvm::DataLayout::getIntPtrType. *)
  61 external qualified_intptr_type : DataLayout.t -> Llvm.llcontext ->
  62                                  int -> Llvm.lltype
  63                                = "llvm_qualified_intptr_type"
  64
  65 (** Computes the size of a type in bits for a target.
  66     See the method llvm::DataLayout::getTypeSizeInBits. *)
  67 external size_in_bits : DataLayout.t -> Llvm.lltype -> Int64.t
  68                       = "llvm_size_in_bits"
  69
  70 (** Computes the storage size of a type in bytes for a target.
  71     See the method llvm::DataLayout::getTypeStoreSize. *)
  72 external store_size : DataLayout.t -> Llvm.lltype -> Int64.t = "llvm_store_size"
  73
  74 (** Computes the ABI size of a type in bytes for a target.
  75     See the method llvm::DataLayout::getTypeAllocSize. *)
  76 external abi_size : DataLayout.t -> Llvm.lltype -> Int64.t = "llvm_abi_size"
  77
  78 (** Computes the ABI alignment of a type in bytes for a target.
  79     See the method llvm::DataLayout::getTypeABISize. *)
  80 external abi_align : DataLayout.t -> Llvm.lltype -> int = "llvm_abi_align"
  81
  82 (** Computes the call frame alignment of a type in bytes for a target.
  83     See the method llvm::DataLayout::getTypeABISize. *)
  84 external stack_align : DataLayout.t -> Llvm.lltype -> int = "llvm_stack_align"
  85
  86 (** Computes the preferred alignment of a type in bytes for a target.
  87     See the method llvm::DataLayout::getTypeABISize. *)
  88 external preferred_align : DataLayout.t -> Llvm.lltype -> int
  89                          = "llvm_preferred_align"
  90
  91 (** Computes the preferred alignment of a global variable in bytes for a target.
  92     See the method llvm::DataLayout::getPreferredAlignment. *)
  93 external preferred_align_of_global : DataLayout.t -> Llvm.llvalue -> int
  94                                    = "llvm_preferred_align_of_global"
  95
  96 (** Computes the structure element that contains the byte offset for a target.
  97     See the method llvm::StructLayout::getElementContainingOffset. *)
  98 external element_at_offset : DataLayout.t -> Llvm.lltype -> Int64.t -> int
  99                            = "llvm_element_at_offset"
 100
 101 (** Computes the byte offset of the indexed struct element for a target.
 102     See the method llvm::StructLayout::getElementContainingOffset. *)
 103 external offset_of_element : DataLayout.t -> Llvm.lltype -> int -> Int64.t
 104                            = "llvm_offset_of_element"