Target.h revision 263508 
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#if defined(_MSC_VER) && !defined(inline)
26#define inline __inline
27#endif
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33/**
34 * @defgroup LLVMCTarget Target information
35 * @ingroup LLVMC
36 *
37 * @{
38 */
39
40enum LLVMByteOrdering { LLVMBigEndian, LLVMLittleEndian };
41
42typedef struct LLVMOpaqueTargetData *LLVMTargetDataRef;
43typedef struct LLVMOpaqueTargetLibraryInfotData *LLVMTargetLibraryInfoRef;
44
45/* Declare all of the target-initialization functions that are available. */
46#define LLVM_TARGET(TargetName) \
47  void LLVMInitialize##TargetName##TargetInfo(void);
48#include "llvm/Config/Targets.def"
49#undef LLVM_TARGET  /* Explicit undef to make SWIG happier */
50
51#define LLVM_TARGET(TargetName) void LLVMInitialize##TargetName##Target(void);
52#include "llvm/Config/Targets.def"
53#undef LLVM_TARGET  /* Explicit undef to make SWIG happier */
54
55#define LLVM_TARGET(TargetName) \
56  void LLVMInitialize##TargetName##TargetMC(void);
57#include "llvm/Config/Targets.def"
58#undef LLVM_TARGET  /* Explicit undef to make SWIG happier */
59
60/* Declare all of the available assembly printer initialization functions. */
61#define LLVM_ASM_PRINTER(TargetName) \
62  void LLVMInitialize##TargetName##AsmPrinter(void);
63#include "llvm/Config/AsmPrinters.def"
64#undef LLVM_ASM_PRINTER  /* Explicit undef to make SWIG happier */
65
66/* Declare all of the available assembly parser initialization functions. */
67#define LLVM_ASM_PARSER(TargetName) \
68  void LLVMInitialize##TargetName##AsmParser(void);
69#include "llvm/Config/AsmParsers.def"
70#undef LLVM_ASM_PARSER  /* Explicit undef to make SWIG happier */
71
72/* Declare all of the available disassembler initialization functions. */
73#define LLVM_DISASSEMBLER(TargetName) \
74  void LLVMInitialize##TargetName##Disassembler(void);
75#include "llvm/Config/Disassemblers.def"
76#undef LLVM_DISASSEMBLER  /* Explicit undef to make SWIG happier */
77
78/** LLVMInitializeAllTargetInfos - The main program should call this function if
79    it wants access to all available targets that LLVM is configured to
80    support. */
81static inline void LLVMInitializeAllTargetInfos(void) {
82#define LLVM_TARGET(TargetName) LLVMInitialize##TargetName##TargetInfo();
83#include "llvm/Config/Targets.def"
84#undef LLVM_TARGET  /* Explicit undef to make SWIG happier */
85}
86
87/** LLVMInitializeAllTargets - The main program should call this function if it
88    wants to link in all available targets that LLVM is configured to
89    support. */
90static inline void LLVMInitializeAllTargets(void) {
91#define LLVM_TARGET(TargetName) LLVMInitialize##TargetName##Target();
92#include "llvm/Config/Targets.def"
93#undef LLVM_TARGET  /* Explicit undef to make SWIG happier */
94}
95
96/** LLVMInitializeAllTargetMCs - The main program should call this function if
97    it wants access to all available target MC that LLVM is configured to
98    support. */
99static inline void LLVMInitializeAllTargetMCs(void) {
100#define LLVM_TARGET(TargetName) LLVMInitialize##TargetName##TargetMC();
101#include "llvm/Config/Targets.def"
102#undef LLVM_TARGET  /* Explicit undef to make SWIG happier */
103}
104
105/** LLVMInitializeAllAsmPrinters - The main program should call this function if
106    it wants all asm printers that LLVM is configured to support, to make them
107    available via the TargetRegistry. */
108static inline void LLVMInitializeAllAsmPrinters(void) {
109#define LLVM_ASM_PRINTER(TargetName) LLVMInitialize##TargetName##AsmPrinter();
110#include "llvm/Config/AsmPrinters.def"
111#undef LLVM_ASM_PRINTER  /* Explicit undef to make SWIG happier */
112}
113
114/** LLVMInitializeAllAsmParsers - The main program should call this function if
115    it wants all asm parsers that LLVM is configured to support, to make them
116    available via the TargetRegistry. */
117static inline void LLVMInitializeAllAsmParsers(void) {
118#define LLVM_ASM_PARSER(TargetName) LLVMInitialize##TargetName##AsmParser();
119#include "llvm/Config/AsmParsers.def"
120#undef LLVM_ASM_PARSER  /* Explicit undef to make SWIG happier */
121}
122
123/** LLVMInitializeAllDisassemblers - The main program should call this function
124    if it wants all disassemblers that LLVM is configured to support, to make
125    them available via the TargetRegistry. */
126static inline void LLVMInitializeAllDisassemblers(void) {
127#define LLVM_DISASSEMBLER(TargetName) \
128  LLVMInitialize##TargetName##Disassembler();
129#include "llvm/Config/Disassemblers.def"
130#undef LLVM_DISASSEMBLER  /* Explicit undef to make SWIG happier */
131}
132
133/** LLVMInitializeNativeTarget - The main program should call this function to
134    initialize the native target corresponding to the host.  This is useful
135    for JIT applications to ensure that the target gets linked in correctly. */
136static inline LLVMBool LLVMInitializeNativeTarget(void) {
137  /* If we have a native target, initialize it to ensure it is linked in. */
138#ifdef LLVM_NATIVE_TARGET
139  LLVM_NATIVE_TARGETINFO();
140  LLVM_NATIVE_TARGET();
141  LLVM_NATIVE_TARGETMC();
142  return 0;
143#else
144  return 1;
145#endif
146}
147
148/** LLVMInitializeNativeTargetAsmParser - The main program should call this
149    function to initialize the parser for the native target corresponding to the
150    host. */
151static inline LLVMBool LLVMInitializeNativeAsmParser(void) {
152#ifdef LLVM_NATIVE_ASMPARSER
153  LLVM_NATIVE_ASMPARSER();
154  return 0;
155#else
156  return 1;
157#endif
158}
159
160/** LLVMInitializeNativeTargetAsmPrinter - The main program should call this
161    function to initialize the printer for the native target corresponding to
162    the host. */
163static inline LLVMBool LLVMInitializeNativeAsmPrinter(void) {
164#ifdef LLVM_NATIVE_ASMPRINTER
165  LLVM_NATIVE_ASMPRINTER();
166  return 0;
167#else
168  return 1;
169#endif
170}
171
172/** LLVMInitializeNativeTargetDisassembler - The main program should call this
173    function to initialize the disassembler for the native target corresponding
174    to the host. */
175static inline LLVMBool LLVMInitializeNativeDisassembler(void) {
176#ifdef LLVM_NATIVE_DISASSEMBLER
177  LLVM_NATIVE_DISASSEMBLER();
178  return 0;
179#else
180  return 1;
181#endif
182}
183
184/*===-- Target Data -------------------------------------------------------===*/
185
186/** Creates target data from a target layout string.
187    See the constructor llvm::DataLayout::DataLayout. */
188LLVMTargetDataRef LLVMCreateTargetData(const char *StringRep);
189
190/** Adds target data information to a pass manager. This does not take ownership
191    of the target data.
192    See the method llvm::PassManagerBase::add. */
193void LLVMAddTargetData(LLVMTargetDataRef TD, LLVMPassManagerRef PM);
194
195/** Adds target library information to a pass manager. This does not take
196    ownership of the target library info.
197    See the method llvm::PassManagerBase::add. */
198void LLVMAddTargetLibraryInfo(LLVMTargetLibraryInfoRef TLI,
199                              LLVMPassManagerRef PM);
200
201/** Converts target data to a target layout string. The string must be disposed
202    with LLVMDisposeMessage.
203    See the constructor llvm::DataLayout::DataLayout. */
204char *LLVMCopyStringRepOfTargetData(LLVMTargetDataRef TD);
205
206/** Returns the byte order of a target, either LLVMBigEndian or
207    LLVMLittleEndian.
208    See the method llvm::DataLayout::isLittleEndian. */
209enum LLVMByteOrdering LLVMByteOrder(LLVMTargetDataRef TD);
210
211/** Returns the pointer size in bytes for a target.
212    See the method llvm::DataLayout::getPointerSize. */
213unsigned LLVMPointerSize(LLVMTargetDataRef TD);
214
215/** Returns the pointer size in bytes for a target for a specified
216    address space.
217    See the method llvm::DataLayout::getPointerSize. */
218unsigned LLVMPointerSizeForAS(LLVMTargetDataRef TD, unsigned AS);
219
220/** Returns the integer type that is the same size as a pointer on a target.
221    See the method llvm::DataLayout::getIntPtrType. */
222LLVMTypeRef LLVMIntPtrType(LLVMTargetDataRef TD);
223
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. */
227LLVMTypeRef LLVMIntPtrTypeForAS(LLVMTargetDataRef TD, unsigned AS);
228
229/** Returns the integer type that is the same size as a pointer on a target.
230    See the method llvm::DataLayout::getIntPtrType. */
231LLVMTypeRef LLVMIntPtrTypeInContext(LLVMContextRef C, LLVMTargetDataRef TD);
232
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. */
236LLVMTypeRef LLVMIntPtrTypeForASInContext(LLVMContextRef C, LLVMTargetDataRef TD,
237                                         unsigned AS);
238
239/** Computes the size of a type in bytes for a target.
240    See the method llvm::DataLayout::getTypeSizeInBits. */
241unsigned long long LLVMSizeOfTypeInBits(LLVMTargetDataRef TD, LLVMTypeRef Ty);
242
243/** Computes the storage size of a type in bytes for a target.
244    See the method llvm::DataLayout::getTypeStoreSize. */
245unsigned long long LLVMStoreSizeOfType(LLVMTargetDataRef TD, LLVMTypeRef Ty);
246
247/** Computes the ABI size of a type in bytes for a target.
248    See the method llvm::DataLayout::getTypeAllocSize. */
249unsigned long long LLVMABISizeOfType(LLVMTargetDataRef TD, LLVMTypeRef Ty);
250
251/** Computes the ABI alignment of a type in bytes for a target.
252    See the method llvm::DataLayout::getTypeABISize. */
253unsigned LLVMABIAlignmentOfType(LLVMTargetDataRef TD, LLVMTypeRef Ty);
254
255/** Computes the call frame alignment of a type in bytes for a target.
256    See the method llvm::DataLayout::getTypeABISize. */
257unsigned LLVMCallFrameAlignmentOfType(LLVMTargetDataRef TD, LLVMTypeRef Ty);
258
259/** Computes the preferred alignment of a type in bytes for a target.
260    See the method llvm::DataLayout::getTypeABISize. */
261unsigned LLVMPreferredAlignmentOfType(LLVMTargetDataRef TD, LLVMTypeRef Ty);
262
263/** Computes the preferred alignment of a global variable in bytes for a target.
264    See the method llvm::DataLayout::getPreferredAlignment. */
265unsigned LLVMPreferredAlignmentOfGlobal(LLVMTargetDataRef TD,
266                                        LLVMValueRef GlobalVar);
267
268/** Computes the structure element that contains the byte offset for a target.
269    See the method llvm::StructLayout::getElementContainingOffset. */
270unsigned LLVMElementAtOffset(LLVMTargetDataRef TD, LLVMTypeRef StructTy,
271                             unsigned long long Offset);
272
273/** Computes the byte offset of the indexed struct element for a target.
274    See the method llvm::StructLayout::getElementContainingOffset. */
275unsigned long long LLVMOffsetOfElement(LLVMTargetDataRef TD,
276                                       LLVMTypeRef StructTy, unsigned Element);
277
278/** Deallocates a TargetData.
279    See the destructor llvm::DataLayout::~DataLayout. */
280void LLVMDisposeTargetData(LLVMTargetDataRef TD);
281
282/**
283 * @}
284 */
285
286#ifdef __cplusplus
287}
288#endif /* defined(__cplusplus) */
289
290#endif
291