include/llvm-c/Target.h

   1 /*===-- llvm-c/Target.h - Target Lib C Iface --------------------*- C++ -*-===*/
   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 /* This header declares the C interface to libLLVMTarget.a, which             */
  11 /* implements target information.                                             */
  12 /*                                                                            */
  13 /* Many exotic languages can interoperate with C code but have a harder time  */
  14 /* with C++ due to name mangling. So in addition to C, this interface enables */
  15 /* tools written in such languages.                                           */
  16 /*                                                                            */
  17 /*===----------------------------------------------------------------------===*/
  18
  19 #ifndef LLVM_C_TARGET_H
  20 #define LLVM_C_TARGET_H
  21
  22 #include "llvm-c/Core.h"
  23 #include "llvm/Config/llvm-config.h"
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 enum LLVMByteOrdering { LLVMBigEndian, LLVMLittleEndian };
  30
  31 typedef struct LLVMOpaqueTargetData *LLVMTargetDataRef;
  32 typedef struct LLVMOpaqueTargetLibraryInfotData *LLVMTargetLibraryInfoRef;
  33 typedef struct LLVMStructLayout *LLVMStructLayoutRef;
  34
  35 /* Declare all of the target-initialization functions that are available. */
  36 #define LLVM_TARGET(TargetName) \
  37   void LLVMInitialize##TargetName##TargetInfo(void);
  38 #include "llvm/Config/Targets.def"
  39 #undef LLVM_TARGET  /* Explicit undef to make SWIG happier */
  40
  41 #define LLVM_TARGET(TargetName) void LLVMInitialize##TargetName##Target(void);
  42 #include "llvm/Config/Targets.def"
  43 #undef LLVM_TARGET  /* Explicit undef to make SWIG happier */
  44
  45 #define LLVM_TARGET(TargetName) \
  46   void LLVMInitialize##TargetName##TargetMC(void);
  47 #include "llvm/Config/Targets.def"
  48 #undef LLVM_TARGET  /* Explicit undef to make SWIG happier */
  49
  50 /* Declare all of the available assembly printer initialization functions. */
  51 #define LLVM_ASM_PRINTER(TargetName) \
  52   void LLVMInitialize##TargetName##AsmPrinter();
  53 #include "llvm/Config/AsmPrinters.def"
  54
  55 /* Declare all of the available assembly parser initialization functions. */
  56 #define LLVM_ASM_PARSER(TargetName) \
  57   void LLVMInitialize##TargetName##AsmParser();
  58 #include "llvm/Config/AsmParsers.def"
  59
  60 /* Declare all of the available disassembler initialization functions. */
  61 #define LLVM_DISASSEMBLER(TargetName) \
  62   void LLVMInitialize##TargetName##Disassembler();
  63 #include "llvm/Config/Disassemblers.def"
  64
  65 /** LLVMInitializeAllTargetInfos - The main program should call this function if
  66     it wants access to all available targets that LLVM is configured to
  67     support. */
  68 static inline void LLVMInitializeAllTargetInfos(void) {
  69 #define LLVM_TARGET(TargetName) LLVMInitialize##TargetName##TargetInfo();
  70 #include "llvm/Config/Targets.def"
  71 #undef LLVM_TARGET  /* Explicit undef to make SWIG happier */
  72 }
  73
  74 /** LLVMInitializeAllTargets - The main program should call this function if it
  75     wants to link in all available targets that LLVM is configured to
  76     support. */
  77 static inline void LLVMInitializeAllTargets(void) {
  78 #define LLVM_TARGET(TargetName) LLVMInitialize##TargetName##Target();
  79 #include "llvm/Config/Targets.def"
  80 #undef LLVM_TARGET  /* Explicit undef to make SWIG happier */
  81 }
  82
  83 /** LLVMInitializeAllTargetMCs - The main program should call this function if
  84     it wants access to all available target MC that LLVM is configured to
  85     support. */
  86 static inline void LLVMInitializeAllTargetMCs(void) {
  87 #define LLVM_TARGET(TargetName) LLVMInitialize##TargetName##TargetMC();
  88 #include "llvm/Config/Targets.def"
  89 #undef LLVM_TARGET  /* Explicit undef to make SWIG happier */
  90 }
  91
  92 /** LLVMInitializeAllAsmPrinters - The main program should call this function if
  93     it wants all asm printers that LLVM is configured to support, to make them
  94     available via the TargetRegistry. */
  95 static inline void LLVMInitializeAllAsmPrinters() {
  96 #define LLVM_ASM_PRINTER(TargetName) LLVMInitialize##TargetName##AsmPrinter();
  97 #include "llvm/Config/AsmPrinters.def"
  98 #undef LLVM_ASM_PRINTER  /* Explicit undef to make SWIG happier */
  99 }
 100
 101 /** LLVMInitializeAllAsmParsers - The main program should call this function if
 102     it wants all asm parsers that LLVM is configured to support, to make them
 103     available via the TargetRegistry. */
 104 static inline void LLVMInitializeAllAsmParsers() {
 105 #define LLVM_ASM_PARSER(TargetName) LLVMInitialize##TargetName##AsmParser();
 106 #include "llvm/Config/AsmParsers.def"
 107 #undef LLVM_ASM_PARSER  /* Explicit undef to make SWIG happier */
 108 }
 109
 110 /** LLVMInitializeAllDisassemblers - The main program should call this function
 111     if it wants all disassemblers that LLVM is configured to support, to make
 112     them available via the TargetRegistry. */
 113 static inline void LLVMInitializeAllDisassemblers() {
 114 #define LLVM_DISASSEMBLER(TargetName) \
 115   LLVMInitialize##TargetName##Disassembler();
 116 #include "llvm/Config/Disassemblers.def"
 117 #undef LLVM_DISASSEMBLER  /* Explicit undef to make SWIG happier */
 118 }
 119
 120 /** LLVMInitializeNativeTarget - The main program should call this function to
 121     initialize the native target corresponding to the host.  This is useful
 122     for JIT applications to ensure that the target gets linked in correctly. */
 123 static inline LLVMBool LLVMInitializeNativeTarget(void) {
 124   /* If we have a native target, initialize it to ensure it is linked in. */
 125 #ifdef LLVM_NATIVE_TARGET
 126   LLVM_NATIVE_TARGETINFO();
 127   LLVM_NATIVE_TARGET();
 128   LLVM_NATIVE_TARGETMC();
 129   return 0;
 130 #else
 131   return 1;
 132 #endif
 133 }
 134
 135 /*===-- Target Data -------------------------------------------------------===*/
 136
 137 /** Creates target data from a target layout string.
 138     See the constructor llvm::TargetData::TargetData. */
 139 LLVMTargetDataRef LLVMCreateTargetData(const char *StringRep);
 140
 141 /** Adds target data information to a pass manager. This does not take ownership
 142     of the target data.
 143     See the method llvm::PassManagerBase::add. */
 144 void LLVMAddTargetData(LLVMTargetDataRef, LLVMPassManagerRef);
 145
 146 /** Adds target library information to a pass manager. This does not take
 147     ownership of the target library info.
 148     See the method llvm::PassManagerBase::add. */
 149 void LLVMAddTargetLibraryInfo(LLVMTargetLibraryInfoRef, LLVMPassManagerRef);
 150
 151 /** Converts target data to a target layout string. The string must be disposed
 152     with LLVMDisposeMessage.
 153     See the constructor llvm::TargetData::TargetData. */
 154 char *LLVMCopyStringRepOfTargetData(LLVMTargetDataRef);
 155
 156 /** Returns the byte order of a target, either LLVMBigEndian or
 157     LLVMLittleEndian.
 158     See the method llvm::TargetData::isLittleEndian. */
 159 enum LLVMByteOrdering LLVMByteOrder(LLVMTargetDataRef);
 160
 161 /** Returns the pointer size in bytes for a target.
 162     See the method llvm::TargetData::getPointerSize. */
 163 unsigned LLVMPointerSize(LLVMTargetDataRef);
 164
 165 /** Returns the integer type that is the same size as a pointer on a target.
 166     See the method llvm::TargetData::getIntPtrType. */
 167 LLVMTypeRef LLVMIntPtrType(LLVMTargetDataRef);
 168
 169 /** Computes the size of a type in bytes for a target.
 170     See the method llvm::TargetData::getTypeSizeInBits. */
 171 unsigned long long LLVMSizeOfTypeInBits(LLVMTargetDataRef, LLVMTypeRef);
 172
 173 /** Computes the storage size of a type in bytes for a target.
 174     See the method llvm::TargetData::getTypeStoreSize. */
 175 unsigned long long LLVMStoreSizeOfType(LLVMTargetDataRef, LLVMTypeRef);
 176
 177 /** Computes the ABI size of a type in bytes for a target.
 178     See the method llvm::TargetData::getTypeAllocSize. */
 179 unsigned long long LLVMABISizeOfType(LLVMTargetDataRef, LLVMTypeRef);
 180
 181 /** Computes the ABI alignment of a type in bytes for a target.
 182     See the method llvm::TargetData::getTypeABISize. */
 183 unsigned LLVMABIAlignmentOfType(LLVMTargetDataRef, LLVMTypeRef);
 184
 185 /** Computes the call frame alignment of a type in bytes for a target.
 186     See the method llvm::TargetData::getTypeABISize. */
 187 unsigned LLVMCallFrameAlignmentOfType(LLVMTargetDataRef, LLVMTypeRef);
 188
 189 /** Computes the preferred alignment of a type in bytes for a target.
 190     See the method llvm::TargetData::getTypeABISize. */
 191 unsigned LLVMPreferredAlignmentOfType(LLVMTargetDataRef, LLVMTypeRef);
 192
 193 /** Computes the preferred alignment of a global variable in bytes for a target.
 194     See the method llvm::TargetData::getPreferredAlignment. */
 195 unsigned LLVMPreferredAlignmentOfGlobal(LLVMTargetDataRef,
 196                                         LLVMValueRef GlobalVar);
 197
 198 /** Computes the structure element that contains the byte offset for a target.
 199     See the method llvm::StructLayout::getElementContainingOffset. */
 200 unsigned LLVMElementAtOffset(LLVMTargetDataRef, LLVMTypeRef StructTy,
 201                              unsigned long long Offset);
 202
 203 /** Computes the byte offset of the indexed struct element for a target.
 204     See the method llvm::StructLayout::getElementContainingOffset. */
 205 unsigned long long LLVMOffsetOfElement(LLVMTargetDataRef, LLVMTypeRef StructTy,
 206                                        unsigned Element);
 207
 208 /** Deallocates a TargetData.
 209     See the destructor llvm::TargetData::~TargetData. */
 210 void LLVMDisposeTargetData(LLVMTargetDataRef);
 211
 212
 213 #ifdef __cplusplus
 214 }
 215
 216 namespace llvm {
 217   class TargetData;
 218   class TargetLibraryInfo;
 219
 220   inline TargetData *unwrap(LLVMTargetDataRef P) {
 221     return reinterpret_cast<TargetData*>(P);
 222   }
 223
 224   inline LLVMTargetDataRef wrap(const TargetData *P) {
 225     return reinterpret_cast<LLVMTargetDataRef>(const_cast<TargetData*>(P));
 226   }
 227
 228   inline TargetLibraryInfo *unwrap(LLVMTargetLibraryInfoRef P) {
 229     return reinterpret_cast<TargetLibraryInfo*>(P);
 230   }
 231
 232   inline LLVMTargetLibraryInfoRef wrap(const TargetLibraryInfo *P) {
 233     TargetLibraryInfo *X = const_cast<TargetLibraryInfo*>(P);
 234     return reinterpret_cast<LLVMTargetLibraryInfoRef>(X);
 235   }
 236 }
 237
 238 #endif /* defined(__cplusplus) */
 239
 240 #endif