1 /*===-- llvm-c/Target.h - Target Lib C Iface --------------------*- C++ -*-===*/
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 /*===----------------------------------------------------------------------===*/
10 /* This header declares the C interface to libLLVMTarget.a, which */
11 /* implements target information. */
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. */
17 /*===----------------------------------------------------------------------===*/
19 #ifndef LLVM_C_TARGET_H
20 #define LLVM_C_TARGET_H
22 #include "llvm-c/Core.h"
23 #include "llvm/Config/llvm-config.h"
25 #if defined(_MSC_VER) && !defined(inline)
26 #define inline __inline
34 * @defgroup LLVMCTarget Target information
40 enum LLVMByteOrdering { LLVMBigEndian, LLVMLittleEndian };
42 typedef struct LLVMOpaqueTargetData *LLVMTargetDataRef;
43 typedef struct LLVMOpaqueTargetLibraryInfotData *LLVMTargetLibraryInfoRef;
44 typedef struct LLVMStructLayout *LLVMStructLayoutRef;
46 /* Declare all of the target-initialization functions that are available. */
47 #define LLVM_TARGET(TargetName) \
48 void LLVMInitialize##TargetName##TargetInfo(void);
49 #include "llvm/Config/Targets.def"
50 #undef LLVM_TARGET /* Explicit undef to make SWIG happier */
52 #define LLVM_TARGET(TargetName) void LLVMInitialize##TargetName##Target(void);
53 #include "llvm/Config/Targets.def"
54 #undef LLVM_TARGET /* Explicit undef to make SWIG happier */
56 #define LLVM_TARGET(TargetName) \
57 void LLVMInitialize##TargetName##TargetMC(void);
58 #include "llvm/Config/Targets.def"
59 #undef LLVM_TARGET /* Explicit undef to make SWIG happier */
61 /* Declare all of the available assembly printer initialization functions. */
62 #define LLVM_ASM_PRINTER(TargetName) \
63 void LLVMInitialize##TargetName##AsmPrinter(void);
64 #include "llvm/Config/AsmPrinters.def"
65 #undef LLVM_ASM_PRINTER /* Explicit undef to make SWIG happier */
67 /* Declare all of the available assembly parser initialization functions. */
68 #define LLVM_ASM_PARSER(TargetName) \
69 void LLVMInitialize##TargetName##AsmParser(void);
70 #include "llvm/Config/AsmParsers.def"
71 #undef LLVM_ASM_PARSER /* Explicit undef to make SWIG happier */
73 /* Declare all of the available disassembler initialization functions. */
74 #define LLVM_DISASSEMBLER(TargetName) \
75 void LLVMInitialize##TargetName##Disassembler(void);
76 #include "llvm/Config/Disassemblers.def"
77 #undef LLVM_DISASSEMBLER /* Explicit undef to make SWIG happier */
79 /** LLVMInitializeAllTargetInfos - The main program should call this function if
80 it wants access to all available targets that LLVM is configured to
82 static inline void LLVMInitializeAllTargetInfos(void) {
83 #define LLVM_TARGET(TargetName) LLVMInitialize##TargetName##TargetInfo();
84 #include "llvm/Config/Targets.def"
85 #undef LLVM_TARGET /* Explicit undef to make SWIG happier */
88 /** LLVMInitializeAllTargets - The main program should call this function if it
89 wants to link in all available targets that LLVM is configured to
91 static inline void LLVMInitializeAllTargets(void) {
92 #define LLVM_TARGET(TargetName) LLVMInitialize##TargetName##Target();
93 #include "llvm/Config/Targets.def"
94 #undef LLVM_TARGET /* Explicit undef to make SWIG happier */
97 /** LLVMInitializeAllTargetMCs - The main program should call this function if
98 it wants access to all available target MC that LLVM is configured to
100 static inline void LLVMInitializeAllTargetMCs(void) {
101 #define LLVM_TARGET(TargetName) LLVMInitialize##TargetName##TargetMC();
102 #include "llvm/Config/Targets.def"
103 #undef LLVM_TARGET /* Explicit undef to make SWIG happier */
106 /** LLVMInitializeAllAsmPrinters - The main program should call this function if
107 it wants all asm printers that LLVM is configured to support, to make them
108 available via the TargetRegistry. */
109 static inline void LLVMInitializeAllAsmPrinters(void) {
110 #define LLVM_ASM_PRINTER(TargetName) LLVMInitialize##TargetName##AsmPrinter();
111 #include "llvm/Config/AsmPrinters.def"
112 #undef LLVM_ASM_PRINTER /* Explicit undef to make SWIG happier */
115 /** LLVMInitializeAllAsmParsers - The main program should call this function if
116 it wants all asm parsers that LLVM is configured to support, to make them
117 available via the TargetRegistry. */
118 static inline void LLVMInitializeAllAsmParsers(void) {
119 #define LLVM_ASM_PARSER(TargetName) LLVMInitialize##TargetName##AsmParser();
120 #include "llvm/Config/AsmParsers.def"
121 #undef LLVM_ASM_PARSER /* Explicit undef to make SWIG happier */
124 /** LLVMInitializeAllDisassemblers - The main program should call this function
125 if it wants all disassemblers that LLVM is configured to support, to make
126 them available via the TargetRegistry. */
127 static inline void LLVMInitializeAllDisassemblers(void) {
128 #define LLVM_DISASSEMBLER(TargetName) \
129 LLVMInitialize##TargetName##Disassembler();
130 #include "llvm/Config/Disassemblers.def"
131 #undef LLVM_DISASSEMBLER /* Explicit undef to make SWIG happier */
134 /** LLVMInitializeNativeTarget - The main program should call this function to
135 initialize the native target corresponding to the host. This is useful
136 for JIT applications to ensure that the target gets linked in correctly. */
137 static inline LLVMBool LLVMInitializeNativeTarget(void) {
138 /* If we have a native target, initialize it to ensure it is linked in. */
139 #ifdef LLVM_NATIVE_TARGET
140 LLVM_NATIVE_TARGETINFO();
141 LLVM_NATIVE_TARGET();
142 LLVM_NATIVE_TARGETMC();
149 /** LLVMInitializeNativeTargetAsmParser - The main program should call this
150 function to initialize the parser for the native target corresponding to the
152 static inline LLVMBool LLVMInitializeNativeTargetAsmParser(void) {
153 #ifdef LLVM_NATIVE_TARGET
154 LLVM_NATIVE_ASMPARSER();
161 /** LLVMInitializeNativeTargetAsmPrinter - The main program should call this
162 function to initialize the printer for the native target corresponding to
164 static inline LLVMBool LLVMInitializeNativeTargetAsmPrinter(void) {
165 #ifdef LLVM_NATIVE_TARGET
166 LLVM_NATIVE_ASMPRINTER();
173 /** LLVMInitializeNativeTargetDisassembler - The main program should call this
174 function to initialize the disassembler for the native target corresponding
176 static inline LLVMBool LLVMInitializeNativeTargetDisassembler(void) {
177 #ifdef LLVM_NATIVE_TARGET
178 LLVM_NATIVE_DISASSEMBLER();
185 /*===-- Target Data -------------------------------------------------------===*/
187 /** Creates target data from a target layout string.
188 See the constructor llvm::DataLayout::DataLayout. */
189 LLVMTargetDataRef LLVMCreateTargetData(const char *StringRep);
191 /** Adds target data information to a pass manager. This does not take ownership
193 See the method llvm::PassManagerBase::add. */
194 void LLVMAddTargetData(LLVMTargetDataRef, LLVMPassManagerRef);
196 /** Adds target library information to a pass manager. This does not take
197 ownership of the target library info.
198 See the method llvm::PassManagerBase::add. */
199 void LLVMAddTargetLibraryInfo(LLVMTargetLibraryInfoRef, LLVMPassManagerRef);
201 /** Converts target data to a target layout string. The string must be disposed
202 with LLVMDisposeMessage.
203 See the constructor llvm::DataLayout::DataLayout. */
204 char *LLVMCopyStringRepOfTargetData(LLVMTargetDataRef);
206 /** Returns the byte order of a target, either LLVMBigEndian or
208 See the method llvm::DataLayout::isLittleEndian. */
209 enum LLVMByteOrdering LLVMByteOrder(LLVMTargetDataRef);
211 /** Returns the pointer size in bytes for a target.
212 See the method llvm::DataLayout::getPointerSize. */
213 unsigned LLVMPointerSize(LLVMTargetDataRef);
215 /** Returns the pointer size in bytes for a target for a specified
217 See the method llvm::DataLayout::getPointerSize. */
218 unsigned LLVMPointerSizeForAS(LLVMTargetDataRef, unsigned AS);
220 /** Returns the integer type that is the same size as a pointer on a target.
221 See the method llvm::DataLayout::getIntPtrType. */
222 LLVMTypeRef LLVMIntPtrType(LLVMTargetDataRef);
224 /** Returns the integer type that is the same size as a pointer on a target.
225 This version allows the address space to be specified.
226 See the method llvm::DataLayout::getIntPtrType. */
227 LLVMTypeRef LLVMIntPtrTypeForAS(LLVMTargetDataRef, unsigned AS);
229 /** Returns the integer type that is the same size as a pointer on a target.
230 See the method llvm::DataLayout::getIntPtrType. */
231 LLVMTypeRef LLVMIntPtrTypeInContext(LLVMContextRef, LLVMTargetDataRef);
233 /** Returns the integer type that is the same size as a pointer on a target.
234 This version allows the address space to be specified.
235 See the method llvm::DataLayout::getIntPtrType. */
236 LLVMTypeRef LLVMIntPtrTypeForASInContext(LLVMContextRef, LLVMTargetDataRef, unsigned AS);
238 /** Computes the size of a type in bytes for a target.
239 See the method llvm::DataLayout::getTypeSizeInBits. */
240 unsigned long long LLVMSizeOfTypeInBits(LLVMTargetDataRef, LLVMTypeRef);
242 /** Computes the storage size of a type in bytes for a target.
243 See the method llvm::DataLayout::getTypeStoreSize. */
244 unsigned long long LLVMStoreSizeOfType(LLVMTargetDataRef, LLVMTypeRef);
246 /** Computes the ABI size of a type in bytes for a target.
247 See the method llvm::DataLayout::getTypeAllocSize. */
248 unsigned long long LLVMABISizeOfType(LLVMTargetDataRef, LLVMTypeRef);
250 /** Computes the ABI alignment of a type in bytes for a target.
251 See the method llvm::DataLayout::getTypeABISize. */
252 unsigned LLVMABIAlignmentOfType(LLVMTargetDataRef, LLVMTypeRef);
254 /** Computes the call frame alignment of a type in bytes for a target.
255 See the method llvm::DataLayout::getTypeABISize. */
256 unsigned LLVMCallFrameAlignmentOfType(LLVMTargetDataRef, LLVMTypeRef);
258 /** Computes the preferred alignment of a type in bytes for a target.
259 See the method llvm::DataLayout::getTypeABISize. */
260 unsigned LLVMPreferredAlignmentOfType(LLVMTargetDataRef, LLVMTypeRef);
262 /** Computes the preferred alignment of a global variable in bytes for a target.
263 See the method llvm::DataLayout::getPreferredAlignment. */
264 unsigned LLVMPreferredAlignmentOfGlobal(LLVMTargetDataRef,
265 LLVMValueRef GlobalVar);
267 /** Computes the structure element that contains the byte offset for a target.
268 See the method llvm::StructLayout::getElementContainingOffset. */
269 unsigned LLVMElementAtOffset(LLVMTargetDataRef, LLVMTypeRef StructTy,
270 unsigned long long Offset);
272 /** Computes the byte offset of the indexed struct element for a target.
273 See the method llvm::StructLayout::getElementContainingOffset. */
274 unsigned long long LLVMOffsetOfElement(LLVMTargetDataRef, LLVMTypeRef StructTy,
277 /** Deallocates a TargetData.
278 See the destructor llvm::DataLayout::~DataLayout. */
279 void LLVMDisposeTargetData(LLVMTargetDataRef);
287 #endif /* defined(__cplusplus) */